More tests

scripts/snap_pac.py

@@ -14,9 +14,7 @@
 # You should have received a copy of the GNU General Public License along
 # with this program; if not, write to the Free Software Foundation, Inc.,
 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
-"""
-Script for taking pre/post snapshots; run from pacman hooks.
-"""
+"""Script for taking pre/post snapshots; run from pacman hooks."""
 
 from argparse import ArgumentParser
 from configparser import ConfigParser
@@ -29,7 +27,7 @@ logging.basicConfig(format="%(message)s", level=logging.INFO)
 
 class SnapperCmd:
 
-    def __init__(self, config, snapshot_type, cleanup_algorithm, description, dbus=False, pre_number=None):
+    def __init__(self, config, snapshot_type, cleanup_algorithm, description="", dbus=False, pre_number=None):
         self.cmd = ["snapper"]
         if dbus:
             self.cmd.append("--no-dbus")
@@ -37,12 +35,14 @@ class SnapperCmd:
         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 description:
+            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.")
+        print(self.__str__())
 
     def __call__(self):
         return os.popen(self.__str__()).read().rstrip("\n")
@@ -67,8 +67,8 @@ def setup_config_parser(ini_file, parent_cmd, packages):
     config["DEFAULT"] = {
         "snapshot": False,
         "cleanup_algorithm": "number",
-        "pre_description": "".join(["\"", parent_cmd, "\""]),
-        "post_description":  "".join(["\"", packages, "\""]),
+        "pre_description": parent_cmd,
+        "post_description": packages,
         "desc_limit": 72
     }
     config["root"] = {
@@ -86,10 +86,8 @@ def get_description(preorpost, config, section):
         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":
+def get_pre_number(preorpost, prefile):
+    if preorpost == "pre":
         pre_number = None
     else:
         try:
@@ -100,6 +98,11 @@ def get_pre_number(preorpost, config, section):
     return pre_number
 
 
+def write_pre_number(num, prefile):
+    with open(prefile, "w") as f:
+        f.write(num)
+
+
 def main(snap_pac_ini, snapper_conf_file, args):
 
     if os.getenv("SNAP_PAC_SKIP", "n") in ["y", "Y", "yes", "Yes", "YES"]:
@@ -117,16 +120,22 @@ def main(snap_pac_ini, snapper_conf_file, args):
             config.add_section(c)
 
         logging.debug(f"{c = }")
+
         if config.getboolean(c, "snapshot"):
+            prefile = f"/tmp/snap-pac-pre_{c}"
+            logging.debug(f"{prefile = }")
 
             cleanup_algorithm = config.get(c, "cleanup_algorithm")
             description = get_description(args.preorpost, config, c)
-            pre_number = get_pre_number(args.preorpost, config, c)
+            pre_number = get_pre_number(args.preorpost, prefile)
 
             snapper_cmd = SnapperCmd(c, args.preorpost, cleanup_algorithm, description, chroot, pre_number)
             num = snapper_cmd()
             logging.info(f"==> {c}: {num}")
 
+            if args.preorpost == "pre":
+                write_pre_number(num, prefile)
+
     return True
 
 

tests.py

@@ -4,7 +4,10 @@ import os
 
 import pytest
 
-from scripts.snap_pac import SnapperCmd, get_snapper_configs, main, setup_config_parser
+from scripts.snap_pac import (
+   SnapperCmd, get_pre_number, get_snapper_configs, main, setup_config_parser,
+   write_pre_number, get_description
+)
 
 
 @pytest.fixture
@@ -13,19 +16,29 @@ def config():
     config["DEFAULT"] = {
         "snapshot": False,
         "cleanup_algorithm": "number",
-        "pre_description": "\"foo\"",
-        "post_description":  "\"bar\"",
+        "pre_description": "foo",
+        "post_description":  "bar",
         "desc_limit": 72
     }
     config["root"] = {
         "snapshot": True
     }
     config["home"] = {
-        "snapshot": True
+        "snapshot": True,
+        "desc_limit": 3,
+        "post_description": "a really long description"
     }
     return config
 
 
+@pytest.fixture
+def prefile():
+    with tempfile.NamedTemporaryFile("w", delete=False) as f:
+        f.write("1234")
+        name = f.name
+    return name
+
+
 def test_snapper_cmd_pre():
     snapper_cmd = SnapperCmd("root", "pre", "number", "foo")
     cmd = "snapper --config root create --type pre --cleanup-algorithm number --print-number --description \"foo\""
@@ -59,7 +72,30 @@ def test_skip_snap_pac():
 def test_setup_config_parser(config):
     with tempfile.NamedTemporaryFile("w", delete=False) as f:
         f.write("[home]\n")
-        f.write("snapshot = True")
+        f.write("snapshot = True\n")
+        f.write("desc_limit = 3\n")
+        f.write("post_description = a really long description\n")
         name = f.name
     config2 = setup_config_parser(name, "foo", "bar")
     assert config == config2
+
+
+def test_get_pre_number_pre(prefile):
+    assert get_pre_number("pre", prefile) is None
+
+
+def test_get_pre_number_post(prefile):
+    assert get_pre_number("post", prefile) == "1234"
+
+
+def test_write_pre_number(prefile):
+    write_pre_number("5678", prefile)
+    assert get_pre_number("post", prefile) == "5678"
+
+
+def test_get_pre_description(config):
+    assert get_description("pre", config, "home") == "foo"
+
+
+def test_get_post_description(config):
+    assert get_description("post", config, "home") == "a r"