import logging import pytest from flexmock import flexmock from borgmatic.borg import list as module from ..test_verbosity import insert_logging_mock BORG_LIST_LATEST_ARGUMENTS = ( '--last', '1', '--short', 'repo', ) def test_resolve_archive_name_passes_through_non_latest_archive_name(): archive = 'myhost-2030-01-01T14:41:17.647620' assert module.resolve_archive_name('repo', archive, storage_config={}) == archive def test_resolve_archive_name_calls_borg_with_parameters(): expected_archive = 'archive-name' flexmock(module).should_receive('execute_command').with_args( ('borg', 'list') + BORG_LIST_LATEST_ARGUMENTS, output_log_level=None, borg_local_path='borg' ).and_return(expected_archive + '\n') assert module.resolve_archive_name('repo', 'latest', storage_config={}) == expected_archive def test_resolve_archive_name_with_log_info_calls_borg_with_info_parameter(): expected_archive = 'archive-name' flexmock(module).should_receive('execute_command').with_args( ('borg', 'list', '--info') + BORG_LIST_LATEST_ARGUMENTS, output_log_level=None, borg_local_path='borg', ).and_return(expected_archive + '\n') insert_logging_mock(logging.INFO) assert module.resolve_archive_name('repo', 'latest', storage_config={}) == expected_archive def test_resolve_archive_name_with_log_debug_calls_borg_with_debug_parameter(): expected_archive = 'archive-name' flexmock(module).should_receive('execute_command').with_args( ('borg', 'list', '--debug', '--show-rc') + BORG_LIST_LATEST_ARGUMENTS, output_log_level=None, borg_local_path='borg', ).and_return(expected_archive + '\n') insert_logging_mock(logging.DEBUG) assert module.resolve_archive_name('repo', 'latest', storage_config={}) == expected_archive def test_resolve_archive_name_with_local_path_calls_borg_via_local_path(): expected_archive = 'archive-name' flexmock(module).should_receive('execute_command').with_args( ('borg1', 'list') + BORG_LIST_LATEST_ARGUMENTS, output_log_level=None, borg_local_path='borg1', ).and_return(expected_archive + '\n') assert ( module.resolve_archive_name('repo', 'latest', storage_config={}, local_path='borg1') == expected_archive ) def test_resolve_archive_name_with_remote_path_calls_borg_with_remote_path_parameters(): expected_archive = 'archive-name' flexmock(module).should_receive('execute_command').with_args( ('borg', 'list', '--remote-path', 'borg1') + BORG_LIST_LATEST_ARGUMENTS, output_log_level=None, borg_local_path='borg', ).and_return(expected_archive + '\n') assert ( module.resolve_archive_name('repo', 'latest', storage_config={}, remote_path='borg1') == expected_archive ) def test_resolve_archive_name_without_archives_raises(): flexmock(module).should_receive('execute_command').with_args( ('borg', 'list') + BORG_LIST_LATEST_ARGUMENTS, output_log_level=None, borg_local_path='borg' ).and_return('') with pytest.raises(ValueError): module.resolve_archive_name('repo', 'latest', storage_config={}) def test_resolve_archive_name_with_lock_wait_calls_borg_with_lock_wait_parameters(): expected_archive = 'archive-name' flexmock(module).should_receive('execute_command').with_args( ('borg', 'list', '--lock-wait', 'okay') + BORG_LIST_LATEST_ARGUMENTS, output_log_level=None, borg_local_path='borg', ).and_return(expected_archive + '\n') assert ( module.resolve_archive_name('repo', 'latest', storage_config={'lock_wait': 'okay'}) == expected_archive ) def test_list_archives_calls_borg_with_parameters(): flexmock(module).should_receive('execute_command').with_args( ('borg', 'list', 'repo'), output_log_level=logging.WARNING, borg_local_path='borg' ) module.list_archives( repository='repo', storage_config={}, list_arguments=flexmock(archive=None, paths=None, json=False), ) def test_list_archives_with_log_info_calls_borg_with_info_parameter(): flexmock(module).should_receive('execute_command').with_args( ('borg', 'list', '--info', 'repo'), output_log_level=logging.WARNING, borg_local_path='borg' ) insert_logging_mock(logging.INFO) module.list_archives( repository='repo', storage_config={}, list_arguments=flexmock(archive=None, paths=None, json=False), ) def test_list_archives_with_log_info_and_json_suppresses_most_borg_output(): flexmock(module).should_receive('execute_command').with_args( ('borg', 'list', '--json', 'repo'), output_log_level=None, borg_local_path='borg' ) insert_logging_mock(logging.INFO) module.list_archives( repository='repo', storage_config={}, list_arguments=flexmock(archive=None, paths=None, json=True), ) def test_list_archives_with_log_debug_calls_borg_with_debug_parameter(): flexmock(module).should_receive('execute_command').with_args( ('borg', 'list', '--debug', '--show-rc', 'repo'), output_log_level=logging.WARNING, borg_local_path='borg', ) insert_logging_mock(logging.DEBUG) module.list_archives( repository='repo', storage_config={}, list_arguments=flexmock(archive=None, paths=None, json=False), ) def test_list_archives_with_log_debug_and_json_suppresses_most_borg_output(): flexmock(module).should_receive('execute_command').with_args( ('borg', 'list', '--json', 'repo'), output_log_level=None, borg_local_path='borg' ) insert_logging_mock(logging.DEBUG) module.list_archives( repository='repo', storage_config={}, list_arguments=flexmock(archive=None, paths=None, json=True), ) def test_list_archives_with_lock_wait_calls_borg_with_lock_wait_parameters(): storage_config = {'lock_wait': 5} flexmock(module).should_receive('execute_command').with_args( ('borg', 'list', '--lock-wait', '5', 'repo'), output_log_level=logging.WARNING, borg_local_path='borg', ) module.list_archives( repository='repo', storage_config=storage_config, list_arguments=flexmock(archive=None, paths=None, json=False), ) def test_list_archives_with_archive_calls_borg_with_archive_parameter(): storage_config = {} flexmock(module).should_receive('execute_command').with_args( ('borg', 'list', 'repo::archive'), output_log_level=logging.WARNING, borg_local_path='borg' ) module.list_archives( repository='repo', storage_config=storage_config, list_arguments=flexmock(archive='archive', paths=None, json=False), ) def test_list_archives_with_path_calls_borg_with_path_parameter(): storage_config = {} flexmock(module).should_receive('execute_command').with_args( ('borg', 'list', 'repo::archive', 'var/lib'), output_log_level=logging.WARNING, borg_local_path='borg', ) module.list_archives( repository='repo', storage_config=storage_config, list_arguments=flexmock(archive='archive', paths=['var/lib'], json=False), ) def test_list_archives_with_local_path_calls_borg_via_local_path(): flexmock(module).should_receive('execute_command').with_args( ('borg1', 'list', 'repo'), output_log_level=logging.WARNING, borg_local_path='borg1' ) module.list_archives( repository='repo', storage_config={}, list_arguments=flexmock(archive=None, paths=None, json=False), local_path='borg1', ) def test_list_archives_with_remote_path_calls_borg_with_remote_path_parameters(): flexmock(module).should_receive('execute_command').with_args( ('borg', 'list', '--remote-path', 'borg1', 'repo'), output_log_level=logging.WARNING, borg_local_path='borg', ) module.list_archives( repository='repo', storage_config={}, list_arguments=flexmock(archive=None, paths=None, json=False), remote_path='borg1', ) def test_list_archives_with_short_calls_borg_with_short_parameter(): flexmock(module).should_receive('execute_command').with_args( ('borg', 'list', '--short', 'repo'), output_log_level=logging.WARNING, borg_local_path='borg', ).and_return('[]') module.list_archives( repository='repo', storage_config={}, list_arguments=flexmock(archive=None, paths=None, json=False, short=True), ) @pytest.mark.parametrize( 'argument_name', ( 'prefix', 'glob_archives', 'sort_by', 'first', 'last', 'exclude', 'exclude_from', 'pattern', 'patterns_from', ), ) def test_list_archives_passes_through_arguments_to_borg(argument_name): flexmock(module).should_receive('execute_command').with_args( ('borg', 'list', '--' + argument_name.replace('_', '-'), 'value', 'repo'), output_log_level=logging.WARNING, borg_local_path='borg', ).and_return('[]') module.list_archives( repository='repo', storage_config={}, list_arguments=flexmock(archive=None, paths=None, json=False, **{argument_name: 'value'}), ) def test_list_archives_with_json_calls_borg_with_json_parameter(): flexmock(module).should_receive('execute_command').with_args( ('borg', 'list', '--json', 'repo'), output_log_level=None, borg_local_path='borg' ).and_return('[]') json_output = module.list_archives( repository='repo', storage_config={}, list_arguments=flexmock(archive=None, paths=None, json=True), ) assert json_output == '[]'