Separated resume tests into a separate module

- added the `test_modules` parameter to to specify which modules to
  include in test image.

- the `test_resume` parameter now includes the extra hibernate/resume
  testing function

- including swap in the test image now works off the `test_swap_uuid`
  parameter, so it's less dependent on the resume module. would still
  be ideal to fix up the code that builds the swap at some point.

Author: truffle0

src/ugrd/base/test.py

@@ -86,7 +86,7 @@ def make_test_image(self):
         "validate": False,
         "NO_BASE": True,
         "config": None,
-        "modules": "ugrd.fs.test_image",
+        "modules": ','.join(self["test_modules"]), # By default is only "ugrd.fs.test_image"
         "out_file": self["test_rootfs_name"],
         "build_dir": self["test_rootfs_build_dir"],
         "custom_parameters": get_copy_config_types(self),

src/ugrd/base/test.toml

@@ -10,6 +10,7 @@ test_cpu = 'host'
 test_arch = 'x86_64'
 test_timeout = 30
 test_cmdline = 'console=ttyS0,115200 panic=0'
+test_modules = [ "ugrd.fs.test_image" ]
 qemu_bool_args = ['nographic', 'enable-kvm' ]
 
 [imports.build_pre]
@@ -30,4 +31,5 @@ test_flag = "str"  # Define the success flag for the test
 test_no_rootfs = "bool"  # Toggle to run tests without mounting the root image
 test_rootfs_name = "str"  # Define the name of the rootfs image
 test_rootfs_build_dir = "Path"  # Define the build directory for the rootfs image
+test_modules = "NoDupFlatList" # List of modules to include in test image
 qemu_bool_args = "NoDupFlatList"  # Define the qemu boolean arguments

src/ugrd/fs/resume.py

@@ -71,14 +71,16 @@ def handle_late_resume(self) -> None:
     # At the moment it's the same code but delayed, will change when more features are added
     return handle_early_resume(self)
 
-
 @contains("test_resume")
-def test_init_swap_uuid(self):
-    if "test_cpu" in self:
+def test_resume_setup(self) -> None:
+    if "ugrd.base.test" in self["modules"]:
+        # Add resume to the list of test modules
+        self["test_modules"] = "ugrd.fs.test_resume"
+        
+        # Create a uuid for the swap partition in the test image
         from uuid import uuid4
-
         if not self["test_swap_uuid"]:
             self["test_swap_uuid"] = swap_uuid = uuid4()
 
-        # append to test kernel cmdline and adjust planned image size to allow enough space
+        # append to QEMU kernel cmdline
         self["test_cmdline"] = f"{self.get('test_cmdline')} resume=UUID={swap_uuid}"

src/ugrd/fs/resume.toml

@@ -3,7 +3,7 @@ binaries = [ 'lsblk' ]
 test_copy_config = [ "test_resume", "test_swap_uuid" ]
 
 [imports.build_pre]
-"ugrd.fs.resume" = [ "test_init_swap_uuid" ]
+"ugrd.fs.resume" = [ "test_resume_setup" ]
 
 [imports.build_pre]
 "ugrd.fs.resume" = [ "test_init_swap_uuid" ]

src/ugrd/fs/test_image.py

@@ -15,30 +15,6 @@ def init_banner(self):
     self["banner"] = "echo ugRD Test Image"
 
 
-@contains("test_resume")
-def resume_tests(self):
-    return """
-        echo "Begin resume testing."
-        if [ "$(</sys/power/resume)" != "0:0" ] ; then
-            echo reboot > /sys/power/disk
-            echo 1 > /sys/power/pm_debug_messages
-
-            local SWAPDEV=/dev/$(source "/sys/dev/block/$(</sys/power/resume)/uevent" && echo $DEVNAME)
-            echo "Activating swap device ${SWAPDEV}..."
-            swapon ${SWAPDEV}
-
-            echo "Triggering test hibernation..."
-            echo disk > /sys/power/state || (echo "Suspend to disk failed!" ; echo c > /proc/sysrq-trigger)
-
-            # Assume at this point system has hibernated then resumed again
-            echo "Resume test completed without error."
-        else
-            echo "No resume device found! Resume test not possible!"
-            echo c > /proc/sysrq-trigger
-        fi
-    """
-
-
 @contains("test_flag", "A test flag must be set to create a test image", raise_exception=True)
 def complete_tests(self):
     return f"""
@@ -156,7 +132,7 @@ def make_test_image(self):
         _allocate_image(self, image_path)
 
     loopback = None
-    if self.get("test_resume"):
+    if self.get("test_swap_uuid"):
         try:
             self._run(["sgdisk", "-og", "-n", "1:0:+128M", "-n", "2:0:0", image_path])
         except RuntimeError as e:
@@ -168,6 +144,7 @@ def make_test_image(self):
 
             image_path = f"{loopback}p2"
         except RuntimeError as e:
+            self._run(["losetup", "-d", loopback])   # Free loopback device on fail
             raise RuntimeError("Failed to allocate loopback device for disk creation: %s", e)
 
         # sleep for 100ms, to give the loopback device time to scan for partitions
@@ -178,6 +155,7 @@ def make_test_image(self):
         try:
             self._run(["mkswap", "-U", self["test_swap_uuid"], f"{loopback}p1"])
         except RuntimeError as e:
+            self._run(["losetup", "-d", loopback])
             raise RuntimeError("Failed to create swap partition on test disk: %s", e)
 
     if rootfs_type == "ext4":

src/ugrd/fs/test_image.toml

@@ -10,9 +10,6 @@ _cryptsetup_root = "root"
 [imports.build_pre]
 "ugrd.fs.test_image" = ["init_banner"]
 
-[imports.init_main]
-"ugrd.fs.test_image" = ["resume_tests"]
-
 [imports.init_final]
 "ugrd.fs.test_image" = ["complete_tests"]
 

src/ugrd/fs/test_resume.py

@@ -0,0 +1,26 @@
+__version__ = "2.0.0"
+
+from zenlib.util import contains
+
+@contains("test_resume")
+def resume_tests(self):
+    return """
+        echo "Begin resume testing."
+        if [ "$(</sys/power/resume)" != "0:0" ] ; then
+            echo reboot > /sys/power/disk
+            echo 1 > /sys/power/pm_debug_messages
+
+            local SWAPDEV=/dev/$(source "/sys/dev/block/$(</sys/power/resume)/uevent" && echo $DEVNAME)
+            echo "Activating swap device ${SWAPDEV}..."
+            swapon ${SWAPDEV}
+
+            echo "Triggering test hibernation..."
+            echo disk > /sys/power/state || (echo "Suspend to disk failed!" ; echo c > /proc/sysrq-trigger)
+
+            # Assume at this point system has hibernated then resumed again
+            echo "Resume test completed without error."
+        else
+            echo "No resume device found! Resume test not possible!"
+            echo c > /proc/sysrq-trigger
+        fi
+    """

src/ugrd/fs/test_resume.toml

@@ -0,0 +1,2 @@
+[imports.init_main]
+"ugrd.fs.test_resume" = ["resume_tests"]