refactor: pytest-docker fixtures

Liora Milbaum · nejch · commit 3e4781a66577 · 2022-10-16T20:37:39.000+02:00
diff --git a/tests/functional/conftest.py b/tests/functional/conftest.py
@@ -12,6 +12,7 @@
 import gitlab
 import gitlab.base
 from tests.functional import helpers
+from tests.functional.fixtures.docker import *  # noqa
 
 SLEEP_TIME = 10
 
@@ -34,11 +35,6 @@ def gitlab_version(gl) -> GitlabVersion:
     return GitlabVersion(major=major, minor=minor, patch=patch, revision=revision)
 
 
-@pytest.fixture(scope="session")
-def docker_compose_command():
-    return "docker compose"
-
-
 @pytest.fixture(scope="session")
 def fixture_dir(test_dir) -> pathlib.Path:
     return test_dir / "functional" / "fixtures"
@@ -160,26 +156,6 @@ def temp_dir() -> pathlib.Path:
     return pathlib.Path(tempfile.gettempdir())
 
 
-@pytest.fixture(scope="session")
-def docker_compose_file(fixture_dir):
-    return fixture_dir / "docker-compose.yml"
-
-
-@pytest.fixture(scope="session")
-def docker_compose_project_name():
-    """Set a consistent project name to enable optional reuse of containers."""
-    return "pytest-python-gitlab"
-
-
-@pytest.fixture(scope="session")
-def docker_cleanup(request):
-    """Conditionally keep containers around by overriding the cleanup command."""
-    if request.config.getoption("--keep-containers"):
-        # Print version and exit.
-        return "-v"
-    return "down -v"
-
-
 @pytest.fixture(scope="session")
 def check_is_alive():
     """
diff --git a/tests/functional/fixtures/__init__.py b/tests/functional/fixtures/__init__.py
diff --git a/tests/functional/fixtures/docker.py b/tests/functional/fixtures/docker.py
@@ -0,0 +1,30 @@
+"""
+pytest-docker fixture overrides.
+See https://github.com/avast/pytest-docker#available-fixtures.
+"""
+import pytest
+
+
+@pytest.fixture(scope="session")
+def docker_compose_command():
+    return "docker compose"
+
+
+@pytest.fixture(scope="session")
+def docker_compose_project_name():
+    """Set a consistent project name to enable optional reuse of containers."""
+    return "pytest-python-gitlab"
+
+
+@pytest.fixture(scope="session")
+def docker_compose_file(fixture_dir):
+    return fixture_dir / "docker-compose.yml"
+
+
+@pytest.fixture(scope="session")
+def docker_cleanup(request):
+    """Conditionally keep containers around by overriding the cleanup command."""
+    if request.config.getoption("--keep-containers"):
+        # Print version and exit.
+        return "-v"
+    return "down -v"
