tests: cover set_subvol, update_fstab_home, HOME_COPY_FILES, key trimming, home skeleton and orphan home GC

Author: linux_name2

tests/test_common.sh

@@ -172,6 +172,7 @@ section "Function definitions"
 EXPECTED_FUNCTIONS=(
     load_config validate_config check_dependencies acquire_lock
     is_child_of_aur_helper sign_uki verify_uki update_fstab
+    update_fstab_home populate_home_skeleton
     get_current_subvol get_current_subvol_raw get_root_device
     ensure_btrfs_mounted validate_subvolume check_btrfs_space
     check_esp_space list_generations build_uki garbage_collect
@@ -200,6 +201,7 @@ assert_eq "KERNEL_PKG default"  "linux"                  "$KERNEL_PKG"
 assert_eq "LOCK_FILE default"   "/var/lock/atomic-upgrade.lock" "$LOCK_FILE"
 assert_eq "SBCTL_SIGN default"  "0"                      "$SBCTL_SIGN"
 assert_eq "UPGRADE_GUARD default" "1"                    "$UPGRADE_GUARD"
+assert_eq "HOME_COPY_FILES default" ""                   "$HOME_COPY_FILES"
 assert_match "KERNEL_PARAMS contains rw"     "rw"     "$KERNEL_PARAMS"
 assert_match "KERNEL_PARAMS contains pti=on" "pti=on" "$KERNEL_PARAMS"
 
@@ -967,6 +969,120 @@ section "is_child_of_aur_helper"
 run_cmd is_child_of_aur_helper
 assert_eq "not child of aur helper" "1" "$_rc"
 
+# ── HOME_COPY_FILES config ─────────────────────
+
+section "HOME_COPY_FILES config"
+
+# Test: HOME_COPY_FILES loaded from config
+CONFIG_FILE="${TESTDIR}/home_copy.conf"
+cat > "$CONFIG_FILE" <<'EOF'
+HOME_COPY_FILES=.bashrc .ssh .gitconfig
+EOF
+HOME_COPY_FILES=""
+load_config
+assert_eq "HOME_COPY_FILES loaded" ".bashrc .ssh .gitconfig" "$HOME_COPY_FILES"
+
+# Test: HOME_COPY_FILES with quotes
+CONFIG_FILE="${TESTDIR}/home_copy_quoted.conf"
+cat > "$CONFIG_FILE" <<'EOF'
+HOME_COPY_FILES=".bashrc .bash_profile .ssh"
+EOF
+HOME_COPY_FILES=""
+load_config
+assert_eq "HOME_COPY_FILES quoted" ".bashrc .bash_profile .ssh" "$HOME_COPY_FILES"
+
+# Test: HOME_COPY_FILES absent → default preserved
+CONFIG_FILE="${TESTDIR}/home_copy_absent.conf"
+cat > "$CONFIG_FILE" <<'EOF'
+KEEP_GENERATIONS=3
+EOF
+HOME_COPY_FILES=""
+load_config
+assert_eq "HOME_COPY_FILES absent → stays empty" "" "$HOME_COPY_FILES"
+
+# Restore
+HOME_COPY_FILES=""
+
+
+# ── config key whitespace trimming ─────────────
+
+section "Config key whitespace trimming"
+
+CONFIG_FILE="${TESTDIR}/whitespace_key.conf"
+printf '  KEEP_GENERATIONS=7\n' > "$CONFIG_FILE"
+printf '\tESP=/boot/efi\n' >> "$CONFIG_FILE"
+KEEP_GENERATIONS=3
+ESP="/efi"
+load_config
+assert_eq "leading spaces in key trimmed" "7" "$KEEP_GENERATIONS"
+assert_eq "leading tab in key trimmed" "/boot/efi" "$ESP"
+KEEP_GENERATIONS=3
+ESP="/efi"
+
+
+# ── populate_home_skeleton ─────────────────────
+
+section "populate_home_skeleton"
+
+# Test: unsafe path rejection (absolute path)
+# Function iterates /home/* which may be empty in CI —
+# Safety checks are inside the per-user loop, so if /home is empty
+# in CI the paths won't be exercised — but the function must not crash
+# the function doesn't crash and doesn't emit "Failed"
+_PHS_TARGET="${TESTDIR}/phs_target"
+mkdir -p "$_PHS_TARGET"
+
+run_cmd populate_home_skeleton "$_PHS_TARGET" "/etc/passwd"
+assert_eq "absolute path does not crash" "0" "$_rc"
+assert_not_contains "absolute path no failure" "Failed" "$_out"
+
+# Test: unsafe path rejection (path traversal)
+run_cmd populate_home_skeleton "$_PHS_TARGET" "../../../etc/shadow"
+assert_eq "traversal does not crash" "0" "$_rc"
+assert_not_contains "traversal no failure" "Failed" "$_out"
+
+# Test: empty copy_files produces skeleton message
+run_cmd populate_home_skeleton "$_PHS_TARGET" ""
+assert_eq "empty copy_files does not crash" "0" "$_rc"
+
+# ── orphan home subvolumes in GC ──────────────
+
+section "garbage_collect: orphan home subvolumes"
+
+ESP="${TESTDIR}/esp_orphan_home"
+BTRFS_MOUNT="${TESTDIR}/btrfs_orphan_home"
+mkdir -p "${ESP}/EFI/Linux" "$BTRFS_MOUNT"
+
+make_mock findmnt    'echo "rw,subvol=/root-20250605-120000"'
+make_mock btrfs      'exit 0'
+make_mock mountpoint 'exit 0'
+_ROOT_DEVICE="${TESTDIR}/fake_dev/root_crypt"
+
+# Current generation
+touch "${ESP}/EFI/Linux/arch-20250605-120000.efi"
+mkdir -p "${BTRFS_MOUNT}/root-20250605-120000"
+
+# Generation with tag "kde"
+touch "${ESP}/EFI/Linux/arch-20250604-100000-kde.efi"
+mkdir -p "${BTRFS_MOUNT}/root-20250604-100000-kde"
+
+# Home subvolume matching the tag — NOT orphan
+mkdir -p "${BTRFS_MOUNT}/home-kde"
+
+# Orphan home subvolume — no generation with tag "old-test"
+mkdir -p "${BTRFS_MOUNT}/home-old-test"
+
+run_cmd garbage_collect 3 0
+assert_contains "orphan home detected" "Orphan home" "$_out"
+assert_contains "orphan mentions tag" "old-test" "$_out"
+assert_not_contains "non-orphan home not flagged" "Orphan home: home-kde" "$_out"
+
+# Verify home subvolumes are never deleted (even orphans)
+[[ -d "${BTRFS_MOUNT}/home-old-test" ]] \
+    && ok "orphan home NOT auto-deleted" || fail "orphan home was deleted"
+[[ -d "${BTRFS_MOUNT}/home-kde" ]] \
+    && ok "active home preserved" || fail "active home was deleted"
+
 
 # ═══════════════════════════════════════════════════════════════
 #  RESULTS

tests/test_fstab.py

@@ -5,7 +5,7 @@
 
 import sys
 sys.path.insert(0, os.path.join(os.path.dirname(__file__), '..', 'lib', 'atomic'))
-from fstab import FstabEntry, update_fstab
+from fstab import FstabEntry, update_fstab, update_fstab_home
 
 
 class TestFstabEntryParse:
@@ -137,13 +137,14 @@ def test_basic_replacement(self, tmp_path):
         assert "root-new" in text
         assert "subvol=home" in text
 
-    def test_backup_created(self, tmp_path):
+    def test_backup_cleaned_after_success(self, tmp_path):
+        """Backup is created during write but removed on success."""
         path = tmp_path / "fstab"
         path.write_text("UUID=x / btrfs rw,subvol=root-old 0 0\n")
         update_fstab(str(path), "root-old", "root-new")
         bak = tmp_path / "fstab.bak"
-        assert bak.exists()
-        assert "root-old" in bak.read_text()
+        assert not bak.exists()
+        assert "root-new" in path.read_text()
 
     def test_no_root_entry(self, tmp_path):
         path = tmp_path / "fstab"
@@ -267,3 +268,157 @@ def test_subvol_mismatch_without_subvolid_generic_error(self, tmp_path, capsys):
         assert "subvol=root-old not found" in err
         # Must NOT mention subvolid since there is none
         assert "subvolid=" not in err
+
+
+class TestSetSubvol:
+    """Tests for FstabEntry.set_subvol() — unconditional subvol replacement."""
+
+    def test_basic_replacement(self):
+        e = FstabEntry.parse("UUID=x /home btrfs rw,subvol=/home 0 0\n")
+        assert e.set_subvol("home-kde")
+        assert "subvol=/home-kde" in e.options
+
+    def test_preserves_leading_slash(self):
+        e = FstabEntry.parse("UUID=x /home btrfs rw,subvol=/home 0 0\n")
+        e.set_subvol("home-kde")
+        assert "subvol=/home-kde" in e.options
+
+    def test_no_leading_slash_preserved(self):
+        e = FstabEntry.parse("UUID=x /home btrfs rw,subvol=home 0 0\n")
+        e.set_subvol("home-kde")
+        assert "subvol=home-kde" in e.options
+        assert "/home-kde" not in e.options
+
+    def test_already_set_no_change(self):
+        e = FstabEntry.parse("UUID=x /home btrfs rw,subvol=/home-kde 0 0\n")
+        assert not e.set_subvol("home-kde")
+
+    def test_preserves_other_options(self):
+        e = FstabEntry.parse(
+            "UUID=x /home btrfs rw,noatime,subvol=/home,compress=zstd 0 0\n"
+        )
+        e.set_subvol("home-dev")
+        opts = e.options.split(",")
+        assert "rw" in opts
+        assert "noatime" in opts
+        assert "compress=zstd" in opts
+        assert "subvol=/home-dev" in opts
+
+    def test_comment_line(self):
+        e = FstabEntry.parse("# subvol=home\n")
+        assert not e.set_subvol("home-new")
+
+    def test_input_slash_stripped(self):
+        """Input with leading slash is normalized."""
+        e = FstabEntry.parse("UUID=x /home btrfs rw,subvol=/home 0 0\n")
+        e.set_subvol("/home-kde")
+        assert "subvol=/home-kde" in e.options
+
+    def test_no_subvol_option(self):
+        """Entry without subvol= → no change."""
+        e = FstabEntry.parse("UUID=x /home btrfs rw,noatime 0 0\n")
+        assert not e.set_subvol("home-kde")
+
+
+class TestUpdateFstabHome:
+    """Tests for update_fstab_home() function."""
+
+    def test_basic_replacement(self, tmp_path):
+        path = tmp_path / "fstab"
+        path.write_text(
+            "UUID=x / btrfs rw,subvol=/root-old 0 0\n"
+            "UUID=x /home btrfs rw,subvol=/home 0 0\n"
+        )
+        assert update_fstab_home(str(path), "home-kde")
+        text = path.read_text()
+        assert "subvol=/home-kde" in text
+        # Root entry untouched
+        assert "subvol=/root-old" in text
+
+    def test_no_home_entry(self, tmp_path):
+        path = tmp_path / "fstab"
+        path.write_text("UUID=x / btrfs rw,subvol=/root-old 0 0\n")
+        assert not update_fstab_home(str(path), "home-kde")
+
+    def test_no_subvol_in_home(self, tmp_path):
+        path = tmp_path / "fstab"
+        path.write_text(
+            "UUID=x / btrfs rw,subvol=/root-old 0 0\n"
+            "UUID=y /home ext4 rw,noatime 0 0\n"
+        )
+        assert not update_fstab_home(str(path), "home-kde")
+
+    def test_already_set(self, tmp_path):
+        path = tmp_path / "fstab"
+        path.write_text(
+            "UUID=x /home btrfs rw,subvol=/home-kde 0 0\n"
+        )
+        assert update_fstab_home(str(path), "home-kde")
+
+    def test_nonexistent_file(self):
+        assert not update_fstab_home("/nonexistent/fstab", "home-kde")
+
+    def test_empty_subvol_name(self, tmp_path):
+        path = tmp_path / "fstab"
+        path.write_text("UUID=x /home btrfs rw,subvol=/home 0 0\n")
+        assert not update_fstab_home(str(path), "")
+
+    def test_invalid_subvol_name(self, tmp_path):
+        path = tmp_path / "fstab"
+        path.write_text("UUID=x /home btrfs rw,subvol=/home 0 0\n")
+        assert not update_fstab_home(str(path), "../etc/passwd")
+
+    def test_permissions_preserved(self, tmp_path):
+        path = tmp_path / "fstab"
+        path.write_text("UUID=x /home btrfs rw,subvol=/home 0 0\n")
+        path.chmod(0o644)
+        update_fstab_home(str(path), "home-kde")
+        assert path.stat().st_mode & 0o7777 == 0o644
+
+    def test_backup_cleaned_up_on_success(self, tmp_path):
+        path = tmp_path / "fstab"
+        path.write_text("UUID=x /home btrfs rw,subvol=/home 0 0\n")
+        update_fstab_home(str(path), "home-kde")
+        assert not (tmp_path / "fstab.home-bak").exists()
+
+    def test_root_untouched(self, tmp_path):
+        path = tmp_path / "fstab"
+        path.write_text(
+            "UUID=x / btrfs rw,subvol=/root-20250601 0 0\n"
+            "UUID=x /home btrfs rw,subvol=/home 0 0\n"
+            "UUID=x /var/log btrfs rw,subvol=/log 0 0\n"
+        )
+        update_fstab_home(str(path), "home-dev")
+        text = path.read_text()
+        assert "subvol=/root-20250601" in text
+        assert "subvol=/home-dev" in text
+        assert "subvol=/log" in text
+
+    def test_preserves_comments(self, tmp_path):
+        path = tmp_path / "fstab"
+        path.write_text(
+            "# home filesystem\n"
+            "UUID=x /home btrfs rw,subvol=/home 0 0\n"
+        )
+        update_fstab_home(str(path), "home-kde")
+        text = path.read_text()
+        assert "# home filesystem" in text
+        assert "subvol=/home-kde" in text
+
+    def test_real_fstab(self, tmp_path):
+        path = tmp_path / "fstab"
+        path.write_text(
+            "# /etc/fstab\n"
+            "\n"
+            "UUID=ABCD-1234 /efi vfat rw,relatime 0 2\n"
+            "UUID=aaaa-bbbb / btrfs rw,noatime,compress=zstd:3,subvol=/root-20250220-141710 0 0\n"
+            "UUID=aaaa-bbbb /home btrfs rw,noatime,compress=zstd:3,subvol=/home 0 0\n"
+            "UUID=aaaa-bbbb /var/log btrfs rw,noatime,compress=zstd:3,subvol=/log 0 0\n"
+            "tmpfs /tmp tmpfs defaults,noatime,mode=1777 0 0\n"
+        )
+        assert update_fstab_home(str(path), "home-kde")
+        text = path.read_text()
+        assert "subvol=/home-kde" in text
+        assert "subvol=/root-20250220-141710" in text
+        assert "subvol=/log" in text
+        assert "ABCD-1234" in text