remove force_out, improve comments/testing

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

Author: desultory

docs/configuration.md

@@ -43,7 +43,6 @@ Modules write to a shared config dict that is accessible by other modules.
 * `find_libgcc` (true) Automatically locates libgcc using ldconfig -p and adds it to the initramfs.
 * `out_dir` (initramfs_out) If relative, it will be placed under `tmpdir`, defines the output directory.
 * `out_file` Sets the name of the output file, under `out_dir`.
-* `force_out` (false) Forces out_file/dir to ignore the defined TMPDIR.
 * `clean` (true) forces the build dir to be cleaned on each run.
 * `old_count` (1) Sets the number of old file to keep when running the `_rotate_old` function.
 * `binaries` - A list used to define programs to be pulled into the initrams. `which` is used to find the path of added entries, and `lddtree` is used to resolve dependendies.

src/ugrd/base/core.py

@@ -194,9 +194,6 @@ def _process_out_file(self, out_file: str) -> None:
     If set to the current directory, resolves and sets the out_dir to the current directory.
     If a '/' is present, resolves the path and sets the out_dir to the parent directory.
     If out_file is a directory, sets the out_dir to the directory, stops processing.
-
-    If it's an absolute path, sets the out_dir to the parent directory.
-    otherise, force_out is enabled, sets the out_dir to the resolved parent directory.
     """
     out_file = str(out_file)
     if out_file == "./" or out_file == ".":
@@ -220,9 +217,6 @@ def _process_out_file(self, out_file: str) -> None:
         self["out_dir"] = out_file.parent
         self.logger.info("Resolved out_dir to: %s" % self["out_dir"])
         out_file = out_file.name
-    elif self["force_out"]:
-        self["out_dir"] = out_file.parent.resolve()
-        out_file = out_file.name
 
     self.data["out_file"] = out_file
 

src/ugrd/base/core.toml

@@ -74,6 +74,5 @@ masks = "dict"  # Imports to be masked in the initramfs
 make_nodes = "bool"  # If true, actual device nodes will be created in the build dir
 out_dir = "Path"  # The directory where the initramfs is packed/output. If no packer is used, this is the final output directory.
 out_file = "str"  # The name of the output file, if absolute, overrides out dir with the path, and sets out_file to the filename
-force_out = "bool"  # If true, the out_dir will be interpreted literally, and the initramfs will be output there
 old_count = "int"  # The number of times to cycle old files before deleting
 clean = "bool"  # Add the clean property, used to define if the mounts should be cleaned up after boot

src/ugrd/base/test.toml

@@ -2,7 +2,7 @@ test_rootfs_name = 'ugrd-test-rootfs'
 test_rootfs_build_dir = 'initramfs_test_rootfs'
 test_image_size = 16
 
-test_copy_config = ["mounts", "force_out", "out_dir", "tmpdir", "clean", "test_image_size", "test_flag", "cryptsetup"]
+test_copy_config = ["mounts", "out_dir", "tmpdir", "clean", "test_image_size", "test_flag", "cryptsetup"]
 
 test_memory = '256M'
 test_cpu = 'host'

src/ugrd/generator_helpers.py

@@ -4,7 +4,7 @@
 
 from zenlib.util import pretty_print
 
-__version__ = "1.3.8"
+__version__ = "1.3.9"
 __author__ = "desultory"
 
 
@@ -25,7 +25,7 @@ class GeneratorHelpers:
     def _get_out_path(self, path: Union[Path, str]) -> Path:
         """Takes a filename, if the out_dir is relative, returns the path relative to the tmpdir.
         If the out_dir is absolute, returns the path relative to the out_dir."""
-        if self.out_dir.is_absolute() or self.get("force_out"):
+        if self.out_dir.is_absolute():
             return get_subpath(self.out_dir, path)
         return get_subpath(get_subpath(self.tmpdir, self.out_dir), path)
 

tests/test_output_paths.py

@@ -55,10 +55,10 @@ def test_TMPDIR(self):
         finally:
             environ.pop("TMPDIR")
 
-    def test_force_out(self):
-        """ Tests force_out which ignores the tmpdir prefix """
+    def test_implied_relative_output(self):
+        """ Tests implied relative output paths. Should resolve out_dir to the current dir. """
         out_file = "implied/relative/path/initrd"
-        generator = InitramfsGenerator(logger=self.logger, config="tests/fullauto.toml", out_file=out_file, force_out=True)
+        generator = InitramfsGenerator(logger=self.logger, config="tests/fullauto.toml", out_file=out_file)
         out_path = Path(out_file)
         if out_path.exists():
             self.fail(f"File {out_file} already exists")
@@ -68,6 +68,8 @@ def test_force_out(self):
         test_image = out_path.parent / generator["test_rootfs_name"]
         self.assertTrue(test_image.exists())
         test_image.unlink()
+        generator["out_dir"].rmdir()
+
 
 
 if __name__ == "__main__":