improve logging, bash autocomplete, docs. remove required_modules

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

Author: desultory

completion/ugrd

@@ -9,6 +9,7 @@ _ugrd_autocomplete() {
 	args+=" ${option}"
     done <<< "$(ugrd --dump_args)"
 
+    args+=" $(ls)"
     COMPREPLY=()
     case "${prev}" in
 		--config|-c)
@@ -20,7 +21,11 @@ _ugrd_autocomplete() {
 			return 0    
 			;;
 		*)
-			mapfile -t COMPREPLY < <(compgen -W "${args}" -- "${cur}")
+			if [[ "${cur}" == -* ]]; then
+				mapfile -t COMPREPLY < <(compgen -W "${args}" -- "${cur}")
+				return 0
+			fi
+			mapfile -t COMPREPLY < <(compgen -f -- "${cur}")
 			return 0
 			;;
 	esac

readme.md

@@ -118,6 +118,13 @@ An initramfs environment will be generated at `build_dir` (`/tmp/initramfs/`).
 
 The initramfs will be packed to `out_dir` (`/tmp/initramfs_out`) and named `out_file` (`ugrd.cpio`).
 
+## Config information
+
+The final config dict can be printed with `--print-config`.
+
+A list of functions by runlevel can be printed with `--print-init`.
+
+
 ### Embedding the initramfs image into the kernel
 
 The `build_dir`can be embedded into the Linux kernel with:
@@ -209,7 +216,7 @@ Verbose information about what what is being moved into the initramfs build dire
 
 `_build_log_level` can be manually set to any log level. It is incremented by 10 when `build_logging` is enabled, with a minimum of 20.
 
-This can be enabled at runtime with `--build-logging` or disabled wit `--no-build-logging`
+This can be enabled at runtime with `--build-logging` or disabled with `--no-build-logging`
 
 The output can be logged to a file instead of stdout by specifying a log file with `--log-file`
 

src/ugrd/base/core.toml

@@ -10,8 +10,6 @@ old_count = 1
 
 binaries = [ "/bin/bash" ]
 
-required_parameters = [ "clean", "old_count", "build_dir", "out_dir", "file_owner", "validate", "hostonly"]
-
 [nodes.console]
 mode = 0o644
 major = 5

src/ugrd/fs/cpio.py

@@ -1,5 +1,5 @@
 __author__ = 'desultory'
-__version__ = '2.5.1'
+__version__ = '2.6.0'
 
 
 from pycpio import PyCPIO
@@ -31,11 +31,17 @@ def make_cpio(self) -> None:
 
 def _process_out_file(self, out_file):
     """ Processes the out_file configuration option. """
+    from pathlib import Path
+    if Path(out_file).is_dir():
+        self.logger.info("Specified out_file is a directory, setting out_dir: %s" % out_file)
+        self['out_dir'] = out_file
+        return
+
     if out_file.startswith('./'):
         from pathlib import Path
         self.logger.debug("Relative out_file path detected: %s" % out_file)
         self['out_dir'] = Path('.').resolve()
-        self.logger.info("out_dir resolve to: %s" % self['out_dir'])
+        self.logger.info("Resolved out_dir to: %s" % self['out_dir'])
         out_file = Path(out_file[2:])
 
     dict.__setitem__(self, 'out_file', out_file)

src/ugrd/fs/cpio.toml

@@ -1,14 +1,12 @@
 out_file = "ugrd.cpio"
 mknod_cpio = true
 
-required_parameters = ['out_file']
-
 [imports.config_processing]
 "ugrd.fs.cpio" = [ "_process_out_file" ]
 
 [imports.pack]
 "ugrd.fs.cpio" = [ "make_cpio" ]
 
 [custom_parameters]
-out_file =  "str"  # The name of the cpio file to create.
+out_file = "str"  # The name of the cpio file to create.
 mknod_cpio = "bool"  # When enabled, mknod is not used to create device nodes, they are just created in the cpio.

src/ugrd/initramfs_dict.py

@@ -1,6 +1,6 @@
 
 __author__ = "desultory"
-__version__ = "1.2.0"
+__version__ = "1.3.0"
 
 from tomllib import load, TOMLDecodeError
 from pathlib import Path
@@ -24,7 +24,6 @@ class InitramfsConfigDict(dict):
     """
     builtin_parameters = {'modules': NoDupFlatList,  # A list of the names of modules which have been loaded, mostly used for dependency checking
                           'imports': dict,  # A dict of functions to be imported into the initramfs, under their respective hooks
-                          'required_parameters': NoDupFlatList,  # A list of parameters which must be set before the initramfs can be generated
                           'custom_parameters': dict,  # Custom parameters loaded from imports
                           'custom_processing': dict,  # Custom processing functions which will be run to validate and process parameters
                           '_processing': dict}  # A dict of queues containing parameters which have been set before the type was known
@@ -222,18 +221,8 @@ def verify_mask(self) -> None:
                         runlevel.remove(function)
                         self.logger.warning("[%s] Masking import: %s" % (mask_hook, function.__name__))
 
-    def verify_required_parameters(self) -> None:
-        """ Verifies that all required parameters are set """
-        for parameter in self['required_parameters']:
-            if parameter not in self:
-                self.logger.error(self)
-                raise KeyError("Required parameter not found in config: %s" % parameter)
-
-        self.logger.debug("Verified required parameters: %s" % self['required_parameters'])
-
     def validate(self) -> None:
         """ Validate config """
-        self.verify_required_parameters()
         if self['_processing']:
             self.logger.critical("Unprocessed config values: %s" % ', '.join(list(self['_processing'].keys())))
         self.verify_mask()

src/ugrd/initramfs_generator.py

@@ -1,4 +1,3 @@
-
 from tomllib import load
 from typing import Union
 from pathlib import Path
@@ -66,8 +65,6 @@ def get(self, item, default=None):
     def __getattr__(self, item):
         """ Allows access to the config dict via the InitramfsGenerator object. """
         if item not in self.__dict__ and item != 'config_dict':
-            if item not in self.config_dict['required_parameters']:
-                self.logger.warning("Accessing non-required parameter through getattr -> config_dict: %s" % item)
             return self[item]
         return super().__getattr__(item)
 
@@ -184,7 +181,7 @@ def generate_init(self) -> None:
         if self.included_functions:
             init_funcs = self.generate_init_funcs()
             self._write('init_funcs.sh', init_funcs, 0o755)
-            self.logger.info("Included functions: %s" % list(self.included_functions.keys()))
+            self.logger.info("Included functions: %s" % ', '.join(list(self.included_functions.keys())))
             init.insert(3, "source init_funcs.sh")
             if self['imports'].get('custom_init'):
                 custom_init.insert(2, f"echo 'Starting custom init, UGRD v{__version__}'")

src/ugrd/main.py

@@ -26,11 +26,13 @@ def main():
                  {'flags': ['--autodetect-root-luks'], 'action': 'store_true', 'help': 'autodetect LUKS volumes under the root partition'},
                  {'flags': ['--no-autodetect-root-luks'], 'action': 'store_false', 'help': 'do not autodetect root LUKS volumes', 'dest': 'autodetect_root_luks'},
                  {'flags': ['--print-config'], 'action': 'store_true', 'help': 'print the final config dict'},
+                 {'flags': ['--print-init'], 'action': 'store_true', 'help': 'print the final init structure'},
                  {'flags': ['out_file'], 'action': 'store', 'help': 'set the output image location', 'nargs': '?'}]
 
     args, logger = get_args_n_logger(package=__package__, description='MicrogRAM disk initramfs generator', arguments=arguments, drop_default=True)
     kwargs = get_kwargs_from_args(args, logger=logger)
     kwargs.pop('print_config', None)  # This is not a valid kwarg for InitramfsGenerator
+    kwargs.pop('print_init', None)  # This is not a valid kwarg for InitramfsGenerator
 
     logger.debug(f"Using the following kwargs: {kwargs}")
     generator = InitramfsGenerator(**kwargs)
@@ -46,6 +48,14 @@ def main():
     if 'print_config' in args and args.print_config:
         print(generator.config_dict)
 
+    if 'print_init' in args and args.print_init:
+        for runlevel in ['init_pre', *generator.init_types, 'init_final']:
+            if runlevel not in generator.imports:
+                continue
+            print({runlevel} + ":")
+            for func in generator.imports[runlevel]:
+                print(f"    {func.__name__}")
+
 
 if __name__ == '__main__':
     main()