Various cleanup and improvements

Sorry! That is a terrible commit message, but I've been coding
frantically and watching Topgun with the missus.

She's never seen it. Watching vicariously I'm becoming increasingly
certain that Topgun is a chickflick masquerading as a action movie.

Author: cscutcher

README.md

@@ -0,0 +1,8 @@
+# snapper_systemd_boot
+
+### TODO
+
+* Look at user metadata to decide whether to clone vmlinuz and initramfs
+* Hook into snapper
+* Cleanup and commit
+

setup.cfg

@@ -0,0 +1,5 @@
+[tool:pytest]
+addopts = -v
+testpaths = snapper_systemd_boot
+python_files = *.py
+log_cli = true

setup.py

@@ -12,7 +12,7 @@
     },
     entry_points={
         "console_scripts": [
-            "snapper-systemd-boot = snapper_systemd_boot.main:main",
+            "snapper-systemd-boot = snapper_systemd_boot.cli:main",
         ]
     }
 )

snapper_systemd_boot.conf.example

@@ -1,13 +1,14 @@
 [DEFAULT]
 
-IMAGES_SOURCE = /boot
+KERNEL_IMAGE_SOURCE = .bootbackup/pre/vmlinuz-linux
+INITRAMFS_IMAGE_SOURCE = .bootbackup/pre/initramfs-linux.img
+
+IMAGES_SNAPSHOT_DIR = /boot/snapper
 SYSTEMD_ENTRIES = /boot/loader/entries
+
 ENTRY_PREFIX = arch-auto-snapshot-
 ENTRY_TEMPLATE =
-    title Arch Linux (Snapshot {date} [{snapshot.num}])
+    title Arch Linux (Snapshot {snapshot.iso_timestamp} [{snapshot.num}])
     linux /vmlinuz-linux
     initrd /initramfs-linux.img
-    options \
-        cryptdevice=UUID=d79c85d5-0ed6-4b92-b3dd-e7b6fc7dee9f:aeryn-root-crypt\
-        root=/dev/mapper/aeryn-root-crypt quiet rw\
-        rootflags=subvol=@/.snapshots/{snapshot.num}/snapshot
+    options cryptdevice=UUID=d79c85d5-0ed6-4b92-b3dd-e7b6fc7dee9f:aeryn-root-crypt root=/dev/mapper/aeryn-root-crypt quiet rw rootflags=subvol=@/.snapshots/{snapshot.num}/snapshot

snapper_systemd_boot/cli.py

@@ -0,0 +1,155 @@
+# -*- coding: utf-8 -*-
+"""
+CLI for snapper_systemd_boot
+"""
+import json
+import logging
+import textwrap
+
+import argh
+
+from snapper_systemd_boot import context
+from snapper_systemd_boot.manager import SnapperSystemDBootManager
+
+DEV_LOGGER = logging.getLogger(__name__)
+
+
+def update():
+    """
+    Update systemd-boot entries based on snapper snapshots.
+    """
+    DEV_LOGGER.info("Update entries.")
+    inst = context.get_manager()
+    inst.remove_boot_configs()
+    inst.write_boot_entries()
+
+
+def remove():
+    """
+    Remove all systemd-boot entries generated from snapper snapshots.
+    """
+    DEV_LOGGER.info("Remove existing entries.")
+    inst = context.get_manager()
+    snapper = context.get_snapper()
+    config = context.get_config()
+    inst = SnapperSystemDBootManager(snapper, config)
+    inst.remove_boot_configs()
+
+
+def view_config():
+    """
+    Print config
+    """
+    config = context.get_config()
+    print(config)
+
+
+class SnapshotListWrapper:
+    def __init__(self, snapshot):
+        self.snapshot = snapshot
+
+    def __getattr__(self, name):
+        return getattr(self.snapshot, name)
+
+    @property
+    def userdata_compact_str(self):
+        """
+        Outputs userdata in compact one line string.
+        """
+        return textwrap.shorten(
+            json.dumps(self.userdata),
+            width=70,
+            placeholder="...}")
+
+    @property
+    def description(self):
+        """
+        Shorten description for output.
+        """
+        return textwrap.shorten(
+            self.snapshot.description,
+            width=80,
+            placeholder="...")
+
+    def __str__(self):
+        return textwrap.dedent("""\
+            {s.num:04}: {s.description}
+                created: {s.iso_timestamp}
+                type: {s.type.name}
+                user_data: {s.userdata_compact_str:.70}
+        """.format(s=self))
+
+
+def list_snapshots():
+    """
+    List snapshots that will be converted into entries.
+    """
+    DEV_LOGGER.info("List applicable snapshots")
+    inst = context.get_manager()
+    snapper = context.get_snapper()
+    config = context.get_config()
+    inst = SnapperSystemDBootManager(snapper, config)
+
+    yield "Snapshots to make entries:"
+
+    for snapshot in map(SnapshotListWrapper, inst.get_snapshots_iter()):
+        yield textwrap.indent(str(snapshot), "  ")
+
+
+def list_generated():
+    """
+    List the filenames of already generated entries.
+    """
+    DEV_LOGGER.info("List generated snapshots")
+    inst = context.get_manager()
+    snapper = context.get_snapper()
+    config = context.get_config()
+    inst = SnapperSystemDBootManager(snapper, config)
+    for p in inst.get_existing_entries():
+        yield str(p)
+
+
+def list_entries():
+    """
+    List entries that will be written.
+    """
+    DEV_LOGGER.info("List generated entries.")
+    inst = context.get_manager()
+    snapper = context.get_snapper()
+    config = context.get_config()
+    inst = SnapperSystemDBootManager(snapper, config)
+    for entry in inst.get_boot_entries():
+        yield "Will write to path:"
+        yield textwrap.indent(str(entry.get_entry_path()), "  ")
+        yield "\nWill write:"
+        yield textwrap.indent(str(entry.get_contents()), "  ")
+        yield "=" * 80
+        yield "\n"
+
+
+def main():
+    parser = argh.ArghParser()
+    parser.add_commands([
+        update,
+        remove,
+        view_config,
+        list_generated,
+        list_snapshots,
+        list_entries,
+    ])
+    parser.add_argument(
+        "--log-level",
+        action="store",
+        default="WARNING",
+        help="Set the log level for the process.",
+    )
+    parser.set_default_command(update)
+
+    ns = parser.parse_args()
+    logging.basicConfig(level=getattr(logging, ns.log_level))
+
+    parser.dispatch()
+
+
+if __name__ == "__main__":
+    main()

snapper_systemd_boot/config.py

@@ -8,16 +8,12 @@ class SnapperSystemDBootConfig:
     def __init__(
             self,
             *ignore,
-            image_source_path,
             systemd_entries_path,
             entry_prefix,
             entry_template,
             ):
         assert not ignore
 
-        self.image_source_path = Path(image_source_path)
-        assert self.image_source_path.is_dir()
-
         self.systemd_entries_path = Path(systemd_entries_path)
         assert self.systemd_entries_path.is_dir()
 
@@ -30,13 +26,11 @@ def from_filename(cls, filename):
         config.read(filename)
         section = config["DEFAULT"]
         return cls(
-            image_source_path=section["IMAGES_SOURCE"],
             systemd_entries_path=section["SYSTEMD_ENTRIES"],
             entry_prefix=section["ENTRY_PREFIX"],
             entry_template=section["ENTRY_TEMPLATE"])
 
     __repr__ = GetattrRepr(
-        image_source_path="image_source_path",
         systemd_entries_path="systemd_entries_path",
         entry_prefix="entry_prefix",
         entry_template="entry_template",

snapper_systemd_boot/conftest.py

@@ -14,10 +14,9 @@ def snapper():
 
 @pytest.fixture
 def config(tmpdir):
-    image_source_path = Path(tmpdir.mkdir("image_source"))
     systemd_entries_path = Path(tmpdir.mkdir("systemd_entries"))
     entry_template = dedent("""
-        title Arch Linux (Snapshot {date} [{snapshot.num}])
+        title Arch Linux (Snapshot {snapshot.iso_timestamp} [{snapshot.num}])
         linux /vmlinuz-linux
         initrd /initramfs-linux.img
         options \
@@ -27,7 +26,6 @@ def config(tmpdir):
     """)
 
     yield SnapperSystemDBootConfig(
-        image_source_path=image_source_path,
         systemd_entries_path=systemd_entries_path,
         entry_prefix="arch-auto-snapshot-",
         entry_template=entry_template)