rename autodetect_root_<type> parameters to just autodetect_<type>

setting the stage for these detection methods to be applied to all mount
types

Signed-off-by: Zen <[email protected]>

Author: desultory

docs/configuration.md

@@ -234,14 +234,14 @@ Additional modules include:
 #### ugrd.fs.mounts
 
 * `autodetect_root` (true) Set the root mount parameter based on the current root label or uuid.
-* `autodetect_root_dm` (true) Attempt to automatically configure virtual block devices such as LUKS/LVM/MDRAID.
-* `autodetect_root_luks` (true) Attempt to automatically configure LUKS mounts for the root device.
-* `autodetect_root_lvm` (true) Attempt to automatically configure LVM mounts for the root device.
-* `autodetect_root_mdraid` (true) Attempt to automatically configure MDRAID mounts for the root device.
+* `autodetect_dm` (true) Attempt to automatically configure virtual block devices such as LUKS/LVM/MDRAID.
+* `autodetect_luks` (true) Attempt to automatically configure LUKS mounts for the root device.
+* `autodetect_lvm` (true) Attempt to automatically configure LVM mounts for the root device.
+* `autodetect_mdraid` (true) Attempt to automatically configure MDRAID mounts for the root device.
 * `autodetect_init_mount'` (true) Automatically detect the mountpoint for the init binary, and add it to `late_mounts`.
 * `run_dirs` A list of directories to create under `/run/` at runtime
 
-> `autodetect_root` is required for `autodetect_root_<type>` to work.
+> `autodetect_root` is required for `autodetect_<type>` to work.
 
 `mounts`: A dictionary containing entries for mounts, with their associated config.
 

examples/luks.toml

@@ -7,7 +7,7 @@ modules = [
 ]
 
 # Device mapper autodetection is enabled by default
-# autodetect_root_luks = true
+# autodetect_luks = true
 
 # Information about the LUKS volume can be manually specified
 #[cryptsetup.root]

src/ugrd/crypto/cryptsetup.py

@@ -100,7 +100,7 @@ def _validate_cryptsetup_config(self, mapped_name: str) -> None:
         ).exists():  # Make sure the header file exists, it may not be present at build time
             self.logger.warning("[%s] Header file not found: %s" % (mapped_name, c_(config["header_file"], "yellow")))
     elif not any([config.get("partuuid"), config.get("uuid"), config.get("path")]):
-        if not self["autodetect_root_luks"]:
+        if not self["autodetect_luks"]:
             raise ValidationError(
                 "A device uuid, partuuid, or path must be specified for cryptsetup mount: %s" % mapped_name
             )

src/ugrd/fs/mounts.py

@@ -1,5 +1,5 @@
 __author__ = "desultory"
-__version__ = "7.2.1"
+__version__ = "7.3.0"
 
 from pathlib import Path
 from re import search
@@ -436,7 +436,7 @@ def get_virtual_block_info(self):
     sys_block = Path("/sys/devices/virtual/block")
 
     if not sys_block.exists():
-        self["autodetect_root_dm"] = False
+        self["autodetect_dm"] = False
         return self.logger.warning("Virtual block devices unavailable, disabling device mapper autodetection.")
 
     devices = []
@@ -450,7 +450,7 @@ def get_virtual_block_info(self):
                 devices.append(part)
 
     if not devices:
-        self["autodetect_root_dm"] = False
+        self["autodetect_dm"] = False
         return self.logger.warning("No virtual block devices found, disabling device mapper autodetection.")
 
     for virt_dev in devices:
@@ -624,7 +624,7 @@ def _autodetect_dm(self, mountpoint, device=None) -> None:
             self.logger.debug("Slave does not appear to be a DM device: %s" % slave)
 
 
-@contains("autodetect_root_raid", "Skipping RAID autodetection, autodetect_root_raid is disabled.", log_level=30)
+@contains("autodetect_raid", "Skipping RAID autodetection, autodetect_raid is disabled.", log_level=30)
 @contains("hostonly", "Skipping RAID autodetection, hostonly mode is disabled.", log_level=30)
 def autodetect_raid(self, source_dev, dm_name, blkid_info) -> None:
     """Autodetects MD RAID mounts and sets the raid config.
@@ -641,7 +641,7 @@ def autodetect_raid(self, source_dev, dm_name, blkid_info) -> None:
         raise AutodetectError("[%s] Failed to autodetect MDRAID level: %s" % (dm_name, blkid_info))
 
 
-@contains("autodetect_root_lvm", "Skipping LVM autodetection, autodetect_root_lvm is disabled.", log_level=20)
+@contains("autodetect_lvm", "Skipping LVM autodetection, autodetect_lvm is disabled.", log_level=20)
 @contains("hostonly", "Skipping LVM autodetection, hostonly mode is disabled.", log_level=30)
 def autodetect_lvm(self, source_dev, dm_num, blkid_info) -> None:
     """Autodetects LVM mounts and sets the lvm config."""
@@ -664,7 +664,7 @@ def autodetect_lvm(self, source_dev, dm_num, blkid_info) -> None:
     self["lvm"] = {source_dev.name: lvm_config}
 
 
-@contains("autodetect_root_luks", "Skipping LUKS autodetection, autodetect_root_luks is disabled.", log_level=30)
+@contains("autodetect_luks", "Skipping LUKS autodetection, autodetect_luks is disabled.", log_level=30)
 @contains("hostonly", "Skipping LUKS autodetection, hostonly mode is disabled.", log_level=30)
 def autodetect_luks(self, source_dev, dm_num, blkid_info) -> None:
     """Autodetects LUKS mounts and sets the cryptsetup config."""
@@ -748,7 +748,7 @@ def autodetect_root(self) -> None:
             "Root mount not found in host mounts.\nCurrent mounts: %s" % pretty_print(self["_mounts"])
         )
     root_dev = _autodetect_mount(self, "/")
-    if self["autodetect_root_dm"]:
+    if self["autodetect_dm"]:
         if self["mounts"]["root"]["type"] == "btrfs":
             from ugrd.fs.btrfs import _get_btrfs_mount_devices
 

src/ugrd/fs/mounts.toml

@@ -9,10 +9,10 @@ run_dirs = [ "ugrd" ]
 
 mount_timeout = 1
 autodetect_root = true
-autodetect_root_dm = true
-autodetect_root_luks = true
-autodetect_root_lvm = true
-autodetect_root_raid = true
+autodetect_dm = true
+autodetect_luks = true
+autodetect_lvm = true
+autodetect_raid = true
 autodetect_init_mount = true
 
 [imports.config_processing]
@@ -62,10 +62,10 @@ mount_timeout = "float"  # The time to wait between mount attempts
 mount_retries = "int"  # The number of times to re-attempt mounting the fstab, infinite if not set
 mount_cmd = "str"  # The mount command called by mount_root, can be overridden
 autodetect_root = "bool"  # Add the autodetect_root property, if defined, the root mount will be autodetected
-autodetect_root_dm = "bool"  # Whether or not to try to autodetect device-mapper partitions
-autodetect_root_luks = "bool"  # Whether or not to try to autodetect LUKS partitions
-autodetect_root_lvm = "bool"  # Whether or not to try to autodetect LVM partitions
-autodetect_root_raid = "bool"  # Whether or not to try to autodetect MDRAID partitions
+autodetect_dm = "bool"  # Whether or not to try to autodetect device-mapper partitions
+autodetect_luks = "bool"  # Whether or not to try to autodetect LUKS partitions
+autodetect_lvm = "bool"  # Whether or not to try to autodetect LVM partitions
+autodetect_raid = "bool"  # Whether or not to try to autodetect MDRAID partitions
 autodetect_init_mount = "bool"  # Adds a late_mount for the init target if it exists under a mount on the host
 no_fsck = "bool"  # Whether or not to skip fsck on the root device when applicable
 _mounts = "dict"  # The mounts information

src/ugrd/main.py

@@ -94,36 +94,36 @@ def main():
             "dest": "autodetect_root",
         },
         {
-            "flags": ["--autodetect-root-luks"],
+            "flags": ["--autodetect-luks"],
             "action": "store_true",
             "help": "autodetect LUKS volumes under the root partition",
         },
         {
-            "flags": ["--no-autodetect-root-luks"],
+            "flags": ["--no-autodetect-luks"],
             "action": "store_false",
-            "help": "do not autodetect root LUKS volumes",
-            "dest": "autodetect_root_luks",
+            "help": "do not autodetect LUKS volumes",
+            "dest": "autodetect_luks",
         },
-        {"flags": ["--autodetect-root-lvm"], "action": "store_true", "help": "autodetect LVM volumes"},
+        {"flags": ["--autodetect-lvm"], "action": "store_true", "help": "autodetect LVM volumes"},
         {
-            "flags": ["--no-autodetect-root-lvm"],
+            "flags": ["--no-autodetect-lvm"],
             "action": "store_false",
             "help": "do not autodetect LVM volumes",
-            "dest": "autodetect_root_lvm",
+            "dest": "autodetect_lvm",
         },
-        {"flags": ["--autodetect-root-raid"], "action": "store_true", "help": "autodetect MRRAID volumes"},
+        {"flags": ["--autodetect-raid"], "action": "store_true", "help": "autodetect MRRAID volumes"},
         {
-            "flags": ["--no-autodetect-root-raid"],
+            "flags": ["--no-autodetect-raid"],
             "action": "store_false",
             "help": "do not autodetect MRRAID volumes",
-            "dest": "autodetect_root_raid",
+            "dest": "autodetect_raid",
         },
-        {"flags": ["--autodetect-root-dm"], "action": "store_true", "help": "autodetect DM (LUKS/LVM) root partitions"},
+        {"flags": ["--autodetect-dm"], "action": "store_true", "help": "autodetect DM (LUKS/LVM) root partitions"},
         {
-            "flags": ["--no-autodetect-root-dm"],
+            "flags": ["--no-autodetect-dm"],
             "action": "store_false",
-            "help": "do not autodetect root DM volumes",
-            "dest": "autodetect_root_dm",
+            "help": "do not autodetect device mapper volumes",
+            "dest": "autodetect_dm",
         },
         {"flags": ["--print-config"], "action": "store_true", "help": "print the final config dict"},
         {"flags": ["--print-init"], "action": "store_true", "help": "print the final init structure"},
@@ -156,7 +156,7 @@ def main():
     if test:
         logger.warning("TEST MODE ENABLED")
         logger.info("Disabling DM autodetection")
-        kwargs["autodetect_root_dm"] = False
+        kwargs["autodetect_dm"] = False
         kwargs["modules"] = kwargs["modules"] + ",ugrd.base.test" if kwargs.get("modules") else "ugrd.base.test"
 
     logger.debug(f"Using the following kwargs: {kwargs}")

tests/fs/overlayfs.toml

@@ -3,4 +3,4 @@ modules = [ "ugrd.base.test", "ugrd.fs.overlayfs"]
 
 out_dir = "initramfs_test"
 cpio_compression = false
-autodetect_root_dm = false
+autodetect_dm = false

tests/fullauto.toml

@@ -12,7 +12,7 @@ out_dir = "initramfs_test"
 #test_kernel = "/boot/vmlinuz-6.6.35-gentoo-dist"
 cpio_compression = false
 
-autodetect_root_dm = false
+autodetect_dm = false
 
 # Optionally supply a kernel version, uses the current kernel version if not specified
 #kernel_version = "6.1.53-gentoo-dist"