Merge pull request #649 from gibmat/flasher-tests

Add tests to exercise `flasher-tool`

Author: stgraber

.github/workflows/daily.yml

@@ -23,6 +23,11 @@ jobs:
       - name: Checkout
         uses: actions/checkout@v4
 
+      - name: Install Go
+        uses: actions/setup-go@v5
+        with:
+          go-version: stable
+
       - name: Install dependencies
         run: |
           sudo apt-get install --yes \

incus-osd/cmd/flasher-tool/main.go

@@ -718,8 +718,14 @@ func downloadCurrentIncusOSRelease(ctx context.Context, asker ask.Asker, imageFo
 
 	slog.InfoContext(ctx, "Downloading and decompressing IncusOS image ("+imageFormat+") version "+release.Version()+" from Linux Containers CDN")
 
+	// In the update metadata, the USB image installer is called "raw", so fixup the format name if needed.
+	providerFormatName := imageFormat
+	if providerFormatName == "img" {
+		providerFormatName = "raw"
+	}
+
 	// Download and decompress the image.
-	return release.DownloadImage(ctx, imageFormat, ".", nil)
+	return release.DownloadImage(ctx, providerFormatName, ".", nil)
 }
 
 // Spawn the editor with a temporary YAML file for editing configs.

incus-osd/tests/api-tests.py

@@ -9,6 +9,7 @@
 import urllib.request
 
 from incusos_tests import IncusOSTests
+from incusos_tests.incus_test_vm import IncusOSException
 
 current_release = None
 prior_stable_release = None
@@ -32,7 +33,7 @@
                 break
 
     if prior_stable_release is None:
-        raise Exception("need at least two published stable releases")
+        raise IncusOSException("need at least two published stable releases")
 
     for file in current_release["files"]:
         if file["architecture"] == "x86_64":
@@ -80,7 +81,7 @@
 
         try:
             data = future.result()
-        except Exception as e:
+        except IncusOSException as e:
             num_fail += 1
             print("FAIL: %s: %s" % (name, e.args[0]), flush=True)
 
@@ -89,6 +90,9 @@
                 for line in e.args[1]:
                     if line != "":
                         print("          %s" % line, flush=True)
+        except Exception as e:
+            num_fail += 1
+            print("FAIL: %s: %s" % (name, e), flush=True)
         else:
             num_pass += 1
             print("PASS: %s" % name, flush=True)

incus-osd/tests/incusos_tests/__init__.py

@@ -1,7 +1,7 @@
 from inspect import getmembers, isfunction
 
-from . import tests_incusos_api, tests_incusos_api_applications, tests_incusos_api_debug, tests_incusos_api_services, \
-    tests_incusos_api_system, tests_incusos_api_system_logging, tests_incusos_api_system_provider, \
+from . import tests_flasher_tool, tests_incusos_api, tests_incusos_api_applications, tests_incusos_api_debug, \
+    tests_incusos_api_services, tests_incusos_api_system, tests_incusos_api_system_logging, tests_incusos_api_system_provider, \
     tests_incusos_api_system_resources, tests_incusos_api_system_security, tests_incusos_api_system_storage_import_pool, \
     tests_incusos_api_system_storage_local_pool, tests_install_smoke, tests_install_system_checks, tests_seed_applications, \
     tests_seed_install, tests_upgrade
@@ -47,11 +47,15 @@ def GetTests(self):
             tests_incusos_api_system_storage_local_pool,
         ]
 
+        # Test the flasher-tool utility
+        flasher_tool_tests = [tests_flasher_tool]
+
         ret = []
 
         ret.extend(self._get_tests(core_tests, self.current_image_img))
         ret.extend(self._get_tests(upgrade_tests, self.prior_image_img))
         ret.extend(self._get_tests(iso_install_tests, self.current_image_iso))
+        ret.extend(self._get_tests(flasher_tool_tests, ""))
 
         return ret
 

incus-osd/tests/incusos_tests/incus_test_vm/__init__.py

@@ -6,6 +6,11 @@
 
 from . import util
 
+class IncusOSException(Exception):
+    """A custom exception raised by test code."""
+
+    pass
+
 class IncusTestVM:
     def __init__(self, vm_name_base, install_image, root_size="50GiB"):
         self.vm_name = vm_name_base + "-" + util._get_random_string()
@@ -114,7 +119,7 @@ def WaitAgentRunning(self, timeout=300):
                 pass
 
             if time.time() - start > timeout:
-                raise Exception("timed out waiting for agent to start")
+                raise IncusOSException("timed out waiting for agent to start")
 
             time.sleep(1)
 
@@ -136,7 +141,7 @@ def WaitExpectedLog(self, unit, log, timeout=480, regex=False):
                     return None
 
             if time.time() - start > timeout:
-                raise Exception(f"timed out waiting for log entry '{log}' to appear", result.stdout.decode("utf-8").split("\n"))
+                raise IncusOSException(f"timed out waiting for log entry '{log}' to appear", result.stdout.decode("utf-8").split("\n"))
 
             time.sleep(1)
 
@@ -146,7 +151,7 @@ def LogDoesntContain(self, unit, log):
         result = subprocess.run(["incus", "exec", self.vm_name, "--", "journalctl", "-b", "-u", unit], capture_output=True, check=True)
 
         if log in str(result.stdout):
-            raise Exception(f"wasn't expecting log entry '{log}' to appear")
+            raise IncusOSException(f"wasn't expecting log entry '{log}' to appear")
 
     def APIRequest(self, path, method="GET", body=None, content_type=None, return_raw_content=False):
         """Perform a HTTP REST API call, and return the result."""

incus-osd/tests/incusos_tests/tests_flasher_tool.py

@@ -0,0 +1,52 @@
+import io
+import os
+import re
+import subprocess
+import tarfile
+import tempfile
+
+from .incus_test_vm import IncusTestVM, IncusOSException
+
+def TestFlasherToolStableIMG(_):
+    test_name = "flasher-tool-stable-img"
+
+    test_image = _flasher_download_image("stable", "img")
+
+    with IncusTestVM(test_name, test_image) as vm:
+        vm.StartVM()
+        vm.WaitAgentRunning()
+        vm.WaitExpectedLog("incus-osd", "Installing IncusOS source=/dev/sdb target=/dev/sda")
+        vm.WaitExpectedLog("incus-osd", "IncusOS was successfully installed")
+
+def TestFlasherToolTestingISO(_):
+    test_name = "flasher-tool-testing-iso"
+
+    test_image = _flasher_download_image("testing", "iso")
+
+    with IncusTestVM(test_name, test_image) as vm:
+        vm.StartVM()
+        vm.WaitAgentRunning()
+        vm.WaitExpectedLog("incus-osd", "Installing IncusOS source=/dev/mapper/sr0 target=/dev/sda")
+        vm.WaitExpectedLog("incus-osd", "IncusOS was successfully installed")
+
+def _flasher_download_image(channel, image_format):
+    if not os.path.exists("./incus-osd/flasher-tool"):
+        subprocess.run(["go", "build", "./cmd/flasher-tool/"], cwd=os.path.join(os.getcwd(), "incus-osd"), capture_output=True, check=True)
+
+    with tempfile.TemporaryDirectory(dir=os.getcwd()) as tmp_dir:
+        with tarfile.open(os.path.join(tmp_dir, "seed.tar"), mode="w") as tar:
+            raw = "force_reboot: true".encode("utf-8")
+            buf = io.BytesIO(raw)
+            ti = tarfile.TarInfo(name="install.yaml")
+            ti.size = len(raw)
+            tar.addfile(ti, buf)
+
+        result = subprocess.run(["../incus-osd/flasher-tool", "--channel", channel, "--format", image_format, "--seed", "seed.tar"], cwd=tmp_dir, capture_output=True, check=True)
+
+        match = re.search("Downloading and decompressing IncusOS image \\(" + image_format + "\\) version (\\d+) from Linux Containers CDN", str(result.stderr))
+        if not match:
+            raise IncusOSException("Failed to download image")
+
+        os.rename(os.path.join(tmp_dir, "IncusOS_" + match.group(1) + "." + image_format), "flasher-install-image." + image_format)
+
+        return os.path.join(os.getcwd(), "flasher-install-image." + image_format)

incus-osd/tests/incusos_tests/tests_incusos_api.py

@@ -1,4 +1,4 @@
-from .incus_test_vm import IncusTestVM, util
+from .incus_test_vm import IncusTestVM, IncusOSException, util
 
 def TestIncusOSAPI(install_image):
     test_name = "incusos-api"
@@ -14,10 +14,10 @@ def TestIncusOSAPI(install_image):
         # Test top-level /1.0 endpoint.
         result = vm.APIRequest("/1.0")
         if result["status_code"] != 200:
-            raise Exception("unexpected status code %d: %s" % (result["status_code"], result["error"]))
+            raise IncusOSException("unexpected status code %d: %s" % (result["status_code"], result["error"]))
 
         if result["metadata"]["environment"]["os_name"] != "IncusOS":
-            raise Exception("unexpected OS Name: " + result["metadata"]["environment"]["os_name"])
+            raise IncusOSException("unexpected OS Name: " + result["metadata"]["environment"]["os_name"])
 
         if result["metadata"]["environment"]["os_version"] != incusos_version:
-            raise Exception("unexpected OS Version: " + result["metadata"]["environment"]["os_version"])
+            raise IncusOSException("unexpected OS Version: " + result["metadata"]["environment"]["os_version"])