Skip to content

fix(core): restore dind test #920

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
alexanderankin wants to merge 4 commits into
base: main
Choose a base branch
from
+55 −36
Open

fix(core): restore dind test #920

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
53b8e3d
alexanderankin Jan 24, 2026
3aecc6a
fix logic
alexanderankin Jan 24, 2026
9a9e50a
test ci
alexanderankin Jan 24, 2026
45d17d4
learn that dind bug is actually python syntax bug
alexanderankin Jan 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
91 changes: 55 additions & 36 deletions core/tests/test_docker_in_docker.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
import contextlib
import json
import logging
import os
import time
import socket
import sys
from textwrap import indent
from pathlib import Path
from typing import Final, Any, Generator

Expand All @@ -20,12 +22,15 @@
from testcontainers.core.utils import is_mac
from testcontainers.core.waiting_utils import wait_for_logs

_DIND_PYTHON_VERSION = (3, 13)
_DIND_PYTHON_VERSION = (3, 10)
logger = logging.getLogger(__name__)


def _should_run_dind() -> bool:
def _should_skip_dind() -> bool:
if os.getenv("DIND"):
return False
# todo refine macos check -> run in ci but not locally
return not is_mac() and tuple([*sys.version_info][:2]) == _DIND_PYTHON_VERSION
return is_mac() or tuple([*sys.version_info][:2]) != _DIND_PYTHON_VERSION


def _wait_for_dind_return_ip(client: DockerClient, dind: Container):
Expand All @@ -46,10 +51,11 @@ 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")
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
logger.info("starting test_wait_for_logs_docker_in_docker")
client = DockerClient()
not_really_dind = client.run(
image="alpine/socat",
Expand All @@ -58,25 +64,30 @@ def test_wait_for_logs_docker_in_docker():
detach=True,
)

logger.info("starting not_really_dind")
not_really_dind.start()
logger.info("started not_really_dind")
docker_host_ip = _wait_for_dind_return_ip(client, not_really_dind)
logger.info("waited for not_really_dind: '_wait_for_dind_return_ip'")
docker_host = f"tcp://{docker_host_ip}:2375"

with DockerContainer(
image="hello-world",
docker_client_kw={"environment": {"DOCKER_HOST": docker_host, "DOCKER_CERT_PATH": "", "DOCKER_TLS_VERIFY": ""}},
) as 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"

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"
_should_skip_dind(), reason="Bridge networking and Docker socket forwarding are not supported on Docker Desktop for macOS"
)
def test_dind_inherits_network():
client = DockerClient()
Expand Down Expand Up @@ -122,19 +133,19 @@ def print_surround_header(what: str, header_len: int = 80) -> Generator[None, No
start = f"# Beginning of {what}"
end = f"# End of {what}"

print("\n")
print("#" * header_len)
print(start + " " * (header_len - len(start) - 1) + "#")
print("#" * header_len)
print("\n")
logger.info("\n")
logger.info("#" * header_len)
logger.info(start + " " * (header_len - len(start) - 1) + "#")
logger.info("#" * header_len)
logger.info("\n")

yield

print("\n")
print("#" * header_len)
print(end + " " * (header_len - len(end) - 1) + "#")
print("#" * header_len)
print("\n")
logger.info("\n")
logger.info("#" * header_len)
logger.info(end + " " * (header_len - len(end) - 1) + "#")
logger.info("#" * header_len)
logger.info("\n")


EXPECTED_NETWORK_VAR: Final[str] = "TCC_EXPECTED_NETWORK"
Expand All @@ -160,20 +171,20 @@ 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.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(_should_skip_dind() or 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
"""
LOGGER.info(f"Running container id={utils.get_running_in_container_id()}")
logger.info(f"Running container id={utils.get_running_in_container_id()}")
# Get some debug information in the hope this helps to find
LOGGER.info(f"hostname: {socket.gethostname()}")
LOGGER.info(f"docker info: {json.dumps(get_docker_info(), indent=2)}")
logger.info(f"hostname: {socket.gethostname()}")
logger.info(f"docker info: {json.dumps(get_docker_info(), indent=2)}")
assert DockerClient().find_host_network() == os.environ[EXPECTED_NETWORK_VAR]


@pytest.mark.skipif(
_should_run_dind(), reason="Docker socket mounting and container networking do not work reliably on Docker Desktop for macOS"
_should_skip_dind(), 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")
def test_dood(python_testcontainer_image: str) -> None:
Expand All @@ -183,6 +194,7 @@ def test_dood(python_testcontainer_image: str) -> None:

docker_sock = tcc.ryuk_docker_socket
with Network() as network:
logger.info("test_dood - created network")
with (
DockerContainer(
image=python_testcontainer_image,
Expand All @@ -196,7 +208,9 @@ def test_dood(python_testcontainer_image: str) -> None:
.with_env("RYUK_RECONNECTION_TIMEOUT", "1s")
.with_network(network)
) as container:
logger.info("test_dood - created container")
status = container.get_wrapped_container().wait()
logger.info("test_dood - container returned status %s", status)
stdout, stderr = container.get_logs()
# ensure ryuk removed the containers created inside container
# because they are bound our network the deletion of the network
Expand All @@ -205,13 +219,13 @@ def test_dood(python_testcontainer_image: str) -> None:

# Show what was done inside test
with print_surround_header("test_dood results"):
print(stdout.decode("utf-8", errors="replace"))
print(stderr.decode("utf-8", errors="replace"))
logger.info(indent(stdout.decode("utf-8", errors="replace"), prefix=(" " * 4) + "container log: "))
logger.info(indent(stderr.decode("utf-8", errors="replace"), prefix=(" " * 4) + "container log: "))
assert status["StatusCode"] == 0


@pytest.mark.skipif(
_should_run_dind(), reason="Docker socket mounting and container networking do not work reliably on Docker Desktop for macOS"
_should_skip_dind(), reason="Docker socket mounting and container networking do not work reliably on Docker Desktop for macOS"
)
def test_dind(python_testcontainer_image: str, tmp_path: Path) -> None:
"""
Expand All @@ -220,6 +234,7 @@ def test_dind(python_testcontainer_image: str, tmp_path: Path) -> None:
cert_dir = tmp_path / "certs"
dind_name = f"docker_{SESSION_ID}"
with Network() as network:
logger.info("test_dind - created network")
with (
DockerContainer(image="docker:dind", privileged=True)
.with_name(dind_name)
Expand All @@ -229,7 +244,9 @@ def test_dind(python_testcontainer_image: str, tmp_path: Path) -> None:
.with_network(network)
.with_network_aliases("docker")
) as dind_container:
logger.info("test_dind - created docker:dind container")
wait_for_logs(dind_container, "API listen on")
logger.info("test_dind - waited for ready message in logs")
client_dir = cert_dir / "docker" / "client"
ca_file = client_dir / "ca.pem"
assert ca_file.is_file()
Expand All @@ -247,7 +264,9 @@ def test_dind(python_testcontainer_image: str, tmp_path: Path) -> None:
.with_env("DOCKER_HOST", "tcp://docker:2376")
.with_network(network)
) as test_container:
logger.info("test_dind - created test suite container")
status = test_container.get_wrapped_container().wait()
logger.info("test_dind - test suite container returned status %s", status)
stdout, stderr = test_container.get_logs()
finally:
# ensure the certs are deleted from inside the container
Expand All @@ -258,6 +277,6 @@ def test_dind(python_testcontainer_image: str, tmp_path: Path) -> None:

# Show what was done inside test
with print_surround_header("test_dood results"):
print(stdout.decode("utf-8", errors="replace"))
print(stderr.decode("utf-8", errors="replace"))
logger.info(indent(stdout.decode("utf-8", errors="replace"), prefix=(" " * 4) + "container log: "))
logger.info(indent(stderr.decode("utf-8", errors="replace"), prefix=(" " * 4) + "container log: "))
assert status["StatusCode"] == 0