File: //usr/lib/python3/dist-packages/twisted/pair/test/__pycache__/test_tuntap.cpython-38.pyc
U
W[Ϲ � @ s d Z ddlmZmZ ddlZddlZddlZddlmZm Z m
Z
m Z m Z m
Z
mZ ddlmZ ddlmZ ddlmZ ddlmZ dd lmZmZ dd
lmZm Z z e d � W n ee fk
r� d Z Y nX dZ dd
l m Z m!Z! ddl"m#Z# ddl$m%Z% ddl&m'Z' ddl(m)Z) ddl*m+Z+ ddl,m-Z- ddlm.Z. ddlm/Z/ ddl0m1Z1m2Z2m3Z3 ddl$m4Z4m5Z5 ddl&m6Z6m7Z7 ddl8m9Z9 ddl:m;Z;m<Z< ddl=m>Z> dd l?m@Z@ eAZBe ZCe dk�rdd lDmEZEmFZFmGZGmHZHmIZImJZJmKZKmLZL dd lMmNZNmOZOmBZBmCZCmPZPmQZQmRZR ne ZSe!e5�G d d � d eA��ZTe#e5eT� � G d!d"� d"e9eT�ZUG d#d$� d$eA�ZVG d%d&� d&eA�ZWG d'd(� d(e<�ZXG d)d*� d*eA�ZYG d+d,� d,eA�ZZG d-d.� d.eZeYe<�Z[eWe[j\e[j]d/d0�e[_^G d1d2� d2eZeYe<�Z_eWe[j\e[j]d3d0�e__^G d4d5� d5eZeYe<�Z`eVe`j\e`j]�e`_^e!eC�G d6d7� d7eB��ZaG d8d9� d9eA�ZbG d:d;� d;ebeYe<�ZcG d<d=� d=ebeYe<�ZdG d>d?� d?e<�ZeG d@dA� dAeA�ZfG dBdC� dCe<�ZgG dDdE� dEe<�Zhe!e@�G dFdG� dGe6��ZiG dHdI� dIefe<�ZjG dJdK� dKe-�ZkG dLdM� dMefe<�ZlG dNdO� dOeA�ZmG dPdQ� dQeme<eZ�ZnG dRdS� dSeme<eb�ZodS )Tz#
Tests for L{twisted.pair.tuntap}.
� )�division�absolute_importN)�EPERM�EBADF�EINVAL�EAGAIN� EWOULDBLOCK�ENOENT�ENODEV)� randrange)�deque)�cycle)�SIGINT)�
intToBytes�_PY3)�ObjectNotFound�namedAnyz fcntl.ioctlz'Platform is missing fcntl/ioctl support)� Interface� implementer)� verifyObject)�IListeningPort)�DatagramProtocol)�RawUDPProtocol)�
IPProtocol)�EthernetProtocol)�fullyQualifiedName)� iterbytes)� addObserver�removeObserver�textFromEventDict)�IAddress�
IReactorFDSet)�AbstractDatagramProtocol�Factory)�Clock)�SkipTest�SynchronousTestCase)�CannotListenError)�IRawPacketProtocol)�_PI_SIZE�Tunnel�MemoryIOSystem�_IPv4�_H� _ethernet�_ip�_udp)�
_TUNSETIFF� _IFNAMSIZ� _RealSystem�_IInputOutputSystem� TunnelFlags�
TunnelAddress�
TuntapPortc @ s@ e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
d � Zd d
� Z dS )� ReactorFDSeta6
An implementation of L{IReactorFDSet} which only keeps track of which
descriptors have been registered for reading and writing.
This implementation isn't actually capable of determining readability or
writeability and generates no events for the descriptors registered with
it.
@ivar _readers: A L{set} of L{IReadDescriptor} providers which the reactor
is supposedly monitoring for read events.
@ivar _writers: A L{set} of L{IWriteDescriptor} providers which the reactor
is supposedly monitoring for write events.
c C s( t � | _t � | _| jj| _| jj| _d S �N)�set�_readers�_writers�addZ addReaderZ addWriter��self� r@ �?/usr/lib/python3/dist-packages/twisted/pair/test/test_tuntap.py�__init__U s
zReactorFDSet.__init__c C s | j �|� d S r9 )r; �discard)r? �readerr@ r@ rA � removeReader\ s zReactorFDSet.removeReaderc C s | j �|� d S r9 )r< rC )r? �writerr@ r@ rA � removeWriter` s zReactorFDSet.removeWriterc C s
t | j�S r9 )�iterr; r> r@ r@ rA �
getReadersd s zReactorFDSet.getReadersc C s
t | j�S r9 )rH r< r> r@ r@ rA �
getWritersh s zReactorFDSet.getWritersc C s, zt| j| jB �W �S t � | _t � | _X d S r9 )r: r; r< �listr> r@ r@ rA � removeAlll s zReactorFDSet.removeAllN)
�__name__�
__module__� __qualname__�__doc__rB rE rG rI rJ rL r@ r@ r@ rA r8 E s r8 c @ s e Zd ZdZdd� ZdS )�
FSSetClockzI
An L{FSSetClock} is a L{IReactorFDSet} and an L{IReactorClock}.
c C s t �| � t�| � d S r9 )r$ rB r8 r> r@ r@ rA rB z s
zFSSetClock.__init__N)rM rN rO rP rB r@ r@ r@ rA rQ v s rQ c @ s4 e Zd ZdZedd� �Zdd� Zdd� Zdd � Zd
S ) � TunHelperzM
A helper for tests of tun-related functionality (ip-level tunnels).
c C s t jt jB S r9 )r5 �IFF_TUN� IFF_NO_PIr> r@ r@ rA � TUNNEL_TYPE� s zTunHelper.TUNNEL_TYPEc C s || _ || _dS )aw
@param tunnelRemote: The source address for UDP datagrams originated
from this helper. This is an IPv4 dotted-quad string.
@type tunnelRemote: L{bytes}
@param tunnelLocal: The destination address for UDP datagrams
originated from this helper. This is an IPv4 dotted-quad string.
@type tunnelLocal: L{bytes}
N)� tunnelRemote� tunnelLocal)r? rV rW r@ r@ rA rB � s
zTunHelper.__init__c C s t | j| jt|||d�d�S )a
Construct an ip datagram containing a udp datagram containing the given
application-level payload.
@param source: The source port for the UDP datagram being encapsulated.
@type source: L{int}
@param destination: The destination port for the UDP datagram being
encapsulated.
@type destination: L{int}
@param payload: The application data to include in the udp datagram.
@type payload: L{bytes}
@return: An ethernet frame.
@rtype: L{bytes}
)�src�dst�payload)r/ rV rW r0 )r? �source� destinationrZ r@ r@ rA � encapsulate� s ��zTunHelper.encapsulatec sR g � t � }� fdd�}||_t� }|�d|� t� ���d|� � �fdd�}|S )a�
Get a function for parsing a datagram read from a I{tun} device.
@return: A function which accepts a datagram exactly as might be read
from a I{tun} device. The datagram is expected to ultimately carry
a UDP datagram. When called, it returns a L{list} of L{tuple}s.
Each tuple has the UDP application data as the first element and
the sender address as the second element.
c s � � | � d S r9 ��append��args�� datagramsr@ rA �capture� s z!TunHelper.parser.<locals>.capture�90 � c s �� | dd d d � � S )NF)�datagramReceived)�data�rc �ipr@ rA �parse� s z TunHelper.parser.<locals>.parse)r rg r �addProtor )r? �receiverrd �udprk r@ ri rA �parser� s
zTunHelper.parserN� rM rN rO rP �propertyrU rB r] ro r@ r@ r@ rA rR � s
rR c @ s4 e Zd ZdZedd� �Zdd� Zdd� Zdd � Zd
S ) � TapHelperzS
A helper for tests of tap-related functionality (ethernet-level tunnels).
c C s t j}| js|t jO }|S r9 )r5 �IFF_TAP�pirT )r? �flagr@ r@ rA rU � s
zTapHelper.TUNNEL_TYPEc C s || _ || _|| _dS )a
@param tunnelRemote: The source address for UDP datagrams originated
from this helper. This is an IPv4 dotted-quad string.
@type tunnelRemote: L{bytes}
@param tunnelLocal: The destination address for UDP datagrams
originated from this helper. This is an IPv4 dotted-quad string.
@type tunnelLocal: L{bytes}
@param pi: A flag indicating whether this helper will generate and
consume a protocol information (PI) header.
@type pi: L{bool}
N)rV rW rt )r? rV rW rt r@ r@ rA rB � s zTapHelper.__init__c C sR t | j| j�}|�|||�}tddt|d�}| jrNt}d}t|�t|� | }|S )a<
Construct an ethernet frame containing an ip datagram containing a udp
datagram containing the given application-level payload.
@param source: The source port for the UDP datagram being encapsulated.
@type source: L{int}
@param destination: The destination port for the UDP datagram being
encapsulated.
@type destination: L{int}
@param payload: The application data to include in the udp datagram.
@type payload: L{bytes}
@return: An ethernet frame.
@rtype: L{bytes}
s s ������)rX rY �protocolrZ r )rR rV rW r] r. r, rt r- ) r? r[ r\ rZ Ztunrj �framerv �flagsr@ r@ rA r] � s �zTapHelper.encapsulatec sf g � t � }� fdd�}||_t� }|�d|� t� }|�d|� t� ���d|� � ��fdd�}|S )a�
Get a function for parsing a datagram read from a I{tap} device.
@return: A function which accepts a datagram exactly as might be read
from a I{tap} device. The datagram is expected to ultimately carry
a UDP datagram. When called, it returns a L{list} of L{tuple}s.
Each tuple has the UDP application data as the first element and
the sender address as the second element.
c s � � | � d S r9 r^ r` rb r@ rA rd s z!TapHelper.parser.<locals>.capturere rf i c s �j r| td � } ��| � � S r9 )rt r) rg )�datagram�rc Zetherr? r@ rA ro , s
z TapHelper.parser.<locals>.parser)r rg r rl r r )r? rm rd rn rj ro r@ rz rA ro s
zTapHelper.parserNrp r@ r@ r@ rA rr � s
rr c @ s e Zd ZdZdd� ZdS )� TunnelTestszs
L{Tunnel} is mostly tested by other test cases but some tests don't fit
there. Those tests are here.
c C s$ t t� tjd�}| �t|jd� dS )z�
Blocking reads are not implemented by L{Tunnel.read}. Attempting one
results in L{NotImplementedError} being raised.
N� )r* r+ �os�O_RDONLY� assertRaises�NotImplementedError�read�r? �tunnelr@ r@ rA �test_blockingRead@ s �z TunnelTests.test_blockingReadN)rM rN rO rP r� r@ r@ r@ rA r{ ; s r{ c @ s` e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
d � Zd d
� Z dd� Z
dd� Z dd� Z dd� Z
dS )�TunnelDeviceTestsMixinzZ
A mixin defining tests that apply to L{_IInputOutputSystem}
implementations.
c C sj | � � | _| j�dtjtjB �| _| �| jj| j� | j j
}t � dt
f | j|j�}| j�| jt|� dS )zk
Create the L{_IInputOutputSystem} provider under test and open a tunnel
using it.
� /dev/net/tunz%dsHN)� createSystem�system�openr} �O_RDWR�
O_NONBLOCK�fileno�
addCleanup�close�helperrU �structZpackr2 �_TUNNEL_DEVICE�value�ioctlr1 )r? �modeZconfigr@ r@ rA �setUpP s
� �z TunnelDeviceTestsMixin.setUpc C s | � tt| j�� dS )zH
The object under test provides L{_IInputOutputSystem}.
N)�
assertTruer r4 r� r> r@ r@ rA �test_interface` s z%TunnelDeviceTestsMixin.test_interfacec C s | j �dtj�}| j �|� |S )a@
Get an invalid file descriptor.
@return: An integer which is not a valid file descriptor at the time of
this call. After any future system call which allocates a new file
descriptor, there is no guarantee the returned file descriptor will
still be invalid.
r� )r� r� r} r� r� )r? �fdr@ r@ rA �_invalidFileDescriptorg s z-TunnelDeviceTestsMixin._invalidFileDescriptorc C s. | � � }| �t| jj|d�}| �t|j� dS )z�
The device's C{read} implementation raises L{OSError} with an errno of
C{EBADF} when called on a file descriptor which is not valid (ie, which
has no associated file description).
r| N)r� r �OSErrorr� r� � assertEqualr �errno�r? r� �excr@ r@ rA �test_readEBADFu s z%TunnelDeviceTestsMixin.test_readEBADFc C s. | � � }| �t| jj|d�}| �t|j� dS )z�
The device's C{write} implementation raises L{OSError} with an errno of
C{EBADF} when called on a file descriptor which is not valid (ie, which
has no associated file description).
s bytesN)r� r r� r� �writer� r r� r� r@ r@ rA �test_writeEBADF� s z&TunnelDeviceTestsMixin.test_writeEBADFc C s, | � � }| �t| jj|�}| �t|j� dS )z�
The device's C{close} implementation raises L{OSError} with an errno of
C{EBADF} when called on a file descriptor which is not valid (ie, which
has no associated file description).
N)r� r r� r� r� r� r r� r� r@ r@ rA �test_closeEBADF� s z&TunnelDeviceTestsMixin.test_closeEBADFc C s0 | � � }| �t| jj|td�}| �t|j� dS )z�
The device's C{ioctl} implementation raises L{OSError} with an errno of
C{EBADF} when called on a file descriptor which is not valid (ie, which
has no associated file description).
s tap0N) r� r �IOErrorr� r� r1 r� r r� r� r@ r@ rA �test_ioctlEBADF� s �z&TunnelDeviceTestsMixin.test_ioctlEBADFc C s. d}| � t| jj| j|d�}| �t|j� dS )z�
The device's C{ioctl} implementation raises L{IOError} with an errno of
C{EINVAL} when called with a request (second argument) which is not a
supported operation.
l �>[= s garbageN)r r� r� r� r� r� r r� )r? Zrequestr� r@ r@ rA �test_ioctlEINVAL� s �z'TunnelDeviceTestsMixin.test_ioctlEINVALc C s� | j �� }d}td�D ]�}td�}dt|� }| j�|| jdf�}td�D ]|}z| j�| j d�}W n< t
k
r� } z | j t t
fkr�W Y �
qȂ W 5 d} ~ X Y qJX ||�}
||f|
kr�d} q�|
dd�= qJ|r q�q|s�| �d � dS )
z�
If a UDP datagram is sent to an address reachable by the tunnel device
then it can be read out of the tunnel device.
F�d � � hello world:re r| NTz$Never saw probe UDP packet on tunnel)r� ro �ranger r r� �sendUDP�_TUNNEL_REMOTEr� r� �EnvironmentErrorr� r r Zfail) r? rk �found�i�key�messager[ �j�packet�erc r@ r@ rA � test_receive� s,
z#TunnelDeviceTestsMixin.test_receivec C s~ t d�}dt|� }| �tjt�� � t�d� | j�| j| j d�}| j
� dd|�}| j� | j|� |�
d�}| �||� dS )z�
If a UDP datagram is written the tunnel device then it is received by
the network to which it is addressed.
r� r� �x re iP� r| N)r r r� �socketZsetdefaulttimeoutZgetdefaulttimeoutr� �
receiveUDPr� �
_TUNNEL_LOCALr� r] r� Zrecvr� )r? r� r� �portr� r@ r@ rA � test_send� s
z TunnelDeviceTestsMixin.test_sendN)rM rN rO rP r� r� r� r� r� r� r� r� r� r� r@ r@ r@ rA r� K s 'r� c @ s$ e Zd ZdZdZdZdZdd� ZdS )�FakeDeviceTestsMixinz�
Define a mixin for use with test cases that require an
L{_IInputOutputSystem} provider. This mixin hands out L{MemoryIOSystem}
instances as the provider of that interface.
s tap-twistedtests
172.16.2.1s
172.16.2.2c C s t � }|�tjt� |S )z�
Create and return a brand new L{MemoryIOSystem}.
The L{MemoryIOSystem} knows how to open new tunnel devices.
@return: The newly created I/O system object.
@rtype: L{MemoryIOSystem}
)r+ �registerSpecialDevicer* � _DEVICE_NAME�r? r� r@ r@ rA r� s z!FakeDeviceTestsMixin.createSystemN)rM rN rO rP r� r� r� r� r@ r@ r@ rA r� � s
r� c @ s e Zd ZdZdS )�FakeTapDeviceTestszQ
Run various tap-type tunnel unit tests against an in-memory I/O system.
N�rM rN rO rP r@ r@ r@ rA r� s r� F�rt c @ s e Zd ZdZdS )�FakeTapDeviceWithPITestszp
Run various tap-type tunnel unit tests against an in-memory I/O system with
the PI header enabled.
Nr� r@ r@ r@ rA r� # s r� Tc @ s e Zd ZdZdS )�FakeTunDeviceTestszQ
Run various tun-type tunnel unit tests against an in-memory I/O system.
Nr� r@ r@ r@ rA r� / s r� c s< e Zd ZdZ� fdd�Z� fdd�Zdd� Zdd � Z� ZS )
�TestRealSystemz�
Add extra skipping logic so tests that try to create real tunnel devices on
platforms where those are not supported automatically get skipped.
c
sb zt t| �j|f|�|�W S tk
r\ } z$|jttfkrJ|dkrJtd��� W 5 d}~X Y nX dS )z�
Attempt an open, but if the file is /dev/net/tun and it does not exist,
translate the error into L{SkipTest} so that tests that require
platform support for tuntap devices are skipped instead of failed.
r� zPlatform lacks /dev/net/tunN)�superr� r� r� r� r r
r% )r? �filenamera �kwargsr� �� __class__r@ rA r� ? s zTestRealSystem.openc
sP zt t| �j||�W S tk
rJ } zt|jkr8td��� W 5 d}~X Y nX dS )z�
Attempt an ioctl, but translate permission denied errors into
L{SkipTest} so that tests that require elevated system privileges and
do not have them are skipped instead of failed.
z%Permission to configure device deniedN)r� r� r� r� r r� r% )r? ra r� r� r� r@ rA r� O s
zTestRealSystem.ioctlc C s. t � t jt j�}|�d� |�||� |�� S )a�
Use the platform network stack to send a datagram to the given address.
@param datagram: A UDP datagram payload to send.
@type datagram: L{bytes}
@param address: The destination to which to send the datagram.
@type address: L{tuple} of (L{bytes}, L{int})
@return: The address from which the UDP datagram was sent.
@rtype: L{tuple} of (L{bytes}, L{int})
)z
172.16.0.1r )r� �AF_INET�
SOCK_DGRAM�bindZsendtoZ getsockname)r? ry �address�sr@ r@ rA r� ] s
zTestRealSystem.sendUDPc C s" t � t jt j�}|�||f� |S )a�
Use the platform network stack to receive a datagram sent to the given
address.
@param fileno: The file descriptor of the tunnel used to send the
datagram. This is ignored because a real socket is used to receive
the datagram.
@type fileno: L{int}
@param host: The IPv4 address at which the datagram will be received.
@type host: L{bytes}
@param port: The UDP port number at which the datagram will be
received.
@type port: L{int}
@return: A L{socket.socket} which can be used to receive the specified
datagram.
)r� r� r� r� )r? r� Zhostr� r� r@ r@ rA r� p s zTestRealSystem.receiveUDP) rM rN rO rP r� r� r� r� �
__classcell__r@ r@ r� rA r� 9 s
r� c @ s e Zd ZdZereZdd� ZdS )�RealDeviceTestsMixinz�
Define a mixin for use with test cases that require an
L{_IInputOutputSystem} provider. This mixin hands out L{TestRealSystem}
instances as the provider of that interface.
c C s t � S )z�
Create a real I/O system that can be used to open real tunnel device
provided by the underlying system and previously configured.
@return: The newly created I/O system object.
@rtype: L{TestRealSystem}
)r� r> r@ r@ rA r� � s z!RealDeviceTestsMixin.createSystemN)rM rN rO rP � platformSkip�skipr� r@ r@ r@ rA r� � s r� c @ s* e Zd ZdZdZdZdZeeedd�ZdS )�&RealDeviceWithProtocolInformationTestsz|
Run various tap-type tunnel unit tests, with "protocol information" (PI)
turned on, against a real I/O system.
s
tap-twtest-pis
172.16.1.1s
172.16.1.2Tr� N� rM rN rO rP r� r� r� rr r� r@ r@ r@ rA r� � s
r� c @ s* e Zd ZdZdZdZdZeeedd�ZdS )�)RealDeviceWithoutProtocolInformationTestsz}
Run various tap-type tunnel unit tests, with "protocol information" (PI)
turned off, against a real I/O system.
s
tap-twtests
172.16.0.1s
172.16.0.2Fr� Nr� r@ r@ r@ rA r� � s
r� c @ s e Zd ZdZdd� Zdd� ZdS )�TuntapPortTestszR
Tests for L{TuntapPort} behavior that is independent of the tunnel type.
c C s t dt� �}| �tt|�� dS )zF
A L{TuntapPort} instance provides L{IListeningPort}.
� deviceN)r7 r r� r r �r? r� r@ r@ rA r� � s z TuntapPortTests.test_interfacec C s t dt� �}| �|jt� dS )zg
When not initialized with an I/O system, L{TuntapPort} uses a
L{_RealSystem}.
r� N)r7 r ZassertIsInstanceZ_systemr3 r� r@ r@ rA �test_realSystem� s z TuntapPortTests.test_realSystemN)rM rN rO rP r� r� r@ r@ r@ rA r� � s r� c @ s( e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
d � Zd d
� Z dd� Z
dd� Z dd� Z dd� Z
dd� Zdd� Zdd� Zd d � Zd d � Zd d!� Zd"d#� Zd$d%� Zd&d'� Zd(d)� Zd*d+� Zd,d-� Zd.d/� Zd0d1� Zd2d3� Z d4d5� Z d6d7� Z d8d9� Z d:d;� Z d<d=� Z!d>d?� Z"d@dA� Z#dBdC� Z$dDdE� Z%dFdG� Z&dHS )I�TunnelTestsMixinz�
A mixin defining tests for L{TuntapPort}.
These tests run against L{MemoryIOSystem} (proven equivalent to the real
thing by the tests above) to avoid performing any real I/O.
c C s^ d| _ t� | _| j�tjt� | j�t| j j
| j ��| _ t � | _
t| j | j | j
| jd�| _dS )zW
Create an in-memory I/O system and set up a L{TuntapPort} against it.
� tun0)�reactorr� N)�namer+ r� r� r* r� �factoryZ
buildProtocolr6 r� rU rv rQ r� r7 r� r> r@ r@ rA r� � s � �zTunnelTestsMixin.setUpc C s |t jt jB @ S )a/
Mask off any flags except for L{TunnelType.IFF_TUN} and
L{TunnelType.IFF_TAP}.
@param flags: Flags from L{TunnelType} to mask.
@type flags: L{FlagConstant}
@return: The flags given by C{flags} except the two type flags.
@rtype: L{FlagConstant}
)r5 rS rs )r? rx r@ r@ rA �_tunnelTypeOnly� s z TunnelTestsMixin._tunnelTypeOnlyc C sv | j }| j�� | j �| j�}|j|jB |jB ddttd� | jj ddf}|j
|j |j |j
|jf}| �||� dS )z�
L{TuntapPort.startListening} opens the tunnel factory character special
device C{"/dev/net/tun"} and configures it as a I{tun} tunnel.
r� � FTN)r� r� �startListening� getTunnelr� � O_CLOEXECr� r2 �lenZ interfaceZ openFlagsZ
requestedNamer� ZblockingZ closeOnExecr� )r? r� r� �expectedZactualr@ r@ rA � test_startListeningOpensDevice� s
� �z/TunnelTestsMixin.test_startListeningOpensDevicec C s | j �� | �| j j� dS )zg
L{TuntapPort.startListening} sets C{connected} on the port object to
C{True}.
N)r� r� r� � connectedr> r@ r@ rA � test_startListeningSetsConnected s
z1TunnelTestsMixin.test_startListeningSetsConnectedc C s | j �� | �| j | jj� dS )z�
L{TuntapPort.startListening} calls C{makeConnection} on the protocol
the port was initialized with, passing the port as an argument.
N)r� r� ZassertIsrv � transportr> r@ r@ rA �#test_startListeningConnectsProtocol s
z4TunnelTestsMixin.test_startListeningConnectsProtocolc C s" | j �� | �| j | j�� � dS )z�
L{TuntapPort.startListening} passes the port instance to the reactor's
C{addReader} method to begin watching the port's file descriptor for
data to read.
N)r� r� ZassertInr� rI r> r@ r@ rA � test_startListeningStartsReading" s
z1TunnelTestsMixin.test_startListeningStartsReadingc C s" | j j�d� | �t| jj� dS )z�
L{TuntapPort.startListening} raises L{CannotListenError} if opening the
tunnel factory character special device fails.
r� N�r� Z permissions�remover r' r� r� r> r@ r@ rA �%test_startListeningHandlesOpenFailure, s z6TunnelTestsMixin.test_startListeningHandlesOpenFailurec C s" | j j�d� | �t| jj� dS )z�
L{TuntapPort.startListening} raises L{CannotListenError} if the
C{ioctl} call to configure the tunnel device fails.
r� Nr� r> r@ r@ rA �*test_startListeningHandlesConfigureFailure5 s z;TunnelTestsMixin.test_startListeningHandlesConfigureFailurec C s: |� � }| �|| j�� � | j�d� | �| �|�� dS )a<
Verify that the C{stopListening} method of an L{IListeningPort} removes
that port from the reactor's "readers" set and also that the
L{Deferred} returned by that method fires with L{None}.
@param port: The port object to stop.
@type port: L{IListeningPort} provider
r N)�
stopListening� assertNotInr� rI �advance� assertIsNone�successResultOf)r? r� �stoppedr@ r@ rA � _stopPort> s zTunnelTestsMixin._stopPortc C s4 | j �� | j �� }| �| j � | �|| jj� dS )z�
L{TuntapPort.stopListening} returns a L{Deferred} which fires after the
port has been removed from the reactor's reader list by passing it to
the reactor's C{removeReader} method.
N)r� r� r� r� r� r� Z
_openFiles)r? r� r@ r@ rA � test_stopListeningStopsReadingN s
z/TunnelTestsMixin.test_stopListeningStopsReadingc C s( | j �� | �| j � | �| j j� dS )z�
After the L{Deferred} returned by L{TuntapPort.stopListening} fires,
the C{connected} attribute of the port object is set to C{False}.
N)r� r� r� � assertFalser� r> r@ r@ rA �!test_stopListeningUnsetsConnected[ s
z2TunnelTestsMixin.test_stopListeningUnsetsConnectedc C s( | j �� | �| j � | �| jj� dS )zt
L{TuntapPort.stopListening} calls C{doStop} on the protocol the port
was initialized with.
N)r� r� r� r� rv r� r> r@ r@ rA � test_stopListeningStopsProtocole s
z0TunnelTestsMixin.test_stopListeningStopsProtocolc C s | j �� }| �| �|�� dS )z�
L{TuntapPort.stopListening} returns a L{Deferred} which succeeds
immediately if it is called when the port is not listening.
N)r� r� r� r� )r? r� r@ r@ rA � test_stopListeningWhenStoppedo s
z.TunnelTestsMixin.test_stopListeningWhenStoppedc C s> | j �� | j �� | j �� }| j�d� | �| �|�� dS )z�
It is safe and a no-op to call L{TuntapPort.stopListening} more than
once with no intervening L{TuntapPort.startListening} call.
r N)r� r� r� r� r� r� r� )r? �secondr@ r@ rA �test_multipleStopListeningx s
z+TunnelTestsMixin.test_multipleStopListeningc C sx | j �� | j �� | j�d� | �| j j� | �| jg�}| � t
|d d � | � d|d d � | � dt |�� dS )zP
L{TuntapPort.loseConnection} stops the port and is deprecated.
r �categoryz�twisted.pair.tuntap.TuntapPort.loseConnection was deprecated in Twisted 14.0.0; please use twisted.pair.tuntap.TuntapPort.stopListening insteadr� � N) r� r� ZloseConnectionr� r� r� r� �
flushWarnings�test_loseConnectionr� �DeprecationWarningr� )r? �warningsr@ r@ rA r � s
�z$TunnelTestsMixin.test_loseConnectionc C s< | j �� | j�| j �}||_| j �� | �g | jj� dS )ah
Test that L{TuntapPort.doRead} has no side-effects under a certain
exception condition.
@param style: An exception instance to arrange for the (python wrapper
around the) underlying platform I{read} call to fail with.
@raise C{self.failureException}: If there are any observable
side-effects.
N) r� r� r� r� ZnonBlockingExceptionStyle�doReadr� rv �received)r? Zstyler� r@ r@ rA �_stopsReadingTest� s
z"TunnelTestsMixin._stopsReadingTestc C s | � tj� dS )zr
Once L{TuntapPort.doRead} encounters an I{EAGAIN} errno from a C{read}
call, it returns.
N)r r* Z EAGAIN_STYLEr> r@ r@ rA �test_eagainStopsReading� s z(TunnelTestsMixin.test_eagainStopsReadingc C s | � tj� dS )zw
Once L{TuntapPort.doRead} encounters an I{EWOULDBLOCK} errno from a
C{read} call, it returns.
N)r r* ZEWOULDBLOCK_STYLEr> r@ r@ rA � test_ewouldblockStopsReading� s z-TunnelTestsMixin.test_ewouldblockStopsReadingc C s | � tj� dS )zq
Once L{TuntapPort.doRead} encounters an I{EINTR} errno from a C{read}
call, it returns.
N)r r* Z EINTR_STYLEr> r@ r@ rA �test_eintrblockStopsReading� s z,TunnelTestsMixin.test_eintrblockStopsReadingc C s& G dd� dt �}| �|| j|� � dS )z�
If L{Tuntap.doRead} encounters any exception other than one explicitly
handled by the code, the exception propagates to the caller.
c @ s e Zd ZdS )zETunnelTestsMixin.test_unhandledReadError.<locals>.UnexpectedExceptionN)rM rN rO r@ r@ r@ rA �UnexpectedException� s r
N)� Exceptionr r )r? r
r@ r@ rA �test_unhandledReadError� s �z(TunnelTestsMixin.test_unhandledReadErrorc C s | � t| jttd�� dS )z�
Just like C{test_unhandledReadError}, but for the case where the
exception that is not explicitly handled happens to be of type
C{EnvironmentError} (C{OSError} or C{IOError}).
zOperation not permittedN)r r� r r r> r@ r@ rA �"test_unhandledEnvironmentReadError� s
�z3TunnelTestsMixin.test_unhandledEnvironmentReadErrorc C sT d| j jd }| j �� | j�| j �}|j�|� | j �� | �|g| j j
� dS )z�
L{TuntapPort.doRead} reads a datagram of fewer than
C{TuntapPort.maxPacketSize} from the port's file descriptor and passes
it to its protocol's C{datagramReceived} method.
� xr� N� r� �
maxPacketSizer� r� r� �
readBufferr_ r r� rv r �r? ry r� r@ r@ rA �test_doReadSmallDatagram� s
z)TunnelTestsMixin.test_doReadSmallDatagramc C sT d| j j }| j �� | j�| j �}|j�|d � | j �� | �|g| j j
� dS )z�
L{TuntapPort.doRead} reads the first part of a datagram of more than
C{TuntapPort.maxPacketSize} from the port's file descriptor and passes
the truncated data to its protocol's C{datagramReceived} method.
r � yNr r r@ r@ rA �test_doReadLargeDatagram� s
z)TunnelTestsMixin.test_doReadLargeDatagramc C s� t td��}d}g }|| jjk rD|�t|�| jj � || jj7 }q| j�� | j� | j�}|j
� |� |j
�d� | j� � | �
|| jj� dS )z�
L{TuntapPort.doRead} reads several datagrams, of up to
C{TuntapPort.maxThroughput} bytes total, before returning.
s abcdefghijklmnopqrstuvwxyzr s" excessive datagram, not to be readN)r
r r� Z
maxThroughputr_ �nextr r� r� r� r �extendr r� rv r )r? �valuesZtotalrc r� r@ r@ rA �test_doReadSeveralDatagrams� s
z,TunnelTestsMixin.test_doReadSeveralDatagramsc C s< | j �� | j�| j �j�d� d| j_| j �� | � t
�S )z�
Deliver some data to a L{TuntapPort} hooked up to an application
protocol that raises an exception from its C{datagramReceived} method.
@return: Whatever L{AttributeError} exceptions are logged.
s pingN) r� r� r� r� r r_ rv r r ZflushLoggedErrors�AttributeErrorr> r@ r@ rA �_datagramReceivedException s
z+TunnelTestsMixin._datagramReceivedExceptionc C s | � � }| �dt|�� dS )zt
If the protocol's C{datagramReceived} method raises an exception, the
exception is logged.
r� N)r r� r� )r? �errorsr@ r@ rA � test_datagramReceivedException s z/TunnelTestsMixin.test_datagramReceivedExceptionc C sd g }t |j� | �t|j� | �� tdd� |D ��}t|�}| �dt| j j
�f |� � d � dS )z�
The exception raised by C{datagramReceived} is logged with a message
identifying the offending protocol.
c s s | ]}|d r|V qdS )ZisErrorNr@ )�.0�mr@ r@ rA � <genexpr>/ s zTTunnelTestsMixin.test_datagramReceivedExceptionIdentifiesProtocol.<locals>.<genexpr>z,Unhandled exception from %s.datagramReceivedr N) r r_ r� r r r r r� r rv r� �
splitlines)r? Zmessages�errorr� r@ r@ rA �0test_datagramReceivedExceptionIdentifiesProtocol& s
�
�zATunnelTestsMixin.test_datagramReceivedExceptionIdentifiesProtocolc C s< d}| j �� | j �|� | �| j�| j �jt|g�� dS )zG
L{TuntapPort.write} sends a datagram into the tunnel.
s
a b c d e f gN)r� r� r� r� r� r� � writeBufferr �r? ry r@ r@ rA �
test_write7 s
�zTunnelTestsMixin.test_writec C sH | j �� | j�| j �}|j�t� | j �d� | �t dg�|j
� dS )z�
If the platform write call is interrupted (causing the Python wrapper
to raise C{IOError} with errno set to C{EINTR}), the write is re-tried.
s hello, worldN) r� r� r� r� ZpendingSignalsr_ r r� r� r r$ r� r@ r@ rA �test_interruptedWriteC s
z&TunnelTestsMixin.test_interruptedWritec C s8 | j �� | j�| j �}| �t| j jd|j d � dS )z{
Any exception raised by the underlying write call, except for EINTR, is
propagated to the caller.
r r N)r� r� r� r� r r� r� ZSEND_BUFFER_SIZEr� r@ r@ rA �test_unhandledWriteErrorO s
�z)TunnelTestsMixin.test_unhandledWriteErrorc C sJ ddddg}| j �� | j �|� | �| j�| j �jtd�|�g�� dS )z�
L{TuntapPort.writeSequence} sends a datagram into the tunnel by
concatenating the byte strings in the list passed to it.
� a� b� c� d� N) r� r� Z
writeSequencer� r� r� r$ r �joinr% r@ r@ rA �test_writeSequence[ s
�z#TunnelTestsMixin.test_writeSequencec C s@ | j �� | j �� }| �t| �| jj�| j� | j �j
�|� dS )zp
L{TuntapPort.getHost} returns a L{TunnelAddress} including the tunnel's
type and name.
N) r� r� ZgetHostr� r6 r� r� rU r� r� r� )r? r� r@ r@ rA � test_getHosth s
��z TunnelTestsMixin.test_getHostc C s� | j �� trh| �t| j �t| jj�� d| �| j j
�j | j �
| j �j f }| �t| j ��|�dk� n@dt| jj�| �| j j
�j | j �
| j �j f }| �|t| j �� dS )��
The string representation of a L{TuntapPort} instance includes the
tunnel type and interface and the protocol associated with the port.
z listening on %s/%s>���z<%s listening on %s/%s>N)r� r� r � assertRegex�strr rv r� r� r� rU r� r� r� r� �findr� �r? r� r@ r@ rA �test_listeningStringv s
��
�z%TunnelTestsMixin.test_listeningStringc C s� t rT| �t| j�t| jj�� d| �| jj �j
| j
f }| � t| j�� |�dk� n6dt| jj�| �| jj �j
| j
f }| �
|t| j�� dS )r1 z not listening on %s/%s>r2 z<%s not listening on %s/%s>N)r r3 r4 r� r rv r� r� r� rU r� r� r5 r� r6 r@ r@ rA �test_unlisteningString� s
��
�z'TunnelTestsMixin.test_unlisteningStringc C s0 | � d| jjj| �| jj�jf | j� � � dS )z
L{TuntapPort.logPrefix} returns a string identifying the application
protocol and the type of tunnel.
z%s (%s)N)
r� rv r� rM r� r� rU r� r� Z logPrefixr> r@ r@ rA �test_logPrefix� s ��z TunnelTestsMixin.test_logPrefixN)'rM rN rO rP r� r� r� r� r� r� r� r� r� r� r� r� r� r� r r r r r r r
r r r r r r# r& r' r( r/ r0 r7 r8 r9 r@ r@ r@ rA r� � sH
r� c @ s( e Zd ZdZdd� Zdd� Zdd� ZdS ) �TunnelAddressTestsz%
Tests for L{TunnelAddress}.
c C s | � ttttjd��� dS )zD
A L{TunnelAddress} instances provides L{IAddress}.
�tap0N)r� r r r6 r5 rs r> r@ r@ rA �test_interfaces� s �z"TunnelAddressTests.test_interfacesc C s� t tjd�}| �d|d � | �d|d � | �| jg�}d}| �t|d d � | �||d d � | �t|d d � | �||d d � | �dt|�� d S )
z�
A L{TunnelAddress} instance can be indexed to retrieve either the byte
string C{"TUNTAP"} or the name of the tunnel interface, while
triggering a deprecation warning.
r; ZTUNTAPr r� zUTunnelAddress.__getitem__ is deprecated since Twisted 14.0.0 Use attributes instead.r� r� � N)r6 r5 rs r� r �
test_indexingr r� )r? r� r r� r@ r@ rA r> � s �z TunnelAddressTests.test_indexingc C s> t r | �tttjdd��d� n| �dtttjdd��� dS )z�
The string representation of a L{TunnelAddress} instance includes the
class name and the values of the C{type} and C{name} attributes.
r� )r� z*TunnelAddress type=IFF_TUN name=b'device'>z*<TunnelAddress type=IFF_TUN name='device'>N)r r3 �reprr6 r5 rS r� r> r@ r@ rA � test_repr� s ��z TunnelAddressTests.test_reprN)rM rN rO rP r< r> r@ r@ r@ r@ rA r: � s r: c @ sh e Zd ZdZdd� Zdd� Zdd� Zdd � Zd
d � Zd d
� Z dd� Z
dd� Z dd� Z dd� Z
dd� ZdS )�TunnelAddressEqualityTestsz^
Tests for the implementation of equality (C{==} and C{!=}) for
L{TunnelAddress}.
c C sB t tjd�| _t tjtjB d�| _t tjd�| _t tjd�| _d S )Nr� s tap1s tun1)r6 r5 rS �firstr� rs �
variedType�
variedNamer> r@ r@ rA r� � s
�z TunnelAddressEqualityTests.setUpc C s | � | j| jk� dS )z>
A L{TunnelAddress} compares equal to itself.
N�r� rB r> r@ r@ rA �test_selfComparesEqual� s z1TunnelAddressEqualityTests.test_selfComparesEqualc C s | � | j| jk� dS )zI
A L{TunnelAddress} doesn't compare not equal to itself.
N�r� rB r> r@ r@ rA � test_selfNotComparesNotEqual� s z7TunnelAddressEqualityTests.test_selfNotComparesNotEqualc C s | � | j| jk� dS )z�
Two L{TunnelAddress} instances with the same value for the C{type} and
C{name} attributes compare equal to each other.
N)r� rB r� r> r@ r@ rA � test_sameAttributesComparesEqual s z;TunnelAddressEqualityTests.test_sameAttributesComparesEqualc C s | � | j| jk� dS )z�
Two L{TunnelAddress} instances with the same value for the C{type} and
C{name} attributes don't compare not equal to each other.
N)r� rB r� r> r@ r@ rA �&test_sameAttributesNotComparesNotEqual s zATunnelAddressEqualityTests.test_sameAttributesNotComparesNotEqualc C s | � | j| jk� dS )z�
Two L{TunnelAddress} instances that differ only by the value of their
type don't compare equal to each other.
N)r� rB rC r> r@ r@ rA �"test_differentTypeComparesNotEqual s z=TunnelAddressEqualityTests.test_differentTypeComparesNotEqualc C s | � | j| jk� dS )z�
Two L{TunnelAddress} instances that differ only by the value of their
type compare not equal to each other.
N)r� rB rC r> r@ r@ rA �"test_differentTypeNotComparesEqual s z=TunnelAddressEqualityTests.test_differentTypeNotComparesEqualc C s | � | j| jk� dS )z�
Two L{TunnelAddress} instances that differ only by the value of their
name don't compare equal to each other.
N)r� rB rD r> r@ r@ rA �"test_differentNameComparesNotEqual s z=TunnelAddressEqualityTests.test_differentNameComparesNotEqualc C s | � | j| jk� dS )z�
Two L{TunnelAddress} instances that differ only by the value of their
name compare not equal to each other.
N)r� rB rD r> r@ r@ rA �"test_differentNameNotComparesEqual( s z=TunnelAddressEqualityTests.test_differentNameNotComparesEqualc C s | � | j| k� dS )zc
A L{TunnelAddress} doesn't compare equal to an instance of another
class.
NrG r> r@ r@ rA �#test_differentClassNotComparesEqual0 s z>TunnelAddressEqualityTests.test_differentClassNotComparesEqualc C s | � | j| k� dS )zX
A L{TunnelAddress} compares not equal to an instance of another class.
NrE r> r@ r@ rA �#test_differentClassComparesNotEqual8 s z>TunnelAddressEqualityTests.test_differentClassComparesNotEqualN)rM rN rO rP r� rF rH rI rJ rK rL rM rN rO rP r@ r@ r@ rA rA � s rA c @ s" e Zd ZdZdd� Zddd�ZdS ) �IPRecordingProtocol�H
A protocol which merely records the datagrams delivered to it.
c C s
g | _ d S r9 �r r> r@ r@ rA �
startProtocolE s z!IPRecordingProtocol.startProtocolFc C s | j �|� d S r9 �r r_ �r? ry �partialr@ r@ rA rg I s z$IPRecordingProtocol.datagramReceivedN)F�rM rN rO rP rT rg r@ r@ r@ rA rQ @ s rQ c @ s& e Zd ZdZe� Zee_edd�Z dS )�TunTestszJ
Tests for L{TuntapPort} when used to open a Linux I{tun} tunnel.
N)
rM rN rO rP r# r� rQ rv rR r� r@ r@ r@ rA rY N s rY c @ s" e Zd ZdZdd� Zddd�ZdS ) �EthernetRecordingProtocolrR c C s
g | _ d S r9 rS r> r@ r@ rA rT \ s z'EthernetRecordingProtocol.startProtocolFc C s | j �|� d S r9 rU rV r@ r@ rA rg ` s z*EthernetRecordingProtocol.datagramReceivedN)FrX r@ r@ r@ rA rZ X s rZ c @ s* e Zd ZdZe� Zee_edddd�Z dS )�TapTestszJ
Tests for L{TuntapPort} when used to open a Linux I{tap} tunnel.
NFr� )
rM rN rO rP r# r� rZ rv rr r� r@ r@ r@ rA r[ e s r[ c @ s e Zd ZdZdd� ZdS )�IOSystemTestsMixinzH
Tests that apply to any L{_IInputOutputSystem} implementation.
c C s | � � }| �t|jdtj� dS )zt
L{_IInputOutputSystem.open} raises L{OSError} when called with a
non-existent device path.
s! /dev/there-is-no-such-device-everN)r� r r� r� r} r� r� r@ r@ rA �test_noSuchDevices s �z$IOSystemTestsMixin.test_noSuchDeviceN)rM rN rO rP r] r@ r@ r@ rA r\ o s r\ c @ s e Zd ZdZdS )�MemoryIOSystemTestszL
General L{_IInputOutputSystem} tests applied to L{MemoryIOSystem}.
Nr� r@ r@ r@ rA r^ s r^ c @ s e Zd ZdZdS )�RealIOSystemTestszI
General L{_IInputOutputSystem} tests applied to L{_RealSystem}.
Nr� r@ r@ r@ rA r_ � s r_ )prP Z
__future__r r r} r� r� r� r r r r r r r
Zrandomr � collectionsr � itertoolsr
�signalr Ztwisted.python.compatr r Ztwisted.python.reflectr r r r� Zzope.interfacer r Zzope.interface.verifyr Ztwisted.internet.interfacesr Ztwisted.internet.protocolr Ztwisted.pair.rawudpr Ztwisted.pair.ipr Ztwisted.pair.ethernetr r r Ztwisted.python.logr r r r r! r" r# Ztwisted.internet.taskr$ Ztwisted.trial.unittestr% r& Ztwisted.internet.errorr' Ztwisted.pair.rawr( �objectr3 r4 Ztwisted.pair.testingr) r* r+ r, r- r. r/ r0 Ztwisted.pair.tuntapr1 r2 r5 r6 r7 r� r8 rQ rR rr r{ r� r� r� r� r� r� r� r� r� r� r� r� r� r� r: rA rQ rY rZ r[ r\ r^ r_ r@ r@ r@ rA �<module> s� $
(&,
Ri 5 � � � � � �P � � W0c
��