Better tests directory structure

Author: mathbunnyru

CHANGELOG.md

@@ -1,33 +1,15 @@
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
-import logging
 import os
-import socket
-from contextlib import closing
-from typing import Any
+from collections.abc import Generator
 
 import docker
 import pytest  # type: ignore
 import requests
-from docker.models.containers import Container
 from requests.adapters import HTTPAdapter
 from urllib3.util.retry import Retry
 
-LOGGER = logging.getLogger(__name__)
-
-
-def find_free_port() -> str:
-    """Returns the available host port. Can be called in multiple threads/processes."""
-    with closing(socket.socket(socket.AF_INET, socket.SOCK_STREAM)) as s:
-        s.bind(("", 0))
-        s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
-        return s.getsockname()[1]  # type: ignore
-
-
-def get_health(container: Container) -> str:
-    api_client = docker.APIClient()
-    inspect_results = api_client.inspect_container(container.name)
-    return inspect_results["State"]["Health"]["Status"]  # type: ignore
+from tests.utils.tracked_container import TrackedContainer
 
 
 @pytest.fixture(scope="session")
@@ -52,95 +34,10 @@ def image_name() -> str:
     return os.environ["TEST_IMAGE"]
 
 
-class TrackedContainer:
-    """Wrapper that collects docker container configuration and delays
-    container creation/execution.
-
-    Parameters
-    ----------
-    docker_client: docker.DockerClient
-        Docker client instance
-    image_name: str
-        Name of the docker image to launch
-    **kwargs: dict, optional
-        Default keyword arguments to pass to docker.DockerClient.containers.run
-    """
-
-    def __init__(
-        self,
-        docker_client: docker.DockerClient,
-        image_name: str,
-        **kwargs: Any,
-    ):
-        self.container: Container | None = None
-        self.docker_client: docker.DockerClient = docker_client
-        self.image_name: str = image_name
-        self.kwargs: Any = kwargs
-
-    def run_detached(self, **kwargs: Any) -> Container:
-        """Runs a docker container using the pre-configured image name
-        and a mix of the pre-configured container options and those passed
-        to this method.
-
-        Keeps track of the docker.Container instance spawned to kill it
-        later.
-
-        Parameters
-        ----------
-        **kwargs: dict, optional
-            Keyword arguments to pass to docker.DockerClient.containers.run
-            extending and/or overriding key/value pairs passed to the constructor
-
-        Returns
-        -------
-        docker.Container
-        """
-        all_kwargs = self.kwargs | kwargs
-        LOGGER.info(f"Running {self.image_name} with args {all_kwargs} ...")
-        self.container = self.docker_client.containers.run(
-            self.image_name,
-            **all_kwargs,
-        )
-        return self.container
-
-    def run_and_wait(
-        self,
-        timeout: int,
-        no_warnings: bool = True,
-        no_errors: bool = True,
-        no_failure: bool = True,
-        **kwargs: Any,
-    ) -> str:
-        running_container = self.run_detached(**kwargs)
-        rv = running_container.wait(timeout=timeout)
-        logs = running_container.logs().decode("utf-8")
-        assert isinstance(logs, str)
-        LOGGER.debug(logs)
-        assert no_warnings == (not self.get_warnings(logs))
-        assert no_errors == (not self.get_errors(logs))
-        assert no_failure == (rv["StatusCode"] == 0)
-        return logs
-
-    @staticmethod
-    def get_errors(logs: str) -> list[str]:
-        return TrackedContainer._lines_starting_with(logs, "ERROR")
-
-    @staticmethod
-    def get_warnings(logs: str) -> list[str]:
-        return TrackedContainer._lines_starting_with(logs, "WARNING")
-
-    @staticmethod
-    def _lines_starting_with(logs: str, pattern: str) -> list[str]:
-        return [line for line in logs.splitlines() if line.startswith(pattern)]
-
-    def remove(self) -> None:
-        """Kills and removes the tracked docker container."""
-        if self.container:
-            self.container.remove(force=True)
-
-
 @pytest.fixture(scope="function")
-def container(docker_client: docker.DockerClient, image_name: str) -> Container:
+def container(
+    docker_client: docker.DockerClient, image_name: str
+) -> Generator[TrackedContainer]:
     """Notebook container with initial configuration appropriate for testing
     (e.g., HTTP port exposed to the host for HTTP calls).
 

tests/conftest.py

@@ -3,6 +3,9 @@
 from pathlib import Path
 
 THIS_DIR = Path(__file__).parent.resolve()
+IMAGE_SPECIFIC_TESTS_DIR = THIS_DIR.parent / "image_specific_tests"
+
+assert IMAGE_SPECIFIC_TESTS_DIR.exists(), f"{IMAGE_SPECIFIC_TESTS_DIR} does not exist."
 
 # Please, take a look at the hierarchy of the images here:
 # https://jupyter-docker-stacks.readthedocs.io/en/latest/using/selecting.html#image-relationships
@@ -28,6 +31,8 @@ def get_test_dirs(
         return []
 
     test_dirs = get_test_dirs(ALL_IMAGES[short_image_name])
-    if (current_image_tests_dir := THIS_DIR / short_image_name).exists():
+    if (
+        current_image_tests_dir := IMAGE_SPECIFIC_TESTS_DIR / short_image_name
+    ).exists():
         test_dirs.append(current_image_tests_dir)
     return test_dirs

tests/hierarchy/__init__.py

@@ -5,7 +5,7 @@
 
 import pytest  # type: ignore
 
-from tests.conftest import TrackedContainer
+from tests.utils.tracked_container import TrackedContainer
 
 LOGGER = logging.getLogger(__name__)
 THIS_DIR = Path(__file__).parent.resolve()

tests/images_hierarchy.py renamed to tests/hierarchy/images_hierarchy.py

@@ -6,7 +6,8 @@
 import pytest  # type: ignore
 import requests
 
-from tests.conftest import TrackedContainer, find_free_port
+from tests.utils.find_free_port import find_free_port
+from tests.utils.tracked_container import TrackedContainer
 
 LOGGER = logging.getLogger(__name__)