HEX

File: //usr/lib/python3/dist-packages/twisted/mail/test/__pycache__/test_pop3.cpython-310.pyc
o

�b���@s�dZddlZddlZddlZddlmZddlmZddlm	Z	ddl
mZddlZ
ddlZ
ddlZ
ddlZ
ddlZ
ddlZ
ddl
mZmZmZddlmZdd	lmZdd
lmZddlmZddlmZdd
l m!Z!m"Z"Gdd�de!j#�Z$Gdd�dej%j&�Z'Gdd�d�Z(Gdd�d�Z)Gdd�dej*�Z+Gdd�de!j#�Z,Gdd�dej-�Z.Gdd�de.�Z/Gdd�dej0�Z1Gd d!�d!e!j#�Z2eej3�Gd"d#�d#��Z4Gd$d%�d%�Z5d&d'�Z6Gd(d)�d)e!j#�Z7Gd*d+�d+e!j#�Z8Gd,d-�d-�Z9Gd.d/�d/e!j#�Z:Gd0d1�d1�Z;d2Z<e"j=e<e>d3�Z?d4Z@e"j=e@e>d3�ZAGd5d6�d6e;e!j#�ZBGd7d8�d8e;e!j#�ZCGd9d:�d:e1�ZDGd;d<�d<eB�ZEGd=d>�d>eC�ZFGd?d@�d@e1�ZGGdAdB�dBeB�ZHGdCdD�dDeC�ZIGdEdF�dFe!j#�ZJGdGdH�dHe!j#�ZKdS)Iz-
Test cases for L{twisted.mail.pop3} module.
�N)�OrderedDict)�md5)�BytesIO)�implementer)�cred�internet�mail)�defer)�pop3)�loopback)�failure)�LineSendingProtocol)�unittest�utilc@s@eZdZdZdd�Zdd�Zdd�Zdd	�Zd
d�Zdd
�Z	dS)�UtilityTestszl
    Test the various helper functions and classes used by the POP3 server
    protocol implementation.
    cCs�g}tt�gd���}t�|j|d�}t|�}|�|g�t|�|�|g�t|�|�|g�t|�|�|gd��td�D]}t|�qA|�|gd��dS)z�
        Test creating a LineBuffer and feeding it some lines.  The lines should
        build up in its internal buffer for a while and then get spat out to
        the writer.
        )�012�345�6�7�8�9�)rrr�)rrrrrrrrN)	�iter�	itertools�cycler
�_IteratorBuffer�extend�assertEqual�next�range)�self�output�input�c�i�n�r'�=/usr/lib/python3/dist-packages/twisted/mail/test/test_pop3.py�test_LineBuffering's
zUtilityTests.test_LineBufferingcCs>g}tgd��}t�|j|d�}|D]}q|�|gd��dS)z�
        Test that a LineBuffer flushes everything when its iterator is
        exhausted, and itself raises StopIteration.
        )�a�br$rN)rr
rrr)r!r"r#r$r%r'r'r(�test_FinishLineBuffering<sz%UtilityTests.test_FinishLineBufferingcCs|�t�d�d�dS)zb
        Test that the thing that spits out POP3 'success responses' works
        right.
        sGreat.s+OK Great.
N)rr
�successResponse�r!r'r'r(�test_SuccessResponseFormatterHsz*UtilityTests.test_SuccessResponseFormattercCsDtt�g��d}|�|d�tt�gd���d}|�|d�dS)zX
        Test that the function which formats stat lines does so appropriately.
        ���s	+OK 0 0
)�
�riu's
+OK 4 10142
N)�listr
�formatStatResponser)r!�statLiner'r'r(�test_StatLineFormatterOsz#UtilityTests.test_StatLineFormattercCsDtt�g��}|�|ddg�tt�gd���}|�|gd��dS)z}
        Test that the function which formats the lines in response to a LIST
        command does so appropriately.
        �+OK 0
�.
)����d)s+OK 4
s1 1
s2 2
s3 3
s4 100
r8N)r3r
�formatListResponser)r!�	listLinesr'r'r(�test_ListLineFormatterYs�z#UtilityTests.test_ListLineFormattercCszgd�}tt�g|j��}|�|ddg�tt�gd�|j��}|�|gd��tt�gd�|j��}|�|gd��dS)	zy
        Test that the function which formats lines in response to a UIDL
        command does so appropriately.
        )�abc�def�ghi�+OK 
r8)�{i��O)rC�1 abc
s2 def
�3 ghi
r8)rNrE)rCrFrGr8N)r3r
�formatUIDListResponse�__getitem__r)r!�uidsr>r'r'r(�test_UIDListLineFormattergs�z&UtilityTests.test_UIDListLineFormatterN)
�__name__�
__module__�__qualname__�__doc__r)r,r/r6r?rKr'r'r'r(r!s
rc@�eZdZdZdZdd�ZdS)�
MyVirtualPOP3z2
    A virtual-domain-supporting POP3 server.
    �<moshez>cCs(|�|�\}}|jjd�|||j|�S)a7
        Authenticate against a user against a virtual domain.

        @param user: The username.
        @param digest: The digested password.

        @return: A three-tuple like the one returned by
            L{IRealm.requestAvatar}.  The mailbox will be for the user given
            by C{user}.
        �baz.com)�lookupDomain�service�domains�authenticateUserAPOP�magic)r!�user�digest�domainr'r'r(rW�s
�z"MyVirtualPOP3.authenticateUserAPOPN�rLrMrNrOrXrWr'r'r'r(rQy�rQc@s0eZdZdZdd�Zdd�Zdd�Zdd	�Zd
S)�DummyDomainz-
    A virtual domain for a POP3 server.
    cCs
i|_dS�N��usersr.r'r'r(�__init__�s
zDummyDomain.__init__cCsg|j|<dS)zV
        Create a mailbox for a new user.

        @param name: The username.
        Nr`)r!�namer'r'r(�addUser��zDummyDomain.addUsercCs|j|�|�dS)z�
        Add a message to the mailbox of the named user.

        @param name: The username.
        @param message: The contents of the message.
        N)ra�append)r!rc�messager'r'r(�
addMessage�szDummyDomain.addMessagecCstjt|j|�dd�fS)ae
        Succeed with a L{ListMailbox}.

        @param name: The name of the user authenticating.
        @param digest: ignored
        @param magic: ignored
        @param domain: ignored

        @return: A three-tuple like the one returned by
            L{IRealm.requestAvatar}.  The mailbox will be for the user given
            by C{name}.
        cS�dSr_r'r'r'r'r(�<lambda>��z2DummyDomain.authenticateUserAPOP.<locals>.<lambda>)r
�IMailbox�ListMailboxra)r!rcrZrXr[r'r'r(rW�s
z DummyDomain.authenticateUserAPOPN)rLrMrNrOrbrdrhrWr'r'r'r(r^�s	r^c@sBeZdZdZdd�Zddd�Zdd�Zd	d
�Zdd�Zd
d�Z	dS)rmz@
    A simple in-memory list implementation of L{IMailbox}.
    cCs
||_dS)z,
        @param list: The messages.
        N�r3)r!r3r'r'r(rb��
zListMailbox.__init__NcCs&|durdd�|jD�St|j|�S)��
        Get some message information.

        @param i: See L{pop3.IMailbox.listMessages}.
        @return: See L{pop3.IMailbox.listMessages}.
        NcS�g|]}t|��qSr'��len)�.0�lr'r'r(�
<listcomp>��z,ListMailbox.listMessages.<locals>.<listcomp>)r3rs�r!r%r'r'r(�listMessages�szListMailbox.listMessagescC�t|j|�S�z�
        Get the message content.

        @param i: See L{pop3.IMailbox.getMessage}.
        @return: See L{pop3.IMailbox.getMessage}.
        )rr3rxr'r'r(�
getMessage��zListMailbox.getMessagecCs|S)z�
        Construct a UID by using the given index value.

        @param i: See L{pop3.IMailbox.getUidl}.
        @return: See L{pop3.IMailbox.getUidl}.
        r'rxr'r'r(�getUidl�szListMailbox.getUidlcC�d|j|<dS�zm
        Wipe the message at the given index.

        @param i: See L{pop3.IMailbox.deleteMessage}.
        �Nrnrxr'r'r(�
deleteMessage�rezListMailbox.deleteMessagecC�dS)z=
        No-op.

        @see: L{pop3.IMailbox.sync}
        Nr'r.r'r'r(�sync�rkzListMailbox.syncr_)
rLrMrNrOrbryr|r~r�r�r'r'r'r(rm�s
		rmc@s8eZdZdZdd�Zdd�Zdd�Zdd	�Zd
d�ZdS)
�MyPOP3DownloaderzE
    A POP3 client which downloads all messages from the server.
    cCstj�||�|�dd�dS)zK
        Authenticate.

        @param line: The welcome response.
        s
hello@baz.comsworldN)r
�
POP3Client�handle_WELCOME�apop�r!�liner'r'r(r��szMyPOP3Downloader.handle_WELCOMEcCsB|��}|d}|dkrtd|�d|�d���g|_|�d�dS)zc
        Require an I{OK} response to I{APOP}.

        @param line: The I{APOP} response.
        r�+OKz	code is: z
 , parts is: � r9N)�split�AssertionError�lines�retr)r!r��parts�coder'r'r(�handle_APOPszMyPOP3Downloader.handle_APOPcCs|j�|�dS)zh
        Record one line of message information.

        @param line: A I{RETR} response line.
        N)r�rfr�r'r'r(�handle_RETR_continue
�z%MyPOP3Downloader.handle_RETR_continuecCsd�|j�d|_|��dS)z:
        Record the received message information.
        �
N)�joinr�rg�quitr.r'r'r(�handle_RETR_endsz MyPOP3Downloader.handle_RETR_endcCs |dd�dkrtd|��dS)zc
        Require an I{OK} response to I{QUIT}.

        @param line: The I{QUIT} response.
        Nr;r�scode is )r�r�r'r'r(�handle_QUITs�zMyPOP3Downloader.handle_QUITN)	rLrMrNrOr�r�r�r�r�r'r'r'r(r��s	
r�c@sReZdZdZdZdee�fZdd�Zdd�Zdd	�Z	e
jd
d�ge	_dd
�ZdS)�	POP3Testsz!
    Tests for L{pop3.POP3}.
    s-Subject: urgent

Someone set up us the bomb!
s{+OK <moshez>
+OK Authentication succeeded
+OK 
1 0
.
+OK %d
Subject: urgent

Someone set up us the bomb!
.
+OK 
cCsNtj��|_i|j_t�|jjd<|jjd�d�|jjd�d|j�dS)zC
        Set up a POP3 server with virtual domain support.
        rSshelloN)	r�protocol�Factory�factoryrVr^rdrhrgr.r'r'r(�setUpAs
zPOP3Tests.setUpcs:tgd���t�}�j|_��fdd�}t�|���|�S)zL
        Messages can be downloaded over a loopback TCP connection.
        )sAPOP hello@baz.com world�UIDL�RETR 1�QUITcs"d��j�d}��|�j�dS)N�
)r��responser�expectedOutput)�ignoredr"��clientr!r'r(�checkZsz&POP3Tests.test_messages.<locals>.check)r
rQr�rUr�loopbackTCP�addCallback)r!�serverr�r'r�r(�
test_messagesKs�zPOP3Tests.test_messagescs:t���j�_t�����fdd�}t����}|�|�S)zH
        Messages can be downloaded over a loopback connection.
        cs(���j�j���t�td���dS)N�Test harness disconnect)rrg�connectionLostr�Failure�	Exception)r���clientProtocolr�r!r'r(r�hs�z&POP3Tests.test_loopback.<locals>.check)rQr�rUr�r�
loopbackAsyncr�)r!r��dr'r�r(�
test_loopback`s
zPOP3Tests.test_loopbackz*twisted.mail.pop3.POP3Client is deprecated)rgcCsRtj��}i|_t�|jd<t�}||_|�tj	|j
dd�}|�|jdd�dS)zP
        Look up a user in a domain which this server does not support.
        stwistedmatrix.comsnobody@baz.comspasswordrzno such domain baz.comN)
rr�r�rVr^rQrU�assertRaisesr
�	POP3ErrorrWr�args)r!r�r��excr'r'r(�test_incorrectDomainus
�zPOP3Tests.test_incorrectDomainN)
rLrMrNrOrgrsr�r�r�r�r�suppressr�r'r'r'r(r�&s
��

�r�c@rP)�	DummyPOP3zF
    A simple POP3 server with a hard-coded mailbox for any user.
    rRcCstjtt�dd�fS)z�
        Succeed with a L{DummyMailbox}.

        @param user: ignored
        @param password: ignored

        @return: A three-tuple like the one returned by
            L{IRealm.requestAvatar}.
        cSrir_r'r'r'r'r(rj�rkz0DummyPOP3.authenticateUserAPOP.<locals>.<lambda>�r
rl�DummyMailbox�
ValueError)r!rY�passwordr'r'r(rW�s
zDummyPOP3.authenticateUserAPOPNr\r'r'r'r(r��r]r�c@�eZdZdZdd�ZdS)�
DummyPOP3AuthzL
    Class to test successful authentication in twisted.mail.pop3.POP3.
    cCs6tj�t��|_tj��}|�||�|j�|�dSr_)r�portal�Portal�	TestRealm�checkers�'InMemoryUsernamePasswordDatabaseDontUserd�registerChecker)r!rYr��chr'r'r(rb�s
zDummyPOP3Auth.__init__N)rLrMrNrOrbr'r'r'r(r���r�c@s@eZdZdZdgZdd�Zddd�Zdd	�Zd
d�Zdd
�Z	dS)r�z�
    An in-memory L{pop3.IMailbox} implementation.

    @ivar messages: A sequence of L{bytes} defining the messages in this
        mailbox.

    @ivar exceptionType: The type of exception to raise when an out-of-bounds
        index is addressed.
    s,From: moshe
To: moshe

How are you, friend?
cCstjdd�|_||_dSr_)r��messages�
exceptionType)r!r�r'r'r(rb�s
zDummyMailbox.__init__NcCs<|durdd�|jD�S|t|j�kr|���t|j|�S)rpNcSrqr'rr)rt�mr'r'r(rv�rwz-DummyMailbox.listMessages.<locals>.<listcomp>)r�rsr�rxr'r'r(ry�s
zDummyMailbox.listMessagescCrzr{)rr�rxr'r'r(r|�r}zDummyMailbox.getMessagecCs |t|j�kr|���d|fS)z�
        Construct a UID which is simply the string representation of the given
        index.

        @param i: See L{pop3.IMailbox.getUidl}.
        @return: See L{pop3.IMailbox.getUidl}.
        s%d)rsr�r�rxr'r'r(r~�s
zDummyMailbox.getUidlcCrr�)r�rxr'r'r(r��rezDummyMailbox.deleteMessager_)
rLrMrNrOr�rbryr|r~r�r'r'r'r(r��s


	r�c@s�eZdZdZd5dd�Zdd�Zdd�Zd	d
�Zdd�Zd
d�Z	dd�Z
ddggfdd�Zdd�Zdd�Z
dd�Zdd�Zdd�Zdd�Zdd �Zd!d"�Zd#d$�Zd%d&�Zd'd(�Zd)d*�Zd+d,�Zd-d.�Zd/d0�Zd1d2�Zd3d4�ZdS)6�AnotherPOP3Testsz(
    Additional L{pop3.POP3} tests.
    NcCs4|r|nt�}t|�}t�||�}|�|j|||�S)aO
        Assert that when C{lines} are delivered to L{pop3.POP3} it responds
        with C{expectedOutput}.

        @param lines: A sequence of L{bytes} representing lines to deliver to
            the server.

        @param expectedOutput: A sequence of L{bytes} representing the
            expected response from the server.

        @param protocolInstance: Instance of L{twisted.mail.pop3.POP3} or
            L{None}. If L{None}, a new DummyPOP3 will be used.

        @return: A L{Deferred} that fires when the lines have been delivered
            and the output checked.
        )r�r
rr�r��
_cbRunTest)r!r�r��protocolInstance�dummyr�r�r'r'r(�runTest�szAnotherPOP3Tests.runTestcCs2|�d�|�d�|j��|�t�td���|S)Nr�r�)rr�r�r�rr�r�)r!r�r�r�r�r'r'r(r��szAnotherPOP3Tests._cbRunTestcC�|�gd�gd��S)a4
        Test a lot of different POP3 commands in an extremely pipelined
        scenario.

        This test may cover legitimate behavior, but the intent and
        granularity are not very good.  It would likely be an improvement to
        split it into a number of smaller, more focused tests.
        )sAPOP moshez dummy�LISTr�r��RETR 2sDELE 1r�r�)�+OK <moshez>�+OK Authentication succeededs+OK 1s1 44�.�+OK s1 0r�s+OK 44sFrom: moshes	To: mosher�sHow are you, friend?r�s -ERR Bad message number argumentr�s-ERR message deletedr��r�r.r'r'r(�test_buffers	
�zAnotherPOP3Tests.test_buffercCr�)z)
        Test the no-op command.
        )sAPOP spiv dummysNOOPr�)r�r�r�r�r�r.r'r'r(�	test_noop+s�zAnotherPOP3Tests.test_noopcCs>d}|�ddgdd|dg�}|�tj�}|�t|�d�|S)zi
        Sending a command with invalid UTF-8 characters
        will raise a L{pop3.POP3Error}.
        s&not authenticated yet: cannot do �PASSs�PASSr�r�s(-ERR bad protocol or server: POP3Error: r�r9)r��flushLoggedErrorsr
r�rrs)r!�errorr��errorsr'r'r(�test_badUTF8CharactersInCommand4s��z0AnotherPOP3Tests.test_badUTF8CharactersInCommandcCsHt�}tj��|_dddd�|j_tddg�}t�||�}|�	|j
|�S)z�
        L{pop3.POP3} responds to an I{AUTH} command with a list of supported
        authentication types based on its factory's C{challengers}.
        N)sAuth1s
secondAuthsauthLastsAUTHr�)r�rr�r�r��challengersr
rr�r��_cbTestAuthListing)r!�pr�r�r'r'r(�test_authListingFs��z!AnotherPOP3Tests.test_authListingcCsJ|�|jd�d��|�t|jdd��gd��|�|jdd�dS)Nr9r�r:r)sAUTH1sAUTHLASTs
SECONDAUTHr�)�
assertTruer��
startswithr�sorted)r!r�r�r'r'r(r�Xs
�z#AnotherPOP3Tests._cbTestAuthListingc	Cs~|s|}|s|}gd�}||kr||krgd�}d�d|g�d�d|g�g}||dg7}||dg7}|j||t||�d�S)	a�
        Test a login with PASS.

        If L{real_user} matches L{tried_user} and L{real_password} matches
        L{tried_password}, a successful login will be expected.
        Otherwise an unsuccessful login will be expected.

        @type real_user: L{bytes}
        @param real_user: The user to test.

        @type real_password: L{bytes}
        @param real_password: The password of the test user.

        @type tried_user: L{bytes} or L{None}
        @param tried_user: The user to call USER with.
            If None, real_user will be used.

        @type tried_password: L{bytes} or L{None}
        @param tried_password: The password to call PASS with.
            If None, real_password will be used.

        @type after_auth_input: L{list} of l{bytes}
        @param after_auth_input: Extra protocol input after authentication.

        @type after_auth_output: L{list} of l{bytes}
        @param after_auth_output: Extra protocol output after authentication.
        )r��+OK USER accepted, send PASSs-ERR Authentication failed)r�r�r�� �USER�PASSr�r�)r�)r�r�r�)	r!�	real_user�
real_password�
tried_user�tried_password�after_auth_input�after_auth_outputr��	fullInputr'r'r(�run_PASS_s"$��zAnotherPOP3Tests.run_PASScCs|�d�d|g�dggd��S)z�
        Test protocol violation produced by calling PASS before USER.
        @type password: L{bytes}
        @param password: A password to test.
        r�r�r�)r�s-ERR USER required before PASSr�)r�r�)r!r�r'r'r(�run_PASS_before_USER�s�z%AnotherPOP3Tests.run_PASS_before_USERcC�
|�d�S)z>
        Test PASS before USER with a wrong password.
        �fooz�r�r.r'r'r(�test_illegal_PASS_before_USER�roz.AnotherPOP3Tests.test_illegal_PASS_before_USERcCr�)z?
        Test PASS before USER with an empty password.
        r�r�r.r'r'r(�test_empty_PASS_before_USER�roz,AnotherPOP3Tests.test_empty_PASS_before_USERcCr�)zI
        Test PASS before USER with an password that is a space.
        r�r�r.r'r'r(�test_one_space_PASS_before_USER�roz0AnotherPOP3Tests.test_one_space_PASS_before_USERcCr�)zK
        Test PASS before USER with a password containing a space.
        �	fooz barzr�r.r'r'r(�test_space_PASS_before_USER�roz,AnotherPOP3Tests.test_space_PASS_before_USERcCr�)zS
        Test PASS before USER with a password containing multiple spaces.
        �fooz barz asdfr�r.r'r'r(�%test_multiple_spaces_PASS_before_USER�roz6AnotherPOP3Tests.test_multiple_spaces_PASS_before_USERcCr�)zS
        Test PASS before USER with a password containing tabs and spaces.
        �fooz barz	crazy@! 	 r�r.r'r'r(�&test_other_whitespace_PASS_before_USER�roz7AnotherPOP3Tests.test_other_whitespace_PASS_before_USERcC�|�dd�S)z1
        Test PASS with a good password.
        �testuserr��r�r.r'r'r(�test_good_PASS��zAnotherPOP3Tests.test_good_PASScCr)�?
        Test PASS with a password containing a space.
        rr�rr.r'r'r(�test_space_PASS�rz AnotherPOP3Tests.test_space_PASScCr)rrr�rr.r'r'r(�test_multiple_spaces_PASS�rz*AnotherPOP3Tests.test_multiple_spaces_PASScCr�zG
        Test PASS with a password containing tabs and spaces.
        rrrr.r'r'r(�test_other_whitespace_PASS�rz+AnotherPOP3Tests.test_other_whitespace_PASScC�|jdddd�S)z.
        Test PASS with a wrong user.
        rr�s	wronguser)r�rr.r'r'r(�test_pass_wrong_user��z%AnotherPOP3Tests.test_pass_wrong_usercCr)z2
        Test PASS with a wrong password.
        rr�sbarz�r�rr.r'r'r(�test_wrong_PASS�rz AnotherPOP3Tests.test_wrong_PASScCr)rrr�s	foozbarz rrr.r'r'r(�test_wrong_space_PASS�rz&AnotherPOP3Tests.test_wrong_space_PASScCr)rrr�sfoozbarz   rrr.r'r'r(�test_wrong_multiple_spaces_PASS�s�z0AnotherPOP3Tests.test_wrong_multiple_spaces_PASScCrr
rr.r'r'r(� test_wrong_other_whitespace_PASSrz1AnotherPOP3Tests.test_wrong_other_whitespace_PASScCs4dg}d�ddg�g}|jdd||d��|jtj�S)zM
        After logging in, test a dummy command that is not defined.
        s
DUMMY COMMANDr�s'-ERR bad protocol or server: POP3Error:sUnknown protocol command: DUMMYr�testpassword)r�r�)r�r�r�r�r
r�)r!�extra_input�extra_outputr'r'r(�test_wrong_commands���	��z#AnotherPOP3Tests.test_wrong_commandr_)rLrMrNrOr�r�r�r�r�r�r�r�r�r�r�r�r�r�rrrr	rr
rrrrrr'r'r'r(r��s>
*	
�Ar�c@sLeZdZdZdd�Zdd�Zeddg�Zdd	�Zd
Z	dd�Z
d
Zd
d�ZdS)�TestServerFactoryz�
    A L{pop3.IServerFactory} implementation, for use by the test suite, with
    some behavior controlled by the values of (settable) public attributes and
    other behavior based on values hard-coded both here and in some test
    methods.
    cCr�)�W
        Return the hard-coded value.

        @return: L{pop3.IServerFactory}
        zTest Implementation Stringr'r.r'r'r(�cap_IMPLEMENTATION&�z$TestServerFactory.cap_IMPLEMENTATIONcCr�)r�<r'r.r'r'r(�
cap_EXPIRE.rzTestServerFactory.cap_EXPIRE)sSCHEME_1N)sSCHEME_2NcCr�)r�xr'r.r'r'r(�cap_LOGIN_DELAY8rz!TestServerFactory.cap_LOGIN_DELAYTcC�|jS�r)�puer.r'r'r(�perUserExpirationB�z#TestServerFactory.perUserExpirationcCr r!)�puldr.r'r'r(�perUserLoginDelayLr$z#TestServerFactory.perUserLoginDelayN)
rLrMrNrOrrrr�rr"r#r%r&r'r'r'r(rsrc@seZdZdZdZdZdS)�TestMailboxz�
    An incomplete L{IMailbox} implementation with certain per-user values
    hard-coded and known by tests in this module.


    This is useful for testing the server's per-user capability
    implementation.
    r<�N)rLrMrNrO�
loginDelay�messageExpirationr'r'r'r(r'Us	r'cGs|D]}|�||�qdS)aG
    Assert that the given capability is included in all of the capability
    sets.

    @param testcase: A L{unittest.TestCase} to use to make assertions.

    @param s: The capability for which to check.
    @type s: L{bytes}

    @param caps: The capability sets in which to check.
    @type caps: L{tuple} of iterable
    N)�assertIn)�testcase�s�capsr$r'r'r(�	containedcs
�r/c@sPeZdZdZdd�Zdd�Zdd�Zdd	�Zd
d�Zdd
�Z	dd�Z
dd�ZdS)�CapabilityTestsz@
    Tests for L{pop3.POP3}'s per-user capability handling.
    cCs�t�}t��}t�|_tj�|�|_|�	�|�
�|��|_|�
���|_t�}t�|_tj�|�|_|�
�|�
���|_|�t�td���dS)�>
        Create a POP3 server with some capabilities.
        r�N)rr
�POP3rr�rr��FileWrapper�	transport�connectionMade�do_CAPA�listCapabilitiesr.�getvalue�
splitlines�pcapsr'�mbox�lpcapsr�rr�r��r!r-r�r'r'r(r�ys
zCapabilityTests.setUpcC�t|d|j|j|j�dS)zB
        The server can advertise the I{UIDL} capability.
        r�N�r/r.r:r<r.r'r'r(�	test_UIDL��zCapabilityTests.test_UIDLcCr>)zA
        The server can advertise the I{TOP} capability.
        sTOPNr?r.r'r'r(�test_TOP�rAzCapabilityTests.test_TOPcCr>)zB
        The server can advertise the I{USER} capability.
        r�Nr?r.r'r'r(�	test_USER�rAzCapabilityTests.test_USERcCs$t|d|j|j�t|d|j�dS)zj
        The server can advertise its per-user expiration as well as a global
        expiration.
        sEXPIRE 60 USERs	EXPIRE 25Nr?r.r'r'r(�test_EXPIRE��zCapabilityTests.test_EXPIREcCr>)zE
        The server can advertise its implementation string.
        s)IMPLEMENTATION Test Implementation StringNr?r.r'r'r(�test_IMPLEMENTATION�s�z#CapabilityTests.test_IMPLEMENTATIONcCr>)zH
        The server can advertise the SASL schemes it supports.
        sSASL SCHEME_1 SCHEME_2Nr?r.r'r'r(�	test_SASL�rAzCapabilityTests.test_SASLcCs$t|d|j|j�|�d|j�dS)zc
        The can advertise a per-user login delay as well as a global login
        delay.
        sLOGIN-DELAY 120 USERsLOGIN-DELAY 100N)r/r.r:r+r<r.r'r'r(�test_LOGIN_DELAY�rEz CapabilityTests.test_LOGIN_DELAYN)rLrMrNrOr�r@rBrCrDrFrGrHr'r'r'r(r0tsr0c@s(eZdZdZdd�Zdd�Zdd�ZdS)	�GlobalCapabilitiesTestsz>
    Tests for L{pop3.POP3}'s global capability handling.
    cCs�t�}t��}t�|_d|j_|j_tj�	|�|_
|��|��|�
�|_|����|_t�}t�|_tj�	|�|_
|��|����|_|�t�td���dS)r1Fr�N)rr
r2rr�r"r%rr�r3r4r5r6r7r.r8r9r:r'r;r<r�rr�r�r=r'r'r(r��s
zGlobalCapabilitiesTests.setUpcCr>)zG
        I{EXPIRE} is in the server's advertised capabilities.
        s	EXPIRE 60Nr?r.r'r'r(rD�rAz#GlobalCapabilitiesTests.test_EXPIREcCr>)zL
        I{LOGIN-DELAY} is in the server's advertised capabilities.
        sLOGIN-DELAY 120Nr?r.r'r'r(rH�rAz(GlobalCapabilitiesTests.test_LOGIN_DELAYN)rLrMrNrOr�rDrHr'r'r'r(rI�s
rIc@r�)r�zI
    An L{IRealm} which knows about a single test account's mailbox.
    cGs |dkrtjtt�dd�fSJ�)aE
        Retrieve a mailbox for I{testuser} or fail.

        @param avatarId: See L{IRealm.requestAvatar}.
        @param mind: See L{IRealm.requestAvatar}.
        @param interfaces: See L{IRealm.requestAvatar}.

        @raises: L{AssertionError} when requesting an C{avatarId} other than
            I{testuser}.
        rcSrir_r'r'r'r'r(rj�rkz)TestRealm.requestAvatar.<locals>.<lambda>r�)r!�avatarId�mind�
interfacesr'r'r(�
requestAvatar�szTestRealm.requestAvatarN)rLrMrNrOrMr'r'r'r(r��r�r�c@r�)�	SASLTestsz7
    Tests for L{pop3.POP3}'s SASL implementation.
    cCs.t��}t�|_dtjji|j_tj�	t
��|_tj��}|�
dd�|j�|�t�}tj�|�|_|��|�d�|�|���d�dk�|�d�|����dd	d
�}t�|�}tjd|td���� d�}|�t�!d
|��|�|j"�|�|����d�d�dk�|�#t$�%t&d���d
S)z�
        A CRAM-MD5-based SASL login attempt succeeds if it uses a username and
        a hashed password known to the server's credentials checker.
        sCRAM-MD5rrsCAPAs
SASL CRAM-MD5rs
AUTH CRAM-MD5r0r:N)�	digestmod�asciis	testuser r�r�)'r
r2rr�r�credentials�CramMD5Credentialsr�r�r�r�r�r�rdr�rrr�r3r4r5�lineReceivedr�r8�findr9�base64�	b64decode�hmac�HMACr�	hexdigest�encode�	b64encoder;r�rr�r�)r!r�r�r-�chalr�r'r'r(�test_ValidLogins*



� zSASLTests.test_ValidLoginN)rLrMrNrOr]r'r'r'r(rNr�rNc@s�eZdZdZdZdd�Zdd�Zdd�Zd	d
�Zdd�Z	d
d�Z
dd�Zdd�Zdd�Z
dd�Zdd�Zdd�Zdd�Zdd�Zdd �Zd!d"�Zd#d$�Zd%S)&�CommandMixinzI
    Tests for all the commands a POP3 server is allowed to receive.
    s1From: guy
To: fellow

More message text for you.
cCs\t��}|�|j�|_t|_||_t�}t	j
�|�|_|�
�|�d�|�d�||_dS)z�
        Make a POP3 server protocol instance hooked up to a simple mailbox and
        a transport that buffers output to a BytesIO.
        rN)r
r2�mailboxTyper�r;r3�schedule�
pop3Serverrrr�r3r4r5�seek�truncate�
pop3Transport�r!r�r-r'r'r(r�4s


zCommandMixin.setUpcCs|j�t�td���dS)zo
        Disconnect the server protocol so it can clean up anything it might
        need to clean up.
        r�N)rar�rr�r�r.r'r'r(�tearDownEs�zCommandMixin.tearDowncCs|jj��dS)zz
        Do some of the things that the reactor would take care of, if the
        reactor were actually running.
        N)rar4�_checkProducerr.r'r'r(�_flushNr�zCommandMixin._flushcCsh|j}|j}|�d�|��|�|��d�|�d�|�d�|�d�|��|�|��d�dS)z�
        Test the two forms of list: with a message index number, which should
        return a short-form response, and without a message index number, which
        should return a long-form response, one line per message.
        sLIST 1�
+OK 1 44
rr�s+OK 1
1 44
.
N�rardrSrhrr8rbrcrer'r'r(�	test_LISTVs



zCommandMixin.test_LISTcCs�|j}|j}|�d�|�|��d�|�d�|�d�|�d�|�|��d�|�d�|�d�|�d�|�|��d�|�d�|�d�dS)	zo
        Test that non-integers and out-of-bound integers produce appropriate
        error responses.
        sLIST as -ERR Invalid message-number: a
rsLIST 0s -ERR Invalid message-number: 0
sLIST 2s -ERR Invalid message-number: 2
N�rardrSrr8rbrcrer'r'r(�test_LISTWithBadArgumenti�







z%CommandMixin.test_LISTWithBadArgumentcCs`|j}|j}|�d�|�|��d�|�d�|�d�|�d�|��|�|��d�dS)zy
        Test the two forms of the UIDL command.  These are just like the two
        forms of the LIST command.
        sUIDL 1r7rr�s+OK 
1 0
.
N)rardrSrr8rbrcrhrer'r'r(r@�s



zCommandMixin.test_UIDLcC�|j}|j}|�d�|�|��d�|�d�|�d�|�d�|�|��d�|�d�|�d�|�d�|�|��d�|�d�|�d�dS)z�
        Test that UIDL with a non-integer or an out-of-bounds integer produces
        the appropriate error response.
        sUIDL a�"-ERR Bad message number argument
rsUIDL 0sUIDL 2Nrlrer'r'r(�test_UIDLWithBadArgument�rnz%CommandMixin.test_UIDLWithBadArgumentcCs2|j}|j}|�d�|��|�|��d�dS)z�
        Test the single form of the STAT command, which returns a short-form
        response of the number of messages in the mailbox and their total size.
        sSTATriN)rardrSrhrr8rer'r'r(�	test_STAT�s

zCommandMixin.test_STATcCsF|j}|j}|�d�|��|�|��d�|�d�|�d�dS)z-
        Test downloading a message.
        r�s;+OK 44
From: moshe
To: moshe

How are you, friend?
.
rNrjrer'r'r(�	test_RETR�s
�
	zCommandMixin.test_RETRcCro)z�
        Test that trying to download a message with a bad argument, either not
        an integer or an out-of-bounds integer, fails with the appropriate
        error response.
        sRETR arprsRETR 0r�Nrlrer'r'r(�test_RETRWithBadArgument�s







z%CommandMixin.test_RETRWithBadArgumentcCsB|j}|j}|jj�|j�|�d�|��|�|�	�d�dS)zQ
        Test downloading the headers and part of the body of a message.
        sTOP 1 0s9+OK Top of message follows
From: moshe
To: moshe

.
N)
rardr;r�rf�extraMessagerSrhrr8rer'r'r(rB�s
�zCommandMixin.test_TOPcCs|j}|j}|jj�|j�|�d�|�|��d�|�	d�|�
d�|�d�|�|��d�|�	d�|�
d�|�d�|�|��d�|�	d�|�
d�|�d�|�|��d�|�	d�|�
d�|�d�|�|��d�|�	d�|�
d�d	S)
a$
        Test that trying to download a message with a bad argument, either a
        message number which isn't an integer or is an out-of-bounds integer or
        a number of lines which isn't an integer or is a negative integer,
        fails with the appropriate error response.
        sTOP 1 as-ERR Bad line count argument
rsTOP 1 -1sTOP a 1rpsTOP 0 1sTOP 3 1N�rardr;r�rfrurSrr8rbrcrer'r'r(�test_TOPWithBadArgument�s.













z$CommandMixin.test_TOPWithBadArgumentcCsN|j}|j}|jj�|j�|�d�|�|��d�|�	d�|�
d�dS)z�
        Test the exceedingly pointless LAST command, which tells you the
        highest message index which you have already downloaded.
        �LASTr7rNrvrer'r'r(�	test_LASTs

zCommandMixin.test_LASTcCst|j}|j}|jj�|j�|�d�|��|�d�|�	d�|�d�|�
|��d�|�d�|�	d�dS)zM
        Test that issuing a RETR command updates the LAST response.
        r�rrx�+OK 2
N�rardr;r�rfrurSrhrbrcrr8rer'r'r(�test_RetrieveUpdatesHighest&s




z(CommandMixin.test_RetrieveUpdatesHighestcCs`|j}|j}|jj�|j�|�d�|��|�d�|�	d�|�d�|�
|��d�dS)zL
        Test that issuing a TOP command updates the LAST response.
        sTOP 2 10rrxrzNr{rer'r'r(�test_TopUpdatesHighest7s



z#CommandMixin.test_TopUpdatesHighestcCsr|j}|j}|jj�|j�|�d�|��|�d�|��|�d�|�	d�|�d�|�
|��d�dS)z�
        Test that downloading a message with a smaller index than the current
        LAST response doesn't change the LAST response.
        r�sTOP 1 10rrxrzNr{rer'r'r(�test_HighestOnlyProgressesFs




z'CommandMixin.test_HighestOnlyProgressescCsj|j}|j}|jj�|j�|�d�|��|�d�|�d�|�	d�|�d�|�
|��d�dS)zH
        Test that issuing RSET changes the LAST response to 0.
        r�sRSETrrxr7Nr{rer'r'r(�test_ResetClearsHighestXs




z$CommandMixin.test_ResetClearsHighestN)rLrMrNrOrur�rfrhrkrmr@rqrrrsrtrBrwryr|r}r~rr'r'r'r(r^(s(	$r^z}twisted.mail.pop3.IMailbox.listMessages may not raise IndexError for out-of-bounds message numbers: raise ValueError instead.)rg�categoryzxtwisted.mail.pop3.IMailbox.getUidl may not raise IndexError for out-of-bounds message numbers: raise ValueError instead.c@sXeZdZdZeZeZdd�Ze	ge_
dd�Zege_
dd�Z
e	ge
_
dd	�Ze	ge_
d
S)�IndexErrorCommandTestsz�
    Run all of the command tests against a mailbox which raises IndexError
    when an out of bounds request is made.  This behavior will be deprecated
    shortly and then removed.
    cC�
t�|�S)z�
        An attempt to get metadata about a message with a bad argument fails
        with an I{ERR} response even if the mailbox implementation raises
        L{IndexError}.
        )r^rmr.r'r'r(rm��
z/IndexErrorCommandTests.test_LISTWithBadArgumentcCr�)z�
        An attempt to look up the UID of a message with a bad argument fails
        with an I{ERR} response even if the mailbox implementation raises
        L{IndexError}.
        )r^rqr.r'r'r(rq�r�z/IndexErrorCommandTests.test_UIDLWithBadArgumentcCr�)z�
        An attempt to download some of a message with a bad argument fails with
        an I{ERR} response even if the mailbox implementation raises
        L{IndexError}.
        )r^rwr.r'r'r(rw�r�z.IndexErrorCommandTests.test_TOPWithBadArgumentcCr�)z�
        An attempt to download a message with a bad argument fails with an
        I{ERR} response even if the mailbox implementation raises
        L{IndexError}.
        )r^rtr.r'r'r(rt�r�z/IndexErrorCommandTests.test_RETRWithBadArgumentN)rLrMrNrO�
IndexErrorr�r�r_rm�_listMessageSuppressionr�rq�_getUidlSuppressionrwrtr'r'r'r(r�|sr�c@seZdZdZeZeZdS)�ValueErrorCommandTestsa
    Run all of the command tests against a mailbox which raises ValueError
    when an out of bounds request is made.  This is the correct behavior and
    after support for mailboxes which raise IndexError is removed, this will
    become just C{CommandTestCase}.
    N)rLrMrNrOr�r�r�r_r'r'r'r(r��sr�c@seZdZdZddd�ZdS)�SyncDeferredMailboxzo
    Mailbox which has a listMessages implementation which returns a Deferred
    which has already fired.
    NcCst�t�||��S)z�
        Synchronously list messages.

        @type n: L{int} or L{None}
        @param n: The 0-based index of the message.

        @return: A L{Deferred} which already has a message list result.
        )r	�succeedr�ry)r!r&r'r'r(ry�s	z SyncDeferredMailbox.listMessagesr_)rLrMrNrOryr'r'r'r(r��sr�c@�eZdZdZeZdS)�"IndexErrorSyncDeferredCommandTestsz{
    Run all of the L{IndexErrorCommandTests} tests with a
    synchronous-Deferred returning IMailbox implementation.
    N�rLrMrNrOr�r_r'r'r'r(r���r�c@r�)�"ValueErrorSyncDeferredCommandTestsz{
    Run all of the L{ValueErrorCommandTests} tests with a
    synchronous-Deferred returning IMailbox implementation.
    Nr�r'r'r'r(r��r�r�c@s"eZdZdZdd�Zddd�ZdS)�AsyncDeferredMailboxzo
    Mailbox which has a listMessages implementation which returns a Deferred
    which has not yet fired.
    cOs"g|_tj|g|�Ri|��dSr_)�waitingr�rb)r!r*�kwr'r'r(rb�szAsyncDeferredMailbox.__init__NcCs$t��}|j�|t�||�f�|S)z�
        Record a new unfired L{Deferred} in C{self.waiting} and return it.

        @type n: L{int} or L{None}
        @param n: The 0-based index of the message.

        @return: The L{Deferred}
        )r	�Deferredr�rfr�ry)r!r&r�r'r'r(ry�s	z!AsyncDeferredMailbox.listMessagesr_)rLrMrNrOrbryr'r'r'r(r��sr�c@�eZdZdZeZdd�ZdS)�#IndexErrorAsyncDeferredCommandTests�}
    Run all of the L{IndexErrorCommandTests} tests with an
    asynchronous-Deferred returning IMailbox implementation.
    cC�>|jjjr|jjj��\}}|�|�|jjjst�|�dS�zH
        Fire whatever Deferreds we've built up in our mailbox.
        N)rar;r��pop�callbackr�rh�r!r�r*r'r'r(rh�



�z*IndexErrorAsyncDeferredCommandTests._flushN�rLrMrNrOr�r_rhr'r'r'r(r���r�c@r�)�#ValueErrorAsyncDeferredCommandTestsr�cCr�r�)rar;r�r�r�r�rhr�r'r'r(rhr�z*ValueErrorAsyncDeferredCommandTests._flushNr�r'r'r'r(r�
r�r�c@r�)�
POP3MiscTestsz}
    Miscellaneous tests more to do with module/package structure than
    anything to do with the Post Office Protocol.
    cCs(tjj}|jD]
}|�t||��qdS)z�
        This test checks that all names listed in
        twisted.mail.pop3.__all__ are actually present in the module.
        N)�twistedrr
�__all__r��hasattr)r!�mod�attrr'r'r(�test_all"s
�zPOP3MiscTests.test_allN)rLrMrNrOr�r'r'r'r(r�sr�c@r�)�POP3ClientDeprecationTestszI
    Tests for the now deprecated L{twisted.mail.pop3client} module.
    cCs\ddlm}|j|jgd�}|�|ddt�|�|ddd�|�t|�d�|dS)	z�
        A deprecation warning is emitted when directly importing the now
        deprected pop3client module.

        This test might fail is some other code has already imported it.
        No code should use the deprected module.
        r)�
pop3client)�offendingFunctionsr�rgzXtwisted.mail.pop3client was deprecated in Twisted 21.2.0. Use twisted.mail.pop3 instead.r9N)�twisted.mailr��
flushWarnings�test_deprecationr�DeprecationWarningrs)r!r��
warningsShownr'r'r(r�1s
�z+POP3ClientDeprecationTests.test_deprecationN)rLrMrNrOr�r'r'r'r(r�,r�r�)LrOrUrWr�collectionsr�hashlibr�ior�zope.interfacer�twisted.cred.checkersr��twisted.cred.credentials�twisted.cred.portal�twisted.internet.protocol�twisted.mail.pop3�twisted.mail.protocolsrrr�twisted.internetr	r�r
�twisted.protocolsr�twisted.pythonr�twisted.test.proto_helpersr
�
twisted.trialrr�TestCaser�	protocols�VirtualPOP3rQr^rmr�r�r�r2r�r��Mailboxr�r��IServerFactoryrr'r/r0rIr�rNr^�_listMessageDeprecationr��PendingDeprecationWarningr��_getUidlDeprecationr�r�r�r�r�r�r�r�r�r�r�r'r'r'r(�<module>s�X)84_<>7P)&D����3