VhRDUdZddlmZddlmZddlZddlZddlZddl Z ddl Z ddl Z ddl Z ddl Z ddlZddlmZddlmZddlmZmZmZmZmZmZmZmZmZmZmZm Z m!Z!m"Z"m#Z#m$Z$m%Z%ddl&m'Z'm(Z(m)Z)m*Z*dd l+m,Z,dd l-m.Z.dd l/m0Z0m1Z1iZ2d e3d <GddZ4GddZ5GddZ6e6joGddZ8d(dZ9d)dZ:d*dZ;d+d,dZd?d'ZKy)@z1Common utility code that depends on CommonConfig.) annotationsN)ANSIBLE_BIN_SYMLINK_MAP)to_bytes)cachedisplayget_ansible_version remove_treeMODE_DIRECTORYMODE_FILE_EXECUTE MODE_FILE OutputStream PYTHON_PATHS raw_commandANSIBLE_TEST_DATA_ROOTANSIBLE_TEST_TARGET_ROOTANSIBLE_TEST_TARGET_TOOLS_ROOTApplicationErrorSubprocessError generate_nameverified_chmod) make_dirsread_text_filewrite_text_filewrite_json_file) data_context)LayoutMessages) PythonConfigVirtualPythonConfigzdict[str, t.Any]CHECK_YAML_VERSIONScbeZdZUdZgZded<eddZeejddZ y) ExitHandlerz#Simple exit handler implementation.z??@//0E%*YY["dF@$)&)$@%'NMM$9"">??@ $$szC/A:/C/A C/C/ A7A2-C/2A77C/:0C,+B43C,4 C!=CC,C!!C,'C,,C/N)r&z t.CallablereturnNone)r5zt.Generator[None, None, None]) __name__ __module__ __qualname____doc__r#__annotations__ staticmethodr* contextlibcontextmanagerr4r+r)r"r"BsD-OQJLQ<<%%r+r"c2eZdZdZddZddZeddZy) ShellScriptTemplatez1A simple substitution template for shell scripts.c||_yN)template)selfrDs r)__init__zShellScriptTemplate.__init__fs   r+c tfd|jDtjd}|j fdj }|S)z3Return a string templated with the given arguments.c3JK|]\}}|j|fywrC)quote).0kvrEs r) z1ShellScriptTemplate.substitute..ks"A$!QAtzz!}%As #z#{(?P[^}]+)}c,|jdS)Nname)group)matchkvps r)z0ShellScriptTemplate.substitute..ms#ekk&.A*Br+)dictitemsrecompilesubrD)rEr(patternvaluerRs` @r) substitutezShellScriptTemplate.substituteisBA&,,.AA**23 BDMMR r+ct|tr$tjdj |Stj|S)z1Return a shell quoted version of the given value. ) isinstancer-shlexrIjoin)rZs r)rIzShellScriptTemplate.quoteps4 eT ";;sxx/ /{{5!!r+N)rDstrr5r6)r(t.Union[str, list[str]]r5ra)rZrbr5ra)r7r8r9r:rFr[r<rIr?r+r)rArAcs#;!""r+rAceZdZUdZdZded<dZded<dZded<dZded<dZ ded<dZ ded<dZ ded <e dd Z dd Zedd Zedd ZddZy) ResultTypezTest result type.NBOTCOVERAGEDATAJUNITLOGSREPORTSTMPctdt_tdt_tdt_tdt_tdt_tdt_tdt_y)Nbotcoveragedatajunitlogsreportsz.tmp)rdrerfrgrhrirjrkr?r+r) _populatezResultType._populatesY#E* (4 $V, %g. $V, ' 2 #F+ r+c||_yrCrO)rErOs r)rFzResultType.__init__s  r+ctjjtjj |j S)z)The content relative path to the results.)ospathr`rcontent results_pathrOrEs r) relative_pathzResultType.relative_paths+ww||LN22??KKr+ctjjtjj |j S)z!The absolute path to the results.)rwrxr`rryrootr|r{s r)rxzResultType.paths-ww||LN22779K9KLLr+c|jSrCrur{s r)__str__zResultType.__str__s yyr+r5r6)rOrar5r6r5ra)r7r8r9r:rer;rfrgrhrirjrkr<rsrFpropertyr|rxrr?r+r)rdrdysCHjD*E:D*GZC,,LLMMr+rdc eZdZdZddZddZy) CommonConfigz%Configuration common to all commands.cB||_d|_d|_d|_|j|_|j |_|j |_|j|_|j|_|j|_ d|_ t|_ i|_ y)NFT)command interactive check_layoutsuccesscolorexplain verbositydebugtruncateredactdisplay_stderrr session_namer)rEr'rs r)rFzCommonConfig.__init__s{   )- :: !\\ "nn:: !]]  KK $))O') r+cJtjjtdS)z;Return the path to the Ansible config for the given config.z ansible.cfg)rwrxr`rr{s r)get_ansible_configzCommonConfig.get_ansible_configsww||2MBBr+N)r'zt.Anyrrar5r6r)r7r8r9r:rFrr?r+r)rrs/*&Cr+rcd}|j|std|d|t}tjd|r;dj |j ddd}d|d }|j||}|S) a< Return the given docs.ansible.com URL updated to match the running ansible-test version, if it is not a pre-release version. The URL should be in the form: https://docs.ansible.com/ansible/devel/path/to/doc.html Where 'devel' will be replaced with the current version, unless it is a pre-release version. When run under a pre-release version, the URL will remain unchanged. This serves to provide a fallback URL for pre-release versions. It also makes searching the source for docs links easier, since a full URL is provided to this function. z,https://docs.ansible.com/ansible-core/devel/zURL "z" does not start with: z ^[0-9.]+$.Nz&https://docs.ansible.com/ansible-core//) startswith ValueErrorr rVsearchr`splitreplace)url url_prefixansible_version url_version new_prefixs r) get_docs_urlrs@J >>* %5% =k]!L kk*j1 Jr+c|jryttjjttj jy)zCreate result directories.N)rrrdrfrxrg)r's r)create_result_directoriesrs2 || j!!&&' joo""#r+c|sy|jD]}tj|d|jD]}tj||jr$t dj |jy)z"Display the given layout messages.Nrr )inforwarningerrorrr`)messagesmessages r)handle_layout_messagesrsr ==+ W*+##! !~~tyy899r+cf|jr\tjjt j |xst j t|xsdSt j||\}tj|tjfdS)z^Return the path to a temporary file that will be automatically removed when the process exits.prefixsuffixc.tjSrC)rwremoverxsr)rSz/process_scoped_temporary_file..sRYYt_r+) rrwrxr`tempfile gettempdir gettempprefixrmkstempcloser"r*)r'rrtemp_fdrxs @r)process_scoped_temporary_filers ||ww||H//1f6X@V@V@X5YZgZiYjkqkwuwjx3yz K !((vF  45 Kr+c6|jr\tjjt j |xst j t|xsdSt j||tjfdS)zcReturn the path to a temporary directory that will be automatically removed when the process exits.rrctSrCr rsr)rSz4process_scoped_temporary_directory..s [%6r+) rrwrxr`rrrrmkdtempr"r*)r'rrrxs @r)"process_scoped_temporary_directoryrs ||ww||H//1f6X@V@V@X5YZgZiYjkqkwuwjx3yz Kvf=67 Kr+c#TK|jr,tjj|xsd|d|yt j |||5}|j t||j |j dddy#wxYw#1swYyxYww)z+Context manager for a named temporary file./tmptemprrdirN) rrwrxr`rNamedTemporaryFilewriterflushrO)r'rr directoryry tempfile_fds r)named_temporary_filers ||ggll9.ff0MNN  ( (v9 U Yd   hw/ 0     !&&&    s0AB(+B?B B(BBB%!B(cxtjj|j|}t||d||y)z`Write the given json content to the specified test results path, creating directories as needed.T)create_directories formattedencoderN)rwrxr`r)categoryrOryrrrxs r)write_json_test_resultsrs- 77<< t ,DD'diY`ar+cttjj|j|}t||dy)z`Write the given text content to the specified test results path, creating directories as needed.T)rN)rwrxr`r)rrOryrxs r)write_text_test_resultsr"s& 77<< t ,DD'd;r+c tjddd tjd ddt t t gd z}d d tfd d tff}tjjtd}|D]6}tjd tjj |8|D]u\}}}tjj||}tjj |}t|}t||}t!||t#||wt# t$d fd } t&j)|  S)zgReturn the path to a directory which contains a `python.py` executable and associated injector scripts. ansible-test-z -injectorrrzInitializing "z&" as the temporary injector directory.rr)z importer.pypytestzansible_connection_cli_stub.pyz python.pyz/usr/bin/env pythonz virtualenv.shz/usr/bin/env bashinjectorcty)z(Remove the temporary injector directory.Nr) injector_pathsr)cleanup_injectorz+get_injector_path..cleanup_injectorKs M"r+r)rrrrsortedr-rr r rwrxr`rsymlinkr set_shebangrrr r"r*) injector_namesscripts source_pathrOshebangmodesrcdstscriptrrs @r)get_injector_pathr(sF$$OKU[\M LL>-0VWcdeD!89=N +->? -y9G '',,7DKC ; ]D ABC '"gtggll;-ggll=$/$VW-V$sD!"=.1#)* r+cd}||z}|ddf}|jtfd|Dr|d<njd|dj}|S)zKReturn the given script with the specified executable used for the shebang.z#!z# auto-shebangz# shellcheck shell=c3FK|]}dj|yw)rN)r)rJrZliness r)rMzset_shebang..as =%58  u % =s!rr) splitlinesanyinsertr`)r executablerr overwriters @r)rrTsl Fz!G I    E =9 ==a Q YYu F Mr+cxtj|}|r|Sd}d}d}tj|||}tj j |d}tjd|d|dd t||t|ttstjt|t|<|S) zhReturn the path to a directory which contains a `python` executable that runs the specified interpreter.zpython-z-ansiblerrpythonz Injecting "z" as a execv wrapper for the "z" interpreter.rr)rgetrrrwrxr`rrcreate_interpreter_wrapperrr r"r*cleanup_python_paths) interpreter python_pathrr root_temp_dirinjected_interpreters r)get_python_pathrks"";/K F FM""&]SK77<< X> LLRfhstABC{,@A;/ 12 +L r+cztj|xsd|xsd|}tjt||S)zKCreate a temporary directory that persists until the current process exits.tmprr)rrr"r*r )rrbase_dir temp_paths r)create_temp_dirrs5  % "RZ[Ii0 r+ctj}tjd|d|dj }t ||t |ty)zHCreate a wrapper for the given Python interpreter at the specified path.z #!zk from __future__ import annotations from os import execv from sys import argv python = 'z.' execv(python, [python] + argv[1:]) N)sysrtextwrapdedentlstriprrr )rrshebang_interpretercodes r)rrsM.. ??   - ./5fh ($/'):;r+cttjD]'}tjd|zdt |)y)z*Clean up all temporary python directories.z*Cleaning up temporary python directory: %srrN)rrvaluesrrr rs r)rrs<|**,- ADHTUVDr+c |j}t|}t}t|tr*t j j|j } nt|j } t j jj|| |dg|d<|j|d<|j |d<t|||||||S)a9 Run a command while intercepting invocations of Python to control the version used. If the specified Python is an ansible-test managed virtual environment, it will be added to PATH to activate it. Otherwise a temporary directory will be created to ensure the correct Python can be found in PATH. PATHANSIBLE_TEST_PYTHON_VERSIONANSIBLE_TEST_PYTHON_INTERPRETER)captureenvrocwdalways) copyr-rr^rrwrxdirnamerpathsepr`version run_command) r'rcmdrr rorr inject_pathrs r)intercept_pythonrs ((*C s)C#%K&-.ggoofkk2 %fkk2 ''//&& [#f+'NOCK)/C%&-3[[C)* tS's3W] ^^r+cT|jxr| }t||||||||| | | | |  S)zBRun the specified command and return stdout and stderr as a tuple.) r rrorrstdinstdoutr output_stream cmd_verbosity str_errorserror_callback)rr)r'rr rrorrrrrrrrrrs r)rrsH"ll)6zG     ##% r+ct|jtjjtdgd|d}|ryt j |}|dsy|dS)z]Return True if PyYAML has libyaml support, False if it does not and None if it was not found.z yamlcheck.pyT)r rrNyamlcloader)rrxrwr`rjsonloads)rrrresults r) yamlcheckr&si &++rww||4RTb'cdnr}DEFGHF ZZ F &> ) r+c, t|jS#t$rYnwxYwt|}||r|t|j<|sL|&|r"t j d|jz|S|s"t j d|jz|S)z Return True if PyYAML has libyaml support, False if it does not and None if it was not found. The result is cached if True or required. z+PyYAML is not installed for interpreter: %szSPyYAML will be slow due to installation without libyaml support for interpreter: %s)r rxKeyErrorr&rr)rrequiredquietstates r) check_pyyamlr,s  "6;;//     f E H,1FKK(  = MPVP[P[ [\ L OOqtztt A Ls  !!)rrar5ra)r'rr5r6)rzt.Optional[LayoutMessages]r5r6)rN)r'rrt.Optional[str]rr-r5ra) r'rrrarrarr-ryrar5zc.Iterator[str])TN) rrdrOraryz&t.Union[list[t.Any], dict[str, t.Any]]rboolrz$t.Optional[t.Type[json.JSONEncoder]]r5r6)rrdrOraryrar5r6r)rrarrar5ra)rrar5ra)NNN)rr-rr-rr-r5ra)rrarrar5r6r)NNF)r'rrrrz list[str]rzdict[str, str]r r.ror-rr-rr.r5'tuple[t.Optional[str], t.Optional[str]]) NNNFNNFNrstrictN)r'rrzc.Iterable[str]r r.rzt.Optional[dict[str, str]]ror-rr-rr.rt.Optional[t.IO[bytes]]rr1rr.rzt.Optional[OutputStream]rintrrarz/t.Optional[c.Callable[[SubprocessError], None]]r5r/)F)rrrr.r5t.Optional[bool])TF)rrr)r.r*r.r5r3)Lr: __future__rcollections.abcabccr=r#rwrVr_rrrtypingt constantsrencodingrutilrrr r r r r rrrrrrrrrriorrrrrorprovider.layoutr host_configsrrr r;r"rArdrsrrrrrrr>rrrrrrrrrrrr&r,r?r+r)r@s7" ( )+%*%%B"",##N CC62$ :    &48 b b  b4 b b 2 b  b< ((V."J<0!_ _ _ _  _  _  _ _ _-_H'+ %)&*.2FJ       $        #  $  ,   D - F r+