File: //lib/python3/dist-packages/certbot/tests/__pycache__/util.cpython-310.pyc
o
6��a�H � @ sV d Z ddlmZ ddlZddlZddlmZ ddlmZ ddl Z ddl
Z
ddl Z ddl m
Z
ddl mZ ddl mZ ddlZddlZdd lmZ dd
lmZ ddlZddlZddlZdd lmZ dd lm Z dd
l m Z ddl m Z ddl m Z ddl!m"Z# ddl$m%Z% ddl$m&Z& dd l'm Z( ddl)m*Z* z ddl+Z+e�,de-� W n e.y� ddlm+Z+ Y nw G dd� de*j/�Z0dd� Z1dd� Z2d d � Z3d d � Z4d d!� Z5d"d#� Z6d$d%� Z7d&d'� Z8dHd)d*�Z9dId,d-�Z: + dJd.d/�Z;d0d1� Z<dKd2d3�Z=G d4d5� d5�Z>d6d7� Z?d8d9� Z@d:d;� ZAG d<d=� d=ejB�ZCG d>d?� d?eC�ZDd@dA� ZEdBdC� ZFdDdE� ZGdFdG� ZHdS )LzTest utilities.� )�reloadN)�Event)�Process)�Iterable)�List)�Optional)�default_backend)�
serialization)�
configuration)�util)� constants)�lock)�storage)�obj)�
filesystem)�os)�commonz�The external mock module is being used for backwards compatibility since it is available, however, future versions of Certbot's tests will use unittest.mock. Be sure to update your code accordingly.)�mockc @ s� e Zd ZdZdee fdd�Zdedededed edd
f d d �Zd"ded
edee e dd
fdd�Z
de e fdd�Z d#dee de dd
fdd�Z
d$dd�Zd$dd�Zed d � �Zd$d d �Zdefd d!�Zd
S )%�DummyInstallerz(Dummy installer plugin for test purpose.�returnc C � d S �N� ��selfr r �4/usr/lib/python3/dist-packages/certbot/tests/util.py�
get_all_names2 � z DummyInstaller.get_all_names�domain� cert_path�key_path�
chain_path�fullchain_pathNc C r r r )r r r r r! r" r r r � deploy_cert5 � zDummyInstaller.deploy_cert� enhancement�optionsc C r r r )r r r% r& r r r �enhance9 r zDummyInstaller.enhancec C r r r r r r r �supported_enhancements< r z%DummyInstaller.supported_enhancementsF�title� temporaryc C r r r )r r) r* r r r �save? r zDummyInstaller.savec C r r r r r r r � config_testB r zDummyInstaller.config_testc C r r r r r r r �restartE r zDummyInstaller.restartc C r r r )�cls�addr r r �add_parser_argumentsH r$ z#DummyInstaller.add_parser_argumentsc C r r r r r r r �prepareL r zDummyInstaller.preparec C r r r r r r r � more_infoO r zDummyInstaller.more_infor )NF)r N)�__name__�
__module__� __qualname__�__doc__r �strr r# r r r' r( �boolr+ r, r- � classmethodr0 r1 r2 r r r r r 0 s" �
�$
r c G s t �ttjjdg| �R � �S )zPath to a test vector.�testdata)�
pkg_resources�resource_filenamer3 r �path�join��namesr r r � vector_pathS s �rA c G sJ t �ttjjdg| �R � �}z |�� �dd��� W S t y$ | Y S w )z Load contents of a test vector.r: z
�
)
r; �resource_stringr3 r r= r> �decode�replace�encode�
ValueError)r@ �datar r r � load_vectorY s � �rI c C s8 t j�| �\}}|�� dkr|S |�� dkr|S td��)Nz.pemz.derz1Loader could not be recognized based on extension)r r= �splitext�lowerrG )�filename�
loader_pem�
loader_der�_�extr r r �
_guess_loaderg s rQ c G �* t | d tjjtjj�}tj�|t| � �S )zLoad certificate.���)rQ �OpenSSL�crypto� FILETYPE_PEM�
FILETYPE_ASN1�load_certificaterI �r@ �loaderr r r � load_certp � �r[ c G rR )zLoad certificate request.rS )rQ rT rU rV rW �load_certificate_requestrI rY r r r �load_csrw r\ r^ c G s t �t| � �S )z(Load ComparableX509 certificate request.)�jose�ComparableX509r^ r? r r r �load_comparable_csr~ � ra c G s. t | d tjtj�}t�|t| � dt� d��S )zLoad RSA private key.rS N)�password�backend)rQ r �load_pem_private_key�load_der_private_keyr_ �ComparableRSAKeyrI r rY r r r �load_rsa_private_key� s � �rh c G rR )zLoad pyOpenSSL private key.rS )rQ rT rU rV rW �load_privatekeyrI rY r r r �load_pyopenssl_private_key� r\ rj Fc
s~ |dt d� � }tj�� tj�}tj�� tj|�}tj�� tj|�}|||fD ]
}tj�|�s5t �
|� q(t d� |r=dnd��}t�
|�D ]} t�tj�|| �tj�|| �� qFtjD ]} t�tj�|d� | ��tj�|d� | ��� q\tj�� ||�}
tt |���2} t|
d��} | �� fd d
�| D �� W d � n1 s�w Y W d � |
S W d � |
S 1 s�w Y |
S ) ap Creates a lineage defined by testfile.
This creates the archive, live, and renewal directories if
necessary and creates a simple lineage.
:param str config_dir: path to the configuration directory
:param str testfile: configuration file to base the lineage on
:returns: path to the renewal conf file for the created lineage
:rtype: str
Nz.confzsample-archive{}z-ec� z{0}1.pemz{0}.pem�wc 3 s � | ] }|� d � �V qdS )�MAGICDIRN)rE )�.0�line��
config_dirr r � <genexpr>� s �
�z make_lineage.<locals>.<genexpr>)�lenr r= r> r �RENEWAL_CONFIGS_DIR� ARCHIVE_DIR�LIVE_DIR�existsr �makedirsrA �format�listdir�shutil�copyfiler �ALL_FOUR�symlink�open�
writelines)
rq �testfile�ec� lineage_name�conf_dir� archive_dir�live_dir� directory�sample_archive�kind� conf_path�src�dstr rp r � make_lineage� sJ
���
� �
�
� �
��
��r� �zope.component.getUtilityc C s t �d� tj| td�S )z�Deprecated, patch certbot.display.util directly or use patch_display_util instead.
:param str target: path to patch
:returns: mock zope.component.getUtility
:rtype: mock.MagicMock
z�Decorator certbot.tests.util.patch_get_utility is deprecated. You should now patch certbot.display.util yourself directly or use certbot.tests.util.patch_display_util as a temporary workaround.�� new_callable)�warnings�warnr �patch�_create_display_util_mock)�targetr r r �patch_get_utility� s
r� c C s0 t �d� |r |nt�� }t|�}tj| |d�S )aE Deprecated, patch certbot.display.util directly
or use patch_display_util_with_stdout instead.
:param str target: path to patch
:param object stdout: object to write standard output to; it is
expected to have a `write` method
:returns: mock zope.component.getUtility
:rtype: mock.MagicMock
z�Decorator certbot.tests.util.patch_get_utility_with_stdout is deprecated. You should now patch certbot.display.util yourself directly or use use certbot.tests.util.patch_display_util_with_stdout as a temporary workaround.��new)r� r� �io�StringIO�%_create_display_util_mock_with_stdoutr r� )r� �stdout�freezable_mockr r r � patch_get_utility_with_stdout� s
r� c C s t jdtd�S )a� Patch certbot.display.util to use a special mock display utility.
The mock display utility works like a regular mock object, except it also
also asserts that methods are called with valid arguments.
The mock created by this patch mocks out Certbot internals so this can be
used like the old patch_get_utility function. That is, the mock object will
be called by the certbot.display.util functions and the mock returned by
that call will be used as the display utility. This was done to simplify
the transition from zope.component and mocking certbot.display.util
functions directly in test code should be preferred over using this
function in the future.
See https://github.com/certbot/certbot/issues/8948
:returns: patch on the function used internally by certbot.display.util to
get a display utility instance
:rtype: unittest.mock._patch
�)certbot._internal.display.obj.get_displayr� )r r� r� r r r r �patch_display_util� s �r� c C s" | r| nt �� } tjdt| �d�S )a] Patch certbot.display.util to use a special mock display utility.
The mock display utility works like a regular mock object, except it also
asserts that methods are called with valid arguments.
The mock created by this patch mocks out Certbot internals so this can be
used like the old patch_get_utility function. That is, the mock object will
be called by the certbot.display.util functions and the mock returned by
that call will be used as the display utility. This was done to simplify
the transition from zope.component and mocking certbot.display.util
functions directly in test code should be preferred over using this
function in the future.
See https://github.com/certbot/certbot/issues/8948
The `message` argument passed to the display utility methods is passed to
stdout's write method.
:param object stdout: object to write standard output to; it is
expected to have a `write` method
:returns: patch on the function used internally by certbot.display.util to
get a display utility instance
:rtype: unittest.mock._patch
r� r� )r� r� r r� r� �r� r r r � patch_display_util_with_stdout� s �r� c @ sD e Zd ZdZddejjfdd�Zdd� Zdd � Z d
d � Z
d d
� Z dS )�
FreezableMocka� Mock object with the ability to freeze attributes.
This class works like a regular mock.MagicMock object, except
attributes and behavior set before the object is frozen cannot
be changed during tests.
If a func argument is provided to the constructor, this function
is called first when an instance of FreezableMock is called,
followed by the usual behavior defined by MagicMock. The return
value of func is ignored.
FNc C s> |rt � ndh| _|| _t�� | _|tjjkr|| _|| _ d S )N�freeze)
�set� _frozen_set�_funcr � MagicMock�_mock�sentinel�DEFAULT� return_value�_frozen)r �frozen�funcr� r r r �__init__) s
zFreezableMock.__init__c C s
d| _ dS )z)Freeze object preventing further changes.TN)r� r r r r r� 1 s
zFreezableMock.freezec O s* | j d ur
| j |i |�� | j|i |��S r )r� r� )r �args�kwargsr r r �__call__5 s
zFreezableMock.__call__c C sv |dkrzt �| |�W S ty Y dS w |dv r#tt �| d�|�S |dks,|| jv r2t �| |�S tt �| d�|�S )Nr� F�r� � side_effectr� r� )�object�__getattribute__�AttributeError�getattrr� )r �namer r r r� : s � z FreezableMock.__getattribute__c C sb | j r|| jv rtd| ��t| j||�S |dkr | j�|� |dv r*t| j||�S t�| ||�S )a� Before it is frozen, attributes are set on the FreezableMock
instance and added to the _frozen_set. Attributes in the _frozen_set
cannot be changed after the FreezableMock is frozen. In this case,
they are set on the underlying _mock.
In cases of return_value and side_effect, these attributes are always
passed through to the instance's _mock and added to the _frozen_set
before the object is frozen.
z Cannot change frozen attribute r� r� )r� r� r� �setattrr� r/ r� � __setattr__)r r� �valuer r r r� G s
zFreezableMock.__setattr__) r3 r4 r5 r6 r r� r� r� r� r� r� r� r r r r r� s
r� c C sX t � } dd� ttj�D �}|D ]}|dkr!t dtd�}t| ||� q| �� t d| d�S )Nc S �* g | ]}t ttj|��r|�d �s|�qS ��__��callabler� � display_obj� FileDisplay�
startswith�rn r� r r r �
<listcomp>c �
�
�z-_create_display_util_mock.<locals>.<listcomp>� notificationT�r� r� �r� r� )r� �dirr� r� �_assert_valid_callr� r� )�display� method_list�method� frozen_mockr r r r� ` s � r� c s~ �fdd�� � fdd�}t � }dd� ttj�D �}|D ]}|dkr(t d� d �}nt d|d �}t|||� q|�� t d|d
�S ) Nc s | r � � | � dS dS )z$Write to message to stdout.
N)�write)�message� unused_args�
unused_kwargsr� r r �
_write_msgo s �z9_create_display_util_mock_with_stdout.<locals>._write_msgc s t | |� � | i |�� dS )z<
Mock function for display utility methods.
N)r� )r� r� )r� r r � mock_methodu s
z:_create_display_util_mock_with_stdout.<locals>.mock_methodc S r� r� r� r� r r r r� ~ r� z9_create_display_util_mock_with_stdout.<locals>.<listcomp>r� Tr� r� )r� r� r� r� r� r� )r� r� r� r� r� r� r )r� r� r r� n s �� r� c O s^ | r| d n|d g}i }|� dd �|d< |� dd �|d< |� dd�|d< tj|i |�� d S )Nr r� �default�cli_flag�force_interactiveF)�get� display_util�assert_valid_call)r� r� � assert_args�
assert_kwargsr r r r� � s r� c @ s e Zd ZdZdd� Zdd� ZdS )�TempDirTestCasezBBase test class which sets up and tears down a temporary directoryc C s t �� | _dS )zExecute before testN)�tempfile�mkdtemp�tempdirr r r r �setUp� rb zTempDirTestCase.setUpc C s* t �� g t �� _t�� t�| j� dS )zExecute after testN) �logging�shutdown� getLogger�handlersr �_release_locksr{ �rmtreer� r r r r �tearDown� s
zTempDirTestCase.tearDownN)r3 r4 r5 r6 r� r� r r r r r� � s r� c s e Zd ZdZ� fdd�Z� ZS )�ConfigTestCasez2Test class which sets up a NamespaceConfig object.c s� t � �� t�tjdi tj���| _d| jj _
t j �
| jd�| jj _t j �
| jd�| jj _t j �
| jd�| jj _tjd | jj _tjd | jj _tjd | jj _d| jj _d S ) N�certonly�config�work�logs�auth_cert_path�auth_chain_pathzhttps://example.comr )�superr� r
�NamespaceConfigr r� r � CLI_DEFAULTSr� � namespace�verbr r= r> r� rq �work_dir�logs_dirr r" r! �serverr �� __class__r r r� � s
�
zConfigTestCase.setUp)r3 r4 r5 r6 r� �
__classcell__r r r� r r� � s r� c C sX t j�|�r t�|�}nt�|�}z|�� | jdd�s J d��W |�� dS |�� w )a�
Acquire a file lock on given path, then wait to release it. This worker is coordinated
using events to signal when the lock should be acquired and released.
:param multiprocessing.Event event_in: event object to signal when to release the lock
:param multiprocessing.Event event_out: event object to signal when the lock is acquired
:param path: the path to lock
� ��timeoutz*Timeout while waiting to release the lock.N) r r= �isdirr
�lock_dir�LockFiler� �wait�release)�event_in� event_outr= �my_lockr r r � _handle_lock� s
r c C sn t t� t� }t� }tt|||fd�}|�� |jdd�s!J d��| � |�� |jdd� |j dks5J �dS )z�
Grab a lock on path_to_lock from a foreign process then execute the callback.
:param callable callback: object to call after acquiring the lock
:param str path_to_lock: path to file or directory to lock
)r� r� �
r� z*Timeout while waiting to acquire the lock.r N)
�
reload_moduler r r r �startr r� r> �exitcode)�callback� path_to_lock�
emit_event�
receive_event�processr r r �
lock_and_call� s r c s � fdd�}|S )zFDecorator to skip permanently a test on Windows. A reason is required.c s t �tjdk� �| �S )zWrapped version�win32)�unittest�skipIf�sys�platform)�function��reasonr r �wrapper� s z skip_on_windows.<locals>.wrapperr )r r r r r �skip_on_windows� s r c C s t j�t�� | �S )z�
Return the given path joined to the tempdir path for the current platform
Eg.: 'cert' => /tmp/cert (Linux) or 'C:\Users\currentuser\AppData\Temp\cert' (Windows)
)r r= r> r� �
gettempdir)r= r r r � temp_join� s r )F)r� )r� Nr )Ir6 � importlibr r r� r� �multiprocessingr r r{ r r� �typingr r r r r� � cryptography.hazmat.backendsr � cryptography.hazmat.primitivesr �josepyr_ rT r; �certbotr
r �certbot._internalr r
r �certbot._internal.displayr r� �certbot.compatr r �certbot.displayr� �certbot.pluginsr r r� �PendingDeprecationWarning� ImportError� Installerr rA rI rQ r[ r^ ra rh rj r� r� r� r� r� r� r� r� r� �TestCaser� r� r r r r r r r r �<module> s� � �#
,
�
D