🧼 Cleanup network name after test run

Author: bdsoha

.github/workflows/tag.yaml

@@ -22,7 +22,7 @@ jobs:
 
       - name: 🔢 Extract version from __init__.py
         id: extract_version
-        run: |
+        run: |-
           VERSION=$(grep -oP '__version__ = "\K[^"]+' src/kloudkit/testshed/__init__.py)
           echo "VERSION=$VERSION" >> "$GITHUB_ENV"
 

README.md

@@ -115,12 +115,11 @@ from kloudkit.testshed.docker import InlineVolume, RemoteVolume
 
 @shed_env(MY_ENV_VAR="hello")
 @shed_volumes(
-  ("/path/to/host/data", "/app/data:ro"),
+  ("/path/to/host/data", "/app/data"),
   InlineVolume("/app/config.txt", "any content you want", mode=0o644),
   RemoteVolume("/app/remote-config.json", "https://api.example.com/config.json", mode=0o644),
 )
-def test_configured_docker_app(docker_sidecar):
-  app = docker_sidecar("my-custom-app:latest")
+def test_configured_docker_app(shed):
   # ... test logic ...
 ```
 
@@ -145,7 +144,6 @@ TestShed extends `pytest` with options to control the Docker environment:
 - **`--shed-tag TAG|SHA`:** Image tag or digest *(default: `tests`)*.
 - **`--shed-build-context DIR`:** Docker build context *(default: `pytest.ini` directory)*.
 - **`--shed-image-policy POLICY`:** Image acquisition policy for building or pulling *(default: `pull`)*.
-- **`--shed-network NAME`:** Docker network *(default: `testshed-network`)*.
 - **`--shed-skip-bootstrap`:** Skip Docker bootstrapping *(useful for unit tests)*.
 
 > [!NOTE]

src/kloudkit/testshed/__init__.py

@@ -1 +1 @@
-__version__ = "0.0.1"
+__version__ = "0.0.2"

src/kloudkit/testshed/_internal/state.py

@@ -1,13 +1,30 @@
+import os
+import random
+import threading
 from dataclasses import dataclass, field
 from pathlib import Path
 
 
+def _dynamic_network_name(project_name: str | None = None) -> str:
+  """Generate a dynamic network name."""
+
+  xdist_worker = os.getenv("PYTEST_XDIST_WORKER")
+  random_suffix = f"{random.randint(1000, 9999)}"
+
+  network_parts = filter(
+    None,
+    ["testshed", project_name or Path.cwd().name, random_suffix, xdist_worker],
+  )
+
+  return "-".join(network_parts)
+
+
 @dataclass(slots=True)
 class Options:
   labels: dict[str, str] = field(
     default_factory=lambda: {"com.kloudkit.testshed": "testing-container"}
   )
-  network: str = "testshed-network"
+  network: str | None = None
   image: str | None = None
   tag: str = "tests"
   src_path: Path | None = None
@@ -25,11 +42,42 @@ def image_and_tag(self) -> str:
 
     return f"{self.image}{sep}{self.tag}"
 
+  @classmethod
+  def create(
+    cls,
+    project_name: str | None = None,
+    image: str | None = None,
+    tag: str = "tests",
+    src_path: Path | None = None,
+    tests_path: Path | None = None,
+    stubs_path: Path | None = None,
+  ) -> "Options":
+    """Create an Options instance with a dynamic network name."""
 
-_state: Options = Options()
+    return cls(
+      network=_dynamic_network_name(project_name),
+      image=image,
+      tag=tag,
+      src_path=src_path,
+      tests_path=tests_path,
+      stubs_path=stubs_path,
+    )
+
+
+_state: Options | None = None
+_state_lock = threading.RLock()
 
 
 def get_state() -> Options:
-  """Get the current state."""
+  """Get the current state in a thread-safe manner."""
+
+  with _state_lock:
+    return Options() if _state is None else _state
+
+
+def set_state(options: Options) -> None:
+  """Set the global state in a thread-safe manner."""
 
-  return _state
+  global _state
+  with _state_lock:
+    _state = options

src/kloudkit/testshed/docker/runtime/cleanup.py

@@ -13,6 +13,7 @@ def run(
     cls,
     containers: list[Container] | None = None,
     labels: dict | None = None,
+    network: bool = False,
   ) -> None:
     """Force-remove all provided containers or labeled."""
 
@@ -28,3 +29,7 @@ def run(
     for container in containers:
       with contextlib.suppress(DockerException):
         container.remove(force=True, volumes=True)
+
+    if network:
+      with contextlib.suppress(DockerException):
+        docker.network.remove(get_state().network)

src/kloudkit/testshed/plugin/__init__.py

@@ -1,14 +1,6 @@
-from kloudkit.testshed.docker.runtime.cleanup import Cleanup
 from kloudkit.testshed.plugin.addoptions import pytest_addoption  # noqa: F401
 from kloudkit.testshed.plugin.configure import pytest_configure  # noqa: F401
 from kloudkit.testshed.plugin.presenter import (
   pytest_report_header,  # noqa: F401
 )
-
-import pytest
-
-
-def pytest_keyboard_interrupt(excinfo: pytest.ExceptionInfo) -> None:
-  """Cleanup any dangling containers before exiting."""
-
-  Cleanup.run()
+from kloudkit.testshed.plugin.session import pytest_sessionfinish  # noqa: F401

src/kloudkit/testshed/plugin/addoptions.py

@@ -44,13 +44,6 @@ def pytest_addoption(parser: pytest.Parser) -> None:
     help="Image acquisition policy for building or pulling.",
   )
 
-  parser.addoption(
-    "--shed-network",
-    action="store",
-    default="testshed-network",
-    metavar="NAME",
-    help="Docker network to use when running containers.",
-  )
 
   parser.addoption(
     "--shed-src-dir",

src/kloudkit/testshed/plugin/configure.py

@@ -1,6 +1,9 @@
 from pathlib import Path
 
-from kloudkit.testshed._internal.state import get_state
+from kloudkit.testshed._internal.state import (
+  Options,
+  set_state,
+)
 from kloudkit.testshed.core.bootstrap import init_shed_image, init_shed_network
 from kloudkit.testshed.plugin.validation import validate_config
 
@@ -41,15 +44,16 @@ def pytest_configure(config: pytest.Config) -> None:
 
   validate_config(config)
 
-  state = get_state()
-
-  state.network = config.getoption("shed_network")
-  state.image = config.getoption("shed_image")
-  state.tag = config.getoption("shed_tag")
+  state = Options.create(
+    project_name=config.inipath.parent.name,
+    image=config.getoption("shed_image"),
+    tag=config.getoption("shed_tag"),
+    src_path=_resolve_path("src_dir", config),
+    stubs_path=_resolve_path("stubs_dir", config),
+    tests_path=_resolve_path("tests_dir", config),
+  )
 
-  state.src_path = _resolve_path("src_dir", config)
-  state.stubs_path = _resolve_path("stubs_dir", config)
-  state.tests_path = _resolve_path("tests_dir", config)
+  set_state(state)
 
   if config.getoption("shed_skip_bootstrap"):
     return

src/kloudkit/testshed/plugin/session.py

@@ -0,0 +1,9 @@
+from kloudkit.testshed.docker.runtime.cleanup import Cleanup
+
+import pytest
+
+
+def pytest_sessionfinish(session: pytest.Session):
+  """Cleanup all Docker resources at the end of the test session."""
+
+  Cleanup.run(network=True)

tests/unit/test_options.py

@@ -0,0 +1,35 @@
+import os
+from unittest.mock import patch
+
+from kloudkit.testshed._internal.state import Options
+
+
+def test_generate_name_with_project():
+  options = Options.create(project_name="myproject")
+
+  parts = options.network.split("-")
+
+  assert parts[0] == "testshed"
+  assert parts[1] == "myproject"
+  assert len(parts[2]) == 4
+  assert len(parts) == 3
+
+
+def test_generate_name_with_xdist():
+  with patch.dict(os.environ, {"PYTEST_XDIST_WORKER": "gw0"}):
+    options = Options.create(project_name="myproject")
+
+    parts = options.network.split("-")
+
+    assert parts[0] == "testshed"
+    assert parts[1] == "myproject"
+    assert len(parts[2]) == 4
+    assert parts[3] == "gw0"
+    assert len(parts) == 4
+
+
+def test_generate_name_random_suffix():
+  options1 = Options.create(project_name="test")
+  options2 = Options.create(project_name="test")
+
+  assert options1.network != options2.network