improve dind tests

Make it more clear why a test is skipped or not

Author: CarliJoy

core/tests/test_docker_in_docker.py

@@ -23,9 +23,13 @@
 _DIND_PYTHON_VERSION = (3, 13)
 
 
-def _should_run_dind() -> bool:
-    # todo refine macos check -> run in ci but not locally
-    return not is_mac() and tuple([*sys.version_info][:2]) == _DIND_PYTHON_VERSION
+RUN_ONCE_IN_CI = pytest.mark.skipif(
+    bool(os.environ.get("CI")) and tuple([*sys.version_info][:2]) != _DIND_PYTHON_VERSION,
+    reason=(
+        f"To reduce load the DinD test are only executed "
+        f"in Python {'.'.join(map(str, _DIND_PYTHON_VERSION))} in the Pipeline."
+    ),
+)
 
 
 def _wait_for_dind_return_ip(client: DockerClient, dind: Container):
@@ -46,10 +50,8 @@ def _wait_for_dind_return_ip(client: DockerClient, dind: Container):
     return docker_host_ip
 
 
-@pytest.mark.skipif(_should_run_dind(), reason="Docker socket forwarding (socat) is unsupported on Docker Desktop for macOS")
-@pytest.mark.skipif(
-    _should_skip_dind(), reason="Docker socket forwarding (socat) is unsupported on Docker Desktop for macOS"
-)
+@pytest.mark.skipif(is_mac(), reason="Docker socket forwarding (socat) is unsupported on Docker Desktop for macOS")
+@RUN_ONCE_IN_CI
 def test_wait_for_logs_docker_in_docker():
     # real dind isn't possible (AFAIK) in CI
     # forwarding the socket to a container port is at least somewhat the same
@@ -76,26 +78,13 @@ def test_wait_for_logs_docker_in_docker():
 
     not_really_dind.stop()
     not_really_dind.remove()
-    try:
-        with DockerContainer(
-            image="hello-world",
-            docker_client_kw={
-                "environment": {"DOCKER_HOST": docker_host, "DOCKER_CERT_PATH": "", "DOCKER_TLS_VERIFY": ""}
-            },
-        ) as container:
-            logger.info("started hello-world container")
-            assert container.get_container_host_ip() == docker_host_ip
-            wait_for_logs(container, "Hello from Docker!")
-            stdout, stderr = container.get_logs()
-            assert stdout, "There should be something on stdout"
-    finally:
-        not_really_dind.stop()
-        not_really_dind.remove()
 
 
 @pytest.mark.skipif(
-    _should_run_dind(), reason="Bridge networking and Docker socket forwarding are not supported on Docker Desktop for macOS"
+    is_mac(),
+    reason="Bridge networking and Docker socket forwarding are not supported on Docker Desktop for macOS",
 )
+@RUN_ONCE_IN_CI
 def test_dind_inherits_network():
     client = DockerClient()
     try:
@@ -176,9 +165,9 @@ def get_docker_info() -> dict[str, Any]:
 
 
 # see https://forums.docker.com/t/get-a-containers-full-id-from-inside-of-itself
-@pytest.mark.xfail(reason="Does not work in rootles docker i.e. github actions")
+@pytest.mark.xfail(reason="Does not work in rootless docker i.e. github actions")
 @pytest.mark.inside_docker_check
-@pytest.mark.skipif(_should_run_dind() or not os.environ.get(EXPECTED_NETWORK_VAR), reason="No expected network given")
+@pytest.mark.skipif(not os.environ.get(EXPECTED_NETWORK_VAR), reason="No expected network given")
 def test_find_host_network_in_dood() -> None:
     """
     Check that the correct host network is found for DooD
@@ -191,9 +180,11 @@ def test_find_host_network_in_dood() -> None:
 
 
 @pytest.mark.skipif(
-    _should_run_dind(), reason="Docker socket mounting and container networking do not work reliably on Docker Desktop for macOS"
+    is_mac(),
+    reason="Docker socket mounting and container networking do not work reliably on Docker Desktop for macOS",
 )
 @pytest.mark.skipif(not Path(tcc.ryuk_docker_socket).exists(), reason="No docker socket available")
+@RUN_ONCE_IN_CI
 def test_dood(python_testcontainer_image: str) -> None:
     """
     Run tests marked as inside_docker_check inside docker out of docker
@@ -229,8 +220,10 @@ def test_dood(python_testcontainer_image: str) -> None:
 
 
 @pytest.mark.skipif(
-    _should_run_dind(), reason="Docker socket mounting and container networking do not work reliably on Docker Desktop for macOS"
+    is_mac(),
+    reason="Docker socket mounting and container networking do not work reliably on Docker Desktop for macOS",
 )
+@RUN_ONCE_IN_CI
 def test_dind(python_testcontainer_image: str, tmp_path: Path) -> None:
     """
     Run selected tests in Docker in Docker