518 lines
19 KiB
Python
518 lines
19 KiB
Python
import pytest
|
|
from flexmock import flexmock
|
|
|
|
from borgmatic.commands import arguments as module
|
|
|
|
|
|
def test_parse_arguments_with_no_arguments_uses_defaults():
|
|
config_paths = ['default']
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(config_paths)
|
|
|
|
arguments = module.parse_arguments()
|
|
|
|
global_arguments = arguments['global']
|
|
assert global_arguments.config_paths == config_paths
|
|
assert global_arguments.excludes_filename is None
|
|
assert global_arguments.verbosity == 0
|
|
assert global_arguments.syslog_verbosity == 0
|
|
assert global_arguments.log_file_verbosity == 0
|
|
|
|
|
|
def test_parse_arguments_with_multiple_config_paths_parses_as_list():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
arguments = module.parse_arguments('--config', 'myconfig', 'otherconfig')
|
|
|
|
global_arguments = arguments['global']
|
|
assert global_arguments.config_paths == ['myconfig', 'otherconfig']
|
|
assert global_arguments.verbosity == 0
|
|
assert global_arguments.syslog_verbosity == 0
|
|
assert global_arguments.log_file_verbosity == 0
|
|
|
|
|
|
def test_parse_arguments_with_verbosity_overrides_default():
|
|
config_paths = ['default']
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(config_paths)
|
|
|
|
arguments = module.parse_arguments('--verbosity', '1')
|
|
|
|
global_arguments = arguments['global']
|
|
assert global_arguments.config_paths == config_paths
|
|
assert global_arguments.excludes_filename is None
|
|
assert global_arguments.verbosity == 1
|
|
assert global_arguments.syslog_verbosity == 0
|
|
assert global_arguments.log_file_verbosity == 0
|
|
|
|
|
|
def test_parse_arguments_with_syslog_verbosity_overrides_default():
|
|
config_paths = ['default']
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(config_paths)
|
|
|
|
arguments = module.parse_arguments('--syslog-verbosity', '2')
|
|
|
|
global_arguments = arguments['global']
|
|
assert global_arguments.config_paths == config_paths
|
|
assert global_arguments.excludes_filename is None
|
|
assert global_arguments.verbosity == 0
|
|
assert global_arguments.syslog_verbosity == 2
|
|
|
|
|
|
def test_parse_arguments_with_log_file_verbosity_overrides_default():
|
|
config_paths = ['default']
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(config_paths)
|
|
|
|
arguments = module.parse_arguments('--log-file-verbosity', '-1')
|
|
|
|
global_arguments = arguments['global']
|
|
assert global_arguments.config_paths == config_paths
|
|
assert global_arguments.excludes_filename is None
|
|
assert global_arguments.verbosity == 0
|
|
assert global_arguments.syslog_verbosity == 0
|
|
assert global_arguments.log_file_verbosity == -1
|
|
|
|
|
|
def test_parse_arguments_with_single_override_parses():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
arguments = module.parse_arguments('--override', 'foo.bar=baz')
|
|
|
|
global_arguments = arguments['global']
|
|
assert global_arguments.overrides == ['foo.bar=baz']
|
|
|
|
|
|
def test_parse_arguments_with_multiple_overrides_parses():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
arguments = module.parse_arguments('--override', 'foo.bar=baz', 'foo.quux=7')
|
|
|
|
global_arguments = arguments['global']
|
|
assert global_arguments.overrides == ['foo.bar=baz', 'foo.quux=7']
|
|
|
|
|
|
def test_parse_arguments_with_multiple_overrides_and_flags_parses():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
arguments = module.parse_arguments(
|
|
'--override', 'foo.bar=baz', '--override', 'foo.quux=7', 'this.that=8'
|
|
)
|
|
|
|
global_arguments = arguments['global']
|
|
assert global_arguments.overrides == ['foo.bar=baz', 'foo.quux=7', 'this.that=8']
|
|
|
|
|
|
def test_parse_arguments_with_list_json_overrides_default():
|
|
arguments = module.parse_arguments('list', '--json')
|
|
|
|
assert 'list' in arguments
|
|
assert arguments['list'].json is True
|
|
|
|
|
|
def test_parse_arguments_with_no_actions_defaults_to_all_actions_enabled():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
arguments = module.parse_arguments()
|
|
|
|
assert 'prune' in arguments
|
|
assert 'create' in arguments
|
|
assert 'check' in arguments
|
|
|
|
|
|
def test_parse_arguments_with_no_actions_passes_argument_to_relevant_actions():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
arguments = module.parse_arguments('--stats', '--list')
|
|
|
|
assert 'prune' in arguments
|
|
assert arguments['prune'].stats
|
|
assert arguments['prune'].list_archives
|
|
assert 'create' in arguments
|
|
assert arguments['create'].stats
|
|
assert arguments['create'].list_files
|
|
assert 'check' in arguments
|
|
|
|
|
|
def test_parse_arguments_with_help_and_no_actions_shows_global_help(capsys):
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
with pytest.raises(SystemExit) as exit:
|
|
module.parse_arguments('--help')
|
|
|
|
assert exit.value.code == 0
|
|
captured = capsys.readouterr()
|
|
assert 'global arguments:' in captured.out
|
|
assert 'actions:' in captured.out
|
|
|
|
|
|
def test_parse_arguments_with_help_and_action_shows_action_help(capsys):
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
with pytest.raises(SystemExit) as exit:
|
|
module.parse_arguments('create', '--help')
|
|
|
|
assert exit.value.code == 0
|
|
captured = capsys.readouterr()
|
|
assert 'global arguments:' not in captured.out
|
|
assert 'actions:' not in captured.out
|
|
assert 'create arguments:' in captured.out
|
|
|
|
|
|
def test_parse_arguments_with_action_before_global_options_parses_options():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
arguments = module.parse_arguments('prune', '--verbosity', '2')
|
|
|
|
assert 'prune' in arguments
|
|
assert arguments['global'].verbosity == 2
|
|
|
|
|
|
def test_parse_arguments_with_global_options_before_action_parses_options():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
arguments = module.parse_arguments('--verbosity', '2', 'prune')
|
|
|
|
assert 'prune' in arguments
|
|
assert arguments['global'].verbosity == 2
|
|
|
|
|
|
def test_parse_arguments_with_prune_action_leaves_other_actions_disabled():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
arguments = module.parse_arguments('prune')
|
|
|
|
assert 'prune' in arguments
|
|
assert 'create' not in arguments
|
|
assert 'check' not in arguments
|
|
|
|
|
|
def test_parse_arguments_with_multiple_actions_leaves_other_action_disabled():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
arguments = module.parse_arguments('create', 'check')
|
|
|
|
assert 'prune' not in arguments
|
|
assert 'create' in arguments
|
|
assert 'check' in arguments
|
|
|
|
|
|
def test_parse_arguments_with_invalid_arguments_exits():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
with pytest.raises(SystemExit):
|
|
module.parse_arguments('--posix-me-harder')
|
|
|
|
|
|
def test_parse_arguments_disallows_deprecated_excludes_option():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
with pytest.raises(ValueError):
|
|
module.parse_arguments('--config', 'myconfig', '--excludes', 'myexcludes')
|
|
|
|
|
|
def test_parse_arguments_disallows_encryption_mode_without_init():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
with pytest.raises(SystemExit):
|
|
module.parse_arguments('--config', 'myconfig', '--encryption', 'repokey')
|
|
|
|
|
|
def test_parse_arguments_allows_encryption_mode_with_init():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
module.parse_arguments('--config', 'myconfig', 'init', '--encryption', 'repokey')
|
|
|
|
|
|
def test_parse_arguments_requires_encryption_mode_with_init():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
with pytest.raises(SystemExit):
|
|
module.parse_arguments('--config', 'myconfig', 'init')
|
|
|
|
|
|
def test_parse_arguments_disallows_append_only_without_init():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
with pytest.raises(SystemExit):
|
|
module.parse_arguments('--config', 'myconfig', '--append-only')
|
|
|
|
|
|
def test_parse_arguments_disallows_storage_quota_without_init():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
with pytest.raises(SystemExit):
|
|
module.parse_arguments('--config', 'myconfig', '--storage-quota', '5G')
|
|
|
|
|
|
def test_parse_arguments_allows_init_and_prune():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
module.parse_arguments('--config', 'myconfig', 'init', '--encryption', 'repokey', 'prune')
|
|
|
|
|
|
def test_parse_arguments_allows_init_and_create():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
module.parse_arguments('--config', 'myconfig', 'init', '--encryption', 'repokey', 'create')
|
|
|
|
|
|
def test_parse_arguments_allows_repository_with_extract():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
module.parse_arguments(
|
|
'--config', 'myconfig', 'extract', '--repository', 'test.borg', '--archive', 'test'
|
|
)
|
|
|
|
|
|
def test_parse_arguments_allows_repository_with_mount():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
module.parse_arguments(
|
|
'--config',
|
|
'myconfig',
|
|
'mount',
|
|
'--repository',
|
|
'test.borg',
|
|
'--archive',
|
|
'test',
|
|
'--mount-point',
|
|
'/mnt',
|
|
)
|
|
|
|
|
|
def test_parse_arguments_allows_repository_with_list():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
module.parse_arguments('--config', 'myconfig', 'list', '--repository', 'test.borg')
|
|
|
|
|
|
def test_parse_arguments_disallows_archive_unless_action_consumes_it():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
with pytest.raises(SystemExit):
|
|
module.parse_arguments('--config', 'myconfig', '--archive', 'test')
|
|
|
|
|
|
def test_parse_arguments_disallows_paths_unless_action_consumes_it():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
with pytest.raises(SystemExit):
|
|
module.parse_arguments('--config', 'myconfig', '--path', 'test')
|
|
|
|
|
|
def test_parse_arguments_allows_archive_with_extract():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
module.parse_arguments('--config', 'myconfig', 'extract', '--archive', 'test')
|
|
|
|
|
|
def test_parse_arguments_allows_archive_with_mount():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
module.parse_arguments(
|
|
'--config', 'myconfig', 'mount', '--archive', 'test', '--mount-point', '/mnt'
|
|
)
|
|
|
|
|
|
def test_parse_arguments_allows_archive_with_restore():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
module.parse_arguments('--config', 'myconfig', 'restore', '--archive', 'test')
|
|
|
|
|
|
def test_parse_arguments_allows_archive_with_list():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
module.parse_arguments('--config', 'myconfig', 'list', '--archive', 'test')
|
|
|
|
|
|
def test_parse_arguments_requires_archive_with_extract():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
with pytest.raises(SystemExit):
|
|
module.parse_arguments('--config', 'myconfig', 'extract')
|
|
|
|
|
|
def test_parse_arguments_requires_archive_with_restore():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
with pytest.raises(SystemExit):
|
|
module.parse_arguments('--config', 'myconfig', 'restore')
|
|
|
|
|
|
def test_parse_arguments_requires_mount_point_with_mount():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
with pytest.raises(SystemExit):
|
|
module.parse_arguments('--config', 'myconfig', 'mount', '--archive', 'test')
|
|
|
|
|
|
def test_parse_arguments_requires_mount_point_with_umount():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
with pytest.raises(SystemExit):
|
|
module.parse_arguments('--config', 'myconfig', 'umount')
|
|
|
|
|
|
def test_parse_arguments_allows_progress_before_create():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
module.parse_arguments('--progress', 'create', 'list')
|
|
|
|
|
|
def test_parse_arguments_allows_progress_after_create():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
module.parse_arguments('create', '--progress', 'list')
|
|
|
|
|
|
def test_parse_arguments_allows_progress_and_extract():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
module.parse_arguments('--progress', 'extract', '--archive', 'test', 'list')
|
|
|
|
|
|
def test_parse_arguments_disallows_progress_without_create():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
with pytest.raises(SystemExit):
|
|
module.parse_arguments('--progress', 'list')
|
|
|
|
|
|
def test_parse_arguments_with_stats_and_create_flags_does_not_raise():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
module.parse_arguments('--stats', 'create', 'list')
|
|
|
|
|
|
def test_parse_arguments_with_stats_and_prune_flags_does_not_raise():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
module.parse_arguments('--stats', 'prune', 'list')
|
|
|
|
|
|
def test_parse_arguments_with_stats_flag_but_no_create_or_prune_flag_raises_value_error():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
with pytest.raises(SystemExit):
|
|
module.parse_arguments('--stats', 'list')
|
|
|
|
|
|
def test_parse_arguments_with_list_and_create_flags_does_not_raise():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
module.parse_arguments('--list', 'create')
|
|
|
|
|
|
def test_parse_arguments_with_list_and_prune_flags_does_not_raise():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
module.parse_arguments('--list', 'prune')
|
|
|
|
|
|
def test_parse_arguments_with_list_flag_but_no_relevant_action_raises_value_error():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
with pytest.raises(SystemExit):
|
|
module.parse_arguments('--list', 'rcreate')
|
|
|
|
|
|
def test_parse_arguments_disallows_list_with_progress_for_create_action():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
with pytest.raises(ValueError):
|
|
module.parse_arguments('create', '--list', '--progress')
|
|
|
|
|
|
def test_parse_arguments_allows_json_with_list_or_info():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
module.parse_arguments('list', '--json')
|
|
module.parse_arguments('info', '--json')
|
|
|
|
|
|
def test_parse_arguments_disallows_json_with_both_list_and_info():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
with pytest.raises(ValueError):
|
|
module.parse_arguments('list', 'info', '--json')
|
|
|
|
|
|
def test_parse_arguments_disallows_json_with_both_list_and_rinfo():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
with pytest.raises(ValueError):
|
|
module.parse_arguments('list', 'rinfo', '--json')
|
|
|
|
|
|
def test_parse_arguments_disallows_json_with_both_rinfo_and_info():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
with pytest.raises(ValueError):
|
|
module.parse_arguments('rinfo', 'info', '--json')
|
|
|
|
|
|
def test_parse_arguments_disallows_transfer_with_both_archive_and_match_archives():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
with pytest.raises(ValueError):
|
|
module.parse_arguments(
|
|
'transfer',
|
|
'--source-repository',
|
|
'source.borg',
|
|
'--archive',
|
|
'foo',
|
|
'--match-archives',
|
|
'sh:*bar',
|
|
)
|
|
|
|
|
|
def test_parse_arguments_disallows_list_with_both_prefix_and_match_archives():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
with pytest.raises(ValueError):
|
|
module.parse_arguments('list', '--prefix', 'foo', '--match-archives', 'sh:*bar')
|
|
|
|
|
|
def test_parse_arguments_disallows_rlist_with_both_prefix_and_match_archives():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
with pytest.raises(ValueError):
|
|
module.parse_arguments('rlist', '--prefix', 'foo', '--match-archives', 'sh:*bar')
|
|
|
|
|
|
def test_parse_arguments_disallows_info_with_both_archive_and_match_archives():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
with pytest.raises(ValueError):
|
|
module.parse_arguments('info', '--archive', 'foo', '--match-archives', 'sh:*bar')
|
|
|
|
|
|
def test_parse_arguments_disallows_info_with_both_archive_and_prefix():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
with pytest.raises(ValueError):
|
|
module.parse_arguments('info', '--archive', 'foo', '--prefix', 'bar')
|
|
|
|
|
|
def test_parse_arguments_disallows_info_with_both_prefix_and_match_archives():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
with pytest.raises(ValueError):
|
|
module.parse_arguments('info', '--prefix', 'foo', '--match-archives', 'sh:*bar')
|
|
|
|
|
|
def test_parse_arguments_check_only_extract_does_not_raise_extract_subparser_error():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
module.parse_arguments('check', '--only', 'extract')
|
|
|
|
|
|
def test_parse_arguments_extract_archive_check_does_not_raise_check_subparser_error():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
module.parse_arguments('extract', '--archive', 'check')
|
|
|
|
|
|
def test_parse_arguments_extract_with_check_only_extract_does_not_raise():
|
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
|
|
module.parse_arguments('extract', '--archive', 'name', 'check', '--only', 'extract')
|