pytest-docker 2.1.0__tar.gz → 2.2.0__tar.gz

{pytest-docker-2.1.0/src/pytest_docker.egg-info → pytest-docker-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pytest-docker
-Version: 2.1.0
+Version: 2.2.0
 Summary: Simple pytest fixtures for Docker and Docker Compose based tests
 Home-page: https://github.com/avast/pytest-docker
 Author: Max K., Andre Caron
@@ -33,13 +33,14 @@ Requires-Dist: pytest-pycodestyle<3.0,>=2.0.0; extra == "tests"
 
 Docker-based integration tests
 =====
+
 [![PyPI version](https://img.shields.io/pypi/v/pytest-docker?color=green)](https://pypi.org/project/pytest-docker/)
 [![Build Status](https://github.com/avast/pytest-docker/actions/workflows/tests.yaml/badge.svg?branch=master)](https://github.com/avast/pytest-docker/actions/workflows/tests.yaml)
 [![Python versions](https://img.shields.io/pypi/pyversions/pytest-docker)](https://pypi.org/project/pytest-docker/)
 [![Code style](https://img.shields.io/badge/formatted%20with-black-black)](https://github.com/psf/black)
 
-
 # Description
+
 Simple [pytest](http://doc.pytest.org/) fixtures that help you write integration
 tests with Docker and [Docker Compose](https://docs.docker.com/compose/).
 Specify all necessary containers in a `docker-compose.yml` file and and
@@ -51,6 +52,7 @@ This package is tested with Python versions `3.6`, `3.7`, `3.8` and
 `pytest-docker` was originally created by André Caron.
 
 # Installation
+
 Install `pytest-docker` with `pip` or add it to your test requirements.
 
 By default, it uses the `docker compose` command, so it relies on the Compose plugin for Docker (also called Docker Compose V2).
@@ -67,6 +69,7 @@ def docker_compose_command() -> str:
 ```
 
 If you want to use the pip-distributed version of `docker-compose` command, you can install it using
+
 ```
 pip install pytest-docker[docker-compose-v1]
 ```
@@ -74,6 +77,7 @@ pip install pytest-docker[docker-compose-v1]
 Another option could be usage of [`compose-switch`](https://github.com/docker/compose-switch).
 
 # Usage
+
 Here is an example of a test that depends on a HTTP service.
 
 With a `docker-compose.yml` file like this (using the
@@ -150,7 +154,7 @@ pytest --container-scope <scope> <test_directory>
 ```
 
 For available scopes and descriptions
-see https://docs.pytest.org/en/6.2.x/fixture.html#fixture-scopes
+see <https://docs.pytest.org/en/6.2.x/fixture.html#fixture-scopes>
 
 ### `docker_ip`
 
@@ -179,29 +183,33 @@ Docker Compose V1, change this fixture to return `docker-compose`.
 
 ### `docker_setup`
 
-Get the docker_compose command to be executed for test spawn actions.
+Get the list of docker_compose commands to be executed for test spawn actions.
 Override this fixture in your tests if you need to change spawn actions.
 Returning anything that would evaluate to False will skip this command.
 
 ### `docker_cleanup`
 
-Get the docker_compose command to be executed for test clean-up actions.
+Get the list of docker_compose commands to be executed for test clean-up actions.
 Override this fixture in your tests if you need to change clean-up actions.
 Returning anything that would evaluate to False will skip this command.
 
-
 # Development
+
 Use of a virtual environment is recommended. See the
 [venv](https://docs.python.org/3/library/venv.html) package for more
 information.
 
 First, install `pytest-docker` and its test dependencies:
 
-	pip install -e ".[tests]"
+```bash
+pip install -e ".[tests]"
+```
 
 Run tests with
 
-	pytest -c setup.cfg
+```bash
+pytest -c setup.cfg
+```
 
 to make sure that the correct configuration is used. This is also how tests are
 run in CI.
@@ -210,9 +218,9 @@ Use [black](https://pypi.org/project/black/) with default settings for
 formatting. You can also use `pylint` with `setup.cfg` as the configuration
 file.
 
-
 # Contributing
-This pytest plug-in and its source code are made available to you under a MIT
+
+This `pytest` plug-in and its source code are made available to you under a MIT
 license. It is safe to use in commercial and closed-source applications. Read
 the license for details!
 

{pytest-docker-2.1.0 → pytest-docker-2.2.0}/README.md

@@ -1,12 +1,13 @@
 Docker-based integration tests
 =====
+
 [![PyPI version](https://img.shields.io/pypi/v/pytest-docker?color=green)](https://pypi.org/project/pytest-docker/)
 [![Build Status](https://github.com/avast/pytest-docker/actions/workflows/tests.yaml/badge.svg?branch=master)](https://github.com/avast/pytest-docker/actions/workflows/tests.yaml)
 [![Python versions](https://img.shields.io/pypi/pyversions/pytest-docker)](https://pypi.org/project/pytest-docker/)
 [![Code style](https://img.shields.io/badge/formatted%20with-black-black)](https://github.com/psf/black)
 
-
 # Description
+
 Simple [pytest](http://doc.pytest.org/) fixtures that help you write integration
 tests with Docker and [Docker Compose](https://docs.docker.com/compose/).
 Specify all necessary containers in a `docker-compose.yml` file and and
@@ -18,6 +19,7 @@ This package is tested with Python versions `3.6`, `3.7`, `3.8` and
 `pytest-docker` was originally created by André Caron.
 
 # Installation
+
 Install `pytest-docker` with `pip` or add it to your test requirements.
 
 By default, it uses the `docker compose` command, so it relies on the Compose plugin for Docker (also called Docker Compose V2).
@@ -34,6 +36,7 @@ def docker_compose_command() -> str:
 ```
 
 If you want to use the pip-distributed version of `docker-compose` command, you can install it using
+
 ```
 pip install pytest-docker[docker-compose-v1]
 ```
@@ -41,6 +44,7 @@ pip install pytest-docker[docker-compose-v1]
 Another option could be usage of [`compose-switch`](https://github.com/docker/compose-switch).
 
 # Usage
+
 Here is an example of a test that depends on a HTTP service.
 
 With a `docker-compose.yml` file like this (using the
@@ -117,7 +121,7 @@ pytest --container-scope <scope> <test_directory>
 ```
 
 For available scopes and descriptions
-see https://docs.pytest.org/en/6.2.x/fixture.html#fixture-scopes
+see <https://docs.pytest.org/en/6.2.x/fixture.html#fixture-scopes>
 
 ### `docker_ip`
 
@@ -146,29 +150,33 @@ Docker Compose V1, change this fixture to return `docker-compose`.
 
 ### `docker_setup`
 
-Get the docker_compose command to be executed for test spawn actions.
+Get the list of docker_compose commands to be executed for test spawn actions.
 Override this fixture in your tests if you need to change spawn actions.
 Returning anything that would evaluate to False will skip this command.
 
 ### `docker_cleanup`
 
-Get the docker_compose command to be executed for test clean-up actions.
+Get the list of docker_compose commands to be executed for test clean-up actions.
 Override this fixture in your tests if you need to change clean-up actions.
 Returning anything that would evaluate to False will skip this command.
 
-
 # Development
+
 Use of a virtual environment is recommended. See the
 [venv](https://docs.python.org/3/library/venv.html) package for more
 information.
 
 First, install `pytest-docker` and its test dependencies:
 
-	pip install -e ".[tests]"
+```bash
+pip install -e ".[tests]"
+```
 
 Run tests with
 
-	pytest -c setup.cfg
+```bash
+pytest -c setup.cfg
+```
 
 to make sure that the correct configuration is used. This is also how tests are
 run in CI.
@@ -177,9 +185,9 @@ Use [black](https://pypi.org/project/black/) with default settings for
 formatting. You can also use `pylint` with `setup.cfg` as the configuration
 file.
 
-
 # Contributing
-This pytest plug-in and its source code are made available to you under a MIT
+
+This `pytest` plug-in and its source code are made available to you under a MIT
 license. It is safe to use in commercial and closed-source applications. Read
 the license for details!
 

{pytest-docker-2.1.0 → pytest-docker-2.2.0}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = pytest-docker
-version = 2.1.0
+version = 2.2.0
 description = Simple pytest fixtures for Docker and Docker Compose based tests
 long_description = file: README.md
 long_description_content_type = text/markdown

{pytest-docker-2.1.0 → pytest-docker-2.2.0}/src/pytest_docker/__init__.py

@@ -1,6 +1,5 @@
 import pytest
 from .plugin import (
-    docker_cleanup,
     docker_compose_command,
     docker_compose_file,
     docker_compose_project_name,
@@ -11,7 +10,7 @@ from .plugin import (
 )
 
 __all__ = [
-    "docker_cleanup",
+    "docker_compose_command",
     "docker_compose_file",
     "docker_compose_project_name",
     "docker_ip",

{pytest-docker-2.1.0 → pytest-docker-2.2.0}/src/pytest_docker/plugin.py

@@ -162,8 +162,7 @@ def docker_compose_project_name():
 
 
 def get_cleanup_command():
-
-    return "down -v"
+    return ["down -v"]
 
 
 @pytest.fixture(scope=containers_scope)
@@ -176,8 +175,7 @@ def docker_cleanup():
 
 
 def get_setup_command():
-
-    return "up --build -d"
+    return ["up --build -d"]
 
 
 @pytest.fixture(scope=containers_scope)
@@ -203,7 +201,11 @@ def get_docker_services(
 
     # setup containers.
     if docker_setup:
-        docker_compose.execute(docker_setup)
+        # Maintain backwards compatibility with the string format.
+        if isinstance(docker_setup, str):
+            docker_setup = [docker_setup]
+        for command in docker_setup:
+            docker_compose.execute(command)
 
     try:
         # Let test(s) run.
@@ -211,7 +213,11 @@ def get_docker_services(
     finally:
         # Clean up.
         if docker_cleanup:
-            docker_compose.execute(docker_cleanup)
+            # Maintain backwards compatibility with the string format.
+            if isinstance(docker_cleanup, str):
+                docker_cleanup = [docker_cleanup]
+            for command in docker_cleanup:
+                docker_compose.execute(command)
 
 
 @pytest.fixture(scope=containers_scope)

{pytest-docker-2.1.0 → pytest-docker-2.2.0/src/pytest_docker.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pytest-docker
-Version: 2.1.0
+Version: 2.2.0
 Summary: Simple pytest fixtures for Docker and Docker Compose based tests
 Home-page: https://github.com/avast/pytest-docker
 Author: Max K., Andre Caron
@@ -33,13 +33,14 @@ Requires-Dist: pytest-pycodestyle<3.0,>=2.0.0; extra == "tests"
 
 Docker-based integration tests
 =====
+
 [![PyPI version](https://img.shields.io/pypi/v/pytest-docker?color=green)](https://pypi.org/project/pytest-docker/)
 [![Build Status](https://github.com/avast/pytest-docker/actions/workflows/tests.yaml/badge.svg?branch=master)](https://github.com/avast/pytest-docker/actions/workflows/tests.yaml)
 [![Python versions](https://img.shields.io/pypi/pyversions/pytest-docker)](https://pypi.org/project/pytest-docker/)
 [![Code style](https://img.shields.io/badge/formatted%20with-black-black)](https://github.com/psf/black)
 
-
 # Description
+
 Simple [pytest](http://doc.pytest.org/) fixtures that help you write integration
 tests with Docker and [Docker Compose](https://docs.docker.com/compose/).
 Specify all necessary containers in a `docker-compose.yml` file and and
@@ -51,6 +52,7 @@ This package is tested with Python versions `3.6`, `3.7`, `3.8` and
 `pytest-docker` was originally created by André Caron.
 
 # Installation
+
 Install `pytest-docker` with `pip` or add it to your test requirements.
 
 By default, it uses the `docker compose` command, so it relies on the Compose plugin for Docker (also called Docker Compose V2).
@@ -67,6 +69,7 @@ def docker_compose_command() -> str:
 ```
 
 If you want to use the pip-distributed version of `docker-compose` command, you can install it using
+
 ```
 pip install pytest-docker[docker-compose-v1]
 ```
@@ -74,6 +77,7 @@ pip install pytest-docker[docker-compose-v1]
 Another option could be usage of [`compose-switch`](https://github.com/docker/compose-switch).
 
 # Usage
+
 Here is an example of a test that depends on a HTTP service.
 
 With a `docker-compose.yml` file like this (using the
@@ -150,7 +154,7 @@ pytest --container-scope <scope> <test_directory>
 ```
 
 For available scopes and descriptions
-see https://docs.pytest.org/en/6.2.x/fixture.html#fixture-scopes
+see <https://docs.pytest.org/en/6.2.x/fixture.html#fixture-scopes>
 
 ### `docker_ip`
 
@@ -179,29 +183,33 @@ Docker Compose V1, change this fixture to return `docker-compose`.
 
 ### `docker_setup`
 
-Get the docker_compose command to be executed for test spawn actions.
+Get the list of docker_compose commands to be executed for test spawn actions.
 Override this fixture in your tests if you need to change spawn actions.
 Returning anything that would evaluate to False will skip this command.
 
 ### `docker_cleanup`
 
-Get the docker_compose command to be executed for test clean-up actions.
+Get the list of docker_compose commands to be executed for test clean-up actions.
 Override this fixture in your tests if you need to change clean-up actions.
 Returning anything that would evaluate to False will skip this command.
 
-
 # Development
+
 Use of a virtual environment is recommended. See the
 [venv](https://docs.python.org/3/library/venv.html) package for more
 information.
 
 First, install `pytest-docker` and its test dependencies:
 
-	pip install -e ".[tests]"
+```bash
+pip install -e ".[tests]"
+```
 
 Run tests with
 
-	pytest -c setup.cfg
+```bash
+pytest -c setup.cfg
+```
 
 to make sure that the correct configuration is used. This is also how tests are
 run in CI.
@@ -210,9 +218,9 @@ Use [black](https://pypi.org/project/black/) with default settings for
 formatting. You can also use `pylint` with `setup.cfg` as the configuration
 file.
 
-
 # Contributing
-This pytest plug-in and its source code are made available to you under a MIT
+
+This `pytest` plug-in and its source code are made available to you under a MIT
 license. It is safe to use in commercial and closed-source applications. Read
 the license for details!
 

{pytest-docker-2.1.0 → pytest-docker-2.2.0}/tests/test_docker_services.py

@@ -174,3 +174,121 @@ def test_wait_until_responsive_timeout():
             )
         assert sleep.call_args_list == [mock.call(1.0), mock.call(1.0), mock.call(1.0)]
     assert str(exc.value) == ("Timeout reached while waiting on service!")
+
+
+def test_single_commands():
+    """Ensures backwards compatibility with single command strings for setup and cleanup."""
+
+    with mock.patch("subprocess.check_output") as check_output:
+        check_output.returncode = 0
+
+        assert check_output.call_count == 0
+
+        # The fixture is a context-manager.
+        with get_docker_services(
+            "docker compose",
+            "docker-compose.yml",
+            docker_compose_project_name="pytest123",
+            docker_setup="up --build -d",
+            docker_cleanup="down -v",
+        ) as services:
+            assert isinstance(services, Services)
+
+            assert check_output.call_count == 1
+
+            # Can request port for services.
+            port = services.port_for("hello", 80)
+            assert port == 1
+
+            assert check_output.call_count == 2
+
+            # 2nd request for same service should hit the cache.
+            port = services.port_for("hello", 80)
+            assert port == 1
+
+            assert check_output.call_count == 2
+
+        assert check_output.call_count == 3
+
+    # Both should have been called.
+    assert check_output.call_args_list == [
+        mock.call(
+            'docker compose -f "docker-compose.yml" -p "pytest123" up --build -d',
+            stderr=subprocess.STDOUT,
+            shell=True,
+        ),
+        mock.call(
+            'docker compose -f "docker-compose.yml" -p "pytest123" port hello 80',
+            stderr=subprocess.STDOUT,
+            shell=True,
+        ),
+        mock.call(
+            'docker compose -f "docker-compose.yml" -p "pytest123" down -v',
+            stderr=subprocess.STDOUT,
+            shell=True,
+        ),
+    ]
+
+
+def test_multiple_commands():
+    """Multiple startup and cleanup commands should be executed."""
+
+    with mock.patch("subprocess.check_output") as check_output:
+        check_output.returncode = 0
+
+        assert check_output.call_count == 0
+
+        # The fixture is a context-manager.
+        with get_docker_services(
+            "docker compose",
+            "docker-compose.yml",
+            docker_compose_project_name="pytest123",
+            docker_setup=["ps", "up --build -d"],
+            docker_cleanup=["down -v", "ps"],
+        ) as services:
+            assert isinstance(services, Services)
+
+            assert check_output.call_count == 2
+
+            # Can request port for services.
+            port = services.port_for("hello", 80)
+            assert port == 1
+
+            assert check_output.call_count == 3
+
+            # 2nd request for same service should hit the cache.
+            port = services.port_for("hello", 80)
+            assert port == 1
+
+            assert check_output.call_count == 3
+
+        assert check_output.call_count == 5
+
+    # Both should have been called.
+    assert check_output.call_args_list == [
+        mock.call(
+            'docker compose -f "docker-compose.yml" -p "pytest123" ps',
+            stderr=subprocess.STDOUT,
+            shell=True,
+        ),
+        mock.call(
+            'docker compose -f "docker-compose.yml" -p "pytest123" up --build -d',
+            stderr=subprocess.STDOUT,
+            shell=True,
+        ),
+        mock.call(
+            'docker compose -f "docker-compose.yml" -p "pytest123" port hello 80',
+            stderr=subprocess.STDOUT,
+            shell=True,
+        ),
+        mock.call(
+            'docker compose -f "docker-compose.yml" -p "pytest123" down -v',
+            stderr=subprocess.STDOUT,
+            shell=True,
+        ),
+        mock.call(
+            'docker compose -f "docker-compose.yml" -p "pytest123" ps',
+            stderr=subprocess.STDOUT,
+            shell=True,
+        ),
+    ]

{pytest-docker-2.1.0 → pytest-docker-2.2.0}/tests/test_fixtures.py

@@ -13,14 +13,16 @@ def test_docker_compose_project(docker_compose_project_name):
 
 
 def test_docker_cleanup(docker_cleanup):
-    assert docker_cleanup == "down -v"
+    assert docker_cleanup == ["down -v"]
+
 
 
 def test_docker_setup(docker_setup):
-    assert docker_setup == "up --build -d"
+    assert docker_setup == ["up --build -d"]
+
 
 
-def test_docker_compose_comand(docker_compose_command):
+def test_docker_compose_command(docker_compose_command):
     assert docker_compose_command == "docker compose"