925 lines
36 KiB
Python
925 lines
36 KiB
Python
import logging
|
|
|
|
import pytest
|
|
from flexmock import flexmock
|
|
|
|
from borgmatic.borg import create as module
|
|
|
|
from ..test_verbosity import insert_logging_mock
|
|
|
|
|
|
def test_expand_directory_with_basic_path_passes_it_through():
|
|
flexmock(module.os.path).should_receive('expanduser').and_return('foo')
|
|
flexmock(module.glob).should_receive('glob').and_return([])
|
|
|
|
paths = module._expand_directory('foo')
|
|
|
|
assert paths == ['foo']
|
|
|
|
|
|
def test_expand_directory_with_glob_expands():
|
|
flexmock(module.os.path).should_receive('expanduser').and_return('foo*')
|
|
flexmock(module.glob).should_receive('glob').and_return(['foo', 'food'])
|
|
|
|
paths = module._expand_directory('foo*')
|
|
|
|
assert paths == ['foo', 'food']
|
|
|
|
|
|
def test_expand_directories_flattens_expanded_directories():
|
|
flexmock(module).should_receive('_expand_directory').with_args('~/foo').and_return(
|
|
['/root/foo']
|
|
)
|
|
flexmock(module).should_receive('_expand_directory').with_args('bar*').and_return(
|
|
['bar', 'barf']
|
|
)
|
|
|
|
paths = module._expand_directories(('~/foo', 'bar*'))
|
|
|
|
assert paths == ('/root/foo', 'bar', 'barf')
|
|
|
|
|
|
def test_expand_directories_considers_none_as_no_directories():
|
|
paths = module._expand_directories(None)
|
|
|
|
assert paths == ()
|
|
|
|
|
|
def test_expand_home_directories_expands_tildes():
|
|
flexmock(module.os.path).should_receive('expanduser').with_args('~/bar').and_return('/foo/bar')
|
|
flexmock(module.os.path).should_receive('expanduser').with_args('baz').and_return('baz')
|
|
|
|
paths = module._expand_home_directories(('~/bar', 'baz'))
|
|
|
|
assert paths == ('/foo/bar', 'baz')
|
|
|
|
|
|
def test_expand_home_directories_considers_none_as_no_directories():
|
|
paths = module._expand_home_directories(None)
|
|
|
|
assert paths == ()
|
|
|
|
|
|
def test_write_pattern_file_does_not_raise():
|
|
temporary_file = flexmock(name='filename', write=lambda mode: None, flush=lambda: None)
|
|
flexmock(module.tempfile).should_receive('NamedTemporaryFile').and_return(temporary_file)
|
|
|
|
module._write_pattern_file(['exclude'])
|
|
|
|
|
|
def test_write_pattern_file_with_empty_exclude_patterns_does_not_raise():
|
|
module._write_pattern_file([])
|
|
|
|
|
|
def test_make_pattern_flags_includes_pattern_filename_when_given():
|
|
pattern_flags = module._make_pattern_flags(
|
|
location_config={'patterns': ['R /', '- /var']}, pattern_filename='/tmp/patterns'
|
|
)
|
|
|
|
assert pattern_flags == ('--patterns-from', '/tmp/patterns')
|
|
|
|
|
|
def test_make_pattern_flags_includes_patterns_from_filenames_when_in_config():
|
|
pattern_flags = module._make_pattern_flags(
|
|
location_config={'patterns_from': ['patterns', 'other']}
|
|
)
|
|
|
|
assert pattern_flags == ('--patterns-from', 'patterns', '--patterns-from', 'other')
|
|
|
|
|
|
def test_make_pattern_flags_includes_both_filenames_when_patterns_given_and_patterns_from_in_config():
|
|
pattern_flags = module._make_pattern_flags(
|
|
location_config={'patterns_from': ['patterns']}, pattern_filename='/tmp/patterns'
|
|
)
|
|
|
|
assert pattern_flags == ('--patterns-from', 'patterns', '--patterns-from', '/tmp/patterns')
|
|
|
|
|
|
def test_make_pattern_flags_considers_none_patterns_from_filenames_as_empty():
|
|
pattern_flags = module._make_pattern_flags(location_config={'patterns_from': None})
|
|
|
|
assert pattern_flags == ()
|
|
|
|
|
|
def test_make_exclude_flags_includes_exclude_patterns_filename_when_given():
|
|
exclude_flags = module._make_exclude_flags(
|
|
location_config={'exclude_patterns': ['*.pyc', '/var']}, exclude_filename='/tmp/excludes'
|
|
)
|
|
|
|
assert exclude_flags == ('--exclude-from', '/tmp/excludes')
|
|
|
|
|
|
def test_make_exclude_flags_includes_exclude_from_filenames_when_in_config():
|
|
|
|
exclude_flags = module._make_exclude_flags(
|
|
location_config={'exclude_from': ['excludes', 'other']}
|
|
)
|
|
|
|
assert exclude_flags == ('--exclude-from', 'excludes', '--exclude-from', 'other')
|
|
|
|
|
|
def test_make_exclude_flags_includes_both_filenames_when_patterns_given_and_exclude_from_in_config():
|
|
exclude_flags = module._make_exclude_flags(
|
|
location_config={'exclude_from': ['excludes']}, exclude_filename='/tmp/excludes'
|
|
)
|
|
|
|
assert exclude_flags == ('--exclude-from', 'excludes', '--exclude-from', '/tmp/excludes')
|
|
|
|
|
|
def test_make_exclude_flags_considers_none_exclude_from_filenames_as_empty():
|
|
exclude_flags = module._make_exclude_flags(location_config={'exclude_from': None})
|
|
|
|
assert exclude_flags == ()
|
|
|
|
|
|
def test_make_exclude_flags_includes_exclude_caches_when_true_in_config():
|
|
exclude_flags = module._make_exclude_flags(location_config={'exclude_caches': True})
|
|
|
|
assert exclude_flags == ('--exclude-caches',)
|
|
|
|
|
|
def test_make_exclude_flags_does_not_include_exclude_caches_when_false_in_config():
|
|
exclude_flags = module._make_exclude_flags(location_config={'exclude_caches': False})
|
|
|
|
assert exclude_flags == ()
|
|
|
|
|
|
def test_make_exclude_flags_includes_exclude_if_present_when_in_config():
|
|
exclude_flags = module._make_exclude_flags(location_config={'exclude_if_present': 'exclude_me'})
|
|
|
|
assert exclude_flags == ('--exclude-if-present', 'exclude_me')
|
|
|
|
|
|
def test_make_exclude_flags_is_empty_when_config_has_no_excludes():
|
|
exclude_flags = module._make_exclude_flags(location_config={})
|
|
|
|
assert exclude_flags == ()
|
|
|
|
|
|
DEFAULT_ARCHIVE_NAME = '{hostname}-{now:%Y-%m-%dT%H:%M:%S.%f}'
|
|
ARCHIVE_WITH_PATHS = ('repo::{}'.format(DEFAULT_ARCHIVE_NAME), 'foo', 'bar')
|
|
|
|
|
|
def test_create_archive_calls_borg_with_parameters():
|
|
flexmock(module).should_receive('_expand_directories').and_return(('foo', 'bar'))
|
|
flexmock(module).should_receive('_expand_home_directories').and_return(())
|
|
flexmock(module).should_receive('_write_pattern_file').and_return(None)
|
|
flexmock(module).should_receive('_make_pattern_flags').and_return(())
|
|
flexmock(module).should_receive('_make_exclude_flags').and_return(())
|
|
flexmock(module).should_receive('execute_command').with_args(
|
|
('borg', 'create') + ARCHIVE_WITH_PATHS, output_log_level=logging.INFO
|
|
)
|
|
|
|
module.create_archive(
|
|
dry_run=False,
|
|
repository='repo',
|
|
location_config={
|
|
'source_directories': ['foo', 'bar'],
|
|
'repositories': ['repo'],
|
|
'exclude_patterns': None,
|
|
},
|
|
storage_config={},
|
|
)
|
|
|
|
|
|
def test_create_archive_with_patterns_calls_borg_with_patterns():
|
|
pattern_flags = ('--patterns-from', 'patterns')
|
|
flexmock(module).should_receive('_expand_directories').and_return(('foo', 'bar'))
|
|
flexmock(module).should_receive('_expand_home_directories').and_return(())
|
|
flexmock(module).should_receive('_write_pattern_file').and_return(
|
|
flexmock(name='/tmp/patterns')
|
|
).and_return(None)
|
|
flexmock(module).should_receive('_make_pattern_flags').and_return(pattern_flags)
|
|
flexmock(module).should_receive('_make_exclude_flags').and_return(())
|
|
flexmock(module).should_receive('execute_command').with_args(
|
|
('borg', 'create') + pattern_flags + ARCHIVE_WITH_PATHS, output_log_level=logging.INFO
|
|
)
|
|
|
|
module.create_archive(
|
|
dry_run=False,
|
|
repository='repo',
|
|
location_config={
|
|
'source_directories': ['foo', 'bar'],
|
|
'repositories': ['repo'],
|
|
'patterns': ['pattern'],
|
|
},
|
|
storage_config={},
|
|
)
|
|
|
|
|
|
def test_create_archive_with_exclude_patterns_calls_borg_with_excludes():
|
|
exclude_flags = ('--exclude-from', 'excludes')
|
|
flexmock(module).should_receive('_expand_directories').and_return(('foo', 'bar'))
|
|
flexmock(module).should_receive('_expand_home_directories').and_return(('exclude',))
|
|
flexmock(module).should_receive('_write_pattern_file').and_return(None).and_return(
|
|
flexmock(name='/tmp/excludes')
|
|
)
|
|
flexmock(module).should_receive('_make_pattern_flags').and_return(())
|
|
flexmock(module).should_receive('_make_exclude_flags').and_return(exclude_flags)
|
|
flexmock(module).should_receive('execute_command').with_args(
|
|
('borg', 'create') + exclude_flags + ARCHIVE_WITH_PATHS, output_log_level=logging.INFO
|
|
)
|
|
|
|
module.create_archive(
|
|
dry_run=False,
|
|
repository='repo',
|
|
location_config={
|
|
'source_directories': ['foo', 'bar'],
|
|
'repositories': ['repo'],
|
|
'exclude_patterns': ['exclude'],
|
|
},
|
|
storage_config={},
|
|
)
|
|
|
|
|
|
def test_create_archive_with_log_info_calls_borg_with_info_parameter():
|
|
flexmock(module).should_receive('_expand_directories').and_return(('foo', 'bar'))
|
|
flexmock(module).should_receive('_expand_home_directories').and_return(())
|
|
flexmock(module).should_receive('_write_pattern_file').and_return(None)
|
|
flexmock(module).should_receive('_make_pattern_flags').and_return(())
|
|
flexmock(module).should_receive('_make_pattern_flags').and_return(())
|
|
flexmock(module).should_receive('_make_exclude_flags').and_return(())
|
|
flexmock(module).should_receive('execute_command').with_args(
|
|
('borg', 'create', '--list', '--filter', 'AME-', '--info', '--stats') + ARCHIVE_WITH_PATHS,
|
|
output_log_level=logging.INFO,
|
|
)
|
|
insert_logging_mock(logging.INFO)
|
|
|
|
module.create_archive(
|
|
dry_run=False,
|
|
repository='repo',
|
|
location_config={
|
|
'source_directories': ['foo', 'bar'],
|
|
'repositories': ['repo'],
|
|
'exclude_patterns': None,
|
|
},
|
|
storage_config={},
|
|
)
|
|
|
|
|
|
def test_create_archive_with_log_info_and_json_suppresses_most_borg_output():
|
|
flexmock(module).should_receive('_expand_directories').and_return(('foo', 'bar'))
|
|
flexmock(module).should_receive('_expand_home_directories').and_return(())
|
|
flexmock(module).should_receive('_write_pattern_file').and_return(None)
|
|
flexmock(module).should_receive('_make_pattern_flags').and_return(())
|
|
flexmock(module).should_receive('_make_pattern_flags').and_return(())
|
|
flexmock(module).should_receive('_make_exclude_flags').and_return(())
|
|
flexmock(module).should_receive('execute_command').with_args(
|
|
('borg', 'create', '--json') + ARCHIVE_WITH_PATHS, output_log_level=None
|
|
)
|
|
insert_logging_mock(logging.INFO)
|
|
|
|
module.create_archive(
|
|
dry_run=False,
|
|
repository='repo',
|
|
location_config={
|
|
'source_directories': ['foo', 'bar'],
|
|
'repositories': ['repo'],
|
|
'exclude_patterns': None,
|
|
},
|
|
storage_config={},
|
|
json=True,
|
|
)
|
|
|
|
|
|
def test_create_archive_with_log_debug_calls_borg_with_debug_parameter():
|
|
flexmock(module).should_receive('_expand_directories').and_return(('foo', 'bar'))
|
|
flexmock(module).should_receive('_expand_home_directories').and_return(())
|
|
flexmock(module).should_receive('_write_pattern_file').and_return(None)
|
|
flexmock(module).should_receive('_make_pattern_flags').and_return(())
|
|
flexmock(module).should_receive('_make_exclude_flags').and_return(())
|
|
flexmock(module).should_receive('execute_command').with_args(
|
|
('borg', 'create', '--list', '--filter', 'AME-', '--stats', '--debug', '--show-rc')
|
|
+ ARCHIVE_WITH_PATHS,
|
|
output_log_level=logging.INFO,
|
|
)
|
|
insert_logging_mock(logging.DEBUG)
|
|
|
|
module.create_archive(
|
|
dry_run=False,
|
|
repository='repo',
|
|
location_config={
|
|
'source_directories': ['foo', 'bar'],
|
|
'repositories': ['repo'],
|
|
'exclude_patterns': None,
|
|
},
|
|
storage_config={},
|
|
)
|
|
|
|
|
|
def test_create_archive_with_log_debug_and_json_suppresses_most_borg_output():
|
|
flexmock(module).should_receive('_expand_directories').and_return(('foo', 'bar'))
|
|
flexmock(module).should_receive('_expand_home_directories').and_return(())
|
|
flexmock(module).should_receive('_write_pattern_file').and_return(None)
|
|
flexmock(module).should_receive('_make_pattern_flags').and_return(())
|
|
flexmock(module).should_receive('_make_exclude_flags').and_return(())
|
|
flexmock(module).should_receive('execute_command').with_args(
|
|
('borg', 'create', '--json') + ARCHIVE_WITH_PATHS, output_log_level=None
|
|
)
|
|
insert_logging_mock(logging.DEBUG)
|
|
|
|
module.create_archive(
|
|
dry_run=False,
|
|
repository='repo',
|
|
location_config={
|
|
'source_directories': ['foo', 'bar'],
|
|
'repositories': ['repo'],
|
|
'exclude_patterns': None,
|
|
},
|
|
storage_config={},
|
|
json=True,
|
|
)
|
|
|
|
|
|
def test_create_archive_with_dry_run_calls_borg_with_dry_run_parameter():
|
|
flexmock(module).should_receive('_expand_directories').and_return(('foo', 'bar'))
|
|
flexmock(module).should_receive('_expand_home_directories').and_return(())
|
|
flexmock(module).should_receive('_write_pattern_file').and_return(None)
|
|
flexmock(module).should_receive('_make_pattern_flags').and_return(())
|
|
flexmock(module).should_receive('_make_pattern_flags').and_return(())
|
|
flexmock(module).should_receive('_make_exclude_flags').and_return(())
|
|
flexmock(module).should_receive('execute_command').with_args(
|
|
('borg', 'create', '--dry-run') + ARCHIVE_WITH_PATHS, output_log_level=logging.INFO
|
|
)
|
|
|
|
module.create_archive(
|
|
dry_run=True,
|
|
repository='repo',
|
|
location_config={
|
|
'source_directories': ['foo', 'bar'],
|
|
'repositories': ['repo'],
|
|
'exclude_patterns': None,
|
|
},
|
|
storage_config={},
|
|
)
|
|
|
|
|
|
def test_create_archive_with_dry_run_and_log_info_calls_borg_without_stats_parameter():
|
|
# --dry-run and --stats are mutually exclusive, see:
|
|
# https://borgbackup.readthedocs.io/en/stable/usage/create.html#description
|
|
flexmock(module).should_receive('_expand_directories').and_return(('foo', 'bar'))
|
|
flexmock(module).should_receive('_expand_home_directories').and_return(())
|
|
flexmock(module).should_receive('_write_pattern_file').and_return(None)
|
|
flexmock(module).should_receive('_make_pattern_flags').and_return(())
|
|
flexmock(module).should_receive('_make_pattern_flags').and_return(())
|
|
flexmock(module).should_receive('_make_exclude_flags').and_return(())
|
|
flexmock(module).should_receive('execute_command').with_args(
|
|
('borg', 'create', '--list', '--filter', 'AME-', '--info', '--dry-run')
|
|
+ ARCHIVE_WITH_PATHS,
|
|
output_log_level=logging.INFO,
|
|
)
|
|
insert_logging_mock(logging.INFO)
|
|
|
|
module.create_archive(
|
|
dry_run=True,
|
|
repository='repo',
|
|
location_config={
|
|
'source_directories': ['foo', 'bar'],
|
|
'repositories': ['repo'],
|
|
'exclude_patterns': None,
|
|
},
|
|
storage_config={},
|
|
)
|
|
|
|
|
|
def test_create_archive_with_dry_run_and_log_debug_calls_borg_without_stats_parameter():
|
|
# --dry-run and --stats are mutually exclusive, see:
|
|
# https://borgbackup.readthedocs.io/en/stable/usage/create.html#description
|
|
flexmock(module).should_receive('_expand_directories').and_return(('foo', 'bar'))
|
|
flexmock(module).should_receive('_expand_home_directories').and_return(())
|
|
flexmock(module).should_receive('_write_pattern_file').and_return(None)
|
|
flexmock(module).should_receive('_make_pattern_flags').and_return(())
|
|
flexmock(module).should_receive('_make_pattern_flags').and_return(())
|
|
flexmock(module).should_receive('_make_exclude_flags').and_return(())
|
|
flexmock(module).should_receive('execute_command').with_args(
|
|
('borg', 'create', '--list', '--filter', 'AME-', '--debug', '--show-rc', '--dry-run')
|
|
+ ARCHIVE_WITH_PATHS,
|
|
output_log_level=logging.INFO,
|
|
)
|
|
insert_logging_mock(logging.DEBUG)
|
|
|
|
module.create_archive(
|
|
dry_run=True,
|
|
repository='repo',
|
|
location_config={
|
|
'source_directories': ['foo', 'bar'],
|
|
'repositories': ['repo'],
|
|
'exclude_patterns': None,
|
|
},
|
|
storage_config={},
|
|
)
|
|
|
|
|
|
def test_create_archive_with_checkpoint_interval_calls_borg_with_checkpoint_interval_parameters():
|
|
flexmock(module).should_receive('_expand_directories').and_return(('foo', 'bar'))
|
|
flexmock(module).should_receive('_expand_home_directories').and_return(())
|
|
flexmock(module).should_receive('_write_pattern_file').and_return(None)
|
|
flexmock(module).should_receive('_make_pattern_flags').and_return(())
|
|
flexmock(module).should_receive('_make_exclude_flags').and_return(())
|
|
flexmock(module).should_receive('execute_command').with_args(
|
|
('borg', 'create', '--checkpoint-interval', '600') + ARCHIVE_WITH_PATHS,
|
|
output_log_level=logging.INFO,
|
|
)
|
|
|
|
module.create_archive(
|
|
dry_run=False,
|
|
repository='repo',
|
|
location_config={
|
|
'source_directories': ['foo', 'bar'],
|
|
'repositories': ['repo'],
|
|
'exclude_patterns': None,
|
|
},
|
|
storage_config={'checkpoint_interval': 600},
|
|
)
|
|
|
|
|
|
def test_create_archive_with_chunker_params_calls_borg_with_chunker_params_parameters():
|
|
flexmock(module).should_receive('_expand_directories').and_return(('foo', 'bar'))
|
|
flexmock(module).should_receive('_expand_home_directories').and_return(())
|
|
flexmock(module).should_receive('_write_pattern_file').and_return(None)
|
|
flexmock(module).should_receive('_make_pattern_flags').and_return(())
|
|
flexmock(module).should_receive('_make_exclude_flags').and_return(())
|
|
flexmock(module).should_receive('execute_command').with_args(
|
|
('borg', 'create', '--chunker-params', '1,2,3,4') + ARCHIVE_WITH_PATHS,
|
|
output_log_level=logging.INFO,
|
|
)
|
|
|
|
module.create_archive(
|
|
dry_run=False,
|
|
repository='repo',
|
|
location_config={
|
|
'source_directories': ['foo', 'bar'],
|
|
'repositories': ['repo'],
|
|
'exclude_patterns': None,
|
|
},
|
|
storage_config={'chunker_params': '1,2,3,4'},
|
|
)
|
|
|
|
|
|
def test_create_archive_with_compression_calls_borg_with_compression_parameters():
|
|
flexmock(module).should_receive('_expand_directories').and_return(('foo', 'bar'))
|
|
flexmock(module).should_receive('_expand_home_directories').and_return(())
|
|
flexmock(module).should_receive('_write_pattern_file').and_return(None)
|
|
flexmock(module).should_receive('_make_pattern_flags').and_return(())
|
|
flexmock(module).should_receive('_make_exclude_flags').and_return(())
|
|
flexmock(module).should_receive('execute_command').with_args(
|
|
('borg', 'create', '--compression', 'rle') + ARCHIVE_WITH_PATHS,
|
|
output_log_level=logging.INFO,
|
|
)
|
|
|
|
module.create_archive(
|
|
dry_run=False,
|
|
repository='repo',
|
|
location_config={
|
|
'source_directories': ['foo', 'bar'],
|
|
'repositories': ['repo'],
|
|
'exclude_patterns': None,
|
|
},
|
|
storage_config={'compression': 'rle'},
|
|
)
|
|
|
|
|
|
def test_create_archive_with_remote_rate_limit_calls_borg_with_remote_ratelimit_parameters():
|
|
flexmock(module).should_receive('_expand_directories').and_return(('foo', 'bar'))
|
|
flexmock(module).should_receive('_expand_home_directories').and_return(())
|
|
flexmock(module).should_receive('_write_pattern_file').and_return(None)
|
|
flexmock(module).should_receive('_make_pattern_flags').and_return(())
|
|
flexmock(module).should_receive('_make_exclude_flags').and_return(())
|
|
flexmock(module).should_receive('execute_command').with_args(
|
|
('borg', 'create', '--remote-ratelimit', '100') + ARCHIVE_WITH_PATHS,
|
|
output_log_level=logging.INFO,
|
|
)
|
|
|
|
module.create_archive(
|
|
dry_run=False,
|
|
repository='repo',
|
|
location_config={
|
|
'source_directories': ['foo', 'bar'],
|
|
'repositories': ['repo'],
|
|
'exclude_patterns': None,
|
|
},
|
|
storage_config={'remote_rate_limit': 100},
|
|
)
|
|
|
|
|
|
def test_create_archive_with_one_file_system_calls_borg_with_one_file_system_parameter():
|
|
flexmock(module).should_receive('_expand_directories').and_return(('foo', 'bar'))
|
|
flexmock(module).should_receive('_expand_home_directories').and_return(())
|
|
flexmock(module).should_receive('_write_pattern_file').and_return(None)
|
|
flexmock(module).should_receive('_make_pattern_flags').and_return(())
|
|
flexmock(module).should_receive('_make_exclude_flags').and_return(())
|
|
flexmock(module).should_receive('execute_command').with_args(
|
|
('borg', 'create', '--one-file-system') + ARCHIVE_WITH_PATHS, output_log_level=logging.INFO
|
|
)
|
|
|
|
module.create_archive(
|
|
dry_run=False,
|
|
repository='repo',
|
|
location_config={
|
|
'source_directories': ['foo', 'bar'],
|
|
'repositories': ['repo'],
|
|
'one_file_system': True,
|
|
'exclude_patterns': None,
|
|
},
|
|
storage_config={},
|
|
)
|
|
|
|
|
|
def test_create_archive_with_numeric_owner_calls_borg_with_numeric_owner_parameter():
|
|
flexmock(module).should_receive('_expand_directories').and_return(('foo', 'bar'))
|
|
flexmock(module).should_receive('_expand_home_directories').and_return(())
|
|
flexmock(module).should_receive('_write_pattern_file').and_return(None)
|
|
flexmock(module).should_receive('_make_pattern_flags').and_return(())
|
|
flexmock(module).should_receive('_make_exclude_flags').and_return(())
|
|
flexmock(module).should_receive('execute_command').with_args(
|
|
('borg', 'create', '--numeric-owner') + ARCHIVE_WITH_PATHS, output_log_level=logging.INFO
|
|
)
|
|
|
|
module.create_archive(
|
|
dry_run=False,
|
|
repository='repo',
|
|
location_config={
|
|
'source_directories': ['foo', 'bar'],
|
|
'repositories': ['repo'],
|
|
'numeric_owner': True,
|
|
'exclude_patterns': None,
|
|
},
|
|
storage_config={},
|
|
)
|
|
|
|
|
|
def test_create_archive_with_read_special_calls_borg_with_read_special_parameter():
|
|
flexmock(module).should_receive('_expand_directories').and_return(('foo', 'bar'))
|
|
flexmock(module).should_receive('_expand_home_directories').and_return(())
|
|
flexmock(module).should_receive('_write_pattern_file').and_return(None)
|
|
flexmock(module).should_receive('_make_pattern_flags').and_return(())
|
|
flexmock(module).should_receive('_make_exclude_flags').and_return(())
|
|
flexmock(module).should_receive('execute_command').with_args(
|
|
('borg', 'create', '--read-special') + ARCHIVE_WITH_PATHS, output_log_level=logging.INFO
|
|
)
|
|
|
|
module.create_archive(
|
|
dry_run=False,
|
|
repository='repo',
|
|
location_config={
|
|
'source_directories': ['foo', 'bar'],
|
|
'repositories': ['repo'],
|
|
'read_special': True,
|
|
'exclude_patterns': None,
|
|
},
|
|
storage_config={},
|
|
)
|
|
|
|
|
|
@pytest.mark.parametrize('option_name', ('atime', 'ctime', 'birthtime', 'bsd_flags'))
|
|
def test_create_archive_with_option_true_calls_borg_without_corresponding_parameter(option_name):
|
|
flexmock(module).should_receive('_expand_directories').and_return(('foo', 'bar'))
|
|
flexmock(module).should_receive('_expand_home_directories').and_return(())
|
|
flexmock(module).should_receive('_write_pattern_file').and_return(None)
|
|
flexmock(module).should_receive('_make_pattern_flags').and_return(())
|
|
flexmock(module).should_receive('_make_exclude_flags').and_return(())
|
|
flexmock(module).should_receive('execute_command').with_args(
|
|
('borg', 'create') + ARCHIVE_WITH_PATHS, output_log_level=logging.INFO
|
|
)
|
|
|
|
module.create_archive(
|
|
dry_run=False,
|
|
repository='repo',
|
|
location_config={
|
|
'source_directories': ['foo', 'bar'],
|
|
'repositories': ['repo'],
|
|
option_name: True,
|
|
'exclude_patterns': None,
|
|
},
|
|
storage_config={},
|
|
)
|
|
|
|
|
|
@pytest.mark.parametrize('option_name', ('atime', 'ctime', 'birthtime', 'bsd_flags'))
|
|
def test_create_archive_with_option_false_calls_borg_with_corresponding_parameter(option_name):
|
|
flexmock(module).should_receive('_expand_directories').and_return(('foo', 'bar'))
|
|
flexmock(module).should_receive('_expand_home_directories').and_return(())
|
|
flexmock(module).should_receive('_write_pattern_file').and_return(None)
|
|
flexmock(module).should_receive('_make_pattern_flags').and_return(())
|
|
flexmock(module).should_receive('_make_exclude_flags').and_return(())
|
|
flexmock(module).should_receive('execute_command').with_args(
|
|
('borg', 'create', '--no' + option_name.replace('_', '')) + ARCHIVE_WITH_PATHS,
|
|
output_log_level=logging.INFO,
|
|
)
|
|
|
|
module.create_archive(
|
|
dry_run=False,
|
|
repository='repo',
|
|
location_config={
|
|
'source_directories': ['foo', 'bar'],
|
|
'repositories': ['repo'],
|
|
option_name: False,
|
|
'exclude_patterns': None,
|
|
},
|
|
storage_config={},
|
|
)
|
|
|
|
|
|
def test_create_archive_with_files_cache_calls_borg_with_files_cache_parameters():
|
|
flexmock(module).should_receive('_expand_directories').and_return(('foo', 'bar'))
|
|
flexmock(module).should_receive('_expand_home_directories').and_return(())
|
|
flexmock(module).should_receive('_write_pattern_file').and_return(None)
|
|
flexmock(module).should_receive('_make_pattern_flags').and_return(())
|
|
flexmock(module).should_receive('_make_exclude_flags').and_return(())
|
|
flexmock(module).should_receive('execute_command').with_args(
|
|
('borg', 'create', '--files-cache', 'ctime,size') + ARCHIVE_WITH_PATHS,
|
|
output_log_level=logging.INFO,
|
|
)
|
|
|
|
module.create_archive(
|
|
dry_run=False,
|
|
repository='repo',
|
|
location_config={
|
|
'source_directories': ['foo', 'bar'],
|
|
'repositories': ['repo'],
|
|
'files_cache': 'ctime,size',
|
|
'exclude_patterns': None,
|
|
},
|
|
storage_config={},
|
|
)
|
|
|
|
|
|
def test_create_archive_with_local_path_calls_borg_via_local_path():
|
|
flexmock(module).should_receive('_expand_directories').and_return(('foo', 'bar'))
|
|
flexmock(module).should_receive('_expand_home_directories').and_return(())
|
|
flexmock(module).should_receive('_write_pattern_file').and_return(None)
|
|
flexmock(module).should_receive('_make_pattern_flags').and_return(())
|
|
flexmock(module).should_receive('_make_exclude_flags').and_return(())
|
|
flexmock(module).should_receive('execute_command').with_args(
|
|
('borg1', 'create') + ARCHIVE_WITH_PATHS, output_log_level=logging.INFO
|
|
)
|
|
|
|
module.create_archive(
|
|
dry_run=False,
|
|
repository='repo',
|
|
location_config={
|
|
'source_directories': ['foo', 'bar'],
|
|
'repositories': ['repo'],
|
|
'exclude_patterns': None,
|
|
},
|
|
storage_config={},
|
|
local_path='borg1',
|
|
)
|
|
|
|
|
|
def test_create_archive_with_remote_path_calls_borg_with_remote_path_parameters():
|
|
flexmock(module).should_receive('_expand_directories').and_return(('foo', 'bar'))
|
|
flexmock(module).should_receive('_expand_home_directories').and_return(())
|
|
flexmock(module).should_receive('_write_pattern_file').and_return(None)
|
|
flexmock(module).should_receive('_make_pattern_flags').and_return(())
|
|
flexmock(module).should_receive('_make_exclude_flags').and_return(())
|
|
flexmock(module).should_receive('execute_command').with_args(
|
|
('borg', 'create', '--remote-path', 'borg1') + ARCHIVE_WITH_PATHS,
|
|
output_log_level=logging.INFO,
|
|
)
|
|
|
|
module.create_archive(
|
|
dry_run=False,
|
|
repository='repo',
|
|
location_config={
|
|
'source_directories': ['foo', 'bar'],
|
|
'repositories': ['repo'],
|
|
'exclude_patterns': None,
|
|
},
|
|
storage_config={},
|
|
remote_path='borg1',
|
|
)
|
|
|
|
|
|
def test_create_archive_with_umask_calls_borg_with_umask_parameters():
|
|
flexmock(module).should_receive('_expand_directories').and_return(('foo', 'bar'))
|
|
flexmock(module).should_receive('_expand_home_directories').and_return(())
|
|
flexmock(module).should_receive('_write_pattern_file').and_return(None)
|
|
flexmock(module).should_receive('_make_pattern_flags').and_return(())
|
|
flexmock(module).should_receive('_make_exclude_flags').and_return(())
|
|
flexmock(module).should_receive('execute_command').with_args(
|
|
('borg', 'create', '--umask', '740') + ARCHIVE_WITH_PATHS, output_log_level=logging.INFO
|
|
)
|
|
|
|
module.create_archive(
|
|
dry_run=False,
|
|
repository='repo',
|
|
location_config={
|
|
'source_directories': ['foo', 'bar'],
|
|
'repositories': ['repo'],
|
|
'exclude_patterns': None,
|
|
},
|
|
storage_config={'umask': 740},
|
|
)
|
|
|
|
|
|
def test_create_archive_with_lock_wait_calls_borg_with_lock_wait_parameters():
|
|
flexmock(module).should_receive('_expand_directories').and_return(('foo', 'bar'))
|
|
flexmock(module).should_receive('_expand_home_directories').and_return(())
|
|
flexmock(module).should_receive('_write_pattern_file').and_return(None)
|
|
flexmock(module).should_receive('_make_pattern_flags').and_return(())
|
|
flexmock(module).should_receive('_make_exclude_flags').and_return(())
|
|
flexmock(module).should_receive('execute_command').with_args(
|
|
('borg', 'create', '--lock-wait', '5') + ARCHIVE_WITH_PATHS, output_log_level=logging.INFO
|
|
)
|
|
|
|
module.create_archive(
|
|
dry_run=False,
|
|
repository='repo',
|
|
location_config={
|
|
'source_directories': ['foo', 'bar'],
|
|
'repositories': ['repo'],
|
|
'exclude_patterns': None,
|
|
},
|
|
storage_config={'lock_wait': 5},
|
|
)
|
|
|
|
|
|
def test_create_archive_with_stats_calls_borg_with_stats_parameter():
|
|
flexmock(module).should_receive('_expand_directories').and_return(('foo', 'bar'))
|
|
flexmock(module).should_receive('_expand_home_directories').and_return(())
|
|
flexmock(module).should_receive('_write_pattern_file').and_return(None)
|
|
flexmock(module).should_receive('_make_pattern_flags').and_return(())
|
|
flexmock(module).should_receive('_make_exclude_flags').and_return(())
|
|
flexmock(module).should_receive('execute_command').with_args(
|
|
('borg', 'create', '--stats') + ARCHIVE_WITH_PATHS, output_log_level=logging.WARNING
|
|
)
|
|
|
|
module.create_archive(
|
|
dry_run=False,
|
|
repository='repo',
|
|
location_config={
|
|
'source_directories': ['foo', 'bar'],
|
|
'repositories': ['repo'],
|
|
'exclude_patterns': None,
|
|
},
|
|
storage_config={},
|
|
stats=True,
|
|
)
|
|
|
|
|
|
def test_create_archive_with_json_calls_borg_with_json_parameter():
|
|
flexmock(module).should_receive('_expand_directories').and_return(('foo', 'bar'))
|
|
flexmock(module).should_receive('_expand_home_directories').and_return(())
|
|
flexmock(module).should_receive('_write_pattern_file').and_return(None)
|
|
flexmock(module).should_receive('_make_pattern_flags').and_return(())
|
|
flexmock(module).should_receive('_make_exclude_flags').and_return(())
|
|
flexmock(module).should_receive('execute_command').with_args(
|
|
('borg', 'create', '--json') + ARCHIVE_WITH_PATHS, output_log_level=None
|
|
).and_return('[]')
|
|
|
|
json_output = module.create_archive(
|
|
dry_run=False,
|
|
repository='repo',
|
|
location_config={
|
|
'source_directories': ['foo', 'bar'],
|
|
'repositories': ['repo'],
|
|
'exclude_patterns': None,
|
|
},
|
|
storage_config={},
|
|
json=True,
|
|
)
|
|
|
|
assert json_output == '[]'
|
|
|
|
|
|
def test_create_archive_with_stats_and_json_calls_borg_without_stats_parameter():
|
|
flexmock(module).should_receive('_expand_directories').and_return(('foo', 'bar'))
|
|
flexmock(module).should_receive('_expand_home_directories').and_return(())
|
|
flexmock(module).should_receive('_write_pattern_file').and_return(None)
|
|
flexmock(module).should_receive('_make_pattern_flags').and_return(())
|
|
flexmock(module).should_receive('_make_exclude_flags').and_return(())
|
|
flexmock(module).should_receive('execute_command').with_args(
|
|
('borg', 'create', '--json') + ARCHIVE_WITH_PATHS, output_log_level=None
|
|
).and_return('[]')
|
|
|
|
json_output = module.create_archive(
|
|
dry_run=False,
|
|
repository='repo',
|
|
location_config={
|
|
'source_directories': ['foo', 'bar'],
|
|
'repositories': ['repo'],
|
|
'exclude_patterns': None,
|
|
},
|
|
storage_config={},
|
|
json=True,
|
|
stats=True,
|
|
)
|
|
|
|
assert json_output == '[]'
|
|
|
|
|
|
def test_create_archive_with_source_directories_glob_expands():
|
|
flexmock(module).should_receive('_expand_directories').and_return(('foo', 'food'))
|
|
flexmock(module).should_receive('_expand_home_directories').and_return(())
|
|
flexmock(module).should_receive('_write_pattern_file').and_return(None)
|
|
flexmock(module).should_receive('_make_pattern_flags').and_return(())
|
|
flexmock(module).should_receive('_make_exclude_flags').and_return(())
|
|
flexmock(module).should_receive('execute_command').with_args(
|
|
('borg', 'create', 'repo::{}'.format(DEFAULT_ARCHIVE_NAME), 'foo', 'food'),
|
|
output_log_level=logging.INFO,
|
|
)
|
|
flexmock(module.glob).should_receive('glob').with_args('foo*').and_return(['foo', 'food'])
|
|
|
|
module.create_archive(
|
|
dry_run=False,
|
|
repository='repo',
|
|
location_config={
|
|
'source_directories': ['foo*'],
|
|
'repositories': ['repo'],
|
|
'exclude_patterns': None,
|
|
},
|
|
storage_config={},
|
|
)
|
|
|
|
|
|
def test_create_archive_with_non_matching_source_directories_glob_passes_through():
|
|
flexmock(module).should_receive('_expand_directories').and_return(('foo*',))
|
|
flexmock(module).should_receive('_expand_home_directories').and_return(())
|
|
flexmock(module).should_receive('_write_pattern_file').and_return(None)
|
|
flexmock(module).should_receive('_make_pattern_flags').and_return(())
|
|
flexmock(module).should_receive('_make_exclude_flags').and_return(())
|
|
flexmock(module).should_receive('execute_command').with_args(
|
|
('borg', 'create', 'repo::{}'.format(DEFAULT_ARCHIVE_NAME), 'foo*'),
|
|
output_log_level=logging.INFO,
|
|
)
|
|
flexmock(module.glob).should_receive('glob').with_args('foo*').and_return([])
|
|
|
|
module.create_archive(
|
|
dry_run=False,
|
|
repository='repo',
|
|
location_config={
|
|
'source_directories': ['foo*'],
|
|
'repositories': ['repo'],
|
|
'exclude_patterns': None,
|
|
},
|
|
storage_config={},
|
|
)
|
|
|
|
|
|
def test_create_archive_with_glob_calls_borg_with_expanded_directories():
|
|
flexmock(module).should_receive('_expand_directories').and_return(('foo', 'food'))
|
|
flexmock(module).should_receive('_expand_home_directories').and_return(())
|
|
flexmock(module).should_receive('_write_pattern_file').and_return(None)
|
|
flexmock(module).should_receive('_make_pattern_flags').and_return(())
|
|
flexmock(module).should_receive('_make_exclude_flags').and_return(())
|
|
flexmock(module).should_receive('execute_command').with_args(
|
|
('borg', 'create', 'repo::{}'.format(DEFAULT_ARCHIVE_NAME), 'foo', 'food'),
|
|
output_log_level=logging.INFO,
|
|
)
|
|
|
|
module.create_archive(
|
|
dry_run=False,
|
|
repository='repo',
|
|
location_config={
|
|
'source_directories': ['foo*'],
|
|
'repositories': ['repo'],
|
|
'exclude_patterns': None,
|
|
},
|
|
storage_config={},
|
|
)
|
|
|
|
|
|
def test_create_archive_with_archive_name_format_calls_borg_with_archive_name():
|
|
flexmock(module).should_receive('_expand_directories').and_return(('foo', 'bar'))
|
|
flexmock(module).should_receive('_expand_home_directories').and_return(())
|
|
flexmock(module).should_receive('_write_pattern_file').and_return(None)
|
|
flexmock(module).should_receive('_make_pattern_flags').and_return(())
|
|
flexmock(module).should_receive('_make_exclude_flags').and_return(())
|
|
flexmock(module).should_receive('execute_command').with_args(
|
|
('borg', 'create', 'repo::ARCHIVE_NAME', 'foo', 'bar'), output_log_level=logging.INFO
|
|
)
|
|
|
|
module.create_archive(
|
|
dry_run=False,
|
|
repository='repo',
|
|
location_config={
|
|
'source_directories': ['foo', 'bar'],
|
|
'repositories': ['repo'],
|
|
'exclude_patterns': None,
|
|
},
|
|
storage_config={'archive_name_format': 'ARCHIVE_NAME'},
|
|
)
|
|
|
|
|
|
def test_create_archive_with_archive_name_format_accepts_borg_placeholders():
|
|
flexmock(module).should_receive('_expand_directories').and_return(('foo', 'bar'))
|
|
flexmock(module).should_receive('_expand_home_directories').and_return(())
|
|
flexmock(module).should_receive('_write_pattern_file').and_return(None)
|
|
flexmock(module).should_receive('_make_pattern_flags').and_return(())
|
|
flexmock(module).should_receive('_make_exclude_flags').and_return(())
|
|
flexmock(module).should_receive('execute_command').with_args(
|
|
('borg', 'create', 'repo::Documents_{hostname}-{now}', 'foo', 'bar'),
|
|
output_log_level=logging.INFO,
|
|
)
|
|
|
|
module.create_archive(
|
|
dry_run=False,
|
|
repository='repo',
|
|
location_config={
|
|
'source_directories': ['foo', 'bar'],
|
|
'repositories': ['repo'],
|
|
'exclude_patterns': None,
|
|
},
|
|
storage_config={'archive_name_format': 'Documents_{hostname}-{now}'},
|
|
)
|