VhdZddlmZddlZddlZddlZddlZddlZddlZddl Z ddl Z ddl Z ddl ZddlmZmZmZmZmZmZmZmZmZddlmZmZddlmZddlmZm Z dd l!m"Z"m#Z#m$Z$d d gZ%d Z&d Z'dZ(GddZ)ed@dZ*GddejVZ,ejZdGddZ.edAdZ/dBdZ0 dC dDdZ1GddZ2dEdZ3edFdZ4dGdZ5edHd Z6edHd!Z7edHd"Z8edId#Z9edId$Z:edHd%Z;edId&ZdKd)Z? dC dLd*Z@ dM dNd+ZA dOd,ZBdPd-ZCGd.d/eDZEGd0d1eEZFGd2d3ZGdQdRd4ZHdSd5ZIGd6d7ZJedQdTd8ZKGd9d:ZLdQdUd;ZMdPd<ZN dV dWd=ZO dX dYd>ZPdZd?ZQy)[z2Functions for accessing docker via the docker cli.) annotationsN) ApplicationErrorcommon_environmentdisplayfind_executableSubprocessErrorcache OutputStream InternalErrorformat_command_output) run_command raw_command) CommonConfig)mutex named_lock) CGroupEntry MountEntry MountTypedockerpodmanz4quay.io/ansible/ansible-test-utility-container:3.1.0i(lceZdZdZeddZddZeddZeddZ eddZ eddZ eddZ edd Z edd Zedd Zedd Zedd Zy) DockerInfozLThe results of `docker info` and `docker version` for the container runtime.cNtj}t|gdddd}tj|}|j dx}rt ddj|zt|gdddd}tj|}t||||}|S) z,Initialize and return a DockerInfo instance.)info--format {{ json . }}Tcapturealwaysr ServerErrorsz*Unable to get container host information:  )versionrr) require_dockercommanddocker_commandjsonloadsgetrjoinr)clsargsr% info_stdoutr server_errorsversion_stdoutr#s R/home/dcms/DCMS/lib/python3.12/site-packages/ansible_test/_internal/docker_util.pyinitzDockerInfo.initCs!"**$T+OY]fjklmn zz+& HH^4 4= 4##ORVR[R[\iRj#jk k'.U_clpqrst**^,$w7 c<||_||_||_||_yN)r,enginerr#)selfr,r5rr#s r0__init__zDockerInfo.__init__Xs    r2cV|jjd}|s td|S)zThe client version details.Clientz0Unable to get container host client information.)r#r)r)r6clients r0r:zDockerInfo.client^s,!!(+"#UV V r2c|jjd}|s&|jdk(r |jSt d|S)zThe server version details.Serverrz0Unable to get container host server information.)r#r)r5r:r)r6servers r0r=zDockerInfo.serverhsD!!(+{{h& {{""#UV V r2c |jdS)zThe client version.Version)r:r6s r0client_versionzDockerInfo.client_versiony{{9%%r2c |jdS)zThe server version.r?)r=r@s r0server_versionzDockerInfo.server_version~rBr2cp|jjddd\}}t|t|fS)z#The client major and minor version..N)rAsplitintr6majorminors r0client_major_minor_versionz%DockerInfo.client_major_minor_version8**005bq9 u5z3u:%%r2cp|jjddd\}}t|t|fS)z#The server major and minor version.rFNrG)rDrHrIrJs r0server_major_minor_versionz%DockerInfo.server_major_minor_versionrNr2c|jdk(r |jdk\xr|jdk\St|j)zLReturn True if the `--cgroupns` option is supported, otherwise return False.r )r5rMrPNotImplementedErrorr@s r0cgroupns_option_supportedz$DockerInfo.cgroupns_option_supportedsC ;;( "22h>n4CbCbfnCn n!$++..r2c|j}|jd}|rt|djdS t|dS#t$rYnwxYw|j dkryd|j d|jd }t|jjrtd |tjd |d y)z)The cgroup version of the container host.host cgroupVersionv CgroupVersionrRrzThe Docker client version is z. The Docker server version is z7. Upgrade your Docker client to version 20.10 or later.zBUnsupported Docker client and server combination using cgroup v2. z0Detected Docker server cgroup v1 using probing. Tunique)rr)rIlstripKeyErrorrPrArDdetect_host_propertiesr, cgroup_v2rrwarning)r6rrXmessages r0cgroup_versionzDockerInfo.cgroup_versionsyyxx tO,33C89 9 tO,- -     * *X 5 ,D,?,?+@A,,0,?,?+@AD D  "$)) , 6 6#%ghogp#qr rJ7)T]abs A AAc|j}|jd}|jd}|xr|jdxr|dk(}|S)zPReturn True if Docker Desktop integrated with WSL2 is detected, otherwise False. KernelVersionOperatingSystemz-WSL2zDocker Desktop)rr)endswith)r6rkernel_versionoperating_systemdd_wsl2s r0docker_desktop_wsl2zDockerInfo.docker_desktop_wsl2sQyy/288$56 n^%<%z)detect_host_properties..us<&V%%LVAYJ!'s6!9~Hq *G   fQi (F&&: +DIYIaIaemIm \;M)N(OPQ( %*41FWUVWXFVJ % OOCG $ $ %2e5::uzz)>>K> "/AA 'OOG,A,ABR,STTjT/FF y** */FF /55  5 5h ?@IDWDWWI LL0 B|nANZ[\ LL2:,?1M LL'H4Hm'\$,0@$@LbIKVWY&&DEWDXXxzDyEENO P' (! J)3% s* G66 H'?H""H'Ic$|d|jS)zQReturn the given container name with the current test session name applied to it.-) session_name)r,names r0get_session_container_namersV1T&&' ((r2ct||}|d|dgz}|r|jdt|tt |t|||S)z`Run the specified command using the ansible-test utility container, returning stdout and stderr.z--namez--rm-i)rrs docker_pull UTILITY_IMAGE docker_run)r,rrrdatas r0rrsU &dD 1D$G  tm$ dM7C >>r2c*eZdZdZddZeddZy) DockerCommandz+Details about the available docker command.c.||_||_||_yr4)r% executabler#)r6r%rr#s r0r7zDockerCommand.__init__s $ r2cjtjjdrtt t }nt }|D]p}t |d}|st|dgtddj}|dk(rd |vrFtjd |d |d t|||cSy)z8Detect and return the available docker command, or None.ANSIBLE_TEST_PREFER_PODMANF)requiredz-vTenvrrrrz Detected "z" container runtime version: rrN) osenvironr)listreversedDOCKER_COMMANDSrrdocker_environmentrrrr)commandsr%rr#s r0detectzDockerCommand.detects ::>>6 7H_56H&H CG(5AJ%wo;M;OY]^_`aggih&8w+> gW^_klm$Wj'BB Cr2N)r%r{rr{r#r{rzr}rzzt.Optional[DockerCommand])rrrrr7 staticmethodrrr2r0rrs5 r2rc`tx}r|Stddjt)zTReturn the docker command to invoke. Raises an exception if docker is not available.z3No container runtime detected. Supported commands: , )get_docker_commandrr*r)r%s r0r$r$s6$&&w& PQUQZQZ[jQkPlm nnr2c*tjS)zHReturn the docker command to invoke, or None if docker is not available.)rrrr2r0rrs    !!r2c(ttS)z;Return True if docker is available, otherwise return False.)rrrr2r0docker_availablers "$ %%r2cttjt}tjd|zd|S)z!Return the IP of the Docker host.zDetected docker host IP: %srr)socket gethostbynameget_docker_hostnamerr)docker_host_ips r0get_docker_host_ipr2))*=*?@N LL.?1M r2ctjjd}|rb|jdrQ tj j |djdd}tjd|zd|Sd}tjd d|S#t$rd}tjd |zY|SwxYw) z*Return the hostname of the Docker service. DOCKER_HOST)ztcp://ssh://r:rzDetected Docker host: %sr localhostzQCould not parse DOCKER_HOST environment variable "%s", falling back to localhost.z*Assuming Docker is available on localhost.) rrr) startswithurllibparseurlparserHrr ValueErrorrb) docker_hosthostnames r0rrs**../K{--.BC ||,,[9!<BB3GJH LL3h>! L O AQO O "H OOor}} ~ O sAB#CCcttjt}tjd|zd|S)z!Return the IP of the Podman host.zDetected Podman host IP: %srr)rrget_podman_hostnamerr)podman_host_ips r0get_podman_host_ipr rr2cd} tgdtdd} tj|}|D]}|ddd k(s|d }|S|S#t$rd}Y?wxYw#tj j $r|cYSwxYw) z Return the default hostname of the Podman service. --format was added in podman 3.3.0, this functionality depends on its availability N)rsystem connectionrz --format=jsonTrr[]Name*URI)rrr r'r(decoderJSONDecodeError)rr connectionsr s r0get_podman_default_hostnamers!%HX^p^r}ABCDEjj( " f b !S (!%(H  O  O  << ' 's"AA" AA"BBcbd}tjjd}|s t}|rW|j drF t j j|j}tjd|zd|S|S#t$rtjd|zY|SwxYw)zAReturn the remote podman hostname, if any, otherwise return None.NCONTAINER_HOSTrzDetected Podman remote: %srrzCould not parse podman URI "%s") rrr)rrrrrrrrrrb)r podman_hosts r0get_podman_remoter.sH**..!12K 13 {--h7 O||,,[9BBH LL5@A N O8O  M OO= K L O  Ms)B !B.-B.cPt}|sd}tjdd|S)z*Return the hostname of the Podman service.rz*Assuming Podman is available on localhost.rr)rrr)rs r0rrFs(!"H  AQO Or2ctjd}d}d}|jrtj|j }|D]}t |jdk(stjdt |jx}r|jd}d}nBtjdt |jx}s|jd}d}n|rtjd |d |d |S) zQReturn the current container ID if running in a container, otherwise return None.z/proc/self/mountinfoNz /etc/hostnamez(/(?P[0-9a-f]{64})/userdata/hostname$idPodmanz/(?P[0-9a-f]{64})/hostname$DockerzDetected execution in z container ID: rr)rPathis_filerr( read_textr{rresearchrootgrouprr)mountinfo_path container_idr5rrmatchs r0get_docker_container_idr&Rs\\"89NL F !!.":":"<= E5::/1II&PRUV[V`V`Rabb5b#(;;t#4L%FII&GUZZYY5Y#(;;t#4L%F3 6 -fX_\NS_`a r2cftd|5}|r t||dddy#1swYyxYw)aR Pull the specified image if it is not available. Images without a tag or digest will not be pulled. Retries up to 10 times if the pull fails. A warning will be shown for any image with volumes defined. Images will be pulled only once. Concurrent pulls for the same image will block until the first completes. z docker_pull:N)r __docker_pull)r,imagefirsts r0rrs7 l5'* +'u  $ &'''s'0c d|vr+d|vr'tjd|zdt||}nt||dx}rtjd|zdnftd d D]H} t |d |gd t||x}s |j rn*tj d|dJtd|d|rd|jrWtj d|dt|jddjt|jddyyy#t$r1tj d|dtjdYwxYw)z>Internal implementation for docker_pull. Do not call directly.@rz0Skipping pull of image without tag or digest: %srGrT)r z#Skipping pull of existing image: %srrTpullFrzImage "zL" not found after pull completed. Waiting a few seconds before trying again.z Failed to pull container image "z-". Waiting a few seconds before trying again.rz".z " contains z volume(s): rz This may result in leaking anonymous volumes. It may also prevent the image from working on some hosts or container engines. The image should be rebuilt without the use of the VOLUME instruction.r\N)rrdocker_image_inspectranger&rrbr timesleeprvolumesrr*sorted)r,r)inspect _iterations r0r(r(se %Cu, G%O[\]&tU3(uTB B B :UBaP2, QJ tfe_eD3D%@@G@T\\'%0| }~ Q#%EeWB#OP P7??'% C4H3IVZV_V_`fgngvgv`wVxUyzaa $ %#w # "B5'Iv wx 1  s+*D(D((7E"!E"c0t|d||d|gdy)z'Copy a file to the specified container.cprTr.Nr&)r,r$srcdsts r0 docker_cp_tor<s4$ c%BCTRr2c4t|dg|z|gz|zdS)z0Create a container using the given docker image.createTr.r9)r,r)rrs r0 docker_creater?s& $ W 4w > Dd SSr2c6t|dg|z|gz|z|dS)z-Run a container using the given docker image.runT)rrr9)r,r)rrrs r0rrs) $' 1UG ;c AVZ [[r2c.t|dg|z|gzdS)z Start a container by name or ID.startTr.r9)r,r$rs r0 docker_startrDs! $ G 3|n Dd SSr2c t|ddd|gdt|d|gdy#t$r(}d|jjvr|Yd}~yd}~wwxYw) zRemove the specified container.stopz-t0Tr.rmzno such containerN)r&r rlowerr,r$rs r0 docker_rmrKs^  tfdC>MtdL14@  biioo&7 7H 8s"% AAAceZdZdZy) DockerErrorzGeneral Docker error.N)rrrrrr2r0rMrMsr2rMc$eZdZdZdfd ZxZS)ContainerNotFoundErrorz7The container identified by `identifier` was not found.c8t|d|z||_y)Nz!The container "%s" was not found.)superr7 identifier)r6rR __class__s r0r7zContainerNotFoundError.__init__s .1sW4T!Wd1g&Wsror)rqrrH)r6es r0env_dictzDockerInspect.env_dict/s/WTXX3VAGGCO3VWWW3Vs; c>|jjd|zS)zuReturn a list of the endpoints published by the container for the specified TCP port, or None if it is not published.z%d/tcp)rkr))r6ports r0 get_tcp_portzDockerInspect.get_tcp_port3szz~~ho..r2cF|jyt|jS)z@Return a list of the network names the container is attached to.N)rnr4r@s r0get_network_nameszDockerInspect.get_network_names7s == dmm$$r2c|j}|std|jzt|dkDr*td|jddj ||dS)zwReturn the network name the container is attached to. Raises an exception if no network, or more than one, is attached.z*No network found for Docker container: %s.rz-Found multiple networks for Docker container z instead of only one: rr)rrrrr*)r6rns r0get_network_namezDockerInspect.get_network_name>s~))+"#ORVRYRY#YZ Z x=1 "ptpwpwy}zCzCDLzM$NO O{r2Nr,rrYr|rzr}rr~)rzzdict[str, list[dict[str, str]]])rzz't.Optional[dict[str, dict[str, t.Any]]]rrrz list[str]rzzdict[str, str])rrIrzz t.Optional[list[dict[str, str]]])rzt.Optional[list[str]])rrrrr7rrrardrgrkrnrqrtrr)rrrrrr2r0rVrVsA% %%22(()) ..55%%!!""$$ X/% r2rVc t|dd|gd|d}|jr|sg}nt j |}t |dk(rt||dSt|#t$r}|j}Yd}~hd}~wwxYw)z Return the results of `docker container inspect` for the specified container. Raises a ContainerNotFoundError if the container was not found. containerr5TrrNr) r&r rrr'r(rrVrO)r,rRr rrrrs r0docker_inspectrKs {Iz&JTXaghijk ||F 6" 5zQT58,,  ,, sA%% B. A??Bc(t|dd||gdy)zADisconnect the specified docker container from the given network.network disconnectTr.Nr9)r,r$rs r0docker_network_disconnectr`s4)\7LISWXr2cNeZdZdZddZeddZeddZed dZy) DockerImageInspectz9The results of `docker image inspect` for a single image.c ||_||_yr4rXrZs r0r7zDockerImageInspect.__init__hr[r2c |jdS)z(Return a dictionary of the image config.rfr^r@s r0rgzDockerImageInspect.confignrhr2c@|jjdxsiS)z)Return a dictionary of the image volumes.Volumes)rgr)r@s r0r3zDockerImageInspect.volumesus{{y)/R/r2c |jdS)z-The command to run when the container starts.Cmdrwr@s r0rzDockerImageInspect.cmdzrxr2Nrr~r) rrrrr7rrgr3rrr2r0rresFC% )) 00""r2rc  tj}|j|x}r|S t |dd|gd|d}|j r|sg}ntj|}t|dkDr2td|d t|d tj|d t|dk(rt||d}|||<|Sy #t$rix}t_YwxYw#t $rd}YwxYw)zs Return the results of `docker image inspect` for the specified image or None if the image does not exist. r)r5Trrr rzInspection of image "z" resulted in z items: )indentN) r/r rr)r&r rr'r(rrdumpsr)r,r)r inspect_cacheinspect_resultrrrs r0r/r/s8,22 '**511~1w 5&A4X^_`ab ||F 6" 5zA~!6ug^CPUJ.s+^R{A^b^m^mnt^u^Rs)rupdaterrrrany)r var_names var_prefixesrrvs ` r0rrs  C I L JJrzz/?/?/ASS eTYEVZ]^REQ^R[Re ST JSs A0 !A0 ry)r,rrzr)r,rrr{rzr{r4) r,rrr{rrrrrt.Optional[str]rz'tuple[t.Optional[str], t.Optional[str]])rzrrrr)rzr)r,rr)r{rzr}) r,rr$r{r:r{r;r{rzr}) r,rr)r{rrrrrzr)NN) r,rr)r{rrrrrrrzr)r,rr$r{rrrzr)r,rr$r{rzr})F)r,rrRr{r rrzrV)r,rr$r{rr{rzr})r,rr)r{r rrzzt.Optional[DockerImageInspect])r,rrr{r rrzz t.Optional[DockerNetworkInspect])NNNFNN)r,rr$r{rrrrrrrt.Optional[t.IO[bytes]]rrrrrt.Optional[OutputStream]rrrzr)NNFNFN)r,rrrrrrrrrrrrrr rrrrzrr)Rr __future__r dataclassesenumr'rrrrr1 urllib.parsertypingtutilrrrrr r r r r util_commonrrrgrthreadrrrnrrrrrrrrrEnumr dataclassrr`rrrr$rrrrrrrrr&rr(r<r?rrDrK ExceptionrMrOrVrrrr/rrrrr&rrr2r0rs8"          G  b8b8J   ;$));d#$OOd)! ? ? ? ? ?  ? - ?.@o"" & $4.,,^ '%:S T T TT  T - T \ \ \\  \  \ - \T TTT- T   ) %[%[[|-*Y ""6  F%%(&*%)&*.2     #  #  $, -F&*&*.2    #  $   ,  -@r2