From cc9044487b6e769921b8387e137686fb964b2513 Mon Sep 17 00:00:00 2001 From: Dan Helfman Date: Sat, 26 May 2018 15:09:23 -0700 Subject: [PATCH] Support for Borg --nobsdflags option to skip recording bsdflags (e.g. NODUMP, IMMUTABLE) in archive (#63). --- NEWS | 2 + borgmatic/borg/create.py | 58 ++++++++++++------------ borgmatic/config/schema.yaml | 4 ++ borgmatic/tests/unit/borg/test_create.py | 42 +++++++++++++++++ 4 files changed, 78 insertions(+), 28 deletions(-) diff --git a/NEWS b/NEWS index 89e2009..51b42e3 100644 --- a/NEWS +++ b/NEWS @@ -6,6 +6,8 @@ * #62: Update README to mention other ways of installing borgmatic. * #59: Ignore "check_last" and consistency "prefix" when "archives" not in consistency checks. * #60: Add "Persistent" flag to systemd timer example. + * #63: Support for Borg --nobsdflags option to skip recording bsdflags (e.g. NODUMP, IMMUTABLE) in + archive. 1.1.15 * Support for Borg BORG_PASSCOMMAND environment variable to read a password from an external file. diff --git a/borgmatic/borg/create.py b/borgmatic/borg/create.py index bbc9308..632f39c 100644 --- a/borgmatic/borg/create.py +++ b/borgmatic/borg/create.py @@ -114,44 +114,46 @@ def create_archive( sources = _expand_directories(location_config['source_directories']) pattern_file = _write_pattern_file(location_config.get('patterns')) - pattern_flags = _make_pattern_flags( - location_config, - pattern_file.name if pattern_file else None, - ) exclude_file = _write_pattern_file(_expand_directories(location_config.get('exclude_patterns'))) - exclude_flags = _make_exclude_flags( - location_config, - exclude_file.name if exclude_file else None, - ) compression = storage_config.get('compression', None) - compression_flags = ('--compression', compression) if compression else () remote_rate_limit = storage_config.get('remote_rate_limit', None) - remote_rate_limit_flags = ('--remote-ratelimit', str(remote_rate_limit)) if remote_rate_limit else () umask = storage_config.get('umask', None) - umask_flags = ('--umask', str(umask)) if umask else () lock_wait = storage_config.get('lock_wait', None) - lock_wait_flags = ('--lock-wait', str(lock_wait)) if lock_wait else () - one_file_system_flags = ('--one-file-system',) if location_config.get('one_file_system') else () files_cache = location_config.get('files_cache') - files_cache_flags = ('--files-cache', files_cache) if files_cache else () - remote_path_flags = ('--remote-path', remote_path) if remote_path else () - verbosity_flags = { - VERBOSITY_SOME: ('--info',) if dry_run else ('--info', '--stats',), - VERBOSITY_LOTS: ('--debug', '--list',) if dry_run else ('--debug', '--list', '--stats',), - }.get(verbosity, ()) - dry_run_flags = ('--dry-run',) if dry_run else () default_archive_name_format = '{hostname}-{now:%Y-%m-%dT%H:%M:%S.%f}' archive_name_format = storage_config.get('archive_name_format', default_archive_name_format) full_command = ( - local_path, 'create', - '{repository}::{archive_name_format}'.format( - repository=repository, - archive_name_format=archive_name_format, - ), - ) + sources + pattern_flags + exclude_flags + compression_flags + remote_rate_limit_flags + \ - one_file_system_flags + files_cache_flags + remote_path_flags + umask_flags + \ - lock_wait_flags + verbosity_flags + dry_run_flags + ( + local_path, 'create', + '{repository}::{archive_name_format}'.format( + repository=repository, + archive_name_format=archive_name_format, + ), + ) + + sources + + _make_pattern_flags( + location_config, + pattern_file.name if pattern_file else None, + ) + + _make_exclude_flags( + location_config, + exclude_file.name if exclude_file else None, + ) + + (('--compression', compression) if compression else ()) + + (('--remote-ratelimit', str(remote_rate_limit)) if remote_rate_limit else ()) + + (('--one-file-system',) if location_config.get('one_file_system') else ()) + + (('--nobsdflags',) if location_config.get('bsd_flags') is False else ()) + + (('--files-cache', files_cache) if files_cache else ()) + + (('--remote-path', remote_path) if remote_path else ()) + + (('--umask', str(umask)) if umask else ()) + + (('--lock-wait', str(lock_wait)) if lock_wait else ()) + + { + VERBOSITY_SOME: ('--info',) if dry_run else ('--info', '--stats',), + VERBOSITY_LOTS: ('--debug', '--list',) if dry_run else ('--debug', '--list', '--stats',), + }.get(verbosity, ()) + + (('--dry-run',) if dry_run else ()) + ) logger.debug(' '.join(full_command)) subprocess.check_call(full_command) diff --git a/borgmatic/config/schema.yaml b/borgmatic/config/schema.yaml index 8706f43..a7b9a17 100644 --- a/borgmatic/config/schema.yaml +++ b/borgmatic/config/schema.yaml @@ -22,6 +22,10 @@ map: type: bool desc: Stay in same file system (do not cross mount points). example: true + bsd_flags: + type: bool + desc: Record bsdflags (e.g. NODUMP, IMMUTABLE) in archive. Defaults to true. + example: true files_cache: type: scalar desc: | diff --git a/borgmatic/tests/unit/borg/test_create.py b/borgmatic/tests/unit/borg/test_create.py index 8831e63..411893c 100644 --- a/borgmatic/tests/unit/borg/test_create.py +++ b/borgmatic/tests/unit/borg/test_create.py @@ -435,6 +435,48 @@ def test_create_archive_with_one_file_system_calls_borg_with_one_file_system_par ) +def test_create_archive_with_bsd_flags_true_calls_borg_without_nobsdflags_parameter(): + flexmock(module).should_receive('_expand_directories').and_return(('foo', 'bar')).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(()) + insert_subprocess_mock(CREATE_COMMAND) + + module.create_archive( + verbosity=None, + dry_run=False, + repository='repo', + location_config={ + 'source_directories': ['foo', 'bar'], + 'repositories': ['repo'], + 'bsd_flags': True, + 'exclude_patterns': None, + }, + storage_config={}, + ) + + +def test_create_archive_with_bsd_flags_false_calls_borg_with_nobsdflags_parameter(): + flexmock(module).should_receive('_expand_directories').and_return(('foo', 'bar')).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(()) + insert_subprocess_mock(CREATE_COMMAND + ('--nobsdflags',)) + + module.create_archive( + verbosity=None, + dry_run=False, + repository='repo', + location_config={ + 'source_directories': ['foo', 'bar'], + 'repositories': ['repo'], + 'bsd_flags': 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')).and_return(()) flexmock(module).should_receive('_write_pattern_file').and_return(None)