import pytest

import tempfile

import random

import os

from pathlib import Path

from typing import Any, Optional

from testcontainers.core.container import DockerContainer

from testcontainers.core.image import DockerImage

@pytest.mark.parametrize("test_cleanup", [True, False])

@pytest.mark.parametrize("test_image_tag", [None, "test-image:latest"])

def test_docker_image(test_image_tag: Optional[str], test_cleanup: bool, check_for_image) -> None:

with tempfile.TemporaryDirectory() as temp_directory:

# It's important to use a random string to avoid image caching

random_string = "Hello from Docker Image! " + str(random.randint(0, 1000))

with open(f"{temp_directory}/Dockerfile", "w") as f:

f.write(

f"""

FROM alpine:latest

CMD echo "{random_string}"

"""

)

with DockerImage(path=temp_directory, tag=test_image_tag, clean_up=test_cleanup) as image:

image_short_id = image.short_id

assert image.tag is test_image_tag, f"Expected {test_image_tag}, got {image.tag}"

assert image.short_id is not None, "Short ID should not be None"

assert image.get_wrapped_image() is not None

logs = image.get_logs()

assert isinstance(logs, list), "Logs should be a list"

assert logs[0] == {"stream": "Step 1/2 : FROM alpine:latest"}

assert logs[3] == {"stream": f'Step 2/2 : CMD echo "{random_string}"'}

with DockerContainer(str(image)) as container:

c_c = container._container

assert c_c

assert c_c.image.short_id.endswith(image_short_id), "Image ID mismatch"

assert container.get_logs() == ((random_string + "\n").encode(), b""), "Container logs mismatch"

check_for_image(image_short_id, test_cleanup)

@pytest.mark.parametrize("dockerfile_path", [None, Path("subdir/my.Dockerfile")])

def test_docker_image_with_custom_dockerfile_path(dockerfile_path: Optional[Path]) -> None:

with tempfile.TemporaryDirectory() as temp_directory:

temp_dir_path = Path(temp_directory)

dockerfile_kwargs: dict[str, Any] = {}

if dockerfile_path:

os.makedirs(temp_dir_path / dockerfile_path.parent, exist_ok=True)

dockerfile_rel_path = dockerfile_path

dockerfile_kwargs = {"dockerfile_path": dockerfile_path}

else:

dockerfile_rel_path = Path("Dockerfile") # default

dockerfile_kwargs = {}

with open(temp_dir_path / dockerfile_rel_path, "x") as f:

f.write(

f"""

FROM alpine:latest

CMD echo "Hello world!"

"""

)

with DockerImage(path=temp_directory, tag="test", clean_up=True, no_cache=True, **dockerfile_kwargs) as image:

image_short_id = image.short_id

assert image.get_wrapped_image() is not None

with DockerContainer(str(image)) as container:

c_c = container._container

assert c_c

assert c_c.image.short_id.endswith(image_short_id), "Image ID mismatch"

assert container.get_logs() == (("Hello world!\n").encode(), b""), "Container logs mismatch"

def test_docker_image_with_kwargs():

with tempfile.TemporaryDirectory() as temp_directory:

with open(f"{temp_directory}/Dockerfile", "w") as f:

f.write(

f"""

FROM alpine:latest

ARG TEST_ARG

ENV TEST_ARG $TEST_ARG

CMD echo $TEST_ARG

"""

)

with DockerImage(

path=temp_directory, tag="test", clean_up=True, no_cache=True, buildargs={"TEST_ARG": "new_arg"}

) as image:

image_short_id = image.short_id

assert image.get_wrapped_image() is not None

with DockerContainer(str(image)) as container:

c_c = container._container

assert c_c

assert c_c.image.short_id.endswith(image_short_id), "Image ID mismatch"

assert container.get_logs() == (("new_arg\n").encode(), b""), "Container logs mismatch"