Fix end to end tests

Handle empty docker result

Fix linter

Fixed end to end tests except one volume test

Put the skip mounts back

add arg to build tesseract

Add short id to container

Fix volume args

Author: angela-ko

tesseract_core/sdk/cli.py

@@ -754,20 +754,19 @@ def run_container(
         )
 
     except RuntimeError as e:
+        if "repository" in str(e) or "Repository" in str(e):
+            raise UserError(
+                "Tesseract image not found. "
+                f"Are you sure your tesseract image name is {tesseract_image}?\n\n{e}"
+            ) from e
+
         if "No such command" in str(e):
             error_string = f"Error running Tesseract '{tesseract_image}' \n\n Error: Unimplemented command '{cmd}'.  "
         else:
             error_string = _sanitize_error_output(
                 f"Error running Tesseract. \n\n{e}", tesseract_image
             )
 
-
-        if "repository" in str(e) or "Repository" in str(e):
-            raise UserError(
-                "Tesseract image not found. "
-                f"Are you sure your tesseract image name is {tesseract_image}?\n\n{e}"
-            ) from e
-
         raise UserError(error_string) from e
 
     if invoke_help:

tesseract_core/sdk/docker_cli_wrapper.py

@@ -27,6 +27,7 @@ class Container:
 
         def __init__(self, json_dict: dict) -> None:
             self.id = json_dict.get("Id", None)
+            self.short_id = self.id[:12] if self.id else None
             self.name = json_dict.get("Name", None)
             ports = json_dict.get("NetworkSettings", None)
             if ports:
@@ -48,18 +49,17 @@ def __init__(self, json_dict: dict) -> None:
             self.short_id = self.id[:12] if self.id else None
             self.attrs = json_dict
             self.tags = json_dict.get("RepoTags", None)
-            self.name = self.tags[0] if self.tags else None
+            # Docker images may be prefixed with the registry URL
+            self.name = self.tags[0].split("/")[-1] if self.tags else None
 
     def get_all_containers(self) -> dict:
         """Returns the current list of containers."""
-        if not self.containers:
-            self._update_containers()
+        self._update_containers()
         return self.containers
 
     def get_all_images(self) -> dict:
         """Returns the current list of images."""
-        if not self.images:
-            self._update_images()
+        self._update_images()
         return self.images
 
     def get_projects(self) -> dict:
@@ -182,14 +182,12 @@ def exec_run(self, container_id: str, command: str) -> tuple:
         Return exit code and stdout.
         """
         try:
-            print("AKOAKO === ENTERING EXEC_RUN")
             result = subprocess.run(
                 ["docker", "exec", container_id, *command],
                 check=True,
                 capture_output=True,
                 text=True,
             )
-            print("AKOAKO === EXITING EXEC_RUN")
             return result.returncode, result.stdout
         except subprocess.CalledProcessError as ex:
             raise RuntimeError(
@@ -199,20 +197,22 @@ def exec_run(self, container_id: str, command: str) -> tuple:
     def run_container(
         self,
         image_id: str,
-        command: str,
+        command: list[str],
         parsed_volumes: dict,
         gpus: list[int | str] | None = None,
     ) -> bool:
         """Run a command in a container from an image."""
         # Convert the parsed_volumes into a list of strings in proper argument format,
         # `-v host_path:container_path:mode`.
         if not parsed_volumes:
-            parsed_volumes = []
+            volume_args = []
         else:
-            parsed_volumes = [
-                f"-v {host_path}:{volume_info['bind']}:{volume_info['mode']}"
-                for host_path, volume_info in parsed_volumes.items()
-            ]
+            volume_args = []
+            for host_path, volume_info in parsed_volumes.items():
+                volume_args.append("-v")
+                volume_args.append(
+                    f"{host_path}:{volume_info['bind']}:{volume_info['mode']}"
+                )
 
         if gpus:
             gpus_str = ",".join(gpus)
@@ -225,7 +225,7 @@ def run_container(
             "docker",
             "run",
             "--rm",
-            *parsed_volumes,
+            *volume_args,
             *([gpus_option] if gpus_option else []),
             image_id,
             *command,
@@ -245,7 +245,9 @@ def run_container(
             return result.stdout, result.stderr
 
         except subprocess.CalledProcessError as ex:
-            raise RuntimeError(f"{ex.stderr}") from ex
+            raise RuntimeError(
+                f"Error running command: `{' '.join(cmd_list)}`. \n\n{ex.stderr}"
+            ) from ex
 
     def docker_buildx(
         self,
@@ -303,6 +305,8 @@ def docker_buildx(
         if return_code != 0:
             raise RuntimeError("Error while building Docker image", logs)
 
+        # Update self.images
+        self._update_images()
         # Get image object
         image = self.get_image(tag)
         return image
@@ -316,7 +320,10 @@ def _update_containers(self) -> None:
                 text=True,
                 check=True,
             )
-            container_ids = result.stdout.strip().split("\n")
+            if not result.stdout:
+                container_ids = []
+            else:
+                container_ids = result.stdout.strip().split("\n")
 
             # Check if theres any cleaned up containers.
             for container_id in self.containers:
@@ -347,7 +354,10 @@ def _update_images(self) -> None:
                 text=True,
                 check=True,
             )
-            images = image_ids.stdout.strip().split("\n")
+            if not image_ids.stdout:
+                images = []
+            else:
+                images = image_ids.stdout.strip().split("\n")
 
             # Clean up deleted images.
             for image in self.images:

tests/conftest.py

@@ -281,16 +281,16 @@ def mocked_subprocess_run(*args, **kwargs):
         if "run" in args[0]:
             # Return args to `docker run` as json.
             args = args[0]
-
             return_dict = {"volumes": {}, "device_requests": None}
             volume_arg = args[3]
             while "-v" in volume_arg:
                 # Add all the volumes and remove them from arg list.
-                volume = args[3].split(" ")[1].split(":")
+                volume = args[4].split(":")
                 return_dict["volumes"].update(
                     {volume[0]: {"bind": volume[1], "mode": volume[2]}}
                 )
                 # Remove this argument to fix indexing for none volume cases.
+                args.pop(4)
                 args.pop(3)
                 volume_arg = args[3]
 

tests/endtoend_tests/common.py

@@ -9,12 +9,9 @@
 
 
 def image_exists(docker_wrapper, image_name):
-    # Docker images may be prefixed with the registry URL
-    return any(
-        tag.split("/")[-1] == image_name
-        for img in docker_wrapper.get_all_images()
-        for tag in img.tags
-    )
+    images = docker_wrapper.get_all_images()
+    # If any image.name starts with image_name, we consider it exists
+    return any(image_name in image.name for image in images)
 
 
 def print_debug_info(result):
@@ -26,7 +23,7 @@ def print_debug_info(result):
         traceback.print_exception(*result.exc_info)
 
 
-def build_tesseract(sourcedir, image_name, tag=None, build_retries=3):
+def build_tesseract(docker_wrapper, sourcedir, image_name, tag=None, build_retries=3):
     cli_runner = CliRunner()
 
     build_args = [
@@ -58,4 +55,5 @@ def build_tesseract(sourcedir, image_name, tag=None, build_retries=3):
 
     print_debug_info(result)
     assert result.exit_code == 0, result.exception
+    assert docker_wrapper.get_image(image_name)
     return image_name

tests/endtoend_tests/test_endtoend.py

@@ -18,7 +18,9 @@
 @pytest.fixture(scope="module")
 def built_image_name(docker_wrapper, shared_dummy_image_name, dummy_tesseract_location):
     """Build the dummy Tesseract image for the tests."""
-    image_name = build_tesseract(dummy_tesseract_location, shared_dummy_image_name)
+    image_name = build_tesseract(
+        docker_wrapper, dummy_tesseract_location, shared_dummy_image_name
+    )
     assert image_exists(docker_wrapper, image_name)
     yield image_name
 
@@ -42,7 +44,9 @@ def test_build_from_init_endtoend(
         assert yaml.safe_load(config_yaml)["name"] == dummy_image_name
 
     img_tag = "foo" if tag else None
-    image_name = build_tesseract(tmp_path, dummy_image_name, tag=img_tag)
+    image_name = build_tesseract(
+        docker_wrapper, tmp_path, dummy_image_name, tag=img_tag
+    )
     assert image_exists(docker_wrapper, image_name)
 
     # Test that the image can be run and that --help is forwarded correctly
@@ -131,7 +135,6 @@ def test_tesseract_run_stdout(built_image_name):
 def test_tesseract_serve_pipeline(docker_wrapper, built_image_name):
     cli_runner = CliRunner(mix_stderr=False)
     try:
-
         # Serve
         run_res = cli_runner.invoke(
             app,
@@ -185,6 +188,7 @@ def test_tesseract_serve_pipeline(docker_wrapper, built_image_name):
         )
         assert run_res.exit_code == 0, run_res.stderr
 
+
 @pytest.mark.parametrize("tear_all", [True, False])
 def test_tesseract_teardown_multiple(built_image_name, tear_all):
     """Teardown multiple projects."""
@@ -382,6 +386,7 @@ def test_tesseract_serve_with_volumes(built_image_name, tmp_path, docker_wrapper
         assert run_res.exit_code == 0, run_res.stderr
         assert run_res.stdout
         project_meta = json.loads(run_res.stdout)
+        project_id = project_meta["project_id"]
         tesseract0_id = project_meta["containers"][0]["name"]
         tesseract0 = docker_wrapper.get_container(tesseract0_id)
         assert tesseract0 is not None
@@ -393,7 +398,9 @@ def test_tesseract_serve_with_volumes(built_image_name, tmp_path, docker_wrapper
         with open(tmpfile, "w") as hello:
             hello.write("world")
             hello.flush()
-        exit_code, output = docker_wrapper.exec_run(tesseract0.name, ["cat", f"{dest}/hi"])
+        exit_code, output = docker_wrapper.exec_run(
+            tesseract0.name, ["cat", f"{dest}/hi"]
+        )
         assert exit_code == 0
         assert output == "world"
 
@@ -403,7 +410,9 @@ def test_tesseract_serve_with_volumes(built_image_name, tmp_path, docker_wrapper
             tesseract0.name, ["touch", f"{bar_file}"]
         )
         assert exit_code == 0
-        exit_code, output = docker_wrapper.exec_run(tesseract1.name, ["cat", f"{bar_file}"])
+        exit_code, output = docker_wrapper.exec_run(
+            tesseract1.name, ["cat", f"{bar_file}"]
+        )
         assert exit_code == 0
 
         # The file should exist outside the container

tests/endtoend_tests/test_examples.py

@@ -566,6 +566,7 @@ def test_unit_tesseract_endtoend(
 
     # Stage 1: Build
     img_name = build_tesseract(
+        docker_wrapper,
         unit_tesseract_path,
         dummy_image_name,
         tag="sometag",
@@ -651,6 +652,10 @@ def test_unit_tesseract_endtoend(
                 assert_contains_array_allclose(output_json, array)
 
     # Stage 3: Test HTTP server
+    if unit_tesseract_config.volume_mounts is not None:
+        # TODO: Mounts are not supported in HTTP mode yet, skip rest of the test for now
+        return
+
     try:
         result = cli_runner.invoke(
             app,

tests/endtoend_tests/test_tesseract_sdk.py

@@ -11,7 +11,9 @@
 @pytest.fixture(scope="module")
 def built_image_name(docker_wrapper, shared_dummy_image_name, dummy_tesseract_location):
     """Build the dummy Tesseract image for the tests."""
-    image_name = build_tesseract(dummy_tesseract_location, shared_dummy_image_name)
+    image_name = build_tesseract(
+        docker_wrapper, dummy_tesseract_location, shared_dummy_image_name
+    )
     assert image_exists(docker_wrapper, image_name)
     yield image_name