Update some files from upstream docker-stacks project (#108)

Author: mathbunnyru

pytest.ini

@@ -1,7 +1,7 @@
 [pytest]
 addopts = -ra --color=yes
 log_cli = 1
-log_cli_level = DEBUG
+log_cli_level = INFO
 log_cli_format = %(asctime)s [%(levelname)8s] %(message)s (%(filename)s:%(lineno)s)
 log_cli_date_format=%Y-%m-%d %H:%M:%S
 markers =

{{cookiecutter.stack_name}}/tests/conftest.py

@@ -1,5 +1,6 @@
 # Copyright (c) Jupyter Development Team.
 # Distributed under the terms of the Modified BSD License.
+import logging
 import os
 from collections.abc import Generator
 
@@ -10,6 +11,8 @@
 from tests.utils.tracked_container import TrackedContainer
 from urllib3.util.retry import Retry
 
+LOGGER = logging.getLogger(__name__)
+
 
 @pytest.fixture(scope="session")
 def http_client() -> requests.Session:
@@ -24,7 +27,9 @@ def http_client() -> requests.Session:
 @pytest.fixture(scope="session")
 def docker_client() -> docker.DockerClient:
     """Docker client configured based on the host environment"""
-    return docker.from_env()
+    client = docker.from_env()
+    LOGGER.debug(f"Docker client created: {client.version()}")
+    return client
 
 
 @pytest.fixture(scope="session")
@@ -45,7 +50,6 @@ def container(
     container = TrackedContainer(
         docker_client,
         image_name,
-        detach=True,
     )
     yield container
     container.remove()

{{cookiecutter.stack_name}}/tests/utils/tracked_container.py

@@ -19,22 +19,18 @@ class TrackedContainer:
         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:
+    def run_detached(self, **kwargs: Any) -> None:
         """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.
@@ -47,18 +43,41 @@ def run_detached(self, **kwargs: Any) -> Container:
         **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} ...")
+        LOGGER.info(
+            f"Creating a container for the image: {self.image_name} with args: {kwargs} ..."
+        )
+        default_kwargs = {"detach": True, "tty": True}
+        final_kwargs = default_kwargs | kwargs
         self.container = self.docker_client.containers.run(
-            self.image_name,
-            **all_kwargs,
+            self.image_name, **final_kwargs
         )
-        return self.container
+        LOGGER.info(f"Container {self.container.name} created")
+
+    def get_logs(self) -> str:
+        assert self.container is not None
+        logs = self.container.logs().decode()
+        assert isinstance(logs, str)
+        return logs
+
+    def get_health(self) -> str:
+        assert self.container is not None
+        self.container.reload()
+        return self.container.health  # type: ignore
+
+    def exec_cmd(self, cmd: str, **kwargs: Any) -> str:
+        assert self.container is not None
+        container = self.container
+
+        LOGGER.info(f"Running cmd: `{cmd}` on container: {container.name}")
+        default_kwargs = {"tty": True}
+        final_kwargs = default_kwargs | kwargs
+        exec_result = container.exec_run(cmd, **final_kwargs)
+        output = exec_result.output.decode().rstrip()
+        assert isinstance(output, str)
+        LOGGER.debug(f"Command output: {output}")
+        assert exec_result.exit_code == 0, f"Command: `{cmd}` failed"
+        return output
 
     def run_and_wait(
         self,
@@ -68,14 +87,15 @@ def run_and_wait(
         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)
+        self.run_detached(**kwargs)
+        assert self.container is not None
+        rv = self.container.wait(timeout=timeout)
+        logs = self.get_logs()
         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)
+        self.remove()
         return logs
 
     @staticmethod
@@ -93,8 +113,9 @@ def _lines_starting_with(logs: str, pattern: str) -> list[str]:
     def remove(self) -> None:
         """Kills and removes the tracked docker container."""
         if self.container is None:
-            LOGGER.info("No container to remove")
+            LOGGER.debug("No container to remove")
         else:
             LOGGER.info(f"Removing container {self.container.name} ...")
             self.container.remove(force=True)
             LOGGER.info(f"Container {self.container.name} removed")
+            self.container = None