a
}|gE @ sj d Z ddlZddlZddlmZ ddlmZ ddlZddlmZ ddlm Z ddl
m Z ddl
m Z ddl
m Z dd lmZ eed
d d ZG d
d dejZG dd dejZG dd dejZG dd deZG dd deZG dd deZG dd deZ G dd d e Z G d d d e Z G d d d ejZ d!d" Z e!d#krfe"e#ej$d$d e%g dS )%z"Tests for certbot._internal.hooks. N)python_version_tuple)mock)errors)util)
filesystem)os)List)majorminorc C s@ t t d }t t d }|| k r(dS || kr4dS ||k S d S )Nr TF)intr )r r
ZpymajorZpyminor r
E/usr/lib/python3.9/site-packages/certbot/_internal/tests/hook_test.pypyver_lt s r c @ s. e Zd ZdZedd Zeddd ZdS )ValidateHooksTestz1Tests for certbot._internal.hooks.validate_hooks.c O s ddl m} ||i |S )Nr )validate_hooks)certbot._internal.hooksr )clsargskwargsr r
r
r _call s zValidateHooksTest._callz%certbot._internal.hooks.validate_hookc C s& t }| | dd |jD }d S )Nc S s g | ]}|d d qS )r r r
).0callr
r
r
) z-ValidateHooksTest.test_it..)r Z MagicMockr call_args_list)selfZmock_validate_hookconfigtypesr
r
r test_it$ s
zValidateHooksTest.test_itN) __name__
__module__ __qualname____doc__ classmethodr r patchr r
r
r
r r s
r c @ sH e Zd ZdZedd Zdd Zeddd Z ed d
d Z
d S )
ValidateHookTestz0Tests for certbot._internal.hooks.validate_hook.c O s ddl m} ||i |S )Nr )
validate_hook)r r' )r r r r' r
r
r r 2 s zValidateHookTest._callc
C s t dv t jdddH ttj | dd W d n1 sJ0 Y W d n1 sh0 Y W d n1 s0 Y d S )N.certbot._internal.hooks.plug_util.path_surgeryz0certbot._internal.hooks.filesystem.is_executableF) return_valueZdummyfoo)r r% pytestraisesr HookCommandNotFoundr r r
r
r test_hook_not_executable7 s z)ValidateHookTest.test_hook_not_executablez'certbot._internal.hooks.util.exe_existsc C sl d|_ tdH}ttj | dd W d n1 s@0 Y W d n1 s^0 Y d S )NFr( r* bar)r) r r% r+ r, r r- r )r Zmock_exe_existsZmock_psr
r
r test_not_foundA s
Hz ValidateHookTest.test_not_foundz certbot._internal.hooks._progc C s | d d d S Nr* )r )r Z mock_progr
r
r
test_unsetI s zValidateHookTest.test_unsetN) r r! r" r# r$ r r/ r r% r1 r3 r
r
r
r r& / s
r& c @ s( e Zd ZdZedd Zedd ZdS )HookTestz!Common base class for hook tests.c O s t dS )z7Calls the method being tested with the given arguments.N)NotImplementedError)r r r r
r
r r R s zHookTest._callc O sD t d&}d|_| j|i | W d n1 s60 Y |S )zCalls self._call after mocking out certbot.compat.misc.execute_command_status.
The mock execute object is returned rather than the return value
of self._call.
*certbot.compat.misc.execute_command_statusr r8 N)r r% r) r )r r r mock_executer
r
r _call_with_mock_executeW s .z HookTest._call_with_mock_executeN)r r! r" r# r$ r r: r
r
r
r r4 O s
r4 c s e Zd ZdZedd Z fddZ fddZdd Zd
d Z d d
Z
dd Z dd Z dd Z
dd Zdd Zdd Z ZS ) PreHookTestz+Tests for certbot._internal.hooks.pre_hook.c O s ddl m} ||i |S )Nr )pre_hook)r r< )r r r r< r
r
r r h s zPreHookTest._callc sJ t d| j_t| jj tj | jjd| _
t | j
| d S Nr* r0 )
supersetUpr r< r makedirsZrenewal_pre_hooks_dirr pathjoindir_hook create_hook_reset_pre_hook_alreadyr. __class__r
r r? m s
zPreHookTest.setUpc s | t d S N)rE r> tearDownr. rF r
r rI x s zPreHookTest.tearDownc C s ddl m} | d S )Nr )executed_pre_hooks)r rJ clear)r rJ r
r
r rE } s z#PreHookTest._reset_pre_hook_alreadyc C s d| j _| d S )Ncertonlyr verb_test_nonrenew_commonr. r
r
r
test_certonly s zPreHookTest.test_certonlyc C s d| j _| d S )NrunrM r. r
r
r test_run s zPreHookTest.test_runc C s. | | j}|jd| jjtjd | d S )Npre-hookenv)r: r assert_called_once_withr< r ANY_test_no_executions_commonr r9 r
r
r rO s z!PreHookTest._test_nonrenew_commonc C sV d | j _d| j _t| j td }| | j }W d n1 sH0 Y d S )Nrenew certbot._internal.hooks.logger) r r< rN r removerC r r% r: r Z mock_loggerr9 r
r
r
test_no_hooks s *zPreHookTest.test_no_hooksc C s6 d| j _| | j }|jd| j jtjd | d S )NFrS rT )r directory_hooksr: rV r< r rW rX rY r
r
r test_renew_disabled_dir_hooks s z)PreHookTest.test_renew_disabled_dir_hooksc C sJ d| j _| | j }|jd| jtjd |jd| j jtjd | d S NrZ rS rT )
r rN r: assert_any_callrC r rW assert_called_withr< rX rY r
r
r test_renew_no_overlap s
z!PreHookTest.test_renew_no_overlapc C s> | j | j_d| j_| | j}|jd| j tjd | d S ra ) rC r r< rN r: rV r rW rX rY r
r
r test_renew_with_overlap s
z#PreHookTest.test_renew_with_overlapc C s: t d }| | j}W d n1 s,0 Y d S )Nr[ )r r% r: r r] r
r
r rX s *z&PreHookTest._test_no_executions_common)r r! r" r# r$ r r? rI rE rP rR rO r^ r` rd re rX
__classcell__r
r
rF r r; e s
r; c s e Zd ZdZedd Z fddZ fddZdd Zd
d Z d d
Z
dd Z dd Z dd Z
dd Zdd Zdd Zdd Zd d Zd d Z ZS ) PostHookTestz,Tests for certbot._internal.hooks.post_hook.c O s ddl m} ||i |S )Nr ) post_hook)r rh )r r r rh r
r
r r s zPostHookTest._callc sJ t d| j_t| jj tj | jjd| _
t | j
| d S )Nr0 r* )
r> r? r rh r r@ Zrenewal_post_hooks_dirr rA rB rC rD _reset_post_hook_eventuallyr. rF r
r r? s
zPostHookTest.setUpc s | t d S rH )ri r> rI r. rF r
r rI s zPostHookTest.tearDownc C s ddl m} |d d = d S Nr )
post_hooksr rk r rk r
r
r ri s z(PostHookTest._reset_post_hook_eventuallyc C s: dD ]0}|| j _| | j g }|jd| j jtjd qd S )NrL rQ post-hookrT )r rN r: rV rh r rW )r rN r9 r
r
r test_certonly_and_run_with_hook s
z,PostHookTest.test_certonly_and_run_with_hookc C s d | j _dD ] }|| j _q d S )Nrn )r rh rN )r rN r
r
r #test_cert_only_and_run_without_hook s z0PostHookTest.test_cert_only_and_run_without_hookc C s d| j _| | j dgj}d S )NrL success.org)r rN r: Z call_args)r r r
r
r test_renew_env s zPostHookTest.test_renew_envc C s d| j _| | j jg d S )NF)r r_ _test_renew_commonrh r. r
r
r r` s z*PostHookTest.test_renew_disabled_dir_hooksc C s d | j _| | jg d S rH )r rh rt rC r. r
r
r test_renew_no_config_hook s z&PostHookTest.test_renew_no_config_hookc C s t | j | | jjg d S rH )r r\ rC rt r rh r. r
r
r test_renew_no_dir_hook s z#PostHookTest.test_renew_no_dir_hookc C s" d | j _t| j | g d S rH )r rh r r\ rC rt r. r
r
r test_renew_no_hooks s z PostHookTest.test_renew_no_hooksc C s< | j | jjg}| | d| j_|| jj | | d S )Nbaz)rC r rh rt append)r expectedr
r
r rd s
z"PostHookTest.test_renew_no_overlapc C s | j | j_| | j g d S rH )rC r rh rt r. r
r
r re s
z$PostHookTest.test_renew_with_overlapc C s( d| j _tdD ]}| | j g qd S )NrZ )r rN ranger )r rz _r
r
r rt s z PostHookTest._test_renew_commonc C s ddl m} |S rj rl rm r
r
r _get_eventually s z PostHookTest._get_eventually)r r! r" r# r$ r r? rI ri rp rq rs r` ru rv rw rd re rt r~ rf r
r
rF r rg s"
rg c sT e Zd ZdZedd Zdd Z fddZdd Zd
d Z d d
Z
dd Z Z S )RunSavedPostHooksTestz7Tests for certbot._internal.hooks.run_saved_post_hooks.c O sF ddl m} d|v r |d n|d }d|v r4|d n|d }|||S )Nr )run_saved_post_hooksrenewed_domainsfailed_domainsr )r r )r r r r r r r
r
r r s zRunSavedPostHooksTest._callc O sH d}t j|| jd | j|i |W d S 1 s:0 Y dS )zCall run_saved_post_hooks but mock out execute and eventually
certbot._internal.hooks.post_hooks is replaced with
self.eventually. The mock execute object is returned rather than
the return value of run_saved_post_hooks.
z"certbot._internal.hooks.post_hooks)newN)r r%
eventuallyr: )r r r Zeventually_pathr
r
r &_call_with_mock_execute_and_eventually s z r? r r. rF r
r r? " s
zRunSavedPostHooksTest.setUpc C s d S rH r
r. r
r
r
test_empty& s z RunSavedPostHooksTest.test_emptyc C s6 g d| _ | g g }|j}t|| j D ]\}}q(d S )Nr* r0 rx Zqux)r r r zip)r r9 ZcallsZ actual_callZ expected_argr
r
r
test_multiple) s
z#RunSavedPostHooksTest.test_multiplec C s0 dg| _ | g g }|jd| j d tjd d S )Nr* ro r rT )r r rV r rW rY r
r
r test_single1 s z!RunSavedPostHooksTest.test_singlec C s dg| _ | dgdg}d S )Nr* rr z
failed.org)r r rY r
r
r test_env6 s z RunSavedPostHooksTest.test_env)
r r! r" r# r$ r r r? r r r r rf r
r
rF r r s
r c s4 e Zd ZdZdd Z fddZ fddZ ZS )RenewalHookTestz1Common base class for testing deploy/renew hooks.c s d|v r|d n|d d|v r(|d n|d fdd}t d&}||_| j|i | W d n1 st0 Y |S ) a Calls self._call after mocking out certbot.compat.misc.execute_command_status.
The mock execute object is returned rather than the return value
of self._call. The mock execute object asserts that environment
variables were properly set.
domainsr lineager{ c s dS )zAssert environment variables are properly set.
:returns: two strings imitating no output from the hook
:rtype: `tuple` of `str`
r7 r
)Z unused_argsZ
unused_kwargsr r r
r execute_side_effectM s zDRenewalHookTest._call_with_mock_execute..execute_side_effectr6 N)r r% Z side_effectr )r r r r r9 r
r r r: B s .z'RenewalHookTest._call_with_mock_executec s t dd dD | _d S )Nc S s h | ]}|t jvr|qS r
)r environ)r varr
r
r _ s
z(RenewalHookTest.setUp..)ZRENEWED_DOMAINSZRENEWED_LINEAGE)r> r?
vars_to_clearr. rF r
r r? ] s
zRenewalHookTest.setUpc s( | j D ]}tj|d qt d S rH )r r r popr> rI )r r rF r
r rI d s
zRenewalHookTest.tearDown)r r! r" r# r: r? rI rf r
r
rF r r = s r c @ sH e Zd ZdZedd Zeddd Zeddd Z d d
Z
d S ) DeployHookTestz.Tests for certbot._internal.hooks.deploy_hook.c O s ddl m} ||i |S )Nr ) deploy_hook)r r )r r r r r
r
r r m s zDeployHookTest._callr[ c C s& d| j _d| j _| | j dgd}d S )Nr* T example.org/foo/bar)r r dry_runr: r] r
r
r test_dry_runr s
zDeployHookTest.test_dry_runc C s d | j _| | j dgd}d S )Nr r )r r r: r] r
r
r test_no_hook{ s
zDeployHookTest.test_no_hookc C s> ddg}d}d| j _| | j ||}|jd| j jtjd d S )Nr example.netr r* deploy-hookrT )r r r: rV r rW )r r r r9 r
r
r test_success s zDeployHookTest.test_successN) r r! r" r# r$ r r r% r r r r
r
r
r r j s
r c s^ e Zd ZdZedd Z fddZdd Ze dd d
Z
d d Z d
d Z dd Z
ZS )
RenewHookTestz,Tests for certbot._internal.hooks.renew_hookc O s ddl m} ||i |S )Nr )
renew_hook)r r )r r r r r
r
r r s zRenewHookTest._callc sB t d| j_t| jj tj | jjd| _
t | j
d S r= ) r> r? r r r r@ Zrenewal_deploy_hooks_dirr rA rB rC rD r. rF r
r r? s
zRenewHookTest.setUpc C s4 d| j _| | j dgd}|jd| j jtjd d S )NFr r r rT )r r_ r: rV r r rW rY r
r
r test_disabled_dir_hooks s
z%RenewHookTest.test_disabled_dir_hooksr[ c C s d| j _| | j dgd}d S )NTr r )r r r: r] r
r
r r s
zRenewHookTest.test_dry_runc C sT d | j _t| j td"}| | j dgd}W d n1 sF0 Y d S )Nr[ r r )r r r r\ rC r r% r: r] r
r
r r^ s
"zRenewHookTest.test_no_hooksc C s6 | j | j_| | jddgd}|jd| j tjd d S )Nr r r r rT )rC r r r: rV r rW rY r
r
r test_overlap s
zRenewHookTest.test_overlapc C s@ | | jdgd}|jd| jtjd |jd| jjtjd d S )Nr r r rT )r: r rb rC r rW rc r rY r
r
r test_no_overlap s
z RenewHookTest.test_no_overlap)r r! r" r# r$ r r? r r r% r r^ r r rf r
r
rF r r s
r c @ s< e Zd ZdZedd Zdd Zdd Zdd Zd
d Z d S )
ListHooksTestz-Tests for certbot._internal.hooks.list_hooks.c O s ddl m} ||i |S )Nr )
list_hooks)r r )r r r r r
r
r r s zListHooksTest._callc C s d S rH r
r. r
r
r r s zListHooksTest.test_emptyc s, t fdddD }|D ] }t| qd S )Nc 3 s | ]}t j j|V qd S rH )r rA rB tempdir)r basenamer. r
r s z.ListHooksTest.test_multiple..r )sortedrD )r namesnamer
r. r r s
zListHooksTest.test_multiplec C s t j| jd}t| d S r2 r rA rB r rD r r r
r
r r s zListHooksTest.test_singlec C s t j| jd}t| d S )Nzfoo~r r r
r
r test_ignore_tilde s z ListHooksTest.test_ignore_tildeN)
r r! r" r# r$ r r r r r r
r
r
r r s
r c C s t j| ddd dS )zmCreates an executable file at the specified path.
:param str file_path: path to create the file at
wi )modechmodN)r Z safe_openclose)Z file_pathr
r
r rD s rD __main__r )&r# sysZunittestplatformr r r+ Zcertbotr r Zcertbot.compatr r Z
certbot.testsZ test_utiltypingr r r ZTestCaser ZTempDirTestCaser& ZConfigTestCaser4 r; rg r r r r r rD r exitmainargv__file__r
r
r
r s2 NX2-"6"