VhYUdZddlmZddlmZddlZddlZddlZddl Z ddl Z ddl Z ddl Z ddlmZmZmZmZddlmZmZddlmZmZmZmZmZmZddlmZmZm Z m!Z!m"Z"m#Z#m$Z$m%Z%m&Z&m'Z'm(Z(m)Z)m*Z*m+Z+m,Z,m-Z-dd l.m/Z/dd l0m1Z1dd l2m3Z3dd l4m5Z5m6Z6m7Z7m8Z8m9Z9dd l:m;Z;mZ>m?Z?m@Z@mAZAddlBmCZCddlDmEZEiZFdeGd<e jZIGddZJ d1 d2dZK d3 d4dZLd5dZMd6dZNeEd7dZOd8dZPeEd9dZQGddZRGddZSd:dZTd;d ZUd9d!ZVGd"d#ZWej d d?d*Z]d@d+Z^dAd,Z_ dBd-Z`dCd.Za dDd/Zb dEd0Zcy)Fz1High level functions for working with containers.) annotationsN)ApplicationErrorSubprocessErrordisplaysanitize_host_name) ExitHandlernamed_temporary_file)EnvironmentConfigIntegrationConfig SanityConfig ShellConfig UnitsConfigWindowsIntegrationConfig)ContainerNotFoundError DockerInspect docker_create docker_execdocker_inspectdocker_network_inspect docker_pull docker_rm docker_run docker_startget_docker_container_idget_docker_host_ipget_podman_host_ipget_session_container_namerequire_dockerdetect_host_properties) run_playbook)SshKey)IntegrationTarget)SshConnectionDetail SshProcesscreate_ssh_port_forwardscreate_ssh_port_redirectsgenerate_ssh_inventory)ControllerConfig DockerConfig OriginConfigPosixSshConfig PythonConfig RemoteConfigWindowsInventoryConfig) SshConnection)mutexzdict[str, ContainerDescriptor]support_containersceZdZdZdZdZdZy)HostTypez?Enum representing the types of hosts involved in running tests.origincontrolmanagedN)__name__ __module__ __qualname____doc__r5r6r7Q/home/dcms/DCMS/lib/python3.12/site-packages/ansible_test/_internal/containers.pyr4r4`sI FGGr=r4c Xt||}|jr t||yt||xs t |g}t j } t} | dk(r z(run_support_container..s%=Nv|ZQacoPp=q=N "Fz-dtz-p--env=z--ulimitz nofile=%s)rHzSYSTEMD_LOG_LEVEL=debugzStarting new "%s" container.) create_onlycmdzContainer already defined: zAdding "z" to container database.)rprime_containersrr"rrcommandrrC controllerr*alltargetsappendextendstritemsr max_open_filesdev_systemd_debugrinfo run_containerContainerDescriptorsupport_containers_mutexr2 Exceptionr registercleanup_containers)argscontextimagenameportsaliasesstartcleanuprKenvoptions publish_portsdocker_commandcurrent_container_idportkeyvaluerUsupport_container_idrunning descriptors r>run_support_containerrqhs=$ &dD 1D D%  4L3,T23G#%--N24! doo| 4=NAEAMAM=N:N!M !MmG u .D NND#d), - . ))+ >JC NNGU%;< = >,D1@@N NNJ n <=> ;< LL/$67e(udGUZQZ`cdG$     J ". % %9$@A A!  !3T :#-4 . LL8D6!9:; D! ..s *AH  H)ct|xsg}t|xsg}|jd|gt|}t|r|jd|gt ddD]f} |rt ||||d}nt ||||d}|jr!djdt dD}|jcSt%d |d #t$rc} tj| jtjd |d t||t!j"dYd } ~ d } ~ wwxYw) z-Run a container using the given docker image.z--namez --networkrrc3FK|]}tjdyw)0123456789abcdefN)randomchoice)rD _iterations r>rFz run_container..s _z/A!B _!@zFailed to run docker image "-". Waiting a few seconds before trying again.N".)listrR!get_docker_preferred_network_nameis_docker_user_defined_networkrangerrexplainjoinstriprrerrormessagewarningrtimesleepr) r^r`rargrKrJnetworkrystdoutexs r>rXrXs17=b!G syb/C NNHd#$/5G%g. W-.Aqk"  "&tUGSA!D#D%#>qA|| _UZ[]U^ __<<> !"" 9%C DD  MM"** % OO:5'Ano p dD ! JJqMM  s+%C E (AEE c*g}tddD]} t|||cStd|d#t$rW}tj|j tj d|dtjdYd}~~d}~wwxYw)z'Start a docker container by name or ID.rrsz"Failed to start docker container "r|Nr}) rrrrrrrrrr)r^ container_idrgryrs r>start_containerrsGAqk  lG< < ? ~RP QQ   MM"** % OO@N{| } JJqMM s 2 BA B  Bc|jrRt|}|s2t|jjj d}|j|d}n|j d}|sy|S)zHReturn the IP address of the container for the preferred docker network.r IPAddressN)networksrsortedkeyspopnetwork_settings)r^ container network_name ipaddresss r>get_container_ip_addressrso8> ")"4"4"9"9";<@@CL&&|4[A ..{;  r=c tjS#t$rYnwxYwd}|jr |j}nPt }|rD t ||d}|j }n$#t$rtjdYnwxYw|'tjdk(rt|ddrd}|t_|S)a  Return the preferred network name for use with Docker. The selection logic is: - the network selected by the user with `--docker-network` - the network of the currently running docker container (if any) - the default docker network (returns None) NT)alwayszxUnable to detect the network for the current container. Use the `--docker-network` option if containers are unreachable.podman) rrAttributeErrordocker_networkrrget_network_namerrrrrMr)r^rrjrs r>rrs 0888    G %%68  \+41EdS #446) \![\ \>+33x?DZ[_airvDw07%- Ns  A((B B c&t|xr|dk7S)z@Return True if the network being used is a user-defined network.bridge)bool)rs r>rr<s = 0W00r=ContainerDatabasec tjS#t$rYnwxYw|jrJt j ddt jtj|j}n"t j ddt|}t j dtj|jddzd |t_|S) zReturn the current container database, creating it as needed, or returning the one provided on the command line through delegation.zParsing container database.r verbosityzCreating container database.z>>> Container Database %sTindent sort_keysrs) get_container_databasedatabaser containersrrWr from_dictjsonloadscreate_container_databasedumpsto_dict)r^rs r>rrAs %...      2a@$..tzz$///JK 3qA,T2 LL- 8;K;K;MVWcg0hhtuv&.# Os  c:eZdZdZddZddZed dZd dZy) ContainerAccesszSInformation needed for one test host to access a single container supporting tests.c<||_||_||_||_yrBhost_ipnamesrbforwards)selfrrrbrs r>__init__zContainerAccess.__init__Zs&    ! r=c|jr%t|jj}|S|jDcgc]}||f}}|Scc}w)z/Return a port map for accessing this container.)rr~rTrb)rrbrks r>port_mapzContainerAccess.port_mapksN ==,,./E /3jj9ddD\9E9 :s Ac|jd}|r td|jD}t|d|d|jd|S)z6Return a ContainerAccess instance from the given dict.rc3<K|]\}}t||fywrBintrDrlrms r>rFz,ContainerAccess.from_dict..zsQ*#uSXu-Qsrrrbr)getdictrTr)datars r>rzContainerAccess.from_dicttsV88J' Q@PQQHOw-((7#   r=ct|j|j}|jr|j |j|j r|j |j |S)&Return a dict of the current instance.)rr)rb)r)rrrrbupdater)rrms r>rzContainerAccess.to_dictsS"&LL**#  :: LLtzzL * == LL$--L 0 r=N) rrSr list[str]rbzt.Optional[list[int]]rzt.Optional[dict[int, int]]returnNone)rzlist[tuple[int, int]])rdict[str, t.Any]rrrr) r8r9r:r;rr staticmethodrrr<r=r>rrWs(]!"     r=rc2eZdZdZddZeddZddZy) rz5Database of running containers used to support tests.c||_yrBr)rrs r>rzContainerDatabase.__init__s  r=cTttd|jDS)z8Return a ContainerDatabase instance from the given dict.c3fK|])\}}|td|jDf+yw)c3fK|])\}}|td|jDf+yw)c3PK|]\}}|tj|f ywrB)rrrDcontainer_namers r>rFzBContainerDatabase.from_dict....s02g6Oni4B?C\C\]fCg2h2gs$&NrrTrD context_namers r>rFz8ContainerDatabase.from_dict...sH,^1I j.:-12gS]ScScSe2g.g-h,^/1NrrD access_namecontextss r>rFz.ContainerDatabase.from_dict..sJ&Q +@+x (3'+,^MUNNL\,^(^'_&Qr)rrrTrs r>rzContainerDatabase.from_dicts4!&Q DH::< &Q"QR Rr=cVtd|jjDS)rc3fK|])\}}|td|jDf+yw)c3fK|])\}}|td|jDf+yw)c3FK|]\}}||jfywrB)rrs r>rFz@ContainerDatabase.to_dict....s, U$=NI"01B1B1D E UrzNrrs r>rFz6ContainerDatabase.to_dict...sGL7lJ( UAKAQAQAS UUVLrNrrs r>rFz,ContainerDatabase.to_dict..sHD . X !L;C..:JLLMDr)rrrTrs r>rzContainerDatabase.to_dicts-D 261B DD Dr=N)rz0dict[str, dict[str, dict[str, ContainerAccess]]]rr)rrrrr)r8r9r:r;rrrrr<r=r>rrs&?RRDr=c \tddddt|j|jS)zXReturn SSH connection details for localhost, connecting as root to the default SSH port. localhostNroot)r$r"rlpath)r^pythons r> local_sshrs( {Kvvd|GWGWY_YdYd eer=c|jjj}|jr|j dt di|S)z}Return the SSH connection details from the given SSH connection. If become was specified, the user will be changed to `root`.r)userr<)settings__dict__copybecomerr$)sshrs r>root_sshrsE||$$))+H zz    * **r=c |i}i}i}tjD]B\}}|jjrut j dk(rt }nt}t||jdtd|jjjD}nd}|jjr8t|jj|j|jd}nmt j dk(rTtt |jdtd|jjjD}nd}tr2|std|z|j|j i} || |<n$|sn!|j|j i} || |<t#|j$t&rnd|vrnt#|j$t(s$t#|j$t*rrFz,create_container_database..{9M~t^4{rc3*K|] \}}||f ywrBr<rs r>rFz,create_container_database..rrz$Missing IP address for container: %s -controller-z)Missing published ports for container: %sz-target-c30K|]\}}|s ||fywrBr<rs r>rFz,create_container_database..sEeue Es  )r2rTdetailspublished_portsrrMrrrrcr container_iprbrr[ setdefaultr_rCrNr.r*r+ issubclass target_typer/r,r4r5r6r7r) r^r5r6r7rar host_ip_funcpublished_accesscontainer_accessorigin_contextcontrol_contextmanaged_contextrs r>rrsc46F57G57G-335N5i    , ,''831 1 .$''{QZQbQbQrQrQxQxQz{{    $     ) ).!))66''oo      % % 1.*,''{QZQbQbQrQrQxQxQz{{    $  " $# F MNN#..y/@/@"EN#3N4 ! #..y/@/@"EN#3N4 doo| 4  t #   6:dooWc;djAjC")"4"4Y5F5F"K(8% F MNN# Kd RSS%001B1BBGO$4OD ! d&&7M~(^ _  t #zT'9  ((, 7JtGWGWYerz SupportContainerContext.__init__"s$ r=c|jsy|jjtjdd|jj y)z0Close the process maintaining the port forwards.NzAWaiting for the session SSH port forwarding process to terminate.rr)r  terminaterrWwaitrs r>closezSupportContainerContext.close&s<||    Xdef r=N)rrr zt.Optional[SshProcess]rr)rr)r8r9r:r;rrr<r=r>r r s[ r=r c#"Kt|ttttfsdyt |}|j stiyt|||} |j|jy#|jwxYww)zKCreate a context manager for integration tests that use support containers.N) rCr rr rrrr create_support_container_contextrr)r^rrr_s r>support_container_contextr2st d. \;W X '-J ??##.tS*EG     sABA:)B:B  Bc  tj}t|jj }|jj tj d}i}||jvrn|s td|jD]N\}}|jD]6\} } d| vr | jD]\} } || | f|| j| f<8P|s t|dS|std|zt|j} t||| }t||} |j}i}|jD]\}}|\}} ||| f\}} }||| } |j!|i}|j!| t#d| j$di}||j&|<t)j*d| ||| |fzd||j|<|S#t$r|j-wxYw) zTContext manager that provides SSH port forwards. Returns updated container metadata.Nz!Missing origin container details.r\The %s host was not pre-configured for container access and SSH forwarding is not available. 127.0.0.1zKContainer "%s" port %d available at %s:%d is forwarded over SSH as port %d.rr)r4r6rrrrr5r[rTrrr r~rr&collect_port_forwardsrrrrrrWr)r^rr host_typerevisedsource container_maprr_rrrk access_portrr result port_forwardsrforwardforwarded_port access_hostcontainer_portforwarded_containers r>rrJsI   I  4 4 67G \\  hoot 4FACM $?@ @%+\\^ k !L'-4]]_ k) !^3)2););)=k%D+GSUceiFjM9#4#4k"BCk  k k &w55 vzCCD DM&&()H&tS(;G $Wg 6F557 :<'4':':'<  #G^'. $K;H+WbIc;d 8L..|,^rzContainerDescriptor.__init__sS   (  *  59 r=cRt||j|j|y)zLStart the container. Used for containers which are created, but not started.N)rrar\)rr^s r>rdzContainerDescriptor.startsdii( dr=c\jrtdjz t|jt|}jrtfdjD}td |jDr$t!d t#j$|d d ztd|jD}ni}t'||_jS#t$r|j st |tjtdtfdjDtjr9jjDcgc] \}}|d|ncc}}wc}}ngYlwxYw)zZRecord the container's runtime details. Must be used after the container has been started.z Container already registered: %src3K|]8}d|ztjrtjddn|gf:yw)z%d/tcpi0ui@)HostPortN)rrhrwrandint)rDrkrs r>rFz/ContainerDescriptor.register..sEXEI4$`d`r`ruV[@\x|2}1~Xs>A)rPortsrI)Env)IdNetworkSettingsConfigc3DK|]}|j|fywrB) get_tcp_port)rDrkrs r>rFz/ContainerDescriptor.register..s!YddI$:$:4$@AYs c3bK|]'}| xsttd|Ddk7)yw)c3&K|] }|d yw)r)Nr<)rDconfs r>rFz9ContainerDescriptor.register...s(Mdj)9(MsrN)lenset)rDconfigs r>rFz/ContainerDescriptor.register..s1uX^v:SS(Mf(M%M!NRS!SSus-/z?Unexpected `docker inspect` results for published TCP ports: %srTrc3HK|]\}}|t|ddfyw)rr)Nr)rDrkr7s r>rFz/ContainerDescriptor.register..s("l,$PVD#fQi .C*D#E"lrG)rr[rarrrrrrrbrfrTrrhanyvaluesrrrSupportContainer)rr^rlrmsupport_container_ip tcp_portsrrs` @r>r\zContainerDescriptor.registers <<>JK K &tTYY7I" 8iH   YdjjYYIubkbrbrbtuu&'ilplvlvxAJKW[m\(\]]""lZcZiZiZk"llO O'    ||G& <<&dD$$ $)XMQMWMWXX!W[W_W_$((..BRSJCC/SSeg - I  sC99BF+;F  F+*F+N)r`rSr_rSrarSrrSrb list[int]rcrrhrrorrerrft.Optional[dict[str, str]]rrr^r rr)r^r rr;)r8r9r:r;rrdr\r<r=r>rYrYs0::: :  :  :::::(: :2 *r=rYc(eZdZdZ ddZy)r;zIInformation about a running support container available for use by tests.c.||_||_||_yrB)rrr)rrrrs r>rzSupportContainer.__init__s #(.r=N)rrrrSrzdict[int, int]rr)r8r9r:r;rr<r=r>r;r;s0S/ //( /  /r=r;ctjd|d|td|D]B}|dkDrtj| t ||dd|zgdd}|r ||s@|cStd |d|#t $rYawxYw) zcWait for the specified file to become available in the requested container and return its contents.zWaiting for container "z" to provide file: rddzif=%sT)capturerzTimeout waiting for container ")rrWrrrrrr)r^rrrtriescheckryrs r> wait_for_filerHs LL^UYZ[Auo  > JJu   ~gn7MW[\]^_Ff M  Wegkl mm    sA>> B  B c|tjD]%}|jst||j'y)zClean up containers.N)r2r:rerra)r^rs r>r]r]s1'..0,    dINN +,r=cg}tj}|jD]O}|jrd}n |j}|j |ddj |jd|Q|S)z/Return hosts entries for the specified context.r z # ansible-test )uuiduuid4r:rrrQrr)r_entries unique_idrrs r>create_hosts_entriesrPskG I^^%d   !G''GGSXXioo=VXabcd Nr=c p t}|jjtjro|jjtj  s t  dttrd nd ii d f d }d fd }||fSd\}}||fS)zfReturn pre and post target callbacks for enabling and disabling container access for each test target.posixwindowsc  tdz|tjtd z|tjy)zIConfigure hosts for SSH port forwarding required by the specified target.z%s_hosts_prepare.ymlN)forward_ssh_portsr4r6r7) rEr^control_connectionscontrol_contexts control_state control_typemanaged_connectionsmanaged_contexts managed_state managed_types r> pre_targetz*create_container_hooks..pre_target/sm d$79OR^9^`mouwxHxHJZ [ d$79OR^9^`mouwxHxHJZ [r=ctdz|tjtdz|tjy)z^Clean up previously configured SSH port forwarding which was required by the specified target.z%s_hosts_restore.ymlN)cleanup_ssh_portsr4r6r7)rEr^rVrXrYrZr\r]s r> post_targetz+create_container_hooks..post_target4s_ d$79OR^9^`mouwxHxH I d$79OR^9^`mouwxHxH Ir=)NN)rEr#rr) rrrr4r6r7create_managed_contextsrCr) r^rVrZrr^rarWrXrYr[r\r]s ``` @@@@@@r>create_container_hooksrcs (-J!**8+;+;<%??..x/?/?@67GH  d4 5$L"LGI GI  [ [  I I { ""#- K { ""r=c i}|jD]`\}}ix}||<|jD]A\}}t|j|jdt |j ||<Cb|S)z8Create managed contexts from the given control contexts.N)rTrrrrr)rWr[rrrrcontrol_containers r>rbrb?s>@)9)?)?)A\% o;==*<81@1F1F1H \ -N-.=>O>W>WYjYpYprvx|~O~X~X~Zy[/\ON + \\ r=c |yd}|jD]\}} d|z} | |jvs| }n|sy|s|jrytd|zg} g} |jD]\} }g}|j D]q\}}|j r@| j ||j|f|j d||j|fzR|j d|j|fzs|s|j r d| d|d}n d | d |d }| j |d d j|t|}t|}t|ddd|5}t|||dt|dddg}| r#|D]}|j t|||  ||f||j<| D]}t!j"|dy#1swY`xYw)zAConfigure port forwarding using SSH and write hosts file entries.Nz cloud/%s/rz %d -> %s:%dz%s:%dzPort forwards for the "z)" container have been established on the z hostzPorts for the "z!" container are available on the z host asz:  ssh-inventory-.jsonF hosts_entriesrE variablesrr)rTrcrr[rrrQrrrPr(r r!rr'rarrW)r^ssh_connectionsplaybook target_staterErr test_contextrr_ context_alias redirectsmessagesrrrr"rrrk inventoryinventory_path ssh_processesrs r>rUrULs7L!)!1 g#l2 FNN *"L     << vzCCD D,.IH%1%7%7%9G! +4+=+=+? N 'NK!!  .)2C2C[!QR} @Q@QS^/__`w)*;*;^)LLM  N !!iwzCD"]kluv OO$))G2DE F#G&)6M&7I d$4gtY OqSaT>8UdanNopq')M" RC  !:4i!P Q R"/ >L+ W*+qqs #GG&c t|j|jd}|sy|\}}t|} t|ddd| 5} t || |dt |ddd|rI|D]} | j tjd|zd |D]} | jyy#1swYUxYw) z`Stop previously configured SSH port forwarding and remove previously written hosts file entries.NrhriFrjrlzEWaiting for the %s host SSH port forwarding process(es) to terminate.rr) rrar(r r!rrrrWr) r^rnrorprErstaterkrwrurvr s r>r`r`s   V[[$ /E %*"]M&7I d$4gtY OqSaT>8UdanNopq$ G       \_hhtuv$ G LLN  qqs B..B7)NTTNNNT)r^r r_rSr`rSrarSrbr>rct.Optional[list[str]]rdrrerrKrzrfr?rgrzrhrrzt.Optional[ContainerDescriptor])NF)r^r r`rSrarSrgrzrKrzrJrrrS)r^r rrSrz'tuple[t.Optional[str], t.Optional[str]])r^r rrrt.Optional[str])r^r rr{)rrSrr)r^r rr)r^r rr-rr$)rr0rr$)r^r rt.Optional[SshConnectionDetail]rz)c.Iterator[t.Optional[ContainerDatabase]])r^r rr|rrrr rB)r^r rrSrrSrrrFrrGz#t.Optional[c.Callable[[str], bool]]rrSr@)r_zdict[str, ContainerAccess]rr)r^r rVlist[SshConnectionDetail]rZ%t.Optional[list[SshConnectionDetail]]rzktuple[t.Optional[c.Callable[[IntegrationTarget], None]], t.Optional[c.Callable[[IntegrationTarget], None]]])rW%dict[str, dict[str, ContainerAccess]]rr)r^r rnr~rorSrp-dict[str, tuple[list[str], list[SshProcess]]]rEr#rrSrrrr)r^r rnr}rorSrprrEr#rrSrr)dr; __future__rcollections.abcabcc contextlibrrwrrL threadingtypingtutilrrrr util_commonr r r7r r r rrr docker_utilrrrrrrrrrrrrrrrr ansible_utilr!core_cir"rEr#rr$r%r&r'r( host_configsr)r*r+r,r-r.r/ connectionsr0threadr1r2__annotations__LockrZr4rqrXrrrrrrrrrrr contextmanagerrrrYr;rHr]rPrcrbrUr`r<r=r>rs7"  & 6827)9>>+&*!%&*%)\ \ \ \  \  \ # \ \\ \ $\#\\%\H"& %E %E %E %E# %E  %E  %E %EP R(&&R1 *99xDD4f +^#B&   (/.9 9 (9"9 9xLL^ / /(26 n nn n  n  n / n n4,"'# '#2'#?'#q '#T D+ D+:D+D+@ D+  D+  D+4D+ D+N .@      r=