Additional tests and docstrings.

2026-07-22 02:03:01 +02:00 · 2026-05-27 22:40:13 -07:00
parent 9da6d0f90a
commit 6869a5d5f2
3 changed files with 121 additions and 16 deletions
@@ -0,0 +1,90 @@
+from flexmock import flexmock
+
+from borgmatic.actions.browse import archive as module
+
+
+def test_get_repository_archives_does_not_raise():
+    config = {'repositories': [{'path': 'test.borg'}]}
+    flexmock(module.borgmatic.logger).should_receive('Log_prefix').and_return(flexmock())
+    flexmock(module.borgmatic.borg.version).should_receive('local_borg_version').and_return('3.0')
+    flexmock(module.borgmatic.borg.repo_list).should_receive('list_repository').and_return('{}')
+
+    assert module.get_repository_archives(config, config['repositories'][0]) == {}
+
+
+def test_get_archive_paths_returns_each_as_archive_path_with_metadata():
+    config = {'repositories': [{'path': 'test.borg'}]}
+    flexmock(module.borgmatic.logger).should_receive('Log_prefix').and_return(flexmock())
+    flexmock(module.borgmatic.borg.version).should_receive('local_borg_version').and_return('3.0')
+    flexmock(module.borgmatic.borg.list).should_receive('capture_archive_listing').and_yield(
+        {'path': 'foo.txt', 'type': '-', 'linktarget': ''},
+        {'path': 'bar.txt', 'type': 'l', 'linktarget': 'foo.txt'},
+        {'path': 'etc', 'type': 'd', 'linktarget': ''},
+    )
+
+    assert tuple(module.get_archive_paths(config, config['repositories'][0], 'archive')) == (
+        module.Archive_path('-', 'foo.txt', ''),
+        module.Archive_path('l', 'bar.txt', 'foo.txt'),
+        module.Archive_path('d', 'etc', ''),
+    )
+
+
+def test_get_archive_file_content_with_binary_file_bails():
+    config = {'repositories': [{'path': 'test.borg'}]}
+    flexmock(module.borgmatic.logger).should_receive('Log_prefix').and_return(flexmock())
+    flexmock(module.borgmatic.borg.version).should_receive('local_borg_version').and_return('3.0')
+    flexmock(module.borgmatic.borg.extract).should_receive('extract_archive').and_return(
+        flexmock(stdout=flexmock(readlines=lambda hint: [b'foo\n', b'bar\n'])),
+    )
+    flexmock(module.binaryornot.helpers).should_receive('is_binary_string').and_return(True)
+
+    assert (
+        module.get_archive_file_content(config, config['repositories'][0], 'archive', 'etc/foo.txt')
+        is None
+    )
+
+
+def test_get_archive_file_content_decodes_content():
+    config = {'repositories': [{'path': 'test.borg'}]}
+    flexmock(module.borgmatic.logger).should_receive('Log_prefix').and_return(flexmock())
+    flexmock(module.borgmatic.borg.version).should_receive('local_borg_version').and_return('3.0')
+    flexmock(module.borgmatic.borg.extract).should_receive('extract_archive').and_return(
+        flexmock(stdout=flexmock(readlines=lambda hint: [b'foo\n', b'bar\n'])),
+    )
+    flexmock(module.binaryornot.helpers).should_receive('is_binary_string').and_return(False)
+
+    assert (
+        module.get_archive_file_content(config, config['repositories'][0], 'archive', 'etc/foo.txt')
+        == 'foo\nbar\n'
+    )
+
+
+def test_get_archive_file_content_with_large_file_truncates_content():
+    config = {'repositories': [{'path': 'test.borg'}]}
+    flexmock(module.borgmatic.logger).should_receive('Log_prefix').and_return(flexmock())
+    flexmock(module.borgmatic.borg.version).should_receive('local_borg_version').and_return('3.0')
+    flexmock(module).READLINES_HINT_BYTES = 3
+    flexmock(module.borgmatic.borg.extract).should_receive('extract_archive').and_return(
+        flexmock(stdout=flexmock(readlines=lambda hint: [b'foo\n', b'bar\n'])),
+    )
+    flexmock(module.binaryornot.helpers).should_receive('is_binary_string').and_return(False)
+
+    assert (
+        module.get_archive_file_content(config, config['repositories'][0], 'archive', 'etc/foo.txt')
+        == f'foo\nbar\n\n{module.TRUNCATION_MESSAGE}'
+    )
+
+
+def test_get_archive_file_content_with_unicode_decode_error_does_not_raise():
+    config = {'repositories': [{'path': 'test.borg'}]}
+    flexmock(module.borgmatic.logger).should_receive('Log_prefix').and_return(flexmock())
+    flexmock(module.borgmatic.borg.version).should_receive('local_borg_version').and_return('3.0')
+    flexmock(module.borgmatic.borg.extract).should_receive('extract_archive').and_return(
+        flexmock(stdout=flexmock(readlines=lambda hint: [b'foo\n', b'\xc3\n'])),
+    )
+    flexmock(module.binaryornot.helpers).should_receive('is_binary_string').and_return(False)
+
+    assert (
+        module.get_archive_file_content(config, config['repositories'][0], 'archive', 'etc/foo.txt')
+        is None
+    )