forked from borgmatic-collective/borgmatic
Compare commits
72 Commits
Author | SHA1 | Date |
---|---|---|
Dan Helfman | 3561c93d74 | |
Dan Helfman | 331a503a25 | |
Dan Helfman | 9aefb5179f | |
Dan Helfman | d14f22e121 | |
Dan Helfman | b6893f6455 | |
Dan Helfman | 80ec3e7d97 | |
Dan Helfman | cd834311eb | |
Dan Helfman | d751cceeb0 | |
Dan Helfman | ce78b07e4b | |
adidalal | 87f3c50931 | |
Dan Helfman | 8e9e06afe6 | |
Dan Helfman | 2bc91ac3d2 | |
Dan Helfman | 5b615d51a4 | |
Dan Helfman | c7f5d5fd0b | |
Dan Helfman | 6ef7538eb0 | |
Dan Helfman | 8fa90053cf | |
Dan Helfman | b3682b61d1 | |
Dan Helfman | ad0e2e0d7c | |
Dan Helfman | 6629f40cab | |
Dan Helfman | e76bfa555f | |
Dan Helfman | 8ddb7268eb | |
Dan Helfman | cb5fe02ebd | |
Dan Helfman | 77b84f8a48 | |
Dan Helfman | 691ec96909 | |
Steve Atwell | 29b4666205 | |
Dan Helfman | 316a22701f | |
Dan Helfman | be59a3e574 | |
Dan Helfman | 37327379bc | |
Dan Helfman | 22c2f13611 | |
polyzen | 8708ca07f4 | |
Dan Helfman | 634d9e4946 | |
Dan Helfman | 54933ebef5 | |
Dan Helfman | 157e59ac88 | |
Dan Helfman | 666f0dd751 | |
Dan Helfman | 8b179e4647 | |
Dan Helfman | 865eff7d98 | |
Dan Helfman | b9741f4d0b | |
Dan Helfman | 02781662f8 | |
Dan Helfman | 32a1043468 | |
Dan Helfman | 3e4aeec649 | |
Dan Helfman | b98b827594 | |
Dan Helfman | 255cc6ec23 | |
Dan Helfman | 51fc37d57a | |
Dan Helfman | 1921f55a9d | |
Dan Helfman | fbd381fcc1 | |
Dan Helfman | cd88f9f2ea | |
Dan Helfman | 788281cfb9 | |
Dan Helfman | cd234b689d | |
Dan Helfman | 92354a77ee | |
Dan Helfman | 48ff3e70d1 | |
Dan Helfman | 7e9adfb899 | |
Dan Helfman | e238e256f7 | |
Daniel Lo Nigro | 3ecb92a8d2 | |
Dan Helfman | d58d450628 | |
Dan Helfman | dee9c6e293 | |
Dan Helfman | 897c4487de | |
Dan Helfman | 48b50b5209 | |
Dan Helfman | 13bae8c23b | |
Dan Helfman | 4a48e6aa04 | |
Dan Helfman | 525266ede6 | |
Dan Helfman | d045eb55ac | |
Dan Helfman | 0e6b425ac5 | |
Dan Helfman | bdc26f2117 | |
Dan Helfman | ed7fe5c6d0 | |
Dan Helfman | cbce6707f4 | |
Dan Helfman | e40e726687 | |
Dan Helfman | 0c027a3050 | |
Dan Helfman | 9f44bbad65 | |
Dan Helfman | 413a079f51 | |
gerdneuman | 6f3accf691 | |
Dan Helfman | 5b3cfc542d | |
Dan Helfman | c838c1d11b |
66
NEWS
66
NEWS
|
@ -1,3 +1,69 @@
|
||||||
|
1.6.3.dev0
|
||||||
|
* #541: Add "borgmatic list --find" flag for searching for files across multiple archives, useful
|
||||||
|
for hunting down that file you accidentally deleted so you can extract it. See the documentation
|
||||||
|
for more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/inspect-your-backups/#searching-for-a-file
|
||||||
|
* Deprecate "borgmatic list --successful" flag, as listing only non-checkpoint (successful)
|
||||||
|
archives is now the default in newer versions of Borg.
|
||||||
|
|
||||||
|
1.6.2
|
||||||
|
* #523: Reduce the default consistency check frequency and support configuring the frequency
|
||||||
|
independently for each check. Also add "borgmatic check --force" flag to ignore configured
|
||||||
|
frequencies. See the documentation for more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/deal-with-very-large-backups/#check-frequency
|
||||||
|
* #536: Fix generate-borgmatic-config to support more complex schema changes like the new
|
||||||
|
Healthchecks configuration options when the "--source" flag is used.
|
||||||
|
* #538: Add support for "borgmatic borg debug" command.
|
||||||
|
* #539: Add "generate-borgmatic-config --overwrite" flag to replace an existing destination file.
|
||||||
|
* Add Bash completion script so you can tab-complete the borgmatic command-line. See the
|
||||||
|
documentation for more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/set-up-backups/#shell-completion
|
||||||
|
|
||||||
|
1.6.1
|
||||||
|
* #294: Add Healthchecks monitoring hook "ping_body_limit" option to configure how many bytes of
|
||||||
|
logs to send to the Healthchecks server.
|
||||||
|
* #402: Remove the error when "archive_name_format" is specified but a retention prefix isn't.
|
||||||
|
* #420: Warn when an unsupported variable is used in a hook command.
|
||||||
|
* #439: Change connection failures for monitoring hooks (Healthchecks, Cronitor, PagerDuty, and
|
||||||
|
Cronhub) to be warnings instead of errors. This way, the monitoring system failing does not block
|
||||||
|
backups.
|
||||||
|
* #460: Add Healthchecks monitoring hook "send_logs" option to enable/disable sending borgmatic
|
||||||
|
logs to the Healthchecks server.
|
||||||
|
* #525: Add Healthchecks monitoring hook "states" option to only enable pinging for particular
|
||||||
|
monitoring states (start, finish, fail).
|
||||||
|
* #528: Improve the error message when a configuration override contains an invalid value.
|
||||||
|
* #531: BREAKING: When deep merging common configuration, merge colliding list values by appending
|
||||||
|
them. Previously, one list replaced the other.
|
||||||
|
* #532: When a configuration include is a relative path, load it from either the current working
|
||||||
|
directory or from the directory containing the file doing the including. Previously, only the
|
||||||
|
working directory was used.
|
||||||
|
* Add a randomized delay to the sample systemd timer to spread out the load on a server.
|
||||||
|
* Change the configuration format for borgmatic monitoring hooks (Healthchecks, Cronitor,
|
||||||
|
PagerDuty, and Cronhub) to specify the ping URL / integration key as a named option. The intent
|
||||||
|
is to support additional options (some in this release). This change is backwards-compatible.
|
||||||
|
* Add emojis to documentation table of contents to make it easier to find particular how-to and
|
||||||
|
reference guides at a glance.
|
||||||
|
|
||||||
|
1.6.0
|
||||||
|
* #381: BREAKING: Greatly simplify configuration file reuse by deep merging when including common
|
||||||
|
configuration. See the documentation for more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/make-per-application-backups/#include-merging
|
||||||
|
* #473: BREAKING: Instead of executing "before" command hooks before all borgmatic actions run (and
|
||||||
|
"after" hooks after), execute these hooks right before/after the corresponding action. E.g.,
|
||||||
|
"before_check" now runs immediately before the "check" action. This better supports running
|
||||||
|
timing-sensitive tasks like pausing containers. Side effect: before/after command hooks now run
|
||||||
|
once for each configured repository instead of once per configuration file. Additionally, the
|
||||||
|
"repositories" interpolated variable has been changed to "repository", containing the path to the
|
||||||
|
current repository for the hook. See the documentation for more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/add-preparation-and-cleanup-steps-to-backups/
|
||||||
|
* #513: Add mention of sudo's "secure_path" option to borgmatic installation documentation.
|
||||||
|
* #515: Fix "borgmatic borg key ..." to pass parameters to Borg in the correct order.
|
||||||
|
* #516: Fix handling of TERM signal to exit borgmatic, not just forward the signal to Borg.
|
||||||
|
* #517: Fix borgmatic exit code (so it's zero) when initial Borg calls fail but later retries
|
||||||
|
succeed.
|
||||||
|
* Change Healthchecks logs truncation size from 10k bytes to 100k bytes, corresponding to that
|
||||||
|
same change on Healthchecks.io.
|
||||||
|
|
||||||
1.5.24
|
1.5.24
|
||||||
* #431: Add "working_directory" option to support source directories with relative paths.
|
* #431: Add "working_directory" option to support source directories with relative paths.
|
||||||
* #444: When loading a configuration file that is unreadable due to file permissions, warn instead
|
* #444: When loading a configuration file that is unreadable due to file permissions, warn instead
|
||||||
|
|
|
@ -37,8 +37,9 @@ retention:
|
||||||
consistency:
|
consistency:
|
||||||
# List of checks to run to validate your backups.
|
# List of checks to run to validate your backups.
|
||||||
checks:
|
checks:
|
||||||
- repository
|
- name: repository
|
||||||
- archives
|
- name: archives
|
||||||
|
frequency: 2 weeks
|
||||||
|
|
||||||
hooks:
|
hooks:
|
||||||
# Custom preparation scripts to run.
|
# Custom preparation scripts to run.
|
||||||
|
|
|
@ -7,6 +7,8 @@ logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
REPOSITORYLESS_BORG_COMMANDS = {'serve', None}
|
REPOSITORYLESS_BORG_COMMANDS = {'serve', None}
|
||||||
|
BORG_COMMANDS_WITH_SUBCOMMANDS = {'key', 'debug'}
|
||||||
|
BORG_SUBCOMMANDS_WITHOUT_REPOSITORY = (('debug', 'info'), ('debug', 'convert-profile'))
|
||||||
|
|
||||||
|
|
||||||
def run_arbitrary_borg(
|
def run_arbitrary_borg(
|
||||||
|
@ -21,17 +23,25 @@ def run_arbitrary_borg(
|
||||||
|
|
||||||
try:
|
try:
|
||||||
options = options[1:] if options[0] == '--' else options
|
options = options[1:] if options[0] == '--' else options
|
||||||
borg_command = options[0]
|
|
||||||
command_options = tuple(options[1:])
|
# Borg commands like "key" have a sub-command ("export", etc.) that must follow it.
|
||||||
|
command_options_start_index = 2 if options[0] in BORG_COMMANDS_WITH_SUBCOMMANDS else 1
|
||||||
|
borg_command = tuple(options[:command_options_start_index])
|
||||||
|
command_options = tuple(options[command_options_start_index:])
|
||||||
except IndexError:
|
except IndexError:
|
||||||
borg_command = None
|
borg_command = ()
|
||||||
command_options = ()
|
command_options = ()
|
||||||
|
|
||||||
repository_archive = '::'.join((repository, archive)) if repository and archive else repository
|
if borg_command in BORG_SUBCOMMANDS_WITHOUT_REPOSITORY:
|
||||||
|
repository_archive = None
|
||||||
|
else:
|
||||||
|
repository_archive = (
|
||||||
|
'::'.join((repository, archive)) if repository and archive else repository
|
||||||
|
)
|
||||||
|
|
||||||
full_command = (
|
full_command = (
|
||||||
(local_path,)
|
(local_path,)
|
||||||
+ ((borg_command,) if borg_command else ())
|
+ borg_command
|
||||||
+ ((repository_archive,) if borg_command and repository_archive else ())
|
+ ((repository_archive,) if borg_command and repository_archive else ())
|
||||||
+ command_options
|
+ command_options
|
||||||
+ (('--info',) if logger.getEffectiveLevel() == logging.INFO else ())
|
+ (('--info',) if logger.getEffectiveLevel() == logging.INFO else ())
|
||||||
|
|
|
@ -1,46 +1,157 @@
|
||||||
|
import argparse
|
||||||
|
import datetime
|
||||||
|
import json
|
||||||
import logging
|
import logging
|
||||||
|
import os
|
||||||
|
import pathlib
|
||||||
|
|
||||||
from borgmatic.borg import extract
|
from borgmatic.borg import extract, info, state
|
||||||
from borgmatic.execute import DO_NOT_CAPTURE, execute_command
|
from borgmatic.execute import DO_NOT_CAPTURE, execute_command
|
||||||
|
|
||||||
DEFAULT_CHECKS = ('repository', 'archives')
|
DEFAULT_CHECKS = (
|
||||||
|
{'name': 'repository', 'frequency': '1 month'},
|
||||||
|
{'name': 'archives', 'frequency': '1 month'},
|
||||||
|
)
|
||||||
DEFAULT_PREFIX = '{hostname}-'
|
DEFAULT_PREFIX = '{hostname}-'
|
||||||
|
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
def _parse_checks(consistency_config, only_checks=None):
|
def parse_checks(consistency_config, only_checks=None):
|
||||||
'''
|
'''
|
||||||
Given a consistency config with a "checks" list, and an optional list of override checks,
|
Given a consistency config with a "checks" sequence of dicts and an optional list of override
|
||||||
transform them a tuple of named checks to run.
|
checks, return a tuple of named checks to run.
|
||||||
|
|
||||||
For example, given a retention config of:
|
For example, given a retention config of:
|
||||||
|
|
||||||
{'checks': ['repository', 'archives']}
|
{'checks': ({'name': 'repository'}, {'name': 'archives'})}
|
||||||
|
|
||||||
This will be returned as:
|
This will be returned as:
|
||||||
|
|
||||||
('repository', 'archives')
|
('repository', 'archives')
|
||||||
|
|
||||||
If no "checks" option is present in the config, return the DEFAULT_CHECKS. If the checks value
|
If no "checks" option is present in the config, return the DEFAULT_CHECKS. If a checks value
|
||||||
is the string "disabled", return an empty tuple, meaning that no checks should be run.
|
has a name of "disabled", return an empty tuple, meaning that no checks should be run.
|
||||||
|
|
||||||
If the "data" option is present, then make sure the "archives" option is included as well.
|
If the "data" check is present, then make sure the "archives" check is included as well.
|
||||||
'''
|
'''
|
||||||
checks = [
|
checks = only_checks or tuple(
|
||||||
check.lower() for check in (only_checks or consistency_config.get('checks', []) or [])
|
check_config['name']
|
||||||
]
|
for check_config in (consistency_config.get('checks', None) or DEFAULT_CHECKS)
|
||||||
if checks == ['disabled']:
|
)
|
||||||
|
checks = tuple(check.lower() for check in checks)
|
||||||
|
if 'disabled' in checks:
|
||||||
|
if len(checks) > 1:
|
||||||
|
logger.warning(
|
||||||
|
'Multiple checks are configured, but one of them is "disabled"; not running any checks'
|
||||||
|
)
|
||||||
return ()
|
return ()
|
||||||
|
|
||||||
if 'data' in checks and 'archives' not in checks:
|
if 'data' in checks and 'archives' not in checks:
|
||||||
checks.append('archives')
|
return checks + ('archives',)
|
||||||
|
|
||||||
return tuple(check for check in checks if check not in ('disabled', '')) or DEFAULT_CHECKS
|
return checks
|
||||||
|
|
||||||
|
|
||||||
def _make_check_flags(checks, check_last=None, prefix=None):
|
def parse_frequency(frequency):
|
||||||
|
'''
|
||||||
|
Given a frequency string with a number and a unit of time, return a corresponding
|
||||||
|
datetime.timedelta instance or None if the frequency is None or "always".
|
||||||
|
|
||||||
|
For instance, given "3 weeks", return datetime.timedelta(weeks=3)
|
||||||
|
|
||||||
|
Raise ValueError if the given frequency cannot be parsed.
|
||||||
|
'''
|
||||||
|
if not frequency:
|
||||||
|
return None
|
||||||
|
|
||||||
|
frequency = frequency.strip().lower()
|
||||||
|
|
||||||
|
if frequency == 'always':
|
||||||
|
return None
|
||||||
|
|
||||||
|
try:
|
||||||
|
number, time_unit = frequency.split(' ')
|
||||||
|
number = int(number)
|
||||||
|
except ValueError:
|
||||||
|
raise ValueError(f"Could not parse consistency check frequency '{frequency}'")
|
||||||
|
|
||||||
|
if not time_unit.endswith('s'):
|
||||||
|
time_unit += 's'
|
||||||
|
|
||||||
|
if time_unit == 'months':
|
||||||
|
number *= 30
|
||||||
|
time_unit = 'days'
|
||||||
|
elif time_unit == 'years':
|
||||||
|
number *= 365
|
||||||
|
time_unit = 'days'
|
||||||
|
|
||||||
|
try:
|
||||||
|
return datetime.timedelta(**{time_unit: number})
|
||||||
|
except TypeError:
|
||||||
|
raise ValueError(f"Could not parse consistency check frequency '{frequency}'")
|
||||||
|
|
||||||
|
|
||||||
|
def filter_checks_on_frequency(
|
||||||
|
location_config, consistency_config, borg_repository_id, checks, force
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Given a location config, a consistency config with a "checks" sequence of dicts, a Borg
|
||||||
|
repository ID, a sequence of checks, and whether to force checks to run, filter down those
|
||||||
|
checks based on the configured "frequency" for each check as compared to its check time file.
|
||||||
|
|
||||||
|
In other words, a check whose check time file's timestamp is too new (based on the configured
|
||||||
|
frequency) will get cut from the returned sequence of checks. Example:
|
||||||
|
|
||||||
|
consistency_config = {
|
||||||
|
'checks': [
|
||||||
|
{
|
||||||
|
'name': 'archives',
|
||||||
|
'frequency': '2 weeks',
|
||||||
|
},
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
When this function is called with that consistency_config and "archives" in checks, "archives"
|
||||||
|
will get filtered out of the returned result if its check time file is newer than 2 weeks old,
|
||||||
|
indicating that it's not yet time to run that check again.
|
||||||
|
|
||||||
|
Raise ValueError if a frequency cannot be parsed.
|
||||||
|
'''
|
||||||
|
filtered_checks = list(checks)
|
||||||
|
|
||||||
|
if force:
|
||||||
|
return tuple(filtered_checks)
|
||||||
|
|
||||||
|
for check_config in consistency_config.get('checks', DEFAULT_CHECKS):
|
||||||
|
check = check_config['name']
|
||||||
|
if checks and check not in checks:
|
||||||
|
continue
|
||||||
|
|
||||||
|
frequency_delta = parse_frequency(check_config.get('frequency'))
|
||||||
|
if not frequency_delta:
|
||||||
|
continue
|
||||||
|
|
||||||
|
check_time = read_check_time(
|
||||||
|
make_check_time_path(location_config, borg_repository_id, check)
|
||||||
|
)
|
||||||
|
if not check_time:
|
||||||
|
continue
|
||||||
|
|
||||||
|
# If we've not yet reached the time when the frequency dictates we're ready for another
|
||||||
|
# check, skip this check.
|
||||||
|
if datetime.datetime.now() < check_time + frequency_delta:
|
||||||
|
remaining = check_time + frequency_delta - datetime.datetime.now()
|
||||||
|
logger.info(
|
||||||
|
f"Skipping {check} check due to configured frequency; {remaining} until next check"
|
||||||
|
)
|
||||||
|
filtered_checks.remove(check)
|
||||||
|
|
||||||
|
return tuple(filtered_checks)
|
||||||
|
|
||||||
|
|
||||||
|
def make_check_flags(checks, check_last=None, prefix=None):
|
||||||
'''
|
'''
|
||||||
Given a parsed sequence of checks, transform it into tuple of command-line flags.
|
Given a parsed sequence of checks, transform it into tuple of command-line flags.
|
||||||
|
|
||||||
|
@ -66,27 +177,67 @@ def _make_check_flags(checks, check_last=None, prefix=None):
|
||||||
last_flags = ()
|
last_flags = ()
|
||||||
prefix_flags = ()
|
prefix_flags = ()
|
||||||
if check_last:
|
if check_last:
|
||||||
logger.warning(
|
logger.info('Ignoring check_last option, as "archives" is not in consistency checks')
|
||||||
'Ignoring check_last option, as "archives" is not in consistency checks.'
|
|
||||||
)
|
|
||||||
if prefix:
|
if prefix:
|
||||||
logger.warning(
|
logger.info(
|
||||||
'Ignoring consistency prefix option, as "archives" is not in consistency checks.'
|
'Ignoring consistency prefix option, as "archives" is not in consistency checks'
|
||||||
)
|
)
|
||||||
|
|
||||||
common_flags = last_flags + prefix_flags + (('--verify-data',) if 'data' in checks else ())
|
common_flags = last_flags + prefix_flags + (('--verify-data',) if 'data' in checks else ())
|
||||||
|
|
||||||
if set(DEFAULT_CHECKS).issubset(set(checks)):
|
if {'repository', 'archives'}.issubset(set(checks)):
|
||||||
return common_flags
|
return common_flags
|
||||||
|
|
||||||
return (
|
return (
|
||||||
tuple('--{}-only'.format(check) for check in checks if check in DEFAULT_CHECKS)
|
tuple('--{}-only'.format(check) for check in checks if check in ('repository', 'archives'))
|
||||||
+ common_flags
|
+ common_flags
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def make_check_time_path(location_config, borg_repository_id, check_type):
|
||||||
|
'''
|
||||||
|
Given a location configuration dict, a Borg repository ID, and the name of a check type
|
||||||
|
("repository", "archives", etc.), return a path for recording that check's time (the time of
|
||||||
|
that check last occurring).
|
||||||
|
'''
|
||||||
|
return os.path.join(
|
||||||
|
os.path.expanduser(
|
||||||
|
location_config.get(
|
||||||
|
'borgmatic_source_directory', state.DEFAULT_BORGMATIC_SOURCE_DIRECTORY
|
||||||
|
)
|
||||||
|
),
|
||||||
|
'checks',
|
||||||
|
borg_repository_id,
|
||||||
|
check_type,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def write_check_time(path): # pragma: no cover
|
||||||
|
'''
|
||||||
|
Record a check time of now as the modification time of the given path.
|
||||||
|
'''
|
||||||
|
logger.debug(f'Writing check time at {path}')
|
||||||
|
|
||||||
|
os.makedirs(os.path.dirname(path), mode=0o700, exist_ok=True)
|
||||||
|
pathlib.Path(path, mode=0o600).touch()
|
||||||
|
|
||||||
|
|
||||||
|
def read_check_time(path):
|
||||||
|
'''
|
||||||
|
Return the check time based on the modification time of the given path. Return None if the path
|
||||||
|
doesn't exist.
|
||||||
|
'''
|
||||||
|
logger.debug(f'Reading check time from {path}')
|
||||||
|
|
||||||
|
try:
|
||||||
|
return datetime.datetime.fromtimestamp(os.stat(path).st_mtime)
|
||||||
|
except FileNotFoundError:
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
def check_archives(
|
def check_archives(
|
||||||
repository,
|
repository,
|
||||||
|
location_config,
|
||||||
storage_config,
|
storage_config,
|
||||||
consistency_config,
|
consistency_config,
|
||||||
local_path='borg',
|
local_path='borg',
|
||||||
|
@ -94,6 +245,7 @@ def check_archives(
|
||||||
progress=None,
|
progress=None,
|
||||||
repair=None,
|
repair=None,
|
||||||
only_checks=None,
|
only_checks=None,
|
||||||
|
force=None,
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Given a local or remote repository path, a storage config dict, a consistency config dict,
|
Given a local or remote repository path, a storage config dict, a consistency config dict,
|
||||||
|
@ -102,13 +254,34 @@ def check_archives(
|
||||||
Borg archives for consistency.
|
Borg archives for consistency.
|
||||||
|
|
||||||
If there are no consistency checks to run, skip running them.
|
If there are no consistency checks to run, skip running them.
|
||||||
|
|
||||||
|
Raises ValueError if the Borg repository ID cannot be determined.
|
||||||
'''
|
'''
|
||||||
checks = _parse_checks(consistency_config, only_checks)
|
try:
|
||||||
|
borg_repository_id = json.loads(
|
||||||
|
info.display_archives_info(
|
||||||
|
repository,
|
||||||
|
storage_config,
|
||||||
|
argparse.Namespace(json=True, archive=None),
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
|
)['repository']['id']
|
||||||
|
except (json.JSONDecodeError, KeyError):
|
||||||
|
raise ValueError(f'Cannot determine Borg repository ID for {repository}')
|
||||||
|
|
||||||
|
checks = filter_checks_on_frequency(
|
||||||
|
location_config,
|
||||||
|
consistency_config,
|
||||||
|
borg_repository_id,
|
||||||
|
parse_checks(consistency_config, only_checks),
|
||||||
|
force,
|
||||||
|
)
|
||||||
check_last = consistency_config.get('check_last', None)
|
check_last = consistency_config.get('check_last', None)
|
||||||
lock_wait = None
|
lock_wait = None
|
||||||
extra_borg_options = storage_config.get('extra_borg_options', {}).get('check', '')
|
extra_borg_options = storage_config.get('extra_borg_options', {}).get('check', '')
|
||||||
|
|
||||||
if set(checks).intersection(set(DEFAULT_CHECKS + ('data',))):
|
if set(checks).intersection({'repository', 'archives', 'data'}):
|
||||||
lock_wait = storage_config.get('lock_wait', None)
|
lock_wait = storage_config.get('lock_wait', None)
|
||||||
|
|
||||||
verbosity_flags = ()
|
verbosity_flags = ()
|
||||||
|
@ -122,7 +295,7 @@ def check_archives(
|
||||||
full_command = (
|
full_command = (
|
||||||
(local_path, 'check')
|
(local_path, 'check')
|
||||||
+ (('--repair',) if repair else ())
|
+ (('--repair',) if repair else ())
|
||||||
+ _make_check_flags(checks, check_last, prefix)
|
+ make_check_flags(checks, check_last, prefix)
|
||||||
+ (('--remote-path', remote_path) if remote_path else ())
|
+ (('--remote-path', remote_path) if remote_path else ())
|
||||||
+ (('--lock-wait', str(lock_wait)) if lock_wait else ())
|
+ (('--lock-wait', str(lock_wait)) if lock_wait else ())
|
||||||
+ verbosity_flags
|
+ verbosity_flags
|
||||||
|
@ -131,12 +304,16 @@ def check_archives(
|
||||||
+ (repository,)
|
+ (repository,)
|
||||||
)
|
)
|
||||||
|
|
||||||
# The Borg repair option trigger an interactive prompt, which won't work when output is
|
# The Borg repair option triggers an interactive prompt, which won't work when output is
|
||||||
# captured. And progress messes with the terminal directly.
|
# captured. And progress messes with the terminal directly.
|
||||||
if repair or progress:
|
if repair or progress:
|
||||||
execute_command(full_command, output_file=DO_NOT_CAPTURE)
|
execute_command(full_command, output_file=DO_NOT_CAPTURE)
|
||||||
else:
|
else:
|
||||||
execute_command(full_command)
|
execute_command(full_command)
|
||||||
|
|
||||||
|
for check in checks:
|
||||||
|
write_check_time(make_check_time_path(location_config, borg_repository_id, check))
|
||||||
|
|
||||||
if 'extract' in checks:
|
if 'extract' in checks:
|
||||||
extract.extract_last_archive_dry_run(repository, lock_wait, local_path, remote_path)
|
extract.extract_last_archive_dry_run(repository, lock_wait, local_path, remote_path)
|
||||||
|
write_check_time(make_check_time_path(location_config, borg_repository_id, 'extract'))
|
||||||
|
|
|
@ -5,7 +5,7 @@ import os
|
||||||
import pathlib
|
import pathlib
|
||||||
import tempfile
|
import tempfile
|
||||||
|
|
||||||
from borgmatic.borg import feature
|
from borgmatic.borg import feature, state
|
||||||
from borgmatic.execute import DO_NOT_CAPTURE, execute_command, execute_command_with_processes
|
from borgmatic.execute import DO_NOT_CAPTURE, execute_command, execute_command_with_processes
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
@ -175,7 +175,7 @@ def make_exclude_flags(location_config, exclude_filename=None):
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
DEFAULT_BORGMATIC_SOURCE_DIRECTORY = '~/.borgmatic'
|
DEFAULT_ARCHIVE_NAME_FORMAT = '{hostname}-{now:%Y-%m-%dT%H:%M:%S.%f}'
|
||||||
|
|
||||||
|
|
||||||
def borgmatic_source_directories(borgmatic_source_directory):
|
def borgmatic_source_directories(borgmatic_source_directory):
|
||||||
|
@ -183,7 +183,7 @@ def borgmatic_source_directories(borgmatic_source_directory):
|
||||||
Return a list of borgmatic-specific source directories used for state like database backups.
|
Return a list of borgmatic-specific source directories used for state like database backups.
|
||||||
'''
|
'''
|
||||||
if not borgmatic_source_directory:
|
if not borgmatic_source_directory:
|
||||||
borgmatic_source_directory = DEFAULT_BORGMATIC_SOURCE_DIRECTORY
|
borgmatic_source_directory = state.DEFAULT_BORGMATIC_SOURCE_DIRECTORY
|
||||||
|
|
||||||
return (
|
return (
|
||||||
[borgmatic_source_directory]
|
[borgmatic_source_directory]
|
||||||
|
@ -192,9 +192,6 @@ def borgmatic_source_directories(borgmatic_source_directory):
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
DEFAULT_ARCHIVE_NAME_FORMAT = '{hostname}-{now:%Y-%m-%dT%H:%M:%S.%f}'
|
|
||||||
|
|
||||||
|
|
||||||
def create_archive(
|
def create_archive(
|
||||||
dry_run,
|
dry_run,
|
||||||
repository,
|
repository,
|
||||||
|
|
|
@ -1,6 +1,8 @@
|
||||||
|
import argparse
|
||||||
import logging
|
import logging
|
||||||
import subprocess
|
import subprocess
|
||||||
|
|
||||||
|
from borgmatic.borg import info
|
||||||
from borgmatic.execute import DO_NOT_CAPTURE, execute_command
|
from borgmatic.execute import DO_NOT_CAPTURE, execute_command
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
@ -23,17 +25,14 @@ def initialize_repository(
|
||||||
whether the repository should be append-only, and the storage quota to use, initialize the
|
whether the repository should be append-only, and the storage quota to use, initialize the
|
||||||
repository. If the repository already exists, then log and skip initialization.
|
repository. If the repository already exists, then log and skip initialization.
|
||||||
'''
|
'''
|
||||||
info_command = (
|
|
||||||
(local_path, 'info')
|
|
||||||
+ (('--info',) if logger.getEffectiveLevel() == logging.INFO else ())
|
|
||||||
+ (('--debug',) if logger.isEnabledFor(logging.DEBUG) else ())
|
|
||||||
+ (('--remote-path', remote_path) if remote_path else ())
|
|
||||||
+ (repository,)
|
|
||||||
)
|
|
||||||
logger.debug(' '.join(info_command))
|
|
||||||
|
|
||||||
try:
|
try:
|
||||||
execute_command(info_command, output_log_level=None)
|
info.display_archives_info(
|
||||||
|
repository,
|
||||||
|
storage_config,
|
||||||
|
argparse.Namespace(json=True, archive=None),
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
logger.info('Repository already exists. Skipping initialization.')
|
logger.info('Repository already exists. Skipping initialization.')
|
||||||
return
|
return
|
||||||
except subprocess.CalledProcessError as error:
|
except subprocess.CalledProcessError as error:
|
||||||
|
|
|
@ -1,4 +1,6 @@
|
||||||
|
import copy
|
||||||
import logging
|
import logging
|
||||||
|
import re
|
||||||
|
|
||||||
from borgmatic.borg.flags import make_flags, make_flags_from_arguments
|
from borgmatic.borg.flags import make_flags, make_flags_from_arguments
|
||||||
from borgmatic.execute import execute_command
|
from borgmatic.execute import execute_command
|
||||||
|
@ -6,17 +8,11 @@ from borgmatic.execute import execute_command
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
# A hack to convince Borg to exclude archives ending in ".checkpoint". This assumes that a
|
|
||||||
# non-checkpoint archive name ends in a digit (e.g. from a timestamp).
|
|
||||||
BORG_EXCLUDE_CHECKPOINTS_GLOB = '*[0123456789]'
|
|
||||||
|
|
||||||
|
|
||||||
def resolve_archive_name(repository, archive, storage_config, local_path='borg', remote_path=None):
|
def resolve_archive_name(repository, archive, storage_config, local_path='borg', remote_path=None):
|
||||||
'''
|
'''
|
||||||
Given a local or remote repository path, an archive name, a storage config dict, a local Borg
|
Given a local or remote repository path, an archive name, a storage config dict, a local Borg
|
||||||
path, and a remote Borg path, simply return the archive name. But if the archive name is
|
path, and a remote Borg path, simply return the archive name. But if the archive name is
|
||||||
"latest", then instead introspect the repository for the latest successful (non-checkpoint)
|
"latest", then instead introspect the repository for the latest archive and return its name.
|
||||||
archive, and return its name.
|
|
||||||
|
|
||||||
Raise ValueError if "latest" is given but there are no archives in the repository.
|
Raise ValueError if "latest" is given but there are no archives in the repository.
|
||||||
'''
|
'''
|
||||||
|
@ -31,7 +27,6 @@ def resolve_archive_name(repository, archive, storage_config, local_path='borg',
|
||||||
+ (('--debug', '--show-rc') if logger.isEnabledFor(logging.DEBUG) else ())
|
+ (('--debug', '--show-rc') if logger.isEnabledFor(logging.DEBUG) else ())
|
||||||
+ make_flags('remote-path', remote_path)
|
+ make_flags('remote-path', remote_path)
|
||||||
+ make_flags('lock-wait', lock_wait)
|
+ make_flags('lock-wait', lock_wait)
|
||||||
+ make_flags('glob-archives', BORG_EXCLUDE_CHECKPOINTS_GLOB)
|
|
||||||
+ make_flags('last', 1)
|
+ make_flags('last', 1)
|
||||||
+ ('--short', repository)
|
+ ('--short', repository)
|
||||||
)
|
)
|
||||||
|
@ -47,17 +42,20 @@ def resolve_archive_name(repository, archive, storage_config, local_path='borg',
|
||||||
return latest_archive
|
return latest_archive
|
||||||
|
|
||||||
|
|
||||||
def list_archives(repository, storage_config, list_arguments, local_path='borg', remote_path=None):
|
MAKE_FLAGS_EXCLUDES = ('repository', 'archive', 'successful', 'paths', 'find_paths')
|
||||||
|
|
||||||
|
|
||||||
|
def make_list_command(
|
||||||
|
repository, storage_config, list_arguments, local_path='borg', remote_path=None
|
||||||
|
):
|
||||||
'''
|
'''
|
||||||
Given a local or remote repository path, a storage config dict, and the arguments to the list
|
Given a local or remote repository path, a storage config dict, the arguments to the list
|
||||||
action, display the output of listing Borg archives in the repository or return JSON output. Or,
|
action, and local and remote Borg paths, return a command as a tuple to list archives or paths
|
||||||
if an archive name is given, listing the files in that archive.
|
within an archive.
|
||||||
'''
|
'''
|
||||||
lock_wait = storage_config.get('lock_wait', None)
|
lock_wait = storage_config.get('lock_wait', None)
|
||||||
if list_arguments.successful:
|
|
||||||
list_arguments.glob_archives = BORG_EXCLUDE_CHECKPOINTS_GLOB
|
|
||||||
|
|
||||||
full_command = (
|
return (
|
||||||
(local_path, 'list')
|
(local_path, 'list')
|
||||||
+ (
|
+ (
|
||||||
('--info',)
|
('--info',)
|
||||||
|
@ -71,19 +69,92 @@ def list_archives(repository, storage_config, list_arguments, local_path='borg',
|
||||||
)
|
)
|
||||||
+ make_flags('remote-path', remote_path)
|
+ make_flags('remote-path', remote_path)
|
||||||
+ make_flags('lock-wait', lock_wait)
|
+ make_flags('lock-wait', lock_wait)
|
||||||
+ make_flags_from_arguments(
|
+ make_flags_from_arguments(list_arguments, excludes=MAKE_FLAGS_EXCLUDES,)
|
||||||
list_arguments, excludes=('repository', 'archive', 'paths', 'successful')
|
|
||||||
)
|
|
||||||
+ (
|
+ (
|
||||||
'::'.join((repository, list_arguments.archive))
|
('::'.join((repository, list_arguments.archive)),)
|
||||||
if list_arguments.archive
|
if list_arguments.archive
|
||||||
else repository,
|
else (repository,)
|
||||||
)
|
)
|
||||||
+ (tuple(list_arguments.paths) if list_arguments.paths else ())
|
+ (tuple(list_arguments.paths) if list_arguments.paths else ())
|
||||||
)
|
)
|
||||||
|
|
||||||
return execute_command(
|
|
||||||
full_command,
|
def make_find_paths(find_paths):
|
||||||
output_log_level=None if list_arguments.json else logging.WARNING,
|
'''
|
||||||
borg_local_path=local_path,
|
Given a sequence of path fragments or patterns as passed to `--find`, transform all path
|
||||||
|
fragments into glob patterns. Pass through existing patterns untouched.
|
||||||
|
|
||||||
|
For example, given find_paths of:
|
||||||
|
|
||||||
|
['foo.txt', 'pp:root/somedir']
|
||||||
|
|
||||||
|
... transform that into:
|
||||||
|
|
||||||
|
['sh:**/*foo.txt*/**', 'pp:root/somedir']
|
||||||
|
'''
|
||||||
|
if not find_paths:
|
||||||
|
return ()
|
||||||
|
|
||||||
|
return tuple(
|
||||||
|
find_path
|
||||||
|
if re.compile(r'([-!+RrPp] )|(\w\w:)').match(find_path)
|
||||||
|
else f'sh:**/*{find_path}*/**'
|
||||||
|
for find_path in find_paths
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def list_archives(repository, storage_config, list_arguments, local_path='borg', remote_path=None):
|
||||||
|
'''
|
||||||
|
Given a local or remote repository path, a storage config dict, the arguments to the list
|
||||||
|
action, and local and remote Borg paths, display the output of listing Borg archives in the
|
||||||
|
repository or return JSON output. Or, if an archive name is given, list the files in that
|
||||||
|
archive. Or, if list_arguments.find_paths are given, list the files by searching across multiple
|
||||||
|
archives.
|
||||||
|
'''
|
||||||
|
# If there are any paths to find (and there's not a single archive already selected), start by
|
||||||
|
# getting a list of archives to search.
|
||||||
|
if list_arguments.find_paths and not list_arguments.archive:
|
||||||
|
repository_arguments = copy.copy(list_arguments)
|
||||||
|
repository_arguments.archive = None
|
||||||
|
repository_arguments.json = False
|
||||||
|
repository_arguments.format = None
|
||||||
|
|
||||||
|
# Ask Borg to list archives. Capture its output for use below.
|
||||||
|
archive_lines = tuple(
|
||||||
|
execute_command(
|
||||||
|
make_list_command(
|
||||||
|
repository, storage_config, repository_arguments, local_path, remote_path
|
||||||
|
),
|
||||||
|
output_log_level=None,
|
||||||
|
borg_local_path=local_path,
|
||||||
|
)
|
||||||
|
.strip('\n')
|
||||||
|
.split('\n')
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
archive_lines = (list_arguments.archive,)
|
||||||
|
|
||||||
|
# For each archive listed by Borg, run list on the contents of that archive.
|
||||||
|
for archive_line in archive_lines:
|
||||||
|
try:
|
||||||
|
archive = archive_line.split()[0]
|
||||||
|
except (AttributeError, IndexError):
|
||||||
|
archive = None
|
||||||
|
|
||||||
|
if archive:
|
||||||
|
logger.warning(archive_line)
|
||||||
|
|
||||||
|
archive_arguments = copy.copy(list_arguments)
|
||||||
|
archive_arguments.archive = archive
|
||||||
|
main_command = make_list_command(
|
||||||
|
repository, storage_config, archive_arguments, local_path, remote_path
|
||||||
|
) + make_find_paths(list_arguments.find_paths)
|
||||||
|
|
||||||
|
output = execute_command(
|
||||||
|
main_command,
|
||||||
|
output_log_level=None if list_arguments.json else logging.WARNING,
|
||||||
|
borg_local_path=local_path,
|
||||||
|
)
|
||||||
|
|
||||||
|
if list_arguments.json:
|
||||||
|
return output
|
||||||
|
|
|
@ -0,0 +1 @@
|
||||||
|
DEFAULT_BORGMATIC_SOURCE_DIRECTORY = '~/.borgmatic'
|
|
@ -109,10 +109,9 @@ class Extend_action(Action):
|
||||||
setattr(namespace, self.dest, list(values))
|
setattr(namespace, self.dest, list(values))
|
||||||
|
|
||||||
|
|
||||||
def parse_arguments(*unparsed_arguments):
|
def make_parsers():
|
||||||
'''
|
'''
|
||||||
Given command-line arguments with which this script was invoked, parse the arguments and return
|
Build a top-level parser and its subparsers and return them as a tuple.
|
||||||
them as a dict mapping from subparser name (or "global") to an argparse.Namespace instance.
|
|
||||||
'''
|
'''
|
||||||
config_paths = collect.get_default_config_paths(expand_home=True)
|
config_paths = collect.get_default_config_paths(expand_home=True)
|
||||||
unexpanded_config_paths = collect.get_default_config_paths(expand_home=False)
|
unexpanded_config_paths = collect.get_default_config_paths(expand_home=False)
|
||||||
|
@ -189,6 +188,12 @@ def parse_arguments(*unparsed_arguments):
|
||||||
action='extend',
|
action='extend',
|
||||||
help='One or more configuration file options to override with specified values',
|
help='One or more configuration file options to override with specified values',
|
||||||
)
|
)
|
||||||
|
global_group.add_argument(
|
||||||
|
'--bash-completion',
|
||||||
|
default=False,
|
||||||
|
action='store_true',
|
||||||
|
help='Show bash completion script and exit',
|
||||||
|
)
|
||||||
global_group.add_argument(
|
global_group.add_argument(
|
||||||
'--version',
|
'--version',
|
||||||
dest='version',
|
dest='version',
|
||||||
|
@ -341,7 +346,7 @@ def parse_arguments(*unparsed_arguments):
|
||||||
dest='repair',
|
dest='repair',
|
||||||
default=False,
|
default=False,
|
||||||
action='store_true',
|
action='store_true',
|
||||||
help='Attempt to repair any inconsistencies found (experimental and only for interactive use)',
|
help='Attempt to repair any inconsistencies found (for interactive use)',
|
||||||
)
|
)
|
||||||
check_group.add_argument(
|
check_group.add_argument(
|
||||||
'--only',
|
'--only',
|
||||||
|
@ -349,7 +354,13 @@ def parse_arguments(*unparsed_arguments):
|
||||||
choices=('repository', 'archives', 'data', 'extract'),
|
choices=('repository', 'archives', 'data', 'extract'),
|
||||||
dest='only',
|
dest='only',
|
||||||
action='append',
|
action='append',
|
||||||
help='Run a particular consistency check (repository, archives, data, or extract) instead of configured checks; can specify flag multiple times',
|
help='Run a particular consistency check (repository, archives, data, or extract) instead of configured checks (subject to configured frequency, can specify flag multiple times)',
|
||||||
|
)
|
||||||
|
check_group.add_argument(
|
||||||
|
'--force',
|
||||||
|
default=False,
|
||||||
|
action='store_true',
|
||||||
|
help='Ignore configured check frequencies and run checks unconditionally',
|
||||||
)
|
)
|
||||||
check_group.add_argument('-h', '--help', action='help', help='Show this help message and exit')
|
check_group.add_argument('-h', '--help', action='help', help='Show this help message and exit')
|
||||||
|
|
||||||
|
@ -543,7 +554,14 @@ def parse_arguments(*unparsed_arguments):
|
||||||
metavar='PATH',
|
metavar='PATH',
|
||||||
nargs='+',
|
nargs='+',
|
||||||
dest='paths',
|
dest='paths',
|
||||||
help='Paths to list from archive, defaults to the entire archive',
|
help='Paths or patterns to list from a single selected archive (via "--archive"), defaults to listing the entire archive',
|
||||||
|
)
|
||||||
|
list_group.add_argument(
|
||||||
|
'--find',
|
||||||
|
metavar='PATH',
|
||||||
|
nargs='+',
|
||||||
|
dest='find_paths',
|
||||||
|
help='Partial paths or patterns to search for and list across multiple archives',
|
||||||
)
|
)
|
||||||
list_group.add_argument(
|
list_group.add_argument(
|
||||||
'--short', default=False, action='store_true', help='Output only archive or path names'
|
'--short', default=False, action='store_true', help='Output only archive or path names'
|
||||||
|
@ -560,9 +578,9 @@ def parse_arguments(*unparsed_arguments):
|
||||||
)
|
)
|
||||||
list_group.add_argument(
|
list_group.add_argument(
|
||||||
'--successful',
|
'--successful',
|
||||||
default=False,
|
default=True,
|
||||||
action='store_true',
|
action='store_true',
|
||||||
help='Only list archive names of successful (non-checkpoint) backups',
|
help='Deprecated in favor of listing successful (non-checkpoint) backups by default in newer versions of Borg',
|
||||||
)
|
)
|
||||||
list_group.add_argument(
|
list_group.add_argument(
|
||||||
'--sort-by', metavar='KEYS', help='Comma-separated list of sorting keys'
|
'--sort-by', metavar='KEYS', help='Comma-separated list of sorting keys'
|
||||||
|
@ -647,6 +665,16 @@ def parse_arguments(*unparsed_arguments):
|
||||||
)
|
)
|
||||||
borg_group.add_argument('-h', '--help', action='help', help='Show this help message and exit')
|
borg_group.add_argument('-h', '--help', action='help', help='Show this help message and exit')
|
||||||
|
|
||||||
|
return top_level_parser, subparsers
|
||||||
|
|
||||||
|
|
||||||
|
def parse_arguments(*unparsed_arguments):
|
||||||
|
'''
|
||||||
|
Given command-line arguments with which this script was invoked, parse the arguments and return
|
||||||
|
them as a dict mapping from subparser name (or "global") to an argparse.Namespace instance.
|
||||||
|
'''
|
||||||
|
top_level_parser, subparsers = make_parsers()
|
||||||
|
|
||||||
arguments, remaining_arguments = parse_subparser_arguments(
|
arguments, remaining_arguments = parse_subparser_arguments(
|
||||||
unparsed_arguments, subparsers.choices
|
unparsed_arguments, subparsers.choices
|
||||||
)
|
)
|
||||||
|
@ -660,9 +688,6 @@ def parse_arguments(*unparsed_arguments):
|
||||||
if 'init' in arguments and arguments['global'].dry_run:
|
if 'init' in arguments and arguments['global'].dry_run:
|
||||||
raise ValueError('The init action cannot be used with the --dry-run option')
|
raise ValueError('The init action cannot be used with the --dry-run option')
|
||||||
|
|
||||||
if 'list' in arguments and arguments['list'].glob_archives and arguments['list'].successful:
|
|
||||||
raise ValueError('The --glob-archives and --successful options cannot be used together')
|
|
||||||
|
|
||||||
if (
|
if (
|
||||||
'list' in arguments
|
'list' in arguments
|
||||||
and 'info' in arguments
|
and 'info' in arguments
|
||||||
|
|
|
@ -11,6 +11,7 @@ from subprocess import CalledProcessError
|
||||||
import colorama
|
import colorama
|
||||||
import pkg_resources
|
import pkg_resources
|
||||||
|
|
||||||
|
import borgmatic.commands.completion
|
||||||
from borgmatic.borg import borg as borg_borg
|
from borgmatic.borg import borg as borg_borg
|
||||||
from borgmatic.borg import check as borg_check
|
from borgmatic.borg import check as borg_check
|
||||||
from borgmatic.borg import compact as borg_compact
|
from borgmatic.borg import compact as borg_compact
|
||||||
|
@ -65,14 +66,10 @@ def run_configuration(config_filename, config, arguments):
|
||||||
using_primary_action = {'prune', 'compact', 'create', 'check'}.intersection(arguments)
|
using_primary_action = {'prune', 'compact', 'create', 'check'}.intersection(arguments)
|
||||||
monitoring_log_level = verbosity_to_log_level(global_arguments.monitoring_verbosity)
|
monitoring_log_level = verbosity_to_log_level(global_arguments.monitoring_verbosity)
|
||||||
|
|
||||||
hook_context = {
|
|
||||||
'repositories': ','.join(location['repositories']),
|
|
||||||
}
|
|
||||||
|
|
||||||
try:
|
try:
|
||||||
local_borg_version = borg_version.local_borg_version(local_path)
|
local_borg_version = borg_version.local_borg_version(local_path)
|
||||||
except (OSError, CalledProcessError, ValueError) as error:
|
except (OSError, CalledProcessError, ValueError) as error:
|
||||||
yield from make_error_log_records(
|
yield from log_error_records(
|
||||||
'{}: Error getting local Borg version'.format(config_filename), error
|
'{}: Error getting local Borg version'.format(config_filename), error
|
||||||
)
|
)
|
||||||
return
|
return
|
||||||
|
@ -87,50 +84,6 @@ def run_configuration(config_filename, config, arguments):
|
||||||
monitoring_log_level,
|
monitoring_log_level,
|
||||||
global_arguments.dry_run,
|
global_arguments.dry_run,
|
||||||
)
|
)
|
||||||
if 'prune' in arguments:
|
|
||||||
command.execute_hook(
|
|
||||||
hooks.get('before_prune'),
|
|
||||||
hooks.get('umask'),
|
|
||||||
config_filename,
|
|
||||||
'pre-prune',
|
|
||||||
global_arguments.dry_run,
|
|
||||||
**hook_context,
|
|
||||||
)
|
|
||||||
if 'compact' in arguments:
|
|
||||||
command.execute_hook(
|
|
||||||
hooks.get('before_compact'),
|
|
||||||
hooks.get('umask'),
|
|
||||||
config_filename,
|
|
||||||
'pre-compact',
|
|
||||||
global_arguments.dry_run,
|
|
||||||
)
|
|
||||||
if 'create' in arguments:
|
|
||||||
command.execute_hook(
|
|
||||||
hooks.get('before_backup'),
|
|
||||||
hooks.get('umask'),
|
|
||||||
config_filename,
|
|
||||||
'pre-backup',
|
|
||||||
global_arguments.dry_run,
|
|
||||||
**hook_context,
|
|
||||||
)
|
|
||||||
if 'check' in arguments:
|
|
||||||
command.execute_hook(
|
|
||||||
hooks.get('before_check'),
|
|
||||||
hooks.get('umask'),
|
|
||||||
config_filename,
|
|
||||||
'pre-check',
|
|
||||||
global_arguments.dry_run,
|
|
||||||
**hook_context,
|
|
||||||
)
|
|
||||||
if 'extract' in arguments:
|
|
||||||
command.execute_hook(
|
|
||||||
hooks.get('before_extract'),
|
|
||||||
hooks.get('umask'),
|
|
||||||
config_filename,
|
|
||||||
'pre-extract',
|
|
||||||
global_arguments.dry_run,
|
|
||||||
**hook_context,
|
|
||||||
)
|
|
||||||
if using_primary_action:
|
if using_primary_action:
|
||||||
dispatch.call_hooks(
|
dispatch.call_hooks(
|
||||||
'ping_monitor',
|
'ping_monitor',
|
||||||
|
@ -146,9 +99,7 @@ def run_configuration(config_filename, config, arguments):
|
||||||
return
|
return
|
||||||
|
|
||||||
encountered_error = error
|
encountered_error = error
|
||||||
yield from make_error_log_records(
|
yield from log_error_records('{}: Error pinging monitor'.format(config_filename), error)
|
||||||
'{}: Error running pre hook'.format(config_filename), error
|
|
||||||
)
|
|
||||||
|
|
||||||
if not encountered_error:
|
if not encountered_error:
|
||||||
repo_queue = Queue()
|
repo_queue = Queue()
|
||||||
|
@ -164,6 +115,7 @@ def run_configuration(config_filename, config, arguments):
|
||||||
try:
|
try:
|
||||||
yield from run_actions(
|
yield from run_actions(
|
||||||
arguments=arguments,
|
arguments=arguments,
|
||||||
|
config_filename=config_filename,
|
||||||
location=location,
|
location=location,
|
||||||
storage=storage,
|
storage=storage,
|
||||||
retention=retention,
|
retention=retention,
|
||||||
|
@ -175,72 +127,32 @@ def run_configuration(config_filename, config, arguments):
|
||||||
repository_path=repository_path,
|
repository_path=repository_path,
|
||||||
)
|
)
|
||||||
except (OSError, CalledProcessError, ValueError) as error:
|
except (OSError, CalledProcessError, ValueError) as error:
|
||||||
yield from make_error_log_records(
|
|
||||||
'{}: Error running actions for repository'.format(repository_path), error
|
|
||||||
)
|
|
||||||
if retry_num < retries:
|
if retry_num < retries:
|
||||||
repo_queue.put((repository_path, retry_num + 1),)
|
repo_queue.put((repository_path, retry_num + 1),)
|
||||||
|
tuple( # Consume the generator so as to trigger logging.
|
||||||
|
log_error_records(
|
||||||
|
'{}: Error running actions for repository'.format(repository_path),
|
||||||
|
error,
|
||||||
|
levelno=logging.WARNING,
|
||||||
|
log_command_error_output=True,
|
||||||
|
)
|
||||||
|
)
|
||||||
logger.warning(
|
logger.warning(
|
||||||
f'{config_filename}: Retrying... attempt {retry_num + 1}/{retries}'
|
f'{config_filename}: Retrying... attempt {retry_num + 1}/{retries}'
|
||||||
)
|
)
|
||||||
continue
|
continue
|
||||||
|
|
||||||
|
if command.considered_soft_failure(config_filename, error):
|
||||||
|
return
|
||||||
|
|
||||||
|
yield from log_error_records(
|
||||||
|
'{}: Error running actions for repository'.format(repository_path), error
|
||||||
|
)
|
||||||
encountered_error = error
|
encountered_error = error
|
||||||
error_repository = repository_path
|
error_repository = repository_path
|
||||||
|
|
||||||
if not encountered_error:
|
if not encountered_error:
|
||||||
try:
|
try:
|
||||||
if 'prune' in arguments:
|
|
||||||
command.execute_hook(
|
|
||||||
hooks.get('after_prune'),
|
|
||||||
hooks.get('umask'),
|
|
||||||
config_filename,
|
|
||||||
'post-prune',
|
|
||||||
global_arguments.dry_run,
|
|
||||||
**hook_context,
|
|
||||||
)
|
|
||||||
if 'compact' in arguments:
|
|
||||||
command.execute_hook(
|
|
||||||
hooks.get('after_compact'),
|
|
||||||
hooks.get('umask'),
|
|
||||||
config_filename,
|
|
||||||
'post-compact',
|
|
||||||
global_arguments.dry_run,
|
|
||||||
)
|
|
||||||
if 'create' in arguments:
|
|
||||||
dispatch.call_hooks(
|
|
||||||
'remove_database_dumps',
|
|
||||||
hooks,
|
|
||||||
config_filename,
|
|
||||||
dump.DATABASE_HOOK_NAMES,
|
|
||||||
location,
|
|
||||||
global_arguments.dry_run,
|
|
||||||
)
|
|
||||||
command.execute_hook(
|
|
||||||
hooks.get('after_backup'),
|
|
||||||
hooks.get('umask'),
|
|
||||||
config_filename,
|
|
||||||
'post-backup',
|
|
||||||
global_arguments.dry_run,
|
|
||||||
**hook_context,
|
|
||||||
)
|
|
||||||
if 'check' in arguments:
|
|
||||||
command.execute_hook(
|
|
||||||
hooks.get('after_check'),
|
|
||||||
hooks.get('umask'),
|
|
||||||
config_filename,
|
|
||||||
'post-check',
|
|
||||||
global_arguments.dry_run,
|
|
||||||
**hook_context,
|
|
||||||
)
|
|
||||||
if 'extract' in arguments:
|
|
||||||
command.execute_hook(
|
|
||||||
hooks.get('after_extract'),
|
|
||||||
hooks.get('umask'),
|
|
||||||
config_filename,
|
|
||||||
'post-extract',
|
|
||||||
global_arguments.dry_run,
|
|
||||||
**hook_context,
|
|
||||||
)
|
|
||||||
if using_primary_action:
|
if using_primary_action:
|
||||||
dispatch.call_hooks(
|
dispatch.call_hooks(
|
||||||
'ping_monitor',
|
'ping_monitor',
|
||||||
|
@ -264,9 +176,7 @@ def run_configuration(config_filename, config, arguments):
|
||||||
return
|
return
|
||||||
|
|
||||||
encountered_error = error
|
encountered_error = error
|
||||||
yield from make_error_log_records(
|
yield from log_error_records('{}: Error pinging monitor'.format(config_filename), error)
|
||||||
'{}: Error running post hook'.format(config_filename), error
|
|
||||||
)
|
|
||||||
|
|
||||||
if encountered_error and using_primary_action:
|
if encountered_error and using_primary_action:
|
||||||
try:
|
try:
|
||||||
|
@ -301,7 +211,7 @@ def run_configuration(config_filename, config, arguments):
|
||||||
if command.considered_soft_failure(config_filename, error):
|
if command.considered_soft_failure(config_filename, error):
|
||||||
return
|
return
|
||||||
|
|
||||||
yield from make_error_log_records(
|
yield from log_error_records(
|
||||||
'{}: Error running on-error hook'.format(config_filename), error
|
'{}: Error running on-error hook'.format(config_filename), error
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@ -309,6 +219,7 @@ def run_configuration(config_filename, config, arguments):
|
||||||
def run_actions(
|
def run_actions(
|
||||||
*,
|
*,
|
||||||
arguments,
|
arguments,
|
||||||
|
config_filename,
|
||||||
location,
|
location,
|
||||||
storage,
|
storage,
|
||||||
retention,
|
retention,
|
||||||
|
@ -318,20 +229,28 @@ def run_actions(
|
||||||
remote_path,
|
remote_path,
|
||||||
local_borg_version,
|
local_borg_version,
|
||||||
repository_path,
|
repository_path,
|
||||||
): # pragma: no cover
|
):
|
||||||
'''
|
'''
|
||||||
Given parsed command-line arguments as an argparse.ArgumentParser instance, several different
|
Given parsed command-line arguments as an argparse.ArgumentParser instance, the configuration
|
||||||
configuration dicts, local and remote paths to Borg, a local Borg version string, and a
|
filename, several different configuration dicts, local and remote paths to Borg, a local Borg
|
||||||
repository name, run all actions from the command-line arguments on the given repository.
|
version string, and a repository name, run all actions from the command-line arguments on the
|
||||||
|
given repository.
|
||||||
|
|
||||||
Yield JSON output strings from executing any actions that produce JSON.
|
Yield JSON output strings from executing any actions that produce JSON.
|
||||||
|
|
||||||
Raise OSError or subprocess.CalledProcessError if an error occurs running a command for an
|
Raise OSError or subprocess.CalledProcessError if an error occurs running a command for an
|
||||||
action. Raise ValueError if the arguments or configuration passed to action are invalid.
|
action or a hook. Raise ValueError if the arguments or configuration passed to action are
|
||||||
|
invalid.
|
||||||
'''
|
'''
|
||||||
repository = os.path.expanduser(repository_path)
|
repository = os.path.expanduser(repository_path)
|
||||||
global_arguments = arguments['global']
|
global_arguments = arguments['global']
|
||||||
dry_run_label = ' (dry run; not making any changes)' if global_arguments.dry_run else ''
|
dry_run_label = ' (dry run; not making any changes)' if global_arguments.dry_run else ''
|
||||||
|
hook_context = {
|
||||||
|
'repository': repository_path,
|
||||||
|
# Deprecated: For backwards compatibility with borgmatic < 1.6.0.
|
||||||
|
'repositories': ','.join(location['repositories']),
|
||||||
|
}
|
||||||
|
|
||||||
if 'init' in arguments:
|
if 'init' in arguments:
|
||||||
logger.info('{}: Initializing repository'.format(repository))
|
logger.info('{}: Initializing repository'.format(repository))
|
||||||
borg_init.initialize_repository(
|
borg_init.initialize_repository(
|
||||||
|
@ -344,6 +263,14 @@ def run_actions(
|
||||||
remote_path=remote_path,
|
remote_path=remote_path,
|
||||||
)
|
)
|
||||||
if 'prune' in arguments:
|
if 'prune' in arguments:
|
||||||
|
command.execute_hook(
|
||||||
|
hooks.get('before_prune'),
|
||||||
|
hooks.get('umask'),
|
||||||
|
config_filename,
|
||||||
|
'pre-prune',
|
||||||
|
global_arguments.dry_run,
|
||||||
|
**hook_context,
|
||||||
|
)
|
||||||
logger.info('{}: Pruning archives{}'.format(repository, dry_run_label))
|
logger.info('{}: Pruning archives{}'.format(repository, dry_run_label))
|
||||||
borg_prune.prune_archives(
|
borg_prune.prune_archives(
|
||||||
global_arguments.dry_run,
|
global_arguments.dry_run,
|
||||||
|
@ -355,7 +282,22 @@ def run_actions(
|
||||||
stats=arguments['prune'].stats,
|
stats=arguments['prune'].stats,
|
||||||
files=arguments['prune'].files,
|
files=arguments['prune'].files,
|
||||||
)
|
)
|
||||||
|
command.execute_hook(
|
||||||
|
hooks.get('after_prune'),
|
||||||
|
hooks.get('umask'),
|
||||||
|
config_filename,
|
||||||
|
'post-prune',
|
||||||
|
global_arguments.dry_run,
|
||||||
|
**hook_context,
|
||||||
|
)
|
||||||
if 'compact' in arguments:
|
if 'compact' in arguments:
|
||||||
|
command.execute_hook(
|
||||||
|
hooks.get('before_compact'),
|
||||||
|
hooks.get('umask'),
|
||||||
|
config_filename,
|
||||||
|
'pre-compact',
|
||||||
|
global_arguments.dry_run,
|
||||||
|
)
|
||||||
if borg_feature.available(borg_feature.Feature.COMPACT, local_borg_version):
|
if borg_feature.available(borg_feature.Feature.COMPACT, local_borg_version):
|
||||||
logger.info('{}: Compacting segments{}'.format(repository, dry_run_label))
|
logger.info('{}: Compacting segments{}'.format(repository, dry_run_label))
|
||||||
borg_compact.compact_segments(
|
borg_compact.compact_segments(
|
||||||
|
@ -368,11 +310,26 @@ def run_actions(
|
||||||
cleanup_commits=arguments['compact'].cleanup_commits,
|
cleanup_commits=arguments['compact'].cleanup_commits,
|
||||||
threshold=arguments['compact'].threshold,
|
threshold=arguments['compact'].threshold,
|
||||||
)
|
)
|
||||||
else:
|
else: # pragma: nocover
|
||||||
logger.info(
|
logger.info(
|
||||||
'{}: Skipping compact (only available/needed in Borg 1.2+)'.format(repository)
|
'{}: Skipping compact (only available/needed in Borg 1.2+)'.format(repository)
|
||||||
)
|
)
|
||||||
|
command.execute_hook(
|
||||||
|
hooks.get('after_compact'),
|
||||||
|
hooks.get('umask'),
|
||||||
|
config_filename,
|
||||||
|
'post-compact',
|
||||||
|
global_arguments.dry_run,
|
||||||
|
)
|
||||||
if 'create' in arguments:
|
if 'create' in arguments:
|
||||||
|
command.execute_hook(
|
||||||
|
hooks.get('before_backup'),
|
||||||
|
hooks.get('umask'),
|
||||||
|
config_filename,
|
||||||
|
'pre-backup',
|
||||||
|
global_arguments.dry_run,
|
||||||
|
**hook_context,
|
||||||
|
)
|
||||||
logger.info('{}: Creating archive{}'.format(repository, dry_run_label))
|
logger.info('{}: Creating archive{}'.format(repository, dry_run_label))
|
||||||
dispatch.call_hooks(
|
dispatch.call_hooks(
|
||||||
'remove_database_dumps',
|
'remove_database_dumps',
|
||||||
|
@ -406,13 +363,39 @@ def run_actions(
|
||||||
files=arguments['create'].files,
|
files=arguments['create'].files,
|
||||||
stream_processes=stream_processes,
|
stream_processes=stream_processes,
|
||||||
)
|
)
|
||||||
if json_output:
|
if json_output: # pragma: nocover
|
||||||
yield json.loads(json_output)
|
yield json.loads(json_output)
|
||||||
|
|
||||||
|
dispatch.call_hooks(
|
||||||
|
'remove_database_dumps',
|
||||||
|
hooks,
|
||||||
|
config_filename,
|
||||||
|
dump.DATABASE_HOOK_NAMES,
|
||||||
|
location,
|
||||||
|
global_arguments.dry_run,
|
||||||
|
)
|
||||||
|
command.execute_hook(
|
||||||
|
hooks.get('after_backup'),
|
||||||
|
hooks.get('umask'),
|
||||||
|
config_filename,
|
||||||
|
'post-backup',
|
||||||
|
global_arguments.dry_run,
|
||||||
|
**hook_context,
|
||||||
|
)
|
||||||
|
|
||||||
if 'check' in arguments and checks.repository_enabled_for_checks(repository, consistency):
|
if 'check' in arguments and checks.repository_enabled_for_checks(repository, consistency):
|
||||||
|
command.execute_hook(
|
||||||
|
hooks.get('before_check'),
|
||||||
|
hooks.get('umask'),
|
||||||
|
config_filename,
|
||||||
|
'pre-check',
|
||||||
|
global_arguments.dry_run,
|
||||||
|
**hook_context,
|
||||||
|
)
|
||||||
logger.info('{}: Running consistency checks'.format(repository))
|
logger.info('{}: Running consistency checks'.format(repository))
|
||||||
borg_check.check_archives(
|
borg_check.check_archives(
|
||||||
repository,
|
repository,
|
||||||
|
location,
|
||||||
storage,
|
storage,
|
||||||
consistency,
|
consistency,
|
||||||
local_path=local_path,
|
local_path=local_path,
|
||||||
|
@ -420,8 +403,25 @@ def run_actions(
|
||||||
progress=arguments['check'].progress,
|
progress=arguments['check'].progress,
|
||||||
repair=arguments['check'].repair,
|
repair=arguments['check'].repair,
|
||||||
only_checks=arguments['check'].only,
|
only_checks=arguments['check'].only,
|
||||||
|
force=arguments['check'].force,
|
||||||
|
)
|
||||||
|
command.execute_hook(
|
||||||
|
hooks.get('after_check'),
|
||||||
|
hooks.get('umask'),
|
||||||
|
config_filename,
|
||||||
|
'post-check',
|
||||||
|
global_arguments.dry_run,
|
||||||
|
**hook_context,
|
||||||
)
|
)
|
||||||
if 'extract' in arguments:
|
if 'extract' in arguments:
|
||||||
|
command.execute_hook(
|
||||||
|
hooks.get('before_extract'),
|
||||||
|
hooks.get('umask'),
|
||||||
|
config_filename,
|
||||||
|
'pre-extract',
|
||||||
|
global_arguments.dry_run,
|
||||||
|
**hook_context,
|
||||||
|
)
|
||||||
if arguments['extract'].repository is None or validate.repositories_match(
|
if arguments['extract'].repository is None or validate.repositories_match(
|
||||||
repository, arguments['extract'].repository
|
repository, arguments['extract'].repository
|
||||||
):
|
):
|
||||||
|
@ -444,6 +444,14 @@ def run_actions(
|
||||||
strip_components=arguments['extract'].strip_components,
|
strip_components=arguments['extract'].strip_components,
|
||||||
progress=arguments['extract'].progress,
|
progress=arguments['extract'].progress,
|
||||||
)
|
)
|
||||||
|
command.execute_hook(
|
||||||
|
hooks.get('after_extract'),
|
||||||
|
hooks.get('umask'),
|
||||||
|
config_filename,
|
||||||
|
'post-extract',
|
||||||
|
global_arguments.dry_run,
|
||||||
|
**hook_context,
|
||||||
|
)
|
||||||
if 'export-tar' in arguments:
|
if 'export-tar' in arguments:
|
||||||
if arguments['export-tar'].repository is None or validate.repositories_match(
|
if arguments['export-tar'].repository is None or validate.repositories_match(
|
||||||
repository, arguments['export-tar'].repository
|
repository, arguments['export-tar'].repository
|
||||||
|
@ -476,7 +484,7 @@ def run_actions(
|
||||||
logger.info(
|
logger.info(
|
||||||
'{}: Mounting archive {}'.format(repository, arguments['mount'].archive)
|
'{}: Mounting archive {}'.format(repository, arguments['mount'].archive)
|
||||||
)
|
)
|
||||||
else:
|
else: # pragma: nocover
|
||||||
logger.info('{}: Mounting repository'.format(repository))
|
logger.info('{}: Mounting repository'.format(repository))
|
||||||
|
|
||||||
borg_mount.mount_archive(
|
borg_mount.mount_archive(
|
||||||
|
@ -492,7 +500,7 @@ def run_actions(
|
||||||
local_path=local_path,
|
local_path=local_path,
|
||||||
remote_path=remote_path,
|
remote_path=remote_path,
|
||||||
)
|
)
|
||||||
if 'restore' in arguments:
|
if 'restore' in arguments: # pragma: nocover
|
||||||
if arguments['restore'].repository is None or validate.repositories_match(
|
if arguments['restore'].repository is None or validate.repositories_match(
|
||||||
repository, arguments['restore'].repository
|
repository, arguments['restore'].repository
|
||||||
):
|
):
|
||||||
|
@ -591,7 +599,7 @@ def run_actions(
|
||||||
repository, arguments['list'].repository
|
repository, arguments['list'].repository
|
||||||
):
|
):
|
||||||
list_arguments = copy.copy(arguments['list'])
|
list_arguments = copy.copy(arguments['list'])
|
||||||
if not list_arguments.json:
|
if not list_arguments.json: # pragma: nocover
|
||||||
logger.warning('{}: Listing archives'.format(repository))
|
logger.warning('{}: Listing archives'.format(repository))
|
||||||
list_arguments.archive = borg_list.resolve_archive_name(
|
list_arguments.archive = borg_list.resolve_archive_name(
|
||||||
repository, list_arguments.archive, storage, local_path, remote_path
|
repository, list_arguments.archive, storage, local_path, remote_path
|
||||||
|
@ -603,14 +611,14 @@ def run_actions(
|
||||||
local_path=local_path,
|
local_path=local_path,
|
||||||
remote_path=remote_path,
|
remote_path=remote_path,
|
||||||
)
|
)
|
||||||
if json_output:
|
if json_output: # pragma: nocover
|
||||||
yield json.loads(json_output)
|
yield json.loads(json_output)
|
||||||
if 'info' in arguments:
|
if 'info' in arguments:
|
||||||
if arguments['info'].repository is None or validate.repositories_match(
|
if arguments['info'].repository is None or validate.repositories_match(
|
||||||
repository, arguments['info'].repository
|
repository, arguments['info'].repository
|
||||||
):
|
):
|
||||||
info_arguments = copy.copy(arguments['info'])
|
info_arguments = copy.copy(arguments['info'])
|
||||||
if not info_arguments.json:
|
if not info_arguments.json: # pragma: nocover
|
||||||
logger.warning('{}: Displaying summary info for archives'.format(repository))
|
logger.warning('{}: Displaying summary info for archives'.format(repository))
|
||||||
info_arguments.archive = borg_list.resolve_archive_name(
|
info_arguments.archive = borg_list.resolve_archive_name(
|
||||||
repository, info_arguments.archive, storage, local_path, remote_path
|
repository, info_arguments.archive, storage, local_path, remote_path
|
||||||
|
@ -622,7 +630,7 @@ def run_actions(
|
||||||
local_path=local_path,
|
local_path=local_path,
|
||||||
remote_path=remote_path,
|
remote_path=remote_path,
|
||||||
)
|
)
|
||||||
if json_output:
|
if json_output: # pragma: nocover
|
||||||
yield json.loads(json_output)
|
yield json.loads(json_output)
|
||||||
if 'borg' in arguments:
|
if 'borg' in arguments:
|
||||||
if arguments['borg'].repository is None or validate.repositories_match(
|
if arguments['borg'].repository is None or validate.repositories_match(
|
||||||
|
@ -704,28 +712,39 @@ def log_record(suppress_log=False, **kwargs):
|
||||||
return record
|
return record
|
||||||
|
|
||||||
|
|
||||||
def make_error_log_records(message, error=None):
|
def log_error_records(
|
||||||
|
message, error=None, levelno=logging.CRITICAL, log_command_error_output=False
|
||||||
|
):
|
||||||
'''
|
'''
|
||||||
Given error message text and an optional exception object, yield a series of logging.LogRecord
|
Given error message text, an optional exception object, an optional log level, and whether to
|
||||||
instances with error summary information. As a side effect, log each record.
|
log the error output of a CalledProcessError (if any), log error summary information and also
|
||||||
|
yield it as a series of logging.LogRecord instances.
|
||||||
|
|
||||||
|
Note that because the logs are yielded as a generator, logs won't get logged unless you consume
|
||||||
|
the generator output.
|
||||||
'''
|
'''
|
||||||
|
level_name = logging._levelToName[levelno]
|
||||||
|
|
||||||
if not error:
|
if not error:
|
||||||
yield log_record(levelno=logging.CRITICAL, levelname='CRITICAL', msg=message)
|
yield log_record(levelno=levelno, levelname=level_name, msg=message)
|
||||||
return
|
return
|
||||||
|
|
||||||
try:
|
try:
|
||||||
raise error
|
raise error
|
||||||
except CalledProcessError as error:
|
except CalledProcessError as error:
|
||||||
yield log_record(levelno=logging.CRITICAL, levelname='CRITICAL', msg=message)
|
yield log_record(levelno=levelno, levelname=level_name, msg=message)
|
||||||
if error.output:
|
if error.output:
|
||||||
# Suppress these logs for now and save full error output for the log summary at the end.
|
# Suppress these logs for now and save full error output for the log summary at the end.
|
||||||
yield log_record(
|
yield log_record(
|
||||||
levelno=logging.CRITICAL, levelname='CRITICAL', msg=error.output, suppress_log=True
|
levelno=levelno,
|
||||||
|
levelname=level_name,
|
||||||
|
msg=error.output,
|
||||||
|
suppress_log=not log_command_error_output,
|
||||||
)
|
)
|
||||||
yield log_record(levelno=logging.CRITICAL, levelname='CRITICAL', msg=error)
|
yield log_record(levelno=levelno, levelname=level_name, msg=error)
|
||||||
except (ValueError, OSError) as error:
|
except (ValueError, OSError) as error:
|
||||||
yield log_record(levelno=logging.CRITICAL, levelname='CRITICAL', msg=message)
|
yield log_record(levelno=levelno, levelname=level_name, msg=message)
|
||||||
yield log_record(levelno=logging.CRITICAL, levelname='CRITICAL', msg=error)
|
yield log_record(levelno=levelno, levelname=level_name, msg=error)
|
||||||
except: # noqa: E722
|
except: # noqa: E722
|
||||||
# Raising above only as a means of determining the error type. Swallow the exception here
|
# Raising above only as a means of determining the error type. Swallow the exception here
|
||||||
# because we don't want the exception to propagate out of this function.
|
# because we don't want the exception to propagate out of this function.
|
||||||
|
@ -764,11 +783,11 @@ def collect_configuration_run_summary_logs(configs, arguments):
|
||||||
try:
|
try:
|
||||||
validate.guard_configuration_contains_repository(repository, configs)
|
validate.guard_configuration_contains_repository(repository, configs)
|
||||||
except ValueError as error:
|
except ValueError as error:
|
||||||
yield from make_error_log_records(str(error))
|
yield from log_error_records(str(error))
|
||||||
return
|
return
|
||||||
|
|
||||||
if not configs:
|
if not configs:
|
||||||
yield from make_error_log_records(
|
yield from log_error_records(
|
||||||
'{}: No valid configuration files found'.format(
|
'{}: No valid configuration files found'.format(
|
||||||
' '.join(arguments['global'].config_paths)
|
' '.join(arguments['global'].config_paths)
|
||||||
)
|
)
|
||||||
|
@ -787,7 +806,7 @@ def collect_configuration_run_summary_logs(configs, arguments):
|
||||||
arguments['global'].dry_run,
|
arguments['global'].dry_run,
|
||||||
)
|
)
|
||||||
except (CalledProcessError, ValueError, OSError) as error:
|
except (CalledProcessError, ValueError, OSError) as error:
|
||||||
yield from make_error_log_records('Error running pre-everything hook', error)
|
yield from log_error_records('Error running pre-everything hook', error)
|
||||||
return
|
return
|
||||||
|
|
||||||
# Execute the actions corresponding to each configuration file.
|
# Execute the actions corresponding to each configuration file.
|
||||||
|
@ -797,7 +816,7 @@ def collect_configuration_run_summary_logs(configs, arguments):
|
||||||
error_logs = tuple(result for result in results if isinstance(result, logging.LogRecord))
|
error_logs = tuple(result for result in results if isinstance(result, logging.LogRecord))
|
||||||
|
|
||||||
if error_logs:
|
if error_logs:
|
||||||
yield from make_error_log_records(
|
yield from log_error_records(
|
||||||
'{}: Error running configuration file'.format(config_filename)
|
'{}: Error running configuration file'.format(config_filename)
|
||||||
)
|
)
|
||||||
yield from error_logs
|
yield from error_logs
|
||||||
|
@ -819,7 +838,7 @@ def collect_configuration_run_summary_logs(configs, arguments):
|
||||||
mount_point=arguments['umount'].mount_point, local_path=get_local_path(configs)
|
mount_point=arguments['umount'].mount_point, local_path=get_local_path(configs)
|
||||||
)
|
)
|
||||||
except (CalledProcessError, OSError) as error:
|
except (CalledProcessError, OSError) as error:
|
||||||
yield from make_error_log_records('Error unmounting mount point', error)
|
yield from log_error_records('Error unmounting mount point', error)
|
||||||
|
|
||||||
if json_results:
|
if json_results:
|
||||||
sys.stdout.write(json.dumps(json_results))
|
sys.stdout.write(json.dumps(json_results))
|
||||||
|
@ -836,7 +855,7 @@ def collect_configuration_run_summary_logs(configs, arguments):
|
||||||
arguments['global'].dry_run,
|
arguments['global'].dry_run,
|
||||||
)
|
)
|
||||||
except (CalledProcessError, ValueError, OSError) as error:
|
except (CalledProcessError, ValueError, OSError) as error:
|
||||||
yield from make_error_log_records('Error running post-everything hook', error)
|
yield from log_error_records('Error running post-everything hook', error)
|
||||||
|
|
||||||
|
|
||||||
def exit_with_help_link(): # pragma: no cover
|
def exit_with_help_link(): # pragma: no cover
|
||||||
|
@ -868,6 +887,9 @@ def main(): # pragma: no cover
|
||||||
if global_arguments.version:
|
if global_arguments.version:
|
||||||
print(pkg_resources.require('borgmatic')[0].version)
|
print(pkg_resources.require('borgmatic')[0].version)
|
||||||
sys.exit(0)
|
sys.exit(0)
|
||||||
|
if global_arguments.bash_completion:
|
||||||
|
print(borgmatic.commands.completion.bash_completion())
|
||||||
|
sys.exit(0)
|
||||||
|
|
||||||
config_filenames = tuple(collect.collect_config_filenames(global_arguments.config_paths))
|
config_filenames = tuple(collect.collect_config_filenames(global_arguments.config_paths))
|
||||||
configs, parse_logs = load_configurations(config_filenames, global_arguments.overrides)
|
configs, parse_logs = load_configurations(config_filenames, global_arguments.overrides)
|
||||||
|
|
|
@ -0,0 +1,58 @@
|
||||||
|
from borgmatic.commands import arguments
|
||||||
|
|
||||||
|
UPGRADE_MESSAGE = '''
|
||||||
|
Your bash completions script is from a different version of borgmatic than is
|
||||||
|
currently installed. Please upgrade your script so your completions match the
|
||||||
|
command-line flags in your installed borgmatic! Try this to upgrade:
|
||||||
|
|
||||||
|
sudo sh -c "borgmatic --bash-completion > $BASH_SOURCE"
|
||||||
|
source $BASH_SOURCE
|
||||||
|
'''
|
||||||
|
|
||||||
|
|
||||||
|
def parser_flags(parser):
|
||||||
|
'''
|
||||||
|
Given an argparse.ArgumentParser instance, return its argument flags in a space-separated
|
||||||
|
string.
|
||||||
|
'''
|
||||||
|
return ' '.join(option for action in parser._actions for option in action.option_strings)
|
||||||
|
|
||||||
|
|
||||||
|
def bash_completion():
|
||||||
|
'''
|
||||||
|
Return a bash completion script for the borgmatic command. Produce this by introspecting
|
||||||
|
borgmatic's command-line argument parsers.
|
||||||
|
'''
|
||||||
|
top_level_parser, subparsers = arguments.make_parsers()
|
||||||
|
global_flags = parser_flags(top_level_parser)
|
||||||
|
actions = ' '.join(subparsers.choices.keys())
|
||||||
|
|
||||||
|
# Avert your eyes.
|
||||||
|
return '\n'.join(
|
||||||
|
(
|
||||||
|
'set -uo pipefail',
|
||||||
|
'check_version() {',
|
||||||
|
' local this_script="$(cat "$BASH_SOURCE" 2> /dev/null)"',
|
||||||
|
' local installed_script="$(borgmatic --bash-completion 2> /dev/null)"',
|
||||||
|
' if [ "$this_script" != "$installed_script" ] && [ "$installed_script" != "" ];'
|
||||||
|
' then cat << EOF\n%s\nEOF' % UPGRADE_MESSAGE,
|
||||||
|
' fi',
|
||||||
|
'}',
|
||||||
|
'complete_borgmatic() {',
|
||||||
|
)
|
||||||
|
+ tuple(
|
||||||
|
''' if [[ " ${COMP_WORDS[*]} " =~ " %s " ]]; then
|
||||||
|
COMPREPLY=($(compgen -W "%s %s %s" -- "${COMP_WORDS[COMP_CWORD]}"))
|
||||||
|
return 0
|
||||||
|
fi'''
|
||||||
|
% (action, parser_flags(subparser), actions, global_flags)
|
||||||
|
for action, subparser in subparsers.choices.items()
|
||||||
|
)
|
||||||
|
+ (
|
||||||
|
' COMPREPLY=($(compgen -W "%s %s" -- "${COMP_WORDS[COMP_CWORD]}"))'
|
||||||
|
% (actions, global_flags),
|
||||||
|
' (check_version &)',
|
||||||
|
'}',
|
||||||
|
'\ncomplete -o bashdefault -o default -F complete_borgmatic borgmatic',
|
||||||
|
)
|
||||||
|
)
|
|
@ -23,10 +23,16 @@ def parse_arguments(*arguments):
|
||||||
'--destination',
|
'--destination',
|
||||||
dest='destination_filename',
|
dest='destination_filename',
|
||||||
default=DEFAULT_DESTINATION_CONFIG_FILENAME,
|
default=DEFAULT_DESTINATION_CONFIG_FILENAME,
|
||||||
help='Destination YAML configuration file. Default: {}'.format(
|
help='Destination YAML configuration file, default: {}'.format(
|
||||||
DEFAULT_DESTINATION_CONFIG_FILENAME
|
DEFAULT_DESTINATION_CONFIG_FILENAME
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
|
parser.add_argument(
|
||||||
|
'--overwrite',
|
||||||
|
default=False,
|
||||||
|
action='store_true',
|
||||||
|
help='Whether to overwrite any existing destination file, defaults to false',
|
||||||
|
)
|
||||||
|
|
||||||
return parser.parse_args(arguments)
|
return parser.parse_args(arguments)
|
||||||
|
|
||||||
|
@ -36,7 +42,10 @@ def main(): # pragma: no cover
|
||||||
args = parse_arguments(*sys.argv[1:])
|
args = parse_arguments(*sys.argv[1:])
|
||||||
|
|
||||||
generate.generate_sample_configuration(
|
generate.generate_sample_configuration(
|
||||||
args.source_filename, args.destination_filename, validate.schema_filename()
|
args.source_filename,
|
||||||
|
args.destination_filename,
|
||||||
|
validate.schema_filename(),
|
||||||
|
overwrite=args.overwrite,
|
||||||
)
|
)
|
||||||
|
|
||||||
print('Generated a sample configuration file at {}.'.format(args.destination_filename))
|
print('Generated a sample configuration file at {}.'.format(args.destination_filename))
|
||||||
|
|
|
@ -5,7 +5,7 @@ import re
|
||||||
|
|
||||||
from ruamel import yaml
|
from ruamel import yaml
|
||||||
|
|
||||||
from borgmatic.config import load
|
from borgmatic.config import load, normalize
|
||||||
|
|
||||||
INDENT = 4
|
INDENT = 4
|
||||||
SEQUENCE_INDENT = 2
|
SEQUENCE_INDENT = 2
|
||||||
|
@ -109,13 +109,18 @@ def render_configuration(config):
|
||||||
return rendered.getvalue()
|
return rendered.getvalue()
|
||||||
|
|
||||||
|
|
||||||
def write_configuration(config_filename, rendered_config, mode=0o600):
|
def write_configuration(config_filename, rendered_config, mode=0o600, overwrite=False):
|
||||||
'''
|
'''
|
||||||
Given a target config filename and rendered config YAML, write it out to file. Create any
|
Given a target config filename and rendered config YAML, write it out to file. Create any
|
||||||
containing directories as needed.
|
containing directories as needed. But if the file already exists and overwrite is False,
|
||||||
|
abort before writing anything.
|
||||||
'''
|
'''
|
||||||
if os.path.exists(config_filename):
|
if not overwrite and os.path.exists(config_filename):
|
||||||
raise FileExistsError('{} already exists. Aborting.'.format(config_filename))
|
raise FileExistsError(
|
||||||
|
'{} already exists. Aborting. Use --overwrite to replace the file.'.format(
|
||||||
|
config_filename
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
try:
|
try:
|
||||||
os.makedirs(os.path.dirname(config_filename), mode=0o700)
|
os.makedirs(os.path.dirname(config_filename), mode=0o700)
|
||||||
|
@ -263,18 +268,22 @@ def merge_source_configuration_into_destination(destination_config, source_confi
|
||||||
return destination_config
|
return destination_config
|
||||||
|
|
||||||
|
|
||||||
def generate_sample_configuration(source_filename, destination_filename, schema_filename):
|
def generate_sample_configuration(
|
||||||
|
source_filename, destination_filename, schema_filename, overwrite=False
|
||||||
|
):
|
||||||
'''
|
'''
|
||||||
Given an optional source configuration filename, and a required destination configuration
|
Given an optional source configuration filename, and a required destination configuration
|
||||||
filename, and the path to a schema filename in a YAML rendition of the JSON Schema format,
|
filename, the path to a schema filename in a YAML rendition of the JSON Schema format, and
|
||||||
write out a sample configuration file based on that schema. If a source filename is provided,
|
whether to overwrite a destination file, write out a sample configuration file based on that
|
||||||
merge the parsed contents of that configuration into the generated configuration.
|
schema. If a source filename is provided, merge the parsed contents of that configuration into
|
||||||
|
the generated configuration.
|
||||||
'''
|
'''
|
||||||
schema = yaml.round_trip_load(open(schema_filename))
|
schema = yaml.round_trip_load(open(schema_filename))
|
||||||
source_config = None
|
source_config = None
|
||||||
|
|
||||||
if source_filename:
|
if source_filename:
|
||||||
source_config = load.load_configuration(source_filename)
|
source_config = load.load_configuration(source_filename)
|
||||||
|
normalize.normalize(source_config)
|
||||||
|
|
||||||
destination_config = merge_source_configuration_into_destination(
|
destination_config = merge_source_configuration_into_destination(
|
||||||
_schema_to_sample_configuration(schema), source_config
|
_schema_to_sample_configuration(schema), source_config
|
||||||
|
@ -283,4 +292,5 @@ def generate_sample_configuration(source_filename, destination_filename, schema_
|
||||||
write_configuration(
|
write_configuration(
|
||||||
destination_filename,
|
destination_filename,
|
||||||
_comment_out_optional_configuration(render_configuration(destination_config)),
|
_comment_out_optional_configuration(render_configuration(destination_config)),
|
||||||
|
overwrite=overwrite,
|
||||||
)
|
)
|
||||||
|
|
|
@ -6,6 +6,19 @@ import ruamel.yaml
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
class Yaml_with_loader_stream(ruamel.yaml.YAML):
|
||||||
|
'''
|
||||||
|
A derived class of ruamel.yaml.YAML that simply tacks the loaded stream (file object) onto the
|
||||||
|
loader class so that it's available anywhere that's passed a loader (in this case,
|
||||||
|
include_configuration() below).
|
||||||
|
'''
|
||||||
|
|
||||||
|
def get_constructor_parser(self, stream):
|
||||||
|
constructor, parser = super(Yaml_with_loader_stream, self).get_constructor_parser(stream)
|
||||||
|
constructor.loader.stream = stream
|
||||||
|
return constructor, parser
|
||||||
|
|
||||||
|
|
||||||
def load_configuration(filename):
|
def load_configuration(filename):
|
||||||
'''
|
'''
|
||||||
Load the given configuration file and return its contents as a data structure of nested dicts
|
Load the given configuration file and return its contents as a data structure of nested dicts
|
||||||
|
@ -14,7 +27,7 @@ def load_configuration(filename):
|
||||||
Raise ruamel.yaml.error.YAMLError if something goes wrong parsing the YAML, or RecursionError
|
Raise ruamel.yaml.error.YAMLError if something goes wrong parsing the YAML, or RecursionError
|
||||||
if there are too many recursive includes.
|
if there are too many recursive includes.
|
||||||
'''
|
'''
|
||||||
yaml = ruamel.yaml.YAML(typ='safe')
|
yaml = Yaml_with_loader_stream(typ='safe')
|
||||||
yaml.Constructor = Include_constructor
|
yaml.Constructor = Include_constructor
|
||||||
|
|
||||||
return yaml.load(open(filename))
|
return yaml.load(open(filename))
|
||||||
|
@ -22,10 +35,146 @@ def load_configuration(filename):
|
||||||
|
|
||||||
def include_configuration(loader, filename_node):
|
def include_configuration(loader, filename_node):
|
||||||
'''
|
'''
|
||||||
Load the given YAML filename (ignoring the given loader so we can use our own), and return its
|
Load the given YAML filename (ignoring the given loader so we can use our own) and return its
|
||||||
contents as a data structure of nested dicts and lists.
|
contents as a data structure of nested dicts and lists. If the filename is relative, probe for
|
||||||
|
it within 1. the current working directory and 2. the directory containing the YAML file doing
|
||||||
|
the including.
|
||||||
|
|
||||||
|
Raise FileNotFoundError if an included file was not found.
|
||||||
'''
|
'''
|
||||||
return load_configuration(os.path.expanduser(filename_node.value))
|
include_directories = [os.getcwd(), os.path.abspath(os.path.dirname(loader.stream.name))]
|
||||||
|
include_filename = os.path.expanduser(filename_node.value)
|
||||||
|
|
||||||
|
if not os.path.isabs(include_filename):
|
||||||
|
candidate_filenames = [
|
||||||
|
os.path.join(directory, include_filename) for directory in include_directories
|
||||||
|
]
|
||||||
|
|
||||||
|
for candidate_filename in candidate_filenames:
|
||||||
|
if os.path.exists(candidate_filename):
|
||||||
|
include_filename = candidate_filename
|
||||||
|
break
|
||||||
|
else:
|
||||||
|
raise FileNotFoundError(
|
||||||
|
f'Could not find include {filename_node.value} at {" or ".join(candidate_filenames)}'
|
||||||
|
)
|
||||||
|
|
||||||
|
return load_configuration(include_filename)
|
||||||
|
|
||||||
|
|
||||||
|
DELETED_NODE = object()
|
||||||
|
|
||||||
|
|
||||||
|
def deep_merge_nodes(nodes):
|
||||||
|
'''
|
||||||
|
Given a nested borgmatic configuration data structure as a list of tuples in the form of:
|
||||||
|
|
||||||
|
(
|
||||||
|
ruamel.yaml.nodes.ScalarNode as a key,
|
||||||
|
ruamel.yaml.nodes.MappingNode or other Node as a value,
|
||||||
|
),
|
||||||
|
|
||||||
|
... deep merge any node values corresponding to duplicate keys and return the result. If
|
||||||
|
there are colliding keys with non-MappingNode values (e.g., integers or strings), the last
|
||||||
|
of the values wins.
|
||||||
|
|
||||||
|
For instance, given node values of:
|
||||||
|
|
||||||
|
[
|
||||||
|
(
|
||||||
|
ScalarNode(tag='tag:yaml.org,2002:str', value='retention'),
|
||||||
|
MappingNode(tag='tag:yaml.org,2002:map', value=[
|
||||||
|
(
|
||||||
|
ScalarNode(tag='tag:yaml.org,2002:str', value='keep_hourly'),
|
||||||
|
ScalarNode(tag='tag:yaml.org,2002:int', value='24')
|
||||||
|
),
|
||||||
|
(
|
||||||
|
ScalarNode(tag='tag:yaml.org,2002:str', value='keep_daily'),
|
||||||
|
ScalarNode(tag='tag:yaml.org,2002:int', value='7')
|
||||||
|
),
|
||||||
|
]),
|
||||||
|
),
|
||||||
|
(
|
||||||
|
ScalarNode(tag='tag:yaml.org,2002:str', value='retention'),
|
||||||
|
MappingNode(tag='tag:yaml.org,2002:map', value=[
|
||||||
|
(
|
||||||
|
ScalarNode(tag='tag:yaml.org,2002:str', value='keep_daily'),
|
||||||
|
ScalarNode(tag='tag:yaml.org,2002:int', value='5')
|
||||||
|
),
|
||||||
|
]),
|
||||||
|
),
|
||||||
|
]
|
||||||
|
|
||||||
|
... the returned result would be:
|
||||||
|
|
||||||
|
[
|
||||||
|
(
|
||||||
|
ScalarNode(tag='tag:yaml.org,2002:str', value='retention'),
|
||||||
|
MappingNode(tag='tag:yaml.org,2002:map', value=[
|
||||||
|
(
|
||||||
|
ScalarNode(tag='tag:yaml.org,2002:str', value='keep_hourly'),
|
||||||
|
ScalarNode(tag='tag:yaml.org,2002:int', value='24')
|
||||||
|
),
|
||||||
|
(
|
||||||
|
ScalarNode(tag='tag:yaml.org,2002:str', value='keep_daily'),
|
||||||
|
ScalarNode(tag='tag:yaml.org,2002:int', value='5')
|
||||||
|
),
|
||||||
|
]),
|
||||||
|
),
|
||||||
|
]
|
||||||
|
|
||||||
|
The purpose of deep merging like this is to support, for instance, merging one borgmatic
|
||||||
|
configuration file into another for reuse, such that a configuration section ("retention",
|
||||||
|
etc.) does not completely replace the corresponding section in a merged file.
|
||||||
|
'''
|
||||||
|
# Map from original node key/value to the replacement merged node. DELETED_NODE as a replacement
|
||||||
|
# node indications deletion.
|
||||||
|
replaced_nodes = {}
|
||||||
|
|
||||||
|
# To find nodes that require merging, compare each node with each other node.
|
||||||
|
for a_key, a_value in nodes:
|
||||||
|
for b_key, b_value in nodes:
|
||||||
|
# If we've already considered one of the nodes for merging, skip it.
|
||||||
|
if (a_key, a_value) in replaced_nodes or (b_key, b_value) in replaced_nodes:
|
||||||
|
continue
|
||||||
|
|
||||||
|
# If the keys match and the values are different, we need to merge these two A and B nodes.
|
||||||
|
if a_key.tag == b_key.tag and a_key.value == b_key.value and a_value != b_value:
|
||||||
|
# Since we're merging into the B node, consider the A node a duplicate and remove it.
|
||||||
|
replaced_nodes[(a_key, a_value)] = DELETED_NODE
|
||||||
|
|
||||||
|
# If we're dealing with MappingNodes, recurse and merge its values as well.
|
||||||
|
if isinstance(b_value, ruamel.yaml.nodes.MappingNode):
|
||||||
|
replaced_nodes[(b_key, b_value)] = (
|
||||||
|
b_key,
|
||||||
|
ruamel.yaml.nodes.MappingNode(
|
||||||
|
tag=b_value.tag,
|
||||||
|
value=deep_merge_nodes(a_value.value + b_value.value),
|
||||||
|
start_mark=b_value.start_mark,
|
||||||
|
end_mark=b_value.end_mark,
|
||||||
|
flow_style=b_value.flow_style,
|
||||||
|
comment=b_value.comment,
|
||||||
|
anchor=b_value.anchor,
|
||||||
|
),
|
||||||
|
)
|
||||||
|
# If we're dealing with SequenceNodes, merge by appending one sequence to the other.
|
||||||
|
elif isinstance(b_value, ruamel.yaml.nodes.SequenceNode):
|
||||||
|
replaced_nodes[(b_key, b_value)] = (
|
||||||
|
b_key,
|
||||||
|
ruamel.yaml.nodes.SequenceNode(
|
||||||
|
tag=b_value.tag,
|
||||||
|
value=a_value.value + b_value.value,
|
||||||
|
start_mark=b_value.start_mark,
|
||||||
|
end_mark=b_value.end_mark,
|
||||||
|
flow_style=b_value.flow_style,
|
||||||
|
comment=b_value.comment,
|
||||||
|
anchor=b_value.anchor,
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
return [
|
||||||
|
replaced_nodes.get(node, node) for node in nodes if replaced_nodes.get(node) != DELETED_NODE
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
class Include_constructor(ruamel.yaml.SafeConstructor):
|
class Include_constructor(ruamel.yaml.SafeConstructor):
|
||||||
|
@ -40,14 +189,19 @@ class Include_constructor(ruamel.yaml.SafeConstructor):
|
||||||
|
|
||||||
def flatten_mapping(self, node):
|
def flatten_mapping(self, node):
|
||||||
'''
|
'''
|
||||||
Support the special case of shallow merging included configuration into an existing mapping
|
Support the special case of deep merging included configuration into an existing mapping
|
||||||
using the YAML '<<' merge key. Example syntax:
|
using the YAML '<<' merge key. Example syntax:
|
||||||
|
|
||||||
```
|
```
|
||||||
retention:
|
retention:
|
||||||
keep_daily: 1
|
keep_daily: 1
|
||||||
<<: !include common.yaml
|
|
||||||
|
<<: !include common.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
|
These includes are deep merged into the current configuration file. For instance, in this
|
||||||
|
example, any "retention" options in common.yaml will get merged into the "retention" section
|
||||||
|
in the example configuration file.
|
||||||
'''
|
'''
|
||||||
representer = ruamel.yaml.representer.SafeRepresenter()
|
representer = ruamel.yaml.representer.SafeRepresenter()
|
||||||
|
|
||||||
|
@ -57,3 +211,5 @@ class Include_constructor(ruamel.yaml.SafeConstructor):
|
||||||
node.value[index] = (key_node, included_value)
|
node.value[index] = (key_node, included_value)
|
||||||
|
|
||||||
super(Include_constructor, self).flatten_mapping(node)
|
super(Include_constructor, self).flatten_mapping(node)
|
||||||
|
|
||||||
|
node.value = deep_merge_nodes(node.value)
|
||||||
|
|
|
@ -3,8 +3,29 @@ def normalize(config):
|
||||||
Given a configuration dict, apply particular hard-coded rules to normalize its contents to
|
Given a configuration dict, apply particular hard-coded rules to normalize its contents to
|
||||||
adhere to the configuration schema.
|
adhere to the configuration schema.
|
||||||
'''
|
'''
|
||||||
|
# Upgrade exclude_if_present from a string to a list.
|
||||||
exclude_if_present = config.get('location', {}).get('exclude_if_present')
|
exclude_if_present = config.get('location', {}).get('exclude_if_present')
|
||||||
|
|
||||||
# "Upgrade" exclude_if_present from a string to a list.
|
|
||||||
if isinstance(exclude_if_present, str):
|
if isinstance(exclude_if_present, str):
|
||||||
config['location']['exclude_if_present'] = [exclude_if_present]
|
config['location']['exclude_if_present'] = [exclude_if_present]
|
||||||
|
|
||||||
|
# Upgrade various monitoring hooks from a string to a dict.
|
||||||
|
healthchecks = config.get('hooks', {}).get('healthchecks')
|
||||||
|
if isinstance(healthchecks, str):
|
||||||
|
config['hooks']['healthchecks'] = {'ping_url': healthchecks}
|
||||||
|
|
||||||
|
cronitor = config.get('hooks', {}).get('cronitor')
|
||||||
|
if isinstance(cronitor, str):
|
||||||
|
config['hooks']['cronitor'] = {'ping_url': cronitor}
|
||||||
|
|
||||||
|
pagerduty = config.get('hooks', {}).get('pagerduty')
|
||||||
|
if isinstance(pagerduty, str):
|
||||||
|
config['hooks']['pagerduty'] = {'integration_key': pagerduty}
|
||||||
|
|
||||||
|
cronhub = config.get('hooks', {}).get('cronhub')
|
||||||
|
if isinstance(cronhub, str):
|
||||||
|
config['hooks']['cronhub'] = {'ping_url': cronhub}
|
||||||
|
|
||||||
|
# Upgrade consistency checks from a list of strings to a list of dicts.
|
||||||
|
checks = config.get('consistency', {}).get('checks')
|
||||||
|
if isinstance(checks, list) and len(checks) and isinstance(checks[0], str):
|
||||||
|
config['consistency']['checks'] = [{'name': check_type} for check_type in checks]
|
||||||
|
|
|
@ -52,16 +52,20 @@ def parse_overrides(raw_overrides):
|
||||||
if not raw_overrides:
|
if not raw_overrides:
|
||||||
return ()
|
return ()
|
||||||
|
|
||||||
try:
|
parsed_overrides = []
|
||||||
return tuple(
|
|
||||||
(tuple(raw_keys.split('.')), convert_value_type(value))
|
for raw_override in raw_overrides:
|
||||||
for raw_override in raw_overrides
|
try:
|
||||||
for raw_keys, value in (raw_override.split('=', 1),)
|
raw_keys, value = raw_override.split('=', 1)
|
||||||
)
|
parsed_overrides.append((tuple(raw_keys.split('.')), convert_value_type(value),))
|
||||||
except ValueError:
|
except ValueError:
|
||||||
raise ValueError('Invalid override. Make sure you use the form: SECTION.OPTION=VALUE')
|
raise ValueError(
|
||||||
except ruamel.yaml.error.YAMLError as error:
|
f"Invalid override '{raw_override}'. Make sure you use the form: SECTION.OPTION=VALUE"
|
||||||
raise ValueError(f'Invalid override value: {error}')
|
)
|
||||||
|
except ruamel.yaml.error.YAMLError as error:
|
||||||
|
raise ValueError(f"Invalid override '{raw_override}': {error.problem}")
|
||||||
|
|
||||||
|
return tuple(parsed_overrides)
|
||||||
|
|
||||||
|
|
||||||
def apply_overrides(config, raw_overrides):
|
def apply_overrides(config, raw_overrides):
|
||||||
|
|
|
@ -53,10 +53,10 @@ properties:
|
||||||
one_file_system:
|
one_file_system:
|
||||||
type: boolean
|
type: boolean
|
||||||
description: |
|
description: |
|
||||||
Stay in same file system (do not cross mount points).
|
Stay in same file system: do not cross mount points beyond
|
||||||
Defaults to false. But when a database hook is used, the
|
the given source directories. Defaults to false. But when a
|
||||||
setting here is ignored and one_file_system is considered
|
database hook is used, the setting here is ignored and
|
||||||
true.
|
one_file_system is considered true.
|
||||||
example: true
|
example: true
|
||||||
numeric_owner:
|
numeric_owner:
|
||||||
type: boolean
|
type: boolean
|
||||||
|
@ -332,10 +332,10 @@ properties:
|
||||||
Name of the archive. Borg placeholders can be used. See the
|
Name of the archive. Borg placeholders can be used. See the
|
||||||
output of "borg help placeholders" for details. Defaults to
|
output of "borg help placeholders" for details. Defaults to
|
||||||
"{hostname}-{now:%Y-%m-%dT%H:%M:%S.%f}". If you specify this
|
"{hostname}-{now:%Y-%m-%dT%H:%M:%S.%f}". If you specify this
|
||||||
option, you must also specify a prefix in the retention
|
option, consider also specifying a prefix in the retention
|
||||||
section to avoid accidental pruning of archives with a
|
and consistency sections to avoid accidental
|
||||||
different archive name format. And you should also specify a
|
pruning/checking of archives with different archive name
|
||||||
prefix in the consistency section as well.
|
formats.
|
||||||
example: "{hostname}-documents-{now}"
|
example: "{hostname}-documents-{now}"
|
||||||
relocated_repo_access_is_ok:
|
relocated_repo_access_is_ok:
|
||||||
type: boolean
|
type: boolean
|
||||||
|
@ -447,26 +447,45 @@ properties:
|
||||||
checks:
|
checks:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
type: string
|
type: object
|
||||||
enum:
|
required: ['name']
|
||||||
- repository
|
additionalProperties: false
|
||||||
- archives
|
properties:
|
||||||
- data
|
name:
|
||||||
- extract
|
type: string
|
||||||
- disabled
|
enum:
|
||||||
uniqueItems: true
|
- repository
|
||||||
|
- archives
|
||||||
|
- data
|
||||||
|
- extract
|
||||||
|
- disabled
|
||||||
|
description: |
|
||||||
|
Name of consistency check to run: "repository",
|
||||||
|
"archives", "data", and/or "extract". Set to
|
||||||
|
"disabled" to disable all consistency checks.
|
||||||
|
"repository" checks the consistency of the
|
||||||
|
repository, "archives" checks all of the
|
||||||
|
archives, "data" verifies the integrity of the
|
||||||
|
data within the archives, and "extract" does an
|
||||||
|
extraction dry-run of the most recent archive.
|
||||||
|
Note that "data" implies "archives".
|
||||||
|
example: repository
|
||||||
|
frequency:
|
||||||
|
type: string
|
||||||
|
description: |
|
||||||
|
How frequently to run this type of consistency
|
||||||
|
check (as a best effort). The value is a number
|
||||||
|
followed by a unit of time. E.g., "2 weeks" to
|
||||||
|
run this consistency check no more than every
|
||||||
|
two weeks for a given repository or "1 month" to
|
||||||
|
run it no more than monthly. Defaults to
|
||||||
|
"always": running this check every time checks
|
||||||
|
are run.
|
||||||
|
example: 2 weeks
|
||||||
description: |
|
description: |
|
||||||
List of one or more consistency checks to run: "repository",
|
List of one or more consistency checks to run on a periodic
|
||||||
"archives", "data", and/or "extract". Defaults to
|
basis (if "frequency" is set) or every time borgmatic runs
|
||||||
"repository" and "archives". Set to "disabled" to disable
|
checks (if "frequency" is omitted).
|
||||||
all consistency checks. "repository" checks the consistency
|
|
||||||
of the repository, "archives" checks all of the archives,
|
|
||||||
"data" verifies the integrity of the data within the
|
|
||||||
archives, and "extract" does an extraction dry-run of the
|
|
||||||
most recent archive. Note that "data" implies "archives".
|
|
||||||
example:
|
|
||||||
- repository
|
|
||||||
- archives
|
|
||||||
check_repositories:
|
check_repositories:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
|
@ -859,8 +878,8 @@ properties:
|
||||||
enum: ['archive', 'directory']
|
enum: ['archive', 'directory']
|
||||||
description: |
|
description: |
|
||||||
Database dump output format. One of "archive",
|
Database dump output format. One of "archive",
|
||||||
or "directory". Defaults to "archive". See
|
or "directory". Defaults to "archive". See
|
||||||
mongodump documentation for details. Note that
|
mongodump documentation for details. Note that
|
||||||
format is ignored when the database name is
|
format is ignored when the database name is
|
||||||
"all".
|
"all".
|
||||||
example: directory
|
example: directory
|
||||||
|
@ -882,41 +901,99 @@ properties:
|
||||||
https://docs.mongodb.com/database-tools/mongorestore/ for
|
https://docs.mongodb.com/database-tools/mongorestore/ for
|
||||||
details.
|
details.
|
||||||
healthchecks:
|
healthchecks:
|
||||||
type: string
|
type: object
|
||||||
|
required: ['ping_url']
|
||||||
|
additionalProperties: false
|
||||||
|
properties:
|
||||||
|
ping_url:
|
||||||
|
type: string
|
||||||
|
description: |
|
||||||
|
Healthchecks ping URL or UUID to notify when a
|
||||||
|
backup begins, ends, or errors.
|
||||||
|
example: https://hc-ping.com/your-uuid-here
|
||||||
|
send_logs:
|
||||||
|
type: boolean
|
||||||
|
description: |
|
||||||
|
Send borgmatic logs to Healthchecks as part the
|
||||||
|
"finish" state. Defaults to true.
|
||||||
|
example: false
|
||||||
|
ping_body_limit:
|
||||||
|
type: integer
|
||||||
|
description: |
|
||||||
|
Number of bytes of borgmatic logs to send to
|
||||||
|
Healthchecks, ideally the same as PING_BODY_LIMIT
|
||||||
|
configured on the Healthchecks server. Set to 0 to
|
||||||
|
send all logs and disable this truncation. Defaults
|
||||||
|
to 100000.
|
||||||
|
example: 200000
|
||||||
|
states:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
enum:
|
||||||
|
- start
|
||||||
|
- finish
|
||||||
|
- fail
|
||||||
|
uniqueItems: true
|
||||||
|
description: |
|
||||||
|
List of one or more monitoring states to ping for:
|
||||||
|
"start", "finish", and/or "fail". Defaults to
|
||||||
|
pinging for all states.
|
||||||
|
example:
|
||||||
|
- finish
|
||||||
description: |
|
description: |
|
||||||
Healthchecks ping URL or UUID to notify when a backup
|
Configuration for a monitoring integration with
|
||||||
begins, ends, or errors. Create an account at
|
Healthchecks. Create an account at https://healthchecks.io
|
||||||
https://healthchecks.io if you'd like to use this service.
|
(or self-host Healthchecks) if you'd like to use this
|
||||||
See borgmatic monitoring documentation for details.
|
|
||||||
example:
|
|
||||||
https://hc-ping.com/your-uuid-here
|
|
||||||
cronitor:
|
|
||||||
type: string
|
|
||||||
description: |
|
|
||||||
Cronitor ping URL to notify when a backup begins, ends, or
|
|
||||||
errors. Create an account at https://cronitor.io if you'd
|
|
||||||
like to use this service. See borgmatic monitoring
|
|
||||||
documentation for details.
|
|
||||||
example:
|
|
||||||
https://cronitor.link/d3x0c1
|
|
||||||
pagerduty:
|
|
||||||
type: string
|
|
||||||
description: |
|
|
||||||
PagerDuty integration key used to notify PagerDuty when a
|
|
||||||
backup errors. Create an account at
|
|
||||||
https://www.pagerduty.com/ if you'd like to use this
|
|
||||||
service. See borgmatic monitoring documentation for details.
|
service. See borgmatic monitoring documentation for details.
|
||||||
example:
|
cronitor:
|
||||||
a177cad45bd374409f78906a810a3074
|
type: object
|
||||||
cronhub:
|
required: ['ping_url']
|
||||||
type: string
|
additionalProperties: false
|
||||||
|
properties:
|
||||||
|
ping_url:
|
||||||
|
type: string
|
||||||
|
description: |
|
||||||
|
Cronitor ping URL to notify when a backup begins,
|
||||||
|
ends, or errors.
|
||||||
|
example: https://cronitor.link/d3x0c1
|
||||||
description: |
|
description: |
|
||||||
Cronhub ping URL to notify when a backup begins, ends, or
|
Configuration for a monitoring integration with Cronitor.
|
||||||
errors. Create an account at https://cronhub.io if you'd
|
Create an account at https://cronitor.io if you'd
|
||||||
like to use this service. See borgmatic monitoring
|
like to use this service. See borgmatic monitoring
|
||||||
documentation for details.
|
documentation for details.
|
||||||
example:
|
pagerduty:
|
||||||
https://cronhub.io/start/1f5e3410-254c-11e8-b61d-55875966d01
|
type: object
|
||||||
|
required: ['integration_key']
|
||||||
|
additionalProperties: false
|
||||||
|
properties:
|
||||||
|
integration_key:
|
||||||
|
type: string
|
||||||
|
description: |
|
||||||
|
PagerDuty integration key used to notify PagerDuty
|
||||||
|
when a backup errors.
|
||||||
|
example: a177cad45bd374409f78906a810a3074
|
||||||
|
description: |
|
||||||
|
Configuration for a monitoring integration with PagerDuty.
|
||||||
|
Create an account at https://www.pagerduty.com/ if you'd
|
||||||
|
like to use this service. See borgmatic monitoring
|
||||||
|
documentation for details.
|
||||||
|
cronhub:
|
||||||
|
type: object
|
||||||
|
required: ['ping_url']
|
||||||
|
additionalProperties: false
|
||||||
|
properties:
|
||||||
|
ping_url:
|
||||||
|
type: string
|
||||||
|
description: |
|
||||||
|
Cronhub ping URL to notify when a backup begins,
|
||||||
|
ends, or errors.
|
||||||
|
example: https://cronhub.io/ping/1f5e3410-254c-5587
|
||||||
|
description: |
|
||||||
|
Configuration for a monitoring integration with Crunhub.
|
||||||
|
Create an account at https://cronhub.io if you'd like to
|
||||||
|
use this service. See borgmatic monitoring documentation
|
||||||
|
for details.
|
||||||
umask:
|
umask:
|
||||||
type: integer
|
type: integer
|
||||||
description: |
|
description: |
|
||||||
|
|
|
@ -65,15 +65,6 @@ def apply_logical_validation(config_filename, parsed_configuration):
|
||||||
below), run through any additional logical validation checks. If there are any such validation
|
below), run through any additional logical validation checks. If there are any such validation
|
||||||
problems, raise a Validation_error.
|
problems, raise a Validation_error.
|
||||||
'''
|
'''
|
||||||
archive_name_format = parsed_configuration.get('storage', {}).get('archive_name_format')
|
|
||||||
prefix = parsed_configuration.get('retention', {}).get('prefix')
|
|
||||||
|
|
||||||
if archive_name_format and not prefix:
|
|
||||||
raise Validation_error(
|
|
||||||
config_filename,
|
|
||||||
('If you provide an archive_name_format, you must also specify a retention prefix.',),
|
|
||||||
)
|
|
||||||
|
|
||||||
location_repositories = parsed_configuration.get('location', {}).get('repositories')
|
location_repositories = parsed_configuration.get('location', {}).get('repositories')
|
||||||
check_repositories = parsed_configuration.get('consistency', {}).get('check_repositories', [])
|
check_repositories = parsed_configuration.get('consistency', {}).get('check_repositories', [])
|
||||||
for repository in check_repositories:
|
for repository in check_repositories:
|
||||||
|
|
|
@ -1,5 +1,6 @@
|
||||||
import logging
|
import logging
|
||||||
import os
|
import os
|
||||||
|
import re
|
||||||
|
|
||||||
from borgmatic import execute
|
from borgmatic import execute
|
||||||
|
|
||||||
|
@ -9,14 +10,19 @@ logger = logging.getLogger(__name__)
|
||||||
SOFT_FAIL_EXIT_CODE = 75
|
SOFT_FAIL_EXIT_CODE = 75
|
||||||
|
|
||||||
|
|
||||||
def interpolate_context(command, context):
|
def interpolate_context(config_filename, hook_description, command, context):
|
||||||
'''
|
'''
|
||||||
Given a single hook command and a dict of context names/values, interpolate the values by
|
Given a config filename, a hook description, a single hook command, and a dict of context
|
||||||
"{name}" into the command and return the result.
|
names/values, interpolate the values by "{name}" into the command and return the result.
|
||||||
'''
|
'''
|
||||||
for name, value in context.items():
|
for name, value in context.items():
|
||||||
command = command.replace('{%s}' % name, str(value))
|
command = command.replace('{%s}' % name, str(value))
|
||||||
|
|
||||||
|
for unsupported_variable in re.findall(r'{\w+}', command):
|
||||||
|
logger.warning(
|
||||||
|
f"{config_filename}: Variable '{unsupported_variable}' is not supported in {hook_description} hook"
|
||||||
|
)
|
||||||
|
|
||||||
return command
|
return command
|
||||||
|
|
||||||
|
|
||||||
|
@ -26,8 +32,7 @@ def execute_hook(commands, umask, config_filename, description, dry_run, **conte
|
||||||
a hook description, and whether this is a dry run, run the given commands. Or, don't run them
|
a hook description, and whether this is a dry run, run the given commands. Or, don't run them
|
||||||
if this is a dry run.
|
if this is a dry run.
|
||||||
|
|
||||||
The context contains optional values interpolated by name into the hook commands. Currently,
|
The context contains optional values interpolated by name into the hook commands.
|
||||||
this only applies to the on_error hook.
|
|
||||||
|
|
||||||
Raise ValueError if the umask cannot be parsed.
|
Raise ValueError if the umask cannot be parsed.
|
||||||
Raise subprocesses.CalledProcessError if an error occurs in a hook.
|
Raise subprocesses.CalledProcessError if an error occurs in a hook.
|
||||||
|
@ -39,7 +44,9 @@ def execute_hook(commands, umask, config_filename, description, dry_run, **conte
|
||||||
dry_run_label = ' (dry run; not actually running hooks)' if dry_run else ''
|
dry_run_label = ' (dry run; not actually running hooks)' if dry_run else ''
|
||||||
|
|
||||||
context['configuration_filename'] = config_filename
|
context['configuration_filename'] = config_filename
|
||||||
commands = [interpolate_context(command, context) for command in commands]
|
commands = [
|
||||||
|
interpolate_context(config_filename, description, command, context) for command in commands
|
||||||
|
]
|
||||||
|
|
||||||
if len(commands) == 1:
|
if len(commands) == 1:
|
||||||
logger.info(
|
logger.info(
|
||||||
|
|
|
@ -22,14 +22,18 @@ def initialize_monitor(
|
||||||
pass
|
pass
|
||||||
|
|
||||||
|
|
||||||
def ping_monitor(ping_url, config_filename, state, monitoring_log_level, dry_run):
|
def ping_monitor(hook_config, config_filename, state, monitoring_log_level, dry_run):
|
||||||
'''
|
'''
|
||||||
Ping the given Cronhub URL, modified with the monitor.State. Use the given configuration
|
Ping the configured Cronhub URL, modified with the monitor.State. Use the given configuration
|
||||||
filename in any log entries. If this is a dry run, then don't actually ping anything.
|
filename in any log entries. If this is a dry run, then don't actually ping anything.
|
||||||
'''
|
'''
|
||||||
dry_run_label = ' (dry run; not actually pinging)' if dry_run else ''
|
dry_run_label = ' (dry run; not actually pinging)' if dry_run else ''
|
||||||
formatted_state = '/{}/'.format(MONITOR_STATE_TO_CRONHUB[state])
|
formatted_state = '/{}/'.format(MONITOR_STATE_TO_CRONHUB[state])
|
||||||
ping_url = ping_url.replace('/start/', formatted_state).replace('/ping/', formatted_state)
|
ping_url = (
|
||||||
|
hook_config['ping_url']
|
||||||
|
.replace('/start/', formatted_state)
|
||||||
|
.replace('/ping/', formatted_state)
|
||||||
|
)
|
||||||
|
|
||||||
logger.info(
|
logger.info(
|
||||||
'{}: Pinging Cronhub {}{}'.format(config_filename, state.name.lower(), dry_run_label)
|
'{}: Pinging Cronhub {}{}'.format(config_filename, state.name.lower(), dry_run_label)
|
||||||
|
@ -38,7 +42,10 @@ def ping_monitor(ping_url, config_filename, state, monitoring_log_level, dry_run
|
||||||
|
|
||||||
if not dry_run:
|
if not dry_run:
|
||||||
logging.getLogger('urllib3').setLevel(logging.ERROR)
|
logging.getLogger('urllib3').setLevel(logging.ERROR)
|
||||||
requests.get(ping_url)
|
try:
|
||||||
|
requests.get(ping_url)
|
||||||
|
except requests.exceptions.RequestException as error:
|
||||||
|
logger.warning(f'{config_filename}: Cronhub error: {error}')
|
||||||
|
|
||||||
|
|
||||||
def destroy_monitor(
|
def destroy_monitor(
|
||||||
|
|
|
@ -22,13 +22,13 @@ def initialize_monitor(
|
||||||
pass
|
pass
|
||||||
|
|
||||||
|
|
||||||
def ping_monitor(ping_url, config_filename, state, monitoring_log_level, dry_run):
|
def ping_monitor(hook_config, config_filename, state, monitoring_log_level, dry_run):
|
||||||
'''
|
'''
|
||||||
Ping the given Cronitor URL, modified with the monitor.State. Use the given configuration
|
Ping the configured Cronitor URL, modified with the monitor.State. Use the given configuration
|
||||||
filename in any log entries. If this is a dry run, then don't actually ping anything.
|
filename in any log entries. If this is a dry run, then don't actually ping anything.
|
||||||
'''
|
'''
|
||||||
dry_run_label = ' (dry run; not actually pinging)' if dry_run else ''
|
dry_run_label = ' (dry run; not actually pinging)' if dry_run else ''
|
||||||
ping_url = '{}/{}'.format(ping_url, MONITOR_STATE_TO_CRONITOR[state])
|
ping_url = '{}/{}'.format(hook_config['ping_url'], MONITOR_STATE_TO_CRONITOR[state])
|
||||||
|
|
||||||
logger.info(
|
logger.info(
|
||||||
'{}: Pinging Cronitor {}{}'.format(config_filename, state.name.lower(), dry_run_label)
|
'{}: Pinging Cronitor {}{}'.format(config_filename, state.name.lower(), dry_run_label)
|
||||||
|
@ -37,7 +37,10 @@ def ping_monitor(ping_url, config_filename, state, monitoring_log_level, dry_run
|
||||||
|
|
||||||
if not dry_run:
|
if not dry_run:
|
||||||
logging.getLogger('urllib3').setLevel(logging.ERROR)
|
logging.getLogger('urllib3').setLevel(logging.ERROR)
|
||||||
requests.get(ping_url)
|
try:
|
||||||
|
requests.get(ping_url)
|
||||||
|
except requests.exceptions.RequestException as error:
|
||||||
|
logger.warning(f'{config_filename}: Cronitor error: {error}')
|
||||||
|
|
||||||
|
|
||||||
def destroy_monitor(
|
def destroy_monitor(
|
||||||
|
|
|
@ -2,7 +2,7 @@ import logging
|
||||||
import os
|
import os
|
||||||
import shutil
|
import shutil
|
||||||
|
|
||||||
from borgmatic.borg.create import DEFAULT_BORGMATIC_SOURCE_DIRECTORY
|
from borgmatic.borg.state import DEFAULT_BORGMATIC_SOURCE_DIRECTORY
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
|
@ -13,13 +13,14 @@ MONITOR_STATE_TO_HEALTHCHECKS = {
|
||||||
}
|
}
|
||||||
|
|
||||||
PAYLOAD_TRUNCATION_INDICATOR = '...\n'
|
PAYLOAD_TRUNCATION_INDICATOR = '...\n'
|
||||||
PAYLOAD_LIMIT_BYTES = 10 * 1024 - len(PAYLOAD_TRUNCATION_INDICATOR)
|
DEFAULT_PING_BODY_LIMIT_BYTES = 100000
|
||||||
|
|
||||||
|
|
||||||
class Forgetful_buffering_handler(logging.Handler):
|
class Forgetful_buffering_handler(logging.Handler):
|
||||||
'''
|
'''
|
||||||
A buffering log handler that stores log messages in memory, and throws away messages (oldest
|
A buffering log handler that stores log messages in memory, and throws away messages (oldest
|
||||||
first) once a particular capacity in bytes is reached.
|
first) once a particular capacity in bytes is reached. But if the given byte capacity is zero,
|
||||||
|
don't throw away any messages.
|
||||||
'''
|
'''
|
||||||
|
|
||||||
def __init__(self, byte_capacity, log_level):
|
def __init__(self, byte_capacity, log_level):
|
||||||
|
@ -36,6 +37,9 @@ class Forgetful_buffering_handler(logging.Handler):
|
||||||
self.byte_count += len(message)
|
self.byte_count += len(message)
|
||||||
self.buffer.append(message)
|
self.buffer.append(message)
|
||||||
|
|
||||||
|
if not self.byte_capacity:
|
||||||
|
return
|
||||||
|
|
||||||
while self.byte_count > self.byte_capacity and self.buffer:
|
while self.byte_count > self.byte_capacity and self.buffer:
|
||||||
self.byte_count -= len(self.buffer[0])
|
self.byte_count -= len(self.buffer[0])
|
||||||
self.buffer.pop(0)
|
self.buffer.pop(0)
|
||||||
|
@ -65,31 +69,45 @@ def format_buffered_logs_for_payload():
|
||||||
return payload
|
return payload
|
||||||
|
|
||||||
|
|
||||||
def initialize_monitor(
|
def initialize_monitor(hook_config, config_filename, monitoring_log_level, dry_run):
|
||||||
ping_url_or_uuid, config_filename, monitoring_log_level, dry_run
|
|
||||||
): # pragma: no cover
|
|
||||||
'''
|
'''
|
||||||
Add a handler to the root logger that stores in memory the most recent logs emitted. That
|
Add a handler to the root logger that stores in memory the most recent logs emitted. That way,
|
||||||
way, we can send them all to Healthchecks upon a finish or failure state.
|
we can send them all to Healthchecks upon a finish or failure state. But skip this if the
|
||||||
|
"send_logs" option is false.
|
||||||
'''
|
'''
|
||||||
|
if hook_config.get('send_logs') is False:
|
||||||
|
return
|
||||||
|
|
||||||
|
ping_body_limit = max(
|
||||||
|
hook_config.get('ping_body_limit', DEFAULT_PING_BODY_LIMIT_BYTES)
|
||||||
|
- len(PAYLOAD_TRUNCATION_INDICATOR),
|
||||||
|
0,
|
||||||
|
)
|
||||||
|
|
||||||
logging.getLogger().addHandler(
|
logging.getLogger().addHandler(
|
||||||
Forgetful_buffering_handler(PAYLOAD_LIMIT_BYTES, monitoring_log_level)
|
Forgetful_buffering_handler(ping_body_limit, monitoring_log_level)
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def ping_monitor(ping_url_or_uuid, config_filename, state, monitoring_log_level, dry_run):
|
def ping_monitor(hook_config, config_filename, state, monitoring_log_level, dry_run):
|
||||||
'''
|
'''
|
||||||
Ping the given Healthchecks URL or UUID, modified with the monitor.State. Use the given
|
Ping the configured Healthchecks URL or UUID, modified with the monitor.State. Use the given
|
||||||
configuration filename in any log entries, and log to Healthchecks with the giving log level.
|
configuration filename in any log entries, and log to Healthchecks with the giving log level.
|
||||||
If this is a dry run, then don't actually ping anything.
|
If this is a dry run, then don't actually ping anything.
|
||||||
'''
|
'''
|
||||||
ping_url = (
|
ping_url = (
|
||||||
ping_url_or_uuid
|
hook_config['ping_url']
|
||||||
if ping_url_or_uuid.startswith('http')
|
if hook_config['ping_url'].startswith('http')
|
||||||
else 'https://hc-ping.com/{}'.format(ping_url_or_uuid)
|
else 'https://hc-ping.com/{}'.format(hook_config['ping_url'])
|
||||||
)
|
)
|
||||||
dry_run_label = ' (dry run; not actually pinging)' if dry_run else ''
|
dry_run_label = ' (dry run; not actually pinging)' if dry_run else ''
|
||||||
|
|
||||||
|
if 'states' in hook_config and state.name.lower() not in hook_config['states']:
|
||||||
|
logger.info(
|
||||||
|
f'{config_filename}: Skipping Healthchecks {state.name.lower()} ping due to configured states'
|
||||||
|
)
|
||||||
|
return
|
||||||
|
|
||||||
healthchecks_state = MONITOR_STATE_TO_HEALTHCHECKS.get(state)
|
healthchecks_state = MONITOR_STATE_TO_HEALTHCHECKS.get(state)
|
||||||
if healthchecks_state:
|
if healthchecks_state:
|
||||||
ping_url = '{}/{}'.format(ping_url, healthchecks_state)
|
ping_url = '{}/{}'.format(ping_url, healthchecks_state)
|
||||||
|
@ -106,10 +124,13 @@ def ping_monitor(ping_url_or_uuid, config_filename, state, monitoring_log_level,
|
||||||
|
|
||||||
if not dry_run:
|
if not dry_run:
|
||||||
logging.getLogger('urllib3').setLevel(logging.ERROR)
|
logging.getLogger('urllib3').setLevel(logging.ERROR)
|
||||||
requests.post(ping_url, data=payload.encode('utf-8'))
|
try:
|
||||||
|
requests.post(ping_url, data=payload.encode('utf-8'))
|
||||||
|
except requests.exceptions.RequestException as error:
|
||||||
|
logger.warning(f'{config_filename}: Healthchecks error: {error}')
|
||||||
|
|
||||||
|
|
||||||
def destroy_monitor(ping_url_or_uuid, config_filename, monitoring_log_level, dry_run):
|
def destroy_monitor(hook_config, config_filename, monitoring_log_level, dry_run):
|
||||||
'''
|
'''
|
||||||
Remove the monitor handler that was added to the root logger. This prevents the handler from
|
Remove the monitor handler that was added to the root logger. This prevents the handler from
|
||||||
getting reused by other instances of this monitor.
|
getting reused by other instances of this monitor.
|
||||||
|
|
|
@ -21,10 +21,10 @@ def initialize_monitor(
|
||||||
pass
|
pass
|
||||||
|
|
||||||
|
|
||||||
def ping_monitor(integration_key, config_filename, state, monitoring_log_level, dry_run):
|
def ping_monitor(hook_config, config_filename, state, monitoring_log_level, dry_run):
|
||||||
'''
|
'''
|
||||||
If this is an error state, create a PagerDuty event with the given integration key. Use the
|
If this is an error state, create a PagerDuty event with the configured integration key. Use
|
||||||
given configuration filename in any log entries. If this is a dry run, then don't actually
|
the given configuration filename in any log entries. If this is a dry run, then don't actually
|
||||||
create an event.
|
create an event.
|
||||||
'''
|
'''
|
||||||
if state != monitor.State.FAIL:
|
if state != monitor.State.FAIL:
|
||||||
|
@ -47,7 +47,7 @@ def ping_monitor(integration_key, config_filename, state, monitoring_log_level,
|
||||||
)
|
)
|
||||||
payload = json.dumps(
|
payload = json.dumps(
|
||||||
{
|
{
|
||||||
'routing_key': integration_key,
|
'routing_key': hook_config['integration_key'],
|
||||||
'event_action': 'trigger',
|
'event_action': 'trigger',
|
||||||
'payload': {
|
'payload': {
|
||||||
'summary': 'backup failed on {}'.format(hostname),
|
'summary': 'backup failed on {}'.format(hostname),
|
||||||
|
@ -68,7 +68,10 @@ def ping_monitor(integration_key, config_filename, state, monitoring_log_level,
|
||||||
logger.debug('{}: Using PagerDuty payload: {}'.format(config_filename, payload))
|
logger.debug('{}: Using PagerDuty payload: {}'.format(config_filename, payload))
|
||||||
|
|
||||||
logging.getLogger('urllib3').setLevel(logging.ERROR)
|
logging.getLogger('urllib3').setLevel(logging.ERROR)
|
||||||
requests.post(EVENTS_API_URL, data=payload.encode('utf-8'))
|
try:
|
||||||
|
requests.post(EVENTS_API_URL, data=payload.encode('utf-8'))
|
||||||
|
except requests.exceptions.RequestException as error:
|
||||||
|
logger.warning(f'{config_filename}: PagerDuty error: {error}')
|
||||||
|
|
||||||
|
|
||||||
def destroy_monitor(
|
def destroy_monitor(
|
||||||
|
|
|
@ -1,23 +1,34 @@
|
||||||
|
import logging
|
||||||
import os
|
import os
|
||||||
import signal
|
import signal
|
||||||
|
import sys
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
def _handle_signal(signal_number, frame): # pragma: no cover
|
EXIT_CODE_FROM_SIGNAL = 128
|
||||||
|
|
||||||
|
|
||||||
|
def handle_signal(signal_number, frame):
|
||||||
'''
|
'''
|
||||||
Send the signal to all processes in borgmatic's process group, which includes child processes.
|
Send the signal to all processes in borgmatic's process group, which includes child processes.
|
||||||
'''
|
'''
|
||||||
# Prevent infinite signal handler recursion. If the parent frame is this very same handler
|
# Prevent infinite signal handler recursion. If the parent frame is this very same handler
|
||||||
# function, we know we're recursing.
|
# function, we know we're recursing.
|
||||||
if frame.f_back.f_code.co_name == _handle_signal.__name__:
|
if frame.f_back.f_code.co_name == handle_signal.__name__:
|
||||||
return
|
return
|
||||||
|
|
||||||
os.killpg(os.getpgrp(), signal_number)
|
os.killpg(os.getpgrp(), signal_number)
|
||||||
|
|
||||||
|
if signal_number == signal.SIGTERM:
|
||||||
|
logger.critical('Exiting due to TERM signal')
|
||||||
|
sys.exit(EXIT_CODE_FROM_SIGNAL + signal.SIGTERM)
|
||||||
|
|
||||||
def configure_signals(): # pragma: no cover
|
|
||||||
|
def configure_signals():
|
||||||
'''
|
'''
|
||||||
Configure borgmatic's signal handlers to pass relevant signals through to any child processes
|
Configure borgmatic's signal handlers to pass relevant signals through to any child processes
|
||||||
like Borg. Note that SIGINT gets passed through even without these changes.
|
like Borg. Note that SIGINT gets passed through even without these changes.
|
||||||
'''
|
'''
|
||||||
for signal_number in (signal.SIGHUP, signal.SIGTERM, signal.SIGUSR1, signal.SIGUSR2):
|
for signal_number in (signal.SIGHUP, signal.SIGTERM, signal.SIGUSR1, signal.SIGUSR2):
|
||||||
signal.signal(signal_number, _handle_signal)
|
signal.signal(signal_number, handle_signal)
|
||||||
|
|
|
@ -1,17 +1,18 @@
|
||||||
---
|
---
|
||||||
title: How to add preparation and cleanup steps to backups
|
title: How to add preparation and cleanup steps to backups
|
||||||
eleventyNavigation:
|
eleventyNavigation:
|
||||||
key: Add preparation and cleanup steps
|
key: 🧹 Add preparation and cleanup steps
|
||||||
parent: How-to guides
|
parent: How-to guides
|
||||||
order: 8
|
order: 8
|
||||||
---
|
---
|
||||||
## Preparation and cleanup hooks
|
## Preparation and cleanup hooks
|
||||||
|
|
||||||
If you find yourself performing prepraration tasks before your backup runs, or
|
If you find yourself performing preparation tasks before your backup runs, or
|
||||||
cleanup work afterwards, borgmatic hooks may be of interest. Hooks are shell
|
cleanup work afterwards, borgmatic hooks may be of interest. Hooks are shell
|
||||||
commands that borgmatic executes for you at various points, and they're
|
commands that borgmatic executes for you at various points as it runs, and
|
||||||
configured in the `hooks` section of your configuration file. But if you're
|
they're configured in the `hooks` section of your configuration file. But if
|
||||||
looking to backup a database, it's probably easier to use the [database backup
|
you're looking to backup a database, it's probably easier to use the [database
|
||||||
|
backup
|
||||||
feature](https://torsion.org/borgmatic/docs/how-to/backup-your-databases/)
|
feature](https://torsion.org/borgmatic/docs/how-to/backup-your-databases/)
|
||||||
instead.
|
instead.
|
||||||
|
|
||||||
|
@ -27,15 +28,16 @@ hooks:
|
||||||
- umount /some/filesystem
|
- umount /some/filesystem
|
||||||
```
|
```
|
||||||
|
|
||||||
The `before_backup` and `after_backup` hooks each run once per configuration
|
The `before_backup` and `after_backup` hooks each run once per repository in a
|
||||||
file. `before_backup` hooks run prior to backups of all repositories in a
|
configuration file. `before_backup` hooks runs right before the `create`
|
||||||
configuration file, right before the `create` action. `after_backup` hooks run
|
action for a particular repository, and `after_backup` hooks run afterwards,
|
||||||
afterwards, but not if an error occurs in a previous hook or in the backups
|
but not if an error occurs in a previous hook or in the backups themselves.
|
||||||
themselves.
|
(Prior to borgmatic 1.6.0, these hooks instead ran once per configuration file
|
||||||
|
rather than once per repository.)
|
||||||
|
|
||||||
There are additional hooks that run before/after other actions as well. For
|
There are additional hooks that run before/after other actions as well. For
|
||||||
instance, `before_prune` runs before a `prune` action, while `after_prune`
|
instance, `before_prune` runs before a `prune` action for a repository, while
|
||||||
runs after it.
|
`after_prune` runs after it.
|
||||||
|
|
||||||
## Variable interpolation
|
## Variable interpolation
|
||||||
|
|
||||||
|
@ -46,24 +48,24 @@ separate shell script:
|
||||||
```yaml
|
```yaml
|
||||||
hooks:
|
hooks:
|
||||||
after_prune:
|
after_prune:
|
||||||
- record-prune.sh "{configuration_filename}" "{repositories}"
|
- record-prune.sh "{configuration_filename}" "{repository}"
|
||||||
```
|
```
|
||||||
|
|
||||||
In this example, when the hook is triggered, borgmatic interpolates runtime
|
In this example, when the hook is triggered, borgmatic interpolates runtime
|
||||||
values into the hook command: the borgmatic configuration filename and the
|
values into the hook command: the borgmatic configuration filename and the
|
||||||
paths of all configured repositories. Here's the full set of supported
|
paths of the current Borg repository. Here's the full set of supported
|
||||||
variables you can use here:
|
variables you can use here:
|
||||||
|
|
||||||
* `configuration_filename`: borgmatic configuration filename in which the
|
* `configuration_filename`: borgmatic configuration filename in which the
|
||||||
hook was defined
|
hook was defined
|
||||||
* `repositories`: comma-separated paths of all repositories configured in the
|
* `repository`: path of the current repository as configured in the current
|
||||||
current borgmatic configuration file
|
borgmatic configuration file
|
||||||
|
|
||||||
|
## Global hooks
|
||||||
|
|
||||||
You can also use `before_everything` and `after_everything` hooks to perform
|
You can also use `before_everything` and `after_everything` hooks to perform
|
||||||
global setup or cleanup:
|
global setup or cleanup:
|
||||||
|
|
||||||
## Global hooks
|
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
hooks:
|
hooks:
|
||||||
before_everything:
|
before_everything:
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: How to backup to a removable drive or an intermittent server
|
title: How to backup to a removable drive or an intermittent server
|
||||||
eleventyNavigation:
|
eleventyNavigation:
|
||||||
key: Backup to a removable drive or server
|
key: 💾 Backup to a removable drive/server
|
||||||
parent: How-to guides
|
parent: How-to guides
|
||||||
order: 9
|
order: 9
|
||||||
---
|
---
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: How to backup your databases
|
title: How to backup your databases
|
||||||
eleventyNavigation:
|
eleventyNavigation:
|
||||||
key: Backup your databases
|
key: 🗄️ Backup your databases
|
||||||
parent: How-to guides
|
parent: How-to guides
|
||||||
order: 7
|
order: 7
|
||||||
---
|
---
|
||||||
|
@ -33,7 +33,8 @@ As part of each backup, borgmatic streams a database dump for each configured
|
||||||
database directly to Borg, so it's included in the backup without consuming
|
database directly to Borg, so it's included in the backup without consuming
|
||||||
additional disk space. (The exceptions are the PostgreSQL/MongoDB "directory"
|
additional disk space. (The exceptions are the PostgreSQL/MongoDB "directory"
|
||||||
dump formats, which can't stream and therefore do consume temporary disk
|
dump formats, which can't stream and therefore do consume temporary disk
|
||||||
space.)
|
space. Additionally, prior to borgmatic 1.5.3, all database dumps consumed
|
||||||
|
temporary disk space.)
|
||||||
|
|
||||||
To support this, borgmatic creates temporary named pipes in `~/.borgmatic` by
|
To support this, borgmatic creates temporary named pipes in `~/.borgmatic` by
|
||||||
default. To customize this path, set the `borgmatic_source_directory` option
|
default. To customize this path, set the `borgmatic_source_directory` option
|
||||||
|
@ -209,9 +210,16 @@ to exclude are `/dev` and `/run`, but that may not be exhaustive.
|
||||||
|
|
||||||
If you prefer to restore a database without the help of borgmatic, first
|
If you prefer to restore a database without the help of borgmatic, first
|
||||||
[extract](https://torsion.org/borgmatic/docs/how-to/extract-a-backup/) an
|
[extract](https://torsion.org/borgmatic/docs/how-to/extract-a-backup/) an
|
||||||
archive containing a database dump, and then manually restore the dump file
|
archive containing a database dump.
|
||||||
found within the extracted `~/.borgmatic/` path (e.g. with `pg_restore`,
|
|
||||||
`mysql`, or `mongorestore`, commands).
|
borgmatic extracts the dump file into the *`username`*`/.borgmatic/` directory
|
||||||
|
within the extraction destination path, where *`username`* is the user that
|
||||||
|
created the backup. For example, if you created the backup with the `root`
|
||||||
|
user and you're extracting to `/tmp`, then the dump will be in
|
||||||
|
`/tmp/root/.borgmatic`.
|
||||||
|
|
||||||
|
After extraction, you can manually restore the dump file using native database
|
||||||
|
commands like `pg_restore`, `mysql`, `mongorestore` or similar.
|
||||||
|
|
||||||
|
|
||||||
## Preparation and cleanup hooks
|
## Preparation and cleanup hooks
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: How to deal with very large backups
|
title: How to deal with very large backups
|
||||||
eleventyNavigation:
|
eleventyNavigation:
|
||||||
key: Deal with very large backups
|
key: 📏 Deal with very large backups
|
||||||
parent: How-to guides
|
parent: How-to guides
|
||||||
order: 3
|
order: 3
|
||||||
---
|
---
|
||||||
|
@ -49,7 +49,7 @@ consistency checks with `check` on a much less frequent basis (e.g. with
|
||||||
|
|
||||||
Another option is to customize your consistency checks. The default
|
Another option is to customize your consistency checks. The default
|
||||||
consistency checks run both full-repository checks and per-archive checks
|
consistency checks run both full-repository checks and per-archive checks
|
||||||
within each repository.
|
within each repository no more than once a month.
|
||||||
|
|
||||||
But if you find that archive checks are too slow, for example, you can
|
But if you find that archive checks are too slow, for example, you can
|
||||||
configure borgmatic to run repository checks only. Configure this in the
|
configure borgmatic to run repository checks only. Configure this in the
|
||||||
|
@ -58,9 +58,11 @@ configure borgmatic to run repository checks only. Configure this in the
|
||||||
```yaml
|
```yaml
|
||||||
consistency:
|
consistency:
|
||||||
checks:
|
checks:
|
||||||
- repository
|
- name: repository
|
||||||
```
|
```
|
||||||
|
|
||||||
|
(Prior to borgmatic 1.6.2, `checks` was a plain list of strings without the `name:` part.)
|
||||||
|
|
||||||
Here are the available checks from fastest to slowest:
|
Here are the available checks from fastest to slowest:
|
||||||
|
|
||||||
* `repository`: Checks the consistency of the repository itself.
|
* `repository`: Checks the consistency of the repository itself.
|
||||||
|
@ -70,6 +72,36 @@ Here are the available checks from fastest to slowest:
|
||||||
|
|
||||||
See [Borg's check documentation](https://borgbackup.readthedocs.io/en/stable/usage/check.html) for more information.
|
See [Borg's check documentation](https://borgbackup.readthedocs.io/en/stable/usage/check.html) for more information.
|
||||||
|
|
||||||
|
### Check frequency
|
||||||
|
|
||||||
|
As of borgmatic 1.6.2, you can optionally configure checks to run on a
|
||||||
|
periodic basis rather than every time borgmatic runs checks. For instance:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
consistency:
|
||||||
|
checks:
|
||||||
|
- name: repository
|
||||||
|
frequency: 2 weeks
|
||||||
|
```
|
||||||
|
|
||||||
|
This tells borgmatic to run this consistency check at most once every two
|
||||||
|
weeks for a given repository. The `frequency` value is a number followed by a
|
||||||
|
unit of time, e.g. "3 days", "1 week", "2 months", etc. The `frequency`
|
||||||
|
defaults to "always", which means run this check every time checks run.
|
||||||
|
|
||||||
|
Unlike a real scheduler like cron, borgmatic only makes a best effort to run
|
||||||
|
checks on the configured frequency. It compares that frequency with how long
|
||||||
|
it's been since the last check for a given repository (as recorded in a file
|
||||||
|
within `~/.borgmatic/checks`). If it hasn't been long enough, the check is
|
||||||
|
skipped. And you still have to run `borgmatic check` (or just `borgmatic`) in
|
||||||
|
order for checks to run, even when a `frequency` is configured!
|
||||||
|
|
||||||
|
If you want to temporarily ignore your configured frequencies, you can invoke
|
||||||
|
`borgmatic check --force` to run checks unconditionally.
|
||||||
|
|
||||||
|
|
||||||
|
### Disabling checks
|
||||||
|
|
||||||
If that's still too slow, you can disable consistency checks entirely,
|
If that's still too slow, you can disable consistency checks entirely,
|
||||||
either for a single repository or for all repositories.
|
either for a single repository or for all repositories.
|
||||||
|
|
||||||
|
@ -78,7 +110,7 @@ Disabling all consistency checks looks like this:
|
||||||
```yaml
|
```yaml
|
||||||
consistency:
|
consistency:
|
||||||
checks:
|
checks:
|
||||||
- disabled
|
- name: disabled
|
||||||
```
|
```
|
||||||
|
|
||||||
Or, if you have multiple repositories in your borgmatic configuration file,
|
Or, if you have multiple repositories in your borgmatic configuration file,
|
||||||
|
@ -99,7 +131,8 @@ borgmatic check --only data --only extract
|
||||||
```
|
```
|
||||||
|
|
||||||
This is useful for running slow consistency checks on an infrequent basis,
|
This is useful for running slow consistency checks on an infrequent basis,
|
||||||
separate from your regular checks.
|
separate from your regular checks. It is still subject to any configured
|
||||||
|
check frequencies unless the `--force` flag is used.
|
||||||
|
|
||||||
|
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: How to develop on borgmatic
|
title: How to develop on borgmatic
|
||||||
eleventyNavigation:
|
eleventyNavigation:
|
||||||
key: Develop on borgmatic
|
key: 🏗️ Develop on borgmatic
|
||||||
parent: How-to guides
|
parent: How-to guides
|
||||||
order: 12
|
order: 12
|
||||||
---
|
---
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: How to extract a backup
|
title: How to extract a backup
|
||||||
eleventyNavigation:
|
eleventyNavigation:
|
||||||
key: Extract a backup
|
key: 📤 Extract a backup
|
||||||
parent: How-to guides
|
parent: How-to guides
|
||||||
order: 6
|
order: 6
|
||||||
---
|
---
|
||||||
|
@ -116,7 +116,7 @@ Omit the `--archive` flag to mount all archives (lazy-loaded):
|
||||||
borgmatic mount --mount-point /mnt
|
borgmatic mount --mount-point /mnt
|
||||||
```
|
```
|
||||||
|
|
||||||
Or use the "latest" value for the archive to mount the latest successful archive:
|
Or use the "latest" value for the archive to mount the latest archive:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
borgmatic mount --archive latest --mount-point /mnt
|
borgmatic mount --archive latest --mount-point /mnt
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: How to inspect your backups
|
title: How to inspect your backups
|
||||||
eleventyNavigation:
|
eleventyNavigation:
|
||||||
key: Inspect your backups
|
key: 🔎 Inspect your backups
|
||||||
parent: How-to guides
|
parent: How-to guides
|
||||||
order: 4
|
order: 4
|
||||||
---
|
---
|
||||||
|
@ -51,6 +51,31 @@ borgmatic info
|
||||||
`--info`. Or upgrade borgmatic!)
|
`--info`. Or upgrade borgmatic!)
|
||||||
|
|
||||||
|
|
||||||
|
### Searching for a file
|
||||||
|
|
||||||
|
Let's say you've accidentally deleted a file and want to find the backup
|
||||||
|
archive(s) containing it. `borgmatic list` provides a `--find` flag for
|
||||||
|
exactly this purpose (as of borgmatic 1.6.3). For instance, if you're looking
|
||||||
|
for a `foo.txt`:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
borgmatic list --find foo.txt
|
||||||
|
```
|
||||||
|
|
||||||
|
This will list your archives and indicate those with files matching
|
||||||
|
`*foo.txt*` anywhere in the archive. The `--find` parameter can alternatively
|
||||||
|
be a [Borg
|
||||||
|
pattern](https://borgbackup.readthedocs.io/en/stable/usage/help.html#borg-patterns).
|
||||||
|
|
||||||
|
To limit the archives searched, use the standard `list` parameters for
|
||||||
|
filtering archives such as `--last`, `--archive`, `--glob-archives`, etc. For
|
||||||
|
example, to search only the last five archives:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
borgmatic list --find foo.txt --last 5
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
## Logging
|
## Logging
|
||||||
|
|
||||||
By default, borgmatic logs to a local syslog-compatible daemon if one is
|
By default, borgmatic logs to a local syslog-compatible daemon if one is
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: How to make backups redundant
|
title: How to make backups redundant
|
||||||
eleventyNavigation:
|
eleventyNavigation:
|
||||||
key: Make backups redundant
|
key: ☁️ Make backups redundant
|
||||||
parent: How-to guides
|
parent: How-to guides
|
||||||
order: 2
|
order: 2
|
||||||
---
|
---
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: How to make per-application backups
|
title: How to make per-application backups
|
||||||
eleventyNavigation:
|
eleventyNavigation:
|
||||||
key: Make per-application backups
|
key: 🔀 Make per-application backups
|
||||||
parent: How-to guides
|
parent: How-to guides
|
||||||
order: 1
|
order: 1
|
||||||
---
|
---
|
||||||
|
@ -32,10 +32,16 @@ perform any merging of configuration files by default. If you'd like borgmatic
|
||||||
to merge your configuration files, see below about configuration includes.
|
to merge your configuration files, see below about configuration includes.
|
||||||
|
|
||||||
Additionally, the `~/.config/borgmatic.d/` directory works the same way as
|
Additionally, the `~/.config/borgmatic.d/` directory works the same way as
|
||||||
`/etc/borgmatic.d`. If you need even more customizability, you can specify
|
`/etc/borgmatic.d`.
|
||||||
alternate configuration paths on the command-line with borgmatic's `--config`
|
|
||||||
flag. See `borgmatic --help` for more information.
|
|
||||||
|
|
||||||
|
If you need even more customizability, you can specify alternate configuration
|
||||||
|
paths on the command-line with borgmatic's `--config` flag. (See `borgmatic
|
||||||
|
--help` for more information.) For instance, if you want to schedule your
|
||||||
|
various borgmatic backups to run at different times, you'll need multiple
|
||||||
|
entries in your [scheduling software of
|
||||||
|
choice](https://torsion.org/borgmatic/docs/how-to/set-up-backups/#autopilot),
|
||||||
|
each entry using borgmatic's `--config` flag instead of relying on
|
||||||
|
`/etc/borgmatic.d`.
|
||||||
|
|
||||||
## Configuration includes
|
## Configuration includes
|
||||||
|
|
||||||
|
@ -69,6 +75,10 @@ themselves and complaining that they are not valid configuration files, you
|
||||||
should put them in a directory other than `/etc/borgmatic.d/`. (A subdirectory
|
should put them in a directory other than `/etc/borgmatic.d/`. (A subdirectory
|
||||||
is fine.)
|
is fine.)
|
||||||
|
|
||||||
|
When a configuration include is a relative path, borgmatic loads it from either
|
||||||
|
the current working directory or from the directory containing the file doing
|
||||||
|
the including.
|
||||||
|
|
||||||
Note that this form of include must be a YAML value rather than a key. For
|
Note that this form of include must be a YAML value rather than a key. For
|
||||||
example, this will not work:
|
example, this will not work:
|
||||||
|
|
||||||
|
@ -80,7 +90,7 @@ location:
|
||||||
!include /etc/borgmatic/common_retention.yaml
|
!include /etc/borgmatic/common_retention.yaml
|
||||||
```
|
```
|
||||||
|
|
||||||
But if you do want to merge in a YAML key and its values, keep reading!
|
But if you do want to merge in a YAML key *and* its values, keep reading!
|
||||||
|
|
||||||
|
|
||||||
## Include merging
|
## Include merging
|
||||||
|
@ -89,35 +99,44 @@ If you need to get even fancier and pull in common configuration options while
|
||||||
potentially overriding individual options, you can perform a YAML merge of
|
potentially overriding individual options, you can perform a YAML merge of
|
||||||
included configuration using the YAML `<<` key. For instance, here's an
|
included configuration using the YAML `<<` key. For instance, here's an
|
||||||
example of a main configuration file that pulls in two retention options via
|
example of a main configuration file that pulls in two retention options via
|
||||||
an include, and then overrides one of them locally:
|
an include and then overrides one of them locally:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
|
<<: !include /etc/borgmatic/common.yaml
|
||||||
|
|
||||||
location:
|
location:
|
||||||
...
|
...
|
||||||
|
|
||||||
retention:
|
retention:
|
||||||
keep_daily: 5
|
keep_daily: 5
|
||||||
<<: !include /etc/borgmatic/common_retention.yaml
|
|
||||||
```
|
```
|
||||||
|
|
||||||
This is what `common_retention.yaml` might look like:
|
This is what `common.yaml` might look like:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
keep_hourly: 24
|
retention:
|
||||||
keep_daily: 7
|
keep_hourly: 24
|
||||||
|
keep_daily: 7
|
||||||
```
|
```
|
||||||
|
|
||||||
Once this include gets merged in, the resulting configuration would have a
|
Once this include gets merged in, the resulting configuration would have a
|
||||||
`keep_hourly` value of `24` and an overridden `keep_daily` value of `5`.
|
`keep_hourly` value of `24` and an overridden `keep_daily` value of `5`.
|
||||||
|
|
||||||
When there is a collision of an option between the local file and the merged
|
When there's an option collision between the local file and the merged
|
||||||
include, the local file's option takes precedent. And note that this is a
|
include, the local file's option takes precedence. And as of borgmatic 1.6.0,
|
||||||
shallow merge rather than a deep merge, so the merging does not descend into
|
this feature performs a deep merge, meaning that values are merged at all
|
||||||
nested values.
|
levels in the two configuration files. Colliding list values are appended
|
||||||
|
together. This allows you to include common configuration—up to full borgmatic
|
||||||
|
configuration files—while overriding only the parts you want to customize.
|
||||||
|
|
||||||
Note that this `<<` include merging syntax is only for merging in mappings
|
Note that this `<<` include merging syntax is only for merging in mappings
|
||||||
(keys/values). If you'd like to include other types like scalars or lists
|
(configuration options and their values). But if you'd like to include a
|
||||||
directly, please see the section above about standard includes.
|
single value directly, please see the section above about standard includes.
|
||||||
|
|
||||||
|
Additionally, there is a limitation preventing multiple `<<` include merges
|
||||||
|
per section. So for instance, that means you can do one `<<` merge at the
|
||||||
|
global level, another `<<` within each configuration section, etc. (This is a
|
||||||
|
YAML limitation.)
|
||||||
|
|
||||||
|
|
||||||
## Configuration overrides
|
## Configuration overrides
|
||||||
|
@ -162,7 +181,14 @@ borgmatic create --override location.repositories=[test1.borg,test2.borg]
|
||||||
Or even a single list element:
|
Or even a single list element:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
borgmatic create --override location.repositories=[/root/test1.borg]
|
borgmatic create --override location.repositories=[/root/test.borg]
|
||||||
|
```
|
||||||
|
|
||||||
|
If your override value contains special YAML characters like colons, then
|
||||||
|
you'll need quotes for it to parse correctly:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
borgmatic create --override location.repositories="['user@server:test.borg']"
|
||||||
```
|
```
|
||||||
|
|
||||||
There is not currently a way to override a single element of a list without
|
There is not currently a way to override a single element of a list without
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: How to monitor your backups
|
title: How to monitor your backups
|
||||||
eleventyNavigation:
|
eleventyNavigation:
|
||||||
key: Monitor your backups
|
key: 🚨 Monitor your backups
|
||||||
parent: How-to guides
|
parent: How-to guides
|
||||||
order: 5
|
order: 5
|
||||||
---
|
---
|
||||||
|
@ -136,7 +136,8 @@ URL" for your project. Here's an example:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
hooks:
|
hooks:
|
||||||
healthchecks: https://hc-ping.com/addffa72-da17-40ae-be9c-ff591afb942a
|
healthchecks:
|
||||||
|
ping_url: https://hc-ping.com/addffa72-da17-40ae-be9c-ff591afb942a
|
||||||
```
|
```
|
||||||
|
|
||||||
With this hook in place, borgmatic pings your Healthchecks project when a
|
With this hook in place, borgmatic pings your Healthchecks project when a
|
||||||
|
@ -158,7 +159,10 @@ itself. But the logs are only included for errors that occur when a `prune`,
|
||||||
|
|
||||||
You can customize the verbosity of the logs that are sent to Healthchecks with
|
You can customize the verbosity of the logs that are sent to Healthchecks with
|
||||||
borgmatic's `--monitoring-verbosity` flag. The `--files` and `--stats` flags
|
borgmatic's `--monitoring-verbosity` flag. The `--files` and `--stats` flags
|
||||||
may also be of use. See `borgmatic --help` for more information.
|
may also be of use. See `borgmatic --help` for more information. Additionally,
|
||||||
|
see the [borgmatic configuration
|
||||||
|
file](https://torsion.org/borgmatic/docs/reference/configuration/) for
|
||||||
|
additional Healthchecks options.
|
||||||
|
|
||||||
You can configure Healthchecks to notify you by a [variety of
|
You can configure Healthchecks to notify you by a [variety of
|
||||||
mechanisms](https://healthchecks.io/#welcome-integrations) when backups fail
|
mechanisms](https://healthchecks.io/#welcome-integrations) when backups fail
|
||||||
|
@ -176,7 +180,8 @@ API URL" for your monitor. Here's an example:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
hooks:
|
hooks:
|
||||||
cronitor: https://cronitor.link/d3x0c1
|
cronitor:
|
||||||
|
ping_url: https://cronitor.link/d3x0c1
|
||||||
```
|
```
|
||||||
|
|
||||||
With this hook in place, borgmatic pings your Cronitor monitor when a backup
|
With this hook in place, borgmatic pings your Cronitor monitor when a backup
|
||||||
|
@ -204,7 +209,8 @@ URL" for your monitor. Here's an example:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
hooks:
|
hooks:
|
||||||
cronhub: https://cronhub.io/start/1f5e3410-254c-11e8-b61d-55875966d031
|
cronhub:
|
||||||
|
ping_url: https://cronhub.io/start/1f5e3410-254c-11e8-b61d-55875966d031
|
||||||
```
|
```
|
||||||
|
|
||||||
With this hook in place, borgmatic pings your Cronhub monitor when a backup
|
With this hook in place, borgmatic pings your Cronhub monitor when a backup
|
||||||
|
@ -246,7 +252,8 @@ Here's an example:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
hooks:
|
hooks:
|
||||||
pagerduty: a177cad45bd374409f78906a810a3074
|
pagerduty:
|
||||||
|
integration_key: a177cad45bd374409f78906a810a3074
|
||||||
```
|
```
|
||||||
|
|
||||||
With this hook in place, borgmatic creates a PagerDuty event for your service
|
With this hook in place, borgmatic creates a PagerDuty event for your service
|
||||||
|
@ -279,35 +286,12 @@ output only shows up at the console, and not in syslog.
|
||||||
* [Borgmacator GNOME AppIndicator](https://github.com/N-Coder/borgmacator/)
|
* [Borgmacator GNOME AppIndicator](https://github.com/N-Coder/borgmacator/)
|
||||||
|
|
||||||
|
|
||||||
### Successful backups
|
|
||||||
|
|
||||||
`borgmatic list` includes support for a `--successful` flag that only lists
|
|
||||||
successful (non-checkpoint) backups. This flag works via a basic heuristic: It
|
|
||||||
assumes that non-checkpoint archive names end with a digit (e.g. from a
|
|
||||||
timestamp), while checkpoint archive names do not. This means that if you're
|
|
||||||
using custom archive names that do not end in a digit, the `--successful` flag
|
|
||||||
will not work as expected.
|
|
||||||
|
|
||||||
Combined with a built-in Borg flag like `--last`, you can list the last
|
|
||||||
successful backup for use in your monitoring scripts. Here's an example
|
|
||||||
combined with `--json`:
|
|
||||||
|
|
||||||
```bash
|
|
||||||
borgmatic list --successful --last 1 --json
|
|
||||||
```
|
|
||||||
|
|
||||||
Note that this particular combination will only work if you've got a single
|
|
||||||
backup "series" in your repository. If you're instead backing up, say, from
|
|
||||||
multiple different hosts into a single repository, then you'll need to get
|
|
||||||
fancier with your archive listing. See `borg list --help` for more flags.
|
|
||||||
|
|
||||||
|
|
||||||
### Latest backups
|
### Latest backups
|
||||||
|
|
||||||
All borgmatic actions that accept an "--archive" flag allow you to specify an
|
All borgmatic actions that accept an "--archive" flag allow you to specify an
|
||||||
archive name of "latest". This lets you get the latest successful archive
|
archive name of "latest". This lets you get the latest archive without having
|
||||||
without having to first run "borgmatic list" manually, which can be handy in
|
to first run "borgmatic list" manually, which can be handy in automated
|
||||||
automated scripts. Here's an example:
|
scripts. Here's an example:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
borgmatic info --archive latest
|
borgmatic info --archive latest
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: How to run arbitrary Borg commands
|
title: How to run arbitrary Borg commands
|
||||||
eleventyNavigation:
|
eleventyNavigation:
|
||||||
key: Run arbitrary Borg commands
|
key: 🔧 Run arbitrary Borg commands
|
||||||
parent: How-to guides
|
parent: How-to guides
|
||||||
order: 10
|
order: 10
|
||||||
---
|
---
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: How to set up backups
|
title: How to set up backups
|
||||||
eleventyNavigation:
|
eleventyNavigation:
|
||||||
key: Set up backups
|
key: 📥 Set up backups
|
||||||
parent: How-to guides
|
parent: How-to guides
|
||||||
order: 0
|
order: 0
|
||||||
---
|
---
|
||||||
|
@ -28,7 +28,7 @@ sudo pip3 install --user --upgrade borgmatic
|
||||||
This installs borgmatic and its commands at the `/root/.local/bin` path.
|
This installs borgmatic and its commands at the `/root/.local/bin` path.
|
||||||
|
|
||||||
Your pip binary may have a different name than "pip3". Make sure you're using
|
Your pip binary may have a different name than "pip3". Make sure you're using
|
||||||
Python 3.6+, as borgmatic does not support Python 2.
|
Python 3.7+, as borgmatic does not support older versions of Python.
|
||||||
|
|
||||||
The next step is to ensure that borgmatic's commands available are on your
|
The next step is to ensure that borgmatic's commands available are on your
|
||||||
system `PATH`, so that you can run borgmatic:
|
system `PATH`, so that you can run borgmatic:
|
||||||
|
@ -51,6 +51,11 @@ sudo borgmatic --version
|
||||||
|
|
||||||
If borgmatic is properly installed, that should output your borgmatic version.
|
If borgmatic is properly installed, that should output your borgmatic version.
|
||||||
|
|
||||||
|
As an alternative to adding the path to `~/.bashrc` file, if you're using sudo
|
||||||
|
to run borgmatic, you can configure [sudo's
|
||||||
|
`secure_path` option](https://man.archlinux.org/man/sudoers.5) to include
|
||||||
|
borgmatic's path.
|
||||||
|
|
||||||
|
|
||||||
### Global install option
|
### Global install option
|
||||||
|
|
||||||
|
@ -78,7 +83,7 @@ Besides the approaches described above, there are several other options for
|
||||||
installing borgmatic:
|
installing borgmatic:
|
||||||
|
|
||||||
* [Docker image with scheduled backups](https://hub.docker.com/r/b3vis/borgmatic/) (+ Docker Compose files)
|
* [Docker image with scheduled backups](https://hub.docker.com/r/b3vis/borgmatic/) (+ Docker Compose files)
|
||||||
* [Docker base image](https://hub.docker.com/r/monachus/borgmatic/)
|
* [Docker image with multi-arch and Docker CLI support](https://hub.docker.com/r/modem7/borgmatic-docker/)
|
||||||
* [Debian](https://tracker.debian.org/pkg/borgmatic)
|
* [Debian](https://tracker.debian.org/pkg/borgmatic)
|
||||||
* [Ubuntu](https://launchpad.net/ubuntu/+source/borgmatic)
|
* [Ubuntu](https://launchpad.net/ubuntu/+source/borgmatic)
|
||||||
* [Fedora official](https://bodhi.fedoraproject.org/updates/?search=borgmatic)
|
* [Fedora official](https://bodhi.fedoraproject.org/updates/?search=borgmatic)
|
||||||
|
@ -87,8 +92,8 @@ installing borgmatic:
|
||||||
* [Alpine Linux](https://pkgs.alpinelinux.org/packages?name=borgmatic)
|
* [Alpine Linux](https://pkgs.alpinelinux.org/packages?name=borgmatic)
|
||||||
* [OpenBSD](http://ports.su/sysutils/borgmatic)
|
* [OpenBSD](http://ports.su/sysutils/borgmatic)
|
||||||
* [openSUSE](https://software.opensuse.org/package/borgmatic)
|
* [openSUSE](https://software.opensuse.org/package/borgmatic)
|
||||||
|
* [macOS (via Homebrew)](https://formulae.brew.sh/formula/borgmatic)
|
||||||
* [Ansible role](https://github.com/borgbase/ansible-role-borgbackup)
|
* [Ansible role](https://github.com/borgbase/ansible-role-borgbackup)
|
||||||
* [stand-alone binary](https://github.com/cmarquardt/borgmatic-binary)
|
|
||||||
* [virtualenv](https://virtualenv.pypa.io/en/stable/)
|
* [virtualenv](https://virtualenv.pypa.io/en/stable/)
|
||||||
|
|
||||||
|
|
||||||
|
@ -107,6 +112,7 @@ Additionally, [rsync.net](https://www.rsync.net/products/borg.html) and
|
||||||
[Hetzner](https://www.hetzner.com/storage/storage-box) have compatible storage
|
[Hetzner](https://www.hetzner.com/storage/storage-box) have compatible storage
|
||||||
offerings, but do not currently fund borgmatic development or hosting.
|
offerings, but do not currently fund borgmatic development or hosting.
|
||||||
|
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
After you install borgmatic, generate a sample configuration file:
|
After you install borgmatic, generate a sample configuration file:
|
||||||
|
@ -298,9 +304,43 @@ interested in an [unofficial work-around for Full Disk
|
||||||
Access](https://projects.torsion.org/borgmatic-collective/borgmatic/issues/293).
|
Access](https://projects.torsion.org/borgmatic-collective/borgmatic/issues/293).
|
||||||
|
|
||||||
|
|
||||||
## Colored output
|
## Niceties
|
||||||
|
|
||||||
Borgmatic produces colored terminal output by default. It is disabled when a
|
|
||||||
|
### Shell completion
|
||||||
|
|
||||||
|
borgmatic includes a shell completion script (currently only for Bash) to
|
||||||
|
support tab-completing borgmatic command-line actions and flags. Depending on
|
||||||
|
how you installed borgmatic, this may be enabled by default. But if it's not,
|
||||||
|
start by installing the `bash-completion` Linux package or the
|
||||||
|
[`bash-completion@2`](https://formulae.brew.sh/formula/bash-completion@2)
|
||||||
|
macOS Homebrew formula. Then, install the shell completion script globally:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo su -c "borgmatic --bash-completion > $(pkg-config --variable=completionsdir bash-completion)/borgmatic"
|
||||||
|
```
|
||||||
|
|
||||||
|
If you don't have `pkg-config` installed, you can try the following path
|
||||||
|
instead:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo su -c "borgmatic --bash-completion > /usr/share/bash-completion/completions/borgmatic"
|
||||||
|
```
|
||||||
|
|
||||||
|
Or, if you'd like to install the script for just the current user:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
mkdir --parents ~/.local/share/bash-completion/completions
|
||||||
|
borgmatic --bash-completion > ~/.local/share/bash-completion/completions/borgmatic
|
||||||
|
```
|
||||||
|
|
||||||
|
Finally, restart your shell (`exit` and open a new shell) so the completions
|
||||||
|
take effect.
|
||||||
|
|
||||||
|
|
||||||
|
### Colored output
|
||||||
|
|
||||||
|
borgmatic produces colored terminal output by default. It is disabled when a
|
||||||
non-interactive terminal is detected (like a cron job), or when you use the
|
non-interactive terminal is detected (like a cron job), or when you use the
|
||||||
`--json` flag. Otherwise, you can disable it by passing the `--no-color` flag,
|
`--json` flag. Otherwise, you can disable it by passing the `--no-color` flag,
|
||||||
setting the environment variable `PY_COLORS=False`, or setting the `color`
|
setting the environment variable `PY_COLORS=False`, or setting the `color`
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: How to upgrade borgmatic
|
title: How to upgrade borgmatic
|
||||||
eleventyNavigation:
|
eleventyNavigation:
|
||||||
key: Upgrade borgmatic
|
key: 📦 Upgrade borgmatic
|
||||||
parent: How-to guides
|
parent: How-to guides
|
||||||
order: 11
|
order: 11
|
||||||
---
|
---
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: Command-line reference
|
title: Command-line reference
|
||||||
eleventyNavigation:
|
eleventyNavigation:
|
||||||
key: Command-line reference
|
key: ⌨️ Command-line reference
|
||||||
parent: Reference guides
|
parent: Reference guides
|
||||||
order: 1
|
order: 1
|
||||||
---
|
---
|
||||||
|
|
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
title: Configuration reference
|
title: Configuration reference
|
||||||
eleventyNavigation:
|
eleventyNavigation:
|
||||||
key: Configuration reference
|
key: ⚙️ Configuration reference
|
||||||
parent: Reference guides
|
parent: Reference guides
|
||||||
order: 0
|
order: 0
|
||||||
---
|
---
|
||||||
|
|
|
@ -4,6 +4,7 @@ Description=Run borgmatic backup
|
||||||
[Timer]
|
[Timer]
|
||||||
OnCalendar=daily
|
OnCalendar=daily
|
||||||
Persistent=true
|
Persistent=true
|
||||||
|
RandomizedDelaySec=3h
|
||||||
|
|
||||||
[Install]
|
[Install]
|
||||||
WantedBy=timers.target
|
WantedBy=timers.target
|
||||||
|
|
|
@ -31,8 +31,8 @@ python3 setup.py bdist_wheel
|
||||||
python3 setup.py sdist
|
python3 setup.py sdist
|
||||||
gpg --detach-sign --armor dist/borgmatic-*.tar.gz
|
gpg --detach-sign --armor dist/borgmatic-*.tar.gz
|
||||||
gpg --detach-sign --armor dist/borgmatic-*-py3-none-any.whl
|
gpg --detach-sign --armor dist/borgmatic-*-py3-none-any.whl
|
||||||
twine upload -r pypi dist/borgmatic-*.tar.gz dist/borgmatic-*.tar.gz.asc
|
twine upload -r pypi --username __token__ dist/borgmatic-*.tar.gz dist/borgmatic-*.tar.gz.asc
|
||||||
twine upload -r pypi dist/borgmatic-*-py3-none-any.whl dist/borgmatic-*-py3-none-any.whl.asc
|
twine upload -r pypi --username __token__ dist/borgmatic-*-py3-none-any.whl dist/borgmatic-*-py3-none-any.whl.asc
|
||||||
|
|
||||||
# Set release changelogs on projects.torsion.org and GitHub.
|
# Set release changelogs on projects.torsion.org and GitHub.
|
||||||
release_changelog="$(cat NEWS | sed '/^$/q' | grep -v '^\S')"
|
release_changelog="$(cat NEWS | sed '/^$/q' | grep -v '^\S')"
|
||||||
|
|
|
@ -11,7 +11,7 @@
|
||||||
set -e
|
set -e
|
||||||
|
|
||||||
apk add --no-cache python3 py3-pip borgbackup postgresql-client mariadb-client mongodb-tools \
|
apk add --no-cache python3 py3-pip borgbackup postgresql-client mariadb-client mongodb-tools \
|
||||||
py3-ruamel.yaml py3-ruamel.yaml.clib
|
py3-ruamel.yaml py3-ruamel.yaml.clib bash
|
||||||
# If certain dependencies of black are available in this version of Alpine, install them.
|
# If certain dependencies of black are available in this version of Alpine, install them.
|
||||||
apk add --no-cache py3-typed-ast py3-regex || true
|
apk add --no-cache py3-typed-ast py3-regex || true
|
||||||
python3 -m pip install --no-cache --upgrade pip==22.0.3 setuptools==60.8.1
|
python3 -m pip install --no-cache --upgrade pip==22.0.3 setuptools==60.8.1
|
||||||
|
|
6
setup.py
6
setup.py
|
@ -1,6 +1,6 @@
|
||||||
from setuptools import find_packages, setup
|
from setuptools import find_packages, setup
|
||||||
|
|
||||||
VERSION = '1.5.24'
|
VERSION = '1.6.3.dev0'
|
||||||
|
|
||||||
|
|
||||||
setup(
|
setup(
|
||||||
|
@ -30,12 +30,12 @@ setup(
|
||||||
},
|
},
|
||||||
obsoletes=['atticmatic'],
|
obsoletes=['atticmatic'],
|
||||||
install_requires=(
|
install_requires=(
|
||||||
|
'colorama>=0.4.1,<0.5',
|
||||||
'jsonschema',
|
'jsonschema',
|
||||||
'requests',
|
'requests',
|
||||||
'ruamel.yaml>0.15.0,<0.18.0',
|
'ruamel.yaml>0.15.0,<0.18.0',
|
||||||
'setuptools',
|
'setuptools',
|
||||||
'colorama>=0.4.1,<0.5',
|
|
||||||
),
|
),
|
||||||
include_package_data=True,
|
include_package_data=True,
|
||||||
python_requires='>3.7.0',
|
python_requires='>=3.7',
|
||||||
)
|
)
|
||||||
|
|
|
@ -0,0 +1,5 @@
|
||||||
|
import subprocess
|
||||||
|
|
||||||
|
|
||||||
|
def test_bash_completion_runs_without_error():
|
||||||
|
subprocess.check_call('borgmatic --bash-completion | bash', shell=True)
|
|
@ -296,15 +296,6 @@ def test_parse_arguments_disallows_init_and_dry_run():
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_parse_arguments_disallows_glob_archives_with_successful():
|
|
||||||
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
|
||||||
|
|
||||||
with pytest.raises(ValueError):
|
|
||||||
module.parse_arguments(
|
|
||||||
'--config', 'myconfig', 'list', '--glob-archives', '*glob*', '--successful'
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def test_parse_arguments_disallows_repository_unless_action_consumes_it():
|
def test_parse_arguments_disallows_repository_unless_action_consumes_it():
|
||||||
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
|
||||||
|
|
||||||
|
|
|
@ -0,0 +1,5 @@
|
||||||
|
from borgmatic.commands import completion as module
|
||||||
|
|
||||||
|
|
||||||
|
def test_bash_completion_does_not_raise():
|
||||||
|
assert module.bash_completion()
|
|
@ -1,13 +1,25 @@
|
||||||
from borgmatic.commands import generate_config as module
|
from borgmatic.commands import generate_config as module
|
||||||
|
|
||||||
|
|
||||||
def test_parse_arguments_with_no_arguments_uses_defaults():
|
def test_parse_arguments_with_no_arguments_uses_default_destination():
|
||||||
parser = module.parse_arguments()
|
parser = module.parse_arguments()
|
||||||
|
|
||||||
assert parser.destination_filename == module.DEFAULT_DESTINATION_CONFIG_FILENAME
|
assert parser.destination_filename == module.DEFAULT_DESTINATION_CONFIG_FILENAME
|
||||||
|
|
||||||
|
|
||||||
def test_parse_arguments_with_filename_argument_overrides_defaults():
|
def test_parse_arguments_with_destination_argument_overrides_default():
|
||||||
parser = module.parse_arguments('--destination', 'config.yaml')
|
parser = module.parse_arguments('--destination', 'config.yaml')
|
||||||
|
|
||||||
assert parser.destination_filename == 'config.yaml'
|
assert parser.destination_filename == 'config.yaml'
|
||||||
|
|
||||||
|
|
||||||
|
def test_parse_arguments_parses_source():
|
||||||
|
parser = module.parse_arguments('--source', 'source.yaml', '--destination', 'config.yaml')
|
||||||
|
|
||||||
|
assert parser.source_filename == 'source.yaml'
|
||||||
|
|
||||||
|
|
||||||
|
def test_parse_arguments_parses_overwrite():
|
||||||
|
parser = module.parse_arguments('--destination', 'config.yaml', '--overwrite')
|
||||||
|
|
||||||
|
assert parser.overwrite
|
||||||
|
|
|
@ -87,7 +87,7 @@ location:
|
||||||
assert module._comment_out_optional_configuration(config.strip()) == expected_config.strip()
|
assert module._comment_out_optional_configuration(config.strip()) == expected_config.strip()
|
||||||
|
|
||||||
|
|
||||||
def testrender_configuration_converts_configuration_to_yaml_string():
|
def test_render_configuration_converts_configuration_to_yaml_string():
|
||||||
yaml_string = module.render_configuration({'foo': 'bar'})
|
yaml_string = module.render_configuration({'foo': 'bar'})
|
||||||
|
|
||||||
assert yaml_string == 'foo: bar\n'
|
assert yaml_string == 'foo: bar\n'
|
||||||
|
@ -110,6 +110,12 @@ def test_write_configuration_with_already_existing_file_raises():
|
||||||
module.write_configuration('config.yaml', 'config: yaml')
|
module.write_configuration('config.yaml', 'config: yaml')
|
||||||
|
|
||||||
|
|
||||||
|
def test_write_configuration_with_already_existing_file_and_overwrite_does_not_raise():
|
||||||
|
flexmock(os.path).should_receive('exists').and_return(True)
|
||||||
|
|
||||||
|
module.write_configuration('config.yaml', 'config: yaml', overwrite=True)
|
||||||
|
|
||||||
|
|
||||||
def test_write_configuration_with_already_existing_directory_does_not_raise():
|
def test_write_configuration_with_already_existing_directory_does_not_raise():
|
||||||
flexmock(os.path).should_receive('exists').and_return(False)
|
flexmock(os.path).should_receive('exists').and_return(False)
|
||||||
flexmock(os).should_receive('makedirs').and_raise(FileExistsError)
|
flexmock(os).should_receive('makedirs').and_raise(FileExistsError)
|
||||||
|
@ -212,6 +218,7 @@ def test_generate_sample_configuration_with_source_filename_does_not_raise():
|
||||||
builtins.should_receive('open').with_args('schema.yaml').and_return('')
|
builtins.should_receive('open').with_args('schema.yaml').and_return('')
|
||||||
flexmock(module.yaml).should_receive('round_trip_load')
|
flexmock(module.yaml).should_receive('round_trip_load')
|
||||||
flexmock(module.load).should_receive('load_configuration')
|
flexmock(module.load).should_receive('load_configuration')
|
||||||
|
flexmock(module.normalize).should_receive('normalize')
|
||||||
flexmock(module).should_receive('_schema_to_sample_configuration')
|
flexmock(module).should_receive('_schema_to_sample_configuration')
|
||||||
flexmock(module).should_receive('merge_source_configuration_into_destination')
|
flexmock(module).should_receive('merge_source_configuration_into_destination')
|
||||||
flexmock(module).should_receive('render_configuration')
|
flexmock(module).should_receive('render_configuration')
|
||||||
|
|
|
@ -1,3 +1,4 @@
|
||||||
|
import io
|
||||||
import sys
|
import sys
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
|
@ -14,49 +15,360 @@ def test_load_configuration_parses_contents():
|
||||||
assert module.load_configuration('config.yaml') == {'key': 'value'}
|
assert module.load_configuration('config.yaml') == {'key': 'value'}
|
||||||
|
|
||||||
|
|
||||||
def test_load_configuration_inlines_include():
|
def test_load_configuration_inlines_include_relative_to_current_directory():
|
||||||
builtins = flexmock(sys.modules['builtins'])
|
builtins = flexmock(sys.modules['builtins'])
|
||||||
builtins.should_receive('open').with_args('include.yaml').and_return('value')
|
flexmock(module.os).should_receive('getcwd').and_return('/tmp')
|
||||||
builtins.should_receive('open').with_args('config.yaml').and_return(
|
flexmock(module.os.path).should_receive('isabs').and_return(False)
|
||||||
'key: !include include.yaml'
|
flexmock(module.os.path).should_receive('exists').and_return(True)
|
||||||
)
|
include_file = io.StringIO('value')
|
||||||
|
include_file.name = 'include.yaml'
|
||||||
|
builtins.should_receive('open').with_args('/tmp/include.yaml').and_return(include_file)
|
||||||
|
config_file = io.StringIO('key: !include include.yaml')
|
||||||
|
config_file.name = 'config.yaml'
|
||||||
|
builtins.should_receive('open').with_args('config.yaml').and_return(config_file)
|
||||||
|
|
||||||
assert module.load_configuration('config.yaml') == {'key': 'value'}
|
assert module.load_configuration('config.yaml') == {'key': 'value'}
|
||||||
|
|
||||||
|
|
||||||
|
def test_load_configuration_inlines_include_relative_to_config_parent_directory():
|
||||||
|
builtins = flexmock(sys.modules['builtins'])
|
||||||
|
flexmock(module.os).should_receive('getcwd').and_return('/tmp')
|
||||||
|
flexmock(module.os.path).should_receive('isabs').with_args('/etc').and_return(True)
|
||||||
|
flexmock(module.os.path).should_receive('isabs').with_args('/etc/config.yaml').and_return(True)
|
||||||
|
flexmock(module.os.path).should_receive('isabs').with_args('include.yaml').and_return(False)
|
||||||
|
flexmock(module.os.path).should_receive('exists').with_args('/tmp/include.yaml').and_return(
|
||||||
|
False
|
||||||
|
)
|
||||||
|
flexmock(module.os.path).should_receive('exists').with_args('/etc/include.yaml').and_return(
|
||||||
|
True
|
||||||
|
)
|
||||||
|
include_file = io.StringIO('value')
|
||||||
|
include_file.name = 'include.yaml'
|
||||||
|
builtins.should_receive('open').with_args('/etc/include.yaml').and_return(include_file)
|
||||||
|
config_file = io.StringIO('key: !include include.yaml')
|
||||||
|
config_file.name = '/etc/config.yaml'
|
||||||
|
builtins.should_receive('open').with_args('/etc/config.yaml').and_return(config_file)
|
||||||
|
|
||||||
|
assert module.load_configuration('/etc/config.yaml') == {'key': 'value'}
|
||||||
|
|
||||||
|
|
||||||
|
def test_load_configuration_raises_if_relative_include_does_not_exist():
|
||||||
|
builtins = flexmock(sys.modules['builtins'])
|
||||||
|
flexmock(module.os).should_receive('getcwd').and_return('/tmp')
|
||||||
|
flexmock(module.os.path).should_receive('isabs').with_args('/etc').and_return(True)
|
||||||
|
flexmock(module.os.path).should_receive('isabs').with_args('/etc/config.yaml').and_return(True)
|
||||||
|
flexmock(module.os.path).should_receive('isabs').with_args('include.yaml').and_return(False)
|
||||||
|
flexmock(module.os.path).should_receive('exists').and_return(False)
|
||||||
|
config_file = io.StringIO('key: !include include.yaml')
|
||||||
|
config_file.name = '/etc/config.yaml'
|
||||||
|
builtins.should_receive('open').with_args('/etc/config.yaml').and_return(config_file)
|
||||||
|
|
||||||
|
with pytest.raises(FileNotFoundError):
|
||||||
|
module.load_configuration('/etc/config.yaml')
|
||||||
|
|
||||||
|
|
||||||
|
def test_load_configuration_inlines_absolute_include():
|
||||||
|
builtins = flexmock(sys.modules['builtins'])
|
||||||
|
flexmock(module.os).should_receive('getcwd').and_return('/tmp')
|
||||||
|
flexmock(module.os.path).should_receive('isabs').and_return(True)
|
||||||
|
flexmock(module.os.path).should_receive('exists').never()
|
||||||
|
include_file = io.StringIO('value')
|
||||||
|
include_file.name = '/root/include.yaml'
|
||||||
|
builtins.should_receive('open').with_args('/root/include.yaml').and_return(include_file)
|
||||||
|
config_file = io.StringIO('key: !include /root/include.yaml')
|
||||||
|
config_file.name = 'config.yaml'
|
||||||
|
builtins.should_receive('open').with_args('config.yaml').and_return(config_file)
|
||||||
|
|
||||||
|
assert module.load_configuration('config.yaml') == {'key': 'value'}
|
||||||
|
|
||||||
|
|
||||||
|
def test_load_configuration_raises_if_absolute_include_does_not_exist():
|
||||||
|
builtins = flexmock(sys.modules['builtins'])
|
||||||
|
flexmock(module.os).should_receive('getcwd').and_return('/tmp')
|
||||||
|
flexmock(module.os.path).should_receive('isabs').and_return(True)
|
||||||
|
builtins.should_receive('open').with_args('/root/include.yaml').and_raise(FileNotFoundError)
|
||||||
|
config_file = io.StringIO('key: !include /root/include.yaml')
|
||||||
|
config_file.name = 'config.yaml'
|
||||||
|
builtins.should_receive('open').with_args('config.yaml').and_return(config_file)
|
||||||
|
|
||||||
|
with pytest.raises(FileNotFoundError):
|
||||||
|
assert module.load_configuration('config.yaml')
|
||||||
|
|
||||||
|
|
||||||
def test_load_configuration_merges_include():
|
def test_load_configuration_merges_include():
|
||||||
builtins = flexmock(sys.modules['builtins'])
|
builtins = flexmock(sys.modules['builtins'])
|
||||||
builtins.should_receive('open').with_args('include.yaml').and_return(
|
flexmock(module.os).should_receive('getcwd').and_return('/tmp')
|
||||||
|
flexmock(module.os.path).should_receive('isabs').and_return(False)
|
||||||
|
flexmock(module.os.path).should_receive('exists').and_return(True)
|
||||||
|
include_file = io.StringIO(
|
||||||
'''
|
'''
|
||||||
foo: bar
|
foo: bar
|
||||||
baz: quux
|
baz: quux
|
||||||
'''
|
'''
|
||||||
)
|
)
|
||||||
builtins.should_receive('open').with_args('config.yaml').and_return(
|
include_file.name = 'include.yaml'
|
||||||
|
builtins.should_receive('open').with_args('/tmp/include.yaml').and_return(include_file)
|
||||||
|
config_file = io.StringIO(
|
||||||
'''
|
'''
|
||||||
foo: override
|
foo: override
|
||||||
<<: !include include.yaml
|
<<: !include include.yaml
|
||||||
'''
|
'''
|
||||||
)
|
)
|
||||||
|
config_file.name = 'config.yaml'
|
||||||
|
builtins.should_receive('open').with_args('config.yaml').and_return(config_file)
|
||||||
|
|
||||||
assert module.load_configuration('config.yaml') == {'foo': 'override', 'baz': 'quux'}
|
assert module.load_configuration('config.yaml') == {'foo': 'override', 'baz': 'quux'}
|
||||||
|
|
||||||
|
|
||||||
def test_load_configuration_does_not_merge_include_list():
|
def test_load_configuration_does_not_merge_include_list():
|
||||||
builtins = flexmock(sys.modules['builtins'])
|
builtins = flexmock(sys.modules['builtins'])
|
||||||
builtins.should_receive('open').with_args('include.yaml').and_return(
|
flexmock(module.os).should_receive('getcwd').and_return('/tmp')
|
||||||
|
flexmock(module.os.path).should_receive('isabs').and_return(False)
|
||||||
|
flexmock(module.os.path).should_receive('exists').and_return(True)
|
||||||
|
include_file = io.StringIO(
|
||||||
'''
|
'''
|
||||||
- one
|
- one
|
||||||
- two
|
- two
|
||||||
'''
|
'''
|
||||||
)
|
)
|
||||||
builtins.should_receive('open').with_args('config.yaml').and_return(
|
include_file.name = 'include.yaml'
|
||||||
|
builtins.should_receive('open').with_args('/tmp/include.yaml').and_return(include_file)
|
||||||
|
config_file = io.StringIO(
|
||||||
'''
|
'''
|
||||||
foo: bar
|
foo: bar
|
||||||
repositories:
|
repositories:
|
||||||
<<: !include include.yaml
|
<<: !include include.yaml
|
||||||
'''
|
'''
|
||||||
)
|
)
|
||||||
|
config_file.name = 'config.yaml'
|
||||||
|
builtins.should_receive('open').with_args('config.yaml').and_return(config_file)
|
||||||
|
|
||||||
with pytest.raises(ruamel.yaml.error.YAMLError):
|
with pytest.raises(ruamel.yaml.error.YAMLError):
|
||||||
assert module.load_configuration('config.yaml')
|
assert module.load_configuration('config.yaml')
|
||||||
|
|
||||||
|
|
||||||
|
def test_deep_merge_nodes_replaces_colliding_scalar_values():
|
||||||
|
node_values = [
|
||||||
|
(
|
||||||
|
ruamel.yaml.nodes.ScalarNode(tag='tag:yaml.org,2002:str', value='retention'),
|
||||||
|
ruamel.yaml.nodes.MappingNode(
|
||||||
|
tag='tag:yaml.org,2002:map',
|
||||||
|
value=[
|
||||||
|
(
|
||||||
|
ruamel.yaml.nodes.ScalarNode(
|
||||||
|
tag='tag:yaml.org,2002:str', value='keep_hourly'
|
||||||
|
),
|
||||||
|
ruamel.yaml.nodes.ScalarNode(tag='tag:yaml.org,2002:int', value='24'),
|
||||||
|
),
|
||||||
|
(
|
||||||
|
ruamel.yaml.nodes.ScalarNode(
|
||||||
|
tag='tag:yaml.org,2002:str', value='keep_daily'
|
||||||
|
),
|
||||||
|
ruamel.yaml.nodes.ScalarNode(tag='tag:yaml.org,2002:int', value='7'),
|
||||||
|
),
|
||||||
|
],
|
||||||
|
),
|
||||||
|
),
|
||||||
|
(
|
||||||
|
ruamel.yaml.nodes.ScalarNode(tag='tag:yaml.org,2002:str', value='retention'),
|
||||||
|
ruamel.yaml.nodes.MappingNode(
|
||||||
|
tag='tag:yaml.org,2002:map',
|
||||||
|
value=[
|
||||||
|
(
|
||||||
|
ruamel.yaml.nodes.ScalarNode(
|
||||||
|
tag='tag:yaml.org,2002:str', value='keep_daily'
|
||||||
|
),
|
||||||
|
ruamel.yaml.nodes.ScalarNode(tag='tag:yaml.org,2002:int', value='5'),
|
||||||
|
),
|
||||||
|
],
|
||||||
|
),
|
||||||
|
),
|
||||||
|
]
|
||||||
|
|
||||||
|
result = module.deep_merge_nodes(node_values)
|
||||||
|
assert len(result) == 1
|
||||||
|
(section_key, section_value) = result[0]
|
||||||
|
assert section_key.value == 'retention'
|
||||||
|
options = section_value.value
|
||||||
|
assert len(options) == 2
|
||||||
|
assert options[0][0].value == 'keep_hourly'
|
||||||
|
assert options[0][1].value == '24'
|
||||||
|
assert options[1][0].value == 'keep_daily'
|
||||||
|
assert options[1][1].value == '5'
|
||||||
|
|
||||||
|
|
||||||
|
def test_deep_merge_nodes_keeps_non_colliding_scalar_values():
|
||||||
|
node_values = [
|
||||||
|
(
|
||||||
|
ruamel.yaml.nodes.ScalarNode(tag='tag:yaml.org,2002:str', value='retention'),
|
||||||
|
ruamel.yaml.nodes.MappingNode(
|
||||||
|
tag='tag:yaml.org,2002:map',
|
||||||
|
value=[
|
||||||
|
(
|
||||||
|
ruamel.yaml.nodes.ScalarNode(
|
||||||
|
tag='tag:yaml.org,2002:str', value='keep_hourly'
|
||||||
|
),
|
||||||
|
ruamel.yaml.nodes.ScalarNode(tag='tag:yaml.org,2002:int', value='24'),
|
||||||
|
),
|
||||||
|
(
|
||||||
|
ruamel.yaml.nodes.ScalarNode(
|
||||||
|
tag='tag:yaml.org,2002:str', value='keep_daily'
|
||||||
|
),
|
||||||
|
ruamel.yaml.nodes.ScalarNode(tag='tag:yaml.org,2002:int', value='7'),
|
||||||
|
),
|
||||||
|
],
|
||||||
|
),
|
||||||
|
),
|
||||||
|
(
|
||||||
|
ruamel.yaml.nodes.ScalarNode(tag='tag:yaml.org,2002:str', value='retention'),
|
||||||
|
ruamel.yaml.nodes.MappingNode(
|
||||||
|
tag='tag:yaml.org,2002:map',
|
||||||
|
value=[
|
||||||
|
(
|
||||||
|
ruamel.yaml.nodes.ScalarNode(
|
||||||
|
tag='tag:yaml.org,2002:str', value='keep_minutely'
|
||||||
|
),
|
||||||
|
ruamel.yaml.nodes.ScalarNode(tag='tag:yaml.org,2002:int', value='10'),
|
||||||
|
),
|
||||||
|
],
|
||||||
|
),
|
||||||
|
),
|
||||||
|
]
|
||||||
|
|
||||||
|
result = module.deep_merge_nodes(node_values)
|
||||||
|
assert len(result) == 1
|
||||||
|
(section_key, section_value) = result[0]
|
||||||
|
assert section_key.value == 'retention'
|
||||||
|
options = section_value.value
|
||||||
|
assert len(options) == 3
|
||||||
|
assert options[0][0].value == 'keep_hourly'
|
||||||
|
assert options[0][1].value == '24'
|
||||||
|
assert options[1][0].value == 'keep_daily'
|
||||||
|
assert options[1][1].value == '7'
|
||||||
|
assert options[2][0].value == 'keep_minutely'
|
||||||
|
assert options[2][1].value == '10'
|
||||||
|
|
||||||
|
|
||||||
|
def test_deep_merge_nodes_keeps_deeply_nested_values():
|
||||||
|
node_values = [
|
||||||
|
(
|
||||||
|
ruamel.yaml.nodes.ScalarNode(tag='tag:yaml.org,2002:str', value='storage'),
|
||||||
|
ruamel.yaml.nodes.MappingNode(
|
||||||
|
tag='tag:yaml.org,2002:map',
|
||||||
|
value=[
|
||||||
|
(
|
||||||
|
ruamel.yaml.nodes.ScalarNode(
|
||||||
|
tag='tag:yaml.org,2002:str', value='lock_wait'
|
||||||
|
),
|
||||||
|
ruamel.yaml.nodes.ScalarNode(tag='tag:yaml.org,2002:int', value='5'),
|
||||||
|
),
|
||||||
|
(
|
||||||
|
ruamel.yaml.nodes.ScalarNode(
|
||||||
|
tag='tag:yaml.org,2002:str', value='extra_borg_options'
|
||||||
|
),
|
||||||
|
ruamel.yaml.nodes.MappingNode(
|
||||||
|
tag='tag:yaml.org,2002:map',
|
||||||
|
value=[
|
||||||
|
(
|
||||||
|
ruamel.yaml.nodes.ScalarNode(
|
||||||
|
tag='tag:yaml.org,2002:str', value='init'
|
||||||
|
),
|
||||||
|
ruamel.yaml.nodes.ScalarNode(
|
||||||
|
tag='tag:yaml.org,2002:str', value='--init-option'
|
||||||
|
),
|
||||||
|
),
|
||||||
|
],
|
||||||
|
),
|
||||||
|
),
|
||||||
|
],
|
||||||
|
),
|
||||||
|
),
|
||||||
|
(
|
||||||
|
ruamel.yaml.nodes.ScalarNode(tag='tag:yaml.org,2002:str', value='storage'),
|
||||||
|
ruamel.yaml.nodes.MappingNode(
|
||||||
|
tag='tag:yaml.org,2002:map',
|
||||||
|
value=[
|
||||||
|
(
|
||||||
|
ruamel.yaml.nodes.ScalarNode(
|
||||||
|
tag='tag:yaml.org,2002:str', value='extra_borg_options'
|
||||||
|
),
|
||||||
|
ruamel.yaml.nodes.MappingNode(
|
||||||
|
tag='tag:yaml.org,2002:map',
|
||||||
|
value=[
|
||||||
|
(
|
||||||
|
ruamel.yaml.nodes.ScalarNode(
|
||||||
|
tag='tag:yaml.org,2002:str', value='prune'
|
||||||
|
),
|
||||||
|
ruamel.yaml.nodes.ScalarNode(
|
||||||
|
tag='tag:yaml.org,2002:str', value='--prune-option'
|
||||||
|
),
|
||||||
|
),
|
||||||
|
],
|
||||||
|
),
|
||||||
|
),
|
||||||
|
],
|
||||||
|
),
|
||||||
|
),
|
||||||
|
]
|
||||||
|
|
||||||
|
result = module.deep_merge_nodes(node_values)
|
||||||
|
assert len(result) == 1
|
||||||
|
(section_key, section_value) = result[0]
|
||||||
|
assert section_key.value == 'storage'
|
||||||
|
options = section_value.value
|
||||||
|
assert len(options) == 2
|
||||||
|
assert options[0][0].value == 'lock_wait'
|
||||||
|
assert options[0][1].value == '5'
|
||||||
|
assert options[1][0].value == 'extra_borg_options'
|
||||||
|
nested_options = options[1][1].value
|
||||||
|
assert len(nested_options) == 2
|
||||||
|
assert nested_options[0][0].value == 'init'
|
||||||
|
assert nested_options[0][1].value == '--init-option'
|
||||||
|
assert nested_options[1][0].value == 'prune'
|
||||||
|
assert nested_options[1][1].value == '--prune-option'
|
||||||
|
|
||||||
|
|
||||||
|
def test_deep_merge_nodes_appends_colliding_sequence_values():
|
||||||
|
node_values = [
|
||||||
|
(
|
||||||
|
ruamel.yaml.nodes.ScalarNode(tag='tag:yaml.org,2002:str', value='hooks'),
|
||||||
|
ruamel.yaml.nodes.MappingNode(
|
||||||
|
tag='tag:yaml.org,2002:map',
|
||||||
|
value=[
|
||||||
|
(
|
||||||
|
ruamel.yaml.nodes.ScalarNode(
|
||||||
|
tag='tag:yaml.org,2002:str', value='before_backup'
|
||||||
|
),
|
||||||
|
ruamel.yaml.nodes.SequenceNode(
|
||||||
|
tag='tag:yaml.org,2002:int', value=['echo 1', 'echo 2']
|
||||||
|
),
|
||||||
|
),
|
||||||
|
],
|
||||||
|
),
|
||||||
|
),
|
||||||
|
(
|
||||||
|
ruamel.yaml.nodes.ScalarNode(tag='tag:yaml.org,2002:str', value='hooks'),
|
||||||
|
ruamel.yaml.nodes.MappingNode(
|
||||||
|
tag='tag:yaml.org,2002:map',
|
||||||
|
value=[
|
||||||
|
(
|
||||||
|
ruamel.yaml.nodes.ScalarNode(
|
||||||
|
tag='tag:yaml.org,2002:str', value='before_backup'
|
||||||
|
),
|
||||||
|
ruamel.yaml.nodes.SequenceNode(
|
||||||
|
tag='tag:yaml.org,2002:int', value=['echo 3', 'echo 4']
|
||||||
|
),
|
||||||
|
),
|
||||||
|
],
|
||||||
|
),
|
||||||
|
),
|
||||||
|
]
|
||||||
|
|
||||||
|
result = module.deep_merge_nodes(node_values)
|
||||||
|
assert len(result) == 1
|
||||||
|
(section_key, section_value) = result[0]
|
||||||
|
assert section_key.value == 'hooks'
|
||||||
|
options = section_value.value
|
||||||
|
assert len(options) == 1
|
||||||
|
assert options[0][0].value == 'before_backup'
|
||||||
|
assert options[0][1].value == ['echo 1', 'echo 2', 'echo 3', 'echo 4']
|
||||||
|
|
|
@ -21,14 +21,20 @@ def mock_config_and_schema(config_yaml, schema_yaml=None):
|
||||||
when parsing the configuration.
|
when parsing the configuration.
|
||||||
'''
|
'''
|
||||||
config_stream = io.StringIO(config_yaml)
|
config_stream = io.StringIO(config_yaml)
|
||||||
|
config_stream.name = 'config.yaml'
|
||||||
|
|
||||||
if schema_yaml is None:
|
if schema_yaml is None:
|
||||||
schema_stream = open(module.schema_filename())
|
schema_stream = open(module.schema_filename())
|
||||||
else:
|
else:
|
||||||
schema_stream = io.StringIO(schema_yaml)
|
schema_stream = io.StringIO(schema_yaml)
|
||||||
|
schema_stream.name = 'schema.yaml'
|
||||||
|
|
||||||
builtins = flexmock(sys.modules['builtins'])
|
builtins = flexmock(sys.modules['builtins'])
|
||||||
builtins.should_receive('open').with_args('config.yaml').and_return(config_stream)
|
flexmock(module.os).should_receive('getcwd').and_return('/tmp')
|
||||||
builtins.should_receive('open').with_args('schema.yaml').and_return(schema_stream)
|
flexmock(module.os.path).should_receive('isabs').and_return(False)
|
||||||
|
flexmock(module.os.path).should_receive('exists').and_return(True)
|
||||||
|
builtins.should_receive('open').with_args('/tmp/config.yaml').and_return(config_stream)
|
||||||
|
builtins.should_receive('open').with_args('/tmp/schema.yaml').and_return(schema_stream)
|
||||||
|
|
||||||
|
|
||||||
def test_parse_configuration_transforms_file_into_mapping():
|
def test_parse_configuration_transforms_file_into_mapping():
|
||||||
|
@ -49,17 +55,17 @@ def test_parse_configuration_transforms_file_into_mapping():
|
||||||
|
|
||||||
consistency:
|
consistency:
|
||||||
checks:
|
checks:
|
||||||
- repository
|
- name: repository
|
||||||
- archives
|
- name: archives
|
||||||
'''
|
'''
|
||||||
)
|
)
|
||||||
|
|
||||||
result = module.parse_configuration('config.yaml', 'schema.yaml')
|
result = module.parse_configuration('/tmp/config.yaml', '/tmp/schema.yaml')
|
||||||
|
|
||||||
assert result == {
|
assert result == {
|
||||||
'location': {'source_directories': ['/home', '/etc'], 'repositories': ['hostname.borg']},
|
'location': {'source_directories': ['/home', '/etc'], 'repositories': ['hostname.borg']},
|
||||||
'retention': {'keep_daily': 7, 'keep_hourly': 24, 'keep_minutely': 60},
|
'retention': {'keep_daily': 7, 'keep_hourly': 24, 'keep_minutely': 60},
|
||||||
'consistency': {'checks': ['repository', 'archives']},
|
'consistency': {'checks': [{'name': 'repository'}, {'name': 'archives'}]},
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
@ -79,7 +85,7 @@ def test_parse_configuration_passes_through_quoted_punctuation():
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
|
|
||||||
result = module.parse_configuration('config.yaml', 'schema.yaml')
|
result = module.parse_configuration('/tmp/config.yaml', '/tmp/schema.yaml')
|
||||||
|
|
||||||
assert result == {
|
assert result == {
|
||||||
'location': {
|
'location': {
|
||||||
|
@ -115,7 +121,7 @@ def test_parse_configuration_with_schema_lacking_examples_does_not_raise():
|
||||||
''',
|
''',
|
||||||
)
|
)
|
||||||
|
|
||||||
module.parse_configuration('config.yaml', 'schema.yaml')
|
module.parse_configuration('/tmp/config.yaml', '/tmp/schema.yaml')
|
||||||
|
|
||||||
|
|
||||||
def test_parse_configuration_inlines_include():
|
def test_parse_configuration_inlines_include():
|
||||||
|
@ -133,14 +139,16 @@ def test_parse_configuration_inlines_include():
|
||||||
'''
|
'''
|
||||||
)
|
)
|
||||||
builtins = flexmock(sys.modules['builtins'])
|
builtins = flexmock(sys.modules['builtins'])
|
||||||
builtins.should_receive('open').with_args('include.yaml').and_return(
|
include_file = io.StringIO(
|
||||||
'''
|
'''
|
||||||
keep_daily: 7
|
keep_daily: 7
|
||||||
keep_hourly: 24
|
keep_hourly: 24
|
||||||
'''
|
'''
|
||||||
)
|
)
|
||||||
|
include_file.name = 'include.yaml'
|
||||||
|
builtins.should_receive('open').with_args('/tmp/include.yaml').and_return(include_file)
|
||||||
|
|
||||||
result = module.parse_configuration('config.yaml', 'schema.yaml')
|
result = module.parse_configuration('/tmp/config.yaml', '/tmp/schema.yaml')
|
||||||
|
|
||||||
assert result == {
|
assert result == {
|
||||||
'location': {'source_directories': ['/home'], 'repositories': ['hostname.borg']},
|
'location': {'source_directories': ['/home'], 'repositories': ['hostname.borg']},
|
||||||
|
@ -164,14 +172,16 @@ def test_parse_configuration_merges_include():
|
||||||
'''
|
'''
|
||||||
)
|
)
|
||||||
builtins = flexmock(sys.modules['builtins'])
|
builtins = flexmock(sys.modules['builtins'])
|
||||||
builtins.should_receive('open').with_args('include.yaml').and_return(
|
include_file = io.StringIO(
|
||||||
'''
|
'''
|
||||||
keep_daily: 7
|
keep_daily: 7
|
||||||
keep_hourly: 24
|
keep_hourly: 24
|
||||||
'''
|
'''
|
||||||
)
|
)
|
||||||
|
include_file.name = 'include.yaml'
|
||||||
|
builtins.should_receive('open').with_args('/tmp/include.yaml').and_return(include_file)
|
||||||
|
|
||||||
result = module.parse_configuration('config.yaml', 'schema.yaml')
|
result = module.parse_configuration('/tmp/config.yaml', '/tmp/schema.yaml')
|
||||||
|
|
||||||
assert result == {
|
assert result == {
|
||||||
'location': {'source_directories': ['/home'], 'repositories': ['hostname.borg']},
|
'location': {'source_directories': ['/home'], 'repositories': ['hostname.borg']},
|
||||||
|
@ -181,23 +191,23 @@ def test_parse_configuration_merges_include():
|
||||||
|
|
||||||
def test_parse_configuration_raises_for_missing_config_file():
|
def test_parse_configuration_raises_for_missing_config_file():
|
||||||
with pytest.raises(FileNotFoundError):
|
with pytest.raises(FileNotFoundError):
|
||||||
module.parse_configuration('config.yaml', 'schema.yaml')
|
module.parse_configuration('/tmp/config.yaml', '/tmp/schema.yaml')
|
||||||
|
|
||||||
|
|
||||||
def test_parse_configuration_raises_for_missing_schema_file():
|
def test_parse_configuration_raises_for_missing_schema_file():
|
||||||
mock_config_and_schema('')
|
mock_config_and_schema('')
|
||||||
builtins = flexmock(sys.modules['builtins'])
|
builtins = flexmock(sys.modules['builtins'])
|
||||||
builtins.should_receive('open').with_args('schema.yaml').and_raise(FileNotFoundError)
|
builtins.should_receive('open').with_args('/tmp/schema.yaml').and_raise(FileNotFoundError)
|
||||||
|
|
||||||
with pytest.raises(FileNotFoundError):
|
with pytest.raises(FileNotFoundError):
|
||||||
module.parse_configuration('config.yaml', 'schema.yaml')
|
module.parse_configuration('/tmp/config.yaml', '/tmp/schema.yaml')
|
||||||
|
|
||||||
|
|
||||||
def test_parse_configuration_raises_for_syntax_error():
|
def test_parse_configuration_raises_for_syntax_error():
|
||||||
mock_config_and_schema('foo:\nbar')
|
mock_config_and_schema('foo:\nbar')
|
||||||
|
|
||||||
with pytest.raises(ValueError):
|
with pytest.raises(ValueError):
|
||||||
module.parse_configuration('config.yaml', 'schema.yaml')
|
module.parse_configuration('/tmp/config.yaml', '/tmp/schema.yaml')
|
||||||
|
|
||||||
|
|
||||||
def test_parse_configuration_raises_for_validation_error():
|
def test_parse_configuration_raises_for_validation_error():
|
||||||
|
@ -211,7 +221,7 @@ def test_parse_configuration_raises_for_validation_error():
|
||||||
)
|
)
|
||||||
|
|
||||||
with pytest.raises(module.Validation_error):
|
with pytest.raises(module.Validation_error):
|
||||||
module.parse_configuration('config.yaml', 'schema.yaml')
|
module.parse_configuration('/tmp/config.yaml', '/tmp/schema.yaml')
|
||||||
|
|
||||||
|
|
||||||
def test_parse_configuration_applies_overrides():
|
def test_parse_configuration_applies_overrides():
|
||||||
|
@ -229,7 +239,7 @@ def test_parse_configuration_applies_overrides():
|
||||||
)
|
)
|
||||||
|
|
||||||
result = module.parse_configuration(
|
result = module.parse_configuration(
|
||||||
'config.yaml', 'schema.yaml', overrides=['location.local_path=borg2']
|
'/tmp/config.yaml', '/tmp/schema.yaml', overrides=['location.local_path=borg2']
|
||||||
)
|
)
|
||||||
|
|
||||||
assert result == {
|
assert result == {
|
||||||
|
@ -255,7 +265,7 @@ def test_parse_configuration_applies_normalization():
|
||||||
'''
|
'''
|
||||||
)
|
)
|
||||||
|
|
||||||
result = module.parse_configuration('config.yaml', 'schema.yaml')
|
result = module.parse_configuration('/tmp/config.yaml', '/tmp/schema.yaml')
|
||||||
|
|
||||||
assert result == {
|
assert result == {
|
||||||
'location': {
|
'location': {
|
||||||
|
|
|
@ -121,3 +121,47 @@ def test_run_arbitrary_borg_without_borg_specific_parameters_does_not_raise():
|
||||||
module.run_arbitrary_borg(
|
module.run_arbitrary_borg(
|
||||||
repository='repo', storage_config={}, options=[],
|
repository='repo', storage_config={}, options=[],
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_run_arbitrary_borg_passes_key_sub_command_to_borg_before_repository():
|
||||||
|
flexmock(module).should_receive('execute_command').with_args(
|
||||||
|
('borg', 'key', 'export', 'repo'), output_log_level=logging.WARNING, borg_local_path='borg',
|
||||||
|
)
|
||||||
|
|
||||||
|
module.run_arbitrary_borg(
|
||||||
|
repository='repo', storage_config={}, options=['key', 'export'],
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_run_arbitrary_borg_passes_debug_sub_command_to_borg_before_repository():
|
||||||
|
flexmock(module).should_receive('execute_command').with_args(
|
||||||
|
('borg', 'debug', 'dump-manifest', 'repo', 'path'),
|
||||||
|
output_log_level=logging.WARNING,
|
||||||
|
borg_local_path='borg',
|
||||||
|
)
|
||||||
|
|
||||||
|
module.run_arbitrary_borg(
|
||||||
|
repository='repo', storage_config={}, options=['debug', 'dump-manifest', 'path'],
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_run_arbitrary_borg_with_debug_info_command_does_not_pass_borg_repository():
|
||||||
|
flexmock(module).should_receive('execute_command').with_args(
|
||||||
|
('borg', 'debug', 'info'), output_log_level=logging.WARNING, borg_local_path='borg',
|
||||||
|
)
|
||||||
|
|
||||||
|
module.run_arbitrary_borg(
|
||||||
|
repository='repo', storage_config={}, options=['debug', 'info'],
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_run_arbitrary_borg_with_debug_convert_profile_command_does_not_pass_borg_repository():
|
||||||
|
flexmock(module).should_receive('execute_command').with_args(
|
||||||
|
('borg', 'debug', 'convert-profile', 'in', 'out'),
|
||||||
|
output_log_level=logging.WARNING,
|
||||||
|
borg_local_path='borg',
|
||||||
|
)
|
||||||
|
|
||||||
|
module.run_arbitrary_borg(
|
||||||
|
repository='repo', storage_config={}, options=['debug', 'convert-profile', 'in', 'out'],
|
||||||
|
)
|
||||||
|
|
|
@ -17,172 +17,336 @@ def insert_execute_command_never():
|
||||||
|
|
||||||
|
|
||||||
def test_parse_checks_returns_them_as_tuple():
|
def test_parse_checks_returns_them_as_tuple():
|
||||||
checks = module._parse_checks({'checks': ['foo', 'disabled', 'bar']})
|
checks = module.parse_checks({'checks': [{'name': 'foo'}, {'name': 'bar'}]})
|
||||||
|
|
||||||
assert checks == ('foo', 'bar')
|
assert checks == ('foo', 'bar')
|
||||||
|
|
||||||
|
|
||||||
def test_parse_checks_with_missing_value_returns_defaults():
|
def test_parse_checks_with_missing_value_returns_defaults():
|
||||||
checks = module._parse_checks({})
|
checks = module.parse_checks({})
|
||||||
|
|
||||||
assert checks == module.DEFAULT_CHECKS
|
assert checks == ('repository', 'archives')
|
||||||
|
|
||||||
|
|
||||||
def test_parse_checks_with_blank_value_returns_defaults():
|
def test_parse_checks_with_empty_list_returns_defaults():
|
||||||
checks = module._parse_checks({'checks': []})
|
checks = module.parse_checks({'checks': []})
|
||||||
|
|
||||||
assert checks == module.DEFAULT_CHECKS
|
assert checks == ('repository', 'archives')
|
||||||
|
|
||||||
|
|
||||||
def test_parse_checks_with_none_value_returns_defaults():
|
def test_parse_checks_with_none_value_returns_defaults():
|
||||||
checks = module._parse_checks({'checks': None})
|
checks = module.parse_checks({'checks': None})
|
||||||
|
|
||||||
assert checks == module.DEFAULT_CHECKS
|
assert checks == ('repository', 'archives')
|
||||||
|
|
||||||
|
|
||||||
def test_parse_checks_with_disabled_returns_no_checks():
|
def test_parse_checks_with_disabled_returns_no_checks():
|
||||||
checks = module._parse_checks({'checks': ['disabled']})
|
checks = module.parse_checks({'checks': [{'name': 'foo'}, {'name': 'disabled'}]})
|
||||||
|
|
||||||
assert checks == ()
|
assert checks == ()
|
||||||
|
|
||||||
|
|
||||||
def test_parse_checks_with_data_check_also_injects_archives():
|
def test_parse_checks_with_data_check_also_injects_archives():
|
||||||
checks = module._parse_checks({'checks': ['data']})
|
checks = module.parse_checks({'checks': [{'name': 'data'}]})
|
||||||
|
|
||||||
assert checks == ('data', 'archives')
|
assert checks == ('data', 'archives')
|
||||||
|
|
||||||
|
|
||||||
def test_parse_checks_with_data_check_passes_through_archives():
|
def test_parse_checks_with_data_check_passes_through_archives():
|
||||||
checks = module._parse_checks({'checks': ['data', 'archives']})
|
checks = module.parse_checks({'checks': [{'name': 'data'}, {'name': 'archives'}]})
|
||||||
|
|
||||||
assert checks == ('data', 'archives')
|
assert checks == ('data', 'archives')
|
||||||
|
|
||||||
|
|
||||||
def test_parse_checks_prefers_override_checks_to_configured_checks():
|
def test_parse_checks_prefers_override_checks_to_configured_checks():
|
||||||
checks = module._parse_checks({'checks': ['archives']}, only_checks=['repository', 'extract'])
|
checks = module.parse_checks(
|
||||||
|
{'checks': [{'name': 'archives'}]}, only_checks=['repository', 'extract']
|
||||||
|
)
|
||||||
|
|
||||||
assert checks == ('repository', 'extract')
|
assert checks == ('repository', 'extract')
|
||||||
|
|
||||||
|
|
||||||
def test_parse_checks_with_override_data_check_also_injects_archives():
|
def test_parse_checks_with_override_data_check_also_injects_archives():
|
||||||
checks = module._parse_checks({'checks': ['extract']}, only_checks=['data'])
|
checks = module.parse_checks({'checks': [{'name': 'extract'}]}, only_checks=['data'])
|
||||||
|
|
||||||
assert checks == ('data', 'archives')
|
assert checks == ('data', 'archives')
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
'frequency,expected_result',
|
||||||
|
(
|
||||||
|
(None, None),
|
||||||
|
('always', None),
|
||||||
|
('1 hour', module.datetime.timedelta(hours=1)),
|
||||||
|
('2 hours', module.datetime.timedelta(hours=2)),
|
||||||
|
('1 day', module.datetime.timedelta(days=1)),
|
||||||
|
('2 days', module.datetime.timedelta(days=2)),
|
||||||
|
('1 week', module.datetime.timedelta(weeks=1)),
|
||||||
|
('2 weeks', module.datetime.timedelta(weeks=2)),
|
||||||
|
('1 month', module.datetime.timedelta(days=30)),
|
||||||
|
('2 months', module.datetime.timedelta(days=60)),
|
||||||
|
('1 year', module.datetime.timedelta(days=365)),
|
||||||
|
('2 years', module.datetime.timedelta(days=365 * 2)),
|
||||||
|
),
|
||||||
|
)
|
||||||
|
def test_parse_frequency_parses_into_timedeltas(frequency, expected_result):
|
||||||
|
assert module.parse_frequency(frequency) == expected_result
|
||||||
|
|
||||||
|
|
||||||
|
@pytest.mark.parametrize(
|
||||||
|
'frequency', ('sometime', 'x days', '3 decades',),
|
||||||
|
)
|
||||||
|
def test_parse_frequency_raises_on_parse_error(frequency):
|
||||||
|
with pytest.raises(ValueError):
|
||||||
|
module.parse_frequency(frequency)
|
||||||
|
|
||||||
|
|
||||||
|
def test_filter_checks_on_frequency_without_config_uses_default_checks():
|
||||||
|
flexmock(module).should_receive('parse_frequency').and_return(
|
||||||
|
module.datetime.timedelta(weeks=4)
|
||||||
|
)
|
||||||
|
flexmock(module).should_receive('make_check_time_path')
|
||||||
|
flexmock(module).should_receive('read_check_time').and_return(None)
|
||||||
|
|
||||||
|
assert module.filter_checks_on_frequency(
|
||||||
|
location_config={},
|
||||||
|
consistency_config={},
|
||||||
|
borg_repository_id='repo',
|
||||||
|
checks=('repository', 'archives'),
|
||||||
|
force=False,
|
||||||
|
) == ('repository', 'archives')
|
||||||
|
|
||||||
|
|
||||||
|
def test_filter_checks_on_frequency_retains_unconfigured_check():
|
||||||
|
assert module.filter_checks_on_frequency(
|
||||||
|
location_config={},
|
||||||
|
consistency_config={},
|
||||||
|
borg_repository_id='repo',
|
||||||
|
checks=('data',),
|
||||||
|
force=False,
|
||||||
|
) == ('data',)
|
||||||
|
|
||||||
|
|
||||||
|
def test_filter_checks_on_frequency_retains_check_without_frequency():
|
||||||
|
flexmock(module).should_receive('parse_frequency').and_return(None)
|
||||||
|
|
||||||
|
assert module.filter_checks_on_frequency(
|
||||||
|
location_config={},
|
||||||
|
consistency_config={'checks': [{'name': 'archives'}]},
|
||||||
|
borg_repository_id='repo',
|
||||||
|
checks=('archives',),
|
||||||
|
force=False,
|
||||||
|
) == ('archives',)
|
||||||
|
|
||||||
|
|
||||||
|
def test_filter_checks_on_frequency_retains_check_with_elapsed_frequency():
|
||||||
|
flexmock(module).should_receive('parse_frequency').and_return(
|
||||||
|
module.datetime.timedelta(hours=1)
|
||||||
|
)
|
||||||
|
flexmock(module).should_receive('make_check_time_path')
|
||||||
|
flexmock(module).should_receive('read_check_time').and_return(
|
||||||
|
module.datetime.datetime(year=module.datetime.MINYEAR, month=1, day=1)
|
||||||
|
)
|
||||||
|
|
||||||
|
assert module.filter_checks_on_frequency(
|
||||||
|
location_config={},
|
||||||
|
consistency_config={'checks': [{'name': 'archives', 'frequency': '1 hour'}]},
|
||||||
|
borg_repository_id='repo',
|
||||||
|
checks=('archives',),
|
||||||
|
force=False,
|
||||||
|
) == ('archives',)
|
||||||
|
|
||||||
|
|
||||||
|
def test_filter_checks_on_frequency_retains_check_with_missing_check_time_file():
|
||||||
|
flexmock(module).should_receive('parse_frequency').and_return(
|
||||||
|
module.datetime.timedelta(hours=1)
|
||||||
|
)
|
||||||
|
flexmock(module).should_receive('make_check_time_path')
|
||||||
|
flexmock(module).should_receive('read_check_time').and_return(None)
|
||||||
|
|
||||||
|
assert module.filter_checks_on_frequency(
|
||||||
|
location_config={},
|
||||||
|
consistency_config={'checks': [{'name': 'archives', 'frequency': '1 hour'}]},
|
||||||
|
borg_repository_id='repo',
|
||||||
|
checks=('archives',),
|
||||||
|
force=False,
|
||||||
|
) == ('archives',)
|
||||||
|
|
||||||
|
|
||||||
|
def test_filter_checks_on_frequency_skips_check_with_unelapsed_frequency():
|
||||||
|
flexmock(module).should_receive('parse_frequency').and_return(
|
||||||
|
module.datetime.timedelta(hours=1)
|
||||||
|
)
|
||||||
|
flexmock(module).should_receive('make_check_time_path')
|
||||||
|
flexmock(module).should_receive('read_check_time').and_return(module.datetime.datetime.now())
|
||||||
|
|
||||||
|
assert (
|
||||||
|
module.filter_checks_on_frequency(
|
||||||
|
location_config={},
|
||||||
|
consistency_config={'checks': [{'name': 'archives', 'frequency': '1 hour'}]},
|
||||||
|
borg_repository_id='repo',
|
||||||
|
checks=('archives',),
|
||||||
|
force=False,
|
||||||
|
)
|
||||||
|
== ()
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_filter_checks_on_frequency_restains_check_with_unelapsed_frequency_and_force():
|
||||||
|
assert module.filter_checks_on_frequency(
|
||||||
|
location_config={},
|
||||||
|
consistency_config={'checks': [{'name': 'archives', 'frequency': '1 hour'}]},
|
||||||
|
borg_repository_id='repo',
|
||||||
|
checks=('archives',),
|
||||||
|
force=True,
|
||||||
|
) == ('archives',)
|
||||||
|
|
||||||
|
|
||||||
def test_make_check_flags_with_repository_check_returns_flag():
|
def test_make_check_flags_with_repository_check_returns_flag():
|
||||||
flags = module._make_check_flags(('repository',))
|
flags = module.make_check_flags(('repository',))
|
||||||
|
|
||||||
assert flags == ('--repository-only',)
|
assert flags == ('--repository-only',)
|
||||||
|
|
||||||
|
|
||||||
def test_make_check_flags_with_archives_check_returns_flag():
|
def test_make_check_flags_with_archives_check_returns_flag():
|
||||||
flags = module._make_check_flags(('archives',))
|
flags = module.make_check_flags(('archives',))
|
||||||
|
|
||||||
assert flags == ('--archives-only',)
|
assert flags == ('--archives-only',)
|
||||||
|
|
||||||
|
|
||||||
def test_make_check_flags_with_data_check_returns_flag():
|
def test_make_check_flags_with_data_check_returns_flag():
|
||||||
flags = module._make_check_flags(('data',))
|
flags = module.make_check_flags(('data',))
|
||||||
|
|
||||||
assert flags == ('--verify-data',)
|
assert flags == ('--verify-data',)
|
||||||
|
|
||||||
|
|
||||||
def test_make_check_flags_with_extract_omits_extract_flag():
|
def test_make_check_flags_with_extract_omits_extract_flag():
|
||||||
flags = module._make_check_flags(('extract',))
|
flags = module.make_check_flags(('extract',))
|
||||||
|
|
||||||
assert flags == ()
|
assert flags == ()
|
||||||
|
|
||||||
|
|
||||||
def test_make_check_flags_with_default_checks_and_default_prefix_returns_default_flags():
|
def test_make_check_flags_with_default_checks_and_default_prefix_returns_default_flags():
|
||||||
flags = module._make_check_flags(module.DEFAULT_CHECKS, prefix=module.DEFAULT_PREFIX)
|
flags = module.make_check_flags(('repository', 'archives'), prefix=module.DEFAULT_PREFIX)
|
||||||
|
|
||||||
assert flags == ('--prefix', module.DEFAULT_PREFIX)
|
assert flags == ('--prefix', module.DEFAULT_PREFIX)
|
||||||
|
|
||||||
|
|
||||||
def test_make_check_flags_with_all_checks_and_default_prefix_returns_default_flags():
|
def test_make_check_flags_with_all_checks_and_default_prefix_returns_default_flags():
|
||||||
flags = module._make_check_flags(
|
flags = module.make_check_flags(
|
||||||
module.DEFAULT_CHECKS + ('extract',), prefix=module.DEFAULT_PREFIX
|
('repository', 'archives', 'extract'), prefix=module.DEFAULT_PREFIX
|
||||||
)
|
)
|
||||||
|
|
||||||
assert flags == ('--prefix', module.DEFAULT_PREFIX)
|
assert flags == ('--prefix', module.DEFAULT_PREFIX)
|
||||||
|
|
||||||
|
|
||||||
def test_make_check_flags_with_archives_check_and_last_includes_last_flag():
|
def test_make_check_flags_with_archives_check_and_last_includes_last_flag():
|
||||||
flags = module._make_check_flags(('archives',), check_last=3)
|
flags = module.make_check_flags(('archives',), check_last=3)
|
||||||
|
|
||||||
assert flags == ('--archives-only', '--last', '3')
|
assert flags == ('--archives-only', '--last', '3')
|
||||||
|
|
||||||
|
|
||||||
def test_make_check_flags_with_repository_check_and_last_omits_last_flag():
|
def test_make_check_flags_with_repository_check_and_last_omits_last_flag():
|
||||||
flags = module._make_check_flags(('repository',), check_last=3)
|
flags = module.make_check_flags(('repository',), check_last=3)
|
||||||
|
|
||||||
assert flags == ('--repository-only',)
|
assert flags == ('--repository-only',)
|
||||||
|
|
||||||
|
|
||||||
def test_make_check_flags_with_default_checks_and_last_includes_last_flag():
|
def test_make_check_flags_with_default_checks_and_last_includes_last_flag():
|
||||||
flags = module._make_check_flags(module.DEFAULT_CHECKS, check_last=3)
|
flags = module.make_check_flags(('repository', 'archives'), check_last=3)
|
||||||
|
|
||||||
assert flags == ('--last', '3')
|
assert flags == ('--last', '3')
|
||||||
|
|
||||||
|
|
||||||
def test_make_check_flags_with_archives_check_and_prefix_includes_prefix_flag():
|
def test_make_check_flags_with_archives_check_and_prefix_includes_prefix_flag():
|
||||||
flags = module._make_check_flags(('archives',), prefix='foo-')
|
flags = module.make_check_flags(('archives',), prefix='foo-')
|
||||||
|
|
||||||
assert flags == ('--archives-only', '--prefix', 'foo-')
|
assert flags == ('--archives-only', '--prefix', 'foo-')
|
||||||
|
|
||||||
|
|
||||||
def test_make_check_flags_with_archives_check_and_empty_prefix_omits_prefix_flag():
|
def test_make_check_flags_with_archives_check_and_empty_prefix_omits_prefix_flag():
|
||||||
flags = module._make_check_flags(('archives',), prefix='')
|
flags = module.make_check_flags(('archives',), prefix='')
|
||||||
|
|
||||||
assert flags == ('--archives-only',)
|
assert flags == ('--archives-only',)
|
||||||
|
|
||||||
|
|
||||||
def test_make_check_flags_with_archives_check_and_none_prefix_omits_prefix_flag():
|
def test_make_check_flags_with_archives_check_and_none_prefix_omits_prefix_flag():
|
||||||
flags = module._make_check_flags(('archives',), prefix=None)
|
flags = module.make_check_flags(('archives',), prefix=None)
|
||||||
|
|
||||||
assert flags == ('--archives-only',)
|
assert flags == ('--archives-only',)
|
||||||
|
|
||||||
|
|
||||||
def test_make_check_flags_with_repository_check_and_prefix_omits_prefix_flag():
|
def test_make_check_flags_with_repository_check_and_prefix_omits_prefix_flag():
|
||||||
flags = module._make_check_flags(('repository',), prefix='foo-')
|
flags = module.make_check_flags(('repository',), prefix='foo-')
|
||||||
|
|
||||||
assert flags == ('--repository-only',)
|
assert flags == ('--repository-only',)
|
||||||
|
|
||||||
|
|
||||||
def test_make_check_flags_with_default_checks_and_prefix_includes_prefix_flag():
|
def test_make_check_flags_with_default_checks_and_prefix_includes_prefix_flag():
|
||||||
flags = module._make_check_flags(module.DEFAULT_CHECKS, prefix='foo-')
|
flags = module.make_check_flags(('repository', 'archives'), prefix='foo-')
|
||||||
|
|
||||||
assert flags == ('--prefix', 'foo-')
|
assert flags == ('--prefix', 'foo-')
|
||||||
|
|
||||||
|
|
||||||
|
def test_read_check_time_does_not_raise():
|
||||||
|
flexmock(module.os).should_receive('stat').and_return(flexmock(st_mtime=123))
|
||||||
|
|
||||||
|
assert module.read_check_time('/path')
|
||||||
|
|
||||||
|
|
||||||
|
def test_read_check_time_on_missing_file_does_not_raise():
|
||||||
|
flexmock(module.os).should_receive('stat').and_raise(FileNotFoundError)
|
||||||
|
|
||||||
|
assert module.read_check_time('/path') is None
|
||||||
|
|
||||||
|
|
||||||
def test_check_archives_with_progress_calls_borg_with_progress_parameter():
|
def test_check_archives_with_progress_calls_borg_with_progress_parameter():
|
||||||
checks = ('repository',)
|
checks = ('repository',)
|
||||||
consistency_config = {'check_last': None}
|
consistency_config = {'check_last': None}
|
||||||
flexmock(module).should_receive('_parse_checks').and_return(checks)
|
flexmock(module).should_receive('parse_checks')
|
||||||
flexmock(module).should_receive('_make_check_flags').and_return(())
|
flexmock(module).should_receive('filter_checks_on_frequency').and_return(checks)
|
||||||
|
flexmock(module.info).should_receive('display_archives_info').and_return(
|
||||||
|
'{"repository": {"id": "repo"}}'
|
||||||
|
)
|
||||||
|
flexmock(module).should_receive('make_check_flags').and_return(())
|
||||||
flexmock(module).should_receive('execute_command').never()
|
flexmock(module).should_receive('execute_command').never()
|
||||||
flexmock(module).should_receive('execute_command').with_args(
|
flexmock(module).should_receive('execute_command').with_args(
|
||||||
('borg', 'check', '--progress', 'repo'), output_file=module.DO_NOT_CAPTURE
|
('borg', 'check', '--progress', 'repo'), output_file=module.DO_NOT_CAPTURE
|
||||||
).once()
|
).once()
|
||||||
|
flexmock(module).should_receive('make_check_time_path')
|
||||||
|
flexmock(module).should_receive('write_check_time')
|
||||||
|
|
||||||
module.check_archives(
|
module.check_archives(
|
||||||
repository='repo', storage_config={}, consistency_config=consistency_config, progress=True
|
repository='repo',
|
||||||
|
location_config={},
|
||||||
|
storage_config={},
|
||||||
|
consistency_config=consistency_config,
|
||||||
|
progress=True,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_check_archives_with_repair_calls_borg_with_repair_parameter():
|
def test_check_archives_with_repair_calls_borg_with_repair_parameter():
|
||||||
checks = ('repository',)
|
checks = ('repository',)
|
||||||
consistency_config = {'check_last': None}
|
consistency_config = {'check_last': None}
|
||||||
flexmock(module).should_receive('_parse_checks').and_return(checks)
|
flexmock(module).should_receive('parse_checks')
|
||||||
flexmock(module).should_receive('_make_check_flags').and_return(())
|
flexmock(module).should_receive('filter_checks_on_frequency').and_return(checks)
|
||||||
|
flexmock(module.info).should_receive('display_archives_info').and_return(
|
||||||
|
'{"repository": {"id": "repo"}}'
|
||||||
|
)
|
||||||
|
flexmock(module).should_receive('make_check_flags').and_return(())
|
||||||
flexmock(module).should_receive('execute_command').never()
|
flexmock(module).should_receive('execute_command').never()
|
||||||
flexmock(module).should_receive('execute_command').with_args(
|
flexmock(module).should_receive('execute_command').with_args(
|
||||||
('borg', 'check', '--repair', 'repo'), output_file=module.DO_NOT_CAPTURE
|
('borg', 'check', '--repair', 'repo'), output_file=module.DO_NOT_CAPTURE
|
||||||
).once()
|
).once()
|
||||||
|
flexmock(module).should_receive('make_check_time_path')
|
||||||
|
flexmock(module).should_receive('write_check_time')
|
||||||
|
|
||||||
module.check_archives(
|
module.check_archives(
|
||||||
repository='repo', storage_config={}, consistency_config=consistency_config, repair=True
|
repository='repo',
|
||||||
|
location_config={},
|
||||||
|
storage_config={},
|
||||||
|
consistency_config=consistency_config,
|
||||||
|
repair=True,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@ -198,64 +362,142 @@ def test_check_archives_with_repair_calls_borg_with_repair_parameter():
|
||||||
def test_check_archives_calls_borg_with_parameters(checks):
|
def test_check_archives_calls_borg_with_parameters(checks):
|
||||||
check_last = flexmock()
|
check_last = flexmock()
|
||||||
consistency_config = {'check_last': check_last}
|
consistency_config = {'check_last': check_last}
|
||||||
flexmock(module).should_receive('_parse_checks').and_return(checks)
|
flexmock(module).should_receive('parse_checks')
|
||||||
flexmock(module).should_receive('_make_check_flags').with_args(
|
flexmock(module).should_receive('filter_checks_on_frequency').and_return(checks)
|
||||||
|
flexmock(module.info).should_receive('display_archives_info').and_return(
|
||||||
|
'{"repository": {"id": "repo"}}'
|
||||||
|
)
|
||||||
|
flexmock(module).should_receive('make_check_flags').with_args(
|
||||||
checks, check_last, module.DEFAULT_PREFIX
|
checks, check_last, module.DEFAULT_PREFIX
|
||||||
).and_return(())
|
).and_return(())
|
||||||
insert_execute_command_mock(('borg', 'check', 'repo'))
|
insert_execute_command_mock(('borg', 'check', 'repo'))
|
||||||
|
flexmock(module).should_receive('make_check_time_path')
|
||||||
|
flexmock(module).should_receive('write_check_time')
|
||||||
|
|
||||||
module.check_archives(
|
module.check_archives(
|
||||||
repository='repo', storage_config={}, consistency_config=consistency_config
|
repository='repo',
|
||||||
|
location_config={},
|
||||||
|
storage_config={},
|
||||||
|
consistency_config=consistency_config,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_check_archives_with_json_error_raises():
|
||||||
|
checks = ('archives',)
|
||||||
|
check_last = flexmock()
|
||||||
|
consistency_config = {'check_last': check_last}
|
||||||
|
flexmock(module).should_receive('parse_checks')
|
||||||
|
flexmock(module).should_receive('filter_checks_on_frequency').and_return(checks)
|
||||||
|
flexmock(module.info).should_receive('display_archives_info').and_return(
|
||||||
|
'{"unexpected": {"id": "repo"}}'
|
||||||
|
)
|
||||||
|
|
||||||
|
with pytest.raises(ValueError):
|
||||||
|
module.check_archives(
|
||||||
|
repository='repo',
|
||||||
|
location_config={},
|
||||||
|
storage_config={},
|
||||||
|
consistency_config=consistency_config,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_check_archives_with_missing_json_keys_raises():
|
||||||
|
checks = ('archives',)
|
||||||
|
check_last = flexmock()
|
||||||
|
consistency_config = {'check_last': check_last}
|
||||||
|
flexmock(module).should_receive('parse_checks')
|
||||||
|
flexmock(module).should_receive('filter_checks_on_frequency').and_return(checks)
|
||||||
|
flexmock(module.info).should_receive('display_archives_info').and_return('{invalid JSON')
|
||||||
|
|
||||||
|
with pytest.raises(ValueError):
|
||||||
|
module.check_archives(
|
||||||
|
repository='repo',
|
||||||
|
location_config={},
|
||||||
|
storage_config={},
|
||||||
|
consistency_config=consistency_config,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_check_archives_with_extract_check_calls_extract_only():
|
def test_check_archives_with_extract_check_calls_extract_only():
|
||||||
checks = ('extract',)
|
checks = ('extract',)
|
||||||
check_last = flexmock()
|
check_last = flexmock()
|
||||||
consistency_config = {'check_last': check_last}
|
consistency_config = {'check_last': check_last}
|
||||||
flexmock(module).should_receive('_parse_checks').and_return(checks)
|
flexmock(module).should_receive('parse_checks')
|
||||||
flexmock(module).should_receive('_make_check_flags').never()
|
flexmock(module).should_receive('filter_checks_on_frequency').and_return(checks)
|
||||||
|
flexmock(module.info).should_receive('display_archives_info').and_return(
|
||||||
|
'{"repository": {"id": "repo"}}'
|
||||||
|
)
|
||||||
|
flexmock(module).should_receive('make_check_flags').never()
|
||||||
flexmock(module.extract).should_receive('extract_last_archive_dry_run').once()
|
flexmock(module.extract).should_receive('extract_last_archive_dry_run').once()
|
||||||
|
flexmock(module).should_receive('write_check_time')
|
||||||
insert_execute_command_never()
|
insert_execute_command_never()
|
||||||
|
|
||||||
module.check_archives(
|
module.check_archives(
|
||||||
repository='repo', storage_config={}, consistency_config=consistency_config
|
repository='repo',
|
||||||
|
location_config={},
|
||||||
|
storage_config={},
|
||||||
|
consistency_config=consistency_config,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_check_archives_with_log_info_calls_borg_with_info_parameter():
|
def test_check_archives_with_log_info_calls_borg_with_info_parameter():
|
||||||
checks = ('repository',)
|
checks = ('repository',)
|
||||||
consistency_config = {'check_last': None}
|
consistency_config = {'check_last': None}
|
||||||
flexmock(module).should_receive('_parse_checks').and_return(checks)
|
flexmock(module).should_receive('parse_checks')
|
||||||
flexmock(module).should_receive('_make_check_flags').and_return(())
|
flexmock(module).should_receive('filter_checks_on_frequency').and_return(checks)
|
||||||
|
flexmock(module.info).should_receive('display_archives_info').and_return(
|
||||||
|
'{"repository": {"id": "repo"}}'
|
||||||
|
)
|
||||||
|
flexmock(module).should_receive('make_check_flags').and_return(())
|
||||||
insert_logging_mock(logging.INFO)
|
insert_logging_mock(logging.INFO)
|
||||||
insert_execute_command_mock(('borg', 'check', '--info', 'repo'))
|
insert_execute_command_mock(('borg', 'check', '--info', 'repo'))
|
||||||
|
flexmock(module).should_receive('make_check_time_path')
|
||||||
|
flexmock(module).should_receive('write_check_time')
|
||||||
|
|
||||||
module.check_archives(
|
module.check_archives(
|
||||||
repository='repo', storage_config={}, consistency_config=consistency_config
|
repository='repo',
|
||||||
|
location_config={},
|
||||||
|
storage_config={},
|
||||||
|
consistency_config=consistency_config,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_check_archives_with_log_debug_calls_borg_with_debug_parameter():
|
def test_check_archives_with_log_debug_calls_borg_with_debug_parameter():
|
||||||
checks = ('repository',)
|
checks = ('repository',)
|
||||||
consistency_config = {'check_last': None}
|
consistency_config = {'check_last': None}
|
||||||
flexmock(module).should_receive('_parse_checks').and_return(checks)
|
flexmock(module).should_receive('parse_checks')
|
||||||
flexmock(module).should_receive('_make_check_flags').and_return(())
|
flexmock(module).should_receive('filter_checks_on_frequency').and_return(checks)
|
||||||
|
flexmock(module.info).should_receive('display_archives_info').and_return(
|
||||||
|
'{"repository": {"id": "repo"}}'
|
||||||
|
)
|
||||||
|
flexmock(module).should_receive('make_check_flags').and_return(())
|
||||||
insert_logging_mock(logging.DEBUG)
|
insert_logging_mock(logging.DEBUG)
|
||||||
insert_execute_command_mock(('borg', 'check', '--debug', '--show-rc', 'repo'))
|
insert_execute_command_mock(('borg', 'check', '--debug', '--show-rc', 'repo'))
|
||||||
|
flexmock(module).should_receive('make_check_time_path')
|
||||||
|
flexmock(module).should_receive('write_check_time')
|
||||||
|
|
||||||
module.check_archives(
|
module.check_archives(
|
||||||
repository='repo', storage_config={}, consistency_config=consistency_config
|
repository='repo',
|
||||||
|
location_config={},
|
||||||
|
storage_config={},
|
||||||
|
consistency_config=consistency_config,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_check_archives_without_any_checks_bails():
|
def test_check_archives_without_any_checks_bails():
|
||||||
consistency_config = {'check_last': None}
|
consistency_config = {'check_last': None}
|
||||||
flexmock(module).should_receive('_parse_checks').and_return(())
|
flexmock(module).should_receive('parse_checks')
|
||||||
|
flexmock(module).should_receive('filter_checks_on_frequency').and_return(())
|
||||||
|
flexmock(module.info).should_receive('display_archives_info').and_return(
|
||||||
|
'{"repository": {"id": "repo"}}'
|
||||||
|
)
|
||||||
insert_execute_command_never()
|
insert_execute_command_never()
|
||||||
|
|
||||||
module.check_archives(
|
module.check_archives(
|
||||||
repository='repo', storage_config={}, consistency_config=consistency_config
|
repository='repo',
|
||||||
|
location_config={},
|
||||||
|
storage_config={},
|
||||||
|
consistency_config=consistency_config,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@ -263,14 +505,21 @@ def test_check_archives_with_local_path_calls_borg_via_local_path():
|
||||||
checks = ('repository',)
|
checks = ('repository',)
|
||||||
check_last = flexmock()
|
check_last = flexmock()
|
||||||
consistency_config = {'check_last': check_last}
|
consistency_config = {'check_last': check_last}
|
||||||
flexmock(module).should_receive('_parse_checks').and_return(checks)
|
flexmock(module).should_receive('parse_checks')
|
||||||
flexmock(module).should_receive('_make_check_flags').with_args(
|
flexmock(module).should_receive('filter_checks_on_frequency').and_return(checks)
|
||||||
|
flexmock(module.info).should_receive('display_archives_info').and_return(
|
||||||
|
'{"repository": {"id": "repo"}}'
|
||||||
|
)
|
||||||
|
flexmock(module).should_receive('make_check_flags').with_args(
|
||||||
checks, check_last, module.DEFAULT_PREFIX
|
checks, check_last, module.DEFAULT_PREFIX
|
||||||
).and_return(())
|
).and_return(())
|
||||||
insert_execute_command_mock(('borg1', 'check', 'repo'))
|
insert_execute_command_mock(('borg1', 'check', 'repo'))
|
||||||
|
flexmock(module).should_receive('make_check_time_path')
|
||||||
|
flexmock(module).should_receive('write_check_time')
|
||||||
|
|
||||||
module.check_archives(
|
module.check_archives(
|
||||||
repository='repo',
|
repository='repo',
|
||||||
|
location_config={},
|
||||||
storage_config={},
|
storage_config={},
|
||||||
consistency_config=consistency_config,
|
consistency_config=consistency_config,
|
||||||
local_path='borg1',
|
local_path='borg1',
|
||||||
|
@ -281,14 +530,21 @@ def test_check_archives_with_remote_path_calls_borg_with_remote_path_parameters(
|
||||||
checks = ('repository',)
|
checks = ('repository',)
|
||||||
check_last = flexmock()
|
check_last = flexmock()
|
||||||
consistency_config = {'check_last': check_last}
|
consistency_config = {'check_last': check_last}
|
||||||
flexmock(module).should_receive('_parse_checks').and_return(checks)
|
flexmock(module).should_receive('parse_checks')
|
||||||
flexmock(module).should_receive('_make_check_flags').with_args(
|
flexmock(module).should_receive('filter_checks_on_frequency').and_return(checks)
|
||||||
|
flexmock(module.info).should_receive('display_archives_info').and_return(
|
||||||
|
'{"repository": {"id": "repo"}}'
|
||||||
|
)
|
||||||
|
flexmock(module).should_receive('make_check_flags').with_args(
|
||||||
checks, check_last, module.DEFAULT_PREFIX
|
checks, check_last, module.DEFAULT_PREFIX
|
||||||
).and_return(())
|
).and_return(())
|
||||||
insert_execute_command_mock(('borg', 'check', '--remote-path', 'borg1', 'repo'))
|
insert_execute_command_mock(('borg', 'check', '--remote-path', 'borg1', 'repo'))
|
||||||
|
flexmock(module).should_receive('make_check_time_path')
|
||||||
|
flexmock(module).should_receive('write_check_time')
|
||||||
|
|
||||||
module.check_archives(
|
module.check_archives(
|
||||||
repository='repo',
|
repository='repo',
|
||||||
|
location_config={},
|
||||||
storage_config={},
|
storage_config={},
|
||||||
consistency_config=consistency_config,
|
consistency_config=consistency_config,
|
||||||
remote_path='borg1',
|
remote_path='borg1',
|
||||||
|
@ -299,14 +555,23 @@ def test_check_archives_with_lock_wait_calls_borg_with_lock_wait_parameters():
|
||||||
checks = ('repository',)
|
checks = ('repository',)
|
||||||
check_last = flexmock()
|
check_last = flexmock()
|
||||||
consistency_config = {'check_last': check_last}
|
consistency_config = {'check_last': check_last}
|
||||||
flexmock(module).should_receive('_parse_checks').and_return(checks)
|
flexmock(module).should_receive('parse_checks')
|
||||||
flexmock(module).should_receive('_make_check_flags').with_args(
|
flexmock(module).should_receive('filter_checks_on_frequency').and_return(checks)
|
||||||
|
flexmock(module.info).should_receive('display_archives_info').and_return(
|
||||||
|
'{"repository": {"id": "repo"}}'
|
||||||
|
)
|
||||||
|
flexmock(module).should_receive('make_check_flags').with_args(
|
||||||
checks, check_last, module.DEFAULT_PREFIX
|
checks, check_last, module.DEFAULT_PREFIX
|
||||||
).and_return(())
|
).and_return(())
|
||||||
insert_execute_command_mock(('borg', 'check', '--lock-wait', '5', 'repo'))
|
insert_execute_command_mock(('borg', 'check', '--lock-wait', '5', 'repo'))
|
||||||
|
flexmock(module).should_receive('make_check_time_path')
|
||||||
|
flexmock(module).should_receive('write_check_time')
|
||||||
|
|
||||||
module.check_archives(
|
module.check_archives(
|
||||||
repository='repo', storage_config={'lock_wait': 5}, consistency_config=consistency_config
|
repository='repo',
|
||||||
|
location_config={},
|
||||||
|
storage_config={'lock_wait': 5},
|
||||||
|
consistency_config=consistency_config,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@ -315,26 +580,42 @@ def test_check_archives_with_retention_prefix():
|
||||||
check_last = flexmock()
|
check_last = flexmock()
|
||||||
prefix = 'foo-'
|
prefix = 'foo-'
|
||||||
consistency_config = {'check_last': check_last, 'prefix': prefix}
|
consistency_config = {'check_last': check_last, 'prefix': prefix}
|
||||||
flexmock(module).should_receive('_parse_checks').and_return(checks)
|
flexmock(module).should_receive('parse_checks')
|
||||||
flexmock(module).should_receive('_make_check_flags').with_args(
|
flexmock(module).should_receive('filter_checks_on_frequency').and_return(checks)
|
||||||
|
flexmock(module.info).should_receive('display_archives_info').and_return(
|
||||||
|
'{"repository": {"id": "repo"}}'
|
||||||
|
)
|
||||||
|
flexmock(module).should_receive('make_check_flags').with_args(
|
||||||
checks, check_last, prefix
|
checks, check_last, prefix
|
||||||
).and_return(())
|
).and_return(())
|
||||||
insert_execute_command_mock(('borg', 'check', 'repo'))
|
insert_execute_command_mock(('borg', 'check', 'repo'))
|
||||||
|
flexmock(module).should_receive('make_check_time_path')
|
||||||
|
flexmock(module).should_receive('write_check_time')
|
||||||
|
|
||||||
module.check_archives(
|
module.check_archives(
|
||||||
repository='repo', storage_config={}, consistency_config=consistency_config
|
repository='repo',
|
||||||
|
location_config={},
|
||||||
|
storage_config={},
|
||||||
|
consistency_config=consistency_config,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_check_archives_with_extra_borg_options_calls_borg_with_extra_options():
|
def test_check_archives_with_extra_borg_options_calls_borg_with_extra_options():
|
||||||
checks = ('repository',)
|
checks = ('repository',)
|
||||||
consistency_config = {'check_last': None}
|
consistency_config = {'check_last': None}
|
||||||
flexmock(module).should_receive('_parse_checks').and_return(checks)
|
flexmock(module).should_receive('parse_checks')
|
||||||
flexmock(module).should_receive('_make_check_flags').and_return(())
|
flexmock(module).should_receive('filter_checks_on_frequency').and_return(checks)
|
||||||
|
flexmock(module.info).should_receive('display_archives_info').and_return(
|
||||||
|
'{"repository": {"id": "repo"}}'
|
||||||
|
)
|
||||||
|
flexmock(module).should_receive('make_check_flags').and_return(())
|
||||||
insert_execute_command_mock(('borg', 'check', '--extra', '--options', 'repo'))
|
insert_execute_command_mock(('borg', 'check', '--extra', '--options', 'repo'))
|
||||||
|
flexmock(module).should_receive('make_check_time_path')
|
||||||
|
flexmock(module).should_receive('write_check_time')
|
||||||
|
|
||||||
module.check_archives(
|
module.check_archives(
|
||||||
repository='repo',
|
repository='repo',
|
||||||
|
location_config={},
|
||||||
storage_config={'extra_borg_options': {'check': '--extra --options'}},
|
storage_config={'extra_borg_options': {'check': '--extra --options'}},
|
||||||
consistency_config=consistency_config,
|
consistency_config=consistency_config,
|
||||||
)
|
)
|
||||||
|
|
|
@ -271,7 +271,9 @@ def test_borgmatic_source_directories_defaults_when_directory_not_given():
|
||||||
flexmock(module.os.path).should_receive('exists').and_return(True)
|
flexmock(module.os.path).should_receive('exists').and_return(True)
|
||||||
flexmock(module.os.path).should_receive('expanduser')
|
flexmock(module.os.path).should_receive('expanduser')
|
||||||
|
|
||||||
assert module.borgmatic_source_directories(None) == [module.DEFAULT_BORGMATIC_SOURCE_DIRECTORY]
|
assert module.borgmatic_source_directories(None) == [
|
||||||
|
module.state.DEFAULT_BORGMATIC_SOURCE_DIRECTORY
|
||||||
|
]
|
||||||
|
|
||||||
|
|
||||||
DEFAULT_ARCHIVE_NAME = '{hostname}-{now:%Y-%m-%dT%H:%M:%S.%f}'
|
DEFAULT_ARCHIVE_NAME = '{hostname}-{now:%Y-%m-%dT%H:%M:%S.%f}'
|
||||||
|
|
|
@ -13,11 +13,11 @@ INIT_COMMAND = ('borg', 'init', '--encryption', 'repokey')
|
||||||
|
|
||||||
|
|
||||||
def insert_info_command_found_mock():
|
def insert_info_command_found_mock():
|
||||||
flexmock(module).should_receive('execute_command')
|
flexmock(module.info).should_receive('display_archives_info')
|
||||||
|
|
||||||
|
|
||||||
def insert_info_command_not_found_mock():
|
def insert_info_command_not_found_mock():
|
||||||
flexmock(module).should_receive('execute_command').and_raise(
|
flexmock(module.info).should_receive('display_archives_info').and_raise(
|
||||||
subprocess.CalledProcessError(module.INFO_REPOSITORY_NOT_FOUND_EXIT_CODE, [])
|
subprocess.CalledProcessError(module.INFO_REPOSITORY_NOT_FOUND_EXIT_CODE, [])
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@ -48,13 +48,13 @@ def test_initialize_repository_raises_for_borg_init_error():
|
||||||
|
|
||||||
|
|
||||||
def test_initialize_repository_skips_initialization_when_repository_already_exists():
|
def test_initialize_repository_skips_initialization_when_repository_already_exists():
|
||||||
flexmock(module).should_receive('execute_command').once()
|
insert_info_command_found_mock()
|
||||||
|
|
||||||
module.initialize_repository(repository='repo', storage_config={}, encryption_mode='repokey')
|
module.initialize_repository(repository='repo', storage_config={}, encryption_mode='repokey')
|
||||||
|
|
||||||
|
|
||||||
def test_initialize_repository_raises_for_unknown_info_command_error():
|
def test_initialize_repository_raises_for_unknown_info_command_error():
|
||||||
flexmock(module).should_receive('execute_command').and_raise(
|
flexmock(module.info).should_receive('display_archives_info').and_raise(
|
||||||
subprocess.CalledProcessError(INFO_SOME_UNKNOWN_EXIT_CODE, [])
|
subprocess.CalledProcessError(INFO_SOME_UNKNOWN_EXIT_CODE, [])
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
|
@ -1,3 +1,4 @@
|
||||||
|
import argparse
|
||||||
import logging
|
import logging
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
|
@ -8,8 +9,6 @@ from borgmatic.borg import list as module
|
||||||
from ..test_verbosity import insert_logging_mock
|
from ..test_verbosity import insert_logging_mock
|
||||||
|
|
||||||
BORG_LIST_LATEST_ARGUMENTS = (
|
BORG_LIST_LATEST_ARGUMENTS = (
|
||||||
'--glob-archives',
|
|
||||||
module.BORG_EXCLUDE_CHECKPOINTS_GLOB,
|
|
||||||
'--last',
|
'--last',
|
||||||
'1',
|
'1',
|
||||||
'--short',
|
'--short',
|
||||||
|
@ -108,156 +107,125 @@ def test_resolve_archive_name_with_lock_wait_calls_borg_with_lock_wait_parameter
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_list_archives_calls_borg_with_parameters():
|
def test_make_list_command_includes_log_info():
|
||||||
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, successful=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)
|
insert_logging_mock(logging.INFO)
|
||||||
|
|
||||||
module.list_archives(
|
command = module.make_list_command(
|
||||||
repository='repo',
|
repository='repo',
|
||||||
storage_config={},
|
storage_config={},
|
||||||
list_arguments=flexmock(archive=None, paths=None, json=False, successful=False),
|
list_arguments=flexmock(archive=None, paths=None, json=False),
|
||||||
)
|
)
|
||||||
|
|
||||||
|
assert command == ('borg', 'list', '--info', 'repo')
|
||||||
|
|
||||||
def test_list_archives_with_log_info_and_json_suppresses_most_borg_output():
|
|
||||||
flexmock(module).should_receive('execute_command').with_args(
|
def test_make_list_command_includes_json_but_not_info():
|
||||||
('borg', 'list', '--json', 'repo'), output_log_level=None, borg_local_path='borg'
|
|
||||||
)
|
|
||||||
insert_logging_mock(logging.INFO)
|
insert_logging_mock(logging.INFO)
|
||||||
|
|
||||||
module.list_archives(
|
command = module.make_list_command(
|
||||||
repository='repo',
|
repository='repo',
|
||||||
storage_config={},
|
storage_config={},
|
||||||
list_arguments=flexmock(archive=None, paths=None, json=True, successful=False),
|
list_arguments=flexmock(archive=None, paths=None, json=True),
|
||||||
)
|
)
|
||||||
|
|
||||||
|
assert command == ('borg', 'list', '--json', 'repo')
|
||||||
|
|
||||||
def test_list_archives_with_log_debug_calls_borg_with_debug_parameter():
|
|
||||||
flexmock(module).should_receive('execute_command').with_args(
|
def test_make_list_command_includes_log_debug():
|
||||||
('borg', 'list', '--debug', '--show-rc', 'repo'),
|
|
||||||
output_log_level=logging.WARNING,
|
|
||||||
borg_local_path='borg',
|
|
||||||
)
|
|
||||||
insert_logging_mock(logging.DEBUG)
|
insert_logging_mock(logging.DEBUG)
|
||||||
|
|
||||||
module.list_archives(
|
command = module.make_list_command(
|
||||||
repository='repo',
|
repository='repo',
|
||||||
storage_config={},
|
storage_config={},
|
||||||
list_arguments=flexmock(archive=None, paths=None, json=False, successful=False),
|
list_arguments=flexmock(archive=None, paths=None, json=False),
|
||||||
)
|
)
|
||||||
|
|
||||||
|
assert command == ('borg', 'list', '--debug', '--show-rc', 'repo')
|
||||||
|
|
||||||
def test_list_archives_with_log_debug_and_json_suppresses_most_borg_output():
|
|
||||||
flexmock(module).should_receive('execute_command').with_args(
|
def test_make_list_command_includes_json_but_not_debug():
|
||||||
('borg', 'list', '--json', 'repo'), output_log_level=None, borg_local_path='borg'
|
|
||||||
)
|
|
||||||
insert_logging_mock(logging.DEBUG)
|
insert_logging_mock(logging.DEBUG)
|
||||||
|
|
||||||
module.list_archives(
|
command = module.make_list_command(
|
||||||
repository='repo',
|
repository='repo',
|
||||||
storage_config={},
|
storage_config={},
|
||||||
list_arguments=flexmock(archive=None, paths=None, json=True, successful=False),
|
list_arguments=flexmock(archive=None, paths=None, json=True),
|
||||||
)
|
)
|
||||||
|
|
||||||
|
assert command == ('borg', 'list', '--json', 'repo')
|
||||||
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, successful=False),
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def test_list_archives_with_archive_calls_borg_with_archive_parameter():
|
def test_make_list_command_includes_json():
|
||||||
storage_config = {}
|
command = module.make_list_command(
|
||||||
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, successful=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, successful=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',
|
repository='repo',
|
||||||
storage_config={},
|
storage_config={},
|
||||||
list_arguments=flexmock(archive=None, paths=None, json=False, successful=False),
|
list_arguments=flexmock(archive=None, paths=None, json=True),
|
||||||
local_path='borg1',
|
|
||||||
)
|
)
|
||||||
|
|
||||||
|
assert command == ('borg', 'list', '--json', 'repo')
|
||||||
|
|
||||||
def test_list_archives_with_remote_path_calls_borg_with_remote_path_parameters():
|
|
||||||
flexmock(module).should_receive('execute_command').with_args(
|
def test_make_list_command_includes_lock_wait():
|
||||||
('borg', 'list', '--remote-path', 'borg1', 'repo'),
|
command = module.make_list_command(
|
||||||
output_log_level=logging.WARNING,
|
repository='repo',
|
||||||
borg_local_path='borg',
|
storage_config={'lock_wait': 5},
|
||||||
|
list_arguments=flexmock(archive=None, paths=None, json=False),
|
||||||
)
|
)
|
||||||
|
|
||||||
module.list_archives(
|
assert command == ('borg', 'list', '--lock-wait', '5', 'repo')
|
||||||
|
|
||||||
|
|
||||||
|
def test_make_list_command_includes_archive():
|
||||||
|
command = module.make_list_command(
|
||||||
repository='repo',
|
repository='repo',
|
||||||
storage_config={},
|
storage_config={},
|
||||||
list_arguments=flexmock(archive=None, paths=None, json=False, successful=False),
|
list_arguments=flexmock(archive='archive', paths=None, json=False),
|
||||||
remote_path='borg1',
|
|
||||||
)
|
)
|
||||||
|
|
||||||
|
assert command == ('borg', 'list', 'repo::archive')
|
||||||
|
|
||||||
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(
|
def test_make_list_command_includes_archive_and_path():
|
||||||
|
command = module.make_list_command(
|
||||||
repository='repo',
|
repository='repo',
|
||||||
storage_config={},
|
storage_config={},
|
||||||
list_arguments=flexmock(archive=None, paths=None, json=False, successful=False, short=True),
|
list_arguments=flexmock(archive='archive', paths=['var/lib'], json=False),
|
||||||
)
|
)
|
||||||
|
|
||||||
|
assert command == ('borg', 'list', 'repo::archive', 'var/lib')
|
||||||
|
|
||||||
|
|
||||||
|
def test_make_list_command_includes_local_path():
|
||||||
|
command = module.make_list_command(
|
||||||
|
repository='repo',
|
||||||
|
storage_config={},
|
||||||
|
list_arguments=flexmock(archive=None, paths=None, json=False),
|
||||||
|
local_path='borg2',
|
||||||
|
)
|
||||||
|
|
||||||
|
assert command == ('borg2', 'list', 'repo')
|
||||||
|
|
||||||
|
|
||||||
|
def test_make_list_command_includes_remote_path():
|
||||||
|
command = module.make_list_command(
|
||||||
|
repository='repo',
|
||||||
|
storage_config={},
|
||||||
|
list_arguments=flexmock(archive=None, paths=None, json=False),
|
||||||
|
remote_path='borg2',
|
||||||
|
)
|
||||||
|
|
||||||
|
assert command == ('borg', 'list', '--remote-path', 'borg2', 'repo')
|
||||||
|
|
||||||
|
|
||||||
|
def test_make_list_command_includes_short():
|
||||||
|
command = module.make_list_command(
|
||||||
|
repository='repo',
|
||||||
|
storage_config={},
|
||||||
|
list_arguments=flexmock(archive=None, paths=None, json=False, short=True),
|
||||||
|
)
|
||||||
|
|
||||||
|
assert command == ('borg', 'list', '--short', 'repo')
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
@pytest.mark.parametrize(
|
||||||
'argument_name',
|
'argument_name',
|
||||||
|
@ -273,45 +241,156 @@ def test_list_archives_with_short_calls_borg_with_short_parameter():
|
||||||
'patterns_from',
|
'patterns_from',
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
def test_list_archives_passes_through_arguments_to_borg(argument_name):
|
def test_make_list_command_includes_additional_flags(argument_name):
|
||||||
flexmock(module).should_receive('execute_command').with_args(
|
command = module.make_list_command(
|
||||||
('borg', 'list', '--' + argument_name.replace('_', '-'), 'value', 'repo'),
|
|
||||||
output_log_level=logging.WARNING,
|
|
||||||
borg_local_path='borg',
|
|
||||||
).and_return('[]')
|
|
||||||
|
|
||||||
module.list_archives(
|
|
||||||
repository='repo',
|
repository='repo',
|
||||||
storage_config={},
|
storage_config={},
|
||||||
list_arguments=flexmock(
|
list_arguments=flexmock(
|
||||||
archive=None, paths=None, json=False, successful=False, **{argument_name: 'value'}
|
archive=None,
|
||||||
|
paths=None,
|
||||||
|
json=False,
|
||||||
|
find_paths=None,
|
||||||
|
format=None,
|
||||||
|
**{argument_name: 'value'}
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
|
|
||||||
|
assert command == ('borg', 'list', '--' + argument_name.replace('_', '-'), 'value', 'repo')
|
||||||
|
|
||||||
def test_list_archives_with_successful_calls_borg_to_exclude_checkpoints():
|
|
||||||
|
def test_make_find_paths_considers_none_as_empty_paths():
|
||||||
|
assert module.make_find_paths(None) == ()
|
||||||
|
|
||||||
|
|
||||||
|
def test_make_find_paths_passes_through_patterns():
|
||||||
|
find_paths = (
|
||||||
|
'fm:*',
|
||||||
|
'sh:**/*.txt',
|
||||||
|
're:^.*$',
|
||||||
|
'pp:root/somedir',
|
||||||
|
'pf:root/foo.txt',
|
||||||
|
'R /',
|
||||||
|
'r /',
|
||||||
|
'p /',
|
||||||
|
'P /',
|
||||||
|
'+ /',
|
||||||
|
'- /',
|
||||||
|
'! /',
|
||||||
|
)
|
||||||
|
|
||||||
|
assert module.make_find_paths(find_paths) == find_paths
|
||||||
|
|
||||||
|
|
||||||
|
def test_make_find_paths_adds_globs_to_path_fragments():
|
||||||
|
assert module.make_find_paths(('foo.txt',)) == ('sh:**/*foo.txt*/**',)
|
||||||
|
|
||||||
|
|
||||||
|
def test_list_archives_calls_borg_with_parameters():
|
||||||
|
list_arguments = argparse.Namespace(archive=None, paths=None, json=False, find_paths=None)
|
||||||
|
|
||||||
|
flexmock(module).should_receive('make_list_command').with_args(
|
||||||
|
repository='repo',
|
||||||
|
storage_config={},
|
||||||
|
list_arguments=list_arguments,
|
||||||
|
local_path='borg',
|
||||||
|
remote_path=None,
|
||||||
|
).and_return(('borg', 'list', 'repo'))
|
||||||
|
flexmock(module).should_receive('make_find_paths').and_return(())
|
||||||
flexmock(module).should_receive('execute_command').with_args(
|
flexmock(module).should_receive('execute_command').with_args(
|
||||||
('borg', 'list', '--glob-archives', module.BORG_EXCLUDE_CHECKPOINTS_GLOB, 'repo'),
|
('borg', 'list', 'repo'), output_log_level=logging.WARNING, borg_local_path='borg'
|
||||||
output_log_level=logging.WARNING,
|
).once()
|
||||||
borg_local_path='borg',
|
|
||||||
).and_return('[]')
|
|
||||||
|
|
||||||
module.list_archives(
|
module.list_archives(
|
||||||
repository='repo',
|
repository='repo', storage_config={}, list_arguments=list_arguments,
|
||||||
storage_config={},
|
|
||||||
list_arguments=flexmock(archive=None, paths=None, json=False, successful=True),
|
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_list_archives_with_json_calls_borg_with_json_parameter():
|
def test_list_archives_with_json_suppresses_most_borg_output():
|
||||||
|
list_arguments = argparse.Namespace(archive=None, paths=None, json=True, find_paths=None)
|
||||||
|
|
||||||
|
flexmock(module).should_receive('make_list_command').with_args(
|
||||||
|
repository='repo',
|
||||||
|
storage_config={},
|
||||||
|
list_arguments=list_arguments,
|
||||||
|
local_path='borg',
|
||||||
|
remote_path=None,
|
||||||
|
).and_return(('borg', 'list', 'repo'))
|
||||||
|
flexmock(module).should_receive('make_find_paths').and_return(())
|
||||||
flexmock(module).should_receive('execute_command').with_args(
|
flexmock(module).should_receive('execute_command').with_args(
|
||||||
('borg', 'list', '--json', 'repo'), output_log_level=None, borg_local_path='borg'
|
('borg', 'list', 'repo'), output_log_level=None, borg_local_path='borg'
|
||||||
).and_return('[]')
|
).once()
|
||||||
|
|
||||||
json_output = module.list_archives(
|
module.list_archives(
|
||||||
repository='repo',
|
repository='repo', storage_config={}, list_arguments=list_arguments,
|
||||||
storage_config={},
|
|
||||||
list_arguments=flexmock(archive=None, paths=None, json=True, successful=False),
|
|
||||||
)
|
)
|
||||||
|
|
||||||
assert json_output == '[]'
|
|
||||||
|
def test_list_archives_calls_borg_with_local_path():
|
||||||
|
list_arguments = argparse.Namespace(archive=None, paths=None, json=False, find_paths=None)
|
||||||
|
|
||||||
|
flexmock(module).should_receive('make_list_command').with_args(
|
||||||
|
repository='repo',
|
||||||
|
storage_config={},
|
||||||
|
list_arguments=list_arguments,
|
||||||
|
local_path='borg2',
|
||||||
|
remote_path=None,
|
||||||
|
).and_return(('borg2', 'list', 'repo'))
|
||||||
|
flexmock(module).should_receive('make_find_paths').and_return(())
|
||||||
|
flexmock(module).should_receive('execute_command').with_args(
|
||||||
|
('borg2', 'list', 'repo'), output_log_level=logging.WARNING, borg_local_path='borg2'
|
||||||
|
).once()
|
||||||
|
|
||||||
|
module.list_archives(
|
||||||
|
repository='repo', storage_config={}, list_arguments=list_arguments, local_path='borg2',
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_list_archives_calls_borg_multiple_times_with_find_paths():
|
||||||
|
glob_paths = ('**/*foo.txt*/**',)
|
||||||
|
list_arguments = argparse.Namespace(
|
||||||
|
archive=None, paths=None, json=False, find_paths=['foo.txt'], format=None
|
||||||
|
)
|
||||||
|
|
||||||
|
flexmock(module).should_receive('make_list_command').and_return(
|
||||||
|
('borg', 'list', 'repo')
|
||||||
|
).and_return(('borg', 'list', 'repo::archive1')).and_return(('borg', 'list', 'repo::archive2'))
|
||||||
|
flexmock(module).should_receive('make_find_paths').and_return(glob_paths)
|
||||||
|
flexmock(module).should_receive('execute_command').with_args(
|
||||||
|
('borg', 'list', 'repo'), output_log_level=None, borg_local_path='borg'
|
||||||
|
).and_return(
|
||||||
|
'archive1 Sun, 2022-05-29 15:27:04 [abc]\narchive2 Mon, 2022-05-30 19:47:15 [xyz]'
|
||||||
|
).once()
|
||||||
|
flexmock(module).should_receive('execute_command').with_args(
|
||||||
|
('borg', 'list', 'repo::archive1') + glob_paths,
|
||||||
|
output_log_level=logging.WARNING,
|
||||||
|
borg_local_path='borg',
|
||||||
|
).once()
|
||||||
|
flexmock(module).should_receive('execute_command').with_args(
|
||||||
|
('borg', 'list', 'repo::archive2') + glob_paths,
|
||||||
|
output_log_level=logging.WARNING,
|
||||||
|
borg_local_path='borg',
|
||||||
|
).once()
|
||||||
|
|
||||||
|
module.list_archives(
|
||||||
|
repository='repo', storage_config={}, list_arguments=list_arguments,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_list_archives_calls_borg_with_archive():
|
||||||
|
list_arguments = argparse.Namespace(archive='archive', paths=None, json=False, find_paths=None)
|
||||||
|
|
||||||
|
flexmock(module).should_receive('make_list_command').with_args(
|
||||||
|
repository='repo',
|
||||||
|
storage_config={},
|
||||||
|
list_arguments=list_arguments,
|
||||||
|
local_path='borg',
|
||||||
|
remote_path=None,
|
||||||
|
).and_return(('borg', 'list', 'repo::archive'))
|
||||||
|
flexmock(module).should_receive('make_find_paths').and_return(())
|
||||||
|
flexmock(module).should_receive('execute_command').with_args(
|
||||||
|
('borg', 'list', 'repo::archive'), output_log_level=logging.WARNING, borg_local_path='borg'
|
||||||
|
).once()
|
||||||
|
|
||||||
|
module.list_archives(
|
||||||
|
repository='repo', storage_config={}, list_arguments=list_arguments,
|
||||||
|
)
|
||||||
|
|
|
@ -35,99 +35,14 @@ def test_run_configuration_with_invalid_borg_version_errors():
|
||||||
list(module.run_configuration('test.yaml', config, arguments))
|
list(module.run_configuration('test.yaml', config, arguments))
|
||||||
|
|
||||||
|
|
||||||
def test_run_configuration_calls_hooks_for_prune_action():
|
def test_run_configuration_logs_monitor_start_error():
|
||||||
flexmock(module.borg_environment).should_receive('initialize')
|
flexmock(module.borg_environment).should_receive('initialize')
|
||||||
flexmock(module.borg_version).should_receive('local_borg_version').and_return(flexmock())
|
flexmock(module.borg_version).should_receive('local_borg_version').and_return(flexmock())
|
||||||
flexmock(module.command).should_receive('execute_hook').twice()
|
flexmock(module.dispatch).should_receive('call_hooks').and_raise(OSError).and_return(
|
||||||
flexmock(module.dispatch).should_receive('call_hooks').at_least().twice()
|
None
|
||||||
flexmock(module).should_receive('run_actions').and_return([])
|
).and_return(None)
|
||||||
config = {'location': {'repositories': ['foo']}}
|
|
||||||
arguments = {'global': flexmock(monitoring_verbosity=1, dry_run=False), 'prune': flexmock()}
|
|
||||||
|
|
||||||
list(module.run_configuration('test.yaml', config, arguments))
|
|
||||||
|
|
||||||
|
|
||||||
def test_run_configuration_calls_hooks_for_compact_action():
|
|
||||||
flexmock(module.borg_environment).should_receive('initialize')
|
|
||||||
flexmock(module.borg_version).should_receive('local_borg_version').and_return(flexmock())
|
|
||||||
flexmock(module.command).should_receive('execute_hook').twice()
|
|
||||||
flexmock(module).should_receive('run_actions').and_return([])
|
|
||||||
config = {'location': {'repositories': ['foo']}}
|
|
||||||
arguments = {'global': flexmock(monitoring_verbosity=1, dry_run=False), 'compact': flexmock()}
|
|
||||||
|
|
||||||
list(module.run_configuration('test.yaml', config, arguments))
|
|
||||||
|
|
||||||
|
|
||||||
def test_run_configuration_executes_and_calls_hooks_for_create_action():
|
|
||||||
flexmock(module.borg_environment).should_receive('initialize')
|
|
||||||
flexmock(module.borg_version).should_receive('local_borg_version').and_return(flexmock())
|
|
||||||
flexmock(module.command).should_receive('execute_hook').twice()
|
|
||||||
flexmock(module.dispatch).should_receive('call_hooks').at_least().twice()
|
|
||||||
flexmock(module).should_receive('run_actions').and_return([])
|
|
||||||
config = {'location': {'repositories': ['foo']}}
|
|
||||||
arguments = {'global': flexmock(monitoring_verbosity=1, dry_run=False), 'create': flexmock()}
|
|
||||||
|
|
||||||
list(module.run_configuration('test.yaml', config, arguments))
|
|
||||||
|
|
||||||
|
|
||||||
def test_run_configuration_calls_hooks_for_check_action():
|
|
||||||
flexmock(module.borg_environment).should_receive('initialize')
|
|
||||||
flexmock(module.borg_version).should_receive('local_borg_version').and_return(flexmock())
|
|
||||||
flexmock(module.command).should_receive('execute_hook').twice()
|
|
||||||
flexmock(module.dispatch).should_receive('call_hooks').at_least().twice()
|
|
||||||
flexmock(module).should_receive('run_actions').and_return([])
|
|
||||||
config = {'location': {'repositories': ['foo']}}
|
|
||||||
arguments = {'global': flexmock(monitoring_verbosity=1, dry_run=False), 'check': flexmock()}
|
|
||||||
|
|
||||||
list(module.run_configuration('test.yaml', config, arguments))
|
|
||||||
|
|
||||||
|
|
||||||
def test_run_configuration_calls_hooks_for_extract_action():
|
|
||||||
flexmock(module.borg_environment).should_receive('initialize')
|
|
||||||
flexmock(module.borg_version).should_receive('local_borg_version').and_return(flexmock())
|
|
||||||
flexmock(module.command).should_receive('execute_hook').twice()
|
|
||||||
flexmock(module.dispatch).should_receive('call_hooks').never()
|
|
||||||
flexmock(module).should_receive('run_actions').and_return([])
|
|
||||||
config = {'location': {'repositories': ['foo']}}
|
|
||||||
arguments = {'global': flexmock(monitoring_verbosity=1, dry_run=False), 'extract': flexmock()}
|
|
||||||
|
|
||||||
list(module.run_configuration('test.yaml', config, arguments))
|
|
||||||
|
|
||||||
|
|
||||||
def test_run_configuration_does_not_trigger_hooks_for_list_action():
|
|
||||||
flexmock(module.borg_environment).should_receive('initialize')
|
|
||||||
flexmock(module.borg_version).should_receive('local_borg_version').and_return(flexmock())
|
|
||||||
flexmock(module.command).should_receive('execute_hook').never()
|
|
||||||
flexmock(module.dispatch).should_receive('call_hooks').never()
|
|
||||||
flexmock(module).should_receive('run_actions').and_return([])
|
|
||||||
config = {'location': {'repositories': ['foo']}}
|
|
||||||
arguments = {'global': flexmock(monitoring_verbosity=1, dry_run=False), 'list': flexmock()}
|
|
||||||
|
|
||||||
list(module.run_configuration('test.yaml', config, arguments))
|
|
||||||
|
|
||||||
|
|
||||||
def test_run_configuration_logs_actions_error():
|
|
||||||
flexmock(module.borg_environment).should_receive('initialize')
|
|
||||||
flexmock(module.borg_version).should_receive('local_borg_version').and_return(flexmock())
|
|
||||||
flexmock(module.command).should_receive('execute_hook')
|
|
||||||
flexmock(module.dispatch).should_receive('call_hooks')
|
|
||||||
expected_results = [flexmock()]
|
expected_results = [flexmock()]
|
||||||
flexmock(module).should_receive('make_error_log_records').and_return(expected_results)
|
flexmock(module).should_receive('log_error_records').and_return(expected_results)
|
||||||
flexmock(module).should_receive('run_actions').and_raise(OSError)
|
|
||||||
config = {'location': {'repositories': ['foo']}}
|
|
||||||
arguments = {'global': flexmock(monitoring_verbosity=1, dry_run=False)}
|
|
||||||
|
|
||||||
results = list(module.run_configuration('test.yaml', config, arguments))
|
|
||||||
|
|
||||||
assert results == expected_results
|
|
||||||
|
|
||||||
|
|
||||||
def test_run_configuration_logs_pre_hook_error():
|
|
||||||
flexmock(module.borg_environment).should_receive('initialize')
|
|
||||||
flexmock(module.borg_version).should_receive('local_borg_version').and_return(flexmock())
|
|
||||||
flexmock(module.command).should_receive('execute_hook').and_raise(OSError).and_return(None)
|
|
||||||
expected_results = [flexmock()]
|
|
||||||
flexmock(module).should_receive('make_error_log_records').and_return(expected_results)
|
|
||||||
flexmock(module).should_receive('run_actions').never()
|
flexmock(module).should_receive('run_actions').never()
|
||||||
config = {'location': {'repositories': ['foo']}}
|
config = {'location': {'repositories': ['foo']}}
|
||||||
arguments = {'global': flexmock(monitoring_verbosity=1, dry_run=False), 'create': flexmock()}
|
arguments = {'global': flexmock(monitoring_verbosity=1, dry_run=False), 'create': flexmock()}
|
||||||
|
@ -137,12 +52,12 @@ def test_run_configuration_logs_pre_hook_error():
|
||||||
assert results == expected_results
|
assert results == expected_results
|
||||||
|
|
||||||
|
|
||||||
def test_run_configuration_bails_for_pre_hook_soft_failure():
|
def test_run_configuration_bails_for_monitor_start_soft_failure():
|
||||||
flexmock(module.borg_environment).should_receive('initialize')
|
flexmock(module.borg_environment).should_receive('initialize')
|
||||||
flexmock(module.borg_version).should_receive('local_borg_version').and_return(flexmock())
|
flexmock(module.borg_version).should_receive('local_borg_version').and_return(flexmock())
|
||||||
error = subprocess.CalledProcessError(borgmatic.hooks.command.SOFT_FAIL_EXIT_CODE, 'try again')
|
error = subprocess.CalledProcessError(borgmatic.hooks.command.SOFT_FAIL_EXIT_CODE, 'try again')
|
||||||
flexmock(module.command).should_receive('execute_hook').and_raise(error).and_return(None)
|
flexmock(module.dispatch).should_receive('call_hooks').and_raise(error)
|
||||||
flexmock(module).should_receive('make_error_log_records').never()
|
flexmock(module).should_receive('log_error_records').never()
|
||||||
flexmock(module).should_receive('run_actions').never()
|
flexmock(module).should_receive('run_actions').never()
|
||||||
config = {'location': {'repositories': ['foo']}}
|
config = {'location': {'repositories': ['foo']}}
|
||||||
arguments = {'global': flexmock(monitoring_verbosity=1, dry_run=False), 'create': flexmock()}
|
arguments = {'global': flexmock(monitoring_verbosity=1, dry_run=False), 'create': flexmock()}
|
||||||
|
@ -152,15 +67,46 @@ def test_run_configuration_bails_for_pre_hook_soft_failure():
|
||||||
assert results == []
|
assert results == []
|
||||||
|
|
||||||
|
|
||||||
def test_run_configuration_logs_post_hook_error():
|
def test_run_configuration_logs_actions_error():
|
||||||
flexmock(module.borg_environment).should_receive('initialize')
|
flexmock(module.borg_environment).should_receive('initialize')
|
||||||
flexmock(module.borg_version).should_receive('local_borg_version').and_return(flexmock())
|
flexmock(module.borg_version).should_receive('local_borg_version').and_return(flexmock())
|
||||||
flexmock(module.command).should_receive('execute_hook').and_return(None).and_raise(
|
flexmock(module.command).should_receive('execute_hook')
|
||||||
OSError
|
|
||||||
).and_return(None)
|
|
||||||
flexmock(module.dispatch).should_receive('call_hooks')
|
flexmock(module.dispatch).should_receive('call_hooks')
|
||||||
expected_results = [flexmock()]
|
expected_results = [flexmock()]
|
||||||
flexmock(module).should_receive('make_error_log_records').and_return(expected_results)
|
flexmock(module).should_receive('log_error_records').and_return(expected_results)
|
||||||
|
flexmock(module).should_receive('run_actions').and_raise(OSError)
|
||||||
|
config = {'location': {'repositories': ['foo']}}
|
||||||
|
arguments = {'global': flexmock(monitoring_verbosity=1, dry_run=False)}
|
||||||
|
|
||||||
|
results = list(module.run_configuration('test.yaml', config, arguments))
|
||||||
|
|
||||||
|
assert results == expected_results
|
||||||
|
|
||||||
|
|
||||||
|
def test_run_configuration_bails_for_actions_soft_failure():
|
||||||
|
flexmock(module.borg_environment).should_receive('initialize')
|
||||||
|
flexmock(module.borg_version).should_receive('local_borg_version').and_return(flexmock())
|
||||||
|
flexmock(module.dispatch).should_receive('call_hooks')
|
||||||
|
error = subprocess.CalledProcessError(borgmatic.hooks.command.SOFT_FAIL_EXIT_CODE, 'try again')
|
||||||
|
flexmock(module).should_receive('run_actions').and_raise(error)
|
||||||
|
flexmock(module).should_receive('log_error_records').never()
|
||||||
|
flexmock(module.command).should_receive('considered_soft_failure').and_return(True)
|
||||||
|
config = {'location': {'repositories': ['foo']}}
|
||||||
|
arguments = {'global': flexmock(monitoring_verbosity=1, dry_run=False), 'create': flexmock()}
|
||||||
|
|
||||||
|
results = list(module.run_configuration('test.yaml', config, arguments))
|
||||||
|
|
||||||
|
assert results == []
|
||||||
|
|
||||||
|
|
||||||
|
def test_run_configuration_logs_monitor_finish_error():
|
||||||
|
flexmock(module.borg_environment).should_receive('initialize')
|
||||||
|
flexmock(module.borg_version).should_receive('local_borg_version').and_return(flexmock())
|
||||||
|
flexmock(module.dispatch).should_receive('call_hooks').and_return(None).and_return(
|
||||||
|
None
|
||||||
|
).and_raise(OSError)
|
||||||
|
expected_results = [flexmock()]
|
||||||
|
flexmock(module).should_receive('log_error_records').and_return(expected_results)
|
||||||
flexmock(module).should_receive('run_actions').and_return([])
|
flexmock(module).should_receive('run_actions').and_return([])
|
||||||
config = {'location': {'repositories': ['foo']}}
|
config = {'location': {'repositories': ['foo']}}
|
||||||
arguments = {'global': flexmock(monitoring_verbosity=1, dry_run=False), 'create': flexmock()}
|
arguments = {'global': flexmock(monitoring_verbosity=1, dry_run=False), 'create': flexmock()}
|
||||||
|
@ -170,16 +116,16 @@ def test_run_configuration_logs_post_hook_error():
|
||||||
assert results == expected_results
|
assert results == expected_results
|
||||||
|
|
||||||
|
|
||||||
def test_run_configuration_bails_for_post_hook_soft_failure():
|
def test_run_configuration_bails_for_monitor_finish_soft_failure():
|
||||||
flexmock(module.borg_environment).should_receive('initialize')
|
flexmock(module.borg_environment).should_receive('initialize')
|
||||||
flexmock(module.borg_version).should_receive('local_borg_version').and_return(flexmock())
|
flexmock(module.borg_version).should_receive('local_borg_version').and_return(flexmock())
|
||||||
error = subprocess.CalledProcessError(borgmatic.hooks.command.SOFT_FAIL_EXIT_CODE, 'try again')
|
error = subprocess.CalledProcessError(borgmatic.hooks.command.SOFT_FAIL_EXIT_CODE, 'try again')
|
||||||
flexmock(module.command).should_receive('execute_hook').and_return(None).and_raise(
|
flexmock(module.dispatch).should_receive('call_hooks').and_return(None).and_return(
|
||||||
error
|
None
|
||||||
).and_return(None)
|
).and_raise(error)
|
||||||
flexmock(module.dispatch).should_receive('call_hooks')
|
flexmock(module).should_receive('log_error_records').never()
|
||||||
flexmock(module).should_receive('make_error_log_records').never()
|
|
||||||
flexmock(module).should_receive('run_actions').and_return([])
|
flexmock(module).should_receive('run_actions').and_return([])
|
||||||
|
flexmock(module.command).should_receive('considered_soft_failure').and_return(True)
|
||||||
config = {'location': {'repositories': ['foo']}}
|
config = {'location': {'repositories': ['foo']}}
|
||||||
arguments = {'global': flexmock(monitoring_verbosity=1, dry_run=False), 'create': flexmock()}
|
arguments = {'global': flexmock(monitoring_verbosity=1, dry_run=False), 'create': flexmock()}
|
||||||
|
|
||||||
|
@ -193,7 +139,7 @@ def test_run_configuration_logs_on_error_hook_error():
|
||||||
flexmock(module.borg_version).should_receive('local_borg_version').and_return(flexmock())
|
flexmock(module.borg_version).should_receive('local_borg_version').and_return(flexmock())
|
||||||
flexmock(module.command).should_receive('execute_hook').and_raise(OSError)
|
flexmock(module.command).should_receive('execute_hook').and_raise(OSError)
|
||||||
expected_results = [flexmock(), flexmock()]
|
expected_results = [flexmock(), flexmock()]
|
||||||
flexmock(module).should_receive('make_error_log_records').and_return(
|
flexmock(module).should_receive('log_error_records').and_return(
|
||||||
expected_results[:1]
|
expected_results[:1]
|
||||||
).and_return(expected_results[1:])
|
).and_return(expected_results[1:])
|
||||||
flexmock(module).should_receive('run_actions').and_raise(OSError)
|
flexmock(module).should_receive('run_actions').and_raise(OSError)
|
||||||
|
@ -209,9 +155,9 @@ def test_run_configuration_bails_for_on_error_hook_soft_failure():
|
||||||
flexmock(module.borg_environment).should_receive('initialize')
|
flexmock(module.borg_environment).should_receive('initialize')
|
||||||
flexmock(module.borg_version).should_receive('local_borg_version').and_return(flexmock())
|
flexmock(module.borg_version).should_receive('local_borg_version').and_return(flexmock())
|
||||||
error = subprocess.CalledProcessError(borgmatic.hooks.command.SOFT_FAIL_EXIT_CODE, 'try again')
|
error = subprocess.CalledProcessError(borgmatic.hooks.command.SOFT_FAIL_EXIT_CODE, 'try again')
|
||||||
flexmock(module.command).should_receive('execute_hook').and_return(None).and_raise(error)
|
flexmock(module.command).should_receive('execute_hook').and_raise(error)
|
||||||
expected_results = [flexmock()]
|
expected_results = [flexmock()]
|
||||||
flexmock(module).should_receive('make_error_log_records').and_return(expected_results)
|
flexmock(module).should_receive('log_error_records').and_return(expected_results)
|
||||||
flexmock(module).should_receive('run_actions').and_raise(OSError)
|
flexmock(module).should_receive('run_actions').and_raise(OSError)
|
||||||
config = {'location': {'repositories': ['foo']}}
|
config = {'location': {'repositories': ['foo']}}
|
||||||
arguments = {'global': flexmock(monitoring_verbosity=1, dry_run=False), 'create': flexmock()}
|
arguments = {'global': flexmock(monitoring_verbosity=1, dry_run=False), 'create': flexmock()}
|
||||||
|
@ -227,12 +173,11 @@ def test_run_configuration_retries_soft_error():
|
||||||
flexmock(module.borg_version).should_receive('local_borg_version').and_return(flexmock())
|
flexmock(module.borg_version).should_receive('local_borg_version').and_return(flexmock())
|
||||||
flexmock(module.command).should_receive('execute_hook')
|
flexmock(module.command).should_receive('execute_hook')
|
||||||
flexmock(module).should_receive('run_actions').and_raise(OSError).and_return([])
|
flexmock(module).should_receive('run_actions').and_raise(OSError).and_return([])
|
||||||
expected_results = [flexmock()]
|
flexmock(module).should_receive('log_error_records').and_return([flexmock()]).once()
|
||||||
flexmock(module).should_receive('make_error_log_records').and_return(expected_results).once()
|
|
||||||
config = {'location': {'repositories': ['foo']}, 'storage': {'retries': 1}}
|
config = {'location': {'repositories': ['foo']}, 'storage': {'retries': 1}}
|
||||||
arguments = {'global': flexmock(monitoring_verbosity=1, dry_run=False), 'create': flexmock()}
|
arguments = {'global': flexmock(monitoring_verbosity=1, dry_run=False), 'create': flexmock()}
|
||||||
results = list(module.run_configuration('test.yaml', config, arguments))
|
results = list(module.run_configuration('test.yaml', config, arguments))
|
||||||
assert results == expected_results
|
assert results == []
|
||||||
|
|
||||||
|
|
||||||
def test_run_configuration_retries_hard_error():
|
def test_run_configuration_retries_hard_error():
|
||||||
|
@ -241,18 +186,20 @@ def test_run_configuration_retries_hard_error():
|
||||||
flexmock(module.borg_version).should_receive('local_borg_version').and_return(flexmock())
|
flexmock(module.borg_version).should_receive('local_borg_version').and_return(flexmock())
|
||||||
flexmock(module.command).should_receive('execute_hook')
|
flexmock(module.command).should_receive('execute_hook')
|
||||||
flexmock(module).should_receive('run_actions').and_raise(OSError).times(2)
|
flexmock(module).should_receive('run_actions').and_raise(OSError).times(2)
|
||||||
expected_results = [flexmock(), flexmock()]
|
flexmock(module).should_receive('log_error_records').with_args(
|
||||||
flexmock(module).should_receive('make_error_log_records').with_args(
|
'foo: Error running actions for repository',
|
||||||
'foo: Error running actions for repository', OSError
|
OSError,
|
||||||
).and_return(expected_results[:1]).with_args(
|
levelno=logging.WARNING,
|
||||||
'foo: Error running actions for repository', OSError
|
log_command_error_output=True,
|
||||||
).and_return(
|
).and_return([flexmock()])
|
||||||
expected_results[1:]
|
error_logs = [flexmock()]
|
||||||
).twice()
|
flexmock(module).should_receive('log_error_records').with_args(
|
||||||
|
'foo: Error running actions for repository', OSError,
|
||||||
|
).and_return(error_logs)
|
||||||
config = {'location': {'repositories': ['foo']}, 'storage': {'retries': 1}}
|
config = {'location': {'repositories': ['foo']}, 'storage': {'retries': 1}}
|
||||||
arguments = {'global': flexmock(monitoring_verbosity=1, dry_run=False), 'create': flexmock()}
|
arguments = {'global': flexmock(monitoring_verbosity=1, dry_run=False), 'create': flexmock()}
|
||||||
results = list(module.run_configuration('test.yaml', config, arguments))
|
results = list(module.run_configuration('test.yaml', config, arguments))
|
||||||
assert results == expected_results
|
assert results == error_logs
|
||||||
|
|
||||||
|
|
||||||
def test_run_repos_ordered():
|
def test_run_repos_ordered():
|
||||||
|
@ -261,10 +208,10 @@ def test_run_repos_ordered():
|
||||||
flexmock(module.command).should_receive('execute_hook')
|
flexmock(module.command).should_receive('execute_hook')
|
||||||
flexmock(module).should_receive('run_actions').and_raise(OSError).times(2)
|
flexmock(module).should_receive('run_actions').and_raise(OSError).times(2)
|
||||||
expected_results = [flexmock(), flexmock()]
|
expected_results = [flexmock(), flexmock()]
|
||||||
flexmock(module).should_receive('make_error_log_records').with_args(
|
flexmock(module).should_receive('log_error_records').with_args(
|
||||||
'foo: Error running actions for repository', OSError
|
'foo: Error running actions for repository', OSError
|
||||||
).and_return(expected_results[:1]).ordered()
|
).and_return(expected_results[:1]).ordered()
|
||||||
flexmock(module).should_receive('make_error_log_records').with_args(
|
flexmock(module).should_receive('log_error_records').with_args(
|
||||||
'bar: Error running actions for repository', OSError
|
'bar: Error running actions for repository', OSError
|
||||||
).and_return(expected_results[1:]).ordered()
|
).and_return(expected_results[1:]).ordered()
|
||||||
config = {'location': {'repositories': ['foo', 'bar']}}
|
config = {'location': {'repositories': ['foo', 'bar']}}
|
||||||
|
@ -278,23 +225,30 @@ def test_run_configuration_retries_round_robbin():
|
||||||
flexmock(module.borg_version).should_receive('local_borg_version').and_return(flexmock())
|
flexmock(module.borg_version).should_receive('local_borg_version').and_return(flexmock())
|
||||||
flexmock(module.command).should_receive('execute_hook')
|
flexmock(module.command).should_receive('execute_hook')
|
||||||
flexmock(module).should_receive('run_actions').and_raise(OSError).times(4)
|
flexmock(module).should_receive('run_actions').and_raise(OSError).times(4)
|
||||||
expected_results = [flexmock(), flexmock(), flexmock(), flexmock()]
|
flexmock(module).should_receive('log_error_records').with_args(
|
||||||
flexmock(module).should_receive('make_error_log_records').with_args(
|
'foo: Error running actions for repository',
|
||||||
|
OSError,
|
||||||
|
levelno=logging.WARNING,
|
||||||
|
log_command_error_output=True,
|
||||||
|
).and_return([flexmock()]).ordered()
|
||||||
|
flexmock(module).should_receive('log_error_records').with_args(
|
||||||
|
'bar: Error running actions for repository',
|
||||||
|
OSError,
|
||||||
|
levelno=logging.WARNING,
|
||||||
|
log_command_error_output=True,
|
||||||
|
).and_return([flexmock()]).ordered()
|
||||||
|
foo_error_logs = [flexmock()]
|
||||||
|
flexmock(module).should_receive('log_error_records').with_args(
|
||||||
'foo: Error running actions for repository', OSError
|
'foo: Error running actions for repository', OSError
|
||||||
).and_return(expected_results[0:1]).ordered()
|
).and_return(foo_error_logs).ordered()
|
||||||
flexmock(module).should_receive('make_error_log_records').with_args(
|
bar_error_logs = [flexmock()]
|
||||||
|
flexmock(module).should_receive('log_error_records').with_args(
|
||||||
'bar: Error running actions for repository', OSError
|
'bar: Error running actions for repository', OSError
|
||||||
).and_return(expected_results[1:2]).ordered()
|
).and_return(bar_error_logs).ordered()
|
||||||
flexmock(module).should_receive('make_error_log_records').with_args(
|
|
||||||
'foo: Error running actions for repository', OSError
|
|
||||||
).and_return(expected_results[2:3]).ordered()
|
|
||||||
flexmock(module).should_receive('make_error_log_records').with_args(
|
|
||||||
'bar: Error running actions for repository', OSError
|
|
||||||
).and_return(expected_results[3:4]).ordered()
|
|
||||||
config = {'location': {'repositories': ['foo', 'bar']}, 'storage': {'retries': 1}}
|
config = {'location': {'repositories': ['foo', 'bar']}, 'storage': {'retries': 1}}
|
||||||
arguments = {'global': flexmock(monitoring_verbosity=1, dry_run=False), 'create': flexmock()}
|
arguments = {'global': flexmock(monitoring_verbosity=1, dry_run=False), 'create': flexmock()}
|
||||||
results = list(module.run_configuration('test.yaml', config, arguments))
|
results = list(module.run_configuration('test.yaml', config, arguments))
|
||||||
assert results == expected_results
|
assert results == foo_error_logs + bar_error_logs
|
||||||
|
|
||||||
|
|
||||||
def test_run_configuration_retries_one_passes():
|
def test_run_configuration_retries_one_passes():
|
||||||
|
@ -304,20 +258,26 @@ def test_run_configuration_retries_one_passes():
|
||||||
flexmock(module).should_receive('run_actions').and_raise(OSError).and_raise(OSError).and_return(
|
flexmock(module).should_receive('run_actions').and_raise(OSError).and_raise(OSError).and_return(
|
||||||
[]
|
[]
|
||||||
).and_raise(OSError).times(4)
|
).and_raise(OSError).times(4)
|
||||||
expected_results = [flexmock(), flexmock(), flexmock()]
|
flexmock(module).should_receive('log_error_records').with_args(
|
||||||
flexmock(module).should_receive('make_error_log_records').with_args(
|
'foo: Error running actions for repository',
|
||||||
'foo: Error running actions for repository', OSError
|
OSError,
|
||||||
).and_return(expected_results[0:1]).ordered()
|
levelno=logging.WARNING,
|
||||||
flexmock(module).should_receive('make_error_log_records').with_args(
|
log_command_error_output=True,
|
||||||
|
).and_return([flexmock()]).ordered()
|
||||||
|
flexmock(module).should_receive('log_error_records').with_args(
|
||||||
|
'bar: Error running actions for repository',
|
||||||
|
OSError,
|
||||||
|
levelno=logging.WARNING,
|
||||||
|
log_command_error_output=True,
|
||||||
|
).and_return(flexmock()).ordered()
|
||||||
|
error_logs = [flexmock()]
|
||||||
|
flexmock(module).should_receive('log_error_records').with_args(
|
||||||
'bar: Error running actions for repository', OSError
|
'bar: Error running actions for repository', OSError
|
||||||
).and_return(expected_results[1:2]).ordered()
|
).and_return(error_logs).ordered()
|
||||||
flexmock(module).should_receive('make_error_log_records').with_args(
|
|
||||||
'bar: Error running actions for repository', OSError
|
|
||||||
).and_return(expected_results[2:3]).ordered()
|
|
||||||
config = {'location': {'repositories': ['foo', 'bar']}, 'storage': {'retries': 1}}
|
config = {'location': {'repositories': ['foo', 'bar']}, 'storage': {'retries': 1}}
|
||||||
arguments = {'global': flexmock(monitoring_verbosity=1, dry_run=False), 'create': flexmock()}
|
arguments = {'global': flexmock(monitoring_verbosity=1, dry_run=False), 'create': flexmock()}
|
||||||
results = list(module.run_configuration('test.yaml', config, arguments))
|
results = list(module.run_configuration('test.yaml', config, arguments))
|
||||||
assert results == expected_results
|
assert results == error_logs
|
||||||
|
|
||||||
|
|
||||||
def test_run_configuration_retry_wait():
|
def test_run_configuration_retry_wait():
|
||||||
|
@ -325,29 +285,38 @@ def test_run_configuration_retry_wait():
|
||||||
flexmock(module.borg_version).should_receive('local_borg_version').and_return(flexmock())
|
flexmock(module.borg_version).should_receive('local_borg_version').and_return(flexmock())
|
||||||
flexmock(module.command).should_receive('execute_hook')
|
flexmock(module.command).should_receive('execute_hook')
|
||||||
flexmock(module).should_receive('run_actions').and_raise(OSError).times(4)
|
flexmock(module).should_receive('run_actions').and_raise(OSError).times(4)
|
||||||
expected_results = [flexmock(), flexmock(), flexmock(), flexmock()]
|
flexmock(module).should_receive('log_error_records').with_args(
|
||||||
flexmock(module).should_receive('make_error_log_records').with_args(
|
'foo: Error running actions for repository',
|
||||||
'foo: Error running actions for repository', OSError
|
OSError,
|
||||||
).and_return(expected_results[0:1]).ordered()
|
levelno=logging.WARNING,
|
||||||
|
log_command_error_output=True,
|
||||||
|
).and_return([flexmock()]).ordered()
|
||||||
|
|
||||||
flexmock(time).should_receive('sleep').with_args(10).and_return().ordered()
|
flexmock(time).should_receive('sleep').with_args(10).and_return().ordered()
|
||||||
flexmock(module).should_receive('make_error_log_records').with_args(
|
flexmock(module).should_receive('log_error_records').with_args(
|
||||||
'foo: Error running actions for repository', OSError
|
'foo: Error running actions for repository',
|
||||||
).and_return(expected_results[1:2]).ordered()
|
OSError,
|
||||||
|
levelno=logging.WARNING,
|
||||||
|
log_command_error_output=True,
|
||||||
|
).and_return([flexmock()]).ordered()
|
||||||
|
|
||||||
flexmock(time).should_receive('sleep').with_args(20).and_return().ordered()
|
flexmock(time).should_receive('sleep').with_args(20).and_return().ordered()
|
||||||
flexmock(module).should_receive('make_error_log_records').with_args(
|
flexmock(module).should_receive('log_error_records').with_args(
|
||||||
'foo: Error running actions for repository', OSError
|
'foo: Error running actions for repository',
|
||||||
).and_return(expected_results[2:3]).ordered()
|
OSError,
|
||||||
|
levelno=logging.WARNING,
|
||||||
|
log_command_error_output=True,
|
||||||
|
).and_return([flexmock()]).ordered()
|
||||||
|
|
||||||
flexmock(time).should_receive('sleep').with_args(30).and_return().ordered()
|
flexmock(time).should_receive('sleep').with_args(30).and_return().ordered()
|
||||||
flexmock(module).should_receive('make_error_log_records').with_args(
|
error_logs = [flexmock()]
|
||||||
|
flexmock(module).should_receive('log_error_records').with_args(
|
||||||
'foo: Error running actions for repository', OSError
|
'foo: Error running actions for repository', OSError
|
||||||
).and_return(expected_results[3:4]).ordered()
|
).and_return(error_logs).ordered()
|
||||||
config = {'location': {'repositories': ['foo']}, 'storage': {'retries': 3, 'retry_wait': 10}}
|
config = {'location': {'repositories': ['foo']}, 'storage': {'retries': 3, 'retry_wait': 10}}
|
||||||
arguments = {'global': flexmock(monitoring_verbosity=1, dry_run=False), 'create': flexmock()}
|
arguments = {'global': flexmock(monitoring_verbosity=1, dry_run=False), 'create': flexmock()}
|
||||||
results = list(module.run_configuration('test.yaml', config, arguments))
|
results = list(module.run_configuration('test.yaml', config, arguments))
|
||||||
assert results == expected_results
|
assert results == error_logs
|
||||||
|
|
||||||
|
|
||||||
def test_run_configuration_retries_timeout_multiple_repos():
|
def test_run_configuration_retries_timeout_multiple_repos():
|
||||||
|
@ -357,29 +326,344 @@ def test_run_configuration_retries_timeout_multiple_repos():
|
||||||
flexmock(module).should_receive('run_actions').and_raise(OSError).and_raise(OSError).and_return(
|
flexmock(module).should_receive('run_actions').and_raise(OSError).and_raise(OSError).and_return(
|
||||||
[]
|
[]
|
||||||
).and_raise(OSError).times(4)
|
).and_raise(OSError).times(4)
|
||||||
expected_results = [flexmock(), flexmock(), flexmock()]
|
flexmock(module).should_receive('log_error_records').with_args(
|
||||||
flexmock(module).should_receive('make_error_log_records').with_args(
|
'foo: Error running actions for repository',
|
||||||
'foo: Error running actions for repository', OSError
|
OSError,
|
||||||
).and_return(expected_results[0:1]).ordered()
|
levelno=logging.WARNING,
|
||||||
flexmock(module).should_receive('make_error_log_records').with_args(
|
log_command_error_output=True,
|
||||||
'bar: Error running actions for repository', OSError
|
).and_return([flexmock()]).ordered()
|
||||||
).and_return(expected_results[1:2]).ordered()
|
flexmock(module).should_receive('log_error_records').with_args(
|
||||||
|
'bar: Error running actions for repository',
|
||||||
|
OSError,
|
||||||
|
levelno=logging.WARNING,
|
||||||
|
log_command_error_output=True,
|
||||||
|
).and_return([flexmock()]).ordered()
|
||||||
|
|
||||||
# Sleep before retrying foo (and passing)
|
# Sleep before retrying foo (and passing)
|
||||||
flexmock(time).should_receive('sleep').with_args(10).and_return().ordered()
|
flexmock(time).should_receive('sleep').with_args(10).and_return().ordered()
|
||||||
|
|
||||||
# Sleep before retrying bar (and failing)
|
# Sleep before retrying bar (and failing)
|
||||||
flexmock(time).should_receive('sleep').with_args(10).and_return().ordered()
|
flexmock(time).should_receive('sleep').with_args(10).and_return().ordered()
|
||||||
flexmock(module).should_receive('make_error_log_records').with_args(
|
error_logs = [flexmock()]
|
||||||
|
flexmock(module).should_receive('log_error_records').with_args(
|
||||||
'bar: Error running actions for repository', OSError
|
'bar: Error running actions for repository', OSError
|
||||||
).and_return(expected_results[2:3]).ordered()
|
).and_return(error_logs).ordered()
|
||||||
config = {
|
config = {
|
||||||
'location': {'repositories': ['foo', 'bar']},
|
'location': {'repositories': ['foo', 'bar']},
|
||||||
'storage': {'retries': 1, 'retry_wait': 10},
|
'storage': {'retries': 1, 'retry_wait': 10},
|
||||||
}
|
}
|
||||||
arguments = {'global': flexmock(monitoring_verbosity=1, dry_run=False), 'create': flexmock()}
|
arguments = {'global': flexmock(monitoring_verbosity=1, dry_run=False), 'create': flexmock()}
|
||||||
results = list(module.run_configuration('test.yaml', config, arguments))
|
results = list(module.run_configuration('test.yaml', config, arguments))
|
||||||
assert results == expected_results
|
assert results == error_logs
|
||||||
|
|
||||||
|
|
||||||
|
def test_run_actions_does_not_raise_for_init_action():
|
||||||
|
flexmock(module.borg_init).should_receive('initialize_repository')
|
||||||
|
arguments = {
|
||||||
|
'global': flexmock(monitoring_verbosity=1, dry_run=False),
|
||||||
|
'init': flexmock(
|
||||||
|
encryption_mode=flexmock(), append_only=flexmock(), storage_quota=flexmock()
|
||||||
|
),
|
||||||
|
}
|
||||||
|
|
||||||
|
list(
|
||||||
|
module.run_actions(
|
||||||
|
arguments=arguments,
|
||||||
|
config_filename='test.yaml',
|
||||||
|
location={'repositories': ['repo']},
|
||||||
|
storage={},
|
||||||
|
retention={},
|
||||||
|
consistency={},
|
||||||
|
hooks={},
|
||||||
|
local_path=None,
|
||||||
|
remote_path=None,
|
||||||
|
local_borg_version=None,
|
||||||
|
repository_path='repo',
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_run_actions_calls_hooks_for_prune_action():
|
||||||
|
flexmock(module.borg_prune).should_receive('prune_archives')
|
||||||
|
flexmock(module.command).should_receive('execute_hook').twice()
|
||||||
|
arguments = {
|
||||||
|
'global': flexmock(monitoring_verbosity=1, dry_run=False),
|
||||||
|
'prune': flexmock(stats=flexmock(), files=flexmock()),
|
||||||
|
}
|
||||||
|
|
||||||
|
list(
|
||||||
|
module.run_actions(
|
||||||
|
arguments=arguments,
|
||||||
|
config_filename='test.yaml',
|
||||||
|
location={'repositories': ['repo']},
|
||||||
|
storage={},
|
||||||
|
retention={},
|
||||||
|
consistency={},
|
||||||
|
hooks={},
|
||||||
|
local_path=None,
|
||||||
|
remote_path=None,
|
||||||
|
local_borg_version=None,
|
||||||
|
repository_path='repo',
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_run_actions_calls_hooks_for_compact_action():
|
||||||
|
flexmock(module.borg_feature).should_receive('available').and_return(True)
|
||||||
|
flexmock(module.borg_compact).should_receive('compact_segments')
|
||||||
|
flexmock(module.command).should_receive('execute_hook').twice()
|
||||||
|
arguments = {
|
||||||
|
'global': flexmock(monitoring_verbosity=1, dry_run=False),
|
||||||
|
'compact': flexmock(progress=flexmock(), cleanup_commits=flexmock(), threshold=flexmock()),
|
||||||
|
}
|
||||||
|
|
||||||
|
list(
|
||||||
|
module.run_actions(
|
||||||
|
arguments=arguments,
|
||||||
|
config_filename='test.yaml',
|
||||||
|
location={'repositories': ['repo']},
|
||||||
|
storage={},
|
||||||
|
retention={},
|
||||||
|
consistency={},
|
||||||
|
hooks={},
|
||||||
|
local_path=None,
|
||||||
|
remote_path=None,
|
||||||
|
local_borg_version=None,
|
||||||
|
repository_path='repo',
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_run_actions_executes_and_calls_hooks_for_create_action():
|
||||||
|
flexmock(module.borg_create).should_receive('create_archive')
|
||||||
|
flexmock(module.command).should_receive('execute_hook').twice()
|
||||||
|
flexmock(module.dispatch).should_receive('call_hooks').and_return({}).times(3)
|
||||||
|
arguments = {
|
||||||
|
'global': flexmock(monitoring_verbosity=1, dry_run=False),
|
||||||
|
'create': flexmock(
|
||||||
|
progress=flexmock(), stats=flexmock(), json=flexmock(), files=flexmock()
|
||||||
|
),
|
||||||
|
}
|
||||||
|
|
||||||
|
list(
|
||||||
|
module.run_actions(
|
||||||
|
arguments=arguments,
|
||||||
|
config_filename='test.yaml',
|
||||||
|
location={'repositories': ['repo']},
|
||||||
|
storage={},
|
||||||
|
retention={},
|
||||||
|
consistency={},
|
||||||
|
hooks={},
|
||||||
|
local_path=None,
|
||||||
|
remote_path=None,
|
||||||
|
local_borg_version=None,
|
||||||
|
repository_path='repo',
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_run_actions_calls_hooks_for_check_action():
|
||||||
|
flexmock(module.checks).should_receive('repository_enabled_for_checks').and_return(True)
|
||||||
|
flexmock(module.borg_check).should_receive('check_archives')
|
||||||
|
flexmock(module.command).should_receive('execute_hook').twice()
|
||||||
|
arguments = {
|
||||||
|
'global': flexmock(monitoring_verbosity=1, dry_run=False),
|
||||||
|
'check': flexmock(
|
||||||
|
progress=flexmock(), repair=flexmock(), only=flexmock(), force=flexmock()
|
||||||
|
),
|
||||||
|
}
|
||||||
|
|
||||||
|
list(
|
||||||
|
module.run_actions(
|
||||||
|
arguments=arguments,
|
||||||
|
config_filename='test.yaml',
|
||||||
|
location={'repositories': ['repo']},
|
||||||
|
storage={},
|
||||||
|
retention={},
|
||||||
|
consistency={},
|
||||||
|
hooks={},
|
||||||
|
local_path=None,
|
||||||
|
remote_path=None,
|
||||||
|
local_borg_version=None,
|
||||||
|
repository_path='repo',
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_run_actions_calls_hooks_for_extract_action():
|
||||||
|
flexmock(module.validate).should_receive('repositories_match').and_return(True)
|
||||||
|
flexmock(module.borg_extract).should_receive('extract_archive')
|
||||||
|
flexmock(module.command).should_receive('execute_hook').twice()
|
||||||
|
arguments = {
|
||||||
|
'global': flexmock(monitoring_verbosity=1, dry_run=False),
|
||||||
|
'extract': flexmock(
|
||||||
|
paths=flexmock(),
|
||||||
|
progress=flexmock(),
|
||||||
|
destination=flexmock(),
|
||||||
|
strip_components=flexmock(),
|
||||||
|
archive=flexmock(),
|
||||||
|
repository='repo',
|
||||||
|
),
|
||||||
|
}
|
||||||
|
|
||||||
|
list(
|
||||||
|
module.run_actions(
|
||||||
|
arguments=arguments,
|
||||||
|
config_filename='test.yaml',
|
||||||
|
location={'repositories': ['repo']},
|
||||||
|
storage={},
|
||||||
|
retention={},
|
||||||
|
consistency={},
|
||||||
|
hooks={},
|
||||||
|
local_path=None,
|
||||||
|
remote_path=None,
|
||||||
|
local_borg_version=None,
|
||||||
|
repository_path='repo',
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_run_actions_does_not_raise_for_export_tar_action():
|
||||||
|
flexmock(module.validate).should_receive('repositories_match').and_return(True)
|
||||||
|
flexmock(module.borg_export_tar).should_receive('export_tar_archive')
|
||||||
|
arguments = {
|
||||||
|
'global': flexmock(monitoring_verbosity=1, dry_run=False),
|
||||||
|
'export-tar': flexmock(
|
||||||
|
repository=flexmock(),
|
||||||
|
archive=flexmock(),
|
||||||
|
paths=flexmock(),
|
||||||
|
destination=flexmock(),
|
||||||
|
tar_filter=flexmock(),
|
||||||
|
files=flexmock(),
|
||||||
|
strip_components=flexmock(),
|
||||||
|
),
|
||||||
|
}
|
||||||
|
|
||||||
|
list(
|
||||||
|
module.run_actions(
|
||||||
|
arguments=arguments,
|
||||||
|
config_filename='test.yaml',
|
||||||
|
location={'repositories': ['repo']},
|
||||||
|
storage={},
|
||||||
|
retention={},
|
||||||
|
consistency={},
|
||||||
|
hooks={},
|
||||||
|
local_path=None,
|
||||||
|
remote_path=None,
|
||||||
|
local_borg_version=None,
|
||||||
|
repository_path='repo',
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_run_actions_does_not_raise_for_mount_action():
|
||||||
|
flexmock(module.validate).should_receive('repositories_match').and_return(True)
|
||||||
|
flexmock(module.borg_mount).should_receive('mount_archive')
|
||||||
|
arguments = {
|
||||||
|
'global': flexmock(monitoring_verbosity=1, dry_run=False),
|
||||||
|
'mount': flexmock(
|
||||||
|
repository=flexmock(),
|
||||||
|
archive=flexmock(),
|
||||||
|
mount_point=flexmock(),
|
||||||
|
paths=flexmock(),
|
||||||
|
foreground=flexmock(),
|
||||||
|
options=flexmock(),
|
||||||
|
),
|
||||||
|
}
|
||||||
|
|
||||||
|
list(
|
||||||
|
module.run_actions(
|
||||||
|
arguments=arguments,
|
||||||
|
config_filename='test.yaml',
|
||||||
|
location={'repositories': ['repo']},
|
||||||
|
storage={},
|
||||||
|
retention={},
|
||||||
|
consistency={},
|
||||||
|
hooks={},
|
||||||
|
local_path=None,
|
||||||
|
remote_path=None,
|
||||||
|
local_borg_version=None,
|
||||||
|
repository_path='repo',
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_run_actions_does_not_raise_for_list_action():
|
||||||
|
flexmock(module.validate).should_receive('repositories_match').and_return(True)
|
||||||
|
flexmock(module.borg_list).should_receive('resolve_archive_name').and_return(flexmock())
|
||||||
|
flexmock(module.borg_list).should_receive('list_archives')
|
||||||
|
arguments = {
|
||||||
|
'global': flexmock(monitoring_verbosity=1, dry_run=False),
|
||||||
|
'list': flexmock(repository=flexmock(), archive=flexmock(), json=flexmock()),
|
||||||
|
}
|
||||||
|
|
||||||
|
list(
|
||||||
|
module.run_actions(
|
||||||
|
arguments=arguments,
|
||||||
|
config_filename='test.yaml',
|
||||||
|
location={'repositories': ['repo']},
|
||||||
|
storage={},
|
||||||
|
retention={},
|
||||||
|
consistency={},
|
||||||
|
hooks={},
|
||||||
|
local_path=None,
|
||||||
|
remote_path=None,
|
||||||
|
local_borg_version=None,
|
||||||
|
repository_path='repo',
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_run_actions_does_not_raise_for_info_action():
|
||||||
|
flexmock(module.validate).should_receive('repositories_match').and_return(True)
|
||||||
|
flexmock(module.borg_list).should_receive('resolve_archive_name').and_return(flexmock())
|
||||||
|
flexmock(module.borg_info).should_receive('display_archives_info')
|
||||||
|
arguments = {
|
||||||
|
'global': flexmock(monitoring_verbosity=1, dry_run=False),
|
||||||
|
'info': flexmock(repository=flexmock(), archive=flexmock(), json=flexmock()),
|
||||||
|
}
|
||||||
|
|
||||||
|
list(
|
||||||
|
module.run_actions(
|
||||||
|
arguments=arguments,
|
||||||
|
config_filename='test.yaml',
|
||||||
|
location={'repositories': ['repo']},
|
||||||
|
storage={},
|
||||||
|
retention={},
|
||||||
|
consistency={},
|
||||||
|
hooks={},
|
||||||
|
local_path=None,
|
||||||
|
remote_path=None,
|
||||||
|
local_borg_version=None,
|
||||||
|
repository_path='repo',
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_run_actions_does_not_raise_for_borg_action():
|
||||||
|
flexmock(module.validate).should_receive('repositories_match').and_return(True)
|
||||||
|
flexmock(module.borg_list).should_receive('resolve_archive_name').and_return(flexmock())
|
||||||
|
flexmock(module.borg_borg).should_receive('run_arbitrary_borg')
|
||||||
|
arguments = {
|
||||||
|
'global': flexmock(monitoring_verbosity=1, dry_run=False),
|
||||||
|
'borg': flexmock(repository=flexmock(), archive=flexmock(), options=flexmock()),
|
||||||
|
}
|
||||||
|
|
||||||
|
list(
|
||||||
|
module.run_actions(
|
||||||
|
arguments=arguments,
|
||||||
|
config_filename='test.yaml',
|
||||||
|
location={'repositories': ['repo']},
|
||||||
|
storage={},
|
||||||
|
retention={},
|
||||||
|
consistency={},
|
||||||
|
hooks={},
|
||||||
|
local_path=None,
|
||||||
|
remote_path=None,
|
||||||
|
local_borg_version=None,
|
||||||
|
repository_path='repo',
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_load_configurations_collects_parsed_configurations():
|
def test_load_configurations_collects_parsed_configurations():
|
||||||
|
@ -421,48 +705,46 @@ def test_log_record_with_suppress_does_not_raise():
|
||||||
module.log_record(levelno=1, foo='bar', baz='quux', suppress_log=True)
|
module.log_record(levelno=1, foo='bar', baz='quux', suppress_log=True)
|
||||||
|
|
||||||
|
|
||||||
def test_make_error_log_records_generates_output_logs_for_message_only():
|
def test_log_error_records_generates_output_logs_for_message_only():
|
||||||
flexmock(module).should_receive('log_record').replace_with(dict)
|
flexmock(module).should_receive('log_record').replace_with(dict)
|
||||||
|
|
||||||
logs = tuple(module.make_error_log_records('Error'))
|
logs = tuple(module.log_error_records('Error'))
|
||||||
|
|
||||||
assert {log['levelno'] for log in logs} == {logging.CRITICAL}
|
assert {log['levelno'] for log in logs} == {logging.CRITICAL}
|
||||||
|
|
||||||
|
|
||||||
def test_make_error_log_records_generates_output_logs_for_called_process_error():
|
def test_log_error_records_generates_output_logs_for_called_process_error():
|
||||||
flexmock(module).should_receive('log_record').replace_with(dict)
|
flexmock(module).should_receive('log_record').replace_with(dict)
|
||||||
flexmock(module.logger).should_receive('getEffectiveLevel').and_return(logging.WARNING)
|
flexmock(module.logger).should_receive('getEffectiveLevel').and_return(logging.WARNING)
|
||||||
|
|
||||||
logs = tuple(
|
logs = tuple(
|
||||||
module.make_error_log_records(
|
module.log_error_records('Error', subprocess.CalledProcessError(1, 'ls', 'error output'))
|
||||||
'Error', subprocess.CalledProcessError(1, 'ls', 'error output')
|
|
||||||
)
|
|
||||||
)
|
)
|
||||||
|
|
||||||
assert {log['levelno'] for log in logs} == {logging.CRITICAL}
|
assert {log['levelno'] for log in logs} == {logging.CRITICAL}
|
||||||
assert any(log for log in logs if 'error output' in str(log))
|
assert any(log for log in logs if 'error output' in str(log))
|
||||||
|
|
||||||
|
|
||||||
def test_make_error_log_records_generates_logs_for_value_error():
|
def test_log_error_records_generates_logs_for_value_error():
|
||||||
flexmock(module).should_receive('log_record').replace_with(dict)
|
flexmock(module).should_receive('log_record').replace_with(dict)
|
||||||
|
|
||||||
logs = tuple(module.make_error_log_records('Error', ValueError()))
|
logs = tuple(module.log_error_records('Error', ValueError()))
|
||||||
|
|
||||||
assert {log['levelno'] for log in logs} == {logging.CRITICAL}
|
assert {log['levelno'] for log in logs} == {logging.CRITICAL}
|
||||||
|
|
||||||
|
|
||||||
def test_make_error_log_records_generates_logs_for_os_error():
|
def test_log_error_records_generates_logs_for_os_error():
|
||||||
flexmock(module).should_receive('log_record').replace_with(dict)
|
flexmock(module).should_receive('log_record').replace_with(dict)
|
||||||
|
|
||||||
logs = tuple(module.make_error_log_records('Error', OSError()))
|
logs = tuple(module.log_error_records('Error', OSError()))
|
||||||
|
|
||||||
assert {log['levelno'] for log in logs} == {logging.CRITICAL}
|
assert {log['levelno'] for log in logs} == {logging.CRITICAL}
|
||||||
|
|
||||||
|
|
||||||
def test_make_error_log_records_generates_nothing_for_other_error():
|
def test_log_error_records_generates_nothing_for_other_error():
|
||||||
flexmock(module).should_receive('log_record').replace_with(dict)
|
flexmock(module).should_receive('log_record').replace_with(dict)
|
||||||
|
|
||||||
logs = tuple(module.make_error_log_records('Error', KeyError()))
|
logs = tuple(module.log_error_records('Error', KeyError()))
|
||||||
|
|
||||||
assert logs == ()
|
assert logs == ()
|
||||||
|
|
||||||
|
@ -519,7 +801,7 @@ def test_collect_configuration_run_summary_logs_extract_with_repository_error():
|
||||||
ValueError
|
ValueError
|
||||||
)
|
)
|
||||||
expected_logs = (flexmock(),)
|
expected_logs = (flexmock(),)
|
||||||
flexmock(module).should_receive('make_error_log_records').and_return(expected_logs)
|
flexmock(module).should_receive('log_error_records').and_return(expected_logs)
|
||||||
arguments = {'extract': flexmock(repository='repo')}
|
arguments = {'extract': flexmock(repository='repo')}
|
||||||
|
|
||||||
logs = tuple(
|
logs = tuple(
|
||||||
|
@ -546,7 +828,7 @@ def test_collect_configuration_run_summary_logs_mount_with_repository_error():
|
||||||
ValueError
|
ValueError
|
||||||
)
|
)
|
||||||
expected_logs = (flexmock(),)
|
expected_logs = (flexmock(),)
|
||||||
flexmock(module).should_receive('make_error_log_records').and_return(expected_logs)
|
flexmock(module).should_receive('log_error_records').and_return(expected_logs)
|
||||||
arguments = {'mount': flexmock(repository='repo')}
|
arguments = {'mount': flexmock(repository='repo')}
|
||||||
|
|
||||||
logs = tuple(
|
logs = tuple(
|
||||||
|
@ -559,7 +841,7 @@ def test_collect_configuration_run_summary_logs_mount_with_repository_error():
|
||||||
def test_collect_configuration_run_summary_logs_missing_configs_error():
|
def test_collect_configuration_run_summary_logs_missing_configs_error():
|
||||||
arguments = {'global': flexmock(config_paths=[])}
|
arguments = {'global': flexmock(config_paths=[])}
|
||||||
expected_logs = (flexmock(),)
|
expected_logs = (flexmock(),)
|
||||||
flexmock(module).should_receive('make_error_log_records').and_return(expected_logs)
|
flexmock(module).should_receive('log_error_records').and_return(expected_logs)
|
||||||
|
|
||||||
logs = tuple(module.collect_configuration_run_summary_logs({}, arguments=arguments))
|
logs = tuple(module.collect_configuration_run_summary_logs({}, arguments=arguments))
|
||||||
|
|
||||||
|
@ -569,7 +851,7 @@ def test_collect_configuration_run_summary_logs_missing_configs_error():
|
||||||
def test_collect_configuration_run_summary_logs_pre_hook_error():
|
def test_collect_configuration_run_summary_logs_pre_hook_error():
|
||||||
flexmock(module.command).should_receive('execute_hook').and_raise(ValueError)
|
flexmock(module.command).should_receive('execute_hook').and_raise(ValueError)
|
||||||
expected_logs = (flexmock(),)
|
expected_logs = (flexmock(),)
|
||||||
flexmock(module).should_receive('make_error_log_records').and_return(expected_logs)
|
flexmock(module).should_receive('log_error_records').and_return(expected_logs)
|
||||||
arguments = {'create': flexmock(), 'global': flexmock(monitoring_verbosity=1, dry_run=False)}
|
arguments = {'create': flexmock(), 'global': flexmock(monitoring_verbosity=1, dry_run=False)}
|
||||||
|
|
||||||
logs = tuple(
|
logs = tuple(
|
||||||
|
@ -583,7 +865,7 @@ def test_collect_configuration_run_summary_logs_post_hook_error():
|
||||||
flexmock(module.command).should_receive('execute_hook').and_return(None).and_raise(ValueError)
|
flexmock(module.command).should_receive('execute_hook').and_return(None).and_raise(ValueError)
|
||||||
flexmock(module).should_receive('run_configuration').and_return([])
|
flexmock(module).should_receive('run_configuration').and_return([])
|
||||||
expected_logs = (flexmock(),)
|
expected_logs = (flexmock(),)
|
||||||
flexmock(module).should_receive('make_error_log_records').and_return(expected_logs)
|
flexmock(module).should_receive('log_error_records').and_return(expected_logs)
|
||||||
arguments = {'create': flexmock(), 'global': flexmock(monitoring_verbosity=1, dry_run=False)}
|
arguments = {'create': flexmock(), 'global': flexmock(monitoring_verbosity=1, dry_run=False)}
|
||||||
|
|
||||||
logs = tuple(
|
logs = tuple(
|
||||||
|
@ -598,7 +880,7 @@ def test_collect_configuration_run_summary_logs_for_list_with_archive_and_reposi
|
||||||
ValueError
|
ValueError
|
||||||
)
|
)
|
||||||
expected_logs = (flexmock(),)
|
expected_logs = (flexmock(),)
|
||||||
flexmock(module).should_receive('make_error_log_records').and_return(expected_logs)
|
flexmock(module).should_receive('log_error_records').and_return(expected_logs)
|
||||||
arguments = {'list': flexmock(repository='repo', archive='test')}
|
arguments = {'list': flexmock(repository='repo', archive='test')}
|
||||||
|
|
||||||
logs = tuple(
|
logs = tuple(
|
||||||
|
@ -624,7 +906,7 @@ def test_collect_configuration_run_summary_logs_run_configuration_error():
|
||||||
flexmock(module).should_receive('run_configuration').and_return(
|
flexmock(module).should_receive('run_configuration').and_return(
|
||||||
[logging.makeLogRecord(dict(levelno=logging.CRITICAL, levelname='CRITICAL', msg='Error'))]
|
[logging.makeLogRecord(dict(levelno=logging.CRITICAL, levelname='CRITICAL', msg='Error'))]
|
||||||
)
|
)
|
||||||
flexmock(module).should_receive('make_error_log_records').and_return([])
|
flexmock(module).should_receive('log_error_records').and_return([])
|
||||||
arguments = {}
|
arguments = {}
|
||||||
|
|
||||||
logs = tuple(
|
logs = tuple(
|
||||||
|
@ -638,7 +920,7 @@ def test_collect_configuration_run_summary_logs_run_umount_error():
|
||||||
flexmock(module.validate).should_receive('guard_configuration_contains_repository')
|
flexmock(module.validate).should_receive('guard_configuration_contains_repository')
|
||||||
flexmock(module).should_receive('run_configuration').and_return([])
|
flexmock(module).should_receive('run_configuration').and_return([])
|
||||||
flexmock(module.borg_umount).should_receive('unmount_archive').and_raise(OSError)
|
flexmock(module.borg_umount).should_receive('unmount_archive').and_raise(OSError)
|
||||||
flexmock(module).should_receive('make_error_log_records').and_return(
|
flexmock(module).should_receive('log_error_records').and_return(
|
||||||
[logging.makeLogRecord(dict(levelno=logging.CRITICAL, levelname='CRITICAL', msg='Error'))]
|
[logging.makeLogRecord(dict(levelno=logging.CRITICAL, levelname='CRITICAL', msg='Error'))]
|
||||||
)
|
)
|
||||||
arguments = {'umount': flexmock(mount_point='/mnt')}
|
arguments = {'umount': flexmock(mount_point='/mnt')}
|
||||||
|
|
|
@ -19,6 +19,26 @@ from borgmatic.config import normalize as module
|
||||||
{'location': {'source_directories': ['foo', 'bar']}},
|
{'location': {'source_directories': ['foo', 'bar']}},
|
||||||
),
|
),
|
||||||
({'storage': {'compression': 'yes_please'}}, {'storage': {'compression': 'yes_please'}}),
|
({'storage': {'compression': 'yes_please'}}, {'storage': {'compression': 'yes_please'}}),
|
||||||
|
(
|
||||||
|
{'hooks': {'healthchecks': 'https://example.com'}},
|
||||||
|
{'hooks': {'healthchecks': {'ping_url': 'https://example.com'}}},
|
||||||
|
),
|
||||||
|
(
|
||||||
|
{'hooks': {'cronitor': 'https://example.com'}},
|
||||||
|
{'hooks': {'cronitor': {'ping_url': 'https://example.com'}}},
|
||||||
|
),
|
||||||
|
(
|
||||||
|
{'hooks': {'pagerduty': 'https://example.com'}},
|
||||||
|
{'hooks': {'pagerduty': {'integration_key': 'https://example.com'}}},
|
||||||
|
),
|
||||||
|
(
|
||||||
|
{'hooks': {'cronhub': 'https://example.com'}},
|
||||||
|
{'hooks': {'cronhub': {'ping_url': 'https://example.com'}}},
|
||||||
|
),
|
||||||
|
(
|
||||||
|
{'consistency': {'checks': ['archives']}},
|
||||||
|
{'consistency': {'checks': [{'name': 'archives'}]}},
|
||||||
|
),
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
def test_normalize_applies_hard_coded_normalization_to_config(config, expected_config):
|
def test_normalize_applies_hard_coded_normalization_to_config(config, expected_config):
|
||||||
|
|
|
@ -37,33 +37,6 @@ def test_validation_error_string_contains_errors():
|
||||||
assert 'uh oh' in result
|
assert 'uh oh' in result
|
||||||
|
|
||||||
|
|
||||||
def test_apply_logical_validation_raises_if_archive_name_format_present_without_prefix():
|
|
||||||
flexmock(module).format_json_error = lambda error: error.message
|
|
||||||
|
|
||||||
with pytest.raises(module.Validation_error):
|
|
||||||
module.apply_logical_validation(
|
|
||||||
'config.yaml',
|
|
||||||
{
|
|
||||||
'storage': {'archive_name_format': '{hostname}-{now}'},
|
|
||||||
'retention': {'keep_daily': 7},
|
|
||||||
},
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def test_apply_logical_validation_raises_if_archive_name_format_present_without_retention_prefix():
|
|
||||||
flexmock(module).format_json_error = lambda error: error.message
|
|
||||||
|
|
||||||
with pytest.raises(module.Validation_error):
|
|
||||||
module.apply_logical_validation(
|
|
||||||
'config.yaml',
|
|
||||||
{
|
|
||||||
'storage': {'archive_name_format': '{hostname}-{now}'},
|
|
||||||
'retention': {'keep_daily': 7},
|
|
||||||
'consistency': {'prefix': '{hostname}-'},
|
|
||||||
},
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def test_apply_locical_validation_raises_if_unknown_repository_in_check_repositories():
|
def test_apply_locical_validation_raises_if_unknown_repository_in_check_repositories():
|
||||||
flexmock(module).format_json_error = lambda error: error.message
|
flexmock(module).format_json_error = lambda error: error.message
|
||||||
|
|
||||||
|
|
|
@ -7,22 +7,34 @@ from borgmatic.hooks import command as module
|
||||||
|
|
||||||
|
|
||||||
def test_interpolate_context_passes_through_command_without_variable():
|
def test_interpolate_context_passes_through_command_without_variable():
|
||||||
assert module.interpolate_context('ls', {'foo': 'bar'}) == 'ls'
|
assert module.interpolate_context('test.yaml', 'pre-backup', 'ls', {'foo': 'bar'}) == 'ls'
|
||||||
|
|
||||||
|
|
||||||
def test_interpolate_context_passes_through_command_with_unknown_variable():
|
def test_interpolate_context_passes_through_command_with_unknown_variable():
|
||||||
assert module.interpolate_context('ls {baz}', {'foo': 'bar'}) == 'ls {baz}'
|
assert (
|
||||||
|
module.interpolate_context('test.yaml', 'pre-backup', 'ls {baz}', {'foo': 'bar'})
|
||||||
|
== 'ls {baz}'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_interpolate_context_interpolates_variables():
|
def test_interpolate_context_interpolates_variables():
|
||||||
context = {'foo': 'bar', 'baz': 'quux'}
|
context = {'foo': 'bar', 'baz': 'quux'}
|
||||||
|
|
||||||
assert module.interpolate_context('ls {foo}{baz} {baz}', context) == 'ls barquux quux'
|
assert (
|
||||||
|
module.interpolate_context('test.yaml', 'pre-backup', 'ls {foo}{baz} {baz}', context)
|
||||||
|
== 'ls barquux quux'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_interpolate_context_does_not_touch_unknown_variables():
|
||||||
|
context = {'foo': 'bar', 'baz': 'quux'}
|
||||||
|
|
||||||
|
assert module.interpolate_context('test.yaml', 'pre-backup', 'ls {wtf}', context) == 'ls {wtf}'
|
||||||
|
|
||||||
|
|
||||||
def test_execute_hook_invokes_each_command():
|
def test_execute_hook_invokes_each_command():
|
||||||
flexmock(module).should_receive('interpolate_context').replace_with(
|
flexmock(module).should_receive('interpolate_context').replace_with(
|
||||||
lambda command, context: command
|
lambda config_file, hook_description, command, context: command
|
||||||
)
|
)
|
||||||
flexmock(module.execute).should_receive('execute_command').with_args(
|
flexmock(module.execute).should_receive('execute_command').with_args(
|
||||||
[':'], output_log_level=logging.WARNING, shell=True
|
[':'], output_log_level=logging.WARNING, shell=True
|
||||||
|
@ -33,7 +45,7 @@ def test_execute_hook_invokes_each_command():
|
||||||
|
|
||||||
def test_execute_hook_with_multiple_commands_invokes_each_command():
|
def test_execute_hook_with_multiple_commands_invokes_each_command():
|
||||||
flexmock(module).should_receive('interpolate_context').replace_with(
|
flexmock(module).should_receive('interpolate_context').replace_with(
|
||||||
lambda command, context: command
|
lambda config_file, hook_description, command, context: command
|
||||||
)
|
)
|
||||||
flexmock(module.execute).should_receive('execute_command').with_args(
|
flexmock(module.execute).should_receive('execute_command').with_args(
|
||||||
[':'], output_log_level=logging.WARNING, shell=True
|
[':'], output_log_level=logging.WARNING, shell=True
|
||||||
|
@ -47,7 +59,7 @@ def test_execute_hook_with_multiple_commands_invokes_each_command():
|
||||||
|
|
||||||
def test_execute_hook_with_umask_sets_that_umask():
|
def test_execute_hook_with_umask_sets_that_umask():
|
||||||
flexmock(module).should_receive('interpolate_context').replace_with(
|
flexmock(module).should_receive('interpolate_context').replace_with(
|
||||||
lambda command, context: command
|
lambda config_file, hook_description, command, context: command
|
||||||
)
|
)
|
||||||
flexmock(module.os).should_receive('umask').with_args(0o77).and_return(0o22).once()
|
flexmock(module.os).should_receive('umask').with_args(0o77).and_return(0o22).once()
|
||||||
flexmock(module.os).should_receive('umask').with_args(0o22).once()
|
flexmock(module.os).should_receive('umask').with_args(0o22).once()
|
||||||
|
@ -60,7 +72,7 @@ def test_execute_hook_with_umask_sets_that_umask():
|
||||||
|
|
||||||
def test_execute_hook_with_dry_run_skips_commands():
|
def test_execute_hook_with_dry_run_skips_commands():
|
||||||
flexmock(module).should_receive('interpolate_context').replace_with(
|
flexmock(module).should_receive('interpolate_context').replace_with(
|
||||||
lambda command, context: command
|
lambda config_file, hook_description, command, context: command
|
||||||
)
|
)
|
||||||
flexmock(module.execute).should_receive('execute_command').never()
|
flexmock(module.execute).should_receive('execute_command').never()
|
||||||
|
|
||||||
|
@ -73,7 +85,7 @@ def test_execute_hook_with_empty_commands_does_not_raise():
|
||||||
|
|
||||||
def test_execute_hook_on_error_logs_as_error():
|
def test_execute_hook_on_error_logs_as_error():
|
||||||
flexmock(module).should_receive('interpolate_context').replace_with(
|
flexmock(module).should_receive('interpolate_context').replace_with(
|
||||||
lambda command, context: command
|
lambda config_file, hook_description, command, context: command
|
||||||
)
|
)
|
||||||
flexmock(module.execute).should_receive('execute_command').with_args(
|
flexmock(module.execute).should_receive('execute_command').with_args(
|
||||||
[':'], output_log_level=logging.ERROR, shell=True
|
[':'], output_log_level=logging.ERROR, shell=True
|
||||||
|
|
|
@ -4,45 +4,72 @@ from borgmatic.hooks import cronhub as module
|
||||||
|
|
||||||
|
|
||||||
def test_ping_monitor_rewrites_ping_url_for_start_state():
|
def test_ping_monitor_rewrites_ping_url_for_start_state():
|
||||||
ping_url = 'https://example.com/start/abcdef'
|
hook_config = {'ping_url': 'https://example.com/start/abcdef'}
|
||||||
flexmock(module.requests).should_receive('get').with_args('https://example.com/start/abcdef')
|
flexmock(module.requests).should_receive('get').with_args('https://example.com/start/abcdef')
|
||||||
|
|
||||||
module.ping_monitor(
|
module.ping_monitor(
|
||||||
ping_url, 'config.yaml', module.monitor.State.START, monitoring_log_level=1, dry_run=False
|
hook_config,
|
||||||
|
'config.yaml',
|
||||||
|
module.monitor.State.START,
|
||||||
|
monitoring_log_level=1,
|
||||||
|
dry_run=False,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_ping_monitor_rewrites_ping_url_and_state_for_start_state():
|
def test_ping_monitor_rewrites_ping_url_and_state_for_start_state():
|
||||||
ping_url = 'https://example.com/ping/abcdef'
|
hook_config = {'ping_url': 'https://example.com/ping/abcdef'}
|
||||||
flexmock(module.requests).should_receive('get').with_args('https://example.com/start/abcdef')
|
flexmock(module.requests).should_receive('get').with_args('https://example.com/start/abcdef')
|
||||||
|
|
||||||
module.ping_monitor(
|
module.ping_monitor(
|
||||||
ping_url, 'config.yaml', module.monitor.State.START, monitoring_log_level=1, dry_run=False
|
hook_config,
|
||||||
|
'config.yaml',
|
||||||
|
module.monitor.State.START,
|
||||||
|
monitoring_log_level=1,
|
||||||
|
dry_run=False,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_ping_monitor_rewrites_ping_url_for_finish_state():
|
def test_ping_monitor_rewrites_ping_url_for_finish_state():
|
||||||
ping_url = 'https://example.com/start/abcdef'
|
hook_config = {'ping_url': 'https://example.com/start/abcdef'}
|
||||||
flexmock(module.requests).should_receive('get').with_args('https://example.com/finish/abcdef')
|
flexmock(module.requests).should_receive('get').with_args('https://example.com/finish/abcdef')
|
||||||
|
|
||||||
module.ping_monitor(
|
module.ping_monitor(
|
||||||
ping_url, 'config.yaml', module.monitor.State.FINISH, monitoring_log_level=1, dry_run=False
|
hook_config,
|
||||||
|
'config.yaml',
|
||||||
|
module.monitor.State.FINISH,
|
||||||
|
monitoring_log_level=1,
|
||||||
|
dry_run=False,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_ping_monitor_rewrites_ping_url_for_fail_state():
|
def test_ping_monitor_rewrites_ping_url_for_fail_state():
|
||||||
ping_url = 'https://example.com/start/abcdef'
|
hook_config = {'ping_url': 'https://example.com/start/abcdef'}
|
||||||
flexmock(module.requests).should_receive('get').with_args('https://example.com/fail/abcdef')
|
flexmock(module.requests).should_receive('get').with_args('https://example.com/fail/abcdef')
|
||||||
|
|
||||||
module.ping_monitor(
|
module.ping_monitor(
|
||||||
ping_url, 'config.yaml', module.monitor.State.FAIL, monitoring_log_level=1, dry_run=False
|
hook_config, 'config.yaml', module.monitor.State.FAIL, monitoring_log_level=1, dry_run=False
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_ping_monitor_dry_run_does_not_hit_ping_url():
|
def test_ping_monitor_dry_run_does_not_hit_ping_url():
|
||||||
ping_url = 'https://example.com'
|
hook_config = {'ping_url': 'https://example.com'}
|
||||||
flexmock(module.requests).should_receive('get').never()
|
flexmock(module.requests).should_receive('get').never()
|
||||||
|
|
||||||
module.ping_monitor(
|
module.ping_monitor(
|
||||||
ping_url, 'config.yaml', module.monitor.State.START, monitoring_log_level=1, dry_run=True
|
hook_config, 'config.yaml', module.monitor.State.START, monitoring_log_level=1, dry_run=True
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_ping_monitor_with_connection_error_does_not_raise():
|
||||||
|
hook_config = {'ping_url': 'https://example.com/start/abcdef'}
|
||||||
|
flexmock(module.requests).should_receive('get').and_raise(
|
||||||
|
module.requests.exceptions.ConnectionError
|
||||||
|
)
|
||||||
|
|
||||||
|
module.ping_monitor(
|
||||||
|
hook_config,
|
||||||
|
'config.yaml',
|
||||||
|
module.monitor.State.START,
|
||||||
|
monitoring_log_level=1,
|
||||||
|
dry_run=False,
|
||||||
)
|
)
|
||||||
|
|
|
@ -4,36 +4,59 @@ from borgmatic.hooks import cronitor as module
|
||||||
|
|
||||||
|
|
||||||
def test_ping_monitor_hits_ping_url_for_start_state():
|
def test_ping_monitor_hits_ping_url_for_start_state():
|
||||||
ping_url = 'https://example.com'
|
hook_config = {'ping_url': 'https://example.com'}
|
||||||
flexmock(module.requests).should_receive('get').with_args('{}/{}'.format(ping_url, 'run'))
|
flexmock(module.requests).should_receive('get').with_args('https://example.com/run')
|
||||||
|
|
||||||
module.ping_monitor(
|
module.ping_monitor(
|
||||||
ping_url, 'config.yaml', module.monitor.State.START, monitoring_log_level=1, dry_run=False
|
hook_config,
|
||||||
|
'config.yaml',
|
||||||
|
module.monitor.State.START,
|
||||||
|
monitoring_log_level=1,
|
||||||
|
dry_run=False,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_ping_monitor_hits_ping_url_for_finish_state():
|
def test_ping_monitor_hits_ping_url_for_finish_state():
|
||||||
ping_url = 'https://example.com'
|
hook_config = {'ping_url': 'https://example.com'}
|
||||||
flexmock(module.requests).should_receive('get').with_args('{}/{}'.format(ping_url, 'complete'))
|
flexmock(module.requests).should_receive('get').with_args('https://example.com/complete')
|
||||||
|
|
||||||
module.ping_monitor(
|
module.ping_monitor(
|
||||||
ping_url, 'config.yaml', module.monitor.State.FINISH, monitoring_log_level=1, dry_run=False
|
hook_config,
|
||||||
|
'config.yaml',
|
||||||
|
module.monitor.State.FINISH,
|
||||||
|
monitoring_log_level=1,
|
||||||
|
dry_run=False,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_ping_monitor_hits_ping_url_for_fail_state():
|
def test_ping_monitor_hits_ping_url_for_fail_state():
|
||||||
ping_url = 'https://example.com'
|
hook_config = {'ping_url': 'https://example.com'}
|
||||||
flexmock(module.requests).should_receive('get').with_args('{}/{}'.format(ping_url, 'fail'))
|
flexmock(module.requests).should_receive('get').with_args('https://example.com/fail')
|
||||||
|
|
||||||
module.ping_monitor(
|
module.ping_monitor(
|
||||||
ping_url, 'config.yaml', module.monitor.State.FAIL, monitoring_log_level=1, dry_run=False
|
hook_config, 'config.yaml', module.monitor.State.FAIL, monitoring_log_level=1, dry_run=False
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_ping_monitor_dry_run_does_not_hit_ping_url():
|
def test_ping_monitor_dry_run_does_not_hit_ping_url():
|
||||||
ping_url = 'https://example.com'
|
hook_config = {'ping_url': 'https://example.com'}
|
||||||
flexmock(module.requests).should_receive('get').never()
|
flexmock(module.requests).should_receive('get').never()
|
||||||
|
|
||||||
module.ping_monitor(
|
module.ping_monitor(
|
||||||
ping_url, 'config.yaml', module.monitor.State.START, monitoring_log_level=1, dry_run=True
|
hook_config, 'config.yaml', module.monitor.State.START, monitoring_log_level=1, dry_run=True
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_ping_monitor_with_connection_error_does_not_raise():
|
||||||
|
hook_config = {'ping_url': 'https://example.com'}
|
||||||
|
flexmock(module.requests).should_receive('get').and_raise(
|
||||||
|
module.requests.exceptions.ConnectionError
|
||||||
|
)
|
||||||
|
|
||||||
|
module.ping_monitor(
|
||||||
|
hook_config,
|
||||||
|
'config.yaml',
|
||||||
|
module.monitor.State.START,
|
||||||
|
monitoring_log_level=1,
|
||||||
|
dry_run=False,
|
||||||
)
|
)
|
||||||
|
|
|
@ -12,6 +12,15 @@ def test_forgetful_buffering_handler_emit_collects_log_records():
|
||||||
assert not handler.forgot
|
assert not handler.forgot
|
||||||
|
|
||||||
|
|
||||||
|
def test_forgetful_buffering_handler_emit_collects_log_records_with_zero_byte_capacity():
|
||||||
|
handler = module.Forgetful_buffering_handler(byte_capacity=0, log_level=1)
|
||||||
|
handler.emit(flexmock(getMessage=lambda: 'foo'))
|
||||||
|
handler.emit(flexmock(getMessage=lambda: 'bar'))
|
||||||
|
|
||||||
|
assert handler.buffer == ['foo\n', 'bar\n']
|
||||||
|
assert not handler.forgot
|
||||||
|
|
||||||
|
|
||||||
def test_forgetful_buffering_handler_emit_forgets_log_records_when_capacity_reached():
|
def test_forgetful_buffering_handler_emit_forgets_log_records_when_capacity_reached():
|
||||||
handler = module.Forgetful_buffering_handler(byte_capacity=len('foo\nbar\n'), log_level=1)
|
handler = module.Forgetful_buffering_handler(byte_capacity=len('foo\nbar\n'), log_level=1)
|
||||||
handler.emit(flexmock(getMessage=lambda: 'foo'))
|
handler.emit(flexmock(getMessage=lambda: 'foo'))
|
||||||
|
@ -60,15 +69,80 @@ def test_format_buffered_logs_for_payload_without_handler_produces_empty_payload
|
||||||
assert payload == ''
|
assert payload == ''
|
||||||
|
|
||||||
|
|
||||||
|
def mock_logger():
|
||||||
|
logger = flexmock()
|
||||||
|
logger.should_receive('addHandler')
|
||||||
|
logger.should_receive('removeHandler')
|
||||||
|
flexmock(module.logging).should_receive('getLogger').and_return(logger)
|
||||||
|
|
||||||
|
|
||||||
|
def test_initialize_monitor_creates_log_handler_with_ping_body_limit():
|
||||||
|
ping_body_limit = 100
|
||||||
|
monitoring_log_level = 1
|
||||||
|
|
||||||
|
mock_logger()
|
||||||
|
flexmock(module).should_receive('Forgetful_buffering_handler').with_args(
|
||||||
|
ping_body_limit - len(module.PAYLOAD_TRUNCATION_INDICATOR), monitoring_log_level
|
||||||
|
).once()
|
||||||
|
|
||||||
|
module.initialize_monitor(
|
||||||
|
{'ping_body_limit': ping_body_limit}, 'test.yaml', monitoring_log_level, dry_run=False
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_initialize_monitor_creates_log_handler_with_default_ping_body_limit():
|
||||||
|
monitoring_log_level = 1
|
||||||
|
|
||||||
|
mock_logger()
|
||||||
|
flexmock(module).should_receive('Forgetful_buffering_handler').with_args(
|
||||||
|
module.DEFAULT_PING_BODY_LIMIT_BYTES - len(module.PAYLOAD_TRUNCATION_INDICATOR),
|
||||||
|
monitoring_log_level,
|
||||||
|
).once()
|
||||||
|
|
||||||
|
module.initialize_monitor({}, 'test.yaml', monitoring_log_level, dry_run=False)
|
||||||
|
|
||||||
|
|
||||||
|
def test_initialize_monitor_creates_log_handler_with_zero_ping_body_limit():
|
||||||
|
ping_body_limit = 0
|
||||||
|
monitoring_log_level = 1
|
||||||
|
|
||||||
|
mock_logger()
|
||||||
|
flexmock(module).should_receive('Forgetful_buffering_handler').with_args(
|
||||||
|
ping_body_limit, monitoring_log_level
|
||||||
|
).once()
|
||||||
|
|
||||||
|
module.initialize_monitor(
|
||||||
|
{'ping_body_limit': ping_body_limit}, 'test.yaml', monitoring_log_level, dry_run=False
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_initialize_monitor_creates_log_handler_when_send_logs_true():
|
||||||
|
mock_logger()
|
||||||
|
flexmock(module).should_receive('Forgetful_buffering_handler').once()
|
||||||
|
|
||||||
|
module.initialize_monitor(
|
||||||
|
{'send_logs': True}, 'test.yaml', monitoring_log_level=1, dry_run=False
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_initialize_monitor_bails_when_send_logs_false():
|
||||||
|
mock_logger()
|
||||||
|
flexmock(module).should_receive('Forgetful_buffering_handler').never()
|
||||||
|
|
||||||
|
module.initialize_monitor(
|
||||||
|
{'send_logs': False}, 'test.yaml', monitoring_log_level=1, dry_run=False
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_ping_monitor_hits_ping_url_for_start_state():
|
def test_ping_monitor_hits_ping_url_for_start_state():
|
||||||
flexmock(module).should_receive('Forgetful_buffering_handler')
|
flexmock(module).should_receive('Forgetful_buffering_handler')
|
||||||
ping_url = 'https://example.com'
|
hook_config = {'ping_url': 'https://example.com'}
|
||||||
flexmock(module.requests).should_receive('post').with_args(
|
flexmock(module.requests).should_receive('post').with_args(
|
||||||
'{}/{}'.format(ping_url, 'start'), data=''.encode('utf-8')
|
'https://example.com/start', data=''.encode('utf-8')
|
||||||
)
|
)
|
||||||
|
|
||||||
module.ping_monitor(
|
module.ping_monitor(
|
||||||
ping_url,
|
hook_config,
|
||||||
'config.yaml',
|
'config.yaml',
|
||||||
state=module.monitor.State.START,
|
state=module.monitor.State.START,
|
||||||
monitoring_log_level=1,
|
monitoring_log_level=1,
|
||||||
|
@ -77,15 +151,15 @@ def test_ping_monitor_hits_ping_url_for_start_state():
|
||||||
|
|
||||||
|
|
||||||
def test_ping_monitor_hits_ping_url_for_finish_state():
|
def test_ping_monitor_hits_ping_url_for_finish_state():
|
||||||
ping_url = 'https://example.com'
|
hook_config = {'ping_url': 'https://example.com'}
|
||||||
payload = 'data'
|
payload = 'data'
|
||||||
flexmock(module).should_receive('format_buffered_logs_for_payload').and_return(payload)
|
flexmock(module).should_receive('format_buffered_logs_for_payload').and_return(payload)
|
||||||
flexmock(module.requests).should_receive('post').with_args(
|
flexmock(module.requests).should_receive('post').with_args(
|
||||||
ping_url, data=payload.encode('utf-8')
|
'https://example.com', data=payload.encode('utf-8')
|
||||||
)
|
)
|
||||||
|
|
||||||
module.ping_monitor(
|
module.ping_monitor(
|
||||||
ping_url,
|
hook_config,
|
||||||
'config.yaml',
|
'config.yaml',
|
||||||
state=module.monitor.State.FINISH,
|
state=module.monitor.State.FINISH,
|
||||||
monitoring_log_level=1,
|
monitoring_log_level=1,
|
||||||
|
@ -94,15 +168,15 @@ def test_ping_monitor_hits_ping_url_for_finish_state():
|
||||||
|
|
||||||
|
|
||||||
def test_ping_monitor_hits_ping_url_for_fail_state():
|
def test_ping_monitor_hits_ping_url_for_fail_state():
|
||||||
ping_url = 'https://example.com'
|
hook_config = {'ping_url': 'https://example.com'}
|
||||||
payload = 'data'
|
payload = 'data'
|
||||||
flexmock(module).should_receive('format_buffered_logs_for_payload').and_return(payload)
|
flexmock(module).should_receive('format_buffered_logs_for_payload').and_return(payload)
|
||||||
flexmock(module.requests).should_receive('post').with_args(
|
flexmock(module.requests).should_receive('post').with_args(
|
||||||
'{}/{}'.format(ping_url, 'fail'), data=payload.encode('utf')
|
'https://example.com/fail', data=payload.encode('utf')
|
||||||
)
|
)
|
||||||
|
|
||||||
module.ping_monitor(
|
module.ping_monitor(
|
||||||
ping_url,
|
hook_config,
|
||||||
'config.yaml',
|
'config.yaml',
|
||||||
state=module.monitor.State.FAIL,
|
state=module.monitor.State.FAIL,
|
||||||
monitoring_log_level=1,
|
monitoring_log_level=1,
|
||||||
|
@ -111,15 +185,15 @@ def test_ping_monitor_hits_ping_url_for_fail_state():
|
||||||
|
|
||||||
|
|
||||||
def test_ping_monitor_with_ping_uuid_hits_corresponding_url():
|
def test_ping_monitor_with_ping_uuid_hits_corresponding_url():
|
||||||
ping_uuid = 'abcd-efgh-ijkl-mnop'
|
hook_config = {'ping_url': 'abcd-efgh-ijkl-mnop'}
|
||||||
payload = 'data'
|
payload = 'data'
|
||||||
flexmock(module).should_receive('format_buffered_logs_for_payload').and_return(payload)
|
flexmock(module).should_receive('format_buffered_logs_for_payload').and_return(payload)
|
||||||
flexmock(module.requests).should_receive('post').with_args(
|
flexmock(module.requests).should_receive('post').with_args(
|
||||||
'https://hc-ping.com/{}'.format(ping_uuid), data=payload.encode('utf-8')
|
'https://hc-ping.com/{}'.format(hook_config['ping_url']), data=payload.encode('utf-8')
|
||||||
)
|
)
|
||||||
|
|
||||||
module.ping_monitor(
|
module.ping_monitor(
|
||||||
ping_uuid,
|
hook_config,
|
||||||
'config.yaml',
|
'config.yaml',
|
||||||
state=module.monitor.State.FINISH,
|
state=module.monitor.State.FINISH,
|
||||||
monitoring_log_level=1,
|
monitoring_log_level=1,
|
||||||
|
@ -129,13 +203,60 @@ def test_ping_monitor_with_ping_uuid_hits_corresponding_url():
|
||||||
|
|
||||||
def test_ping_monitor_dry_run_does_not_hit_ping_url():
|
def test_ping_monitor_dry_run_does_not_hit_ping_url():
|
||||||
flexmock(module).should_receive('Forgetful_buffering_handler')
|
flexmock(module).should_receive('Forgetful_buffering_handler')
|
||||||
ping_url = 'https://example.com'
|
hook_config = {'ping_url': 'https://example.com'}
|
||||||
flexmock(module.requests).should_receive('post').never()
|
flexmock(module.requests).should_receive('post').never()
|
||||||
|
|
||||||
module.ping_monitor(
|
module.ping_monitor(
|
||||||
ping_url,
|
hook_config,
|
||||||
'config.yaml',
|
'config.yaml',
|
||||||
state=module.monitor.State.START,
|
state=module.monitor.State.START,
|
||||||
monitoring_log_level=1,
|
monitoring_log_level=1,
|
||||||
dry_run=True,
|
dry_run=True,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_ping_monitor_does_not_hit_ping_url_when_states_not_matching():
|
||||||
|
flexmock(module).should_receive('Forgetful_buffering_handler')
|
||||||
|
hook_config = {'ping_url': 'https://example.com', 'states': ['finish']}
|
||||||
|
flexmock(module.requests).should_receive('post').never()
|
||||||
|
|
||||||
|
module.ping_monitor(
|
||||||
|
hook_config,
|
||||||
|
'config.yaml',
|
||||||
|
state=module.monitor.State.START,
|
||||||
|
monitoring_log_level=1,
|
||||||
|
dry_run=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_ping_monitor_hits_ping_url_when_states_matching():
|
||||||
|
flexmock(module).should_receive('Forgetful_buffering_handler')
|
||||||
|
hook_config = {'ping_url': 'https://example.com', 'states': ['start', 'finish']}
|
||||||
|
flexmock(module.requests).should_receive('post').with_args(
|
||||||
|
'https://example.com/start', data=''.encode('utf-8')
|
||||||
|
)
|
||||||
|
|
||||||
|
module.ping_monitor(
|
||||||
|
hook_config,
|
||||||
|
'config.yaml',
|
||||||
|
state=module.monitor.State.START,
|
||||||
|
monitoring_log_level=1,
|
||||||
|
dry_run=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_ping_monitor_with_connection_error_does_not_raise():
|
||||||
|
flexmock(module).should_receive('Forgetful_buffering_handler')
|
||||||
|
flexmock(module.logger).should_receive('warning')
|
||||||
|
hook_config = {'ping_url': 'https://example.com'}
|
||||||
|
flexmock(module.requests).should_receive('post').with_args(
|
||||||
|
'https://example.com/start', data=''.encode('utf-8')
|
||||||
|
).and_raise(module.requests.exceptions.ConnectionError)
|
||||||
|
|
||||||
|
module.ping_monitor(
|
||||||
|
hook_config,
|
||||||
|
'config.yaml',
|
||||||
|
state=module.monitor.State.START,
|
||||||
|
monitoring_log_level=1,
|
||||||
|
dry_run=False,
|
||||||
|
)
|
||||||
|
|
|
@ -7,7 +7,11 @@ def test_ping_monitor_ignores_start_state():
|
||||||
flexmock(module.requests).should_receive('post').never()
|
flexmock(module.requests).should_receive('post').never()
|
||||||
|
|
||||||
module.ping_monitor(
|
module.ping_monitor(
|
||||||
'abc123', 'config.yaml', module.monitor.State.START, monitoring_log_level=1, dry_run=False
|
{'integration_key': 'abc123'},
|
||||||
|
'config.yaml',
|
||||||
|
module.monitor.State.START,
|
||||||
|
monitoring_log_level=1,
|
||||||
|
dry_run=False,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@ -15,7 +19,11 @@ def test_ping_monitor_ignores_finish_state():
|
||||||
flexmock(module.requests).should_receive('post').never()
|
flexmock(module.requests).should_receive('post').never()
|
||||||
|
|
||||||
module.ping_monitor(
|
module.ping_monitor(
|
||||||
'abc123', 'config.yaml', module.monitor.State.FINISH, monitoring_log_level=1, dry_run=False
|
{'integration_key': 'abc123'},
|
||||||
|
'config.yaml',
|
||||||
|
module.monitor.State.FINISH,
|
||||||
|
monitoring_log_level=1,
|
||||||
|
dry_run=False,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@ -23,7 +31,11 @@ def test_ping_monitor_calls_api_for_fail_state():
|
||||||
flexmock(module.requests).should_receive('post')
|
flexmock(module.requests).should_receive('post')
|
||||||
|
|
||||||
module.ping_monitor(
|
module.ping_monitor(
|
||||||
'abc123', 'config.yaml', module.monitor.State.FAIL, monitoring_log_level=1, dry_run=False
|
{'integration_key': 'abc123'},
|
||||||
|
'config.yaml',
|
||||||
|
module.monitor.State.FAIL,
|
||||||
|
monitoring_log_level=1,
|
||||||
|
dry_run=False,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@ -31,5 +43,24 @@ def test_ping_monitor_dry_run_does_not_call_api():
|
||||||
flexmock(module.requests).should_receive('post').never()
|
flexmock(module.requests).should_receive('post').never()
|
||||||
|
|
||||||
module.ping_monitor(
|
module.ping_monitor(
|
||||||
'abc123', 'config.yaml', module.monitor.State.FAIL, monitoring_log_level=1, dry_run=True
|
{'integration_key': 'abc123'},
|
||||||
|
'config.yaml',
|
||||||
|
module.monitor.State.FAIL,
|
||||||
|
monitoring_log_level=1,
|
||||||
|
dry_run=True,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_ping_monitor_with_connection_error_does_not_raise():
|
||||||
|
flexmock(module.requests).should_receive('post').and_raise(
|
||||||
|
module.requests.exceptions.ConnectionError
|
||||||
|
)
|
||||||
|
flexmock(module.logger).should_receive('warning')
|
||||||
|
|
||||||
|
module.ping_monitor(
|
||||||
|
{'integration_key': 'abc123'},
|
||||||
|
'config.yaml',
|
||||||
|
module.monitor.State.FAIL,
|
||||||
|
monitoring_log_level=1,
|
||||||
|
dry_run=False,
|
||||||
)
|
)
|
||||||
|
|
|
@ -0,0 +1,40 @@
|
||||||
|
from flexmock import flexmock
|
||||||
|
|
||||||
|
from borgmatic import signals as module
|
||||||
|
|
||||||
|
|
||||||
|
def test_handle_signal_forwards_to_subprocesses():
|
||||||
|
signal_number = 100
|
||||||
|
frame = flexmock(f_back=flexmock(f_code=flexmock(co_name='something')))
|
||||||
|
process_group = flexmock()
|
||||||
|
flexmock(module.os).should_receive('getpgrp').and_return(process_group)
|
||||||
|
flexmock(module.os).should_receive('killpg').with_args(process_group, signal_number).once()
|
||||||
|
|
||||||
|
module.handle_signal(signal_number, frame)
|
||||||
|
|
||||||
|
|
||||||
|
def test_handle_signal_bails_on_recursion():
|
||||||
|
signal_number = 100
|
||||||
|
frame = flexmock(f_back=flexmock(f_code=flexmock(co_name='handle_signal')))
|
||||||
|
flexmock(module.os).should_receive('getpgrp').never()
|
||||||
|
flexmock(module.os).should_receive('killpg').never()
|
||||||
|
|
||||||
|
module.handle_signal(signal_number, frame)
|
||||||
|
|
||||||
|
|
||||||
|
def test_handle_signal_exits_on_sigterm():
|
||||||
|
signal_number = module.signal.SIGTERM
|
||||||
|
frame = flexmock(f_back=flexmock(f_code=flexmock(co_name='something')))
|
||||||
|
flexmock(module.os).should_receive('getpgrp').and_return(flexmock)
|
||||||
|
flexmock(module.os).should_receive('killpg')
|
||||||
|
flexmock(module.sys).should_receive('exit').with_args(
|
||||||
|
module.EXIT_CODE_FROM_SIGNAL + signal_number
|
||||||
|
).once()
|
||||||
|
|
||||||
|
module.handle_signal(signal_number, frame)
|
||||||
|
|
||||||
|
|
||||||
|
def test_configure_signals_installs_signal_handlers():
|
||||||
|
flexmock(module.signal).should_receive('signal').at_least().once()
|
||||||
|
|
||||||
|
module.configure_signals()
|
Loading…
Reference in New Issue