pytest-docker 3.1.1__tar.gz → 3.2.0__tar.gz

{pytest-docker-3.1.1/src/pytest_docker.egg-info → pytest_docker-3.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: pytest-docker
-Version: 3.1.1
+Version: 3.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
@@ -13,6 +13,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Topic :: Utilities
 Classifier: Intended Audience :: Developers
@@ -47,7 +48,7 @@ Docker-based integration tests
 
 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
+Specify all necessary containers in a `docker-compose.yml` file and
 `pytest-docker` will spin them up for the duration of your tests.
 
 `pytest-docker` was originally created by André Caron.
@@ -79,7 +80,7 @@ Another option could be usage of [`compose-switch`](https://github.com/docker/co
 
 # Usage
 
-Here is an example of a test that depends on a HTTP service.
+Here is an example of a test that depends on an HTTP service.
 
 With a `docker-compose.yml` file like this (using the
 [httpbin](https://httpbin.org/) service):
@@ -131,7 +132,7 @@ def test_status_code(http_service):
     assert response.status_code == status
 ```
 
-By default this plugin will try to open `docker-compose.yml` in your
+By default, this plugin will try to open `docker-compose.yml` in your
 `tests` directory. If you need to use a custom location, override the
 `docker_compose_file` fixture inside your `conftest.py` file:
 
@@ -145,9 +146,43 @@ def docker_compose_file(pytestconfig):
     return os.path.join(str(pytestconfig.rootdir), "mycustomdir", "docker-compose.yml")
 ```
 
+To use [multiple compose files](https://docs.docker.com/compose/how-tos/multiple-compose-files/merge/),
+return a list of paths from the `docker_compose_file` fixture:
+
+```python
+import os
+import pytest
+
+
+@pytest.fixture(scope="session")
+def docker_compose_file(pytestconfig):
+    return [
+        os.path.join(str(pytestconfig.rootdir), "tests", "compose.yml"),
+        os.path.join(str(pytestconfig.rootdir), "tests", "compose.override.yml"),
+    ]
+```
+
+If you want to debug the test suite in your IDE (Pycharm, VsCode, etc.) and need to stop the test, the stack will be left running.
+To avoid creating multiple stacks, you can pin the project name and always teardown before starting a new stack:
+
+```python
+import pytest
+
+# Pin the project name to avoid creating multiple stacks
+@pytest.fixture(scope="session")
+def docker_compose_project_name() -> str:
+    return "my-compose-project"
+
+# Stop the stack before starting a new one
+@pytest.fixture(scope="session")
+def docker_setup_command():
+    return ["down -v", "up --build -d"]
+```
+
+
 ## Available fixtures
 
-By default the scope of the fixtures are `session` but can be changed with
+By default, the scope of the fixtures are `session` but can be changed with
 `pytest` command line option `--container-scope <scope>`:
 
 ```bash

{pytest-docker-3.1.1 → pytest_docker-3.2.0}/README.md

@@ -10,7 +10,7 @@ Docker-based integration tests
 
 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
+Specify all necessary containers in a `docker-compose.yml` file and
 `pytest-docker` will spin them up for the duration of your tests.
 
 `pytest-docker` was originally created by André Caron.
@@ -42,7 +42,7 @@ Another option could be usage of [`compose-switch`](https://github.com/docker/co
 
 # Usage
 
-Here is an example of a test that depends on a HTTP service.
+Here is an example of a test that depends on an HTTP service.
 
 With a `docker-compose.yml` file like this (using the
 [httpbin](https://httpbin.org/) service):
@@ -94,7 +94,7 @@ def test_status_code(http_service):
     assert response.status_code == status
 ```
 
-By default this plugin will try to open `docker-compose.yml` in your
+By default, this plugin will try to open `docker-compose.yml` in your
 `tests` directory. If you need to use a custom location, override the
 `docker_compose_file` fixture inside your `conftest.py` file:
 
@@ -108,9 +108,43 @@ def docker_compose_file(pytestconfig):
     return os.path.join(str(pytestconfig.rootdir), "mycustomdir", "docker-compose.yml")
 ```
 
+To use [multiple compose files](https://docs.docker.com/compose/how-tos/multiple-compose-files/merge/),
+return a list of paths from the `docker_compose_file` fixture:
+
+```python
+import os
+import pytest
+
+
+@pytest.fixture(scope="session")
+def docker_compose_file(pytestconfig):
+    return [
+        os.path.join(str(pytestconfig.rootdir), "tests", "compose.yml"),
+        os.path.join(str(pytestconfig.rootdir), "tests", "compose.override.yml"),
+    ]
+```
+
+If you want to debug the test suite in your IDE (Pycharm, VsCode, etc.) and need to stop the test, the stack will be left running.
+To avoid creating multiple stacks, you can pin the project name and always teardown before starting a new stack:
+
+```python
+import pytest
+
+# Pin the project name to avoid creating multiple stacks
+@pytest.fixture(scope="session")
+def docker_compose_project_name() -> str:
+    return "my-compose-project"
+
+# Stop the stack before starting a new one
+@pytest.fixture(scope="session")
+def docker_setup_command():
+    return ["down -v", "up --build -d"]
+```
+
+
 ## Available fixtures
 
-By default the scope of the fixtures are `session` but can be changed with
+By default, the scope of the fixtures are `session` but can be changed with
 `pytest` command line option `--container-scope <scope>`:
 
 ```bash

{pytest-docker-3.1.1 → pytest_docker-3.2.0}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = pytest-docker
-version = 3.1.1
+version = 3.2.0
 description = Simple pytest fixtures for Docker and Docker Compose based tests
 long_description = file: README.md
 long_description_content_type = text/markdown
@@ -16,6 +16,7 @@ classifiers =
 	Programming Language :: Python :: 3.10
 	Programming Language :: Python :: 3.11
 	Programming Language :: Python :: 3.12
+	Programming Language :: Python :: 3.13
 	License :: OSI Approved :: MIT License
 	Topic :: Utilities
 	Intended Audience :: Developers

{pytest-docker-3.1.1 → pytest_docker-3.2.0}/src/pytest_docker/plugin.py

@@ -21,10 +21,11 @@ def containers_scope(fixture_name: str, config: Config) -> Any:  # pylint: disab
     return config.getoption("--container-scope", "session")
 
 
-def execute(command: str, success_codes: Iterable[int] = (0,)) -> Union[bytes, Any]:
+def execute(command: str, success_codes: Iterable[int] = (0,), ignore_stderr: bool = False) -> Union[bytes, Any]:
     """Run a shell command."""
     try:
-        output = subprocess.check_output(command, stderr=subprocess.STDOUT, shell=True)
+        stderr_pipe = subprocess.DEVNULL if ignore_stderr else subprocess.STDOUT
+        output = subprocess.check_output(command, stderr=stderr_pipe, shell=True)
         status = 0
     except subprocess.CalledProcessError as error:
         output = error.output or b""
@@ -132,12 +133,12 @@ class DockerComposeExecutor:
     _compose_files: Any = attr.ib(converter=str_to_list)
     _compose_project_name: str = attr.ib()
 
-    def execute(self, subcommand: str) -> Union[bytes, Any]:
+    def execute(self, subcommand: str, **kwargs: Any) -> Union[bytes, Any]:
         command = self._compose_command
         for compose_file in self._compose_files:
             command += ' -f "{}"'.format(compose_file)
         command += ' -p "{}" {}'.format(self._compose_project_name, subcommand)
-        return execute(command)
+        return execute(command, **kwargs)
 
 
 @pytest.fixture(scope=containers_scope)

{pytest-docker-3.1.1 → pytest_docker-3.2.0/src/pytest_docker.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: pytest-docker
-Version: 3.1.1
+Version: 3.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
@@ -13,6 +13,7 @@ Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Topic :: Utilities
 Classifier: Intended Audience :: Developers
@@ -47,7 +48,7 @@ Docker-based integration tests
 
 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
+Specify all necessary containers in a `docker-compose.yml` file and
 `pytest-docker` will spin them up for the duration of your tests.
 
 `pytest-docker` was originally created by André Caron.
@@ -79,7 +80,7 @@ Another option could be usage of [`compose-switch`](https://github.com/docker/co
 
 # Usage
 
-Here is an example of a test that depends on a HTTP service.
+Here is an example of a test that depends on an HTTP service.
 
 With a `docker-compose.yml` file like this (using the
 [httpbin](https://httpbin.org/) service):
@@ -131,7 +132,7 @@ def test_status_code(http_service):
     assert response.status_code == status
 ```
 
-By default this plugin will try to open `docker-compose.yml` in your
+By default, this plugin will try to open `docker-compose.yml` in your
 `tests` directory. If you need to use a custom location, override the
 `docker_compose_file` fixture inside your `conftest.py` file:
 
@@ -145,9 +146,43 @@ def docker_compose_file(pytestconfig):
     return os.path.join(str(pytestconfig.rootdir), "mycustomdir", "docker-compose.yml")
 ```
 
+To use [multiple compose files](https://docs.docker.com/compose/how-tos/multiple-compose-files/merge/),
+return a list of paths from the `docker_compose_file` fixture:
+
+```python
+import os
+import pytest
+
+
+@pytest.fixture(scope="session")
+def docker_compose_file(pytestconfig):
+    return [
+        os.path.join(str(pytestconfig.rootdir), "tests", "compose.yml"),
+        os.path.join(str(pytestconfig.rootdir), "tests", "compose.override.yml"),
+    ]
+```
+
+If you want to debug the test suite in your IDE (Pycharm, VsCode, etc.) and need to stop the test, the stack will be left running.
+To avoid creating multiple stacks, you can pin the project name and always teardown before starting a new stack:
+
+```python
+import pytest
+
+# Pin the project name to avoid creating multiple stacks
+@pytest.fixture(scope="session")
+def docker_compose_project_name() -> str:
+    return "my-compose-project"
+
+# Stop the stack before starting a new one
+@pytest.fixture(scope="session")
+def docker_setup_command():
+    return ["down -v", "up --build -d"]
+```
+
+
 ## Available fixtures
 
-By default the scope of the fixtures are `session` but can be changed with
+By default, the scope of the fixtures are `session` but can be changed with
 `pytest` command line option `--container-scope <scope>`:
 
 ```bash