SIMPLE-7745 - allow .tar.gz image file extension (#147)

* SIMPLE-7745 - allow .tar.gz image file extension

* Path is supported in import_lab_from_path

Author: virlos

tests/test_image_upload.py

@@ -22,6 +22,7 @@
 import contextlib
 import pathlib
 from io import BufferedReader
+from typing import Iterator
 from unittest.mock import ANY, MagicMock
 
 import pytest
@@ -51,7 +52,8 @@
     "file. qcow",
     "file.qcow2 2",
     "file.qcow ",
-    "file.qcow.tar.gz",
+    "file.qcow.gz",
+    "file.tgz",
 ]
 EXPECTED_PASS_LIST = [
     "file.qcow",
@@ -62,6 +64,7 @@
     "file.iol",
     "qcow.iol",
     "file.tar",
+    "file.tar.gz",
 ]
 
 
@@ -77,7 +80,7 @@ def create_test_files(change_test_dir):
 
 
 @contextlib.contextmanager
-def windows_path(path: str):
+def windows_path(path: str) -> Iterator[None]:
     if "\\" in path:
         orig = pathlib.Path
         pathlib.Path = pathlib.PureWindowsPath
@@ -86,7 +89,7 @@ def windows_path(path: str):
         finally:
             pathlib.Path = orig
     else:
-        yield path
+        yield
 
 
 @pytest.mark.parametrize(
@@ -98,10 +101,12 @@ def windows_path(path: str):
     "test_string",
     WRONG_FORMAT_LIST + NOT_SUPPORTED_LIST + EXPECTED_PASS_LIST,
 )
-def test_image_upload_file(rename: str, test_string: str, test_path: str):
+def test_image_upload_file(rename: str | None, test_string: str, test_path: str):
     session = MagicMock()
     nid = NodeImageDefinitions(session)
     filename = test_path + test_string
+    if rename is not None:
+        rename += test_string
 
     if test_string in WRONG_FORMAT_LIST:
         with pytest.raises(InvalidImageFile, match="wrong format"):
@@ -123,6 +128,10 @@ def test_image_upload_file(rename: str, test_string: str, test_path: str):
         assert pathlib.Path(file.name).resolve() == pathlib.Path(filename).resolve()
         file.close()
     else:
+        if rename is not None:
+            with pytest.raises(InvalidImageFile, match="does not match source"):
+                with windows_path(filename):
+                    nid.upload_image_file(filename, rename[:-3])
         with pytest.raises(FileNotFoundError):
             with windows_path(filename):
                 nid.upload_image_file(filename, rename)

virl2_client/models/node_image_definition.py

@@ -33,6 +33,10 @@
     import httpx
 
 
+TARGZ = ".tar.gz"
+EXTENSION_LIST = [".qcow", ".qcow2", ".iol", ".tar", TARGZ]
+
+
 class NodeImageDefinitions:
     _URL_TEMPLATES = {
         "node_defs": "node_definitions",
@@ -216,31 +220,37 @@ def upload_image_file(
         :param filename: The path of the image to upload.
         :param rename: Optional filename to rename to.
         """
-        extension_list = [".qcow", ".qcow2", ".iol", ".tar"]
         url = self._url_for("upload")
 
         path = pathlib.Path(filename)
-        extension = "".join(path.suffixes)
-        last_ext = path.suffix
+
+        extension = TARGZ if filename.endswith(TARGZ) else path.suffix
         name = rename or path.name
 
+        if not name.endswith(extension):
+            message = (
+                f"Specified filename ({name}) does not match source file's "
+                f"extension ({extension}), possibly using a different file format."
+            )
+            raise InvalidImageFile(message)
+
         if extension == "" or name == "":
             message = (
                 f"Specified filename ({name}) has wrong format "
-                f"(correct format is filename.({'|'.join(extension_list)}) )."
+                f"(correct format is filename.({'|'.join(EXTENSION_LIST)}) )."
             )
             raise InvalidImageFile(message)
 
-        if extension not in extension_list and last_ext not in extension_list:
+        if extension not in EXTENSION_LIST:
             message = (
                 f"Specified filename ({name}) has unsupported extension ({extension}) "
-                f"(supported extensions are {', '.join(extension_list)})."
+                f"(supported extensions are {', '.join(EXTENSION_LIST)})."
             )
             raise InvalidImageFile(message)
 
-        if not os.path.exists(filename):
+        if not os.path.isfile(filename):
             raise FileNotFoundError(filename)
-
+        # TODO: a library should not be printing to stdout unless interactive
         print(f"Uploading {name}")
         headers = {"X-Original-File-Name": name}
 

virl2_client/virl2_client.py

@@ -585,7 +585,7 @@ def _create_imported_lab(
         )
 
     @locked
-    def import_lab_from_path(self, path: str, title: str | None = None) -> Lab:
+    def import_lab_from_path(self, path: Path | str, title: str | None = None) -> Lab:
         """
         Import an existing topology from a file or path.