From 01721e5f5e5980b156d15637d64feb73387d2e48 Mon Sep 17 00:00:00 2001 From: dcermak <45594031+dcermak@users.noreply.github.com> Date: Tue, 28 Nov 2023 11:25:34 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20@=20dcermak/?= =?UTF-8?q?pytest=5Fcontainer@64aba0d1b16c1534b2ce5af3e81242317f8aab8a=20?= =?UTF-8?q?=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- _sources/usage.rst.txt | 12 ++++++++++-- api.html | 24 +++++++++++++++++++----- changelog.html | 4 ++++ genindex.html | 2 ++ index.html | 2 +- objects.inv | Bin 2147 -> 2149 bytes searchindex.js | 2 +- usage.html | 12 +++++++++--- 8 files changed, 46 insertions(+), 12 deletions(-) diff --git a/_sources/usage.rst.txt b/_sources/usage.rst.txt index 03dd97b..21db465 100644 --- a/_sources/usage.rst.txt +++ b/_sources/usage.rst.txt @@ -394,8 +394,8 @@ follows: :command:`podman`. -Entrypoint and stop signal handling ------------------------------------ +Entrypoint, launch command and stop signal handling +--------------------------------------------------- ``pytest_container`` will by default (when :py:attr:`~pytest_container.container.ContainerBase.entry_point` is set to @@ -419,6 +419,14 @@ image without specifying one (:py:attr:`~pytest_container.container.EntrypointSelection.IMAGE`). +The container under test is launched by default with no further +arguments. Additional arguments can be passed to the entrypoint via the +parameter +:py:attr:`~pytest_container.container.ContainerBase.extra_entrypoint_args`. The +list of arguments/parameters is appended to the container launch command line +after the container image. + + Changing the container entrypoint can have a catch with respect to the ``STOPSIGNAL`` defined by a container image. Container images that have non-shell entry points sometimes use a different signal for stopping the main diff --git a/api.html b/api.html index 309c088..9541fd3 100644 --- a/api.html +++ b/api.html @@ -76,7 +76,7 @@

API documentation
-class pytest_container.container.Container(url: str = '', container_id: str = '', entry_point: ~pytest_container.container.EntrypointSelection = EntrypointSelection.AUTO, custom_entry_point: ~typing.Optional[str] = None, extra_launch_args: ~typing.List[str] = <factory>, healthcheck_timeout: ~typing.Optional[~datetime.timedelta] = None, extra_environment_variables: ~typing.Optional[~typing.Dict[str, str]] = None, singleton: bool = False, forwarded_ports: ~typing.List[~pytest_container.inspect.PortForwarding] = <factory>, volume_mounts: ~typing.List[~typing.Union[~pytest_container.container.ContainerVolume, ~pytest_container.container.BindMount]] = <factory>, _is_local: bool = False)
+class pytest_container.container.Container(url: str = '', container_id: str = '', entry_point: ~pytest_container.container.EntrypointSelection = EntrypointSelection.AUTO, custom_entry_point: ~typing.Optional[str] = None, extra_launch_args: ~typing.List[str] = <factory>, extra_entrypoint_args: ~typing.List[str] = <factory>, healthcheck_timeout: ~typing.Optional[~datetime.timedelta] = None, extra_environment_variables: ~typing.Optional[~typing.Dict[str, str]] = None, singleton: bool = False, forwarded_ports: ~typing.List[~pytest_container.inspect.PortForwarding] = <factory>, volume_mounts: ~typing.List[~typing.Union[~pytest_container.container.ContainerVolume, ~pytest_container.container.BindMount]] = <factory>, _is_local: bool = False)

This class stores information about the Container Image under test.

@@ -109,7 +109,7 @@

API documentation
-class pytest_container.container.ContainerBase(url: str = '', container_id: str = '', entry_point: ~pytest_container.container.EntrypointSelection = EntrypointSelection.AUTO, custom_entry_point: ~typing.Optional[str] = None, extra_launch_args: ~typing.List[str] = <factory>, healthcheck_timeout: ~typing.Optional[~datetime.timedelta] = None, extra_environment_variables: ~typing.Optional[~typing.Dict[str, str]] = None, singleton: bool = False, forwarded_ports: ~typing.List[~pytest_container.inspect.PortForwarding] = <factory>, volume_mounts: ~typing.List[~typing.Union[~pytest_container.container.ContainerVolume, ~pytest_container.container.BindMount]] = <factory>, _is_local: bool = False)
+class pytest_container.container.ContainerBase(url: str = '', container_id: str = '', entry_point: ~pytest_container.container.EntrypointSelection = EntrypointSelection.AUTO, custom_entry_point: ~typing.Optional[str] = None, extra_launch_args: ~typing.List[str] = <factory>, extra_entrypoint_args: ~typing.List[str] = <factory>, healthcheck_timeout: ~typing.Optional[~datetime.timedelta] = None, extra_environment_variables: ~typing.Optional[~typing.Dict[str, str]] = None, singleton: bool = False, forwarded_ports: ~typing.List[~pytest_container.inspect.PortForwarding] = <factory>, volume_mounts: ~typing.List[~typing.Union[~pytest_container.container.ContainerVolume, ~pytest_container.container.BindMount]] = <factory>, _is_local: bool = False)

Base class for defining containers to be tested. Not to be used directly, instead use Container or DerivedContainer.

@@ -134,6 +134,19 @@

API documentation/bin/bash will be used.

+
+
+extra_entrypoint_args: List[str]
+

List of additional arguments that are passed to the CMD or +entrypoint. These arguments are inserted after the docker/podman +run -d $image on launching the image. +The list must be properly escaped, e.g. by passing the string through +shlex.split. +The arguments must not cause the container to exit early. It must remain +active in the background, otherwise this library will not function +properly.

+
+
extra_environment_variables: Optional[Dict[str, str]] = None
@@ -145,8 +158,9 @@

API documentation extra_launch_args: List[str]

List of additional flags that will be inserted after -docker/podman run -d. The list must be properly escaped, e.g. as -created by shlex.split

+docker/podman run -d and before the image name (i.e. these arguments +are not passed to the entrypoint or CMD). The list must be properly +escaped, e.g. as created by shlex.split.

@@ -406,7 +420,7 @@

API documentation
-class pytest_container.container.DerivedContainer(url: str = '', container_id: str = '', entry_point: ~pytest_container.container.EntrypointSelection = EntrypointSelection.AUTO, custom_entry_point: ~typing.Optional[str] = None, extra_launch_args: ~typing.List[str] = <factory>, healthcheck_timeout: ~typing.Optional[~datetime.timedelta] = None, extra_environment_variables: ~typing.Optional[~typing.Dict[str, str]] = None, singleton: bool = False, forwarded_ports: ~typing.List[~pytest_container.inspect.PortForwarding] = <factory>, volume_mounts: ~typing.List[~typing.Union[~pytest_container.container.ContainerVolume, ~pytest_container.container.BindMount]] = <factory>, _is_local: bool = False, base: ~typing.Union[~pytest_container.container.Container, ~pytest_container.container.DerivedContainer, str] = '', containerfile: str = '', image_format: ~typing.Optional[~pytest_container.container.ImageFormat] = None, add_build_tags: ~typing.List[str] = <factory>)
+class pytest_container.container.DerivedContainer(url: str = '', container_id: str = '', entry_point: ~pytest_container.container.EntrypointSelection = EntrypointSelection.AUTO, custom_entry_point: ~typing.Optional[str] = None, extra_launch_args: ~typing.List[str] = <factory>, extra_entrypoint_args: ~typing.List[str] = <factory>, healthcheck_timeout: ~typing.Optional[~datetime.timedelta] = None, extra_environment_variables: ~typing.Optional[~typing.Dict[str, str]] = None, singleton: bool = False, forwarded_ports: ~typing.List[~pytest_container.inspect.PortForwarding] = <factory>, volume_mounts: ~typing.List[~typing.Union[~pytest_container.container.ContainerVolume, ~pytest_container.container.BindMount]] = <factory>, _is_local: bool = False, base: ~typing.Union[~pytest_container.container.Container, ~pytest_container.container.DerivedContainer, str] = '', containerfile: str = '', image_format: ~typing.Optional[~pytest_container.container.ImageFormat] = None, add_build_tags: ~typing.List[str] = <factory>)

Class for storing information about the Container Image under test, that is build from a Containerfile/Dockerfile from a different image (can be any image from a registry or an instance of diff --git a/changelog.html b/changelog.html index d8f2748..c2fac20 100644 --- a/changelog.html +++ b/changelog.html @@ -50,6 +50,10 @@

Next Release +

  • Add property +extra_entrypoint_args to +support appending arguments to the container launch command

    • +

  • Add support for Python 3.12

  • Add property bind_ip to support binding to arbitrary IP addresses.

  • Fix host_port being diff --git a/genindex.html b/genindex.html index 5e2efcf..57eba07 100644 --- a/genindex.html +++ b/genindex.html @@ -262,6 +262,8 @@

    E

  • Changelog
      diff --git a/objects.inv b/objects.inv index 8e43fc2bed7898947a78ccc05bf543a19d4b4a5a..db9feae8028f68953aa2b07f449302d3e5c4a028 100644 GIT binary patch delta 713 zcmV;)0yh2Q5akfC+yQ^Bo-Gw&v6ryuS1Nc_>MGDH78E}*0$KsXO_d)2^)_n>t~MN7gPAUo3?iW#D%Uc^AU zQ_^bBh~gEDdck4aMv(V1RAatteP?34)rcpLQw7WI7G@ZicEk$KRYB8j?CWu>6K(kx(XDy3 zNVQMPOOEM#OqPE$YDN`KG0((PHm_skXNCdH&jZSXUQ(kS?hO(2l@v*P+EYe`i^9!e zmC)ETY!`@t!Qum@Gu&Cu3q;AJ@av3b*J!=`mso+R2ouvSj$6|$VSO|fYKbG5Z1%WY z#kO{gcRkzQLh_dPv(JlI;L;4~r{jo*_LnD~-K^$c78`#6MY7d=`TA!p$a=PfY~KI? z7pn}hX&FSz`o!$fL|g-nbT+?TeS1KU+xT(wU=ORs_r)9lwEDW(+|7OfkT#3i4O%_i zfw8`Amb(Q2Y`eHyK0JO$>&^1(43xONooyC3vB2KkaaEuaix-KW1uv14(XJYo2L7z$ z%+|}su;G7+ii7aX>?Ft@I_SNv{p0q#kxa7$yU;i9ozlgi17Wp0UJ5&kae{3uro`ye*Yy=IMeH6d%*-y%?soV1c2sm zB!e;1By6U delta 711 zcmV;&0yzEU5aSTA+yQ^Jp08B!s?>P&iUq|_j7Z1|7;dWkfUwvDVU5FQJbyvvpWyJ| zLn;?Pu_#EPyI3e7Rn0VX?a#|1-QKeU!Au?U1JTV_v?RO%G6vnDm?2u~l?J3cC9U?1 zC|<#+7aUuC1hQTpmB#bK4D#%Hp6rG+1IqPxIG7cnqX91jH&}n+q)syc^SmOtq5wwL z@%qLA;vklmmI&>mT4+1x&E^GhI8A9KYdtin#(dZM&cvXqg8+{2IT97lq#>H?VY~GW zT3x-7FzW{#+Aj8XZvwK`pODSY2bS9{%rGwPh!vcxf~MQp*W-R9+VU-;Tk~j-2b2fBq((d38zSf{DUvpxr;H32g`2}Fp|NM! zE)W5O#Rp1fxU<9*h>}U+*BQ;O(R%qWu>w;OCZ=1MZE3qJ-4fPEW1*Hfg2`r&yH#v! z$9UJX?JXp4c|ZHShy^aqkbXLjXlQ?V;@Qn={$;TNP$Yj_&6lr##)7P8OGwEL0C2I& z5Sy0fv#d|do*%?D&`4+V+ts%R^tg>5HxKr(T6|y30YIy-i_P8a2LNfanBAb&!yOpw z+h)020Km43yXC{FzZ=OkORx)l^WG_43_1{2yECA$^Aac6#!}wir7FDL z5#qH`LdIy+f*IfMX|+d;yb_j1YxEHMQL`RJqV4xz5`{CpKDHN30M)!e&OiWY{zftw zBTYhg(Dm(%a@&|Nrk5iLGcYF@a~#)+>L~D;?qdz*GMCK0+|QlJlVdcMlV${k0$Jyi t?F6p^Drb|P1+xym?9xJdQU`pO;{>9=OtW7G2LS?4*OO=m`2;#nq@i!hV#)vj diff --git a/searchindex.js b/searchindex.js index b23dbfa..e13f645 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["api", "changelog", "fixtures", "index", "prerequisites", "tutorials", "usage"], "filenames": ["api.rst", "changelog.rst", "fixtures.rst", "index.rst", "prerequisites.rst", "tutorials.rst", "usage.rst"], "titles": ["API documentation", "Changelog", "Fixtures", "Pytest container", "Prerequisites", "Tutorials", "Usage Tips"], "terms": {"all": [0, 2, 3, 5, 6], "class": [0, 1, 5, 6], "abstract": 0, "detail": 0, "launch": [0, 1, 2, 3, 6], "awai": 0, "These": 0, "ar": [0, 1, 3, 4, 6], "us": [0, 1, 2, 4, 5, 6], "parametr": [0, 1, 2, 3, 5, 6], "test": [0, 1, 3, 4, 5], "case": [0, 2, 6], "fixtur": [0, 1, 3, 4, 5, 6], "provid": [0, 1, 2, 3, 5, 6], "thi": [0, 1, 2, 5, 6], "pytest_contain": [0, 1, 3, 4, 6], "bindmount": [0, 1, 6], "container_path": 0, "str": 0, "flag": [0, 1, 6], "type": [0, 1], "list": [0, 4, 5, 6], "volumeflag": [0, 6], "factori": 0, "share": [0, 6], "bool": 0, "fals": 0, "_vol_nam": 0, "host_path": [0, 6], "option": [0, 2, 6], "none": [0, 1, 6], "A": [0, 6], "volum": [0, 1, 3], "mount": [0, 1, 3], "from": [0, 1, 3, 5], "host": [0, 1, 3, 6], "bind": [0, 1, 3], "describ": 0, "directori": [0, 3, 5, 6], "In": [0, 2, 6], "most": [0, 1, 6], "minim": 0, "configur": [0, 1, 3], "you": [0, 3, 4, 5, 6], "need": [0, 1, 3, 4, 6], "specifi": [0, 6], "i": [0, 1, 2, 3, 5, 6], "path": [0, 6], "via": [0, 1, 2, 3, 4, 5, 6], "creat": [0, 1, 2, 3, 5], "temporari": [0, 3, 6], "point": [0, 1, 6], "altern": 0, "can": [0, 1, 2, 3, 4, 5, 6], "also": [0, 2, 4, 6], "yourself": 0, "absolut": 0, "rel": [0, 6], "refer": [0, 1, 6], "auto": [0, 6], "when": [0, 1, 2, 4, 6], "omit": [0, 5, 6], "save": [0, 6], "attribut": [0, 1, 2, 3, 5, 6], "bindmountcr": 0, "_tmpdir": 0, "temporarydirectori": 0, "context": [0, 1], "manag": [0, 1, 2, 3, 5], "necessari": [0, 3, 6], "e": [0, 1, 6], "which": [0, 1, 2, 4, 6], "should": 0, "url": [0, 1, 3, 6], "container_id": [0, 2, 6], "entry_point": [0, 1, 6], "entrypointselect": 0, "custom_entry_point": [0, 6], "extra_launch_arg": [0, 6], "healthcheck_timeout": [0, 1, 2], "datetim": 0, "timedelta": [0, 1, 2], "extra_environment_vari": 0, "dict": 0, "singleton": [0, 1], "forwarded_port": [0, 1, 6], "portforward": [0, 6], "volume_mount": [0, 1, 6], "union": 0, "containervolum": [0, 1, 6], "_is_loc": 0, "store": 0, "inform": 0, "about": 0, "imag": [0, 1, 2, 3, 5], "under": 0, "properti": [0, 1, 6], "baseurl": [0, 1], "registri": [0, 1, 2, 3, 5, 6], "base": [0, 1, 2, 5, 6], "one": [0, 6], "exist": [0, 1, 3, 5, 6], "otherwis": [0, 4, 6], "return": [0, 1, 6], "get_bas": [0, 1], "If": [0, 1, 5, 6], "ha": [0, 6], "self": 0, "prepare_contain": [0, 6], "rootdir": 0, "extra_build_arg": [0, 6], "prepar": [0, 1], "so": [0, 1, 5], "pull_contain": 0, "pull": [0, 1, 3], "given": 0, "current": [0, 1, 4], "select": 0, "containerbas": [0, 1], "defin": [0, 1, 2, 5, 6], "Not": 0, "directli": [0, 6], "instead": [0, 1, 6], "derivedcontain": [0, 2, 5, 6], "id": [0, 6], "avail": [0, 2, 6], "custom": [0, 4, 6], "entri": [0, 1, 6], "neither": 0, "its": [0, 5], "default": [0, 1, 2, 4, 6], "nor": 0, "bin": [0, 6], "bash": [0, 6], "1": [0, 2, 3, 4], "entrypoint": [0, 1, 3], "By": 0, "either": [0, 6], "": [0, 1, 2, 5, 6], "cmd": [0, 2, 6], "two": [0, 6], "set": [0, 1, 2, 3], "addit": [0, 6], "environ": [0, 1, 4], "variabl": [0, 1, 4, 5, 6], "inject": [0, 6], "insert": [0, 6], "after": [0, 3, 6], "docker": [0, 1, 2, 4, 6], "podman": [0, 1, 3, 4, 6], "run": [0, 1, 2, 3, 4, 5], "d": [0, 6], "must": [0, 6], "properli": 0, "escap": 0, "g": [0, 1, 6], "shlex": 0, "split": 0, "filelock_filenam": 0, "filenam": 0, "lockfil": 0, "uniqu": [0, 6], "It": [0, 1, 2, 3, 5, 6], "hash": [0, 1, 6], "exclud": 0, "valu": [0, 1], "therebi": 0, "acquir": 0, "lock": [0, 1], "block": 0, "ani": [0, 1, 6], "action": 0, "specif": 0, "across": 0, "thread": 0, "process": [0, 1, 6], "forward": [0, 6], "port": [0, 1, 3], "get_launch_cmd": [0, 6], "container_runtim": [0, 2, 4, 6], "ociruntimebas": [0, 6], "extra_run_arg": 0, "command": [0, 5, 6], "paramet": [0, 5, 6], "argument": [0, 1, 3], "ad": [0, 1, 3, 5], "instanc": [0, 3, 5, 6], "string": [0, 5], "fed": 0, "subprocess": 0, "popen": 0, "arg": [0, 6], "time": [0, 2], "becom": [0, 2, 3], "healthi": [0, 2, 3], "timeout": [0, 1, 2], "ignor": [0, 1, 2], "healthcheck": [0, 1, 3], "below": 0, "zero": 0, "infer": [0, 1, 2], "direct": [0, 1, 2], "local_imag": 0, "true": [0, 1, 2, 6], "been": 0, "local": [0, 3], "indic": 0, "whether": [0, 2, 3, 6], "never": 0, "more": [0, 1], "than": 0, "becaus": [0, 6], "open": 0, "full": 0, "your": [0, 2, 3, 5, 6], "onli": [0, 1, 2, 6], "follow": [0, 1, 3, 4, 5, 6], "syntax": [0, 6], "storag": [0, 6], "local_nam": 0, "containerbaseabc": 0, "method": [0, 6], "implement": [0, 3, 5, 6], "containerdata": [0, 1, 3, 5, 6], "image_url_or_id": 0, "connect": [0, 3, 5, 6], "_container_runtim": 0, "function": [0, 1, 2, 3, 5, 6], "testinfra": [0, 3, 4, 5, 6], "data": [0, 6], "start": [0, 1, 2, 3], "expos": [0, 1, 3], "containerinspect": 0, "result": [0, 6], "ctr_id": 0, "containerlaunch": 0, "pathlib": 0, "container_nam": 0, "_expose_port": 0, "_new_port_forward": 0, "_container_id": 0, "_stack": 0, "contextlib": 0, "exitstack": 0, "_cidfil": 0, "setup": [0, 6], "teardown": 0, "includ": [0, 2, 5, 6], "resourc": 0, "container_data": 0, "correspond": 0, "valid": 0, "enter": 0, "statement": 0, "name": [0, 6], "pass": [0, 1, 6], "launch_contain": 0, "perform": 0, "actual": [0, 3, 5, 6], "heavi": 0, "lift": 0, "etc": [0, 3, 6], "pp": 0, "root": [0, 6], "pytest": [0, 1, 2, 4, 5, 6], "testsuit": 0, "persist": 0, "file": [0, 1, 3, 5], "outsid": 0, "ephemer": [0, 6], "volume_id": [0, 6], "automat": [0, 1, 3, 5, 6], "volumecr": 0, "containervolumebas": 0, "cli_arg": 0, "line": [0, 5, 6], "insid": [0, 3, 5], "where": [0, 5], "note": [0, 5, 6], "some": [0, 6], "mutual": 0, "exclus": 0, "potenti": 0, "support": [0, 1, 2, 4, 6], "selinux_priv": 0, "unless": 0, "between": [0, 6], "affect": [0, 6], "selinux": [0, 6], "containerfil": [0, 2, 5, 6], "image_format": [0, 2], "imageformat": 0, "add_build_tag": [0, 1], "dockerfil": [0, 1, 3, 5, 6], "differ": [0, 6], "an": [0, 3, 5, 6], "tag": [0, 1], "onc": [0, 2, 5, 6], "built": 0, "deriv": 0, "format": [0, 1, 2], "buildah": [0, 1, 2, 4], "oci": 0, "disabl": [0, 2], "detect": 0, "suppli": 0, "qualnam": 0, "boundari": 0, "choic": [0, 6], "how": [0, 1, 5], "pick": [0, 1, 6], "els": [0, 2], "2": [0, 3], "3": [0, 3, 4], "like": [0, 3, 6], "ociv1": [0, 2], "remov": [0, 1, 3, 6], "exit": [0, 5], "destroi": [0, 3, 6], "chown_us": 0, "u": [0, 6], "chown": 0, "content": [0, 5], "rootless": 0, "noexec": 0, "ensur": [0, 2, 5], "overlai": 0, "o": [0, 3], "f": [0, 6], "read_onli": [0, 6], "ro": 0, "read": 0, "read_writ": 0, "rw": 0, "write": 0, "z": [0, 6], "relabel": [0, 6], "singl": [0, 1, 5, 6], "access": [0, 4, 6], "selinux_shar": 0, "container_and_marks_from_pytest_param": [0, 1], "param": [0, 1], "tupl": 0, "liter": 0, "parameterset": 0, "collect": [0, 6], "markdecor": 0, "mark": [0, 1, 2, 3, 6], "extract": 0, "both": [0, 6], "second": [0, 2, 6], "container_from_pytest_param": [0, 1], "just": [0, 6], "container_to_pytest_param": 0, "convert": 0, "subclass": [0, 6], "pretti": 0, "print": [0, 1], "version": [0, 1, 3], "create_host_port_port_forward": 0, "port_forward": [0, 6], "find": [0, 1, 3], "random": 0, "free": [0, 1, 3], "system": [0, 3], "bound": 0, "new": [0, 1, 5], "appropri": 0, "get_volume_cr": 0, "creation": [0, 6], "same": [0, 1, 3, 6], "network": [0, 6], "caution": [0, 6], "individu": [0, 6], "taken": 0, "account": 0, "belong": 0, "poddata": [0, 6], "pod_id": [0, 6], "infra_container_id": 0, "pod_per_test": [0, 6], "each": [0, 5, 6], "infra": 0, "podlaunch": 0, "pod_nam": 0, "extra_pod_create_arg": 0, "_launcher": 0, "_pod_id": 0, "_infra_container_id": 0, "launch_pod": 0, "establish": 0, "pod_data": 0, "pod_from_pytest_param": 0, "git": 0, "repositori": 0, "gitrepositorybuild": 0, "multistag": 0, "multistagebuild": [0, 6], "repository_url": 0, "repository_tag": 0, "build_command": 0, "extern": 0, "requir": [0, 4, 6], "container_git_clon": 0, "host_git_clon": 0, "work": [0, 4, 5], "copi": [0, 3, 5], "left": 0, "empti": [0, 5], "purpos": 0, "clone_command": 0, "clone": 0, "repo_nam": 0, "check": [0, 1, 2, 3, 5, 6], "out": [0, 1, 5], "branch": 0, "end": [0, 6], "test_command": 0, "cd": 0, "correct": [0, 3, 6], "folder": 0, "containerfile_templ": 0, "multi": 0, "stage": 0, "essenti": 0, "veri": 0, "simpl": [0, 3, 5], "replac": 0, "For": [0, 3, 5, 6], "exampl": [0, 3, 5, 6], "builder": 0, "opensus": [0, 2, 3, 5, 6], "org": [0, 2, 3, 5, 6], "busybox": 0, "latest": [0, 2, 3], "runner1": 0, "io": [0, 3, 6], "alpin": 0, "r": [0, 6], "would": [0, 2, 6], "yield": 0, "object": [0, 3, 6], "retriev": 0, "render": 0, "id_of_runner1": 0, "multi_stage_build": [0, 6], "tmp_path": [0, 6], "pytestconfig": [0, 6], "child": 0, "further": 0, "see": 0, "rootdir_or_pytestconfig": 0, "config": [0, 6], "target": 0, "complet": [0, 2, 3], "written": 0, "suit": 0, "upstream": 0, "verif": 0, "prior": 0, "invalid": 0, "fail": [0, 1], "last": 0, "wa": [0, 1, 6], "templat": [0, 6], "dictionari": 0, "map": 0, "previou": 0, "wrap": 0, "prepare_build": 0, "static": 0, "run_build_step": 0, "beforehand": [0, 6], "final": 0, "dockerruntim": 0, "inspect_contain": 0, "pars": [0, 1], "output": [0, 1, 5], "supports_healthcheck_inherit_from_bas": 0, "inherit": 0, "instal": [0, 3, 4, 5], "ociruntimeabc": [0, 1], "interfac": [0, 1, 5], "get_container_health": [0, 2], "containerhealth": [0, 2], "health": [0, 2], "runner_binari": [0, 6], "_runtime_funct": 0, "get_image_id_from_iidfil": 0, "iidfile_path": 0, "iidfil": [0, 1], "get_image_s": 0, "image_or_id_or_contain": 0, "float": 0, "size": 0, "byte": 0, "py": [0, 5, 6], "podmanruntim": 0, "toparammixin": 0, "mixin": 0, "give": [0, 3], "abil": 0, "themselv": [0, 6], "__str__": 0, "to_pytest_param": 0, "major": 0, "int": 0, "0": [0, 3, 5, 6], "minor": 0, "patch": 0, "releas": [0, 3], "represent": 0, "form": 0, "basic": [0, 3, 6], "comparison": [0, 6], "5": 0, "6": [0, 4], "foobar": 0, "field": 0, "less": 0, "greater": 0, "equal": 0, "inequ": 0, "16": 0, "addition": [0, 4, 6], "asdf": 0, "version_str": 0, "construct": 0, "get_selected_runtim": [0, 6], "user": [0, 1, 2, 6], "present": [0, 3], "valueerror": 0, "rais": 0, "definit": 0, "repres": 0, "sourc": 0, "destin": 0, "tty": 0, "env": 0, "label": 0, "stop_sign": 0, "underli": 0, "signal": [0, 3], "sent": 0, "stop": [0, 3], "doe": [0, 1, 2, 6], "termin": 0, "sigkil": [0, 6], "afterward": [0, 5, 6], "attach": [0, 6], "possibl": [0, 2, 6], "state": 0, "no_health_check": 0, "did": 0, "yet": 0, "often": 0, "enough": 0, "unhealthi": [0, 2], "containerst": 0, "image_hash": 0, "containernetworkset": 0, "volumemount": 0, "common": 0, "subset": 0, "gener": 0, "mostli": 0, "digest": [0, 1], "program": 0, "containerinspecthealthcheck": 0, "load": 0, "json": 0, "img_id": 0, "jq": 0, "interv": 0, "retri": 0, "startperiod": 0, "statu": 0, "paus": 0, "restart": 0, "oom_kil": 0, "dead": 0, "pid": 0, "kill": 0, "Of": 0, "memori": 0, "condit": 0, "main": [0, 6], "start_period": 0, "30": 0, "from_container_inspect": 0, "inspect_json": 0, "ctr": 0, "everi": [0, 6], "max_wait_tim": 0, "maximum": [0, 1, 2], "wait": [0, 2, 3, 6], "until": 0, "startup": [0, 2], "period": 0, "dure": [0, 6], "failur": 0, "count": 0, "toward": 0, "consid": [0, 2], "unsuccess": 0, "networkprotocol": 0, "protocol": 0, "sock_const": 0, "socket": 0, "constant": 0, "sock_stream": 0, "sock_dgram": 0, "tcp": 0, "transmiss": 0, "control": 0, "udp": 0, "datagram": 0, "container_port": [0, 6], "host_port": [0, 1, 6], "bind_ip": [0, 1], "To": [0, 2, 6], "well": [0, 6], "my": [0, 5, 6], "webserv": 0, "8000": [0, 6], "ip": [0, 1], "address": [0, 1], "shall": [0, 6], "forward_cli_arg": 0, "container_": [0, 1, 6], "modifi": 0, "driver": 0, "back": 0, "variou": 0, "auto_contain": [0, 5, 6], "add_extra_run_and_build_args_opt": [0, 6], "parser": [0, 6], "add": [0, 1, 5, 6], "extra": [0, 6], "get_extra_run_arg": 0, "get_extra_build_arg": [0, 6], "get_extra_pod_create_arg": 0, "respect": [0, 6], "add_logging_level_opt": [0, 6], "level": [0, 1, 6], "call": [0, 5, 6], "conftest": [0, 5, 6], "pytest_addopt": [0, 6], "set_logging_level_from_cli_arg": [0, 6], "auto_container_parametr": [0, 1, 5], "metafunc": [0, 5], "auto_container_": 0, "code": [0, 1, 5], "snippet": [0, 5, 6], "import": [0, 5, 6], "def": [0, 2, 3, 5, 6], "pytest_generate_test": [0, 5], "get": [0, 1, 3], "bud": 0, "were": [0, 6], "cli": [0, 1, 6], "intern": [0, 1, 6], "befor": [0, 2, 3, 6], "execut": [0, 3, 5, 6], "good": 0, "place": 0, "pytest_configur": [0, 6], "hook": [0, 6], "request": [0, 6], "subrequest": 0, "container_imag": [0, 5], "reus": 0, "session": 0, "auto_container_per_test": [0, 5, 6], "expect": [0, 5], "indirect": [0, 2, 3, 6], "container_per_test": [0, 6], "accord": 0, "rule": 0, "outlin": 0, "here": [0, 6], "skip": [0, 6], "except": 0, "handl": [0, 3], "everyth": [0, 3], "relat": 0, "unsurprisingli": 0, "set_internal_logging_level": [0, 6], "20": [0, 3], "verbos": 0, "logger": 0, "break": 1, "chang": [1, 6], "deprec": 1, "pleas": [1, 6], "longer": [1, 6], "recurs": 1, "immedi": 1, "improv": 1, "featur": 1, "arbitrari": 1, "fix": 1, "being": [1, 6], "document": [1, 3], "get_image_id_from_stdout": 1, "buildx": 1, "stdout": [1, 5, 6], "invok": 1, "build": [1, 2, 3], "contain": [1, 2, 4, 5], "cidfil": 1, "log": [1, 3], "runtim": [1, 2, 3, 4], "python": [1, 4, 5, 6], "framework": 1, "easier": 1, "debug": [1, 6], "25": 1, "later": [1, 4], "11": 1, "even": 1, "due": 1, "readm": 1, "rst": 1, "There": [1, 2, 5], "compar": 1, "healtcheck_timeout_m": 1, "got": 1, "renam": 1, "now": [1, 5, 6], "impli": 1, "figur": 1, "itself": [1, 3], "posit": 1, "neg": [1, 2], "appli": [1, 6], "consequ": 1, "default_entry_point": 1, "get_container_healthcheck": 1, "inspect": [1, 3], "The": [1, 2, 3, 4, 5, 6], "cleanup": 1, "allow": [1, 3, 5, 6], "pod": [1, 3], "thei": [1, 4, 5, 6], "want": [1, 6], "publish": 1, "let": 1, "them": [1, 6], "multipl": [1, 3, 5, 6], "parallel": [1, 3, 5, 6], "without": [1, 6], "datastructur": 1, "helper": [1, 3], "tutori": [1, 3], "public": 1, "privat": 1, "modul": [1, 3, 4, 6], "switch": 1, "tox": [1, 4], "nox": 1, "poetri": [1, 5], "typeguard": 1, "hint": 1, "make": [1, 2, 6], "readabl": 1, "robust": 1, "treat": [1, 2], "unresolv": 1, "error": [1, 6], "enabl": 1, "intersphinx": 1, "better": 1, "messag": [1, 6], "determin": 2, "own": [2, 6], "principl": 2, "noth": 2, "do": 2, "come": 2, "certain": [2, 6], "sens": [2, 6], "explicitli": 2, "had": 2, "container_with_healthcheck": 2, "leap": 2, "don": 2, "t": [2, 5], "test_leap": 2, "assert": [2, 3, 5, 6], "small": 2, "catch": [2, 6], "while": [2, 6], "dcermak": 3, "github": 3, "plugin": [3, 6], "take": 3, "care": 3, "bore": 3, "task": [3, 5], "spin": 3, "up": 3, "clean": [3, 6], "focu": 3, "autom": 3, "through": 3, "xdist": [3, 5, 6], "depend": [3, 5, 6], "order": 3, "mani": 3, "four": 3, "instanti": 3, "tw": 3, "tumblewe": [3, 5, 6], "test_etc_os_release_pres": 3, "receiv": [3, 5, 6], "packag": 3, "oper": 3, "verifi": 3, "softwar": 3, "prerequisit": 3, "usag": 3, "tip": 3, "global": [3, 5], "changelog": 3, "next": 3, "26": 3, "septemb": 3, "2023": 3, "devconf": 3, "cz": 3, "edit": 3, "14": 3, "june": 3, "21": 3, "march": 3, "01": 3, "februari": 3, "2022": 3, "api": 3, "index": [3, 6], "search": [3, 5], "page": 3, "ll": 4, "dataclass": 4, "leverag": 4, "have": [4, 5, 6], "ones": 4, "keep": [4, 5], "mind": 4, "put": 4, "passenv": 4, "demonstr": 5, "project": 5, "pyproject": 5, "toml": 5, "doesn": 5, "alreadi": 5, "init": 5, "develop": 5, "group": 5, "dev": 5, "recommend": [5, 6], "thing": 5, "tidi": 5, "__init__": 5, "abov": [5, 6], "correctli": [5, 6], "we": [5, 6], "smoke": 5, "wheel": 5, "our": 5, "util": 5, "pip": 5, "zypper": [5, 6], "n": [5, 6], "python3": [5, 6], "dist": 5, "whl": 5, "plug": 5, "textwrap": 5, "dedent": 5, "tw_with_pkg": 5, "test_cli": 5, "along": 5, "test_help_work": 5, "re": [5, 6], "run_expect": [5, 6], "binari": [5, 6], "help": 5, "cool": 5, "instruct": [5, 6], "thu": 5, "avoid": 5, "manual": [5, 6], "standard": 5, "sometim": 6, "rather": 6, "cumbersom": 6, "practic": 6, "therefor": 6, "alongsid": 6, "invoc": 6, "Then": 6, "cach": 6, "shown": 6, "wish": 6, "test_multistag": 6, "test_data": 6, "test_multistage_build": 6, "happen": 6, "prefer": 6, "accomplish": 6, "against": 6, "remot": 6, "inspir": 6, "skopeo": 6, "wai": 6, "other": 6, "skipif": 6, "4": 6, "reason": 6, "least": 6, "test_modern_podman_featur": 6, "new_featur": 6, "script": 6, "integr": 6, "achiev": 6, "desir": 6, "nowadai": 6, "http": 6, "phoenixnap": 6, "com": 6, "kb": 6, "v": 6, "dir": 6, "testfil": 6, "cdir": 6, "container1": 6, "some_base_imag": 6, "test_my_script": 6, "cp": 6, "contrast": 6, "first": 6, "disadvantag": 6, "cannot": 6, "howev": 6, "dynam": 6, "easili": 6, "approach": 6, "successfulli": 6, "undertak": 6, "step": 6, "_container_per_test": 6, "obtain": 6, "could": 6, "locat": 6, "restrict": 6, "tricki": 6, "topic": 6, "remedi": 6, "web_serv": 6, "snip": 6, "test_port_forward_set_up": 6, "curl": 6, "localhost": 6, "strip": 6, "quickli": 6, "caus": 6, "problem": 6, "concurr": 6, "pose": 6, "challeng": 6, "leav": 6, "strai": 6, "runner": 6, "offer": 6, "conveni": 6, "finish": 6, "newli": 6, "caveat": 6, "abl": 6, "suffici": 6, "director": 6, "similarli": 6, "permit": 6, "try": 6, "illustr": 6, "nginx": 6, "librari": 6, "80": 6, "conf": 6, "var": 6, "check_nginx_cach": 6, "cache_on_host": 6, "var_log": 6, "nginx_proxi": 6, "echo": 6, "server": 6, "listen": 6, "server_nam": 6, "proxy_pass": 6, "hello": 6, "green": 6, "world": 6, "html": 6, "usr": 6, "m": 6, "proxy_pod": 6, "test_proxy_pod": 6, "port_80_on_host": 6, "behavior": 6, "forc": 6, "stopsign": 6, "non": 6, "shell": 6, "might": 6, "react": 6, "eventu": 6, "resort": 6, "send": 6, "But": 6, "slow": 6, "needlessli": 6, "down": 6, "10": 6, "sigterm": 6}, "objects": {"pytest_container": [[0, 0, 0, "-", "build"], [0, 0, 0, "-", "container"], [0, 0, 0, "-", "helpers"], [0, 0, 0, "-", "inspect"], [0, 0, 0, "-", "logging"], [0, 0, 0, "-", "plugin"], [0, 0, 0, "-", "pod"], [0, 0, 0, "-", "runtime"]], "pytest_container.build": [[0, 1, 1, "", "GitRepositoryBuild"], [0, 1, 1, "", "MultiStageBuild"]], "pytest_container.build.GitRepositoryBuild": [[0, 2, 1, "", "build_command"], [0, 3, 1, "", "clone_command"], [0, 3, 1, "", "repo_name"], [0, 2, 1, "", "repository_tag"], [0, 2, 1, "", "repository_url"], [0, 3, 1, "", "test_command"]], "pytest_container.build.MultiStageBuild": [[0, 4, 1, "", "build"], [0, 3, 1, "", "containerfile"], [0, 2, 1, "", "containerfile_template"], [0, 2, 1, "", "containers"], [0, 4, 1, "", "prepare_build"], [0, 4, 1, "", "run_build_step"]], "pytest_container.container": [[0, 1, 1, "", "BindMount"], [0, 1, 1, "", "BindMountCreator"], [0, 1, 1, "", "Container"], [0, 1, 1, "", "ContainerBase"], [0, 1, 1, "", "ContainerBaseABC"], [0, 1, 1, "", "ContainerData"], [0, 1, 1, "", "ContainerLauncher"], [0, 1, 1, "", "ContainerVolume"], [0, 1, 1, "", "ContainerVolumeBase"], [0, 1, 1, "", "DerivedContainer"], [0, 1, 1, "", "EntrypointSelection"], [0, 1, 1, "", "ImageFormat"], [0, 1, 1, "", "VolumeCreator"], [0, 1, 1, "", "VolumeFlag"], [0, 5, 1, "", "container_and_marks_from_pytest_param"], [0, 5, 1, "", "container_from_pytest_param"], [0, 5, 1, "", "container_to_pytest_param"], [0, 5, 1, "", "create_host_port_port_forward"], [0, 5, 1, "", "get_volume_creator"]], "pytest_container.container.BindMount": [[0, 2, 1, "", "host_path"]], "pytest_container.container.BindMountCreator": [[0, 2, 1, "", "volume"]], "pytest_container.container.Container": [[0, 3, 1, "", "baseurl"], [0, 4, 1, "", "get_base"], [0, 4, 1, "", "prepare_container"], [0, 4, 1, "", "pull_container"]], "pytest_container.container.ContainerBase": [[0, 2, 1, "", "container_id"], [0, 2, 1, "", "custom_entry_point"], [0, 2, 1, "", "entry_point"], [0, 2, 1, "", "extra_environment_variables"], [0, 2, 1, "", "extra_launch_args"], [0, 3, 1, "", "filelock_filename"], [0, 2, 1, "", "forwarded_ports"], [0, 4, 1, "", "get_launch_cmd"], [0, 2, 1, "", "healthcheck_timeout"], [0, 3, 1, "", "local_image"], [0, 2, 1, "", "singleton"], [0, 2, 1, "", "url"], [0, 2, 1, "", "volume_mounts"]], "pytest_container.container.ContainerBaseABC": [[0, 3, 1, "", "baseurl"], [0, 4, 1, "", "get_base"], [0, 4, 1, "", "prepare_container"]], "pytest_container.container.ContainerData": [[0, 2, 1, "", "connection"], [0, 2, 1, "", "container"], [0, 2, 1, "", "container_id"], [0, 2, 1, "", "forwarded_ports"], [0, 2, 1, "", "image_url_or_id"], [0, 3, 1, "", "inspect"]], "pytest_container.container.ContainerLauncher": [[0, 2, 1, "", "container"], [0, 3, 1, "", "container_data"], [0, 2, 1, "", "container_name"], [0, 2, 1, "", "container_runtime"], [0, 2, 1, "", "extra_build_args"], [0, 2, 1, "", "extra_run_args"], [0, 4, 1, "", "launch_container"], [0, 2, 1, "", "rootdir"]], "pytest_container.container.ContainerVolume": [[0, 3, 1, "", "volume_id"]], "pytest_container.container.ContainerVolumeBase": [[0, 3, 1, "", "cli_arg"], [0, 2, 1, "", "container_path"], [0, 2, 1, "", "flags"], [0, 2, 1, "", "shared"]], "pytest_container.container.DerivedContainer": [[0, 2, 1, "", "add_build_tags"], [0, 2, 1, "", "base"], [0, 3, 1, "", "baseurl"], [0, 2, 1, "", "containerfile"], [0, 4, 1, "", "get_base"], [0, 2, 1, "", "image_format"], [0, 4, 1, "", "prepare_container"]], "pytest_container.container.EntrypointSelection": [[0, 2, 1, "", "AUTO"], [0, 2, 1, "", "BASH"], [0, 2, 1, "", "IMAGE"]], "pytest_container.container.ImageFormat": [[0, 2, 1, "", "DOCKER"], [0, 2, 1, "", "OCIv1"]], "pytest_container.container.VolumeCreator": [[0, 2, 1, "", "container_runtime"], [0, 2, 1, "", "volume"]], "pytest_container.container.VolumeFlag": [[0, 2, 1, "", "CHOWN_USER"], [0, 2, 1, "", "NOEXEC"], [0, 2, 1, "", "OVERLAY"], [0, 2, 1, "", "READ_ONLY"], [0, 2, 1, "", "READ_WRITE"], [0, 2, 1, "", "SELINUX_PRIVATE"], [0, 2, 1, "", "SELINUX_SHARED"]], "pytest_container.helpers": [[0, 5, 1, "", "add_extra_run_and_build_args_options"], [0, 5, 1, "", "add_logging_level_options"], [0, 5, 1, "", "auto_container_parametrize"], [0, 5, 1, "", "get_extra_build_args"], [0, 5, 1, "", "get_extra_pod_create_args"], [0, 5, 1, "", "get_extra_run_args"], [0, 5, 1, "", "set_logging_level_from_cli_args"]], "pytest_container.inspect": [[0, 1, 1, "", "BindMount"], [0, 1, 1, "", "Config"], [0, 1, 1, "", "ContainerHealth"], [0, 1, 1, "", "ContainerInspect"], [0, 1, 1, "", "ContainerInspectHealthCheck"], [0, 1, 1, "", "ContainerNetworkSettings"], [0, 1, 1, "", "ContainerState"], [0, 1, 1, "", "HealthCheck"], [0, 1, 1, "", "Mount"], [0, 1, 1, "", "NetworkProtocol"], [0, 1, 1, "", "PortForwarding"], [0, 1, 1, "", "VolumeMount"]], "pytest_container.inspect.Config": [[0, 2, 1, "", "cmd"], [0, 2, 1, "", "entrypoint"], [0, 2, 1, "", "env"], [0, 2, 1, "", "healthcheck"], [0, 2, 1, "", "image"], [0, 2, 1, "", "labels"], [0, 2, 1, "", "stop_signal"], [0, 2, 1, "", "tty"], [0, 2, 1, "", "user"]], "pytest_container.inspect.ContainerHealth": [[0, 2, 1, "", "HEALTHY"], [0, 2, 1, "", "NO_HEALTH_CHECK"], [0, 2, 1, "", "STARTING"], [0, 2, 1, "", "UNHEALTHY"]], "pytest_container.inspect.ContainerInspect": [[0, 2, 1, "", "args"], [0, 2, 1, "", "config"], [0, 2, 1, "", "id"], [0, 2, 1, "", "image_hash"], [0, 2, 1, "", "mounts"], [0, 2, 1, "", "network"], [0, 2, 1, "", "path"], [0, 2, 1, "", "state"]], "pytest_container.inspect.ContainerInspectHealthCheck": [[0, 2, 1, "", "Interval"], [0, 2, 1, "", "Retries"], [0, 2, 1, "", "StartPeriod"], [0, 2, 1, "", "Test"], [0, 2, 1, "", "Timeout"]], "pytest_container.inspect.ContainerNetworkSettings": [[0, 2, 1, "", "ports"]], "pytest_container.inspect.ContainerState": [[0, 2, 1, "", "dead"], [0, 2, 1, "", "health"], [0, 2, 1, "", "oom_killed"], [0, 2, 1, "", "paused"], [0, 2, 1, "", "pid"], [0, 2, 1, "", "restarting"], [0, 2, 1, "", "running"], [0, 2, 1, "", "status"]], "pytest_container.inspect.HealthCheck": [[0, 4, 1, "", "from_container_inspect"], [0, 2, 1, "", "interval"], [0, 3, 1, "", "max_wait_time"], [0, 2, 1, "", "retries"], [0, 2, 1, "", "start_period"], [0, 2, 1, "", "timeout"]], "pytest_container.inspect.Mount": [[0, 2, 1, "", "destination"], [0, 2, 1, "", "rw"], [0, 2, 1, "", "source"]], "pytest_container.inspect.NetworkProtocol": [[0, 3, 1, "", "SOCK_CONST"], [0, 2, 1, "", "TCP"], [0, 2, 1, "", "UDP"]], "pytest_container.inspect.PortForwarding": [[0, 2, 1, "", "bind_ip"], [0, 2, 1, "", "container_port"], [0, 3, 1, "", "forward_cli_args"], [0, 2, 1, "", "host_port"], [0, 2, 1, "", "protocol"]], "pytest_container.inspect.VolumeMount": [[0, 2, 1, "", "driver"], [0, 2, 1, "", "name"]], "pytest_container.logging": [[0, 5, 1, "", "set_internal_logging_level"]], "pytest_container.plugin": [[0, 5, 1, "", "auto_container"], [0, 5, 1, "", "auto_container_per_test"], [0, 5, 1, "", "container"], [0, 5, 1, "", "container_per_test"], [0, 5, 1, "", "container_runtime"], [0, 5, 1, "", "pod"], [0, 5, 1, "", "pod_per_test"]], "pytest_container.pod": [[0, 1, 1, "", "Pod"], [0, 1, 1, "", "PodData"], [0, 1, 1, "", "PodLauncher"], [0, 5, 1, "", "pod_from_pytest_param"]], "pytest_container.pod.Pod": [[0, 2, 1, "", "containers"], [0, 2, 1, "", "forwarded_ports"]], "pytest_container.pod.PodData": [[0, 2, 1, "", "container_data"], [0, 2, 1, "", "forwarded_ports"], [0, 2, 1, "", "infra_container_id"], [0, 2, 1, "", "pod"], [0, 2, 1, "", "pod_id"]], "pytest_container.pod.PodLauncher": [[0, 2, 1, "", "extra_build_args"], [0, 2, 1, "", "extra_pod_create_args"], [0, 2, 1, "", "extra_run_args"], [0, 4, 1, "", "launch_pod"], [0, 2, 1, "", "pod"], [0, 3, 1, "", "pod_data"], [0, 2, 1, "", "pod_name"], [0, 2, 1, "", "rootdir"]], "pytest_container.runtime": [[0, 1, 1, "", "DockerRuntime"], [0, 1, 1, "", "OciRuntimeABC"], [0, 1, 1, "", "OciRuntimeBase"], [0, 1, 1, "", "PodmanRuntime"], [0, 1, 1, "", "ToParamMixin"], [0, 1, 1, "", "Version"], [0, 5, 1, "", "get_selected_runtime"]], "pytest_container.runtime.DockerRuntime": [[0, 4, 1, "", "inspect_container"], [0, 3, 1, "", "supports_healthcheck_inherit_from_base"], [0, 3, 1, "", "version"]], "pytest_container.runtime.OciRuntimeABC": [[0, 4, 1, "", "get_container_health"], [0, 4, 1, "", "inspect_container"], [0, 3, 1, "", "supports_healthcheck_inherit_from_base"], [0, 3, 1, "", "version"]], "pytest_container.runtime.OciRuntimeBase": [[0, 4, 1, "", "get_image_id_from_iidfile"], [0, 4, 1, "", "get_image_size"]], "pytest_container.runtime.PodmanRuntime": [[0, 4, 1, "", "inspect_container"], [0, 3, 1, "", "supports_healthcheck_inherit_from_base"], [0, 3, 1, "", "version"]], "pytest_container.runtime.ToParamMixin": [[0, 2, 1, "", "marks"], [0, 4, 1, "", "to_pytest_param"]], "pytest_container.runtime.Version": [[0, 2, 1, "", "build"], [0, 2, 1, "", "major"], [0, 2, 1, "", "minor"], [0, 4, 1, "", "parse"], [0, 2, 1, "", "patch"], [0, 2, 1, "", "release"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:attribute", "3": "py:property", "4": "py:method", "5": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "property", "Python property"], "4": ["py", "method", "Python method"], "5": ["py", "function", "Python function"]}, "titleterms": {"api": 0, "document": 0, "The": 0, "contain": [0, 3, 6], "modul": 0, "pod": [0, 6], "build": [0, 6], "runtim": [0, 6], "inspect": 0, "helper": 0, "plugin": 0, "log": [0, 6], "changelog": 1, "next": 1, "releas": 1, "0": 1, "3": 1, "26": 1, "septemb": 1, "2023": 1, "2": [1, 6], "devconf": 1, "cz": 1, "edit": 1, "14": 1, "june": 1, "1": [1, 6], "21": 1, "march": 1, "20": 1, "01": 1, "februari": 1, "2022": 1, "fixtur": 2, "handl": [2, 6], "healthcheck": 2, "pytest": 3, "us": 3, "case": 3, "content": 3, "indic": 3, "tabl": 3, "prerequisit": 4, "tutori": 5, "get": 5, "start": 5, "pytest_contain": 5, "usag": 6, "tip": 6, "ad": 6, "global": 6, "run": 6, "creat": 6, "argument": 6, "configur": 6, "test": 6, "local": 6, "imag": 6, "version": 6, "copi": 6, "file": 6, "time": 6, "expos": 6, "port": 6, "from": 6, "set": 6, "up": 6, "bind": 6, "mount": 6, "volum": 6, "manag": 6, "entrypoint": 6, "stop": 6, "signal": 6}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx": 57}, "alltitles": {"API documentation": [[0, "api-documentation"]], "The container module": [[0, "module-pytest_container.container"]], "The pod module": [[0, "module-pytest_container.pod"]], "The build module": [[0, "module-pytest_container.build"]], "The runtime module": [[0, "module-pytest_container.runtime"]], "The inspect module": [[0, "module-pytest_container.inspect"]], "The helpers module": [[0, "module-pytest_container.helpers"]], "The plugin module": [[0, "module-pytest_container.plugin"]], "The logging module": [[0, "module-pytest_container.logging"]], "Changelog": [[1, "changelog"]], "Next Release": [[1, "next-release"]], "0.3.0 (26 September 2023)": [[1, "september-2023"]], "0.2.0 - DevConf.cz edition (14 June 2023)": [[1, "devconf-cz-edition-14-june-2023"]], "0.1.1 (21 March 2023)": [[1, "march-2023"]], "0.1.0 (20 March 2023)": [[1, "id1"]], "0.0.2 (01 February 2022)": [[1, "february-2022"]], "Fixtures": [[2, "fixtures"]], "Handling Healthcheck": [[2, "handling-healthcheck"]], "Pytest container": [[3, "pytest-container"]], "Use cases": [[3, "use-cases"]], "Contents": [[3, "contents"]], "Indices and tables": [[3, "indices-and-tables"]], "Prerequisites": [[4, "prerequisites"]], "Tutorials": [[5, "tutorials"]], "Getting started with pytest_container": [[5, "getting-started-with-pytest-container"]], "Usage Tips": [[6, "usage-tips"]], "Adding global build, run or pod create arguments": [[6, "adding-global-build-run-or-pod-create-arguments"]], "Configuring logging": [[6, "configuring-logging"]], "Testing local images": [[6, "testing-local-images"]], "Container Runtime version": [[6, "container-runtime-version"]], "Copying files into containers": [[6, "copying-files-into-containers"]], "1. Copy the files at build time": [[6, "copy-the-files-at-build-time"]], "2. Copy the files at runtime into the running container": [[6, "copy-the-files-at-runtime-into-the-running-container"]], "Exposing ports from containers": [[6, "exposing-ports-from-containers"]], "Setting up bind mounts or container volumes": [[6, "setting-up-bind-mounts-or-container-volumes"]], "Create and manage pods": [[6, "create-and-manage-pods"]], "Entrypoint and stop signal handling": [[6, "entrypoint-and-stop-signal-handling"]]}, "indexentries": {"auto (pytest_container.container.entrypointselection attribute)": [[0, "pytest_container.container.EntrypointSelection.AUTO"]], "bash (pytest_container.container.entrypointselection attribute)": [[0, "pytest_container.container.EntrypointSelection.BASH"]], "bindmount (class in pytest_container.container)": [[0, "pytest_container.container.BindMount"]], "bindmount (class in pytest_container.inspect)": [[0, "pytest_container.inspect.BindMount"]], "bindmountcreator (class in pytest_container.container)": [[0, "pytest_container.container.BindMountCreator"]], "chown_user (pytest_container.container.volumeflag attribute)": [[0, "pytest_container.container.VolumeFlag.CHOWN_USER"]], "config (class in pytest_container.inspect)": [[0, "pytest_container.inspect.Config"]], "container (class in pytest_container.container)": [[0, "pytest_container.container.Container"]], "containerbase (class in pytest_container.container)": [[0, "pytest_container.container.ContainerBase"]], "containerbaseabc (class in pytest_container.container)": [[0, "pytest_container.container.ContainerBaseABC"]], "containerdata (class in pytest_container.container)": [[0, "pytest_container.container.ContainerData"]], "containerhealth (class in pytest_container.inspect)": [[0, "pytest_container.inspect.ContainerHealth"]], "containerinspect (class in pytest_container.inspect)": [[0, "pytest_container.inspect.ContainerInspect"]], "containerinspecthealthcheck (class in pytest_container.inspect)": [[0, "pytest_container.inspect.ContainerInspectHealthCheck"]], "containerlauncher (class in pytest_container.container)": [[0, "pytest_container.container.ContainerLauncher"]], "containernetworksettings (class in pytest_container.inspect)": [[0, "pytest_container.inspect.ContainerNetworkSettings"]], "containerstate (class in pytest_container.inspect)": [[0, "pytest_container.inspect.ContainerState"]], "containervolume (class in pytest_container.container)": [[0, "pytest_container.container.ContainerVolume"]], "containervolumebase (class in pytest_container.container)": [[0, "pytest_container.container.ContainerVolumeBase"]], "docker (pytest_container.container.imageformat attribute)": [[0, "pytest_container.container.ImageFormat.DOCKER"]], "derivedcontainer (class in pytest_container.container)": [[0, "pytest_container.container.DerivedContainer"]], "dockerruntime (class in pytest_container.runtime)": [[0, "pytest_container.runtime.DockerRuntime"]], "entrypointselection (class in pytest_container.container)": [[0, "pytest_container.container.EntrypointSelection"]], "gitrepositorybuild (class in pytest_container.build)": [[0, "pytest_container.build.GitRepositoryBuild"]], "healthy (pytest_container.inspect.containerhealth attribute)": [[0, "pytest_container.inspect.ContainerHealth.HEALTHY"]], "healthcheck (class in pytest_container.inspect)": [[0, "pytest_container.inspect.HealthCheck"]], "image (pytest_container.container.entrypointselection attribute)": [[0, "pytest_container.container.EntrypointSelection.IMAGE"]], "imageformat (class in pytest_container.container)": [[0, "pytest_container.container.ImageFormat"]], "interval (pytest_container.inspect.containerinspecthealthcheck attribute)": [[0, "pytest_container.inspect.ContainerInspectHealthCheck.Interval"]], "mount (class in pytest_container.inspect)": [[0, "pytest_container.inspect.Mount"]], "multistagebuild (class in pytest_container.build)": [[0, "pytest_container.build.MultiStageBuild"]], "noexec (pytest_container.container.volumeflag attribute)": [[0, "pytest_container.container.VolumeFlag.NOEXEC"]], "no_health_check (pytest_container.inspect.containerhealth attribute)": [[0, "pytest_container.inspect.ContainerHealth.NO_HEALTH_CHECK"]], "networkprotocol (class in pytest_container.inspect)": [[0, "pytest_container.inspect.NetworkProtocol"]], "ociv1 (pytest_container.container.imageformat attribute)": [[0, "pytest_container.container.ImageFormat.OCIv1"]], "overlay (pytest_container.container.volumeflag attribute)": [[0, "pytest_container.container.VolumeFlag.OVERLAY"]], "ociruntimeabc (class in pytest_container.runtime)": [[0, "pytest_container.runtime.OciRuntimeABC"]], "ociruntimebase (class in pytest_container.runtime)": [[0, "pytest_container.runtime.OciRuntimeBase"]], "pod (class in pytest_container.pod)": [[0, "pytest_container.pod.Pod"]], "poddata (class in pytest_container.pod)": [[0, "pytest_container.pod.PodData"]], "podlauncher (class in pytest_container.pod)": [[0, "pytest_container.pod.PodLauncher"]], "podmanruntime (class in pytest_container.runtime)": [[0, "pytest_container.runtime.PodmanRuntime"]], "portforwarding (class in pytest_container.inspect)": [[0, "pytest_container.inspect.PortForwarding"]], "read_only (pytest_container.container.volumeflag attribute)": [[0, "pytest_container.container.VolumeFlag.READ_ONLY"]], "read_write (pytest_container.container.volumeflag attribute)": [[0, "pytest_container.container.VolumeFlag.READ_WRITE"]], "retries (pytest_container.inspect.containerinspecthealthcheck attribute)": [[0, "pytest_container.inspect.ContainerInspectHealthCheck.Retries"]], "selinux_private (pytest_container.container.volumeflag attribute)": [[0, "pytest_container.container.VolumeFlag.SELINUX_PRIVATE"]], "selinux_shared (pytest_container.container.volumeflag attribute)": [[0, "pytest_container.container.VolumeFlag.SELINUX_SHARED"]], "sock_const (pytest_container.inspect.networkprotocol property)": [[0, "pytest_container.inspect.NetworkProtocol.SOCK_CONST"]], "starting (pytest_container.inspect.containerhealth attribute)": [[0, "pytest_container.inspect.ContainerHealth.STARTING"]], "startperiod (pytest_container.inspect.containerinspecthealthcheck attribute)": [[0, "pytest_container.inspect.ContainerInspectHealthCheck.StartPeriod"]], "tcp (pytest_container.inspect.networkprotocol attribute)": [[0, "pytest_container.inspect.NetworkProtocol.TCP"]], "test (pytest_container.inspect.containerinspecthealthcheck attribute)": [[0, "pytest_container.inspect.ContainerInspectHealthCheck.Test"]], "timeout (pytest_container.inspect.containerinspecthealthcheck attribute)": [[0, "pytest_container.inspect.ContainerInspectHealthCheck.Timeout"]], "toparammixin (class in pytest_container.runtime)": [[0, "pytest_container.runtime.ToParamMixin"]], "udp (pytest_container.inspect.networkprotocol attribute)": [[0, "pytest_container.inspect.NetworkProtocol.UDP"]], "unhealthy (pytest_container.inspect.containerhealth attribute)": [[0, "pytest_container.inspect.ContainerHealth.UNHEALTHY"]], "version (class in pytest_container.runtime)": [[0, "pytest_container.runtime.Version"]], "volumecreator (class in pytest_container.container)": [[0, "pytest_container.container.VolumeCreator"]], "volumeflag (class in pytest_container.container)": [[0, "pytest_container.container.VolumeFlag"]], "volumemount (class in pytest_container.inspect)": [[0, "pytest_container.inspect.VolumeMount"]], "add_build_tags (pytest_container.container.derivedcontainer attribute)": [[0, "pytest_container.container.DerivedContainer.add_build_tags"]], "add_extra_run_and_build_args_options() (in module pytest_container.helpers)": [[0, "pytest_container.helpers.add_extra_run_and_build_args_options"]], "add_logging_level_options() (in module pytest_container.helpers)": [[0, "pytest_container.helpers.add_logging_level_options"]], "args (pytest_container.inspect.containerinspect attribute)": [[0, "pytest_container.inspect.ContainerInspect.args"]], "auto_container() (in module pytest_container.plugin)": [[0, "pytest_container.plugin.auto_container"]], "auto_container_parametrize() (in module pytest_container.helpers)": [[0, "pytest_container.helpers.auto_container_parametrize"]], "auto_container_per_test() (in module pytest_container.plugin)": [[0, "pytest_container.plugin.auto_container_per_test"]], "base (pytest_container.container.derivedcontainer attribute)": [[0, "pytest_container.container.DerivedContainer.base"]], "baseurl (pytest_container.container.container property)": [[0, "pytest_container.container.Container.baseurl"]], "baseurl (pytest_container.container.containerbaseabc property)": [[0, "pytest_container.container.ContainerBaseABC.baseurl"]], "baseurl (pytest_container.container.derivedcontainer property)": [[0, "pytest_container.container.DerivedContainer.baseurl"]], "bind_ip (pytest_container.inspect.portforwarding attribute)": [[0, "pytest_container.inspect.PortForwarding.bind_ip"]], "build (pytest_container.runtime.version attribute)": [[0, "pytest_container.runtime.Version.build"]], "build() (pytest_container.build.multistagebuild method)": [[0, "pytest_container.build.MultiStageBuild.build"]], "build_command (pytest_container.build.gitrepositorybuild attribute)": [[0, "pytest_container.build.GitRepositoryBuild.build_command"]], "cli_arg (pytest_container.container.containervolumebase property)": [[0, "pytest_container.container.ContainerVolumeBase.cli_arg"]], "clone_command (pytest_container.build.gitrepositorybuild property)": [[0, "pytest_container.build.GitRepositoryBuild.clone_command"]], "cmd (pytest_container.inspect.config attribute)": [[0, "pytest_container.inspect.Config.cmd"]], "config (pytest_container.inspect.containerinspect attribute)": [[0, "pytest_container.inspect.ContainerInspect.config"]], "connection (pytest_container.container.containerdata attribute)": [[0, "pytest_container.container.ContainerData.connection"]], "container (pytest_container.container.containerdata attribute)": [[0, "pytest_container.container.ContainerData.container"]], "container (pytest_container.container.containerlauncher attribute)": [[0, "pytest_container.container.ContainerLauncher.container"]], "container() (in module pytest_container.plugin)": [[0, "pytest_container.plugin.container"]], "container_and_marks_from_pytest_param() (in module pytest_container.container)": [[0, "pytest_container.container.container_and_marks_from_pytest_param"]], "container_data (pytest_container.container.containerlauncher property)": [[0, "pytest_container.container.ContainerLauncher.container_data"]], "container_data (pytest_container.pod.poddata attribute)": [[0, "pytest_container.pod.PodData.container_data"]], "container_from_pytest_param() (in module pytest_container.container)": [[0, "pytest_container.container.container_from_pytest_param"]], "container_id (pytest_container.container.containerbase attribute)": [[0, "pytest_container.container.ContainerBase.container_id"]], "container_id (pytest_container.container.containerdata attribute)": [[0, "pytest_container.container.ContainerData.container_id"]], "container_name (pytest_container.container.containerlauncher attribute)": [[0, "pytest_container.container.ContainerLauncher.container_name"]], "container_path (pytest_container.container.containervolumebase attribute)": [[0, "pytest_container.container.ContainerVolumeBase.container_path"]], "container_per_test() (in module pytest_container.plugin)": [[0, "pytest_container.plugin.container_per_test"]], "container_port (pytest_container.inspect.portforwarding attribute)": [[0, "pytest_container.inspect.PortForwarding.container_port"]], "container_runtime (pytest_container.container.containerlauncher attribute)": [[0, "pytest_container.container.ContainerLauncher.container_runtime"]], "container_runtime (pytest_container.container.volumecreator attribute)": [[0, "pytest_container.container.VolumeCreator.container_runtime"]], "container_runtime() (in module pytest_container.plugin)": [[0, "pytest_container.plugin.container_runtime"]], "container_to_pytest_param() (in module pytest_container.container)": [[0, "pytest_container.container.container_to_pytest_param"]], "containerfile (pytest_container.build.multistagebuild property)": [[0, "pytest_container.build.MultiStageBuild.containerfile"]], "containerfile (pytest_container.container.derivedcontainer attribute)": [[0, "pytest_container.container.DerivedContainer.containerfile"]], "containerfile_template (pytest_container.build.multistagebuild attribute)": [[0, "pytest_container.build.MultiStageBuild.containerfile_template"]], "containers (pytest_container.build.multistagebuild attribute)": [[0, "pytest_container.build.MultiStageBuild.containers"]], "containers (pytest_container.pod.pod attribute)": [[0, "pytest_container.pod.Pod.containers"]], "create_host_port_port_forward() (in module pytest_container.container)": [[0, "pytest_container.container.create_host_port_port_forward"]], "custom_entry_point (pytest_container.container.containerbase attribute)": [[0, "pytest_container.container.ContainerBase.custom_entry_point"]], "dead (pytest_container.inspect.containerstate attribute)": [[0, "pytest_container.inspect.ContainerState.dead"]], "destination (pytest_container.inspect.mount attribute)": [[0, "pytest_container.inspect.Mount.destination"]], "driver (pytest_container.inspect.volumemount attribute)": [[0, "pytest_container.inspect.VolumeMount.driver"]], "entry_point (pytest_container.container.containerbase attribute)": [[0, "pytest_container.container.ContainerBase.entry_point"]], "entrypoint (pytest_container.inspect.config attribute)": [[0, "pytest_container.inspect.Config.entrypoint"]], "env (pytest_container.inspect.config attribute)": [[0, "pytest_container.inspect.Config.env"]], "extra_build_args (pytest_container.container.containerlauncher attribute)": [[0, "pytest_container.container.ContainerLauncher.extra_build_args"]], "extra_build_args (pytest_container.pod.podlauncher attribute)": [[0, "pytest_container.pod.PodLauncher.extra_build_args"]], "extra_environment_variables (pytest_container.container.containerbase attribute)": [[0, "pytest_container.container.ContainerBase.extra_environment_variables"]], "extra_launch_args (pytest_container.container.containerbase attribute)": [[0, "pytest_container.container.ContainerBase.extra_launch_args"]], "extra_pod_create_args (pytest_container.pod.podlauncher attribute)": [[0, "pytest_container.pod.PodLauncher.extra_pod_create_args"]], "extra_run_args (pytest_container.container.containerlauncher attribute)": [[0, "pytest_container.container.ContainerLauncher.extra_run_args"]], "extra_run_args (pytest_container.pod.podlauncher attribute)": [[0, "pytest_container.pod.PodLauncher.extra_run_args"]], "filelock_filename (pytest_container.container.containerbase property)": [[0, "pytest_container.container.ContainerBase.filelock_filename"]], "flags (pytest_container.container.containervolumebase attribute)": [[0, "pytest_container.container.ContainerVolumeBase.flags"]], "forward_cli_args (pytest_container.inspect.portforwarding property)": [[0, "pytest_container.inspect.PortForwarding.forward_cli_args"]], "forwarded_ports (pytest_container.container.containerbase attribute)": [[0, "pytest_container.container.ContainerBase.forwarded_ports"]], "forwarded_ports (pytest_container.container.containerdata attribute)": [[0, "pytest_container.container.ContainerData.forwarded_ports"]], "forwarded_ports (pytest_container.pod.pod attribute)": [[0, "pytest_container.pod.Pod.forwarded_ports"]], "forwarded_ports (pytest_container.pod.poddata attribute)": [[0, "pytest_container.pod.PodData.forwarded_ports"]], "from_container_inspect() (pytest_container.inspect.healthcheck static method)": [[0, "pytest_container.inspect.HealthCheck.from_container_inspect"]], "get_base() (pytest_container.container.container method)": [[0, "pytest_container.container.Container.get_base"]], "get_base() (pytest_container.container.containerbaseabc method)": [[0, "pytest_container.container.ContainerBaseABC.get_base"]], "get_base() (pytest_container.container.derivedcontainer method)": [[0, "pytest_container.container.DerivedContainer.get_base"]], "get_container_health() (pytest_container.runtime.ociruntimeabc method)": [[0, "pytest_container.runtime.OciRuntimeABC.get_container_health"]], "get_extra_build_args() (in module pytest_container.helpers)": [[0, "pytest_container.helpers.get_extra_build_args"]], "get_extra_pod_create_args() (in module pytest_container.helpers)": [[0, "pytest_container.helpers.get_extra_pod_create_args"]], "get_extra_run_args() (in module pytest_container.helpers)": [[0, "pytest_container.helpers.get_extra_run_args"]], "get_image_id_from_iidfile() (pytest_container.runtime.ociruntimebase static method)": [[0, "pytest_container.runtime.OciRuntimeBase.get_image_id_from_iidfile"]], "get_image_size() (pytest_container.runtime.ociruntimebase method)": [[0, "pytest_container.runtime.OciRuntimeBase.get_image_size"]], "get_launch_cmd() (pytest_container.container.containerbase method)": [[0, "pytest_container.container.ContainerBase.get_launch_cmd"]], "get_selected_runtime() (in module pytest_container.runtime)": [[0, "pytest_container.runtime.get_selected_runtime"]], "get_volume_creator() (in module pytest_container.container)": [[0, "pytest_container.container.get_volume_creator"]], "health (pytest_container.inspect.containerstate attribute)": [[0, "pytest_container.inspect.ContainerState.health"]], "healthcheck (pytest_container.inspect.config attribute)": [[0, "pytest_container.inspect.Config.healthcheck"]], "healthcheck_timeout (pytest_container.container.containerbase attribute)": [[0, "pytest_container.container.ContainerBase.healthcheck_timeout"]], "host_path (pytest_container.container.bindmount attribute)": [[0, "pytest_container.container.BindMount.host_path"]], "host_port (pytest_container.inspect.portforwarding attribute)": [[0, "pytest_container.inspect.PortForwarding.host_port"]], "id (pytest_container.inspect.containerinspect attribute)": [[0, "pytest_container.inspect.ContainerInspect.id"]], "image (pytest_container.inspect.config attribute)": [[0, "pytest_container.inspect.Config.image"]], "image_format (pytest_container.container.derivedcontainer attribute)": [[0, "pytest_container.container.DerivedContainer.image_format"]], "image_hash (pytest_container.inspect.containerinspect attribute)": [[0, "pytest_container.inspect.ContainerInspect.image_hash"]], "image_url_or_id (pytest_container.container.containerdata attribute)": [[0, "pytest_container.container.ContainerData.image_url_or_id"]], "infra_container_id (pytest_container.pod.poddata attribute)": [[0, "pytest_container.pod.PodData.infra_container_id"]], "inspect (pytest_container.container.containerdata property)": [[0, "pytest_container.container.ContainerData.inspect"]], "inspect_container() (pytest_container.runtime.dockerruntime method)": [[0, "pytest_container.runtime.DockerRuntime.inspect_container"]], "inspect_container() (pytest_container.runtime.ociruntimeabc method)": [[0, "pytest_container.runtime.OciRuntimeABC.inspect_container"]], "inspect_container() (pytest_container.runtime.podmanruntime method)": [[0, "pytest_container.runtime.PodmanRuntime.inspect_container"]], "interval (pytest_container.inspect.healthcheck attribute)": [[0, "pytest_container.inspect.HealthCheck.interval"]], "labels (pytest_container.inspect.config attribute)": [[0, "pytest_container.inspect.Config.labels"]], "launch_container() (pytest_container.container.containerlauncher method)": [[0, "pytest_container.container.ContainerLauncher.launch_container"]], "launch_pod() (pytest_container.pod.podlauncher method)": [[0, "pytest_container.pod.PodLauncher.launch_pod"]], "local_image (pytest_container.container.containerbase property)": [[0, "pytest_container.container.ContainerBase.local_image"]], "major (pytest_container.runtime.version attribute)": [[0, "pytest_container.runtime.Version.major"]], "marks (pytest_container.runtime.toparammixin attribute)": [[0, "pytest_container.runtime.ToParamMixin.marks"]], "max_wait_time (pytest_container.inspect.healthcheck property)": [[0, "pytest_container.inspect.HealthCheck.max_wait_time"]], "minor (pytest_container.runtime.version attribute)": [[0, "pytest_container.runtime.Version.minor"]], "module": [[0, "module-pytest_container.build"], [0, "module-pytest_container.container"], [0, "module-pytest_container.helpers"], [0, "module-pytest_container.inspect"], [0, "module-pytest_container.logging"], [0, "module-pytest_container.plugin"], [0, "module-pytest_container.pod"], [0, "module-pytest_container.runtime"]], "mounts (pytest_container.inspect.containerinspect attribute)": [[0, "pytest_container.inspect.ContainerInspect.mounts"]], "name (pytest_container.inspect.volumemount attribute)": [[0, "pytest_container.inspect.VolumeMount.name"]], "network (pytest_container.inspect.containerinspect attribute)": [[0, "pytest_container.inspect.ContainerInspect.network"]], "oom_killed (pytest_container.inspect.containerstate attribute)": [[0, "pytest_container.inspect.ContainerState.oom_killed"]], "parse() (pytest_container.runtime.version static method)": [[0, "pytest_container.runtime.Version.parse"]], "patch (pytest_container.runtime.version attribute)": [[0, "pytest_container.runtime.Version.patch"]], "path (pytest_container.inspect.containerinspect attribute)": [[0, "pytest_container.inspect.ContainerInspect.path"]], "paused (pytest_container.inspect.containerstate attribute)": [[0, "pytest_container.inspect.ContainerState.paused"]], "pid (pytest_container.inspect.containerstate attribute)": [[0, "pytest_container.inspect.ContainerState.pid"]], "pod (pytest_container.pod.poddata attribute)": [[0, "pytest_container.pod.PodData.pod"]], "pod (pytest_container.pod.podlauncher attribute)": [[0, "pytest_container.pod.PodLauncher.pod"]], "pod() (in module pytest_container.plugin)": [[0, "pytest_container.plugin.pod"]], "pod_data (pytest_container.pod.podlauncher property)": [[0, "pytest_container.pod.PodLauncher.pod_data"]], "pod_from_pytest_param() (in module pytest_container.pod)": [[0, "pytest_container.pod.pod_from_pytest_param"]], "pod_id (pytest_container.pod.poddata attribute)": [[0, "pytest_container.pod.PodData.pod_id"]], "pod_name (pytest_container.pod.podlauncher attribute)": [[0, "pytest_container.pod.PodLauncher.pod_name"]], "pod_per_test() (in module pytest_container.plugin)": [[0, "pytest_container.plugin.pod_per_test"]], "ports (pytest_container.inspect.containernetworksettings attribute)": [[0, "pytest_container.inspect.ContainerNetworkSettings.ports"]], "prepare_build() (pytest_container.build.multistagebuild method)": [[0, "pytest_container.build.MultiStageBuild.prepare_build"]], "prepare_container() (pytest_container.container.container method)": [[0, "pytest_container.container.Container.prepare_container"]], "prepare_container() (pytest_container.container.containerbaseabc method)": [[0, "pytest_container.container.ContainerBaseABC.prepare_container"]], "prepare_container() (pytest_container.container.derivedcontainer method)": [[0, "pytest_container.container.DerivedContainer.prepare_container"]], "protocol (pytest_container.inspect.portforwarding attribute)": [[0, "pytest_container.inspect.PortForwarding.protocol"]], "pull_container() (pytest_container.container.container method)": [[0, "pytest_container.container.Container.pull_container"]], "pytest_container.build": [[0, "module-pytest_container.build"]], "pytest_container.container": [[0, "module-pytest_container.container"]], "pytest_container.helpers": [[0, "module-pytest_container.helpers"]], "pytest_container.inspect": [[0, "module-pytest_container.inspect"]], "pytest_container.logging": [[0, "module-pytest_container.logging"]], "pytest_container.plugin": [[0, "module-pytest_container.plugin"]], "pytest_container.pod": [[0, "module-pytest_container.pod"]], "pytest_container.runtime": [[0, "module-pytest_container.runtime"]], "release (pytest_container.runtime.version attribute)": [[0, "pytest_container.runtime.Version.release"]], "repo_name (pytest_container.build.gitrepositorybuild property)": [[0, "pytest_container.build.GitRepositoryBuild.repo_name"]], "repository_tag (pytest_container.build.gitrepositorybuild attribute)": [[0, "pytest_container.build.GitRepositoryBuild.repository_tag"]], "repository_url (pytest_container.build.gitrepositorybuild attribute)": [[0, "pytest_container.build.GitRepositoryBuild.repository_url"]], "restarting (pytest_container.inspect.containerstate attribute)": [[0, "pytest_container.inspect.ContainerState.restarting"]], "retries (pytest_container.inspect.healthcheck attribute)": [[0, "pytest_container.inspect.HealthCheck.retries"]], "rootdir (pytest_container.container.containerlauncher attribute)": [[0, "pytest_container.container.ContainerLauncher.rootdir"]], "rootdir (pytest_container.pod.podlauncher attribute)": [[0, "pytest_container.pod.PodLauncher.rootdir"]], "run_build_step() (pytest_container.build.multistagebuild static method)": [[0, "pytest_container.build.MultiStageBuild.run_build_step"]], "running (pytest_container.inspect.containerstate attribute)": [[0, "pytest_container.inspect.ContainerState.running"]], "rw (pytest_container.inspect.mount attribute)": [[0, "pytest_container.inspect.Mount.rw"]], "set_internal_logging_level() (in module pytest_container.logging)": [[0, "pytest_container.logging.set_internal_logging_level"]], "set_logging_level_from_cli_args() (in module pytest_container.helpers)": [[0, "pytest_container.helpers.set_logging_level_from_cli_args"]], "shared (pytest_container.container.containervolumebase attribute)": [[0, "pytest_container.container.ContainerVolumeBase.shared"]], "singleton (pytest_container.container.containerbase attribute)": [[0, "pytest_container.container.ContainerBase.singleton"]], "source (pytest_container.inspect.mount attribute)": [[0, "pytest_container.inspect.Mount.source"]], "start_period (pytest_container.inspect.healthcheck attribute)": [[0, "pytest_container.inspect.HealthCheck.start_period"]], "state (pytest_container.inspect.containerinspect attribute)": [[0, "pytest_container.inspect.ContainerInspect.state"]], "status (pytest_container.inspect.containerstate attribute)": [[0, "pytest_container.inspect.ContainerState.status"]], "stop_signal (pytest_container.inspect.config attribute)": [[0, "pytest_container.inspect.Config.stop_signal"]], "supports_healthcheck_inherit_from_base (pytest_container.runtime.dockerruntime property)": [[0, "pytest_container.runtime.DockerRuntime.supports_healthcheck_inherit_from_base"]], "supports_healthcheck_inherit_from_base (pytest_container.runtime.ociruntimeabc property)": [[0, "pytest_container.runtime.OciRuntimeABC.supports_healthcheck_inherit_from_base"]], "supports_healthcheck_inherit_from_base (pytest_container.runtime.podmanruntime property)": [[0, "pytest_container.runtime.PodmanRuntime.supports_healthcheck_inherit_from_base"]], "test_command (pytest_container.build.gitrepositorybuild property)": [[0, "pytest_container.build.GitRepositoryBuild.test_command"]], "timeout (pytest_container.inspect.healthcheck attribute)": [[0, "pytest_container.inspect.HealthCheck.timeout"]], "to_pytest_param() (pytest_container.runtime.toparammixin method)": [[0, "pytest_container.runtime.ToParamMixin.to_pytest_param"]], "tty (pytest_container.inspect.config attribute)": [[0, "pytest_container.inspect.Config.tty"]], "url (pytest_container.container.containerbase attribute)": [[0, "pytest_container.container.ContainerBase.url"]], "user (pytest_container.inspect.config attribute)": [[0, "pytest_container.inspect.Config.user"]], "version (pytest_container.runtime.dockerruntime property)": [[0, "pytest_container.runtime.DockerRuntime.version"]], "version (pytest_container.runtime.ociruntimeabc property)": [[0, "pytest_container.runtime.OciRuntimeABC.version"]], "version (pytest_container.runtime.podmanruntime property)": [[0, "pytest_container.runtime.PodmanRuntime.version"]], "volume (pytest_container.container.bindmountcreator attribute)": [[0, "pytest_container.container.BindMountCreator.volume"]], "volume (pytest_container.container.volumecreator attribute)": [[0, "pytest_container.container.VolumeCreator.volume"]], "volume_id (pytest_container.container.containervolume property)": [[0, "pytest_container.container.ContainerVolume.volume_id"]], "volume_mounts (pytest_container.container.containerbase attribute)": [[0, "pytest_container.container.ContainerBase.volume_mounts"]]}}) \ No newline at end of file +Search.setIndex({"docnames": ["api", "changelog", "fixtures", "index", "prerequisites", "tutorials", "usage"], "filenames": ["api.rst", "changelog.rst", "fixtures.rst", "index.rst", "prerequisites.rst", "tutorials.rst", "usage.rst"], "titles": ["API documentation", "Changelog", "Fixtures", "Pytest container", "Prerequisites", "Tutorials", "Usage Tips"], "terms": {"all": [0, 2, 3, 5, 6], "class": [0, 1, 5, 6], "abstract": 0, "detail": 0, "launch": [0, 1, 2, 3], "awai": 0, "These": 0, "ar": [0, 1, 3, 4, 6], "us": [0, 1, 2, 4, 5, 6], "parametr": [0, 1, 2, 3, 5, 6], "test": [0, 1, 3, 4, 5], "case": [0, 2, 6], "fixtur": [0, 1, 3, 4, 5, 6], "provid": [0, 1, 2, 3, 5, 6], "thi": [0, 1, 2, 5, 6], "pytest_contain": [0, 1, 3, 4, 6], "bindmount": [0, 1, 6], "container_path": 0, "str": 0, "flag": [0, 1, 6], "type": [0, 1], "list": [0, 4, 5, 6], "volumeflag": [0, 6], "factori": 0, "share": [0, 6], "bool": 0, "fals": 0, "_vol_nam": 0, "host_path": [0, 6], "option": [0, 2, 6], "none": [0, 1, 6], "A": [0, 6], "volum": [0, 1, 3], "mount": [0, 1, 3], "from": [0, 1, 3, 5], "host": [0, 1, 3, 6], "bind": [0, 1, 3], "describ": 0, "directori": [0, 3, 5, 6], "In": [0, 2, 6], "most": [0, 1, 6], "minim": 0, "configur": [0, 1, 3], "you": [0, 3, 4, 5, 6], "need": [0, 1, 3, 4, 6], "specifi": [0, 6], "i": [0, 1, 2, 3, 5, 6], "path": [0, 6], "via": [0, 1, 2, 3, 4, 5, 6], "creat": [0, 1, 2, 3, 5], "temporari": [0, 3, 6], "point": [0, 1, 6], "altern": 0, "can": [0, 1, 2, 3, 4, 5, 6], "also": [0, 2, 4, 6], "yourself": 0, "absolut": 0, "rel": [0, 6], "refer": [0, 1, 6], "auto": [0, 6], "when": [0, 1, 2, 4, 6], "omit": [0, 5, 6], "save": [0, 6], "attribut": [0, 1, 2, 3, 5, 6], "bindmountcr": 0, "_tmpdir": 0, "temporarydirectori": 0, "context": [0, 1], "manag": [0, 1, 2, 3, 5], "necessari": [0, 3, 6], "e": [0, 1, 6], "which": [0, 1, 2, 4, 6], "should": 0, "url": [0, 1, 3, 6], "container_id": [0, 2, 6], "entry_point": [0, 1, 6], "entrypointselect": 0, "custom_entry_point": [0, 6], "extra_launch_arg": [0, 6], "extra_entrypoint_arg": [0, 1, 6], "healthcheck_timeout": [0, 1, 2], "datetim": 0, "timedelta": [0, 1, 2], "extra_environment_vari": 0, "dict": 0, "singleton": [0, 1], "forwarded_port": [0, 1, 6], "portforward": [0, 6], "volume_mount": [0, 1, 6], "union": 0, "containervolum": [0, 1, 6], "_is_loc": 0, "store": 0, "inform": 0, "about": 0, "imag": [0, 1, 2, 3, 5], "under": [0, 6], "properti": [0, 1, 6], "baseurl": [0, 1], "registri": [0, 1, 2, 3, 5, 6], "base": [0, 1, 2, 5, 6], "one": [0, 6], "exist": [0, 1, 3, 5, 6], "otherwis": [0, 4, 6], "return": [0, 1, 6], "get_bas": [0, 1], "If": [0, 1, 5, 6], "ha": [0, 6], "self": 0, "prepare_contain": [0, 6], "rootdir": 0, "extra_build_arg": [0, 6], "prepar": [0, 1], "so": [0, 1, 5], "pull_contain": 0, "pull": [0, 1, 3], "given": 0, "current": [0, 1, 4], "select": 0, "containerbas": [0, 1], "defin": [0, 1, 2, 5, 6], "Not": 0, "directli": [0, 6], "instead": [0, 1, 6], "derivedcontain": [0, 2, 5, 6], "id": [0, 6], "avail": [0, 2, 6], "custom": [0, 4, 6], "entri": [0, 1, 6], "neither": 0, "its": [0, 5], "default": [0, 1, 2, 4, 6], "nor": 0, "bin": [0, 6], "bash": [0, 6], "1": [0, 2, 3, 4], "entrypoint": [0, 1, 3], "By": 0, "either": [0, 6], "": [0, 1, 2, 5, 6], "cmd": [0, 2, 6], "two": [0, 6], "set": [0, 1, 2, 3], "addit": [0, 6], "argument": [0, 1, 3], "pass": [0, 1, 6], "insert": [0, 6], "after": [0, 3, 6], "docker": [0, 1, 2, 4, 6], "podman": [0, 1, 3, 4, 6], "run": [0, 1, 2, 3, 4, 5], "d": [0, 6], "must": [0, 6], "properli": 0, "escap": 0, "g": [0, 1, 6], "string": [0, 5], "through": [0, 3], "shlex": 0, "split": 0, "caus": [0, 6], "exit": [0, 5], "earli": 0, "It": [0, 1, 2, 3, 5, 6], "remain": 0, "activ": 0, "background": 0, "librari": [0, 6], "function": [0, 1, 2, 3, 5, 6], "environ": [0, 1, 4], "variabl": [0, 1, 4, 5, 6], "inject": [0, 6], "befor": [0, 2, 3, 6], "name": [0, 6], "filelock_filenam": 0, "filenam": 0, "lockfil": 0, "uniqu": [0, 6], "hash": [0, 1, 6], "exclud": 0, "valu": [0, 1], "therebi": 0, "acquir": 0, "lock": [0, 1], "block": 0, "ani": [0, 1, 6], "action": 0, "specif": 0, "across": 0, "thread": 0, "process": [0, 1, 6], "forward": [0, 6], "port": [0, 1, 3], "get_launch_cmd": [0, 6], "container_runtim": [0, 2, 4, 6], "ociruntimebas": [0, 6], "extra_run_arg": 0, "command": [0, 1, 3, 5], "paramet": [0, 5, 6], "ad": [0, 1, 3, 5], "instanc": [0, 3, 5, 6], "fed": 0, "subprocess": 0, "popen": 0, "arg": [0, 6], "time": [0, 2], "becom": [0, 2, 3], "healthi": [0, 2, 3], "timeout": [0, 1, 2], "ignor": [0, 1, 2], "healthcheck": [0, 1, 3], "below": 0, "zero": 0, "infer": [0, 1, 2], "direct": [0, 1, 2], "local_imag": 0, "true": [0, 1, 2, 6], "been": 0, "local": [0, 3], "indic": 0, "whether": [0, 2, 3, 6], "never": 0, "more": [0, 1], "than": 0, "becaus": [0, 6], "open": 0, "full": 0, "your": [0, 2, 3, 5, 6], "onli": [0, 1, 2, 6], "follow": [0, 1, 3, 4, 5, 6], "syntax": [0, 6], "storag": [0, 6], "local_nam": 0, "containerbaseabc": 0, "method": [0, 6], "implement": [0, 3, 5, 6], "containerdata": [0, 1, 3, 5, 6], "image_url_or_id": 0, "connect": [0, 3, 5, 6], "_container_runtim": 0, "testinfra": [0, 3, 4, 5, 6], "data": [0, 6], "start": [0, 1, 2, 3], "expos": [0, 1, 3], "containerinspect": 0, "result": [0, 6], "ctr_id": 0, "containerlaunch": 0, "pathlib": 0, "container_nam": 0, "_expose_port": 0, "_new_port_forward": 0, "_container_id": 0, "_stack": 0, "contextlib": 0, "exitstack": 0, "_cidfil": 0, "setup": [0, 6], "teardown": 0, "includ": [0, 2, 5, 6], "resourc": 0, "container_data": 0, "correspond": 0, "valid": 0, "enter": 0, "statement": 0, "launch_contain": 0, "perform": 0, "actual": [0, 3, 5, 6], "heavi": 0, "lift": 0, "etc": [0, 3, 6], "pp": 0, "root": [0, 6], "pytest": [0, 1, 2, 4, 5, 6], "testsuit": 0, "persist": 0, "file": [0, 1, 3, 5], "outsid": 0, "ephemer": [0, 6], "volume_id": [0, 6], "automat": [0, 1, 3, 5, 6], "volumecr": 0, "containervolumebas": 0, "cli_arg": 0, "line": [0, 5, 6], "insid": [0, 3, 5], "where": [0, 5], "note": [0, 5, 6], "some": [0, 6], "mutual": 0, "exclus": 0, "potenti": 0, "support": [0, 1, 2, 4, 6], "selinux_priv": 0, "unless": 0, "between": [0, 6], "affect": [0, 6], "selinux": [0, 6], "containerfil": [0, 2, 5, 6], "image_format": [0, 2], "imageformat": 0, "add_build_tag": [0, 1], "dockerfil": [0, 1, 3, 5, 6], "differ": [0, 6], "an": [0, 3, 5, 6], "tag": [0, 1], "onc": [0, 2, 5, 6], "built": 0, "deriv": 0, "format": [0, 1, 2], "buildah": [0, 1, 2, 4], "oci": 0, "disabl": [0, 2], "detect": 0, "suppli": 0, "qualnam": 0, "boundari": 0, "choic": [0, 6], "how": [0, 1, 5], "pick": [0, 1, 6], "els": [0, 2], "2": [0, 3], "3": [0, 3, 4], "like": [0, 3, 6], "ociv1": [0, 2], "remov": [0, 1, 3, 6], "destroi": [0, 3, 6], "chown_us": 0, "u": [0, 6], "chown": 0, "content": [0, 5], "rootless": 0, "noexec": 0, "ensur": [0, 2, 5], "overlai": 0, "o": [0, 3], "f": [0, 6], "read_onli": [0, 6], "ro": 0, "read": 0, "read_writ": 0, "rw": 0, "write": 0, "z": [0, 6], "relabel": [0, 6], "singl": [0, 1, 5, 6], "access": [0, 4, 6], "selinux_shar": 0, "container_and_marks_from_pytest_param": [0, 1], "param": [0, 1], "tupl": 0, "liter": 0, "parameterset": 0, "collect": [0, 6], "markdecor": 0, "mark": [0, 1, 2, 3, 6], "extract": 0, "both": [0, 6], "second": [0, 2, 6], "container_from_pytest_param": [0, 1], "just": [0, 6], "container_to_pytest_param": 0, "convert": 0, "subclass": [0, 6], "pretti": 0, "print": [0, 1], "version": [0, 1, 3], "create_host_port_port_forward": 0, "port_forward": [0, 6], "find": [0, 1, 3], "random": 0, "free": [0, 1, 3], "system": [0, 3], "bound": 0, "new": [0, 1, 5], "appropri": 0, "get_volume_cr": 0, "creation": [0, 6], "same": [0, 1, 3, 6], "network": [0, 6], "caution": [0, 6], "individu": [0, 6], "taken": 0, "account": 0, "belong": 0, "poddata": [0, 6], "pod_id": [0, 6], "infra_container_id": 0, "pod_per_test": [0, 6], "each": [0, 5, 6], "infra": 0, "podlaunch": 0, "pod_nam": 0, "extra_pod_create_arg": 0, "_launcher": 0, "_pod_id": 0, "_infra_container_id": 0, "launch_pod": 0, "establish": 0, "pod_data": 0, "pod_from_pytest_param": 0, "git": 0, "repositori": 0, "gitrepositorybuild": 0, "multistag": 0, "multistagebuild": [0, 6], "repository_url": 0, "repository_tag": 0, "build_command": 0, "extern": 0, "requir": [0, 4, 6], "container_git_clon": 0, "host_git_clon": 0, "work": [0, 4, 5], "copi": [0, 3, 5], "left": 0, "empti": [0, 5], "purpos": 0, "clone_command": 0, "clone": 0, "repo_nam": 0, "check": [0, 1, 2, 3, 5, 6], "out": [0, 1, 5], "branch": 0, "end": [0, 6], "test_command": 0, "cd": 0, "correct": [0, 3, 6], "folder": 0, "containerfile_templ": 0, "multi": 0, "stage": 0, "essenti": 0, "veri": 0, "simpl": [0, 3, 5], "replac": 0, "For": [0, 3, 5, 6], "exampl": [0, 3, 5, 6], "builder": 0, "opensus": [0, 2, 3, 5, 6], "org": [0, 2, 3, 5, 6], "busybox": 0, "latest": [0, 2, 3], "runner1": 0, "io": [0, 3, 6], "alpin": 0, "r": [0, 6], "would": [0, 2, 6], "yield": 0, "object": [0, 3, 6], "retriev": 0, "render": 0, "id_of_runner1": 0, "multi_stage_build": [0, 6], "tmp_path": [0, 6], "pytestconfig": [0, 6], "child": 0, "further": [0, 6], "see": 0, "rootdir_or_pytestconfig": 0, "config": [0, 6], "target": 0, "complet": [0, 2, 3], "written": 0, "suit": 0, "upstream": 0, "verif": 0, "prior": 0, "invalid": 0, "fail": [0, 1], "last": 0, "wa": [0, 1, 6], "templat": [0, 6], "dictionari": 0, "map": 0, "previou": 0, "wrap": 0, "prepare_build": 0, "static": 0, "run_build_step": 0, "beforehand": [0, 6], "final": 0, "dockerruntim": 0, "inspect_contain": 0, "pars": [0, 1], "output": [0, 1, 5], "supports_healthcheck_inherit_from_bas": 0, "inherit": 0, "instal": [0, 3, 4, 5], "ociruntimeabc": [0, 1], "interfac": [0, 1, 5], "get_container_health": [0, 2], "containerhealth": [0, 2], "health": [0, 2], "runner_binari": [0, 6], "_runtime_funct": 0, "get_image_id_from_iidfil": 0, "iidfile_path": 0, "iidfil": [0, 1], "get_image_s": 0, "image_or_id_or_contain": 0, "float": 0, "size": 0, "byte": 0, "py": [0, 5, 6], "podmanruntim": 0, "toparammixin": 0, "mixin": 0, "give": [0, 3], "abil": 0, "themselv": [0, 6], "__str__": 0, "to_pytest_param": 0, "major": 0, "int": 0, "0": [0, 3, 5, 6], "minor": 0, "patch": 0, "releas": [0, 3], "represent": 0, "form": 0, "basic": [0, 3, 6], "comparison": [0, 6], "5": 0, "6": [0, 4], "foobar": 0, "field": 0, "less": 0, "greater": 0, "equal": 0, "inequ": 0, "16": 0, "addition": [0, 4, 6], "asdf": 0, "version_str": 0, "construct": 0, "get_selected_runtim": [0, 6], "user": [0, 1, 2, 6], "present": [0, 3], "valueerror": 0, "rais": 0, "definit": 0, "repres": 0, "sourc": 0, "destin": 0, "tty": 0, "env": 0, "label": 0, "stop_sign": 0, "underli": 0, "signal": [0, 3], "sent": 0, "stop": [0, 3], "doe": [0, 1, 2, 6], "termin": 0, "sigkil": [0, 6], "afterward": [0, 5, 6], "attach": [0, 6], "possibl": [0, 2, 6], "state": 0, "no_health_check": 0, "did": 0, "yet": 0, "often": 0, "enough": 0, "unhealthi": [0, 2], "containerst": 0, "image_hash": 0, "containernetworkset": 0, "volumemount": 0, "common": 0, "subset": 0, "gener": 0, "mostli": 0, "digest": [0, 1], "program": 0, "containerinspecthealthcheck": 0, "load": 0, "json": 0, "img_id": 0, "jq": 0, "interv": 0, "retri": 0, "startperiod": 0, "statu": 0, "paus": 0, "restart": 0, "oom_kil": 0, "dead": 0, "pid": 0, "kill": 0, "Of": 0, "memori": 0, "condit": 0, "main": [0, 6], "start_period": 0, "30": 0, "from_container_inspect": 0, "inspect_json": 0, "ctr": 0, "everi": [0, 6], "max_wait_tim": 0, "maximum": [0, 1, 2], "wait": [0, 2, 3, 6], "until": 0, "startup": [0, 2], "period": 0, "dure": [0, 6], "failur": 0, "count": 0, "toward": 0, "consid": [0, 2], "unsuccess": 0, "networkprotocol": 0, "protocol": 0, "sock_const": 0, "socket": 0, "constant": 0, "sock_stream": 0, "sock_dgram": 0, "tcp": 0, "transmiss": 0, "control": 0, "udp": 0, "datagram": 0, "container_port": [0, 6], "host_port": [0, 1, 6], "bind_ip": [0, 1], "To": [0, 2, 6], "well": [0, 6], "my": [0, 5, 6], "webserv": 0, "8000": [0, 6], "ip": [0, 1], "address": [0, 1], "shall": [0, 6], "forward_cli_arg": 0, "container_": [0, 1, 6], "modifi": 0, "driver": 0, "back": 0, "variou": 0, "auto_contain": [0, 5, 6], "add_extra_run_and_build_args_opt": [0, 6], "parser": [0, 6], "add": [0, 1, 5, 6], "extra": [0, 6], "get_extra_run_arg": 0, "get_extra_build_arg": [0, 6], "get_extra_pod_create_arg": 0, "respect": [0, 6], "add_logging_level_opt": [0, 6], "level": [0, 1, 6], "call": [0, 5, 6], "conftest": [0, 5, 6], "pytest_addopt": [0, 6], "set_logging_level_from_cli_arg": [0, 6], "auto_container_parametr": [0, 1, 5], "metafunc": [0, 5], "auto_container_": 0, "code": [0, 1, 5], "snippet": [0, 5, 6], "import": [0, 5, 6], "def": [0, 2, 3, 5, 6], "pytest_generate_test": [0, 5], "get": [0, 1, 3], "bud": 0, "were": [0, 6], "cli": [0, 1, 6], "intern": [0, 1, 6], "execut": [0, 3, 5, 6], "good": 0, "place": 0, "pytest_configur": [0, 6], "hook": [0, 6], "request": [0, 6], "subrequest": 0, "container_imag": [0, 5], "reus": 0, "session": 0, "auto_container_per_test": [0, 5, 6], "expect": [0, 5], "indirect": [0, 2, 3, 6], "container_per_test": [0, 6], "accord": 0, "rule": 0, "outlin": 0, "here": [0, 6], "skip": [0, 6], "except": 0, "handl": [0, 3], "everyth": [0, 3], "relat": 0, "unsurprisingli": 0, "set_internal_logging_level": [0, 6], "20": [0, 3], "verbos": 0, "logger": 0, "break": 1, "chang": [1, 6], "deprec": 1, "pleas": [1, 6], "longer": [1, 6], "recurs": 1, "immedi": 1, "improv": 1, "featur": 1, "append": [1, 6], "contain": [1, 2, 4, 5], "python": [1, 4, 5, 6], "12": 1, "arbitrari": 1, "fix": 1, "being": [1, 6], "document": [1, 3], "get_image_id_from_stdout": 1, "buildx": 1, "stdout": [1, 5, 6], "invok": 1, "build": [1, 2, 3], "cidfil": 1, "log": [1, 3], "runtim": [1, 2, 3, 4], "framework": 1, "easier": 1, "debug": [1, 6], "25": 1, "later": [1, 4], "11": 1, "even": 1, "due": 1, "readm": 1, "rst": 1, "There": [1, 2, 5], "compar": 1, "healtcheck_timeout_m": 1, "got": 1, "renam": 1, "now": [1, 5, 6], "impli": 1, "figur": 1, "itself": [1, 3], "posit": 1, "neg": [1, 2], "appli": [1, 6], "consequ": 1, "default_entry_point": 1, "get_container_healthcheck": 1, "inspect": [1, 3], "The": [1, 2, 3, 4, 5, 6], "cleanup": 1, "allow": [1, 3, 5, 6], "pod": [1, 3], "thei": [1, 4, 5, 6], "want": [1, 6], "publish": 1, "let": 1, "them": [1, 6], "multipl": [1, 3, 5, 6], "parallel": [1, 3, 5, 6], "without": [1, 6], "datastructur": 1, "helper": [1, 3], "tutori": [1, 3], "public": 1, "privat": 1, "modul": [1, 3, 4, 6], "switch": 1, "tox": [1, 4], "nox": 1, "poetri": [1, 5], "typeguard": 1, "hint": 1, "make": [1, 2, 6], "readabl": 1, "robust": 1, "treat": [1, 2], "unresolv": 1, "error": [1, 6], "enabl": 1, "intersphinx": 1, "better": 1, "messag": [1, 6], "determin": 2, "own": [2, 6], "principl": 2, "noth": 2, "do": 2, "come": 2, "certain": [2, 6], "sens": [2, 6], "explicitli": 2, "had": 2, "container_with_healthcheck": 2, "leap": 2, "don": 2, "t": [2, 5], "test_leap": 2, "assert": [2, 3, 5, 6], "small": 2, "catch": [2, 6], "while": [2, 6], "dcermak": 3, "github": 3, "plugin": [3, 6], "take": 3, "care": 3, "bore": 3, "task": [3, 5], "spin": 3, "up": 3, "clean": [3, 6], "focu": 3, "autom": 3, "xdist": [3, 5, 6], "depend": [3, 5, 6], "order": 3, "mani": 3, "four": 3, "instanti": 3, "tw": 3, "tumblewe": [3, 5, 6], "test_etc_os_release_pres": 3, "receiv": [3, 5, 6], "packag": 3, "oper": 3, "verifi": 3, "softwar": 3, "prerequisit": 3, "usag": 3, "tip": 3, "global": [3, 5], "changelog": 3, "next": 3, "26": 3, "septemb": 3, "2023": 3, "devconf": 3, "cz": 3, "edit": 3, "14": 3, "june": 3, "21": 3, "march": 3, "01": 3, "februari": 3, "2022": 3, "api": 3, "index": [3, 6], "search": [3, 5], "page": 3, "ll": 4, "dataclass": 4, "leverag": 4, "have": [4, 5, 6], "ones": 4, "keep": [4, 5], "mind": 4, "put": 4, "passenv": 4, "demonstr": 5, "project": 5, "pyproject": 5, "toml": 5, "doesn": 5, "alreadi": 5, "init": 5, "develop": 5, "group": 5, "dev": 5, "recommend": [5, 6], "thing": 5, "tidi": 5, "__init__": 5, "abov": [5, 6], "correctli": [5, 6], "we": [5, 6], "smoke": 5, "wheel": 5, "our": 5, "util": 5, "pip": 5, "zypper": [5, 6], "n": [5, 6], "python3": [5, 6], "dist": 5, "whl": 5, "plug": 5, "textwrap": 5, "dedent": 5, "tw_with_pkg": 5, "test_cli": 5, "along": 5, "test_help_work": 5, "re": [5, 6], "run_expect": [5, 6], "binari": [5, 6], "help": 5, "cool": 5, "instruct": [5, 6], "thu": 5, "avoid": 5, "manual": [5, 6], "standard": 5, "sometim": 6, "rather": 6, "cumbersom": 6, "practic": 6, "therefor": 6, "alongsid": 6, "invoc": 6, "Then": 6, "cach": 6, "shown": 6, "wish": 6, "test_multistag": 6, "test_data": 6, "test_multistage_build": 6, "happen": 6, "prefer": 6, "accomplish": 6, "against": 6, "remot": 6, "inspir": 6, "skopeo": 6, "wai": 6, "other": 6, "skipif": 6, "4": 6, "reason": 6, "least": 6, "test_modern_podman_featur": 6, "new_featur": 6, "script": 6, "integr": 6, "achiev": 6, "desir": 6, "nowadai": 6, "http": 6, "phoenixnap": 6, "com": 6, "kb": 6, "v": 6, "dir": 6, "testfil": 6, "cdir": 6, "container1": 6, "some_base_imag": 6, "test_my_script": 6, "cp": 6, "contrast": 6, "first": 6, "disadvantag": 6, "cannot": 6, "howev": 6, "dynam": 6, "easili": 6, "approach": 6, "successfulli": 6, "undertak": 6, "step": 6, "_container_per_test": 6, "obtain": 6, "could": 6, "locat": 6, "restrict": 6, "tricki": 6, "topic": 6, "remedi": 6, "web_serv": 6, "snip": 6, "test_port_forward_set_up": 6, "curl": 6, "localhost": 6, "strip": 6, "quickli": 6, "problem": 6, "concurr": 6, "pose": 6, "challeng": 6, "leav": 6, "strai": 6, "runner": 6, "offer": 6, "conveni": 6, "finish": 6, "newli": 6, "caveat": 6, "abl": 6, "suffici": 6, "director": 6, "similarli": 6, "permit": 6, "try": 6, "illustr": 6, "nginx": 6, "80": 6, "conf": 6, "var": 6, "check_nginx_cach": 6, "cache_on_host": 6, "var_log": 6, "nginx_proxi": 6, "echo": 6, "server": 6, "listen": 6, "server_nam": 6, "proxy_pass": 6, "hello": 6, "green": 6, "world": 6, "html": 6, "usr": 6, "m": 6, "proxy_pod": 6, "test_proxy_pod": 6, "port_80_on_host": 6, "behavior": 6, "forc": 6, "stopsign": 6, "non": 6, "shell": 6, "might": 6, "react": 6, "eventu": 6, "resort": 6, "send": 6, "But": 6, "slow": 6, "needlessli": 6, "down": 6, "10": 6, "sigterm": 6}, "objects": {"pytest_container": [[0, 0, 0, "-", "build"], [0, 0, 0, "-", "container"], [0, 0, 0, "-", "helpers"], [0, 0, 0, "-", "inspect"], [0, 0, 0, "-", "logging"], [0, 0, 0, "-", "plugin"], [0, 0, 0, "-", "pod"], [0, 0, 0, "-", "runtime"]], "pytest_container.build": [[0, 1, 1, "", "GitRepositoryBuild"], [0, 1, 1, "", "MultiStageBuild"]], "pytest_container.build.GitRepositoryBuild": [[0, 2, 1, "", "build_command"], [0, 3, 1, "", "clone_command"], [0, 3, 1, "", "repo_name"], [0, 2, 1, "", "repository_tag"], [0, 2, 1, "", "repository_url"], [0, 3, 1, "", "test_command"]], "pytest_container.build.MultiStageBuild": [[0, 4, 1, "", "build"], [0, 3, 1, "", "containerfile"], [0, 2, 1, "", "containerfile_template"], [0, 2, 1, "", "containers"], [0, 4, 1, "", "prepare_build"], [0, 4, 1, "", "run_build_step"]], "pytest_container.container": [[0, 1, 1, "", "BindMount"], [0, 1, 1, "", "BindMountCreator"], [0, 1, 1, "", "Container"], [0, 1, 1, "", "ContainerBase"], [0, 1, 1, "", "ContainerBaseABC"], [0, 1, 1, "", "ContainerData"], [0, 1, 1, "", "ContainerLauncher"], [0, 1, 1, "", "ContainerVolume"], [0, 1, 1, "", "ContainerVolumeBase"], [0, 1, 1, "", "DerivedContainer"], [0, 1, 1, "", "EntrypointSelection"], [0, 1, 1, "", "ImageFormat"], [0, 1, 1, "", "VolumeCreator"], [0, 1, 1, "", "VolumeFlag"], [0, 5, 1, "", "container_and_marks_from_pytest_param"], [0, 5, 1, "", "container_from_pytest_param"], [0, 5, 1, "", "container_to_pytest_param"], [0, 5, 1, "", "create_host_port_port_forward"], [0, 5, 1, "", "get_volume_creator"]], "pytest_container.container.BindMount": [[0, 2, 1, "", "host_path"]], "pytest_container.container.BindMountCreator": [[0, 2, 1, "", "volume"]], "pytest_container.container.Container": [[0, 3, 1, "", "baseurl"], [0, 4, 1, "", "get_base"], [0, 4, 1, "", "prepare_container"], [0, 4, 1, "", "pull_container"]], "pytest_container.container.ContainerBase": [[0, 2, 1, "", "container_id"], [0, 2, 1, "", "custom_entry_point"], [0, 2, 1, "", "entry_point"], [0, 2, 1, "", "extra_entrypoint_args"], [0, 2, 1, "", "extra_environment_variables"], [0, 2, 1, "", "extra_launch_args"], [0, 3, 1, "", "filelock_filename"], [0, 2, 1, "", "forwarded_ports"], [0, 4, 1, "", "get_launch_cmd"], [0, 2, 1, "", "healthcheck_timeout"], [0, 3, 1, "", "local_image"], [0, 2, 1, "", "singleton"], [0, 2, 1, "", "url"], [0, 2, 1, "", "volume_mounts"]], "pytest_container.container.ContainerBaseABC": [[0, 3, 1, "", "baseurl"], [0, 4, 1, "", "get_base"], [0, 4, 1, "", "prepare_container"]], "pytest_container.container.ContainerData": [[0, 2, 1, "", "connection"], [0, 2, 1, "", "container"], [0, 2, 1, "", "container_id"], [0, 2, 1, "", "forwarded_ports"], [0, 2, 1, "", "image_url_or_id"], [0, 3, 1, "", "inspect"]], "pytest_container.container.ContainerLauncher": [[0, 2, 1, "", "container"], [0, 3, 1, "", "container_data"], [0, 2, 1, "", "container_name"], [0, 2, 1, "", "container_runtime"], [0, 2, 1, "", "extra_build_args"], [0, 2, 1, "", "extra_run_args"], [0, 4, 1, "", "launch_container"], [0, 2, 1, "", "rootdir"]], "pytest_container.container.ContainerVolume": [[0, 3, 1, "", "volume_id"]], "pytest_container.container.ContainerVolumeBase": [[0, 3, 1, "", "cli_arg"], [0, 2, 1, "", "container_path"], [0, 2, 1, "", "flags"], [0, 2, 1, "", "shared"]], "pytest_container.container.DerivedContainer": [[0, 2, 1, "", "add_build_tags"], [0, 2, 1, "", "base"], [0, 3, 1, "", "baseurl"], [0, 2, 1, "", "containerfile"], [0, 4, 1, "", "get_base"], [0, 2, 1, "", "image_format"], [0, 4, 1, "", "prepare_container"]], "pytest_container.container.EntrypointSelection": [[0, 2, 1, "", "AUTO"], [0, 2, 1, "", "BASH"], [0, 2, 1, "", "IMAGE"]], "pytest_container.container.ImageFormat": [[0, 2, 1, "", "DOCKER"], [0, 2, 1, "", "OCIv1"]], "pytest_container.container.VolumeCreator": [[0, 2, 1, "", "container_runtime"], [0, 2, 1, "", "volume"]], "pytest_container.container.VolumeFlag": [[0, 2, 1, "", "CHOWN_USER"], [0, 2, 1, "", "NOEXEC"], [0, 2, 1, "", "OVERLAY"], [0, 2, 1, "", "READ_ONLY"], [0, 2, 1, "", "READ_WRITE"], [0, 2, 1, "", "SELINUX_PRIVATE"], [0, 2, 1, "", "SELINUX_SHARED"]], "pytest_container.helpers": [[0, 5, 1, "", "add_extra_run_and_build_args_options"], [0, 5, 1, "", "add_logging_level_options"], [0, 5, 1, "", "auto_container_parametrize"], [0, 5, 1, "", "get_extra_build_args"], [0, 5, 1, "", "get_extra_pod_create_args"], [0, 5, 1, "", "get_extra_run_args"], [0, 5, 1, "", "set_logging_level_from_cli_args"]], "pytest_container.inspect": [[0, 1, 1, "", "BindMount"], [0, 1, 1, "", "Config"], [0, 1, 1, "", "ContainerHealth"], [0, 1, 1, "", "ContainerInspect"], [0, 1, 1, "", "ContainerInspectHealthCheck"], [0, 1, 1, "", "ContainerNetworkSettings"], [0, 1, 1, "", "ContainerState"], [0, 1, 1, "", "HealthCheck"], [0, 1, 1, "", "Mount"], [0, 1, 1, "", "NetworkProtocol"], [0, 1, 1, "", "PortForwarding"], [0, 1, 1, "", "VolumeMount"]], "pytest_container.inspect.Config": [[0, 2, 1, "", "cmd"], [0, 2, 1, "", "entrypoint"], [0, 2, 1, "", "env"], [0, 2, 1, "", "healthcheck"], [0, 2, 1, "", "image"], [0, 2, 1, "", "labels"], [0, 2, 1, "", "stop_signal"], [0, 2, 1, "", "tty"], [0, 2, 1, "", "user"]], "pytest_container.inspect.ContainerHealth": [[0, 2, 1, "", "HEALTHY"], [0, 2, 1, "", "NO_HEALTH_CHECK"], [0, 2, 1, "", "STARTING"], [0, 2, 1, "", "UNHEALTHY"]], "pytest_container.inspect.ContainerInspect": [[0, 2, 1, "", "args"], [0, 2, 1, "", "config"], [0, 2, 1, "", "id"], [0, 2, 1, "", "image_hash"], [0, 2, 1, "", "mounts"], [0, 2, 1, "", "network"], [0, 2, 1, "", "path"], [0, 2, 1, "", "state"]], "pytest_container.inspect.ContainerInspectHealthCheck": [[0, 2, 1, "", "Interval"], [0, 2, 1, "", "Retries"], [0, 2, 1, "", "StartPeriod"], [0, 2, 1, "", "Test"], [0, 2, 1, "", "Timeout"]], "pytest_container.inspect.ContainerNetworkSettings": [[0, 2, 1, "", "ports"]], "pytest_container.inspect.ContainerState": [[0, 2, 1, "", "dead"], [0, 2, 1, "", "health"], [0, 2, 1, "", "oom_killed"], [0, 2, 1, "", "paused"], [0, 2, 1, "", "pid"], [0, 2, 1, "", "restarting"], [0, 2, 1, "", "running"], [0, 2, 1, "", "status"]], "pytest_container.inspect.HealthCheck": [[0, 4, 1, "", "from_container_inspect"], [0, 2, 1, "", "interval"], [0, 3, 1, "", "max_wait_time"], [0, 2, 1, "", "retries"], [0, 2, 1, "", "start_period"], [0, 2, 1, "", "timeout"]], "pytest_container.inspect.Mount": [[0, 2, 1, "", "destination"], [0, 2, 1, "", "rw"], [0, 2, 1, "", "source"]], "pytest_container.inspect.NetworkProtocol": [[0, 3, 1, "", "SOCK_CONST"], [0, 2, 1, "", "TCP"], [0, 2, 1, "", "UDP"]], "pytest_container.inspect.PortForwarding": [[0, 2, 1, "", "bind_ip"], [0, 2, 1, "", "container_port"], [0, 3, 1, "", "forward_cli_args"], [0, 2, 1, "", "host_port"], [0, 2, 1, "", "protocol"]], "pytest_container.inspect.VolumeMount": [[0, 2, 1, "", "driver"], [0, 2, 1, "", "name"]], "pytest_container.logging": [[0, 5, 1, "", "set_internal_logging_level"]], "pytest_container.plugin": [[0, 5, 1, "", "auto_container"], [0, 5, 1, "", "auto_container_per_test"], [0, 5, 1, "", "container"], [0, 5, 1, "", "container_per_test"], [0, 5, 1, "", "container_runtime"], [0, 5, 1, "", "pod"], [0, 5, 1, "", "pod_per_test"]], "pytest_container.pod": [[0, 1, 1, "", "Pod"], [0, 1, 1, "", "PodData"], [0, 1, 1, "", "PodLauncher"], [0, 5, 1, "", "pod_from_pytest_param"]], "pytest_container.pod.Pod": [[0, 2, 1, "", "containers"], [0, 2, 1, "", "forwarded_ports"]], "pytest_container.pod.PodData": [[0, 2, 1, "", "container_data"], [0, 2, 1, "", "forwarded_ports"], [0, 2, 1, "", "infra_container_id"], [0, 2, 1, "", "pod"], [0, 2, 1, "", "pod_id"]], "pytest_container.pod.PodLauncher": [[0, 2, 1, "", "extra_build_args"], [0, 2, 1, "", "extra_pod_create_args"], [0, 2, 1, "", "extra_run_args"], [0, 4, 1, "", "launch_pod"], [0, 2, 1, "", "pod"], [0, 3, 1, "", "pod_data"], [0, 2, 1, "", "pod_name"], [0, 2, 1, "", "rootdir"]], "pytest_container.runtime": [[0, 1, 1, "", "DockerRuntime"], [0, 1, 1, "", "OciRuntimeABC"], [0, 1, 1, "", "OciRuntimeBase"], [0, 1, 1, "", "PodmanRuntime"], [0, 1, 1, "", "ToParamMixin"], [0, 1, 1, "", "Version"], [0, 5, 1, "", "get_selected_runtime"]], "pytest_container.runtime.DockerRuntime": [[0, 4, 1, "", "inspect_container"], [0, 3, 1, "", "supports_healthcheck_inherit_from_base"], [0, 3, 1, "", "version"]], "pytest_container.runtime.OciRuntimeABC": [[0, 4, 1, "", "get_container_health"], [0, 4, 1, "", "inspect_container"], [0, 3, 1, "", "supports_healthcheck_inherit_from_base"], [0, 3, 1, "", "version"]], "pytest_container.runtime.OciRuntimeBase": [[0, 4, 1, "", "get_image_id_from_iidfile"], [0, 4, 1, "", "get_image_size"]], "pytest_container.runtime.PodmanRuntime": [[0, 4, 1, "", "inspect_container"], [0, 3, 1, "", "supports_healthcheck_inherit_from_base"], [0, 3, 1, "", "version"]], "pytest_container.runtime.ToParamMixin": [[0, 2, 1, "", "marks"], [0, 4, 1, "", "to_pytest_param"]], "pytest_container.runtime.Version": [[0, 2, 1, "", "build"], [0, 2, 1, "", "major"], [0, 2, 1, "", "minor"], [0, 4, 1, "", "parse"], [0, 2, 1, "", "patch"], [0, 2, 1, "", "release"]]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:attribute", "3": "py:property", "4": "py:method", "5": "py:function"}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "attribute", "Python attribute"], "3": ["py", "property", "Python property"], "4": ["py", "method", "Python method"], "5": ["py", "function", "Python function"]}, "titleterms": {"api": 0, "document": 0, "The": 0, "contain": [0, 3, 6], "modul": 0, "pod": [0, 6], "build": [0, 6], "runtim": [0, 6], "inspect": 0, "helper": 0, "plugin": 0, "log": [0, 6], "changelog": 1, "next": 1, "releas": 1, "0": 1, "3": 1, "26": 1, "septemb": 1, "2023": 1, "2": [1, 6], "devconf": 1, "cz": 1, "edit": 1, "14": 1, "june": 1, "1": [1, 6], "21": 1, "march": 1, "20": 1, "01": 1, "februari": 1, "2022": 1, "fixtur": 2, "handl": [2, 6], "healthcheck": 2, "pytest": 3, "us": 3, "case": 3, "content": 3, "indic": 3, "tabl": 3, "prerequisit": 4, "tutori": 5, "get": 5, "start": 5, "pytest_contain": 5, "usag": 6, "tip": 6, "ad": 6, "global": 6, "run": 6, "creat": 6, "argument": 6, "configur": 6, "test": 6, "local": 6, "imag": 6, "version": 6, "copi": 6, "file": 6, "time": 6, "expos": 6, "port": 6, "from": 6, "set": 6, "up": 6, "bind": 6, "mount": 6, "volum": 6, "manag": 6, "entrypoint": 6, "launch": 6, "command": 6, "stop": 6, "signal": 6}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx.ext.intersphinx": 1, "sphinx": 57}, "alltitles": {"API documentation": [[0, "api-documentation"]], "The container module": [[0, "module-pytest_container.container"]], "The pod module": [[0, "module-pytest_container.pod"]], "The build module": [[0, "module-pytest_container.build"]], "The runtime module": [[0, "module-pytest_container.runtime"]], "The inspect module": [[0, "module-pytest_container.inspect"]], "The helpers module": [[0, "module-pytest_container.helpers"]], "The plugin module": [[0, "module-pytest_container.plugin"]], "The logging module": [[0, "module-pytest_container.logging"]], "Changelog": [[1, "changelog"]], "Next Release": [[1, "next-release"]], "0.3.0 (26 September 2023)": [[1, "september-2023"]], "0.2.0 - DevConf.cz edition (14 June 2023)": [[1, "devconf-cz-edition-14-june-2023"]], "0.1.1 (21 March 2023)": [[1, "march-2023"]], "0.1.0 (20 March 2023)": [[1, "id1"]], "0.0.2 (01 February 2022)": [[1, "february-2022"]], "Fixtures": [[2, "fixtures"]], "Handling Healthcheck": [[2, "handling-healthcheck"]], "Pytest container": [[3, "pytest-container"]], "Use cases": [[3, "use-cases"]], "Contents": [[3, "contents"]], "Indices and tables": [[3, "indices-and-tables"]], "Prerequisites": [[4, "prerequisites"]], "Tutorials": [[5, "tutorials"]], "Getting started with pytest_container": [[5, "getting-started-with-pytest-container"]], "Usage Tips": [[6, "usage-tips"]], "Adding global build, run or pod create arguments": [[6, "adding-global-build-run-or-pod-create-arguments"]], "Configuring logging": [[6, "configuring-logging"]], "Testing local images": [[6, "testing-local-images"]], "Container Runtime version": [[6, "container-runtime-version"]], "Copying files into containers": [[6, "copying-files-into-containers"]], "1. Copy the files at build time": [[6, "copy-the-files-at-build-time"]], "2. Copy the files at runtime into the running container": [[6, "copy-the-files-at-runtime-into-the-running-container"]], "Exposing ports from containers": [[6, "exposing-ports-from-containers"]], "Setting up bind mounts or container volumes": [[6, "setting-up-bind-mounts-or-container-volumes"]], "Create and manage pods": [[6, "create-and-manage-pods"]], "Entrypoint, launch command and stop signal handling": [[6, "entrypoint-launch-command-and-stop-signal-handling"]]}, "indexentries": {"auto (pytest_container.container.entrypointselection attribute)": [[0, "pytest_container.container.EntrypointSelection.AUTO"]], "bash (pytest_container.container.entrypointselection attribute)": [[0, "pytest_container.container.EntrypointSelection.BASH"]], "bindmount (class in pytest_container.container)": [[0, "pytest_container.container.BindMount"]], "bindmount (class in pytest_container.inspect)": [[0, "pytest_container.inspect.BindMount"]], "bindmountcreator (class in pytest_container.container)": [[0, "pytest_container.container.BindMountCreator"]], "chown_user (pytest_container.container.volumeflag attribute)": [[0, "pytest_container.container.VolumeFlag.CHOWN_USER"]], "config (class in pytest_container.inspect)": [[0, "pytest_container.inspect.Config"]], "container (class in pytest_container.container)": [[0, "pytest_container.container.Container"]], "containerbase (class in pytest_container.container)": [[0, "pytest_container.container.ContainerBase"]], "containerbaseabc (class in pytest_container.container)": [[0, "pytest_container.container.ContainerBaseABC"]], "containerdata (class in pytest_container.container)": [[0, "pytest_container.container.ContainerData"]], "containerhealth (class in pytest_container.inspect)": [[0, "pytest_container.inspect.ContainerHealth"]], "containerinspect (class in pytest_container.inspect)": [[0, "pytest_container.inspect.ContainerInspect"]], "containerinspecthealthcheck (class in pytest_container.inspect)": [[0, "pytest_container.inspect.ContainerInspectHealthCheck"]], "containerlauncher (class in pytest_container.container)": [[0, "pytest_container.container.ContainerLauncher"]], "containernetworksettings (class in pytest_container.inspect)": [[0, "pytest_container.inspect.ContainerNetworkSettings"]], "containerstate (class in pytest_container.inspect)": [[0, "pytest_container.inspect.ContainerState"]], "containervolume (class in pytest_container.container)": [[0, "pytest_container.container.ContainerVolume"]], "containervolumebase (class in pytest_container.container)": [[0, "pytest_container.container.ContainerVolumeBase"]], "docker (pytest_container.container.imageformat attribute)": [[0, "pytest_container.container.ImageFormat.DOCKER"]], "derivedcontainer (class in pytest_container.container)": [[0, "pytest_container.container.DerivedContainer"]], "dockerruntime (class in pytest_container.runtime)": [[0, "pytest_container.runtime.DockerRuntime"]], "entrypointselection (class in pytest_container.container)": [[0, "pytest_container.container.EntrypointSelection"]], "gitrepositorybuild (class in pytest_container.build)": [[0, "pytest_container.build.GitRepositoryBuild"]], "healthy (pytest_container.inspect.containerhealth attribute)": [[0, "pytest_container.inspect.ContainerHealth.HEALTHY"]], "healthcheck (class in pytest_container.inspect)": [[0, "pytest_container.inspect.HealthCheck"]], "image (pytest_container.container.entrypointselection attribute)": [[0, "pytest_container.container.EntrypointSelection.IMAGE"]], "imageformat (class in pytest_container.container)": [[0, "pytest_container.container.ImageFormat"]], "interval (pytest_container.inspect.containerinspecthealthcheck attribute)": [[0, "pytest_container.inspect.ContainerInspectHealthCheck.Interval"]], "mount (class in pytest_container.inspect)": [[0, "pytest_container.inspect.Mount"]], "multistagebuild (class in pytest_container.build)": [[0, "pytest_container.build.MultiStageBuild"]], "noexec (pytest_container.container.volumeflag attribute)": [[0, "pytest_container.container.VolumeFlag.NOEXEC"]], "no_health_check (pytest_container.inspect.containerhealth attribute)": [[0, "pytest_container.inspect.ContainerHealth.NO_HEALTH_CHECK"]], "networkprotocol (class in pytest_container.inspect)": [[0, "pytest_container.inspect.NetworkProtocol"]], "ociv1 (pytest_container.container.imageformat attribute)": [[0, "pytest_container.container.ImageFormat.OCIv1"]], "overlay (pytest_container.container.volumeflag attribute)": [[0, "pytest_container.container.VolumeFlag.OVERLAY"]], "ociruntimeabc (class in pytest_container.runtime)": [[0, "pytest_container.runtime.OciRuntimeABC"]], "ociruntimebase (class in pytest_container.runtime)": [[0, "pytest_container.runtime.OciRuntimeBase"]], "pod (class in pytest_container.pod)": [[0, "pytest_container.pod.Pod"]], "poddata (class in pytest_container.pod)": [[0, "pytest_container.pod.PodData"]], "podlauncher (class in pytest_container.pod)": [[0, "pytest_container.pod.PodLauncher"]], "podmanruntime (class in pytest_container.runtime)": [[0, "pytest_container.runtime.PodmanRuntime"]], "portforwarding (class in pytest_container.inspect)": [[0, "pytest_container.inspect.PortForwarding"]], "read_only (pytest_container.container.volumeflag attribute)": [[0, "pytest_container.container.VolumeFlag.READ_ONLY"]], "read_write (pytest_container.container.volumeflag attribute)": [[0, "pytest_container.container.VolumeFlag.READ_WRITE"]], "retries (pytest_container.inspect.containerinspecthealthcheck attribute)": [[0, "pytest_container.inspect.ContainerInspectHealthCheck.Retries"]], "selinux_private (pytest_container.container.volumeflag attribute)": [[0, "pytest_container.container.VolumeFlag.SELINUX_PRIVATE"]], "selinux_shared (pytest_container.container.volumeflag attribute)": [[0, "pytest_container.container.VolumeFlag.SELINUX_SHARED"]], "sock_const (pytest_container.inspect.networkprotocol property)": [[0, "pytest_container.inspect.NetworkProtocol.SOCK_CONST"]], "starting (pytest_container.inspect.containerhealth attribute)": [[0, "pytest_container.inspect.ContainerHealth.STARTING"]], "startperiod (pytest_container.inspect.containerinspecthealthcheck attribute)": [[0, "pytest_container.inspect.ContainerInspectHealthCheck.StartPeriod"]], "tcp (pytest_container.inspect.networkprotocol attribute)": [[0, "pytest_container.inspect.NetworkProtocol.TCP"]], "test (pytest_container.inspect.containerinspecthealthcheck attribute)": [[0, "pytest_container.inspect.ContainerInspectHealthCheck.Test"]], "timeout (pytest_container.inspect.containerinspecthealthcheck attribute)": [[0, "pytest_container.inspect.ContainerInspectHealthCheck.Timeout"]], "toparammixin (class in pytest_container.runtime)": [[0, "pytest_container.runtime.ToParamMixin"]], "udp (pytest_container.inspect.networkprotocol attribute)": [[0, "pytest_container.inspect.NetworkProtocol.UDP"]], "unhealthy (pytest_container.inspect.containerhealth attribute)": [[0, "pytest_container.inspect.ContainerHealth.UNHEALTHY"]], "version (class in pytest_container.runtime)": [[0, "pytest_container.runtime.Version"]], "volumecreator (class in pytest_container.container)": [[0, "pytest_container.container.VolumeCreator"]], "volumeflag (class in pytest_container.container)": [[0, "pytest_container.container.VolumeFlag"]], "volumemount (class in pytest_container.inspect)": [[0, "pytest_container.inspect.VolumeMount"]], "add_build_tags (pytest_container.container.derivedcontainer attribute)": [[0, "pytest_container.container.DerivedContainer.add_build_tags"]], "add_extra_run_and_build_args_options() (in module pytest_container.helpers)": [[0, "pytest_container.helpers.add_extra_run_and_build_args_options"]], "add_logging_level_options() (in module pytest_container.helpers)": [[0, "pytest_container.helpers.add_logging_level_options"]], "args (pytest_container.inspect.containerinspect attribute)": [[0, "pytest_container.inspect.ContainerInspect.args"]], "auto_container() (in module pytest_container.plugin)": [[0, "pytest_container.plugin.auto_container"]], "auto_container_parametrize() (in module pytest_container.helpers)": [[0, "pytest_container.helpers.auto_container_parametrize"]], "auto_container_per_test() (in module pytest_container.plugin)": [[0, "pytest_container.plugin.auto_container_per_test"]], "base (pytest_container.container.derivedcontainer attribute)": [[0, "pytest_container.container.DerivedContainer.base"]], "baseurl (pytest_container.container.container property)": [[0, "pytest_container.container.Container.baseurl"]], "baseurl (pytest_container.container.containerbaseabc property)": [[0, "pytest_container.container.ContainerBaseABC.baseurl"]], "baseurl (pytest_container.container.derivedcontainer property)": [[0, "pytest_container.container.DerivedContainer.baseurl"]], "bind_ip (pytest_container.inspect.portforwarding attribute)": [[0, "pytest_container.inspect.PortForwarding.bind_ip"]], "build (pytest_container.runtime.version attribute)": [[0, "pytest_container.runtime.Version.build"]], "build() (pytest_container.build.multistagebuild method)": [[0, "pytest_container.build.MultiStageBuild.build"]], "build_command (pytest_container.build.gitrepositorybuild attribute)": [[0, "pytest_container.build.GitRepositoryBuild.build_command"]], "cli_arg (pytest_container.container.containervolumebase property)": [[0, "pytest_container.container.ContainerVolumeBase.cli_arg"]], "clone_command (pytest_container.build.gitrepositorybuild property)": [[0, "pytest_container.build.GitRepositoryBuild.clone_command"]], "cmd (pytest_container.inspect.config attribute)": [[0, "pytest_container.inspect.Config.cmd"]], "config (pytest_container.inspect.containerinspect attribute)": [[0, "pytest_container.inspect.ContainerInspect.config"]], "connection (pytest_container.container.containerdata attribute)": [[0, "pytest_container.container.ContainerData.connection"]], "container (pytest_container.container.containerdata attribute)": [[0, "pytest_container.container.ContainerData.container"]], "container (pytest_container.container.containerlauncher attribute)": [[0, "pytest_container.container.ContainerLauncher.container"]], "container() (in module pytest_container.plugin)": [[0, "pytest_container.plugin.container"]], "container_and_marks_from_pytest_param() (in module pytest_container.container)": [[0, "pytest_container.container.container_and_marks_from_pytest_param"]], "container_data (pytest_container.container.containerlauncher property)": [[0, "pytest_container.container.ContainerLauncher.container_data"]], "container_data (pytest_container.pod.poddata attribute)": [[0, "pytest_container.pod.PodData.container_data"]], "container_from_pytest_param() (in module pytest_container.container)": [[0, "pytest_container.container.container_from_pytest_param"]], "container_id (pytest_container.container.containerbase attribute)": [[0, "pytest_container.container.ContainerBase.container_id"]], "container_id (pytest_container.container.containerdata attribute)": [[0, "pytest_container.container.ContainerData.container_id"]], "container_name (pytest_container.container.containerlauncher attribute)": [[0, "pytest_container.container.ContainerLauncher.container_name"]], "container_path (pytest_container.container.containervolumebase attribute)": [[0, "pytest_container.container.ContainerVolumeBase.container_path"]], "container_per_test() (in module pytest_container.plugin)": [[0, "pytest_container.plugin.container_per_test"]], "container_port (pytest_container.inspect.portforwarding attribute)": [[0, "pytest_container.inspect.PortForwarding.container_port"]], "container_runtime (pytest_container.container.containerlauncher attribute)": [[0, "pytest_container.container.ContainerLauncher.container_runtime"]], "container_runtime (pytest_container.container.volumecreator attribute)": [[0, "pytest_container.container.VolumeCreator.container_runtime"]], "container_runtime() (in module pytest_container.plugin)": [[0, "pytest_container.plugin.container_runtime"]], "container_to_pytest_param() (in module pytest_container.container)": [[0, "pytest_container.container.container_to_pytest_param"]], "containerfile (pytest_container.build.multistagebuild property)": [[0, "pytest_container.build.MultiStageBuild.containerfile"]], "containerfile (pytest_container.container.derivedcontainer attribute)": [[0, "pytest_container.container.DerivedContainer.containerfile"]], "containerfile_template (pytest_container.build.multistagebuild attribute)": [[0, "pytest_container.build.MultiStageBuild.containerfile_template"]], "containers (pytest_container.build.multistagebuild attribute)": [[0, "pytest_container.build.MultiStageBuild.containers"]], "containers (pytest_container.pod.pod attribute)": [[0, "pytest_container.pod.Pod.containers"]], "create_host_port_port_forward() (in module pytest_container.container)": [[0, "pytest_container.container.create_host_port_port_forward"]], "custom_entry_point (pytest_container.container.containerbase attribute)": [[0, "pytest_container.container.ContainerBase.custom_entry_point"]], "dead (pytest_container.inspect.containerstate attribute)": [[0, "pytest_container.inspect.ContainerState.dead"]], "destination (pytest_container.inspect.mount attribute)": [[0, "pytest_container.inspect.Mount.destination"]], "driver (pytest_container.inspect.volumemount attribute)": [[0, "pytest_container.inspect.VolumeMount.driver"]], "entry_point (pytest_container.container.containerbase attribute)": [[0, "pytest_container.container.ContainerBase.entry_point"]], "entrypoint (pytest_container.inspect.config attribute)": [[0, "pytest_container.inspect.Config.entrypoint"]], "env (pytest_container.inspect.config attribute)": [[0, "pytest_container.inspect.Config.env"]], "extra_build_args (pytest_container.container.containerlauncher attribute)": [[0, "pytest_container.container.ContainerLauncher.extra_build_args"]], "extra_build_args (pytest_container.pod.podlauncher attribute)": [[0, "pytest_container.pod.PodLauncher.extra_build_args"]], "extra_entrypoint_args (pytest_container.container.containerbase attribute)": [[0, "pytest_container.container.ContainerBase.extra_entrypoint_args"]], "extra_environment_variables (pytest_container.container.containerbase attribute)": [[0, "pytest_container.container.ContainerBase.extra_environment_variables"]], "extra_launch_args (pytest_container.container.containerbase attribute)": [[0, "pytest_container.container.ContainerBase.extra_launch_args"]], "extra_pod_create_args (pytest_container.pod.podlauncher attribute)": [[0, "pytest_container.pod.PodLauncher.extra_pod_create_args"]], "extra_run_args (pytest_container.container.containerlauncher attribute)": [[0, "pytest_container.container.ContainerLauncher.extra_run_args"]], "extra_run_args (pytest_container.pod.podlauncher attribute)": [[0, "pytest_container.pod.PodLauncher.extra_run_args"]], "filelock_filename (pytest_container.container.containerbase property)": [[0, "pytest_container.container.ContainerBase.filelock_filename"]], "flags (pytest_container.container.containervolumebase attribute)": [[0, "pytest_container.container.ContainerVolumeBase.flags"]], "forward_cli_args (pytest_container.inspect.portforwarding property)": [[0, "pytest_container.inspect.PortForwarding.forward_cli_args"]], "forwarded_ports (pytest_container.container.containerbase attribute)": [[0, "pytest_container.container.ContainerBase.forwarded_ports"]], "forwarded_ports (pytest_container.container.containerdata attribute)": [[0, "pytest_container.container.ContainerData.forwarded_ports"]], "forwarded_ports (pytest_container.pod.pod attribute)": [[0, "pytest_container.pod.Pod.forwarded_ports"]], "forwarded_ports (pytest_container.pod.poddata attribute)": [[0, "pytest_container.pod.PodData.forwarded_ports"]], "from_container_inspect() (pytest_container.inspect.healthcheck static method)": [[0, "pytest_container.inspect.HealthCheck.from_container_inspect"]], "get_base() (pytest_container.container.container method)": [[0, "pytest_container.container.Container.get_base"]], "get_base() (pytest_container.container.containerbaseabc method)": [[0, "pytest_container.container.ContainerBaseABC.get_base"]], "get_base() (pytest_container.container.derivedcontainer method)": [[0, "pytest_container.container.DerivedContainer.get_base"]], "get_container_health() (pytest_container.runtime.ociruntimeabc method)": [[0, "pytest_container.runtime.OciRuntimeABC.get_container_health"]], "get_extra_build_args() (in module pytest_container.helpers)": [[0, "pytest_container.helpers.get_extra_build_args"]], "get_extra_pod_create_args() (in module pytest_container.helpers)": [[0, "pytest_container.helpers.get_extra_pod_create_args"]], "get_extra_run_args() (in module pytest_container.helpers)": [[0, "pytest_container.helpers.get_extra_run_args"]], "get_image_id_from_iidfile() (pytest_container.runtime.ociruntimebase static method)": [[0, "pytest_container.runtime.OciRuntimeBase.get_image_id_from_iidfile"]], "get_image_size() (pytest_container.runtime.ociruntimebase method)": [[0, "pytest_container.runtime.OciRuntimeBase.get_image_size"]], "get_launch_cmd() (pytest_container.container.containerbase method)": [[0, "pytest_container.container.ContainerBase.get_launch_cmd"]], "get_selected_runtime() (in module pytest_container.runtime)": [[0, "pytest_container.runtime.get_selected_runtime"]], "get_volume_creator() (in module pytest_container.container)": [[0, "pytest_container.container.get_volume_creator"]], "health (pytest_container.inspect.containerstate attribute)": [[0, "pytest_container.inspect.ContainerState.health"]], "healthcheck (pytest_container.inspect.config attribute)": [[0, "pytest_container.inspect.Config.healthcheck"]], "healthcheck_timeout (pytest_container.container.containerbase attribute)": [[0, "pytest_container.container.ContainerBase.healthcheck_timeout"]], "host_path (pytest_container.container.bindmount attribute)": [[0, "pytest_container.container.BindMount.host_path"]], "host_port (pytest_container.inspect.portforwarding attribute)": [[0, "pytest_container.inspect.PortForwarding.host_port"]], "id (pytest_container.inspect.containerinspect attribute)": [[0, "pytest_container.inspect.ContainerInspect.id"]], "image (pytest_container.inspect.config attribute)": [[0, "pytest_container.inspect.Config.image"]], "image_format (pytest_container.container.derivedcontainer attribute)": [[0, "pytest_container.container.DerivedContainer.image_format"]], "image_hash (pytest_container.inspect.containerinspect attribute)": [[0, "pytest_container.inspect.ContainerInspect.image_hash"]], "image_url_or_id (pytest_container.container.containerdata attribute)": [[0, "pytest_container.container.ContainerData.image_url_or_id"]], "infra_container_id (pytest_container.pod.poddata attribute)": [[0, "pytest_container.pod.PodData.infra_container_id"]], "inspect (pytest_container.container.containerdata property)": [[0, "pytest_container.container.ContainerData.inspect"]], "inspect_container() (pytest_container.runtime.dockerruntime method)": [[0, "pytest_container.runtime.DockerRuntime.inspect_container"]], "inspect_container() (pytest_container.runtime.ociruntimeabc method)": [[0, "pytest_container.runtime.OciRuntimeABC.inspect_container"]], "inspect_container() (pytest_container.runtime.podmanruntime method)": [[0, "pytest_container.runtime.PodmanRuntime.inspect_container"]], "interval (pytest_container.inspect.healthcheck attribute)": [[0, "pytest_container.inspect.HealthCheck.interval"]], "labels (pytest_container.inspect.config attribute)": [[0, "pytest_container.inspect.Config.labels"]], "launch_container() (pytest_container.container.containerlauncher method)": [[0, "pytest_container.container.ContainerLauncher.launch_container"]], "launch_pod() (pytest_container.pod.podlauncher method)": [[0, "pytest_container.pod.PodLauncher.launch_pod"]], "local_image (pytest_container.container.containerbase property)": [[0, "pytest_container.container.ContainerBase.local_image"]], "major (pytest_container.runtime.version attribute)": [[0, "pytest_container.runtime.Version.major"]], "marks (pytest_container.runtime.toparammixin attribute)": [[0, "pytest_container.runtime.ToParamMixin.marks"]], "max_wait_time (pytest_container.inspect.healthcheck property)": [[0, "pytest_container.inspect.HealthCheck.max_wait_time"]], "minor (pytest_container.runtime.version attribute)": [[0, "pytest_container.runtime.Version.minor"]], "module": [[0, "module-pytest_container.build"], [0, "module-pytest_container.container"], [0, "module-pytest_container.helpers"], [0, "module-pytest_container.inspect"], [0, "module-pytest_container.logging"], [0, "module-pytest_container.plugin"], [0, "module-pytest_container.pod"], [0, "module-pytest_container.runtime"]], "mounts (pytest_container.inspect.containerinspect attribute)": [[0, "pytest_container.inspect.ContainerInspect.mounts"]], "name (pytest_container.inspect.volumemount attribute)": [[0, "pytest_container.inspect.VolumeMount.name"]], "network (pytest_container.inspect.containerinspect attribute)": [[0, "pytest_container.inspect.ContainerInspect.network"]], "oom_killed (pytest_container.inspect.containerstate attribute)": [[0, "pytest_container.inspect.ContainerState.oom_killed"]], "parse() (pytest_container.runtime.version static method)": [[0, "pytest_container.runtime.Version.parse"]], "patch (pytest_container.runtime.version attribute)": [[0, "pytest_container.runtime.Version.patch"]], "path (pytest_container.inspect.containerinspect attribute)": [[0, "pytest_container.inspect.ContainerInspect.path"]], "paused (pytest_container.inspect.containerstate attribute)": [[0, "pytest_container.inspect.ContainerState.paused"]], "pid (pytest_container.inspect.containerstate attribute)": [[0, "pytest_container.inspect.ContainerState.pid"]], "pod (pytest_container.pod.poddata attribute)": [[0, "pytest_container.pod.PodData.pod"]], "pod (pytest_container.pod.podlauncher attribute)": [[0, "pytest_container.pod.PodLauncher.pod"]], "pod() (in module pytest_container.plugin)": [[0, "pytest_container.plugin.pod"]], "pod_data (pytest_container.pod.podlauncher property)": [[0, "pytest_container.pod.PodLauncher.pod_data"]], "pod_from_pytest_param() (in module pytest_container.pod)": [[0, "pytest_container.pod.pod_from_pytest_param"]], "pod_id (pytest_container.pod.poddata attribute)": [[0, "pytest_container.pod.PodData.pod_id"]], "pod_name (pytest_container.pod.podlauncher attribute)": [[0, "pytest_container.pod.PodLauncher.pod_name"]], "pod_per_test() (in module pytest_container.plugin)": [[0, "pytest_container.plugin.pod_per_test"]], "ports (pytest_container.inspect.containernetworksettings attribute)": [[0, "pytest_container.inspect.ContainerNetworkSettings.ports"]], "prepare_build() (pytest_container.build.multistagebuild method)": [[0, "pytest_container.build.MultiStageBuild.prepare_build"]], "prepare_container() (pytest_container.container.container method)": [[0, "pytest_container.container.Container.prepare_container"]], "prepare_container() (pytest_container.container.containerbaseabc method)": [[0, "pytest_container.container.ContainerBaseABC.prepare_container"]], "prepare_container() (pytest_container.container.derivedcontainer method)": [[0, "pytest_container.container.DerivedContainer.prepare_container"]], "protocol (pytest_container.inspect.portforwarding attribute)": [[0, "pytest_container.inspect.PortForwarding.protocol"]], "pull_container() (pytest_container.container.container method)": [[0, "pytest_container.container.Container.pull_container"]], "pytest_container.build": [[0, "module-pytest_container.build"]], "pytest_container.container": [[0, "module-pytest_container.container"]], "pytest_container.helpers": [[0, "module-pytest_container.helpers"]], "pytest_container.inspect": [[0, "module-pytest_container.inspect"]], "pytest_container.logging": [[0, "module-pytest_container.logging"]], "pytest_container.plugin": [[0, "module-pytest_container.plugin"]], "pytest_container.pod": [[0, "module-pytest_container.pod"]], "pytest_container.runtime": [[0, "module-pytest_container.runtime"]], "release (pytest_container.runtime.version attribute)": [[0, "pytest_container.runtime.Version.release"]], "repo_name (pytest_container.build.gitrepositorybuild property)": [[0, "pytest_container.build.GitRepositoryBuild.repo_name"]], "repository_tag (pytest_container.build.gitrepositorybuild attribute)": [[0, "pytest_container.build.GitRepositoryBuild.repository_tag"]], "repository_url (pytest_container.build.gitrepositorybuild attribute)": [[0, "pytest_container.build.GitRepositoryBuild.repository_url"]], "restarting (pytest_container.inspect.containerstate attribute)": [[0, "pytest_container.inspect.ContainerState.restarting"]], "retries (pytest_container.inspect.healthcheck attribute)": [[0, "pytest_container.inspect.HealthCheck.retries"]], "rootdir (pytest_container.container.containerlauncher attribute)": [[0, "pytest_container.container.ContainerLauncher.rootdir"]], "rootdir (pytest_container.pod.podlauncher attribute)": [[0, "pytest_container.pod.PodLauncher.rootdir"]], "run_build_step() (pytest_container.build.multistagebuild static method)": [[0, "pytest_container.build.MultiStageBuild.run_build_step"]], "running (pytest_container.inspect.containerstate attribute)": [[0, "pytest_container.inspect.ContainerState.running"]], "rw (pytest_container.inspect.mount attribute)": [[0, "pytest_container.inspect.Mount.rw"]], "set_internal_logging_level() (in module pytest_container.logging)": [[0, "pytest_container.logging.set_internal_logging_level"]], "set_logging_level_from_cli_args() (in module pytest_container.helpers)": [[0, "pytest_container.helpers.set_logging_level_from_cli_args"]], "shared (pytest_container.container.containervolumebase attribute)": [[0, "pytest_container.container.ContainerVolumeBase.shared"]], "singleton (pytest_container.container.containerbase attribute)": [[0, "pytest_container.container.ContainerBase.singleton"]], "source (pytest_container.inspect.mount attribute)": [[0, "pytest_container.inspect.Mount.source"]], "start_period (pytest_container.inspect.healthcheck attribute)": [[0, "pytest_container.inspect.HealthCheck.start_period"]], "state (pytest_container.inspect.containerinspect attribute)": [[0, "pytest_container.inspect.ContainerInspect.state"]], "status (pytest_container.inspect.containerstate attribute)": [[0, "pytest_container.inspect.ContainerState.status"]], "stop_signal (pytest_container.inspect.config attribute)": [[0, "pytest_container.inspect.Config.stop_signal"]], "supports_healthcheck_inherit_from_base (pytest_container.runtime.dockerruntime property)": [[0, "pytest_container.runtime.DockerRuntime.supports_healthcheck_inherit_from_base"]], "supports_healthcheck_inherit_from_base (pytest_container.runtime.ociruntimeabc property)": [[0, "pytest_container.runtime.OciRuntimeABC.supports_healthcheck_inherit_from_base"]], "supports_healthcheck_inherit_from_base (pytest_container.runtime.podmanruntime property)": [[0, "pytest_container.runtime.PodmanRuntime.supports_healthcheck_inherit_from_base"]], "test_command (pytest_container.build.gitrepositorybuild property)": [[0, "pytest_container.build.GitRepositoryBuild.test_command"]], "timeout (pytest_container.inspect.healthcheck attribute)": [[0, "pytest_container.inspect.HealthCheck.timeout"]], "to_pytest_param() (pytest_container.runtime.toparammixin method)": [[0, "pytest_container.runtime.ToParamMixin.to_pytest_param"]], "tty (pytest_container.inspect.config attribute)": [[0, "pytest_container.inspect.Config.tty"]], "url (pytest_container.container.containerbase attribute)": [[0, "pytest_container.container.ContainerBase.url"]], "user (pytest_container.inspect.config attribute)": [[0, "pytest_container.inspect.Config.user"]], "version (pytest_container.runtime.dockerruntime property)": [[0, "pytest_container.runtime.DockerRuntime.version"]], "version (pytest_container.runtime.ociruntimeabc property)": [[0, "pytest_container.runtime.OciRuntimeABC.version"]], "version (pytest_container.runtime.podmanruntime property)": [[0, "pytest_container.runtime.PodmanRuntime.version"]], "volume (pytest_container.container.bindmountcreator attribute)": [[0, "pytest_container.container.BindMountCreator.volume"]], "volume (pytest_container.container.volumecreator attribute)": [[0, "pytest_container.container.VolumeCreator.volume"]], "volume_id (pytest_container.container.containervolume property)": [[0, "pytest_container.container.ContainerVolume.volume_id"]], "volume_mounts (pytest_container.container.containerbase attribute)": [[0, "pytest_container.container.ContainerBase.volume_mounts"]]}}) \ No newline at end of file diff --git a/usage.html b/usage.html index 638e5cb..f8f4dab 100644 --- a/usage.html +++ b/usage.html @@ -375,8 +375,8 @@

      Create and manage pods -
      -

      Entrypoint and stop signal handling

      +
      +

      Entrypoint, launch command and stop signal handling

      pytest_container will by default (when entry_point is set to AUTO) try to @@ -394,6 +394,12 @@

      Entrypoint and stop signal handlingBASH) or launch the image without specifying one (IMAGE).

      +

      The container under test is launched by default with no further +arguments. Additional arguments can be passed to the entrypoint via the +parameter +extra_entrypoint_args. The +list of arguments/parameters is appended to the container launch command line +after the container image.

      Changing the container entrypoint can have a catch with respect to the STOPSIGNAL defined by a container image. Container images that have non-shell entry points sometimes use a different signal for stopping the main @@ -436,7 +442,7 @@

      Navigation

    • Exposing ports from containers
    • Setting up bind mounts or container volumes
    • Create and manage pods
      • -
    • Entrypoint and stop signal handling
      • +
    • Entrypoint, launch command and stop signal handling

  • Changelog