Added storage.archive_name_format to config (#16)

* Added storage.archive_name_format to config
This commit is contained in:
Michele Lazzeri 2017-09-03 20:13:14 +02:00
parent 7c048d1989
commit 867d3fceb0
4 changed files with 78 additions and 43 deletions

View file

@ -1,8 +1,6 @@
from datetime import datetime
import glob import glob
import itertools import itertools
import os import os
import platform
import subprocess import subprocess
import tempfile import tempfile
@ -82,15 +80,16 @@ def create_archive(
VERBOSITY_SOME: ('--info', '--stats',), VERBOSITY_SOME: ('--info', '--stats',),
VERBOSITY_LOTS: ('--debug', '--list', '--stats'), VERBOSITY_LOTS: ('--debug', '--list', '--stats'),
}.get(verbosity, ()) }.get(verbosity, ())
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 = ( full_command = (
'borg', 'create', 'borg', 'create',
'{repository}::{hostname}-{timestamp}'.format( '{repository}::{archive_name_format}'.format(
repository=repository, repository=repository,
hostname=platform.node(), archive_name_format=archive_name_format,
timestamp=datetime.now().isoformat(),
), ),
) + sources + exclude_flags + compression_flags + one_file_system_flags + \ ) + sources + exclude_flags + compression_flags + one_file_system_flags + \
remote_path_flags + umask_flags + verbosity_flags remote_path_flags + umask_flags + verbosity_flags
subprocess.check_call(full_command) subprocess.check_call(full_command)

View file

@ -88,6 +88,13 @@ map:
type: scalar type: scalar
desc: Umask to be used for borg create. desc: Umask to be used for borg create.
example: 0077 example: 0077
archive_name_format:
type: scalar
desc: |
Name of the archive. Borg placeholders can be used. See
https://borgbackup.readthedocs.io/en/stable/usage.html#borg-help-placeholders
Default is "{hostname}-{now:%Y-%m-%dT%H:%M:%S.%f}"
example: "{hostname}-documents-{now}"
retention: retention:
desc: | desc: |
Retention policy for how many backups to keep in each category. See Retention policy for how many backups to keep in each category. See
@ -119,7 +126,10 @@ map:
example: 1 example: 1
prefix: prefix:
type: scalar type: scalar
desc: When pruning, only consider archive names starting with this prefix. desc: |
When pruning, only consider archive names starting with this prefix.
Borg placeholders can be used. See
https://borgbackup.readthedocs.io/en/stable/usage.html#borg-help-placeholders
example: sourcehostname example: sourcehostname
consistency: consistency:
desc: | desc: |

View file

@ -48,16 +48,6 @@ def insert_subprocess_mock(check_call_command, **kwargs):
subprocess.should_receive('check_call').with_args(check_call_command, **kwargs).once() subprocess.should_receive('check_call').with_args(check_call_command, **kwargs).once()
def insert_platform_mock():
flexmock(module.platform).should_receive('node').and_return('host')
def insert_datetime_mock():
flexmock(module).datetime = flexmock().should_receive('now').and_return(
flexmock().should_receive('isoformat').and_return('now').mock
).mock
def test_make_exclude_flags_includes_exclude_patterns_filename_when_given(): def test_make_exclude_flags_includes_exclude_patterns_filename_when_given():
exclude_flags = module._make_exclude_flags( exclude_flags = module._make_exclude_flags(
location_config={'exclude_patterns': ['*.pyc', '/var']}, location_config={'exclude_patterns': ['*.pyc', '/var']},
@ -128,15 +118,14 @@ def test_make_exclude_flags_is_empty_when_config_has_no_excludes():
assert exclude_flags == () assert exclude_flags == ()
CREATE_COMMAND = ('borg', 'create', 'repo::host-now', 'foo', 'bar') DEFAULT_ARCHIVE_NAME = '{hostname}-{now:%Y-%m-%dT%H:%M:%S.%f}'
CREATE_COMMAND = ('borg', 'create', 'repo::{}'.format(DEFAULT_ARCHIVE_NAME), 'foo', 'bar')
def test_create_archive_should_call_borg_with_parameters(): def test_create_archive_should_call_borg_with_parameters():
flexmock(module).should_receive('_write_exclude_file').and_return(None) flexmock(module).should_receive('_write_exclude_file').and_return(None)
flexmock(module).should_receive('_make_exclude_flags').and_return(()) flexmock(module).should_receive('_make_exclude_flags').and_return(())
insert_subprocess_mock(CREATE_COMMAND) insert_subprocess_mock(CREATE_COMMAND)
insert_platform_mock()
insert_datetime_mock()
module.create_archive( module.create_archive(
verbosity=None, verbosity=None,
@ -155,8 +144,6 @@ def test_create_archive_with_exclude_patterns_should_call_borg_with_excludes():
flexmock(module).should_receive('_write_exclude_file').and_return(flexmock(name='/tmp/excludes')) flexmock(module).should_receive('_write_exclude_file').and_return(flexmock(name='/tmp/excludes'))
flexmock(module).should_receive('_make_exclude_flags').and_return(exclude_flags) flexmock(module).should_receive('_make_exclude_flags').and_return(exclude_flags)
insert_subprocess_mock(CREATE_COMMAND + exclude_flags) insert_subprocess_mock(CREATE_COMMAND + exclude_flags)
insert_platform_mock()
insert_datetime_mock()
module.create_archive( module.create_archive(
verbosity=None, verbosity=None,
@ -174,8 +161,6 @@ def test_create_archive_with_verbosity_some_should_call_borg_with_info_parameter
flexmock(module).should_receive('_write_exclude_file').and_return(None) flexmock(module).should_receive('_write_exclude_file').and_return(None)
flexmock(module).should_receive('_make_exclude_flags').and_return(()) flexmock(module).should_receive('_make_exclude_flags').and_return(())
insert_subprocess_mock(CREATE_COMMAND + ('--info', '--stats',)) insert_subprocess_mock(CREATE_COMMAND + ('--info', '--stats',))
insert_platform_mock()
insert_datetime_mock()
module.create_archive( module.create_archive(
verbosity=VERBOSITY_SOME, verbosity=VERBOSITY_SOME,
@ -193,8 +178,6 @@ def test_create_archive_with_verbosity_lots_should_call_borg_with_debug_paramete
flexmock(module).should_receive('_write_exclude_file').and_return(None) flexmock(module).should_receive('_write_exclude_file').and_return(None)
flexmock(module).should_receive('_make_exclude_flags').and_return(()) flexmock(module).should_receive('_make_exclude_flags').and_return(())
insert_subprocess_mock(CREATE_COMMAND + ('--debug', '--list', '--stats')) insert_subprocess_mock(CREATE_COMMAND + ('--debug', '--list', '--stats'))
insert_platform_mock()
insert_datetime_mock()
module.create_archive( module.create_archive(
verbosity=VERBOSITY_LOTS, verbosity=VERBOSITY_LOTS,
@ -212,8 +195,6 @@ def test_create_archive_with_compression_should_call_borg_with_compression_param
flexmock(module).should_receive('_write_exclude_file').and_return(None) flexmock(module).should_receive('_write_exclude_file').and_return(None)
flexmock(module).should_receive('_make_exclude_flags').and_return(()) flexmock(module).should_receive('_make_exclude_flags').and_return(())
insert_subprocess_mock(CREATE_COMMAND + ('--compression', 'rle')) insert_subprocess_mock(CREATE_COMMAND + ('--compression', 'rle'))
insert_platform_mock()
insert_datetime_mock()
module.create_archive( module.create_archive(
verbosity=None, verbosity=None,
@ -231,8 +212,6 @@ def test_create_archive_with_one_file_system_should_call_borg_with_one_file_syst
flexmock(module).should_receive('_write_exclude_file').and_return(None) flexmock(module).should_receive('_write_exclude_file').and_return(None)
flexmock(module).should_receive('_make_exclude_flags').and_return(()) flexmock(module).should_receive('_make_exclude_flags').and_return(())
insert_subprocess_mock(CREATE_COMMAND + ('--one-file-system',)) insert_subprocess_mock(CREATE_COMMAND + ('--one-file-system',))
insert_platform_mock()
insert_datetime_mock()
module.create_archive( module.create_archive(
verbosity=None, verbosity=None,
@ -251,8 +230,6 @@ def test_create_archive_with_remote_path_should_call_borg_with_remote_path_param
flexmock(module).should_receive('_write_exclude_file').and_return(None) flexmock(module).should_receive('_write_exclude_file').and_return(None)
flexmock(module).should_receive('_make_exclude_flags').and_return(()) flexmock(module).should_receive('_make_exclude_flags').and_return(())
insert_subprocess_mock(CREATE_COMMAND + ('--remote-path', 'borg1')) insert_subprocess_mock(CREATE_COMMAND + ('--remote-path', 'borg1'))
insert_platform_mock()
insert_datetime_mock()
module.create_archive( module.create_archive(
verbosity=None, verbosity=None,
@ -271,8 +248,6 @@ def test_create_archive_with_umask_should_call_borg_with_umask_parameters():
flexmock(module).should_receive('_write_exclude_file').and_return(None) flexmock(module).should_receive('_write_exclude_file').and_return(None)
flexmock(module).should_receive('_make_exclude_flags').and_return(()) flexmock(module).should_receive('_make_exclude_flags').and_return(())
insert_subprocess_mock(CREATE_COMMAND + ('--umask', '740')) insert_subprocess_mock(CREATE_COMMAND + ('--umask', '740'))
insert_platform_mock()
insert_datetime_mock()
module.create_archive( module.create_archive(
verbosity=None, verbosity=None,
@ -289,9 +264,7 @@ def test_create_archive_with_umask_should_call_borg_with_umask_parameters():
def test_create_archive_with_source_directories_glob_expands(): def test_create_archive_with_source_directories_glob_expands():
flexmock(module).should_receive('_write_exclude_file').and_return(None) flexmock(module).should_receive('_write_exclude_file').and_return(None)
flexmock(module).should_receive('_make_exclude_flags').and_return(()) flexmock(module).should_receive('_make_exclude_flags').and_return(())
insert_subprocess_mock(('borg', 'create', 'repo::host-now', 'foo', 'food')) insert_subprocess_mock(('borg', 'create', 'repo::{}'.format(DEFAULT_ARCHIVE_NAME), 'foo', 'food'))
insert_platform_mock()
insert_datetime_mock()
flexmock(module.glob).should_receive('glob').with_args('foo*').and_return(['foo', 'food']) flexmock(module.glob).should_receive('glob').with_args('foo*').and_return(['foo', 'food'])
module.create_archive( module.create_archive(
@ -309,9 +282,7 @@ def test_create_archive_with_source_directories_glob_expands():
def test_create_archive_with_non_matching_source_directories_glob_passes_through(): def test_create_archive_with_non_matching_source_directories_glob_passes_through():
flexmock(module).should_receive('_write_exclude_file').and_return(None) flexmock(module).should_receive('_write_exclude_file').and_return(None)
flexmock(module).should_receive('_make_exclude_flags').and_return(()) flexmock(module).should_receive('_make_exclude_flags').and_return(())
insert_subprocess_mock(('borg', 'create', 'repo::host-now', 'foo*')) insert_subprocess_mock(('borg', 'create', 'repo::{}'.format(DEFAULT_ARCHIVE_NAME), 'foo*'))
insert_platform_mock()
insert_datetime_mock()
flexmock(module.glob).should_receive('glob').with_args('foo*').and_return([]) flexmock(module.glob).should_receive('glob').with_args('foo*').and_return([])
module.create_archive( module.create_archive(
@ -329,9 +300,7 @@ def test_create_archive_with_non_matching_source_directories_glob_passes_through
def test_create_archive_with_glob_should_call_borg_with_expanded_directories(): def test_create_archive_with_glob_should_call_borg_with_expanded_directories():
flexmock(module).should_receive('_write_exclude_file').and_return(None) flexmock(module).should_receive('_write_exclude_file').and_return(None)
flexmock(module).should_receive('_make_exclude_flags').and_return(()) flexmock(module).should_receive('_make_exclude_flags').and_return(())
insert_subprocess_mock(('borg', 'create', 'repo::host-now', 'foo', 'food')) insert_subprocess_mock(('borg', 'create', 'repo::{}'.format(DEFAULT_ARCHIVE_NAME), 'foo', 'food'))
insert_platform_mock()
insert_datetime_mock()
flexmock(module.glob).should_receive('glob').with_args('foo*').and_return(['foo', 'food']) flexmock(module.glob).should_receive('glob').with_args('foo*').and_return(['foo', 'food'])
module.create_archive( module.create_archive(
@ -344,3 +313,41 @@ def test_create_archive_with_glob_should_call_borg_with_expanded_directories():
}, },
storage_config={}, storage_config={},
) )
def test_create_archive_with_archive_name_format_without_placeholders():
flexmock(module).should_receive('_write_exclude_file').and_return(None)
flexmock(module).should_receive('_make_exclude_flags').and_return(())
insert_subprocess_mock(('borg', 'create', 'repo::ARCHIVE_NAME', 'foo', 'bar'))
module.create_archive(
verbosity=None,
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('_write_exclude_file').and_return(None)
flexmock(module).should_receive('_make_exclude_flags').and_return(())
insert_subprocess_mock(('borg', 'create', 'repo::Documents_{hostname}-{now}', 'foo', 'bar'))
module.create_archive(
verbosity=None,
repository='repo',
location_config={
'source_directories': ['foo', 'bar'],
'repositories': ['repo'],
'exclude_patterns': None,
},
storage_config={
'archive_name_format': 'Documents_{hostname}-{now}',
},
)

View file

@ -32,6 +32,24 @@ def test_make_prune_flags_should_return_flags_from_config():
assert tuple(result) == BASE_PRUNE_FLAGS assert tuple(result) == BASE_PRUNE_FLAGS
def test_make_prune_flags_accepts_prefix_with_placeholders():
retention_config = OrderedDict(
(
('keep_daily', 1),
('prefix', 'Documents_{hostname}-{now}'),
)
)
result = module._make_prune_flags(retention_config)
expected = (
('--keep-daily', '1'),
('--prefix', 'Documents_{hostname}-{now}'),
)
assert tuple(result) == expected
PRUNE_COMMAND = ( PRUNE_COMMAND = (
'borg', 'prune', 'repo', '--keep-daily', '1', '--keep-weekly', '2', '--keep-monthly', '3', 'borg', 'prune', 'repo', '--keep-daily', '1', '--keep-weekly', '2', '--keep-monthly', '3',
) )
@ -78,6 +96,7 @@ def test_prune_archives_with_verbosity_lots_should_call_borg_with_debug_paramete
retention_config=retention_config, retention_config=retention_config,
) )
def test_prune_archives_with_remote_path_should_call_borg_with_remote_path_parameters(): def test_prune_archives_with_remote_path_should_call_borg_with_remote_path_parameters():
retention_config = flexmock() retention_config = flexmock()
flexmock(module).should_receive('_make_prune_flags').with_args(retention_config).and_return( flexmock(module).should_receive('_make_prune_flags').with_args(retention_config).and_return(