Ensure built image is fully qualified (#499)

Author: ssbarnea

.config/requirements-test.in

@@ -8,6 +8,7 @@ pre-commit
 pydoclint
 pylint
 pytest
+pytest-instafail
 pytest-xdist
 requests
 ruff

.gitignore

@@ -184,3 +184,4 @@ devspaces/context/*.whl
 devspaces/context/setup-image.sh
 final/context/setup-image.sh
 final/setup-image.sh
+image.tar

pyproject.toml

@@ -329,7 +329,6 @@ addopts = "-ra --showlocals --durations=10 -p no:pytest-ansible"
 cache_dir = "./.cache/.pytest"
 log_cli = true
 log_cli_level = "WARNING"
-showlocals = true
 testpaths = "tests"
 tmp_path_retention_policy = "failed"
 verbosity_assertions = 2

tests/conftest.py

@@ -289,11 +289,12 @@ def _start_container() -> None:
     Raises:
         ValueError: If the container engine is not podman or docker.
     """
+    engine = INFRASTRUCTURE.container_engine
     cmd = (
-        f"{INFRASTRUCTURE.container_engine} kill {INFRASTRUCTURE.container_name};"
-        f"{INFRASTRUCTURE.container_engine} rm {INFRASTRUCTURE.container_name}"
+        f'{engine} ps -q --filter "name={INFRASTRUCTURE.container_name}" | xargs -r {engine} stop;'
+        f'{engine} ps -aq --filter "name=$name" | xargs -r {engine}  rm'
     )
-    subprocess.run(cmd, check=False, capture_output=True, shell=True, text=True)
+    subprocess.run(cmd, check=True, capture_output=False, shell=True, text=True)
 
     auth_file = "$XDG_RUNTIME_DIR/containers/auth.json"
     auth_mount = ""
@@ -321,21 +322,12 @@ def _start_container() -> None:
         err = f"Failed to start container:\ncmd: {cmd}\nstdout: {exc.stdout}\nstderr: {exc.stderr}"
         pytest.fail(err)
 
-    # image is local, can't be pulled, use default
-    if INFRASTRUCTURE.image_name.startswith("localhost"):
-        nav_ee = get_nav_default_ee_in_container()
-        warning = f"localhost in image name, pulling default {nav_ee} for navigator"
-    # dots and slashes in image name, use it
-    elif "/" in INFRASTRUCTURE.image_name and "." in INFRASTRUCTURE.image_name:
-        nav_ee = INFRASTRUCTURE.image_name
-        warning = f"/ and . in image name, pulling {nav_ee} for navigator"
-    # otherwise, use default
+    if INFRASTRUCTURE.image_name:
+        INFRASTRUCTURE.navigator_ee = INFRASTRUCTURE.image_name
+        _proc = _exec_container(command="podman load < image.tar")
     else:
         nav_ee = get_nav_default_ee_in_container()
-        warning = f"localhost / . not in image name, pulling default {nav_ee} for navigator"
-    LOGGER.warning(warning)
-    INFRASTRUCTURE.navigator_ee = nav_ee
-    _proc = _exec_container(command=f"podman pull {nav_ee}")
+        _proc = _exec_container(command=f"podman pull {nav_ee}")
 
 
 def get_nav_default_ee_in_container() -> str:

tests/integration/test_container.py

@@ -109,7 +109,7 @@ def test_user_shell(exec_container: Callable[[str], subprocess.CompletedProcess[
 
 
 @pytest.mark.container
-def test_navigator_simple_c_in_c(
+def test_navigator_2_c_in_c(
     exec_container: Callable[[str], subprocess.CompletedProcess[str]],
     test_fixture_dir_container: Path,
     tmp_path: Path,
@@ -134,7 +134,7 @@ def test_navigator_simple_c_in_c(
 
 
 @pytest.mark.container
-def test_navigator_simple(
+def test_navigator_1(
     cmd_in_tty: Callable[[str], tuple[str, str, int]],
     infrastructure: Infrastructure,
     test_fixture_dir: Path,

tools/ee.sh

@@ -20,7 +20,9 @@ fi
 REPO_DIR=$(git rev-parse --show-toplevel)
 
 TAG_BASE=community-ansible-dev-tools-base:latest
-IMAGE_NAME=community-ansible-dev-tools:test
+# keep the localhost/ prefix on image name all the time or we will face various
+# problems related to docker/podman differences when this is missing.
+IMAGE_NAME=localhost/community-ansible-dev-tools:test
 
 # BUILD_CMD="podman build --squash-all"
 BUILD_CMD="${ADT_CONTAINER_ENGINE} buildx build --progress=plain"
@@ -64,11 +66,15 @@ $BUILD_CMD -f context/Containerfile context/ --tag "${TAG_BASE}"
 cp tools/setup-image.sh final/
 $BUILD_CMD -f final/Containerfile final/ --tag "${IMAGE_NAME}"
 
+# We save local image in order to import it inside the container later for c-in-c testing
+# Do not try to gzip the image because there is no notable change in size and
+# it seems to add ~20% more in total test execution time.
+$ADT_CONTAINER_ENGINE save $IMAGE_NAME > image.tar
+
 # Check container size and layers
 mk containers check "$IMAGE_NAME" --engine="${ADT_CONTAINER_ENGINE}" --max-size=1500 --max-layers=22
 
-pytest -v --only-container --container-engine="${ADT_CONTAINER_ENGINE}" --image-name "${IMAGE_NAME}"
-#  -k test_navigator_simple
+pytest -v --include-container --container-engine="${ADT_CONTAINER_ENGINE}" --image-name "${IMAGE_NAME}"
 # Test the build of example execution environment to avoid regressions
 pushd docs/examples
 ansible-builder build