From 6bd832897813c730deb12768d1eb5b02af66ad20 Mon Sep 17 00:00:00 2001
From: Craig Jennings <c@cjennings.net>
Date: Tue, 30 Jun 2026 07:56:41 -0400
Subject: feat: install pre-pacman ZFS snapshot hook on ZFS-root systems
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

archsetup took sanoid from install-archzfs but never ported the pre-pacman snapshot hook, so a ZFS-root install had no transaction-triggered rollback point — the working setup only existed as a hand-placed script on velox, lost on reinstall. Add configure_pre_pacman_snapshots(): a PreTransaction pacman hook plus a self-pruning script that keeps the 10 most recent pre-pacman snapshots (sanoid ignores them — they aren't autosnap_ names). It's gated to ZFS-root and runs late in boot_ux, so the hook doesn't fire during the install's own package operations and the first snapshot is the fresh system.

The script ships as scripts/zfs-pre-snapshot, made ZFS_PRE_* env-overridable so the pruning logic is unit-testable. Unit tests drive it against a fake zfs (creates a snapshot, prunes the oldest past KEEP, ignores non-pre-pacman snapshots, honors the lockfile interval, warns on failure); a Testinfra test asserts the hook and script land on a ZFS install; the orchestrator test pins the new boot_ux substep.
---
 scripts/testing/tests/test_boot.py | 16 ++++++++++++++
 scripts/zfs-pre-snapshot           | 43 ++++++++++++++++++++++++++++++++++++++
 2 files changed, 59 insertions(+)
 create mode 100755 scripts/zfs-pre-snapshot

(limited to 'scripts')

diff --git a/scripts/testing/tests/test_boot.py b/scripts/testing/tests/test_boot.py
index 78b4404..e442682 100644
--- a/scripts/testing/tests/test_boot.py
+++ b/scripts/testing/tests/test_boot.py
@@ -65,3 +65,19 @@ def test_zfs_has_sanoid(host):
     if not host.exists("zfs"):
         pytest.skip("ZFS not installed (non-ZFS system)")
     assert host.exists("sanoid"), "ZFS system should have sanoid installed"
+
+
+def test_zfs_pre_pacman_snapshot_hook(host):
+    # archsetup installs a PreTransaction pacman hook + a self-pruning script so
+    # every pacman transaction is preceded by a rollback snapshot (configure_
+    # pre_pacman_snapshots, run late in boot_ux). ZFS-root only.
+    if not host.exists("zfs"):
+        pytest.skip("ZFS not installed (non-ZFS system)")
+    script = host.file("/usr/local/bin/zfs-pre-snapshot")
+    assert script.exists and script.is_file, "pre-pacman snapshot script missing"
+    assert script.mode & 0o111, "pre-pacman snapshot script is not executable"
+    hook = host.file("/etc/pacman.d/hooks/zfs-snapshot.hook")
+    assert hook.exists and hook.is_file, "zfs-snapshot.hook missing"
+    assert "PreTransaction" in hook.content_string, "hook not PreTransaction"
+    assert "/usr/local/bin/zfs-pre-snapshot" in hook.content_string, \
+        "hook does not exec the snapshot script"
diff --git a/scripts/zfs-pre-snapshot b/scripts/zfs-pre-snapshot
new file mode 100755
index 0000000..ed914d0
--- /dev/null
+++ b/scripts/zfs-pre-snapshot
@@ -0,0 +1,43 @@
+#!/bin/bash
+# Snapshot the root dataset before a pacman transaction, then prune to the most
+# recent $KEEP pre-pacman snapshots. Run from the zfs-snapshot.hook pacman hook
+# (PreTransaction). Sanoid doesn't manage these (they aren't autosnap_ names),
+# so retention is enforced here at creation time.
+#
+# Defaults match the live zroot layout; the ZFS_PRE_* env vars override them so
+# the pruning logic is unit-testable against a fake zfs on PATH.
+
+POOL="${ZFS_PRE_POOL:-zroot}"
+DATASET="${ZFS_PRE_DATASET:-$POOL/ROOT/default}"
+LOCKFILE="${ZFS_PRE_LOCKFILE:-/tmp/.zfs-pre-snapshot.lock}"
+MIN_INTERVAL="${ZFS_PRE_MIN_INTERVAL:-60}"
+KEEP="${ZFS_PRE_KEEP:-10}"   # pre-pacman snapshots to retain (recent-transaction rollback)
+
+# Skip if a snapshot was created within the last $MIN_INTERVAL seconds. A single
+# pacman invocation can fire several transactions; this stops a burst of them
+# from each cutting a near-identical snapshot.
+if [ -f "$LOCKFILE" ]; then
+    last=$(stat -c %Y "$LOCKFILE" 2>/dev/null || echo 0)
+    now=$(date +%s)
+    if (( now - last < MIN_INTERVAL )); then
+        exit 0
+    fi
+fi
+
+TIMESTAMP=$(date +%Y-%m-%d_%H-%M-%S)
+SNAPSHOT_NAME="pre-pacman_$TIMESTAMP"
+
+if zfs snapshot "$DATASET@$SNAPSHOT_NAME"; then
+    echo "Created snapshot: $DATASET@$SNAPSHOT_NAME"
+    touch "$LOCKFILE"
+
+    # Keep only the most recent $KEEP pre-pacman snapshots; destroy older ones.
+    zfs list -H -o name -t snapshot -s creation "$DATASET" 2>/dev/null \
+        | grep '@pre-pacman_' \
+        | head -n -"$KEEP" \
+        | while read -r old; do
+            zfs destroy "$old" && echo "Pruned old snapshot: $old"
+        done
+else
+    echo "Warning: Failed to create snapshot" >&2
+fi
-- 
cgit v1.2.3