| Current File : //snap/core22/2115/usr/lib/python3.10/test/support/__pycache__/socket_helper.cpython-310.pyc |
o
}�5h�, � @ s� d dl Z d dlZd dlZd dlZd dlZddlmZ dZdZdZ ej
ej fdd�Z efd d
�Z
d d � Zd
d� Ze� Zdadd� Zdd� Ze� Ze jedd�dd��ZdS )� N� )�support� localhostz 127.0.0.1z::1c C s> t � | |��}t|�}W d � ~|S 1 sw Y ~|S )a Returns an unused port that should be suitable for binding. This is
achieved by creating a temporary socket with the same family and type as
the 'sock' parameter (default is AF_INET, SOCK_STREAM), and binding it to
the specified host address (defaults to 0.0.0.0) with the port set to 0,
eliciting an unused ephemeral port from the OS. The temporary socket is
then closed and deleted, and the ephemeral port is returned.
Either this method or bind_port() should be used for any tests where a
server socket needs to be bound to a particular port for the duration of
the test. Which one to use depends on whether the calling code is creating
a python socket, or if an unused port needs to be provided in a constructor
or passed to an external program (i.e. the -accept argument to openssl's
s_server mode). Always prefer bind_port() over find_unused_port() where
possible. Hard coded ports should *NEVER* be used. As soon as a server
socket is bound to a hard coded port, the ability to run multiple instances
of the test simultaneously on the same host is compromised, which makes the
test a ticking time bomb in a buildbot environment. On Unix buildbots, this
may simply manifest as a failed test, which can be recovered from without
intervention in most cases, but on Windows, the entire python process can
completely and utterly wedge, requiring someone to log in to the buildbot
and manually kill the affected process.
(This is easy to reproduce on Windows, unfortunately, and can be traced to
the SO_REUSEADDR socket option having different semantics on Windows versus
Unix/Linux. On Unix, you can't have two AF_INET SOCK_STREAM sockets bind,
listen and then accept connections on identical host/ports. An EADDRINUSE
OSError will be raised at some point (depending on the platform and
the order bind and listen were called on each socket).
However, on Windows, if SO_REUSEADDR is set on the sockets, no EADDRINUSE
will ever be raised when attempting to bind two identical host/ports. When
accept() is called on each socket, the second caller's process will steal
the port from the first caller, leaving them both in an awkwardly wedged
state where they'll no longer respond to any signals or graceful kills, and
must be forcibly killed via OpenProcess()/TerminateProcess().
The solution on Windows is to use the SO_EXCLUSIVEADDRUSE socket option
instead of SO_REUSEADDR, which effectively affords the same semantics as
SO_REUSEADDR on Unix. Given the propensity of Unix developers in the Open
Source world compared to Windows ones, this is a common mistake. A quick
look over OpenSSL's 0.9.8g source shows that they use SO_REUSEADDR when
openssl.exe is called with the 's_server' option, for example. See
http://bugs.python.org/issue2550 for more info. The following site also
has a very thorough description about the implications of both REUSEADDR
and EXCLUSIVEADDRUSE on Windows:
https://learn.microsoft.com/windows/win32/winsock/using-so-reuseaddr-and-so-exclusiveaddruse
XXX: although this approach is a vast improvement on previous attempts to
elicit unused ports, it rests heavily on the assumption that the ephemeral
port returned to us by the OS won't immediately be dished back out to some
other process when we close and delete our temporary socket but before our
calling code has a chance to bind the returned port. We can deal with this
issue if/when we come across it.
N)�socket� bind_port)�family�socktype�tempsock�port� r �1/usr/lib/python3.10/test/support/socket_helper.py�find_unused_port s 8
��r
c C s� | j tjkrN| jtjkrNttd�r | �tjtj�dkr t �
d��ttd�r@z| �tjtj �dkr5t �
d��W n t y? Y nw ttd�rN| �
tjtjd� | �|df� | �� d }|S )a% Bind the socket to a free port and return the port number. Relies on
ephemeral ports in order to ensure we are using an unbound port. This is
important as many tests may be running simultaneously, especially in a
buildbot environment. This method raises an exception if the sock.family
is AF_INET and sock.type is SOCK_STREAM, *and* the socket has SO_REUSEADDR
or SO_REUSEPORT set on it. Tests should *never* set these socket options
for TCP/IP sockets. The only case for setting these options is testing
multicasting via multiple UDP sockets.
Additionally, if the SO_EXCLUSIVEADDRUSE socket option is available (i.e.
on Windows), it will be set on the socket. This will prevent anyone else
from bind()'ing to our host/port for the duration of the test.
� SO_REUSEADDR� zHtests should never set the SO_REUSEADDR socket option on TCP/IP sockets!� SO_REUSEPORTzHtests should never set the SO_REUSEPORT socket option on TCP/IP sockets!�SO_EXCLUSIVEADDRUSEr )r r �AF_INET�type� SOCK_STREAM�hasattr�
getsockopt�
SOL_SOCKETr r �
TestFailedr �OSError�
setsockoptr �bind� getsockname)�sock�hostr
r r r r L s"
� �
r c C sB | j tjksJ �z| �|� W dS ty | �� t�d��w )zBBind a unix socket, raising SkipTest if PermissionError is raised.zcannot bind AF_UNIX socketsN)r r �AF_UNIXr �PermissionError�close�unittest�SkipTest)r �addrr r r �bind_unix_sockets s
�r% c C s| t jr<d} z.zt � t jt j�} | �tdf� W W | r | �� dS dS ty* Y nw W | r2| �� dS | r;| �� w w dS )z+Check whether IPv6 is enabled on this host.Nr TF)r �has_ipv6�AF_INET6r r �HOSTv6r! r )r r r r �_is_ipv6_enabled| s( � ���
�r) c C s� t td�s t�d�| �S tdu r\ddlm}m} |d }t�tj��2}z$z |� |� daW n t
yA } z|aW Y d}~nd}~ww W ||� n||� w W d � n1 sWw Y tridt }t�|�| �S | S ) zCDecorator for tests requiring a functional bind() for unix sockets.r zNo UNIX SocketsNr )�TESTFN�unlink�can_bind_unix_socketFz%Requires a functional unix bind(): %s) r r r" �skip�_bind_nix_socket_error� os_helperr* r+ r r r )�testr* r+ �pathr �e�msgr r r � skip_unless_bind_unix_socket� s(
��� �r4 c C s^ t jg} tt d�r| �t j� tt d�r| �t j� tt d�r%| �t j� ts-| �t j� | S )zr
Get the different socket error numbers ('errno') which can be received
when a connection is refused.
� ENETUNREACH�
EADDRNOTAVAIL� EHOSTUNREACH) �errno� ECONNREFUSEDr �appendr5 r6 r7 � IPV6_ENABLED� EAFNOSUPPORT)�errorsr r r � get_socket_conn_refused_errs� s
r> r )�timeout�errnosc
# sl � ddl }ddl�|tu rtj}g d�}g d�}t�d| ��|� g �� s3dd� |D �� dd� |D ��� ���fd d
�}t�� }zoz|durKt�|� dV W nX |j ym } ztj
rft j �
�jd d � �|�d}~w ty� } z/ |j} t| �d
kr�t| d t�r�| d }nt| �dkr�t| d
t�r�| d
}nnqu||� � d}~ww W t�|� dS t�|� w )z�Return a context manager that raises ResourceDenied when various issues
with the internet connection manifest themselves as exceptions.r N))r9 �o )�
ECONNRESET�h )r7 �q )r5 �e )� ETIMEDOUT�n )r6 �c ))� EAI_AGAIN���)�EAI_FAIL���)�
EAI_NONAME���)�
EAI_NODATA���)�
WSANO_DATAi�* z Resource %r is not availablec S � g | ]
\}}t t||��qS r )�getattrr8 ��.0�name�numr r r �
<listcomp>� � �z&transient_internet.<locals>.<listcomp>c S rR r )rS r rT r r r rX � rY c s� t | dd �}t| t�sBt| tj�r|�v sBt| �jj�r(d| j kr'dksBn t| �jj�r>d| j v sBd| j v sBd| j v sB|� v rSt
j sPt j
��jd d � �| �d S ) Nr8 i� iW �ConnectionRefusedError� TimeoutError�EOFErrorr �
)rS �
isinstancer[ r �gaierror�error� HTTPError�code�URLError�reasonr �verbose�sys�stderr�write�args)�err�n��captured_errnos�denied�
gai_errnos�urllibr r � filter_error� s$
� � �
�z(transient_internet.<locals>.filter_errorr] Tr r )�nntplib� urllib.error�_NOT_SETr �INTERNET_TIMEOUT�ResourceDeniedr �getdefaulttimeout�setdefaulttimeout�NNTPTemporaryErrorre rf rg rh ri r �lenr^ )
�
resource_namer? r@ rr �default_errnos�default_gai_errnosrq � old_timeoutrj �ar rl r �transient_internet� sV �
��
�
� ���r� )�
contextlibr8 r r" rf � r �HOST�HOSTv4r( r r r
r r% r) r; r. r4 r> �objectrt �contextmanagerr� r r r r �<module> s( ='