File: //usr/lib/python3/dist-packages/twisted/internet/test/__pycache__/connectionmixins.cpython-38.pyc
U
W[�O � @ s� d Z ddlmZmZ ddlZddlmZ ddlmZ ddl m
Z
ddl m Z m
Z
ddlmZ dd lmZ dd
lmZmZmZ dd lmZmZ dd lmZmZ dd
l m Z m Z m Z ddl m!Z! ddl"m#Z# ddl$m%Z% dej&ej'fdd�Z(G dd� de �Z)G dd� de*�Z+G dd� de �Z,dd� Z-d d � Z.G d d � d e �Z/G d d!� d!e*�Z0G d"d#� d#e �Z1G d$d%� d%e)�Z2G d&d'� d'e*�Z3G d(d)� d)e*�Z4G d*d+� d+e*�Z5G d,d-� d-e*�Z6dS ).z?
Various helpers for tests for connection-oriented transports.
� )�division�absolute_importN)�collect)�ref)� verifyObject)�context�log)�Failure)�platform)� ILogContext�msg�err)�Deferred�
gatherResults)�
IConnector�
IReactorFDSet)�
ClientFactory�Protocol�
ServerFactory)�SkipTest)�needsRunningReactor)�ClosingProtocolz 127.0.0.1c C s� t �| d�d d }t � ||�}zT|�|� |t jkrf|�� }t �|t jt jB �d }||d fW �S |�� W �S W 5 |�� X dS )a�
Ask the platform to allocate a free port on the specified interface, then
release the socket and return the address which was allocated.
@param interface: The local address to try to bind the port on.
@type interface: C{str}
@param type: The socket type which will use the resulting port.
@return: A two-tuple of address and port, like that returned by
L{socket.getsockname}.
r � � N) �socketZ getaddrinfo�closeZbindZAF_INET6Z getsocknameZ getnameinfoZNI_NUMERICHOSTZNI_NUMERICSERV)Z interfaceZfamily�type�addrZprobeZsocknameZhostname� r �H/usr/lib/python3/dist-packages/twisted/internet/test/connectionmixins.py� findFreePort s
��r c @ s$ e Zd ZdZdZdd� Zdd� ZdS )�ConnectableProtocolab
A protocol to be used with L{runProtocolsWithReactor}.
The protocol and its pair should eventually disconnect from each other.
@ivar reactor: The reactor used in this test.
@ivar disconnectReason: The L{Failure} passed to C{connectionLost}.
@ivar _done: A L{Deferred} which will be fired when the connection is
lost.
Nc C s || _ || _dS )aN
Set attributes on the protocol that are known only externally; this
will be called by L{runProtocolsWithReactor} when this protocol is
instantiated.
@param reactor: The reactor used in this test.
@param done: A L{Deferred} which will be fired when the connection is
lost.
N)�reactor�_done)�selfr" Zdoner r r �_setAttributesM s z"ConnectableProtocol._setAttributesc C s || _ | j�d � | `d S �N)�disconnectReasonr# �callback�r$ �reasonr r r �connectionLost\ s z"ConnectableProtocol.connectionLost)�__name__�
__module__� __qualname__�__doc__r' r% r+ r r r r r! = s
r! c @ s e Zd ZdZdd� Zdd� ZdS )�EndpointCreatorzT
Create client and server endpoints that know how to connect to each other.
c C s
t � �dS )z�
Return an object providing C{IStreamServerEndpoint} for use in creating
a server to use to establish the connection type to be tested.
N��NotImplementedError�r$ r" r r r �serverh s zEndpointCreator.serverc C s
t � �dS )z�
Return an object providing C{IStreamClientEndpoint} for use in creating
a client to use to establish the connection type to be tested.
Nr1 )r$ r" Z
serverAddressr r r �clientp s zEndpointCreator.clientN)r, r- r. r/ r4 r5 r r r r r0 c s r0 c @ s e Zd ZdZdd� Zdd� ZdS )�_SingleProtocolFactoryz�
Factory to be used by L{runProtocolsWithReactor}.
It always returns the same protocol (i.e. is intended for only a single
connection).
c C s
|| _ d S r& �Z _protocol)r$ �protocolr r r �__init__� s z _SingleProtocolFactory.__init__c C s | j S r& r7 )r$ r r r r �
buildProtocol� s z$_SingleProtocolFactory.buildProtocolN�r, r- r. r/ r9 r: r r r r r6 y s r6 c s� | � � �|��t� � |��t� � t|�}t|�� ����}|�|�}� ��fdd�}|�|� dd� }t|j|jg��|��fdd�� |� |� |��fdd�� | �
�� �S )a�
Connect two protocols using endpoints and a new reactor instance.
A new reactor will be created and run, with the client and server protocol
instances connected to each other using the given endpoint creator. The
protocols should run through some set of tests, then disconnect; when both
have disconnected the reactor will be stopped and the function will
return.
@param reactorBuilder: A L{ReactorBuilder} instance.
@param serverProtocol: A L{ConnectableProtocol} that will be the server.
@param clientProtocol: A L{ConnectableProtocol} that will be the client.
@param endpointCreator: An instance of L{EndpointCreator}.
@return: The reactor run by this test.
c s �� �| �� �}|�� �S r& )r5 �getHost�connect)�pZclientEndpoint)�
clientFactory�endpointCreatorr" r r �gotPort� s
�z(runProtocolsWithReactor.<locals>.gotPortc S s t �| d� d S )NzConnection setup failed.)r r
)�resultr r r �failed� s z'runProtocolsWithReactor.<locals>.failedc s � S r& r ��_)� disconnectedr r �<lambda>� � z)runProtocolsWithReactor.<locals>.<lambda>c s t � � j�S r& )r �stoprD �r" r r rG � rH ) � buildReactorr% r r6 r4 �listen� addCallbackr r# �
addErrback�
runReactor) ZreactorBuilderZserverProtocol�clientProtocolr@ Z
serverFactoryZserverEndpoint�drA rC r )r? rF r@ r" r �runProtocolsWithReactor� s
rR c C s6 t �| �r| �� S d| jjkr$| jS td| f ��dS )zZ
Like L{IReactorFDSet.getWriters}, but with support for IOCP reactor as
well.
ZIOCPzCannot find writers on %rN)r Z
providedByZ
getWriters� __class__r, Zhandles� ExceptionrJ r r r � _getWriters� s
rU c @ s e Zd ZdZdd� Zdd� ZdS )�_AcceptOneClientaN
This factory fires a L{Deferred} with a protocol instance shortly after it
is constructed (hopefully long enough afterwards so that it has been
connected to a transport).
@ivar reactor: The reactor used to schedule the I{shortly}.
@ivar result: A L{Deferred} which will be fired with the protocol instance.
c C s || _ || _d S r& )r" rB )r$ r" rB r r r r9 � s z_AcceptOneClient.__init__c C s$ t �| |�}| j�d| jj|� |S )Nr )r r: r" � callLaterrB r( )r$ r r8 r r r r: � s z _AcceptOneClient.buildProtocolNr; r r r r rV � s rV c @ s( e Zd ZdZdd� Zdd� Zdd� ZdS ) �_SimplePullProducerz�
A pull producer which writes one byte whenever it is resumed. For use by
C{test_unregisterProducerAfterDisconnect}.
c C s
|| _ d S r& )�consumer)r$ rY r r r r9 � s z _SimplePullProducer.__init__c C s d S r& r �r$ r r r �
stopProducing� s z!_SimplePullProducer.stopProducingc C s t �d� | j�d� d S )N�Producer.resumeProducing� x)r r rY �writerZ r r r �resumeProducing� s
z#_SimplePullProducer.resumeProducingN)r, r- r. r/ r9 r[ r_ r r r r rX � s rX c @ s$ e Zd ZdZdZdd� Zdd� ZdS )�StopzQ
A client factory which stops a reactor when a connection attempt fails.
Nc C s
|| _ d S r& rJ r3 r r r r9 � s z
Stop.__init__c C s& || _ td|�� f � | j�� d S )NzStop(CF) cCFailed: %s)�
failReasonr ZgetErrorMessager" rI )r$ � connectorr* r r r �clientConnectionFailed� s zStop.clientConnectionFailed)r, r- r. r/ ra r9 rc r r r r r` � s r` c @ s0 e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
S ) �ClosingLaterProtocolz�
ClosingLaterProtocol exchanges one byte with its peer and then disconnects
itself. This is mostly a work-around for the fact that connectionMade is
called before the SSL handshake has completed.
c C s d | _ || _d S r& )�lostConnectionReason�onConnectionLost)r$ rf r r r r9 s z ClosingLaterProtocol.__init__c C s t d� d S )N�#ClosingLaterProtocol.connectionMade)r rZ r r r �connectionMade s rg c C s t d|f � | j�� d S )Nz$ClosingLaterProtocol.dataReceived %r�r � transport�loseConnection�r$ �bytesr r r � dataReceived s z!ClosingLaterProtocol.dataReceivedc C s t d� || _| j�| � d S )N�#ClosingLaterProtocol.connectionLost)r re rf r( r) r r r r+ s ro N)r, r- r. r/ r9 rh rn r+ r r r r rd s
rd c @ s, e Zd ZdZdZdd� Zdd� Zdd� ZdS ) �ConnectionTestsMixinzg
This mixin defines test methods which should apply to most L{ITransport}
implementations.
Nc C sP G dd� dt �}|d�}|d�}t| ||| j� | �d|j� | �d|j� dS )z�
Client and server transports implement L{ILoggingContext.logPrefix} to
return a message reflecting the protocol they are running.
c @ s, e Zd Zdd� Zdd� Zdd� Zdd� Zd S )
zDConnectionTestsMixin.test_logPrefix.<locals>.CustomLogPrefixProtocolc S s || _ d | _d S r& )�_prefix�system)r$ �prefixr r r r9 1 s zMConnectionTestsMixin.test_logPrefix.<locals>.CustomLogPrefixProtocol.__init__c S s | j �d� d S )N� a)rj r^ rZ r r r rh 5 s zSConnectionTestsMixin.test_logPrefix.<locals>.CustomLogPrefixProtocol.connectionMadec S s | j S r& )rq rZ r r r � logPrefix8 s zNConnectionTestsMixin.test_logPrefix.<locals>.CustomLogPrefixProtocol.logPrefixc S s2 t �t�d | _| j�d� d|kr.| j�� d S )Nrr � b)r �getr rr rj r^ rk rl r r r rn ; s zQConnectionTestsMixin.test_logPrefix.<locals>.CustomLogPrefixProtocol.dataReceivedN)r, r- r. r9 rh ru rn r r r r �CustomLogPrefixProtocol0 s rx z
Custom Clientz
Custom ServerN)r! rR � endpointsZassertInrr )r$ rx r5 r4 r r r �test_logPrefix+ s z#ConnectionTestsMixin.test_logPrefixc s� �� � �g � t� ��fdd�}�j����t�|���� ���fdd�����fdd�}t�|� ���� �� � ddg� dS ) z}
After a connection is disconnected, L{ITransport.write} and
L{ITransport.writeSequence} are no-ops.
c s t � �S r& �rd r )� serverConnectionLostDeferredr r rG T rH z@ConnectionTestsMixin.test_writeAfterDisconnect.<locals>.<lambda>c s� t d| �� f � �j��| �� �}t� � � fdd�}|�t�|��}dd� }|�|� j � �fdd�}� �
|� ��
|� t � �g�S )N�Listening on %rc s t � �S r& r{ r ��lostConnectionDeferredr r rG \ rH zSConnectionTestsMixin.test_writeAfterDisconnect.<locals>.listening.<locals>.<lambda>c S s t d| f � | j�d� d S )NzAbout to write to %rr] )r rj r^ ��protor r r r^ ^ s zPConnectionTestsMixin.test_writeAfterDisconnect.<locals>.listening.<locals>.writec s8 t d| f � | j�d� | j�ddg� � �d� d S )Nz%r disconnecteds some bytes to get losts somes moreT)r rj r^ Z
writeSequence�appendr� ��finishedr r rF c s zWConnectionTestsMixin.test_writeAfterDisconnect.<locals>.listening.<locals>.disconnected) r r< ry r5 r r= r � forProtocolZ addCallbacks�errbackrM r )�port�endpointr8 r5 r^ rF )r� r" r$ r| r~ r � listeningW s
�zAConnectionTestsMixin.test_writeAfterDisconnect.<locals>.listeningc s* �� � � ��t� �� �fdd�� d S )Nc s � � � S r& �rI �ZignoredrJ r r rG q rH zRConnectionTestsMixin.test_writeAfterDisconnect.<locals>.onListen.<locals>.<lambda>)rM rN r
r �r� � portDeferredr" r r �onListenn s
z@ConnectionTestsMixin.test_writeAfterDisconnect.<locals>.onListenTN)
rK r ry r4 rL r r� r rO Z assertEqual)r$ r8 r� r )r� r� r� r" r$ r| r �test_writeAfterDisconnectJ s �
z.ConnectionTestsMixin.test_writeAfterDisconnectc s� t � �t��� t� �}��� ��j����t�t ���� ���fdd�����fdd�}t
�|� �� �� d� t � ��
|� � dS )z�
After the connection a protocol is being used for is closed, the
reactor discards all of its references to the protocol.
c s^ t d| �� f � �j��| �� �}|�t�� fdd���}dd� }|�|� |��j � �S )Nr} c s � S r& r r )rP r r rG � rH zaConnectionTestsMixin.test_protocolGarbageAfterLostConnection.<locals>.listening.<locals>.<lambda>c S s t d| f � | j�� d S )NzAbout to disconnect %rri r� r r r �
disconnect� s zcConnectionTestsMixin.test_protocolGarbageAfterLostConnection.<locals>.listening.<locals>.disconnect)
r r< ry r5 r= r r� rM rN r� )r� r� r5 r� )rP r r" r$ r r r� � s �
zOConnectionTestsMixin.test_protocolGarbageAfterLostConnection.<locals>.listeningc s* �� � � ��t� ���fdd�� d S )Nc s � � � S r& r� r� rJ r r rG � rH zcConnectionTestsMixin.test_protocolGarbageAfterLostConnection.<locals>.onListening.<locals>.<lambda>)rM rN r
ZaddBothr r� r r � onListening� s
zQConnectionTestsMixin.test_protocolGarbageAfterLostConnection.<locals>.onListeningN)r rd r rK ry r4 rL r r� r r rO r Z assertIsNone)r$ Z clientRefr� r )rP r� r r� r" r$ r �'test_protocolGarbageAfterLostConnectionx s �
z<ConnectionTestsMixin.test_protocolGarbageAfterLostConnection)r, r- r. r/ ry rz r� r� r r r r rp ! s
.rp c @ s e Zd ZdZdd� ZdS )�LogObserverMixinzL
Mixin for L{TestCase} subclasses which want to observe log events.
c C s$ g }t �|j� | �t j|j� |S r& )r Z addObserverr� Z
addCleanupZremoveObserver)r$ ZloggedMessagesr r r �observe� s zLogObserverMixin.observeN)r, r- r. r/ r� r r r r r� � s r� c @ s e Zd ZdZdZdd� ZdS )�BrokenContextFactoryzv
A context factory with a broken C{getContext} method, for exercising the
error handling for such a case.
zSome path was wrong maybec C s t | j��d S r& )�
ValueError�messagerZ r r r �
getContext� s z BrokenContextFactory.getContextN)r, r- r. r/ r� r� r r r r r� � s r� c @ s8 e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
d � Zd S )
�StreamClientTestsMixinau
This mixin defines tests applicable to SOCK_STREAM client implementations.
This must be mixed in to a L{ReactorBuilder
<twisted.internet.test.reactormixins.ReactorBuilder>} subclass, as it
depends on several of its methods.
Then the methods C{connect} and C{listen} must defined, defining a client
and a server communicating with each other.
c C s* | � � }| �|t� �}| �tt|�� dS )zR
The C{connect} method returns an object providing L{IConnector}.
N)rK r= r �
assertTruer r )r$ r" rb r r r �test_interface� s z%StreamClientTestsMixin.test_interfacec s* �� � � t� � �fdd�� ��� � dS )zl
The reactor can be stopped by a client factory's
C{clientConnectionFailed} method.
c s �� � t� ��S r& )r= r` r �r" r$ r r rG � rH zPStreamClientTestsMixin.test_clientConnectionFailedStopsReactor.<locals>.<lambda>N)rK r rO rZ r r� r �'test_clientConnectionFailedStopsReactor� s �z>StreamClientTestsMixin.test_clientConnectionFailedStopsReactorc sn �� � ����t�t�� g �G ��fdd�dt�}t��� |� _t�� ��fdd�� ��� �� �� dS )z�
This test checks that we correctly get notifications event for a
client. This ought to prevent a regression under Windows using the
GTK2 reactor. See #3925.
c s e Zd Z� �fdd�ZdS )zAStreamClientTestsMixin.test_connectEvent.<locals>.CheckConnectionc s � � | � ��� d S r& )r� rI rZ �� connectedr" r r rh � s
zPStreamClientTestsMixin.test_connectEvent.<locals>.CheckConnection.connectionMadeN)r, r- r. rh r r� r r �CheckConnection� s r� c s �� �� �S r& )r= r )r? r" r$ r r rG � rH z:StreamClientTestsMixin.test_connectEvent.<locals>.<lambda>N)
rK rL r r� r r` r8 r �runr� )r$ r� r )r? r� r" r$ r �test_connectEvent� s �z(StreamClientTestsMixin.test_connectEventc s� | � � �| ��t�t�� t� � � �tj� � � �fdd�� g �G � ��fdd�dt
�}t � }||_ | �
�|� | ��� | ��d d� dS )a3
If a producer is unregistered from a transport after the transport has
been disconnected (by the peer) and after C{loseConnection} has been
called, the transport is not re-added to the reactor as a writer as
would be necessary if the transport were still connected.
c s � � � S r& r� �ZignrJ r r rG rH zOStreamClientTestsMixin.test_unregisterProducerAfterDisconnect.<locals>.<lambda>c s0 e Zd ZdZdd� Z� ��fdd�Zdd� ZdS ) zUStreamClientTestsMixin.test_unregisterProducerAfterDisconnect.<locals>.ClientProtocolz�
Protocol to connect, register a producer, try to lose the
connection, wait for the server to disconnect from us, and then
unregister the producer.
c S s, t �d� | j�t| j�d� | j�� d S )N� ClientProtocol.connectionMadeF)r r rj �registerProducerrX rk rZ r r r rh s
�zdStreamClientTestsMixin.test_unregisterProducerAfterDisconnect.<locals>.ClientProtocol.connectionMadec s4 t �d� | �� ��| jt��k� � �d � d S �Nz ClientProtocol.connectionLost)r r �
unregisterr� rj rU r( r) �r� r" Zwritingr r r+ s
zdStreamClientTestsMixin.test_unregisterProducerAfterDisconnect.<locals>.ClientProtocol.connectionLostc S s t �d� | j�� d S )N�ClientProtocol unregister)r r rj �unregisterProducerrZ r r r r� s
z`StreamClientTestsMixin.test_unregisterProducerAfterDisconnect.<locals>.ClientProtocol.unregisterN)r, r- r. r/ rh r+ r� r r� r r �ClientProtocol s r� r z/Transport was writing after unregisterProducer.N)rK rL r r� r r rN r r
rM r r r8 r= rO Z assertFalse)r$ r� r? r r� r �&test_unregisterProducerAfterDisconnect� s
�z=StreamClientTestsMixin.test_unregisterProducerAfterDisconnectc s� | � � �ddg}�jj}||kr0t�� r0td��G dd� d�� | ��t�t �� t
� ��� t j
� ���fdd�� G � ��fdd �d t �}t� }||_| ��|� | ��� d
S ) z�
If C{loseConnection} is called while a producer is registered with the
transport, the connection is closed after the producer is unregistered.
Z Glib2ReactorZ Gtk2Reactorz=A pygobject/pygtk bug disables this functionality on Windows.c @ s e Zd Zdd� ZdS )zFStreamClientTestsMixin.test_disconnectWhileProducing.<locals>.Producerc S s t �d� d S )Nr\ )r r rZ r r r r_ 8 s zVStreamClientTestsMixin.test_disconnectWhileProducing.<locals>.Producer.resumeProducingN)r, r- r. r_ r r r r �Producer7 s r� c s � � � S r& r� r� rJ r r rG ? rH zFStreamClientTestsMixin.test_disconnectWhileProducing.<locals>.<lambda>c s8 e Zd ZdZ� �fdd�Z��fdd�Z�fdd�ZdS ) zLStreamClientTestsMixin.test_disconnectWhileProducing.<locals>.ClientProtocolz�
Protocol to connect, register a producer, try to lose the
connection, unregister the producer, and wait for the connection to
actually be lost.
c s< t �d� | j�� � d� | j�� ��d�jd| j� d S )Nr� Fr )r r rj r� rk rW r� rZ )r� r" r r rh G s
z[StreamClientTestsMixin.test_disconnectWhileProducing.<locals>.ClientProtocol.connectionMadec s0 t �d� | j�� ��d� jttd��� d S )Nr� g �?zConnection was not lost)r r rj r� rW r� r rT rZ )r� r" r r r� Q s
�zWStreamClientTestsMixin.test_disconnectWhileProducing.<locals>.ClientProtocol.unregisterc s t �d� � �d � d S r� )r r r( r) r� r r r+ [ s
z[StreamClientTestsMixin.test_disconnectWhileProducing.<locals>.ClientProtocol.connectionLostN)r, r- r. r/ rh r� r+ r �r� r� r" r r r� A s
r� N)rK rS r, r
Z isWindowsr rL r r� r r rN r r
rM r r8 r= rO )r$ ZskippedReactorsZreactorClassNamer� r? r r� r � test_disconnectWhileProducing$ s" � z4StreamClientTestsMixin.test_disconnectWhileProducingN) r, r- r. r/ r� r� r� r� r� r r r r r� � s /r� )7r/ Z
__future__r r r �gcr �weakrefr Zzope.interface.verifyr Ztwisted.pythonr r Ztwisted.python.failurer Ztwisted.python.runtimer
Ztwisted.python.logr r r
Ztwisted.internet.deferr r Ztwisted.internet.interfacesr r Ztwisted.internet.protocolr r r Ztwisted.trial.unittestr Z#twisted.internet.test.reactormixinsr Ztwisted.test.test_tcpr ZAF_INETZ SOCK_STREAMr r! �objectr0 r6 rR rU rV rX r` rd rp r� r� r� r r r r �<module> s@ �
&3