Skip to content

tests: speed up the prune tests (1.4-maint) #10543

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ThomasWaldmann merged 2 commits into from
Oct 24, 2026
+52 −22
Merged

tests: speed up the prune tests (1.4-maint) #10543

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9b476f8
tests: speed up the prune tests
ThomasWaldmann Oct 24, 2026
9554348
CI: FreeBSD: do not install python310
ThomasWaldmann Oct 24, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -354,7 +354,6 @@ jobs:
sudo -E chmod 666 /dev/fuse
sudo -E pkg install -y rust
sudo -E pkg install -y git
sudo -E pkg install -y python310 py310-sqlite3
sudo -E pkg install -y python311 py311-sqlite3
sudo ln -sf /usr/local/bin/python3.11 /usr/local/bin/python3
sudo ln -sf /usr/local/bin/python3.11 /usr/local/bin/python
Expand Down
73 changes: 52 additions & 21 deletions src/borg/testsuite/archiver.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2523,13 +2523,14 @@ def test_create_dotslash_hack_root_metadata(self):
# self.assert_in('"--old" has been deprecated. Use "--new" instead', output)

def test_prune_repository(self):
self.create_regular_file('file1', size=1024)
self.cmd('init', '--encryption=repokey', self.repository_location)
self.cmd('create', self.repository_location + '::test1', src_dir)
self.cmd('create', self.repository_location + '::test2', src_dir)
self.cmd('create', self.repository_location + '::test1', self.input_path)
self.cmd('create', self.repository_location + '::test2', self.input_path)
# these are not really a checkpoints, but they look like some:
self.cmd('create', self.repository_location + '::test3.checkpoint', src_dir)
self.cmd('create', self.repository_location + '::test3.checkpoint.1', src_dir)
self.cmd('create', self.repository_location + '::test4.checkpoint', src_dir)
self.cmd('create', self.repository_location + '::test3.checkpoint', self.input_path)
self.cmd('create', self.repository_location + '::test3.checkpoint.1', self.input_path)
self.cmd('create', self.repository_location + '::test4.checkpoint', self.input_path)
output = self.cmd('prune', '--list', '--dry-run', self.repository_location, '--keep-daily=1')
assert re.search(r'Would prune:\s+test1', output)
# must keep the latest non-checkpoint archive:
Expand All @@ -2552,7 +2553,7 @@ def test_prune_repository(self):
self.assert_not_in('test3.checkpoint.1', output)
self.assert_in('test4.checkpoint', output)
# now we supersede the latest checkpoint by a successful backup:
self.cmd('create', self.repository_location + '::test5', src_dir)
self.cmd('create', self.repository_location + '::test5', self.input_path)
self.cmd('prune', self.repository_location, '--keep-daily=2')
output = self.cmd('list', '--consider-checkpoints', self.repository_location)
# all checkpoints should be gone now:
Expand All @@ -2568,10 +2569,11 @@ def _to_utc_timestamp(self, year, month, day, hour, minute, second):

def _create_archive_ts(self, name, y, m, d, H=0, M=0, S=0):
loc = self.repository_location + '::' + name
self.cmd('create', '--timestamp', self._to_utc_timestamp(y, m, d, H, M, S), loc, src_dir)
self.cmd('create', '--timestamp', self._to_utc_timestamp(y, m, d, H, M, S), loc, self.input_path)

# This test must match docs/misc/prune-example.txt
def test_prune_repository_example(self):
self.create_regular_file('file1', size=1024)
self.cmd('init', '--encryption=repokey', self.repository_location)
# Archives that will be kept, per the example
# Oldest archive
Expand Down Expand Up @@ -2640,6 +2642,7 @@ def test_prune_quarterly(self):
# Week number is shown in comment for every row in the below list.
# Year is also shown when it doesn't match the year given in the
# date tuple.
self.create_regular_file('file1', size=1024)
test_dates = [
(2020, 12, 6), (2021, 1, 3), # 49, 2020-53
(2021, 3, 28), (2021, 4, 25), # 12, 16
Expand Down Expand Up @@ -2703,6 +2706,7 @@ def mk_name(tup):

# With an initial and daily backup, prune daily until oldest is replaced by a monthly backup
def test_prune_retain_and_expire_oldest(self):
self.create_regular_file('file1', size=1024)
self.cmd('init', '--encryption=repokey', self.repository_location)
# Initial backup
self._create_archive_ts('original_archive', 2020, 9, 1, 11, 15)
Expand All @@ -2726,9 +2730,10 @@ def test_prune_retain_and_expire_oldest(self):
self.assert_not_in('original_archive', output)

def test_prune_repository_save_space(self):
self.create_regular_file('file1', size=1024)
self.cmd('init', '--encryption=repokey', self.repository_location)
self.cmd('create', self.repository_location + '::test1', src_dir)
self.cmd('create', self.repository_location + '::test2', src_dir)
self.cmd('create', self.repository_location + '::test1', self.input_path)
self.cmd('create', self.repository_location + '::test2', self.input_path)
output = self.cmd('prune', '--list', '--dry-run', self.repository_location, '--keep-daily=1')
assert re.search(r'Keeping archive \(rule: daily #1\):\s+test2', output)
assert re.search(r'Would prune:\s+test1', output)
Expand All @@ -2741,9 +2746,10 @@ def test_prune_repository_save_space(self):
self.assert_in('test2', output)

def test_prune_quick_stats(self):
self.create_regular_file('file1', size=1024)
self.cmd('init', '--encryption=none', self.repository_location)
self.cmd('create', self.repository_location + '::test1', src_dir)
self.cmd('create', self.repository_location + '::test2', src_dir)
self.cmd('create', self.repository_location + '::test1', self.input_path)
self.cmd('create', self.repository_location + '::test2', self.input_path)
output = self.cmd('prune', '--quick-stats', '--keep-daily=1', self.repository_location)
self.assert_in('Deleted data:', output)
assert 'All archives:' not in output
Expand All @@ -2755,19 +2761,21 @@ def test_prune_stats_and_quick_stats_are_mutually_exclusive(self):
self.assert_in('--stats and --quick-stats are mutually exclusive', output)

def test_prune_dry_run_ignores_quick_stats(self):
self.create_regular_file('file1', size=1024)
self.cmd('init', '--encryption=none', self.repository_location)
self.cmd('create', self.repository_location + '::test1', src_dir)
self.cmd('create', self.repository_location + '::test2', src_dir)
self.cmd('create', self.repository_location + '::test1', self.input_path)
self.cmd('create', self.repository_location + '::test2', self.input_path)
output = self.cmd('prune', '--dry-run', '--quick-stats', '--keep-daily=1', self.repository_location)
self.assert_in('Ignoring --quick-stats', output)
assert 'Deleted data:' not in output

def test_prune_repository_prefix(self):
self.create_regular_file('file1', size=1024)
self.cmd('init', '--encryption=repokey', self.repository_location)
self.cmd('create', self.repository_location + '::foo-2015-08-12-10:00', src_dir)
self.cmd('create', self.repository_location + '::foo-2015-08-12-20:00', src_dir)
self.cmd('create', self.repository_location + '::bar-2015-08-12-10:00', src_dir)
self.cmd('create', self.repository_location + '::bar-2015-08-12-20:00', src_dir)
self.cmd('create', self.repository_location + '::foo-2015-08-12-10:00', self.input_path)
self.cmd('create', self.repository_location + '::foo-2015-08-12-20:00', self.input_path)
self.cmd('create', self.repository_location + '::bar-2015-08-12-10:00', self.input_path)
self.cmd('create', self.repository_location + '::bar-2015-08-12-20:00', self.input_path)
output = self.cmd('prune', '--list', '--dry-run', self.repository_location, '--keep-daily=1', '--prefix=foo-')
assert re.search(r'Keeping archive \(rule: daily #1\):\s+foo-2015-08-12-20:00', output)
assert re.search(r'Would prune:\s+foo-2015-08-12-10:00', output)
Expand All @@ -2784,11 +2792,12 @@ def test_prune_repository_prefix(self):
self.assert_in('bar-2015-08-12-20:00', output)

def test_prune_repository_glob(self):
self.create_regular_file('file1', size=1024)
self.cmd('init', '--encryption=repokey', self.repository_location)
self.cmd('create', self.repository_location + '::2015-08-12-10:00-foo', src_dir)
self.cmd('create', self.repository_location + '::2015-08-12-20:00-foo', src_dir)
self.cmd('create', self.repository_location + '::2015-08-12-10:00-bar', src_dir)
self.cmd('create', self.repository_location + '::2015-08-12-20:00-bar', src_dir)
self.cmd('create', self.repository_location + '::2015-08-12-10:00-foo', self.input_path)
self.cmd('create', self.repository_location + '::2015-08-12-20:00-foo', self.input_path)
self.cmd('create', self.repository_location + '::2015-08-12-10:00-bar', self.input_path)
self.cmd('create', self.repository_location + '::2015-08-12-20:00-bar', self.input_path)
output = self.cmd('prune', '--list', '--dry-run', self.repository_location, '--keep-daily=1', '--glob-archives=2015-*-foo')
assert re.search(r'Keeping archive \(rule: daily #1\):\s+2015-08-12-20:00-foo', output)
assert re.search(r'Would prune:\s+2015-08-12-10:00-foo', output)
Expand Down Expand Up @@ -5019,6 +5028,28 @@ def test_config(self):
def test_migrate_lock_alive(self):
pass

# The prune rules are evaluated client-side, so running these again against a remote repository
# adds no coverage. test_prune_repository still exercises prune against a remote repository.
@unittest.skip('prune rules are tested locally')
def test_prune_repository_example(self):
pass

@unittest.skip('prune rules are tested locally')
def test_prune_quarterly(self):
pass

@unittest.skip('prune rules are tested locally')
def test_prune_retain_and_expire_oldest(self):
pass

@unittest.skip('prune rules are tested locally')
def test_prune_repository_prefix(self):
pass

@unittest.skip('prune rules are tested locally')
def test_prune_repository_glob(self):
pass

def test_remote_repo_strip_components_doesnt_leak(self):
self.cmd('init', '--encryption=repokey', self.repository_location)
self.create_regular_file('dir/file', contents=b"test file contents 1")
Expand Down
Loading