Unify how we use volumes: mount files, use pathlib.Path without str

Author: mathbunnyru

tests/by_image/base-notebook/test_ips.py

@@ -35,11 +35,12 @@ def ipv6_network(docker_client: docker.DockerClient) -> Generator[str, None, Non
 
 def test_ipv46(container: TrackedContainer, ipv6_network: str) -> None:
     """Check server is listening on the expected IP families"""
-    host_data_dir = THIS_DIR / "data"
-    cont_data_dir = "/home/jovyan/data"
+    file_name = "check_listening.py"
+    host_file = THIS_DIR / "data" / file_name
+    cont_file = f"/home/jovyan/data/{file_name}"
     LOGGER.info("Testing that server is listening on IPv4 and IPv6 ...")
     container.run_detached(
         network=ipv6_network,
-        volumes={str(host_data_dir): {"bind": cont_data_dir, "mode": "ro,z"}},
+        volumes={host_file: {"bind": cont_file, "mode": "ro"}},
     )
-    container.exec_cmd(f"python {cont_data_dir}/check_listening.py")
+    container.exec_cmd(f"python {cont_file}")

tests/by_image/docker-stacks-foundation/test_run_hooks.py

@@ -85,7 +85,7 @@ def run_source_in_dir(
     )
     return container.run_and_wait(
         timeout=5,
-        volumes={str(host_data_dir): {"bind": cont_data_dir, "mode": "ro"}},
+        volumes={host_data_dir: {"bind": cont_data_dir, "mode": "ro"}},
         no_failure=no_failure,
         command=["bash", "-c", command],
     )

tests/by_image/docker-stacks-foundation/test_units.py

@@ -26,12 +26,12 @@ def test_units(container: TrackedContainer) -> None:
         if not host_data_dir.exists():
             continue
 
-        for test_file in host_data_dir.iterdir():
-            test_file_name = test_file.name
-            LOGGER.info(f"Running unit test: {test_file_name}")
+        for host_file in host_data_dir.iterdir():
+            cont_file = f"{cont_data_dir}/{host_file.name}"
+            LOGGER.info(f"Running unit test: {host_file}")
 
             container.run_and_wait(
                 timeout=30,
-                volumes={str(host_data_dir): {"bind": cont_data_dir, "mode": "ro"}},
-                command=["python", f"{cont_data_dir}/{test_file_name}"],
+                volumes={host_file: {"bind": cont_file, "mode": "ro"}},
+                command=["python", cont_file],
             )

tests/by_image/docker-stacks-foundation/test_user_options.py

@@ -210,10 +210,10 @@ def test_container_not_delete_bind_mount(
     """Container should not delete host system files when using the (docker)
     -v bind mount flag and mapping to /home/jovyan.
     """
-    d = tmp_path / "data"
-    d.mkdir()
-    p = d / "foo.txt"
-    p.write_text("some-content")
+    host_data_dir = tmp_path / "data"
+    host_data_dir.mkdir()
+    host_file = host_data_dir / "foo.txt"
+    host_file.write_text("some-content")
 
     container.run_and_wait(
         timeout=5,
@@ -223,10 +223,10 @@ def test_container_not_delete_bind_mount(
             "NB_USER=user",
             "CHOWN_HOME=yes",
         ],
-        volumes={d: {"bind": "/home/jovyan/data", "mode": "rw"}},
+        volumes={host_data_dir: {"bind": "/home/jovyan/data", "mode": "rw"}},
         command=["ls"],
     )
-    assert p.read_text() == "some-content"
+    assert host_file.read_text() == "some-content"
     assert len(list(tmp_path.iterdir())) == 1
 
 
@@ -259,16 +259,16 @@ def test_secure_path(container: TrackedContainer, tmp_path: pathlib.Path) -> Non
     """Make sure that the sudo command has conda's python (not system's) on PATH.
     See <https://github.com/jupyter/docker-stacks/issues/1053>.
     """
-    d = tmp_path / "data"
-    d.mkdir()
-    p = d / "wrong_python.sh"
-    p.write_text('#!/bin/bash\necho "Wrong python executable invoked!"')
-    p.chmod(0o755)
+    host_data_dir = tmp_path / "data"
+    host_data_dir.mkdir()
+    host_file = host_data_dir / "wrong_python.sh"
+    host_file.write_text('#!/bin/bash\necho "Wrong python executable invoked!"')
+    host_file.chmod(0o755)
 
     logs = container.run_and_wait(
         timeout=5,
         user="root",
-        volumes={p: {"bind": "/usr/bin/python", "mode": "ro"}},
+        volumes={host_file: {"bind": "/usr/bin/python", "mode": "ro"}},
         command=["python", "--version"],
     )
     assert "Wrong python" not in logs

tests/by_image/scipy-notebook/test_cython.py

@@ -13,7 +13,7 @@ def test_cython(container: TrackedContainer) -> None:
 
     logs = container.run_and_wait(
         timeout=10,
-        volumes={str(host_data_dir): {"bind": cont_data_dir, "mode": "ro"}},
+        volumes={host_data_dir: {"bind": cont_data_dir, "mode": "ro"}},
         command=[
             "bash",
             "-c",

tests/by_image/scipy-notebook/test_matplotlib.py

@@ -34,17 +34,15 @@ def test_matplotlib(
     - Test that matplotlib is able to plot a graph and write it as an image
     - Test matplotlib latex fonts, which depend on the cm-super package
     """
-    host_data_dir = THIS_DIR / "data/matplotlib"
-    cont_data_dir = "/home/jovyan/data"
+    host_file = THIS_DIR / "data/matplotlib" / test_file
+    cont_file = f"/home/jovyan/data/{test_file}"
     output_dir = "/tmp"
     LOGGER.info(description)
     container.run_detached(
-        volumes={str(host_data_dir): {"bind": cont_data_dir, "mode": "ro"}},
+        volumes={host_file: {"bind": cont_file, "mode": "ro"}},
         command=["sleep", "infinity"],
     )
-
-    command = f"python {cont_data_dir}/{test_file}"
-    container.exec_cmd(command)
+    container.exec_cmd(f"python {cont_file}")
 
     # Checking if the file is generated
     # https://stackoverflow.com/a/15895594/4413446

tests/shared_checks/nbconvert_check.py

@@ -10,18 +10,18 @@
 
 def check_nbconvert(
     container: TrackedContainer,
-    host_data_file: Path,
+    host_file: Path,
     output_format: str,
     *,
     execute: bool,
     no_warnings: bool = True,
 ) -> str:
     """Check if nbconvert is able to convert a notebook file"""
-    cont_data_file = "/home/jovyan/data/" + host_data_file.name
+    cont_data_file = "/home/jovyan/data/" + host_file.name
 
     output_dir = "/tmp"
     LOGGER.info(
-        f"Test that the example notebook {host_data_file.name} can be converted to {output_format} ..."
+        f"Test that the example notebook {host_file.name} can be converted to {output_format} ..."
     )
     command = [
         "jupyter",
@@ -40,12 +40,12 @@ def check_nbconvert(
         ]
     logs = container.run_and_wait(
         timeout=60,
-        volumes={str(host_data_file): {"bind": cont_data_file, "mode": "ro"}},
+        volumes={host_file: {"bind": cont_data_file, "mode": "ro"}},
         command=command,
         no_warnings=no_warnings,
     )
     output_ext = "md" if output_format == "markdown" else output_format
-    expected_file = f"{output_dir}/{host_data_file.stem}.{output_ext}"
+    expected_file = f"{output_dir}/{host_file.stem}.{output_ext}"
     assert expected_file in logs, f"Expected file {expected_file} not generated"
 
     return logs