Merge pull request #333 from desultory/dev

improve tests, add tests for the mask system, improve organization/comments

Author: desultory

tests/test_compression.py

@@ -0,0 +1,25 @@
+from unittest import TestCase, main
+
+from pycpio.errors import UnavailableCompression
+from ugrd.initramfs_generator import InitramfsGenerator
+from zenlib.logging import loggify
+
+
+@loggify
+class TestCompression(TestCase):
+    def test_xz(self):
+        """Text XZ compression for initramfs."""
+        generator = InitramfsGenerator(logger=self.logger, config="tests/fullauto.toml", cpio_compression="xz")
+        generator.build()
+
+    def test_zstd(self):
+        """Test ZSTD compression for initramfs."""
+        generator = InitramfsGenerator(logger=self.logger, config="tests/fullauto.toml", cpio_compression="zstd")
+        try:
+            generator.build()
+        except UnavailableCompression as e:
+            self.skipTest(f"ZSTD compression is not available: {e}")
+
+
+if __name__ == "__main__":
+    main()

tests/test_cryptsetup.py

@@ -27,6 +27,7 @@ def tearDown(self):
             keyfile.unlink()
 
     def test_cryptsetup_included_key(self):
+        """Tests LUKS based roots using a keyfile included in the initramfs"""
         generator = InitramfsGenerator(logger=self.logger, config="tests/cryptsetup_included_key.toml")
         generator.build()
 

tests/test_filesystems.py

@@ -1,38 +1,46 @@
 from unittest import TestCase, main
 
+from ugrd.exceptions import AutodetectError
 from ugrd.initramfs_generator import InitramfsGenerator
 from ugrd.kmod import MissingModuleError
 from zenlib.logging import loggify
 
 
 @loggify
-class TestCpio(TestCase):
+class TestFilesystems(TestCase):
     def test_ext4(self):
+        """Test ext4 root filesystem functionality."""
         generator = InitramfsGenerator(logger=self.logger, config="tests/fs/ext4.toml")
         generator.build()
 
     def test_btrfs(self):
+        """Test btrfs root filesystem functionality."""
         generator = InitramfsGenerator(logger=self.logger, config="tests/fs/btrfs.toml")
         generator.build()
 
     def test_xfs(self):
+        """Test xfs root filesystem functionality."""
         generator = InitramfsGenerator(logger=self.logger, config="tests/fs/xfs.toml")
         generator.build()
 
     def test_f2fs(self):
+        """Test f2fs root filesystem functionality."""
         generator = InitramfsGenerator(logger=self.logger, config="tests/fs/f2fs.toml")
         try:
             generator.build()
-        except MissingModuleError:
-            generator.logger.critical("F2FS is not supported on this system, skipping test.")
+        except (MissingModuleError, AutodetectError) as e:
+            self.skipTest(f"F2FS is not supported on this system: {e}")
 
     def test_overlayfs(self):
+        """Test overlayfs/tmpfs overlay over root creation."""
         generator = InitramfsGenerator(logger=self.logger, config="tests/fs/overlayfs.toml")
         generator.build()
 
     def test_squashfs(self):
+        """Test squashfs/overlayfs/tmpfs for live cd systems."""
         generator = InitramfsGenerator(logger=self.logger, config="tests/fs/squashfs.toml")
         generator.build()
 
+
 if __name__ == "__main__":
     main()

tests/test_ugrd.py

@@ -4,25 +4,39 @@
 from zenlib.logging import loggify
 
 
+def bad_function(self):
+    """A function that should not be called."""
+    return "exit 1"
+
+
 @loggify
 class TestUGRD(TestCase):
     def test_fullauto(self):
+        """Test a basic initramfs image using config determined from the build environment, with no compression."""
         generator = InitramfsGenerator(logger=self.logger, config="tests/fullauto.toml")
         generator.build()
 
-    def test_xz(self):
-        generator = InitramfsGenerator(logger=self.logger, config="tests/fullauto.toml", cpio_compression="xz")
-        generator.build()
-
-    def test_zstd(self):
-        generator = InitramfsGenerator(logger=self.logger, config="tests/fullauto.toml", cpio_compression="zstd")
-        generator.build()
-
     def test_bad_config(self):
+        """Test that a bad config file which should raise an error."""
         with self.assertRaises(ValueError):
             InitramfsGenerator(logger=self.logger, config="tests/bad_config.toml")
 
+    def test_bad_mask(self):
+        """Test that masking a critical function raises an error."""
+        generator = InitramfsGenerator(logger=self.logger, config="tests/fullauto.toml")
+        generator["masks"] = {"init_final": "do_switch_root"}
+        with self.assertRaises(RuntimeError):
+            generator.build()
+
+    def test_good_mask(self):
+        """ Tests that masking a broken function resolves a boot issue. """
+        generator = InitramfsGenerator(logger=self.logger, config="tests/fullauto.toml")
+        generator["imports"]["init_main"] += bad_function
+        generator["masks"] = {"init_main": "bad_function"}
+        generator.build()
+
     def test_no_root(self):
+        """Test without a rootfs which can be found, should cause the initramfs to restart."""
         generator = InitramfsGenerator(
             logger=self.logger, config="tests/fullauto.toml", test_no_rootfs=True, test_flag="Restarting init"
         )