From 6be6cab8272d4bb9e13e5e8aa6651fb4ac45b1ad Mon Sep 17 00:00:00 2001 From: Wes Barnett Date: Mon, 15 Feb 2021 08:42:03 -0500 Subject: [PATCH] Create SnapperCmd class --- Makefile | 4 +- snap_pac.py => scripts/snap_pac.py | 93 ++++++++++++++++-------------- tests.py | 2 +- 3 files changed, 54 insertions(+), 45 deletions(-) rename snap_pac.py => scripts/snap_pac.py (60%) diff --git a/Makefile b/Makefile index 45bef53..7e68061 100644 --- a/Makefile +++ b/Makefile @@ -23,9 +23,9 @@ SHARE_DIR = $(DESTDIR)$(PREFIX)/share .PHONY: install install: - @install -Dm755 snap_pac.py $(SHARE_DIR)/libalpm/scripts/snap-pac + @install -Dm755 scripts/snap_pac.py $(SHARE_DIR)/libalpm/scripts/snap-pac @install -Dm644 hooks/* -t $(SHARE_DIR)/libalpm/hooks/ @install -Dm644 LICENSE -t $(SHARE_DIR)/licenses/$(PKGNAME)/ @install -Dm644 man8/* -t $(SHARE_DIR)/man/man8/ @install -Dm644 README.md -t $(SHARE_DIR)/doc/$(PKGNAME)/ - @install -Dm644 extra/snap-pac.ini -t $(DESTDIR)/etc/snap-pac.ini.example + @install -Dm644 extra/snap-pac.ini $(DESTDIR)/etc/snap-pac.ini.example diff --git a/snap_pac.py b/scripts/snap_pac.py similarity index 60% rename from snap_pac.py rename to scripts/snap_pac.py index 06cd248..5337468 100755 --- a/snap_pac.py +++ b/scripts/snap_pac.py @@ -27,39 +27,28 @@ import sys logging.basicConfig(format="%(message)s", level=logging.INFO) -def create_snapper_cmd(preorpost, config, section, prefile): - """Populate the snapper command.""" - try: - chroot = os.stat("/") != os.stat("/proc/1/root/.") - except PermissionError: - logging.warning("Unable to detect if in chroot. Run script as root.") - chroot = False - snapper_cmd = ["snapper"] - if chroot: - snapper_cmd.append("--no-dbus") - snapper_cmd.append(f"--config {section} create") - snapper_cmd.append(f"--type {preorpost}") - snapper_cmd.append(f"--cleanup-algorithm {config.get(section, 'cleanup_algorithm')}") - snapper_cmd.append("--print-number") - desc_limit = config.getint(section, "desc_limit") - if preorpost == "pre": - snapper_cmd.append(f"--description {config.get(section, 'pre_description')[:desc_limit]}") - else: - snapper_cmd.append(f"--description {config.get(section, 'post_description')[:desc_limit]}") - with open(prefile, "r") as f: - pre_number = f.read().rstrip("\n") - snapper_cmd.append(f"--pre-number {pre_number}") - os.remove(prefile) - return snapper_cmd +class SnapperCmd: + def __init__(self, config, snapshot_type, cleanup_algorithm, description, dbus=False, pre_number=None): + self.cmd = ["snapper"] + if dbus: + self.cmd.append("--no-dbus") + self.cmd.append(f"--config {config} create") + self.cmd.append(f"--type {snapshot_type}") + self.cmd.append(f"--cleanup-algorithm {cleanup_algorithm}") + self.cmd.append("--print-number") + self.cmd.append(f"--description {description}") + if snapshot_type == "post": + if pre_number is not None: + self.cmd.append(f"--pre-number {pre_number}") + else: + raise ValueError("snapshot type specified as 'post' but no pre snapshot number passed.") -def do_snapshot(preorpost, cmd, prefile): - """Run the actual snapper command and save snapshot number if pre snapshot.""" - num = os.popen(" ".join(cmd)).read().rstrip("\n") - if preorpost == "pre": - with open(prefile, "w") as f: - f.write(num) - return num + def __call__(self): + return os.popen(self.__str__()).read().rstrip("\n") + + def __str__(self): + return " ".join(self.cmd) def get_snapper_configs(conf_file): @@ -89,6 +78,28 @@ def setup_config_parser(ini_file, parent_cmd, packages): return config +def get_description(preorpost, config, section): + desc_limit = config.getint(section, "desc_limit") + if preorpost == "pre": + return config.get(section, "pre_description")[:desc_limit] + else: + return config.get(section, "post_description")[:desc_limit] + + +def get_pre_number(preorpost, config, section): + prefile = f"/tmp/snap-pac-pre_{section}" + logging.debug(f"{prefile = }") + if args.preorpost == "pre": + pre_number = None + else: + try: + with open(prefile, "r") as f: + pre_number = f.read().rstrip("\n") + except FileNotFoundError: + logging.error("prefile not found") + return pre_number + + def main(snap_pac_ini, snapper_conf_file, args): if os.getenv("SNAP_PAC_SKIP", "n") in ["y", "Y", "yes", "Yes", "YES"]: @@ -98,6 +109,7 @@ def main(snap_pac_ini, snapper_conf_file, args): packages = " ".join([line.rstrip("\n") for line in sys.stdin]) config = setup_config_parser(snap_pac_ini, parent_cmd, packages) snapper_configs = get_snapper_configs(snapper_conf_file) + chroot = os.stat("/") != os.stat("/proc/1/root/.") for c in snapper_configs: @@ -106,17 +118,14 @@ def main(snap_pac_ini, snapper_conf_file, args): logging.debug(f"{c = }") if config.getboolean(c, "snapshot"): - prefile = f"/tmp/snap-pac-pre_{c}" - logging.debug(f"{prefile = }") - try: - snapper_cmd = create_snapper_cmd(args.preorpost, config, c, prefile) - logging.debug(f"{snapper_cmd = }") - except FileNotFoundError: - logging.error(f"Error: File containing pre snapshot number not found for \"{c}\" configuration. " - "If you are installing snap-pac for the first time, this is normal and can be ignored.") - else: - num = do_snapshot(args.preorpost, snapper_cmd, prefile) - logging.info(f"==> {c}: {num}") + + cleanup_algorithm = config.get(c, "cleanup_algorithm") + description = get_description(args.preorpost, config, c) + pre_number = get_pre_number(args.preorpost, config, c) + + snapper_cmd = SnapperCmd(c, args.preorpost, cleanup_algorithm, description, chroot, pre_number) + num = snapper_cmd() + logging.info(f"==> {c}: {num}") return True diff --git a/tests.py b/tests.py index a9a1a62..604406e 100644 --- a/tests.py +++ b/tests.py @@ -4,7 +4,7 @@ import os import pytest -from snap_pac import create_snapper_cmd, get_snapper_configs, main, setup_config_parser +from scripts.snap_pac import create_snapper_cmd, get_snapper_configs, main, setup_config_parser @pytest.fixture