pytest-docker 3.1.0__tar.gz → 3.1.2__tar.gz

{pytest-docker-3.1.0/src/pytest_docker.egg-info → pytest_docker-3.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.2
 Name: pytest-docker
-Version: 3.1.0
+Version: 3.1.2
 Summary: Simple pytest fixtures for Docker and Docker Compose based tests
 Home-page: https://github.com/avast/pytest-docker
 Author: Max K., Andre Caron
@@ -12,6 +12,8 @@ Classifier: Programming Language :: Python :: 3.8
 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
@@ -46,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.
@@ -78,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):
@@ -130,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:
 
@@ -144,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.0 → pytest_docker-3.1.2}/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.0 → pytest_docker-3.1.2}/setup.cfg

@@ -1,6 +1,6 @@
 [metadata]
 name = pytest-docker
-version = 3.1.0
+version = 3.1.2
 description = Simple pytest fixtures for Docker and Docker Compose based tests
 long_description = file: README.md
 long_description_content_type = text/markdown
@@ -15,6 +15,8 @@ classifiers =
 	Programming Language :: Python :: 3.9
 	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
@@ -23,7 +25,7 @@ classifiers =
 	Operating System :: Microsoft :: Windows
 
 [options]
-python_requires = >= 3.8
+python_requires = >=3.8
 package_dir = 
 	=src
 packages = pytest_docker

{pytest-docker-3.1.0 → pytest_docker-3.1.2}/src/pytest_docker/plugin.py

@@ -150,7 +150,7 @@ def docker_compose_command() -> str:
 
 
 @pytest.fixture(scope=containers_scope)
-def docker_compose_file(pytestconfig: Any) -> str:
+def docker_compose_file(pytestconfig: Any) -> Union[List[str], str]:
     """Get an absolute path to the  `docker-compose.yml` file. Override this
     fixture in your tests if you need a custom location."""
 
@@ -194,7 +194,7 @@ def docker_setup() -> Union[List[str], str]:
 @contextlib.contextmanager
 def get_docker_services(
     docker_compose_command: str,
-    docker_compose_file: str,
+    docker_compose_file: Union[List[str], str],
     docker_compose_project_name: str,
     docker_setup: Union[List[str], str],
     docker_cleanup: Union[List[str], str],
@@ -227,7 +227,7 @@ def get_docker_services(
 @pytest.fixture(scope=containers_scope)
 def docker_services(
     docker_compose_command: str,
-    docker_compose_file: str,
+    docker_compose_file: Union[List[str], str],
     docker_compose_project_name: str,
     docker_setup: str,
     docker_cleanup: str,

{pytest-docker-3.1.0 → pytest_docker-3.1.2/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.0
+Version: 3.1.2
 Summary: Simple pytest fixtures for Docker and Docker Compose based tests
 Home-page: https://github.com/avast/pytest-docker
 Author: Max K., Andre Caron
@@ -12,6 +12,8 @@ Classifier: Programming Language :: Python :: 3.8
 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
@@ -46,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.
@@ -78,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):
@@ -130,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:
 
@@ -144,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