Skip to content

Commit

Permalink
Deploying to gh-pages from @ 64aba0d 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
dcermak committed Nov 28, 2023
1 parent 635935b commit 01721e5
Show file tree
Hide file tree
Showing 8 changed files with 46 additions and 12 deletions.
12 changes: 10 additions & 2 deletions _sources/usage.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
24 changes: 19 additions & 5 deletions api.html

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions changelog.html
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,10 @@ <h2>Next Release<a class="headerlink" href="#next-release" title="Permalink to t
</ul>
<p>Improvements and new features:</p>
<ul class="simple">
<li><p>Add property
<a class="reference internal" href="api.html#pytest_container.container.ContainerBase.extra_entrypoint_args" title="pytest_container.container.ContainerBase.extra_entrypoint_args"><code class="xref py py-attr docutils literal notranslate"><span class="pre">extra_entrypoint_args</span></code></a> to
support appending arguments to the container launch command</p></li>
<li><p>Add support for Python 3.12</p></li>
<li><p>Add property <a class="reference internal" href="api.html#pytest_container.inspect.PortForwarding.bind_ip" title="pytest_container.inspect.PortForwarding.bind_ip"><code class="xref py py-attr docutils literal notranslate"><span class="pre">bind_ip</span></code></a>
to support binding to arbitrary IP addresses.</p></li>
<li><p>Fix <a class="reference internal" href="api.html#pytest_container.inspect.PortForwarding.host_port" title="pytest_container.inspect.PortForwarding.host_port"><code class="xref py py-attr docutils literal notranslate"><span class="pre">host_port</span></code></a> being
Expand Down
2 changes: 2 additions & 0 deletions genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -262,6 +262,8 @@ <h2 id="E">E</h2>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="api.html#pytest_container.container.ContainerBase.extra_entrypoint_args">extra_entrypoint_args (pytest_container.container.ContainerBase attribute)</a>
</li>
<li><a href="api.html#pytest_container.container.ContainerBase.extra_environment_variables">extra_environment_variables (pytest_container.container.ContainerBase attribute)</a>
</li>
<li><a href="api.html#pytest_container.container.ContainerBase.extra_launch_args">extra_launch_args (pytest_container.container.ContainerBase attribute)</a>
Expand Down
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@ <h2>Contents<a class="headerlink" href="#contents" title="Permalink to this head
<li class="toctree-l2"><a class="reference internal" href="usage.html#exposing-ports-from-containers">Exposing ports from containers</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#setting-up-bind-mounts-or-container-volumes">Setting up bind mounts or container volumes</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#create-and-manage-pods">Create and manage pods</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#entrypoint-and-stop-signal-handling">Entrypoint and stop signal handling</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#entrypoint-launch-command-and-stop-signal-handling">Entrypoint, launch command and stop signal handling</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a><ul>
Expand Down
Binary file modified objects.inv
Binary file not shown.
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

12 changes: 9 additions & 3 deletions usage.html
Original file line number Diff line number Diff line change
Expand Up @@ -375,8 +375,8 @@ <h2>Create and manage pods<a class="headerlink" href="#create-and-manage-pods" t
</pre></div>
</div>
</section>
<section id="entrypoint-and-stop-signal-handling">
<h2>Entrypoint and stop signal handling<a class="headerlink" href="#entrypoint-and-stop-signal-handling" title="Permalink to this heading"></a></h2>
<section id="entrypoint-launch-command-and-stop-signal-handling">
<h2>Entrypoint, launch command and stop signal handling<a class="headerlink" href="#entrypoint-launch-command-and-stop-signal-handling" title="Permalink to this heading"></a></h2>
<p><code class="docutils literal notranslate"><span class="pre">pytest_container</span></code> will by default (when
<a class="reference internal" href="api.html#pytest_container.container.ContainerBase.entry_point" title="pytest_container.container.ContainerBase.entry_point"><code class="xref py py-attr docutils literal notranslate"><span class="pre">entry_point</span></code></a> is set to
<a class="reference internal" href="api.html#pytest_container.container.EntrypointSelection.AUTO" title="pytest_container.container.EntrypointSelection.AUTO"><code class="xref py py-attr docutils literal notranslate"><span class="pre">AUTO</span></code></a>) try to
Expand All @@ -394,6 +394,12 @@ <h2>Entrypoint and stop signal handling<a class="headerlink" href="#entrypoint-a
(<a class="reference internal" href="api.html#pytest_container.container.EntrypointSelection.BASH" title="pytest_container.container.EntrypointSelection.BASH"><code class="xref py py-attr docutils literal notranslate"><span class="pre">BASH</span></code></a>) or launch the
image without specifying one
(<a class="reference internal" href="api.html#pytest_container.container.EntrypointSelection.IMAGE" title="pytest_container.container.EntrypointSelection.IMAGE"><code class="xref py py-attr docutils literal notranslate"><span class="pre">IMAGE</span></code></a>).</p>
<p>The container under test is launched by default with no further
arguments. Additional arguments can be passed to the entrypoint via the
parameter
<a class="reference internal" href="api.html#pytest_container.container.ContainerBase.extra_entrypoint_args" title="pytest_container.container.ContainerBase.extra_entrypoint_args"><code class="xref py py-attr docutils literal notranslate"><span class="pre">extra_entrypoint_args</span></code></a>. The
list of arguments/parameters is appended to the container launch command line
after the container image.</p>
<p>Changing the container entrypoint can have a catch with respect to the
<code class="docutils literal notranslate"><span class="pre">STOPSIGNAL</span></code> defined by a container image. Container images that have
non-shell entry points sometimes use a different signal for stopping the main
Expand Down Expand Up @@ -436,7 +442,7 @@ <h3>Navigation</h3>
<li class="toctree-l2"><a class="reference internal" href="#exposing-ports-from-containers">Exposing ports from containers</a></li>
<li class="toctree-l2"><a class="reference internal" href="#setting-up-bind-mounts-or-container-volumes">Setting up bind mounts or container volumes</a></li>
<li class="toctree-l2"><a class="reference internal" href="#create-and-manage-pods">Create and manage pods</a></li>
<li class="toctree-l2"><a class="reference internal" href="#entrypoint-and-stop-signal-handling">Entrypoint and stop signal handling</a></li>
<li class="toctree-l2"><a class="reference internal" href="#entrypoint-launch-command-and-stop-signal-handling">Entrypoint, launch command and stop signal handling</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="changelog.html">Changelog</a></li>
Expand Down

0 comments on commit 01721e5

Please sign in to comment.