Compare commits
92 Commits
Author | SHA1 | Date |
---|---|---|
Dan Helfman | fecae39fcd | |
Dan Helfman | 38bc4fbfe2 | |
Dan Helfman | 92ed7573d4 | |
Dan Helfman | 80f0e92462 | |
Dan Helfman | 5f10b1b2ca | |
Dan Helfman | 4f83b1e6b3 | |
Codimp | 15d5a687fb | |
Codimp | eb1fce3787 | |
Dan Helfman | 7f735cbe59 | |
Dan Helfman | a690ea4016 | |
Dan Helfman | 7a110c7acd | |
estebanthilliez | 407bb33359 | |
estebanthilliez | 4b7f7bba04 | |
estebanthilliez | cfdc0a1f2a | |
Dan Helfman | f926055e67 | |
Dan Helfman | 058af95d70 | |
Dan Helfman | 54facdc391 | |
estebanthi | 2e4c0cc7e7 | |
Dan Helfman | cb2fd7c5e8 | |
Dan Helfman | 94133cc8b1 | |
Dan Helfman | dcec89be90 | |
Dan Helfman | fefd5d1d0e | |
Dan Helfman | 163c37d77f | |
Dan Helfman | b0e49ebce0 | |
Dan Helfman | 7e51c41ebf | |
Dan Helfman | f9182514d8 | |
Dan Helfman | 7700b87b60 | |
Dan Helfman | 75bdbe6087 | |
Dan Helfman | d243a8c836 | |
Dan Helfman | 4c2eb2bfe3 | |
Dan Helfman | 89ce060dbd | |
Dan Helfman | ad7dcb4615 | |
Dan Helfman | 6680aece5a | |
Dan Helfman | 57eb93760f | |
Dan Helfman | f21a2c06e3 | |
Dan Helfman | 2212539cb0 | |
Dan Helfman | 36d10fecb1 | |
Dan Helfman | 3ecd0e731e | |
Dan Helfman | ecf5a7e294 | |
Dan Helfman | 893fbcf9ff | |
Dan Helfman | f8f6560502 | |
Dan Helfman | 8c301ba688 | |
Dan Helfman | 035e96156a | |
Dan Helfman | a08c7fc77a | |
Dan Helfman | cf9e387811 | |
Dan Helfman | e37224606a | |
Dan Helfman | 9647301b99 | |
Dan Helfman | a0e5dbff96 | |
Dan Helfman | 86117edccf | |
Dan Helfman | 440f3eeb63 | |
Dan Helfman | 181051eae1 | |
Dan Helfman | ec0ee971ed | |
Dan Helfman | b83ffa0cf6 | |
Dan Helfman | cf88665d37 | |
Dan Helfman | b233adba63 | |
Dan Helfman | 018f5e3315 | |
Dan Helfman | 284f26b49d | |
Dan Helfman | 11b437794e | |
Dan Helfman | 0665b50d57 | |
Dan Helfman | 0586b80e5b | |
Dan Helfman | 272a7b4866 | |
Dan Helfman | 98d4a59459 | |
Dan Helfman | 744139cf97 | |
Dan Helfman | 1339509e9b | |
Dan Helfman | e14f61415b | |
Dan Helfman | 98cf8f7e20 | |
Dan Helfman | 5f16b64639 | |
Dan Helfman | fe62a81151 | |
Dan Helfman | 585b1573ae | |
Dan Helfman | 141ba2771d | |
Dan Helfman | a527f76d08 | |
Dan Helfman | a97c68b4c8 | |
Dan Helfman | ef07005a75 | |
Dan Helfman | 43c7c3b6be | |
Dan Helfman | 2f6ad9d173 | |
Dan Helfman | 16bc0de3fb | |
shivansh02 | 458d157e62 | |
shivansh02 | 40c3a28620 | |
Dan Helfman | 60107f1ee8 | |
Dan Helfman | a1153a21fa | |
shivansh02 | b6cb7da98e | |
shivansh02 | 9e3d19a406 | |
shivansh02 | 2b755d8ade | |
shivansh02 | 925f99cfef | |
Dan Helfman | c9f20eb260 | |
Dan Helfman | f4744826fe | |
Dan Helfman | 5586aab967 | |
Dan Helfman | 6fa5dff79b | |
Dan Helfman | 75d11aa9cd | |
Dan Helfman | ad1d104d65 | |
Dan Helfman | 009062128d | |
Dan Helfman | e9813d2539 |
95
.drone.yml
95
.drone.yml
|
@ -1,95 +0,0 @@
|
||||||
---
|
|
||||||
kind: pipeline
|
|
||||||
name: python-3-8-alpine-3-13
|
|
||||||
|
|
||||||
services:
|
|
||||||
- name: postgresql
|
|
||||||
image: docker.io/postgres:13.1-alpine
|
|
||||||
environment:
|
|
||||||
POSTGRES_PASSWORD: test
|
|
||||||
POSTGRES_DB: test
|
|
||||||
- name: postgresql2
|
|
||||||
image: docker.io/postgres:13.1-alpine
|
|
||||||
environment:
|
|
||||||
POSTGRES_PASSWORD: test2
|
|
||||||
POSTGRES_DB: test
|
|
||||||
commands:
|
|
||||||
- docker-entrypoint.sh -p 5433
|
|
||||||
- name: mariadb
|
|
||||||
image: docker.io/mariadb:10.11.4
|
|
||||||
environment:
|
|
||||||
MARIADB_ROOT_PASSWORD: test
|
|
||||||
MARIADB_DATABASE: test
|
|
||||||
- name: mariadb2
|
|
||||||
image: docker.io/mariadb:10.11.4
|
|
||||||
environment:
|
|
||||||
MARIADB_ROOT_PASSWORD: test2
|
|
||||||
MARIADB_DATABASE: test
|
|
||||||
commands:
|
|
||||||
- docker-entrypoint.sh --port=3307
|
|
||||||
- name: not-actually-mysql
|
|
||||||
image: docker.io/mariadb:10.11.4
|
|
||||||
environment:
|
|
||||||
MARIADB_ROOT_PASSWORD: test
|
|
||||||
MARIADB_DATABASE: test
|
|
||||||
- name: not-actually-mysql2
|
|
||||||
image: docker.io/mariadb:10.11.4
|
|
||||||
environment:
|
|
||||||
MARIADB_ROOT_PASSWORD: test2
|
|
||||||
MARIADB_DATABASE: test
|
|
||||||
commands:
|
|
||||||
- docker-entrypoint.sh --port=3307
|
|
||||||
- name: mongodb
|
|
||||||
image: docker.io/mongo:5.0.5
|
|
||||||
environment:
|
|
||||||
MONGO_INITDB_ROOT_USERNAME: root
|
|
||||||
MONGO_INITDB_ROOT_PASSWORD: test
|
|
||||||
- name: mongodb2
|
|
||||||
image: docker.io/mongo:5.0.5
|
|
||||||
environment:
|
|
||||||
MONGO_INITDB_ROOT_USERNAME: root2
|
|
||||||
MONGO_INITDB_ROOT_PASSWORD: test2
|
|
||||||
commands:
|
|
||||||
- docker-entrypoint.sh --port=27018
|
|
||||||
|
|
||||||
clone:
|
|
||||||
skip_verify: true
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: build
|
|
||||||
image: docker.io/alpine:3.13
|
|
||||||
environment:
|
|
||||||
TEST_CONTAINER: true
|
|
||||||
pull: always
|
|
||||||
commands:
|
|
||||||
- scripts/run-full-tests
|
|
||||||
---
|
|
||||||
kind: pipeline
|
|
||||||
name: documentation
|
|
||||||
type: exec
|
|
||||||
|
|
||||||
platform:
|
|
||||||
os: linux
|
|
||||||
arch: amd64
|
|
||||||
|
|
||||||
clone:
|
|
||||||
skip_verify: true
|
|
||||||
|
|
||||||
steps:
|
|
||||||
- name: build
|
|
||||||
environment:
|
|
||||||
USERNAME:
|
|
||||||
from_secret: docker_username
|
|
||||||
PASSWORD:
|
|
||||||
from_secret: docker_password
|
|
||||||
IMAGE_NAME: projects.torsion.org/borgmatic-collective/borgmatic:docs
|
|
||||||
commands:
|
|
||||||
- podman login --username "$USERNAME" --password "$PASSWORD" projects.torsion.org
|
|
||||||
- podman build --tag "$IMAGE_NAME" --file docs/Dockerfile --storage-opt "overlay.mount_program=/usr/bin/fuse-overlayfs" .
|
|
||||||
- podman push "$IMAGE_NAME"
|
|
||||||
|
|
||||||
trigger:
|
|
||||||
repo:
|
|
||||||
- borgmatic-collective/borgmatic
|
|
||||||
branch:
|
|
||||||
- main
|
|
|
@ -0,0 +1,28 @@
|
||||||
|
name: build
|
||||||
|
run-name: ${{ gitea.actor }} is building
|
||||||
|
on:
|
||||||
|
push:
|
||||||
|
branches: [main]
|
||||||
|
|
||||||
|
jobs:
|
||||||
|
test:
|
||||||
|
runs-on: host
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- run: scripts/run-end-to-end-tests
|
||||||
|
|
||||||
|
docs:
|
||||||
|
needs: [test]
|
||||||
|
runs-on: host
|
||||||
|
env:
|
||||||
|
IMAGE_NAME: projects.torsion.org/borgmatic-collective/borgmatic:docs
|
||||||
|
|
||||||
|
steps:
|
||||||
|
- uses: actions/checkout@v4
|
||||||
|
- run: podman login --username "$USERNAME" --password "$PASSWORD" projects.torsion.org
|
||||||
|
env:
|
||||||
|
USERNAME: "${{ secrets.REGISTRY_USERNAME }}"
|
||||||
|
PASSWORD: "${{ secrets.REGISTRY_PASSWORD }}"
|
||||||
|
- run: podman build --tag "$IMAGE_NAME" --file docs/Dockerfile --storage-opt "overlay.mount_program=/usr/bin/fuse-overlayfs" .
|
||||||
|
- run: podman push "$IMAGE_NAME"
|
62
NEWS
62
NEWS
|
@ -1,3 +1,65 @@
|
||||||
|
1.8.12.dev0
|
||||||
|
* #860: Fix interaction between environment variable interpolation in constants and shell escaping.
|
||||||
|
|
||||||
|
1.8.11
|
||||||
|
* #815: Add optional Healthchecks auto-provisioning via "create_slug" option.
|
||||||
|
* #851: Fix lack of file extraction when using "extract --strip-components all" on a path with a
|
||||||
|
leading slash.
|
||||||
|
* #854: Fix a traceback when the "data" consistency check is used.
|
||||||
|
* #857: Fix a traceback with "check --only spot" when the "spot" check is unconfigured.
|
||||||
|
|
||||||
|
1.8.10
|
||||||
|
* #656 (beta): Add a "spot" consistency check that compares file counts and contents between your
|
||||||
|
source files and the latest archive, ensuring they fall within configured tolerances. This can
|
||||||
|
catch problems like incorrect excludes, inadvertent deletes, files changed by malware, etc. See
|
||||||
|
the documentation for more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/deal-with-very-large-backups/#spot-check
|
||||||
|
* #779: When "--match-archives *" is used with "check" action, don't skip Borg's orphaned objects
|
||||||
|
check.
|
||||||
|
* #842: When a command hook exits with a soft failure, ping the log and finish states for any
|
||||||
|
configured monitoring hooks.
|
||||||
|
* #843: Add documentation link to Loki dashboard for borgmatic:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#loki-hook
|
||||||
|
* #847: Fix "--json" error when Borg includes non-JSON warnings in JSON output.
|
||||||
|
* #848: SECURITY: Mask the password when logging a MongoDB dump or restore command.
|
||||||
|
* Fix handling of the NO_COLOR environment variable to ignore an empty value.
|
||||||
|
* Add documentation about backing up containerized databases by configuring borgmatic to exec into
|
||||||
|
a container to run a dump command:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/backup-your-databases/#containers
|
||||||
|
|
||||||
|
1.8.9
|
||||||
|
* #311: Add custom dump/restore command options for MySQL and MariaDB.
|
||||||
|
* #811: Add an "access_token" option to the ntfy monitoring hook for authenticating
|
||||||
|
without username/password.
|
||||||
|
* #827: When the "--json" flag is given, suppress console escape codes so as not to
|
||||||
|
interfere with JSON output.
|
||||||
|
* #829: Fix "--override" values containing deprecated section headers not actually overriding
|
||||||
|
configuration options under deprecated section headers.
|
||||||
|
* #835: Add support for the NO_COLOR environment variable. See the documentation for more
|
||||||
|
information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/set-up-backups/#colored-output
|
||||||
|
* #839: Add log sending for the Apprise logging hook, enabled by default. See the documentation for
|
||||||
|
more information:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#apprise-hook
|
||||||
|
* #839: Document a potentially breaking shell quoting edge case within error hooks:
|
||||||
|
https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#error-hooks
|
||||||
|
* #840: When running the "rcreate" action and the repository already exists but with a different
|
||||||
|
encryption mode than requested, error.
|
||||||
|
* Switch from Drone to Gitea Actions for continuous integration.
|
||||||
|
* Rename scripts/run-end-to-end-dev-tests to scripts/run-end-to-end-tests and use it in both dev
|
||||||
|
and CI for better dev-CI parity.
|
||||||
|
* Clarify documentation about restoring a database: borgmatic does not create the database upon
|
||||||
|
restore.
|
||||||
|
|
||||||
|
1.8.8
|
||||||
|
* #370: For the PostgreSQL hook, pass the "PGSSLMODE" environment variable through to Borg when the
|
||||||
|
database's configuration omits the "ssl_mode" option.
|
||||||
|
* #818: Allow the "--repository" flag to match across multiple configuration files.
|
||||||
|
* #820: Fix broken repository detection in the "rcreate" action with Borg 1.4. The issue did not
|
||||||
|
occur with other versions of Borg.
|
||||||
|
* #822: Fix broken escaping logic in the PostgreSQL hook's "pg_dump_command" option.
|
||||||
|
* SECURITY: Prevent additional shell injection attacks within the PostgreSQL hook.
|
||||||
|
|
||||||
1.8.7
|
1.8.7
|
||||||
* #736: Store included configuration files within each backup archive in support of the "config
|
* #736: Store included configuration files within each backup archive in support of the "config
|
||||||
bootstrap" action. Previously, only top-level configuration files were stored.
|
bootstrap" action. Previously, only top-level configuration files were stored.
|
||||||
|
|
|
@ -154,6 +154,3 @@ general, contributions are very welcome. We don't bite!
|
||||||
Also, please check out the [borgmatic development
|
Also, please check out the [borgmatic development
|
||||||
how-to](https://torsion.org/borgmatic/docs/how-to/develop-on-borgmatic/) for
|
how-to](https://torsion.org/borgmatic/docs/how-to/develop-on-borgmatic/) for
|
||||||
info on cloning source code, running tests, etc.
|
info on cloning source code, running tests, etc.
|
||||||
|
|
||||||
<a href="https://build.torsion.org/borgmatic-collective/borgmatic" alt="build status">![Build Status](https://build.torsion.org/api/badges/borgmatic-collective/borgmatic/status.svg?ref=refs/heads/main)</a>
|
|
||||||
|
|
||||||
|
|
|
@ -1,12 +1,575 @@
|
||||||
|
import datetime
|
||||||
|
import hashlib
|
||||||
|
import itertools
|
||||||
import logging
|
import logging
|
||||||
|
import os
|
||||||
|
import pathlib
|
||||||
|
import random
|
||||||
|
|
||||||
import borgmatic.borg.check
|
import borgmatic.borg.check
|
||||||
|
import borgmatic.borg.create
|
||||||
|
import borgmatic.borg.environment
|
||||||
|
import borgmatic.borg.extract
|
||||||
|
import borgmatic.borg.list
|
||||||
|
import borgmatic.borg.rlist
|
||||||
|
import borgmatic.borg.state
|
||||||
import borgmatic.config.validate
|
import borgmatic.config.validate
|
||||||
|
import borgmatic.execute
|
||||||
import borgmatic.hooks.command
|
import borgmatic.hooks.command
|
||||||
|
|
||||||
|
DEFAULT_CHECKS = (
|
||||||
|
{'name': 'repository', 'frequency': '1 month'},
|
||||||
|
{'name': 'archives', 'frequency': '1 month'},
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
|
def parse_checks(config, only_checks=None):
|
||||||
|
'''
|
||||||
|
Given a configuration dict with a "checks" sequence of dicts and an optional list of override
|
||||||
|
checks, return a tuple of named checks to run.
|
||||||
|
|
||||||
|
For example, given a config of:
|
||||||
|
|
||||||
|
{'checks': ({'name': 'repository'}, {'name': 'archives'})}
|
||||||
|
|
||||||
|
This will be returned as:
|
||||||
|
|
||||||
|
('repository', 'archives')
|
||||||
|
|
||||||
|
If no "checks" option is present in the config, return the DEFAULT_CHECKS. If a checks value
|
||||||
|
has a name of "disabled", return an empty tuple, meaning that no checks should be run.
|
||||||
|
'''
|
||||||
|
checks = only_checks or tuple(
|
||||||
|
check_config['name'] for check_config in (config.get('checks', None) or DEFAULT_CHECKS)
|
||||||
|
)
|
||||||
|
checks = tuple(check.lower() for check in checks)
|
||||||
|
|
||||||
|
if 'disabled' in checks:
|
||||||
|
logger.warning(
|
||||||
|
'The "disabled" value for the "checks" option is deprecated and will be removed from a future release; use "skip_actions" instead'
|
||||||
|
)
|
||||||
|
if len(checks) > 1:
|
||||||
|
logger.warning(
|
||||||
|
'Multiple checks are configured, but one of them is "disabled"; not running any checks'
|
||||||
|
)
|
||||||
|
return ()
|
||||||
|
|
||||||
|
return checks
|
||||||
|
|
||||||
|
|
||||||
|
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(
|
||||||
|
config,
|
||||||
|
borg_repository_id,
|
||||||
|
checks,
|
||||||
|
force,
|
||||||
|
archives_check_id=None,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Given a configuration dict with a "checks" sequence of dicts, a Borg repository ID, a sequence
|
||||||
|
of checks, whether to force checks to run, and an ID for the archives check potentially being
|
||||||
|
run (if any), 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:
|
||||||
|
|
||||||
|
config = {
|
||||||
|
'checks': [
|
||||||
|
{
|
||||||
|
'name': 'archives',
|
||||||
|
'frequency': '2 weeks',
|
||||||
|
},
|
||||||
|
]
|
||||||
|
}
|
||||||
|
|
||||||
|
When this function is called with that 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.
|
||||||
|
'''
|
||||||
|
if not checks:
|
||||||
|
return checks
|
||||||
|
|
||||||
|
filtered_checks = list(checks)
|
||||||
|
|
||||||
|
if force:
|
||||||
|
return tuple(filtered_checks)
|
||||||
|
|
||||||
|
for check_config in 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 = probe_for_check_time(config, borg_repository_id, check, archives_check_id)
|
||||||
|
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 (use --force to check anyway)'
|
||||||
|
)
|
||||||
|
filtered_checks.remove(check)
|
||||||
|
|
||||||
|
return tuple(filtered_checks)
|
||||||
|
|
||||||
|
|
||||||
|
def make_archives_check_id(archive_filter_flags):
|
||||||
|
'''
|
||||||
|
Given a sequence of flags to filter archives, return a unique hash corresponding to those
|
||||||
|
particular flags. If there are no flags, return None.
|
||||||
|
'''
|
||||||
|
if not archive_filter_flags:
|
||||||
|
return None
|
||||||
|
|
||||||
|
return hashlib.sha256(' '.join(archive_filter_flags).encode()).hexdigest()
|
||||||
|
|
||||||
|
|
||||||
|
def make_check_time_path(config, borg_repository_id, check_type, archives_check_id=None):
|
||||||
|
'''
|
||||||
|
Given a configuration dict, a Borg repository ID, the name of a check type ("repository",
|
||||||
|
"archives", etc.), and a unique hash of the archives filter flags, return a path for recording
|
||||||
|
that check's time (the time of that check last occurring).
|
||||||
|
'''
|
||||||
|
borgmatic_source_directory = os.path.expanduser(
|
||||||
|
config.get(
|
||||||
|
'borgmatic_source_directory', borgmatic.borg.state.DEFAULT_BORGMATIC_SOURCE_DIRECTORY
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
if check_type in ('archives', 'data'):
|
||||||
|
return os.path.join(
|
||||||
|
borgmatic_source_directory,
|
||||||
|
'checks',
|
||||||
|
borg_repository_id,
|
||||||
|
check_type,
|
||||||
|
archives_check_id if archives_check_id else 'all',
|
||||||
|
)
|
||||||
|
|
||||||
|
return os.path.join(
|
||||||
|
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 probe_for_check_time(config, borg_repository_id, check, archives_check_id):
|
||||||
|
'''
|
||||||
|
Given a configuration dict, a Borg repository ID, the name of a check type ("repository",
|
||||||
|
"archives", etc.), and a unique hash of the archives filter flags, return a the corresponding
|
||||||
|
check time or None if such a check time does not exist.
|
||||||
|
|
||||||
|
When the check type is "archives" or "data", this function probes two different paths to find
|
||||||
|
the check time, e.g.:
|
||||||
|
|
||||||
|
~/.borgmatic/checks/1234567890/archives/9876543210
|
||||||
|
~/.borgmatic/checks/1234567890/archives/all
|
||||||
|
|
||||||
|
... and returns the maximum modification time of the files found (if any). The first path
|
||||||
|
represents a more specific archives check time (a check on a subset of archives), and the second
|
||||||
|
is a fallback to the last "all" archives check.
|
||||||
|
|
||||||
|
For other check types, this function reads from a single check time path, e.g.:
|
||||||
|
|
||||||
|
~/.borgmatic/checks/1234567890/repository
|
||||||
|
'''
|
||||||
|
check_times = (
|
||||||
|
read_check_time(group[0])
|
||||||
|
for group in itertools.groupby(
|
||||||
|
(
|
||||||
|
make_check_time_path(config, borg_repository_id, check, archives_check_id),
|
||||||
|
make_check_time_path(config, borg_repository_id, check),
|
||||||
|
)
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
try:
|
||||||
|
return max(check_time for check_time in check_times if check_time)
|
||||||
|
except ValueError:
|
||||||
|
return None
|
||||||
|
|
||||||
|
|
||||||
|
def upgrade_check_times(config, borg_repository_id):
|
||||||
|
'''
|
||||||
|
Given a configuration dict and a Borg repository ID, upgrade any corresponding check times on
|
||||||
|
disk from old-style paths to new-style paths.
|
||||||
|
|
||||||
|
Currently, the only upgrade performed is renaming an archive or data check path that looks like:
|
||||||
|
|
||||||
|
~/.borgmatic/checks/1234567890/archives
|
||||||
|
|
||||||
|
to:
|
||||||
|
|
||||||
|
~/.borgmatic/checks/1234567890/archives/all
|
||||||
|
'''
|
||||||
|
for check_type in ('archives', 'data'):
|
||||||
|
new_path = make_check_time_path(config, borg_repository_id, check_type, 'all')
|
||||||
|
old_path = os.path.dirname(new_path)
|
||||||
|
temporary_path = f'{old_path}.temp'
|
||||||
|
|
||||||
|
if not os.path.isfile(old_path) and not os.path.isfile(temporary_path):
|
||||||
|
continue
|
||||||
|
|
||||||
|
logger.debug(f'Upgrading archives check time from {old_path} to {new_path}')
|
||||||
|
|
||||||
|
try:
|
||||||
|
os.rename(old_path, temporary_path)
|
||||||
|
except FileNotFoundError:
|
||||||
|
pass
|
||||||
|
|
||||||
|
os.mkdir(old_path)
|
||||||
|
os.rename(temporary_path, new_path)
|
||||||
|
|
||||||
|
|
||||||
|
def collect_spot_check_source_paths(
|
||||||
|
repository, config, local_borg_version, global_arguments, local_path, remote_path
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Given a repository configuration dict, a configuration dict, the local Borg version, global
|
||||||
|
arguments as an argparse.Namespace instance, the local Borg path, and the remote Borg path,
|
||||||
|
collect the source paths that Borg would use in an actual create (but only include files and
|
||||||
|
symlinks).
|
||||||
|
'''
|
||||||
|
stream_processes = any(
|
||||||
|
borgmatic.hooks.dispatch.call_hooks(
|
||||||
|
'use_streaming',
|
||||||
|
config,
|
||||||
|
repository['path'],
|
||||||
|
borgmatic.hooks.dump.DATA_SOURCE_HOOK_NAMES,
|
||||||
|
).values()
|
||||||
|
)
|
||||||
|
|
||||||
|
(create_flags, create_positional_arguments, pattern_file, exclude_file) = (
|
||||||
|
borgmatic.borg.create.make_base_create_command(
|
||||||
|
dry_run=True,
|
||||||
|
repository_path=repository['path'],
|
||||||
|
config=config,
|
||||||
|
config_paths=(),
|
||||||
|
local_borg_version=local_borg_version,
|
||||||
|
global_arguments=global_arguments,
|
||||||
|
borgmatic_source_directories=(),
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
list_files=True,
|
||||||
|
stream_processes=stream_processes,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
borg_environment = borgmatic.borg.environment.make_environment(config)
|
||||||
|
|
||||||
|
try:
|
||||||
|
working_directory = os.path.expanduser(config.get('working_directory'))
|
||||||
|
except TypeError:
|
||||||
|
working_directory = None
|
||||||
|
|
||||||
|
paths_output = borgmatic.execute.execute_command_and_capture_output(
|
||||||
|
create_flags + create_positional_arguments,
|
||||||
|
capture_stderr=True,
|
||||||
|
working_directory=working_directory,
|
||||||
|
extra_environment=borg_environment,
|
||||||
|
borg_local_path=local_path,
|
||||||
|
borg_exit_codes=config.get('borg_exit_codes'),
|
||||||
|
)
|
||||||
|
|
||||||
|
paths = tuple(
|
||||||
|
path_line.split(' ', 1)[1]
|
||||||
|
for path_line in paths_output.split('\n')
|
||||||
|
if path_line and path_line.startswith('- ') or path_line.startswith('+ ')
|
||||||
|
)
|
||||||
|
|
||||||
|
return tuple(path for path in paths if os.path.isfile(path) or os.path.islink(path))
|
||||||
|
|
||||||
|
|
||||||
|
BORG_DIRECTORY_FILE_TYPE = 'd'
|
||||||
|
|
||||||
|
|
||||||
|
def collect_spot_check_archive_paths(
|
||||||
|
repository, archive, config, local_borg_version, global_arguments, local_path, remote_path
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Given a repository configuration dict, the name of the latest archive, a configuration dict, the
|
||||||
|
local Borg version, global arguments as an argparse.Namespace instance, the local Borg path, and
|
||||||
|
the remote Borg path, collect the paths from the given archive (but only include files and
|
||||||
|
symlinks).
|
||||||
|
'''
|
||||||
|
borgmatic_source_directory = os.path.expanduser(
|
||||||
|
config.get(
|
||||||
|
'borgmatic_source_directory', borgmatic.borg.state.DEFAULT_BORGMATIC_SOURCE_DIRECTORY
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
return tuple(
|
||||||
|
path
|
||||||
|
for line in borgmatic.borg.list.capture_archive_listing(
|
||||||
|
repository['path'],
|
||||||
|
archive,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
path_format='{type} /{path}{NL}', # noqa: FS003
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
)
|
||||||
|
for (file_type, path) in (line.split(' ', 1),)
|
||||||
|
if file_type != BORG_DIRECTORY_FILE_TYPE
|
||||||
|
if pathlib.Path(borgmatic_source_directory) not in pathlib.Path(path).parents
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def compare_spot_check_hashes(
|
||||||
|
repository,
|
||||||
|
archive,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
log_label,
|
||||||
|
source_paths,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Given a repository configuration dict, the name of the latest archive, a configuration dict, the
|
||||||
|
local Borg version, global arguments as an argparse.Namespace instance, the local Borg path, the
|
||||||
|
remote Borg path, a log label, and spot check source paths, compare the hashes for a sampling of
|
||||||
|
the source paths with hashes from corresponding paths in the given archive. Return a sequence of
|
||||||
|
the paths that fail that hash comparison.
|
||||||
|
'''
|
||||||
|
# Based on the configured sample percentage, come up with a list of random sample files from the
|
||||||
|
# source directories.
|
||||||
|
spot_check_config = next(check for check in config['checks'] if check['name'] == 'spot')
|
||||||
|
sample_count = max(
|
||||||
|
int(len(source_paths) * (min(spot_check_config['data_sample_percentage'], 100) / 100)), 1
|
||||||
|
)
|
||||||
|
source_sample_paths = tuple(random.sample(source_paths, sample_count))
|
||||||
|
existing_source_sample_paths = {
|
||||||
|
source_path for source_path in source_sample_paths if os.path.exists(source_path)
|
||||||
|
}
|
||||||
|
logger.debug(
|
||||||
|
f'{log_label}: Sampling {sample_count} source paths (~{spot_check_config["data_sample_percentage"]}%) for spot check'
|
||||||
|
)
|
||||||
|
|
||||||
|
# Hash each file in the sample paths (if it exists).
|
||||||
|
hash_output = borgmatic.execute.execute_command_and_capture_output(
|
||||||
|
(spot_check_config.get('xxh64sum_command', 'xxh64sum'),)
|
||||||
|
+ tuple(path for path in source_sample_paths if path in existing_source_sample_paths)
|
||||||
|
)
|
||||||
|
|
||||||
|
source_hashes = dict(
|
||||||
|
(reversed(line.split(' ', 1)) for line in hash_output.splitlines()),
|
||||||
|
**{path: '' for path in source_sample_paths if path not in existing_source_sample_paths},
|
||||||
|
)
|
||||||
|
|
||||||
|
archive_hashes = dict(
|
||||||
|
reversed(line.split(' ', 1))
|
||||||
|
for line in borgmatic.borg.list.capture_archive_listing(
|
||||||
|
repository['path'],
|
||||||
|
archive,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
list_paths=source_sample_paths,
|
||||||
|
path_format='{xxh64} /{path}{NL}', # noqa: FS003
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
)
|
||||||
|
if line
|
||||||
|
)
|
||||||
|
|
||||||
|
# Compare the source hashes with the archive hashes to see how many match.
|
||||||
|
failing_paths = []
|
||||||
|
|
||||||
|
for path, source_hash in source_hashes.items():
|
||||||
|
archive_hash = archive_hashes.get(path)
|
||||||
|
|
||||||
|
if archive_hash is not None and archive_hash == source_hash:
|
||||||
|
continue
|
||||||
|
|
||||||
|
failing_paths.append(path)
|
||||||
|
|
||||||
|
return tuple(failing_paths)
|
||||||
|
|
||||||
|
|
||||||
|
def spot_check(
|
||||||
|
repository,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Given a repository dict, a loaded configuration dict, the local Borg version, global arguments
|
||||||
|
as an argparse.Namespace instance, the local Borg path, and the remote Borg path, perform a spot
|
||||||
|
check for the latest archive in the given repository.
|
||||||
|
|
||||||
|
A spot check compares file counts and also the hashes for a random sampling of source files on
|
||||||
|
disk to those stored in the latest archive. If any differences are beyond configured tolerances,
|
||||||
|
then the check fails.
|
||||||
|
'''
|
||||||
|
log_label = f'{repository.get("label", repository["path"])}'
|
||||||
|
logger.debug(f'{log_label}: Running spot check')
|
||||||
|
|
||||||
|
try:
|
||||||
|
spot_check_config = next(
|
||||||
|
check for check in config.get('checks', ()) if check.get('name') == 'spot'
|
||||||
|
)
|
||||||
|
except StopIteration:
|
||||||
|
raise ValueError('Cannot run spot check because it is unconfigured')
|
||||||
|
|
||||||
|
if spot_check_config['data_tolerance_percentage'] > spot_check_config['data_sample_percentage']:
|
||||||
|
raise ValueError(
|
||||||
|
'The data_tolerance_percentage must be less than or equal to the data_sample_percentage'
|
||||||
|
)
|
||||||
|
|
||||||
|
source_paths = collect_spot_check_source_paths(
|
||||||
|
repository,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
|
logger.debug(f'{log_label}: {len(source_paths)} total source paths for spot check')
|
||||||
|
|
||||||
|
archive = borgmatic.borg.rlist.resolve_archive_name(
|
||||||
|
repository['path'],
|
||||||
|
'latest',
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
|
logger.debug(f'{log_label}: Using archive {archive} for spot check')
|
||||||
|
|
||||||
|
archive_paths = collect_spot_check_archive_paths(
|
||||||
|
repository,
|
||||||
|
archive,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
|
logger.debug(f'{log_label}: {len(archive_paths)} total archive paths for spot check')
|
||||||
|
|
||||||
|
# Calculate the percentage delta between the source paths count and the archive paths count, and
|
||||||
|
# compare that delta to the configured count tolerance percentage.
|
||||||
|
count_delta_percentage = abs(len(source_paths) - len(archive_paths)) / len(source_paths) * 100
|
||||||
|
|
||||||
|
if count_delta_percentage > spot_check_config['count_tolerance_percentage']:
|
||||||
|
logger.debug(
|
||||||
|
f'{log_label}: Paths in source paths but not latest archive: {", ".join(set(source_paths) - set(archive_paths)) or "none"}'
|
||||||
|
)
|
||||||
|
logger.debug(
|
||||||
|
f'{log_label}: Paths in latest archive but not source paths: {", ".join(set(archive_paths) - set(source_paths)) or "none"}'
|
||||||
|
)
|
||||||
|
raise ValueError(
|
||||||
|
f'Spot check failed: {count_delta_percentage:.2f}% file count delta between source paths and latest archive (tolerance is {spot_check_config["count_tolerance_percentage"]}%)'
|
||||||
|
)
|
||||||
|
|
||||||
|
failing_paths = compare_spot_check_hashes(
|
||||||
|
repository,
|
||||||
|
archive,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
log_label,
|
||||||
|
source_paths,
|
||||||
|
)
|
||||||
|
|
||||||
|
# Error if the percentage of failing hashes exceeds the configured tolerance percentage.
|
||||||
|
logger.debug(f'{log_label}: {len(failing_paths)} non-matching spot check hashes')
|
||||||
|
data_tolerance_percentage = spot_check_config['data_tolerance_percentage']
|
||||||
|
failing_percentage = (len(failing_paths) / len(source_paths)) * 100
|
||||||
|
|
||||||
|
if failing_percentage > data_tolerance_percentage:
|
||||||
|
logger.debug(
|
||||||
|
f'{log_label}: Source paths with data not matching the latest archive: {", ".join(failing_paths)}'
|
||||||
|
)
|
||||||
|
raise ValueError(
|
||||||
|
f'Spot check failed: {failing_percentage:.2f}% of source paths with data not matching the latest archive (tolerance is {data_tolerance_percentage}%)'
|
||||||
|
)
|
||||||
|
|
||||||
|
logger.info(
|
||||||
|
f'{log_label}: Spot check passed with a {count_delta_percentage:.2f}% file count delta and a {failing_percentage:.2f}% file data delta'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def run_check(
|
def run_check(
|
||||||
config_filename,
|
config_filename,
|
||||||
repository,
|
repository,
|
||||||
|
@ -20,6 +583,8 @@ def run_check(
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Run the "check" action for the given repository.
|
Run the "check" action for the given repository.
|
||||||
|
|
||||||
|
Raise ValueError if the Borg repository ID cannot be determined.
|
||||||
'''
|
'''
|
||||||
if check_arguments.repository and not borgmatic.config.validate.repositories_match(
|
if check_arguments.repository and not borgmatic.config.validate.repositories_match(
|
||||||
repository, check_arguments.repository
|
repository, check_arguments.repository
|
||||||
|
@ -34,16 +599,69 @@ def run_check(
|
||||||
global_arguments.dry_run,
|
global_arguments.dry_run,
|
||||||
**hook_context,
|
**hook_context,
|
||||||
)
|
)
|
||||||
|
|
||||||
logger.info(f'{repository.get("label", repository["path"])}: Running consistency checks')
|
logger.info(f'{repository.get("label", repository["path"])}: Running consistency checks')
|
||||||
borgmatic.borg.check.check_archives(
|
repository_id = borgmatic.borg.check.get_repository_id(
|
||||||
repository['path'],
|
repository['path'],
|
||||||
config,
|
config,
|
||||||
local_borg_version,
|
local_borg_version,
|
||||||
check_arguments,
|
|
||||||
global_arguments,
|
global_arguments,
|
||||||
local_path=local_path,
|
local_path=local_path,
|
||||||
remote_path=remote_path,
|
remote_path=remote_path,
|
||||||
)
|
)
|
||||||
|
upgrade_check_times(config, repository_id)
|
||||||
|
configured_checks = parse_checks(config, check_arguments.only_checks)
|
||||||
|
archive_filter_flags = borgmatic.borg.check.make_archive_filter_flags(
|
||||||
|
local_borg_version, config, configured_checks, check_arguments
|
||||||
|
)
|
||||||
|
archives_check_id = make_archives_check_id(archive_filter_flags)
|
||||||
|
checks = filter_checks_on_frequency(
|
||||||
|
config,
|
||||||
|
repository_id,
|
||||||
|
configured_checks,
|
||||||
|
check_arguments.force,
|
||||||
|
archives_check_id,
|
||||||
|
)
|
||||||
|
borg_specific_checks = set(checks).intersection({'repository', 'archives', 'data'})
|
||||||
|
|
||||||
|
if borg_specific_checks:
|
||||||
|
borgmatic.borg.check.check_archives(
|
||||||
|
repository['path'],
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
check_arguments,
|
||||||
|
global_arguments,
|
||||||
|
borg_specific_checks,
|
||||||
|
archive_filter_flags,
|
||||||
|
local_path=local_path,
|
||||||
|
remote_path=remote_path,
|
||||||
|
)
|
||||||
|
for check in borg_specific_checks:
|
||||||
|
write_check_time(make_check_time_path(config, repository_id, check, archives_check_id))
|
||||||
|
|
||||||
|
if 'extract' in checks:
|
||||||
|
borgmatic.borg.extract.extract_last_archive_dry_run(
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
repository['path'],
|
||||||
|
config.get('lock_wait'),
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
|
write_check_time(make_check_time_path(config, repository_id, 'extract'))
|
||||||
|
|
||||||
|
if 'spot' in checks:
|
||||||
|
spot_check(
|
||||||
|
repository,
|
||||||
|
config,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
|
write_check_time(make_check_time_path(config, repository_id, 'spot'))
|
||||||
|
|
||||||
borgmatic.hooks.command.execute_hook(
|
borgmatic.hooks.command.execute_hook(
|
||||||
config.get('after_check'),
|
config.get('after_check'),
|
||||||
config.get('umask'),
|
config.get('umask'),
|
||||||
|
|
|
@ -1,12 +1,26 @@
|
||||||
import json
|
import json
|
||||||
|
import logging
|
||||||
|
|
||||||
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
def parse_json(borg_json_output, label):
|
def parse_json(borg_json_output, label):
|
||||||
'''
|
'''
|
||||||
Given a Borg JSON output string, parse it as JSON into a dict. Inject the given borgmatic
|
Given a Borg JSON output string, parse it as JSON into a dict. Inject the given borgmatic
|
||||||
repository label into it and return the dict.
|
repository label into it and return the dict.
|
||||||
|
|
||||||
|
Raise JSONDecodeError if the JSON output cannot be parsed.
|
||||||
'''
|
'''
|
||||||
json_data = json.loads(borg_json_output)
|
lines = borg_json_output.splitlines()
|
||||||
|
start_line_index = 0
|
||||||
|
|
||||||
|
# Scan forward to find the first line starting with "{" and assume that's where the JSON starts.
|
||||||
|
for line_index, line in enumerate(lines):
|
||||||
|
if line.startswith('{'):
|
||||||
|
start_line_index = line_index
|
||||||
|
break
|
||||||
|
|
||||||
|
json_data = json.loads('\n'.join(lines[start_line_index:]))
|
||||||
|
|
||||||
if 'repository' not in json_data:
|
if 'repository' not in json_data:
|
||||||
return json_data
|
return json_data
|
||||||
|
|
|
@ -1,172 +1,26 @@
|
||||||
import argparse
|
import argparse
|
||||||
import datetime
|
|
||||||
import hashlib
|
|
||||||
import itertools
|
|
||||||
import json
|
import json
|
||||||
import logging
|
import logging
|
||||||
import os
|
|
||||||
import pathlib
|
|
||||||
|
|
||||||
from borgmatic.borg import environment, extract, feature, flags, rinfo, state
|
from borgmatic.borg import environment, feature, flags, rinfo
|
||||||
from borgmatic.execute import DO_NOT_CAPTURE, execute_command
|
from borgmatic.execute import DO_NOT_CAPTURE, execute_command
|
||||||
|
|
||||||
DEFAULT_CHECKS = (
|
|
||||||
{'name': 'repository', 'frequency': '1 month'},
|
|
||||||
{'name': 'archives', 'frequency': '1 month'},
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
def parse_checks(config, only_checks=None):
|
def make_archive_filter_flags(local_borg_version, config, checks, check_arguments):
|
||||||
'''
|
'''
|
||||||
Given a configuration dict with a "checks" sequence of dicts and an optional list of override
|
Given the local Borg version, a configuration dict, a parsed sequence of checks, and check
|
||||||
checks, return a tuple of named checks to run.
|
arguments as an argparse.Namespace instance, transform the checks into tuple of command-line
|
||||||
|
flags for filtering archives in a check command.
|
||||||
|
|
||||||
For example, given a config of:
|
If "check_last" is set in the configuration and "archives" is in checks, then include a "--last"
|
||||||
|
flag. And if "prefix" is set in configuration and "archives" is in checks, then include a
|
||||||
{'checks': ({'name': 'repository'}, {'name': 'archives'})}
|
"--match-archives" flag.
|
||||||
|
|
||||||
This will be returned as:
|
|
||||||
|
|
||||||
('repository', 'archives')
|
|
||||||
|
|
||||||
If no "checks" option is present in the config, return the DEFAULT_CHECKS. If a checks value
|
|
||||||
has a name of "disabled", return an empty tuple, meaning that no checks should be run.
|
|
||||||
'''
|
'''
|
||||||
checks = only_checks or tuple(
|
check_last = config.get('check_last', None)
|
||||||
check_config['name'] for check_config in (config.get('checks', None) or DEFAULT_CHECKS)
|
prefix = config.get('prefix')
|
||||||
)
|
|
||||||
checks = tuple(check.lower() for check in checks)
|
|
||||||
|
|
||||||
if 'disabled' in checks:
|
|
||||||
logger.warning(
|
|
||||||
'The "disabled" value for the "checks" option is deprecated and will be removed from a future release; use "skip_actions" instead'
|
|
||||||
)
|
|
||||||
if len(checks) > 1:
|
|
||||||
logger.warning(
|
|
||||||
'Multiple checks are configured, but one of them is "disabled"; not running any checks'
|
|
||||||
)
|
|
||||||
return ()
|
|
||||||
|
|
||||||
return checks
|
|
||||||
|
|
||||||
|
|
||||||
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(
|
|
||||||
config,
|
|
||||||
borg_repository_id,
|
|
||||||
checks,
|
|
||||||
force,
|
|
||||||
archives_check_id=None,
|
|
||||||
):
|
|
||||||
'''
|
|
||||||
Given a configuration dict with a "checks" sequence of dicts, a Borg repository ID, a sequence
|
|
||||||
of checks, whether to force checks to run, and an ID for the archives check potentially being
|
|
||||||
run (if any), 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:
|
|
||||||
|
|
||||||
config = {
|
|
||||||
'checks': [
|
|
||||||
{
|
|
||||||
'name': 'archives',
|
|
||||||
'frequency': '2 weeks',
|
|
||||||
},
|
|
||||||
]
|
|
||||||
}
|
|
||||||
|
|
||||||
When this function is called with that 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.
|
|
||||||
'''
|
|
||||||
if not checks:
|
|
||||||
return checks
|
|
||||||
|
|
||||||
filtered_checks = list(checks)
|
|
||||||
|
|
||||||
if force:
|
|
||||||
return tuple(filtered_checks)
|
|
||||||
|
|
||||||
for check_config in 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 = probe_for_check_time(config, borg_repository_id, check, archives_check_id)
|
|
||||||
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 (use --force to check anyway)'
|
|
||||||
)
|
|
||||||
filtered_checks.remove(check)
|
|
||||||
|
|
||||||
return tuple(filtered_checks)
|
|
||||||
|
|
||||||
|
|
||||||
def make_archive_filter_flags(
|
|
||||||
local_borg_version, config, checks, check_arguments, check_last=None, prefix=None
|
|
||||||
):
|
|
||||||
'''
|
|
||||||
Given the local Borg version, a configuration dict, a parsed sequence of checks, check arguments
|
|
||||||
as an argparse.Namespace instance, the check last value, and a consistency check prefix,
|
|
||||||
transform the checks into tuple of command-line flags for filtering archives in a check command.
|
|
||||||
|
|
||||||
If a check_last value is given and "archives" is in checks, then include a "--last" flag. And if
|
|
||||||
a prefix value is given and "archives" is in checks, then include a "--match-archives" flag.
|
|
||||||
'''
|
|
||||||
if 'archives' in checks or 'data' in checks:
|
if 'archives' in checks or 'data' in checks:
|
||||||
return (('--last', str(check_last)) if check_last else ()) + (
|
return (('--last', str(check_last)) if check_last else ()) + (
|
||||||
(
|
(
|
||||||
|
@ -196,21 +50,10 @@ def make_archive_filter_flags(
|
||||||
return ()
|
return ()
|
||||||
|
|
||||||
|
|
||||||
def make_archives_check_id(archive_filter_flags):
|
|
||||||
'''
|
|
||||||
Given a sequence of flags to filter archives, return a unique hash corresponding to those
|
|
||||||
particular flags. If there are no flags, return None.
|
|
||||||
'''
|
|
||||||
if not archive_filter_flags:
|
|
||||||
return None
|
|
||||||
|
|
||||||
return hashlib.sha256(' '.join(archive_filter_flags).encode()).hexdigest()
|
|
||||||
|
|
||||||
|
|
||||||
def make_check_flags(checks, archive_filter_flags):
|
def make_check_flags(checks, archive_filter_flags):
|
||||||
'''
|
'''
|
||||||
Given a parsed sequence of checks and a sequence of flags to filter archives, transform the
|
Given a parsed checks set and a sequence of flags to filter archives,
|
||||||
checks into tuple of command-line check flags.
|
transform the checks into tuple of command-line check flags.
|
||||||
|
|
||||||
For example, given parsed checks of:
|
For example, given parsed checks of:
|
||||||
|
|
||||||
|
@ -225,13 +68,13 @@ def make_check_flags(checks, archive_filter_flags):
|
||||||
'''
|
'''
|
||||||
if 'data' in checks:
|
if 'data' in checks:
|
||||||
data_flags = ('--verify-data',)
|
data_flags = ('--verify-data',)
|
||||||
checks += ('archives',)
|
checks.update({'archives'})
|
||||||
else:
|
else:
|
||||||
data_flags = ()
|
data_flags = ()
|
||||||
|
|
||||||
common_flags = (archive_filter_flags if 'archives' in checks else ()) + data_flags
|
common_flags = (archive_filter_flags if 'archives' in checks else ()) + data_flags
|
||||||
|
|
||||||
if {'repository', 'archives'}.issubset(set(checks)):
|
if {'repository', 'archives'}.issubset(checks):
|
||||||
return common_flags
|
return common_flags
|
||||||
|
|
||||||
return (
|
return (
|
||||||
|
@ -240,144 +83,17 @@ def make_check_flags(checks, archive_filter_flags):
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def make_check_time_path(config, borg_repository_id, check_type, archives_check_id=None):
|
def get_repository_id(
|
||||||
'''
|
repository_path, config, local_borg_version, global_arguments, local_path, remote_path
|
||||||
Given a configuration dict, a Borg repository ID, the name of a check type ("repository",
|
|
||||||
"archives", etc.), and a unique hash of the archives filter flags, return a path for recording
|
|
||||||
that check's time (the time of that check last occurring).
|
|
||||||
'''
|
|
||||||
borgmatic_source_directory = os.path.expanduser(
|
|
||||||
config.get('borgmatic_source_directory', state.DEFAULT_BORGMATIC_SOURCE_DIRECTORY)
|
|
||||||
)
|
|
||||||
|
|
||||||
if check_type in ('archives', 'data'):
|
|
||||||
return os.path.join(
|
|
||||||
borgmatic_source_directory,
|
|
||||||
'checks',
|
|
||||||
borg_repository_id,
|
|
||||||
check_type,
|
|
||||||
archives_check_id if archives_check_id else 'all',
|
|
||||||
)
|
|
||||||
|
|
||||||
return os.path.join(
|
|
||||||
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 probe_for_check_time(config, borg_repository_id, check, archives_check_id):
|
|
||||||
'''
|
|
||||||
Given a configuration dict, a Borg repository ID, the name of a check type ("repository",
|
|
||||||
"archives", etc.), and a unique hash of the archives filter flags, return a the corresponding
|
|
||||||
check time or None if such a check time does not exist.
|
|
||||||
|
|
||||||
When the check type is "archives" or "data", this function probes two different paths to find
|
|
||||||
the check time, e.g.:
|
|
||||||
|
|
||||||
~/.borgmatic/checks/1234567890/archives/9876543210
|
|
||||||
~/.borgmatic/checks/1234567890/archives/all
|
|
||||||
|
|
||||||
... and returns the maximum modification time of the files found (if any). The first path
|
|
||||||
represents a more specific archives check time (a check on a subset of archives), and the second
|
|
||||||
is a fallback to the last "all" archives check.
|
|
||||||
|
|
||||||
For other check types, this function reads from a single check time path, e.g.:
|
|
||||||
|
|
||||||
~/.borgmatic/checks/1234567890/repository
|
|
||||||
'''
|
|
||||||
check_times = (
|
|
||||||
read_check_time(group[0])
|
|
||||||
for group in itertools.groupby(
|
|
||||||
(
|
|
||||||
make_check_time_path(config, borg_repository_id, check, archives_check_id),
|
|
||||||
make_check_time_path(config, borg_repository_id, check),
|
|
||||||
)
|
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
try:
|
|
||||||
return max(check_time for check_time in check_times if check_time)
|
|
||||||
except ValueError:
|
|
||||||
return None
|
|
||||||
|
|
||||||
|
|
||||||
def upgrade_check_times(config, borg_repository_id):
|
|
||||||
'''
|
|
||||||
Given a configuration dict and a Borg repository ID, upgrade any corresponding check times on
|
|
||||||
disk from old-style paths to new-style paths.
|
|
||||||
|
|
||||||
Currently, the only upgrade performed is renaming an archive or data check path that looks like:
|
|
||||||
|
|
||||||
~/.borgmatic/checks/1234567890/archives
|
|
||||||
|
|
||||||
to:
|
|
||||||
|
|
||||||
~/.borgmatic/checks/1234567890/archives/all
|
|
||||||
'''
|
|
||||||
for check_type in ('archives', 'data'):
|
|
||||||
new_path = make_check_time_path(config, borg_repository_id, check_type, 'all')
|
|
||||||
old_path = os.path.dirname(new_path)
|
|
||||||
temporary_path = f'{old_path}.temp'
|
|
||||||
|
|
||||||
if not os.path.isfile(old_path) and not os.path.isfile(temporary_path):
|
|
||||||
continue
|
|
||||||
|
|
||||||
logger.debug(f'Upgrading archives check time from {old_path} to {new_path}')
|
|
||||||
|
|
||||||
try:
|
|
||||||
os.rename(old_path, temporary_path)
|
|
||||||
except FileNotFoundError:
|
|
||||||
pass
|
|
||||||
|
|
||||||
os.mkdir(old_path)
|
|
||||||
os.rename(temporary_path, new_path)
|
|
||||||
|
|
||||||
|
|
||||||
def check_archives(
|
|
||||||
repository_path,
|
|
||||||
config,
|
|
||||||
local_borg_version,
|
|
||||||
check_arguments,
|
|
||||||
global_arguments,
|
|
||||||
local_path='borg',
|
|
||||||
remote_path=None,
|
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Given a local or remote repository path, a configuration dict, the local Borg version, check
|
Given a local or remote repository path, a configuration dict, the local Borg version, global
|
||||||
arguments as an argparse.Namespace instance, global arguments, and local/remote commands to run,
|
arguments, and local/remote commands to run, return the corresponding Borg repository ID.
|
||||||
check the contained Borg archives for consistency.
|
|
||||||
|
|
||||||
If there are no consistency checks to run, skip running them.
|
Raise ValueError if the Borg repository ID cannot be determined.
|
||||||
|
|
||||||
Raises ValueError if the Borg repository ID cannot be determined.
|
|
||||||
'''
|
'''
|
||||||
try:
|
try:
|
||||||
borg_repository_id = json.loads(
|
return json.loads(
|
||||||
rinfo.display_repository_info(
|
rinfo.display_repository_info(
|
||||||
repository_path,
|
repository_path,
|
||||||
config,
|
config,
|
||||||
|
@ -391,82 +107,63 @@ def check_archives(
|
||||||
except (json.JSONDecodeError, KeyError):
|
except (json.JSONDecodeError, KeyError):
|
||||||
raise ValueError(f'Cannot determine Borg repository ID for {repository_path}')
|
raise ValueError(f'Cannot determine Borg repository ID for {repository_path}')
|
||||||
|
|
||||||
upgrade_check_times(config, borg_repository_id)
|
|
||||||
|
|
||||||
check_last = config.get('check_last', None)
|
def check_archives(
|
||||||
prefix = config.get('prefix')
|
repository_path,
|
||||||
configured_checks = parse_checks(config, check_arguments.only_checks)
|
config,
|
||||||
lock_wait = None
|
local_borg_version,
|
||||||
|
check_arguments,
|
||||||
|
global_arguments,
|
||||||
|
checks,
|
||||||
|
archive_filter_flags,
|
||||||
|
local_path='borg',
|
||||||
|
remote_path=None,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Given a local or remote repository path, a configuration dict, the local Borg version, check
|
||||||
|
arguments as an argparse.Namespace instance, global arguments, a set of named Borg checks to run
|
||||||
|
(some combination "repository", "archives", and/or "data"), archive filter flags, and
|
||||||
|
local/remote commands to run, check the contained Borg archives for consistency.
|
||||||
|
'''
|
||||||
|
lock_wait = config.get('lock_wait')
|
||||||
extra_borg_options = config.get('extra_borg_options', {}).get('check', '')
|
extra_borg_options = config.get('extra_borg_options', {}).get('check', '')
|
||||||
archive_filter_flags = make_archive_filter_flags(
|
|
||||||
local_borg_version, config, configured_checks, check_arguments, check_last, prefix
|
|
||||||
)
|
|
||||||
archives_check_id = make_archives_check_id(archive_filter_flags)
|
|
||||||
|
|
||||||
checks = filter_checks_on_frequency(
|
verbosity_flags = ()
|
||||||
config,
|
if logger.isEnabledFor(logging.INFO):
|
||||||
borg_repository_id,
|
verbosity_flags = ('--info',)
|
||||||
configured_checks,
|
if logger.isEnabledFor(logging.DEBUG):
|
||||||
check_arguments.force,
|
verbosity_flags = ('--debug', '--show-rc')
|
||||||
archives_check_id,
|
|
||||||
|
full_command = (
|
||||||
|
(local_path, 'check')
|
||||||
|
+ (('--repair',) if check_arguments.repair else ())
|
||||||
|
+ make_check_flags(checks, archive_filter_flags)
|
||||||
|
+ (('--remote-path', remote_path) if remote_path else ())
|
||||||
|
+ (('--log-json',) if global_arguments.log_json else ())
|
||||||
|
+ (('--lock-wait', str(lock_wait)) if lock_wait else ())
|
||||||
|
+ verbosity_flags
|
||||||
|
+ (('--progress',) if check_arguments.progress else ())
|
||||||
|
+ (tuple(extra_borg_options.split(' ')) if extra_borg_options else ())
|
||||||
|
+ flags.make_repository_flags(repository_path, local_borg_version)
|
||||||
)
|
)
|
||||||
|
|
||||||
if set(checks).intersection({'repository', 'archives', 'data'}):
|
borg_environment = environment.make_environment(config)
|
||||||
lock_wait = config.get('lock_wait')
|
borg_exit_codes = config.get('borg_exit_codes')
|
||||||
|
|
||||||
verbosity_flags = ()
|
# The Borg repair option triggers an interactive prompt, which won't work when output is
|
||||||
if logger.isEnabledFor(logging.INFO):
|
# captured. And progress messes with the terminal directly.
|
||||||
verbosity_flags = ('--info',)
|
if check_arguments.repair or check_arguments.progress:
|
||||||
if logger.isEnabledFor(logging.DEBUG):
|
execute_command(
|
||||||
verbosity_flags = ('--debug', '--show-rc')
|
full_command,
|
||||||
|
output_file=DO_NOT_CAPTURE,
|
||||||
full_command = (
|
extra_environment=borg_environment,
|
||||||
(local_path, 'check')
|
borg_local_path=local_path,
|
||||||
+ (('--repair',) if check_arguments.repair else ())
|
borg_exit_codes=borg_exit_codes,
|
||||||
+ make_check_flags(checks, archive_filter_flags)
|
|
||||||
+ (('--remote-path', remote_path) if remote_path else ())
|
|
||||||
+ (('--log-json',) if global_arguments.log_json else ())
|
|
||||||
+ (('--lock-wait', str(lock_wait)) if lock_wait else ())
|
|
||||||
+ verbosity_flags
|
|
||||||
+ (('--progress',) if check_arguments.progress else ())
|
|
||||||
+ (tuple(extra_borg_options.split(' ')) if extra_borg_options else ())
|
|
||||||
+ flags.make_repository_flags(repository_path, local_borg_version)
|
|
||||||
)
|
)
|
||||||
|
else:
|
||||||
borg_environment = environment.make_environment(config)
|
execute_command(
|
||||||
borg_exit_codes = config.get('borg_exit_codes')
|
full_command,
|
||||||
|
extra_environment=borg_environment,
|
||||||
# The Borg repair option triggers an interactive prompt, which won't work when output is
|
borg_local_path=local_path,
|
||||||
# captured. And progress messes with the terminal directly.
|
borg_exit_codes=borg_exit_codes,
|
||||||
if check_arguments.repair or check_arguments.progress:
|
|
||||||
execute_command(
|
|
||||||
full_command,
|
|
||||||
output_file=DO_NOT_CAPTURE,
|
|
||||||
extra_environment=borg_environment,
|
|
||||||
borg_local_path=local_path,
|
|
||||||
borg_exit_codes=borg_exit_codes,
|
|
||||||
)
|
|
||||||
else:
|
|
||||||
execute_command(
|
|
||||||
full_command,
|
|
||||||
extra_environment=borg_environment,
|
|
||||||
borg_local_path=local_path,
|
|
||||||
borg_exit_codes=borg_exit_codes,
|
|
||||||
)
|
|
||||||
|
|
||||||
for check in checks:
|
|
||||||
write_check_time(
|
|
||||||
make_check_time_path(config, borg_repository_id, check, archives_check_id)
|
|
||||||
)
|
|
||||||
|
|
||||||
if 'extract' in checks:
|
|
||||||
extract.extract_last_archive_dry_run(
|
|
||||||
config,
|
|
||||||
local_borg_version,
|
|
||||||
global_arguments,
|
|
||||||
repository_path,
|
|
||||||
lock_wait,
|
|
||||||
local_path,
|
|
||||||
remote_path,
|
|
||||||
)
|
)
|
||||||
write_check_time(make_check_time_path(config, borg_repository_id, 'extract'))
|
|
||||||
|
|
|
@ -275,11 +275,11 @@ def collect_special_file_paths(
|
||||||
create_command, config, local_path, working_directory, borg_environment, skip_directories
|
create_command, config, local_path, working_directory, borg_environment, skip_directories
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Given a Borg create command as a tuple, a local Borg path, a working directory, a dict of
|
Given a Borg create command as a tuple, a configuration dict, a local Borg path, a working
|
||||||
environment variables to pass to Borg, and a sequence of parent directories to skip, collect the
|
directory, a dict of environment variables to pass to Borg, and a sequence of parent directories
|
||||||
paths for any special files (character devices, block devices, and named pipes / FIFOs) that
|
to skip, collect the paths for any special files (character devices, block devices, and named
|
||||||
Borg would encounter during a create. These are all paths that could cause Borg to hang if its
|
pipes / FIFOs) that Borg would encounter during a create. These are all paths that could cause
|
||||||
--read-special flag is used.
|
Borg to hang if its --read-special flag is used.
|
||||||
'''
|
'''
|
||||||
# Omit "--exclude-nodump" from the Borg dry run command, because that flag causes Borg to open
|
# Omit "--exclude-nodump" from the Borg dry run command, because that flag causes Borg to open
|
||||||
# files including any named pipe we've created.
|
# files including any named pipe we've created.
|
||||||
|
@ -320,35 +320,31 @@ def check_all_source_directories_exist(source_directories):
|
||||||
raise ValueError(f"Source directories do not exist: {', '.join(missing_directories)}")
|
raise ValueError(f"Source directories do not exist: {', '.join(missing_directories)}")
|
||||||
|
|
||||||
|
|
||||||
def create_archive(
|
def make_base_create_command(
|
||||||
dry_run,
|
dry_run,
|
||||||
repository_path,
|
repository_path,
|
||||||
config,
|
config,
|
||||||
config_paths,
|
config_paths,
|
||||||
local_borg_version,
|
local_borg_version,
|
||||||
global_arguments,
|
global_arguments,
|
||||||
|
borgmatic_source_directories,
|
||||||
local_path='borg',
|
local_path='borg',
|
||||||
remote_path=None,
|
remote_path=None,
|
||||||
progress=False,
|
progress=False,
|
||||||
stats=False,
|
|
||||||
json=False,
|
json=False,
|
||||||
list_files=False,
|
list_files=False,
|
||||||
stream_processes=None,
|
stream_processes=None,
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Given vebosity/dry-run flags, a local or remote repository path, a configuration dict, a
|
Given vebosity/dry-run flags, a local or remote repository path, a configuration dict, a
|
||||||
sequence of loaded configuration paths, the local Borg version, and global arguments as an
|
sequence of loaded configuration paths, the local Borg version, global arguments as an
|
||||||
argparse.Namespace instance, create a Borg archive and return Borg's JSON output (if any).
|
argparse.Namespace instance, and a sequence of borgmatic source directories, return a tuple of
|
||||||
|
(base Borg create command flags, Borg create command positional arguments, open pattern file
|
||||||
If a sequence of stream processes is given (instances of subprocess.Popen), then execute the
|
handle, open exclude file handle).
|
||||||
create command while also triggering the given processes to produce output.
|
|
||||||
'''
|
'''
|
||||||
borgmatic.logger.add_custom_log_levels()
|
|
||||||
borgmatic_source_directories = expand_directories(
|
|
||||||
collect_borgmatic_source_directories(config.get('borgmatic_source_directory'))
|
|
||||||
)
|
|
||||||
if config.get('source_directories_must_exist', False):
|
if config.get('source_directories_must_exist', False):
|
||||||
check_all_source_directories_exist(config.get('source_directories'))
|
check_all_source_directories_exist(config.get('source_directories'))
|
||||||
|
|
||||||
sources = deduplicate_directories(
|
sources = deduplicate_directories(
|
||||||
map_directories_to_devices(
|
map_directories_to_devices(
|
||||||
expand_directories(
|
expand_directories(
|
||||||
|
@ -364,11 +360,6 @@ def create_archive(
|
||||||
|
|
||||||
ensure_files_readable(config.get('patterns_from'), config.get('exclude_from'))
|
ensure_files_readable(config.get('patterns_from'), config.get('exclude_from'))
|
||||||
|
|
||||||
try:
|
|
||||||
working_directory = os.path.expanduser(config.get('working_directory'))
|
|
||||||
except TypeError:
|
|
||||||
working_directory = None
|
|
||||||
|
|
||||||
pattern_file = (
|
pattern_file = (
|
||||||
write_pattern_file(config.get('patterns'), sources)
|
write_pattern_file(config.get('patterns'), sources)
|
||||||
if config.get('patterns') or config.get('patterns_from')
|
if config.get('patterns') or config.get('patterns_from')
|
||||||
|
@ -411,11 +402,6 @@ def create_archive(
|
||||||
('--remote-ratelimit', str(upload_rate_limit)) if upload_rate_limit else ()
|
('--remote-ratelimit', str(upload_rate_limit)) if upload_rate_limit else ()
|
||||||
)
|
)
|
||||||
|
|
||||||
if stream_processes and config.get('read_special') is False:
|
|
||||||
logger.warning(
|
|
||||||
f'{repository_path}: Ignoring configured "read_special" value of false, as true is needed for database hooks.'
|
|
||||||
)
|
|
||||||
|
|
||||||
create_flags = (
|
create_flags = (
|
||||||
tuple(local_path.split(' '))
|
tuple(local_path.split(' '))
|
||||||
+ ('create',)
|
+ ('create',)
|
||||||
|
@ -451,22 +437,19 @@ def create_archive(
|
||||||
repository_path, archive_name_format, local_borg_version
|
repository_path, archive_name_format, local_borg_version
|
||||||
) + (sources if not pattern_file else ())
|
) + (sources if not pattern_file else ())
|
||||||
|
|
||||||
if json:
|
|
||||||
output_log_level = None
|
|
||||||
elif list_files or (stats and not dry_run):
|
|
||||||
output_log_level = logging.ANSWER
|
|
||||||
else:
|
|
||||||
output_log_level = logging.INFO
|
|
||||||
|
|
||||||
# The progress output isn't compatible with captured and logged output, as progress messes with
|
|
||||||
# the terminal directly.
|
|
||||||
output_file = DO_NOT_CAPTURE if progress else None
|
|
||||||
|
|
||||||
borg_environment = environment.make_environment(config)
|
|
||||||
|
|
||||||
# If database hooks are enabled (as indicated by streaming processes), exclude files that might
|
# If database hooks are enabled (as indicated by streaming processes), exclude files that might
|
||||||
# cause Borg to hang. But skip this if the user has explicitly set the "read_special" to True.
|
# cause Borg to hang. But skip this if the user has explicitly set the "read_special" to True.
|
||||||
if stream_processes and not config.get('read_special'):
|
if stream_processes and not config.get('read_special'):
|
||||||
|
logger.warning(
|
||||||
|
f'{repository_path}: Ignoring configured "read_special" value of false, as true is needed for database hooks.'
|
||||||
|
)
|
||||||
|
try:
|
||||||
|
working_directory = os.path.expanduser(config.get('working_directory'))
|
||||||
|
except TypeError:
|
||||||
|
working_directory = None
|
||||||
|
|
||||||
|
borg_environment = environment.make_environment(config)
|
||||||
|
|
||||||
logger.debug(f'{repository_path}: Collecting special file paths')
|
logger.debug(f'{repository_path}: Collecting special file paths')
|
||||||
special_file_paths = collect_special_file_paths(
|
special_file_paths = collect_special_file_paths(
|
||||||
create_flags + create_positional_arguments,
|
create_flags + create_positional_arguments,
|
||||||
|
@ -489,6 +472,73 @@ def create_archive(
|
||||||
)
|
)
|
||||||
create_flags += make_exclude_flags(config, exclude_file.name)
|
create_flags += make_exclude_flags(config, exclude_file.name)
|
||||||
|
|
||||||
|
return (create_flags, create_positional_arguments, pattern_file, exclude_file)
|
||||||
|
|
||||||
|
|
||||||
|
def create_archive(
|
||||||
|
dry_run,
|
||||||
|
repository_path,
|
||||||
|
config,
|
||||||
|
config_paths,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
local_path='borg',
|
||||||
|
remote_path=None,
|
||||||
|
progress=False,
|
||||||
|
stats=False,
|
||||||
|
json=False,
|
||||||
|
list_files=False,
|
||||||
|
stream_processes=None,
|
||||||
|
):
|
||||||
|
'''
|
||||||
|
Given vebosity/dry-run flags, a local or remote repository path, a configuration dict, a
|
||||||
|
sequence of loaded configuration paths, the local Borg version, and global arguments as an
|
||||||
|
argparse.Namespace instance, create a Borg archive and return Borg's JSON output (if any).
|
||||||
|
|
||||||
|
If a sequence of stream processes is given (instances of subprocess.Popen), then execute the
|
||||||
|
create command while also triggering the given processes to produce output.
|
||||||
|
'''
|
||||||
|
borgmatic.logger.add_custom_log_levels()
|
||||||
|
borgmatic_source_directories = expand_directories(
|
||||||
|
collect_borgmatic_source_directories(config.get('borgmatic_source_directory'))
|
||||||
|
)
|
||||||
|
|
||||||
|
(create_flags, create_positional_arguments, pattern_file, exclude_file) = (
|
||||||
|
make_base_create_command(
|
||||||
|
dry_run,
|
||||||
|
repository_path,
|
||||||
|
config,
|
||||||
|
config_paths,
|
||||||
|
local_borg_version,
|
||||||
|
global_arguments,
|
||||||
|
borgmatic_source_directories,
|
||||||
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
progress,
|
||||||
|
json,
|
||||||
|
list_files,
|
||||||
|
stream_processes,
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
if json:
|
||||||
|
output_log_level = None
|
||||||
|
elif list_files or (stats and not dry_run):
|
||||||
|
output_log_level = logging.ANSWER
|
||||||
|
else:
|
||||||
|
output_log_level = logging.INFO
|
||||||
|
|
||||||
|
# The progress output isn't compatible with captured and logged output, as progress messes with
|
||||||
|
# the terminal directly.
|
||||||
|
output_file = DO_NOT_CAPTURE if progress else None
|
||||||
|
|
||||||
|
try:
|
||||||
|
working_directory = os.path.expanduser(config.get('working_directory'))
|
||||||
|
except TypeError:
|
||||||
|
working_directory = None
|
||||||
|
|
||||||
|
borg_environment = environment.make_environment(config)
|
||||||
|
|
||||||
create_flags += (
|
create_flags += (
|
||||||
(('--info',) if logger.getEffectiveLevel() == logging.INFO and not json else ())
|
(('--info',) if logger.getEffectiveLevel() == logging.INFO and not json else ())
|
||||||
+ (('--stats',) if stats and not json and not dry_run else ())
|
+ (('--stats',) if stats and not json and not dry_run else ())
|
||||||
|
|
|
@ -104,8 +104,13 @@ def extract_archive(
|
||||||
if not paths:
|
if not paths:
|
||||||
raise ValueError('The --strip-components flag with "all" requires at least one --path')
|
raise ValueError('The --strip-components flag with "all" requires at least one --path')
|
||||||
|
|
||||||
# Calculate the maximum number of leading path components of the given paths.
|
# Calculate the maximum number of leading path components of the given paths. "if piece"
|
||||||
strip_components = max(0, *(len(path.split(os.path.sep)) - 1 for path in paths))
|
# ignores empty path components, e.g. those resulting from a leading slash. And the "- 1"
|
||||||
|
# is so this doesn't count the final path component, e.g. the filename itself.
|
||||||
|
strip_components = max(
|
||||||
|
0,
|
||||||
|
*(len(tuple(piece for piece in path.split(os.path.sep) if piece)) - 1 for path in paths)
|
||||||
|
)
|
||||||
|
|
||||||
full_command = (
|
full_command = (
|
||||||
(local_path, 'extract')
|
(local_path, 'extract')
|
||||||
|
|
|
@ -74,6 +74,9 @@ def make_match_archives_flags(match_archives, archive_name_format, local_borg_ve
|
||||||
(like "{now}") with globs.
|
(like "{now}") with globs.
|
||||||
'''
|
'''
|
||||||
if match_archives:
|
if match_archives:
|
||||||
|
if match_archives in {'*', 're:.*', 'sh:*'}:
|
||||||
|
return ()
|
||||||
|
|
||||||
if feature.available(feature.Feature.MATCH_ARCHIVES, local_borg_version):
|
if feature.available(feature.Feature.MATCH_ARCHIVES, local_borg_version):
|
||||||
return ('--match-archives', match_archives)
|
return ('--match-archives', match_archives)
|
||||||
else:
|
else:
|
||||||
|
|
|
@ -79,9 +79,11 @@ def make_find_paths(find_paths):
|
||||||
return ()
|
return ()
|
||||||
|
|
||||||
return tuple(
|
return tuple(
|
||||||
find_path
|
(
|
||||||
if re.compile(r'([-!+RrPp] )|(\w\w:)').match(find_path)
|
find_path
|
||||||
else f'sh:**/*{find_path}*/**'
|
if re.compile(r'([-!+RrPp] )|(\w\w:)').match(find_path)
|
||||||
|
else f'sh:**/*{find_path}*/**'
|
||||||
|
)
|
||||||
for find_path in find_paths
|
for find_path in find_paths
|
||||||
)
|
)
|
||||||
|
|
||||||
|
@ -93,14 +95,15 @@ def capture_archive_listing(
|
||||||
local_borg_version,
|
local_borg_version,
|
||||||
global_arguments,
|
global_arguments,
|
||||||
list_paths=None,
|
list_paths=None,
|
||||||
|
path_format=None,
|
||||||
local_path='borg',
|
local_path='borg',
|
||||||
remote_path=None,
|
remote_path=None,
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Given a local or remote repository path, an archive name, a configuration dict, the local Borg
|
Given a local or remote repository path, an archive name, a configuration dict, the local Borg
|
||||||
version, global arguments as an argparse.Namespace, the archive paths in which to list files, and
|
version, global arguments as an argparse.Namespace, the archive paths in which to list files,
|
||||||
local and remote Borg paths, capture the output of listing that archive and return it as a list
|
the Borg path format to use for the output, and local and remote Borg paths, capture the output
|
||||||
of file paths.
|
of listing that archive and return it as a list of file paths.
|
||||||
'''
|
'''
|
||||||
borg_environment = environment.make_environment(config)
|
borg_environment = environment.make_environment(config)
|
||||||
|
|
||||||
|
@ -116,7 +119,7 @@ def capture_archive_listing(
|
||||||
paths=[f'sh:{path}' for path in list_paths] if list_paths else None,
|
paths=[f'sh:{path}' for path in list_paths] if list_paths else None,
|
||||||
find_paths=None,
|
find_paths=None,
|
||||||
json=None,
|
json=None,
|
||||||
format='{path}{NL}', # noqa: FS003
|
format=path_format or '{path}{NL}', # noqa: FS003
|
||||||
),
|
),
|
||||||
global_arguments,
|
global_arguments,
|
||||||
local_path,
|
local_path,
|
||||||
|
|
|
@ -1,4 +1,5 @@
|
||||||
import argparse
|
import argparse
|
||||||
|
import json
|
||||||
import logging
|
import logging
|
||||||
import subprocess
|
import subprocess
|
||||||
|
|
||||||
|
@ -8,7 +9,7 @@ from borgmatic.execute import DO_NOT_CAPTURE, execute_command
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
RINFO_REPOSITORY_NOT_FOUND_EXIT_CODE = 2
|
RINFO_REPOSITORY_NOT_FOUND_EXIT_CODES = {2, 13}
|
||||||
|
|
||||||
|
|
||||||
def create_repository(
|
def create_repository(
|
||||||
|
@ -31,21 +32,34 @@ def create_repository(
|
||||||
version, a Borg encryption mode, the path to another repo whose key material should be reused,
|
version, a Borg encryption mode, the path to another repo whose key material should be reused,
|
||||||
whether the repository should be append-only, and the storage quota to use, create the
|
whether the repository should be append-only, and the storage quota to use, create the
|
||||||
repository. If the repository already exists, then log and skip creation.
|
repository. If the repository already exists, then log and skip creation.
|
||||||
|
|
||||||
|
Raise ValueError if the requested encryption mode does not match that of the repository.
|
||||||
|
Raise json.decoder.JSONDecodeError if the "borg info" JSON outputcannot be decoded.
|
||||||
|
Raise subprocess.CalledProcessError if "borg info" returns an error exit code.
|
||||||
'''
|
'''
|
||||||
try:
|
try:
|
||||||
rinfo.display_repository_info(
|
info_data = json.loads(
|
||||||
repository_path,
|
rinfo.display_repository_info(
|
||||||
config,
|
repository_path,
|
||||||
local_borg_version,
|
config,
|
||||||
argparse.Namespace(json=True),
|
local_borg_version,
|
||||||
global_arguments,
|
argparse.Namespace(json=True),
|
||||||
local_path,
|
global_arguments,
|
||||||
remote_path,
|
local_path,
|
||||||
|
remote_path,
|
||||||
|
)
|
||||||
)
|
)
|
||||||
|
repository_encryption_mode = info_data.get('encryption', {}).get('mode')
|
||||||
|
|
||||||
|
if repository_encryption_mode != encryption_mode:
|
||||||
|
raise ValueError(
|
||||||
|
f'Requested encryption mode "{encryption_mode}" does not match existing repository encryption mode "{repository_encryption_mode}"'
|
||||||
|
)
|
||||||
|
|
||||||
logger.info(f'{repository_path}: Repository already exists. Skipping creation.')
|
logger.info(f'{repository_path}: Repository already exists. Skipping creation.')
|
||||||
return
|
return
|
||||||
except subprocess.CalledProcessError as error:
|
except subprocess.CalledProcessError as error:
|
||||||
if error.returncode != RINFO_REPOSITORY_NOT_FOUND_EXIT_CODE:
|
if error.returncode not in RINFO_REPOSITORY_NOT_FOUND_EXIT_CODES:
|
||||||
raise
|
raise
|
||||||
|
|
||||||
lock_wait = config.get('lock_wait')
|
lock_wait = config.get('lock_wait')
|
||||||
|
|
|
@ -614,10 +614,10 @@ def make_parsers():
|
||||||
check_group.add_argument(
|
check_group.add_argument(
|
||||||
'--only',
|
'--only',
|
||||||
metavar='CHECK',
|
metavar='CHECK',
|
||||||
choices=('repository', 'archives', 'data', 'extract'),
|
choices=('repository', 'archives', 'data', 'extract', 'spot'),
|
||||||
dest='only_checks',
|
dest='only_checks',
|
||||||
action='append',
|
action='append',
|
||||||
help='Run a particular consistency check (repository, archives, data, or extract) instead of configured checks (subject to configured frequency, can specify flag multiple times)',
|
help='Run a particular consistency check (repository, archives, data, extract, or spot) instead of configured checks (subject to configured frequency, can specify flag multiple times)',
|
||||||
)
|
)
|
||||||
check_group.add_argument(
|
check_group.add_argument(
|
||||||
'--force',
|
'--force',
|
||||||
|
|
|
@ -169,7 +169,7 @@ def run_configuration(config_filename, config, config_paths, arguments):
|
||||||
continue
|
continue
|
||||||
|
|
||||||
if command.considered_soft_failure(config_filename, error):
|
if command.considered_soft_failure(config_filename, error):
|
||||||
return
|
break
|
||||||
|
|
||||||
yield from log_error_records(
|
yield from log_error_records(
|
||||||
f'{repository.get("label", repository["path"])}: Error running actions for repository',
|
f'{repository.get("label", repository["path"])}: Error running actions for repository',
|
||||||
|
@ -180,7 +180,7 @@ def run_configuration(config_filename, config, config_paths, arguments):
|
||||||
|
|
||||||
try:
|
try:
|
||||||
if monitoring_hooks_are_activated:
|
if monitoring_hooks_are_activated:
|
||||||
# send logs irrespective of error
|
# Send logs irrespective of error.
|
||||||
dispatch.call_hooks(
|
dispatch.call_hooks(
|
||||||
'ping_monitor',
|
'ping_monitor',
|
||||||
config,
|
config,
|
||||||
|
@ -191,11 +191,9 @@ def run_configuration(config_filename, config, config_paths, arguments):
|
||||||
global_arguments.dry_run,
|
global_arguments.dry_run,
|
||||||
)
|
)
|
||||||
except (OSError, CalledProcessError) as error:
|
except (OSError, CalledProcessError) as error:
|
||||||
if command.considered_soft_failure(config_filename, error):
|
if not command.considered_soft_failure(config_filename, error):
|
||||||
return
|
encountered_error = error
|
||||||
|
yield from log_error_records(f'{repository["path"]}: Error pinging monitor', error)
|
||||||
encountered_error = error
|
|
||||||
yield from log_error_records(f'{repository["path"]}: Error pinging monitor', error)
|
|
||||||
|
|
||||||
if not encountered_error:
|
if not encountered_error:
|
||||||
try:
|
try:
|
||||||
|
@ -872,10 +870,8 @@ def main(extra_summary_logs=[]): # pragma: no cover
|
||||||
any_json_flags = any(
|
any_json_flags = any(
|
||||||
getattr(sub_arguments, 'json', False) for sub_arguments in arguments.values()
|
getattr(sub_arguments, 'json', False) for sub_arguments in arguments.values()
|
||||||
)
|
)
|
||||||
colorama.init(
|
color_enabled = should_do_markup(global_arguments.no_color or any_json_flags, configs)
|
||||||
autoreset=True,
|
colorama.init(autoreset=color_enabled, strip=not color_enabled)
|
||||||
strip=not should_do_markup(global_arguments.no_color or any_json_flags, configs),
|
|
||||||
)
|
|
||||||
try:
|
try:
|
||||||
configure_logging(
|
configure_logging(
|
||||||
verbosity_to_log_level(global_arguments.verbosity),
|
verbosity_to_log_level(global_arguments.verbosity),
|
||||||
|
@ -884,6 +880,7 @@ def main(extra_summary_logs=[]): # pragma: no cover
|
||||||
verbosity_to_log_level(global_arguments.monitoring_verbosity),
|
verbosity_to_log_level(global_arguments.monitoring_verbosity),
|
||||||
global_arguments.log_file,
|
global_arguments.log_file,
|
||||||
global_arguments.log_file_format,
|
global_arguments.log_file_format,
|
||||||
|
color_enabled=color_enabled,
|
||||||
)
|
)
|
||||||
except (FileNotFoundError, PermissionError) as error:
|
except (FileNotFoundError, PermissionError) as error:
|
||||||
configure_logging(logging.CRITICAL)
|
configure_logging(logging.CRITICAL)
|
||||||
|
|
|
@ -50,12 +50,15 @@ def apply_constants(value, constants, shell_escape=False):
|
||||||
value[index] = apply_constants(list_value, constants, shell_escape)
|
value[index] = apply_constants(list_value, constants, shell_escape)
|
||||||
elif isinstance(value, dict):
|
elif isinstance(value, dict):
|
||||||
for option_name, option_value in value.items():
|
for option_name, option_value in value.items():
|
||||||
shell_escape = (
|
value[option_name] = apply_constants(
|
||||||
shell_escape
|
option_value,
|
||||||
or option_name.startswith('before_')
|
constants,
|
||||||
or option_name.startswith('after_')
|
shell_escape=(
|
||||||
or option_name == 'on_error'
|
shell_escape
|
||||||
|
or option_name.startswith('before_')
|
||||||
|
or option_name.startswith('after_')
|
||||||
|
or option_name == 'on_error'
|
||||||
|
),
|
||||||
)
|
)
|
||||||
value[option_name] = apply_constants(option_value, constants, shell_escape)
|
|
||||||
|
|
||||||
return value
|
return value
|
||||||
|
|
|
@ -21,6 +21,19 @@ def insert_newline_before_comment(config, field_name):
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def get_properties(schema):
|
||||||
|
'''
|
||||||
|
Given a schema dict, return its properties. But if it's got sub-schemas with multiple different
|
||||||
|
potential properties, returned their merged properties instead.
|
||||||
|
'''
|
||||||
|
if 'oneOf' in schema:
|
||||||
|
return dict(
|
||||||
|
collections.ChainMap(*[sub_schema['properties'] for sub_schema in schema['oneOf']])
|
||||||
|
)
|
||||||
|
|
||||||
|
return schema['properties']
|
||||||
|
|
||||||
|
|
||||||
def schema_to_sample_configuration(schema, level=0, parent_is_sequence=False):
|
def schema_to_sample_configuration(schema, level=0, parent_is_sequence=False):
|
||||||
'''
|
'''
|
||||||
Given a loaded configuration schema, generate and return sample config for it. Include comments
|
Given a loaded configuration schema, generate and return sample config for it. Include comments
|
||||||
|
@ -40,7 +53,7 @@ def schema_to_sample_configuration(schema, level=0, parent_is_sequence=False):
|
||||||
config = ruamel.yaml.comments.CommentedMap(
|
config = ruamel.yaml.comments.CommentedMap(
|
||||||
[
|
[
|
||||||
(field_name, schema_to_sample_configuration(sub_schema, level + 1))
|
(field_name, schema_to_sample_configuration(sub_schema, level + 1))
|
||||||
for field_name, sub_schema in schema['properties'].items()
|
for field_name, sub_schema in get_properties(schema).items()
|
||||||
]
|
]
|
||||||
)
|
)
|
||||||
indent = (level * INDENT) + (SEQUENCE_INDENT if parent_is_sequence else 0)
|
indent = (level * INDENT) + (SEQUENCE_INDENT if parent_is_sequence else 0)
|
||||||
|
@ -151,7 +164,7 @@ def add_comments_to_configuration_sequence(config, schema, indent=0):
|
||||||
return
|
return
|
||||||
|
|
||||||
for field_name in config[0].keys():
|
for field_name in config[0].keys():
|
||||||
field_schema = schema['items']['properties'].get(field_name, {})
|
field_schema = get_properties(schema['items']).get(field_name, {})
|
||||||
description = field_schema.get('description')
|
description = field_schema.get('description')
|
||||||
|
|
||||||
# No description to use? Skip it.
|
# No description to use? Skip it.
|
||||||
|
@ -178,7 +191,7 @@ def add_comments_to_configuration_object(config, schema, indent=0, skip_first=Fa
|
||||||
if skip_first and index == 0:
|
if skip_first and index == 0:
|
||||||
continue
|
continue
|
||||||
|
|
||||||
field_schema = schema['properties'].get(field_name, {})
|
field_schema = get_properties(schema).get(field_name, {})
|
||||||
description = field_schema.get('description', '').strip()
|
description = field_schema.get('description', '').strip()
|
||||||
|
|
||||||
# If this is an optional key, add an indicator to the comment flagging it to be commented
|
# If this is an optional key, add an indicator to the comment flagging it to be commented
|
||||||
|
|
|
@ -103,7 +103,7 @@ def parse_overrides(raw_overrides, schema):
|
||||||
for raw_override in raw_overrides:
|
for raw_override in raw_overrides:
|
||||||
try:
|
try:
|
||||||
raw_keys, value = raw_override.split('=', 1)
|
raw_keys, value = raw_override.split('=', 1)
|
||||||
keys = strip_section_names(tuple(raw_keys.split('.')))
|
keys = tuple(raw_keys.split('.'))
|
||||||
option_type = type_for_option(schema, keys)
|
option_type = type_for_option(schema, keys)
|
||||||
|
|
||||||
parsed_overrides.append(
|
parsed_overrides.append(
|
||||||
|
@ -127,8 +127,13 @@ def apply_overrides(config, schema, raw_overrides):
|
||||||
Given a configuration dict, a corresponding configuration schema dict, and a sequence of
|
Given a configuration dict, a corresponding configuration schema dict, and a sequence of
|
||||||
configuration file override strings in the form of "option.suboption=value", parse each override
|
configuration file override strings in the form of "option.suboption=value", parse each override
|
||||||
and set it into the configuration dict.
|
and set it into the configuration dict.
|
||||||
|
|
||||||
|
Set the overrides into the configuration both with and without deprecated section names (if
|
||||||
|
used), so that the overrides work regardless of whether the configuration is also using
|
||||||
|
deprecated section names.
|
||||||
'''
|
'''
|
||||||
overrides = parse_overrides(raw_overrides, schema)
|
overrides = parse_overrides(raw_overrides, schema)
|
||||||
|
|
||||||
for keys, value in overrides:
|
for keys, value in overrides:
|
||||||
set_values(config, keys, value)
|
set_values(config, keys, value)
|
||||||
|
set_values(config, strip_section_names(keys), value)
|
||||||
|
|
|
@ -269,7 +269,8 @@ properties:
|
||||||
compression:
|
compression:
|
||||||
type: string
|
type: string
|
||||||
description: |
|
description: |
|
||||||
Type of compression to use when creating archives. See
|
Type of compression to use when creating archives. (Compression
|
||||||
|
level can be added separated with a comma, like "zstd,7".) See
|
||||||
http://borgbackup.readthedocs.io/en/stable/usage/create.html for
|
http://borgbackup.readthedocs.io/en/stable/usage/create.html for
|
||||||
details. Defaults to "lz4".
|
details. Defaults to "lz4".
|
||||||
example: lz4
|
example: lz4
|
||||||
|
@ -503,37 +504,120 @@ properties:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
type: object
|
type: object
|
||||||
required: ['name']
|
oneOf:
|
||||||
additionalProperties: false
|
- required: [name]
|
||||||
properties:
|
additionalProperties: false
|
||||||
name:
|
properties:
|
||||||
type: string
|
name:
|
||||||
enum:
|
type: string
|
||||||
- repository
|
enum:
|
||||||
- archives
|
- repository
|
||||||
- data
|
- archives
|
||||||
- extract
|
- data
|
||||||
- disabled
|
- extract
|
||||||
description: |
|
- disabled
|
||||||
Name of consistency check to run: "repository",
|
description: |
|
||||||
"archives", "data", and/or "extract". "repository"
|
Name of consistency check to run: "repository",
|
||||||
checks the consistency of the repository, "archives"
|
"archives", "data", "spot", and/or "extract".
|
||||||
checks all of the archives, "data" verifies the
|
"repository" checks the consistency of the
|
||||||
integrity of the data within the archives, and "extract"
|
repository, "archives" checks all of the
|
||||||
does an extraction dry-run of the most recent archive.
|
archives, "data" verifies the integrity of the
|
||||||
Note that "data" implies "archives". See "skip_actions"
|
data within the archives, "spot" checks that
|
||||||
for disabling checks altogether.
|
some percentage of source files are found in the
|
||||||
example: repository
|
most recent archive (with identical contents),
|
||||||
frequency:
|
and "extract" does an extraction dry-run of the
|
||||||
type: string
|
most recent archive. Note that "data" implies
|
||||||
description: |
|
"archives". See "skip_actions" for disabling
|
||||||
How frequently to run this type of consistency check (as
|
checks altogether.
|
||||||
a best effort). The value is a number followed by a unit
|
example: spot
|
||||||
of time. E.g., "2 weeks" to run this consistency check
|
frequency:
|
||||||
no more than every two weeks for a given repository or
|
type: string
|
||||||
"1 month" to run it no more than monthly. Defaults to
|
description: |
|
||||||
"always": running this check every time checks are run.
|
How frequently to run this type of consistency
|
||||||
example: 2 weeks
|
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
|
||||||
|
- required:
|
||||||
|
- name
|
||||||
|
- count_tolerance_percentage
|
||||||
|
- data_sample_percentage
|
||||||
|
- data_tolerance_percentage
|
||||||
|
additionalProperties: false
|
||||||
|
properties:
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
enum:
|
||||||
|
- spot
|
||||||
|
description: |
|
||||||
|
Name of consistency check to run: "repository",
|
||||||
|
"archives", "data", "spot", and/or "extract".
|
||||||
|
"repository" checks the consistency of the
|
||||||
|
repository, "archives" checks all of the
|
||||||
|
archives, "data" verifies the integrity of the
|
||||||
|
data within the archives, "spot" checks that
|
||||||
|
some percentage of source files are found in the
|
||||||
|
most recent archive (with identical contents),
|
||||||
|
and "extract" does an extraction dry-run of the
|
||||||
|
most recent archive. Note that "data" implies
|
||||||
|
"archives". See "skip_actions" for disabling
|
||||||
|
checks altogether.
|
||||||
|
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
|
||||||
|
count_tolerance_percentage:
|
||||||
|
type: number
|
||||||
|
description: |
|
||||||
|
The percentage delta between the source
|
||||||
|
directories file count and the most recent backup
|
||||||
|
archive file count that is allowed before the
|
||||||
|
entire consistency check fails. This can catch
|
||||||
|
problems like incorrect excludes, inadvertent
|
||||||
|
deletes, etc. Only applies to the "spot" check.
|
||||||
|
example: 10
|
||||||
|
data_sample_percentage:
|
||||||
|
type: number
|
||||||
|
description: |
|
||||||
|
The percentage of total files in the source
|
||||||
|
directories to randomly sample and compare to
|
||||||
|
their corresponding files in the most recent
|
||||||
|
backup archive. Only applies to the "spot" check.
|
||||||
|
example: 1
|
||||||
|
data_tolerance_percentage:
|
||||||
|
type: number
|
||||||
|
description: |
|
||||||
|
The percentage of total files in the source
|
||||||
|
directories that can fail a spot check comparison
|
||||||
|
without failing the entire consistency check. This
|
||||||
|
can catch problems like source files that have
|
||||||
|
been bulk-changed by malware, backups that have
|
||||||
|
been tampered with, etc. The value must be lower
|
||||||
|
than or equal to the "contents_sample_percentage".
|
||||||
|
Only applies to the "spot" check.
|
||||||
|
example: 0.5
|
||||||
|
xxh64sum_command:
|
||||||
|
type: string
|
||||||
|
description: |
|
||||||
|
Command to use instead of "xxh64sum" to hash
|
||||||
|
source files, usually found in an OS package named
|
||||||
|
"xxhash". Do not substitute with a different hash
|
||||||
|
type (SHA, MD5, etc.) or the check will never
|
||||||
|
succeed. Only applies to the "spot" check.
|
||||||
|
example: /usr/local/bin/xxh64sum
|
||||||
description: |
|
description: |
|
||||||
List of one or more consistency checks to run on a periodic basis
|
List of one or more consistency checks to run on a periodic basis
|
||||||
(if "frequency" is set) or every time borgmatic runs checks (if
|
(if "frequency" is set) or every time borgmatic runs checks (if
|
||||||
|
@ -971,6 +1055,20 @@ properties:
|
||||||
a password will only work if MariaDB is configured to
|
a password will only work if MariaDB is configured to
|
||||||
trust the configured username without a password.
|
trust the configured username without a password.
|
||||||
example: trustsome1
|
example: trustsome1
|
||||||
|
mariadb_dump_command:
|
||||||
|
type: string
|
||||||
|
description: |
|
||||||
|
Command to use instead of "mariadb-dump". This can be
|
||||||
|
used to run a specific mariadb_dump version (e.g., one
|
||||||
|
inside a running container). Defaults to "mariadb-dump".
|
||||||
|
example: docker exec mariadb_container mariadb-dump
|
||||||
|
mariadb_command:
|
||||||
|
type: string
|
||||||
|
description: |
|
||||||
|
Command to run instead of "mariadb". This can be used to
|
||||||
|
run a specific mariadb version (e.g., one inside a
|
||||||
|
running container). Defaults to "mariadb".
|
||||||
|
example: docker exec mariadb_container mariadb
|
||||||
restore_password:
|
restore_password:
|
||||||
type: string
|
type: string
|
||||||
description: |
|
description: |
|
||||||
|
@ -1087,6 +1185,20 @@ properties:
|
||||||
Password with which to connect to the restore database.
|
Password with which to connect to the restore database.
|
||||||
Defaults to the "password" option.
|
Defaults to the "password" option.
|
||||||
example: trustsome1
|
example: trustsome1
|
||||||
|
mysql_dump_command:
|
||||||
|
type: string
|
||||||
|
description: |
|
||||||
|
Command to use instead of "mysqldump". This can be used
|
||||||
|
to run a specific mysql_dump version (e.g., one inside a
|
||||||
|
running container). Defaults to "mysqldump".
|
||||||
|
example: docker exec mysql_container mysqldump
|
||||||
|
mysql_command:
|
||||||
|
type: string
|
||||||
|
description: |
|
||||||
|
Command to run instead of "mysql". This can be used to
|
||||||
|
run a specific mysql version (e.g., one inside a running
|
||||||
|
container). Defaults to "mysql".
|
||||||
|
example: docker exec mysql_container mysql
|
||||||
format:
|
format:
|
||||||
type: string
|
type: string
|
||||||
enum: ['sql']
|
enum: ['sql']
|
||||||
|
@ -1290,6 +1402,12 @@ properties:
|
||||||
description: |
|
description: |
|
||||||
The password used for authentication.
|
The password used for authentication.
|
||||||
example: fakepassword
|
example: fakepassword
|
||||||
|
access_token:
|
||||||
|
type: string
|
||||||
|
description: |
|
||||||
|
An ntfy access token to authenticate with instead of
|
||||||
|
username/password.
|
||||||
|
example: tk_AgQdq7mVBoFD37zQVN29RhuMzNIz2
|
||||||
start:
|
start:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
@ -1404,6 +1522,19 @@ properties:
|
||||||
label: kodi
|
label: kodi
|
||||||
- url: "line://Token@User"
|
- url: "line://Token@User"
|
||||||
label: line
|
label: line
|
||||||
|
send_logs:
|
||||||
|
type: boolean
|
||||||
|
description: |
|
||||||
|
Send borgmatic logs to Apprise services as part the
|
||||||
|
"finish", "fail", and "log" states. Defaults to true.
|
||||||
|
example: false
|
||||||
|
logs_size_limit:
|
||||||
|
type: integer
|
||||||
|
description: |
|
||||||
|
Number of bytes of borgmatic logs to send to Apprise
|
||||||
|
services. Set to 0 to send all logs and disable this
|
||||||
|
truncation. Defaults to 1500.
|
||||||
|
example: 100000
|
||||||
start:
|
start:
|
||||||
type: object
|
type: object
|
||||||
required: ['body']
|
required: ['body']
|
||||||
|
@ -1449,6 +1580,21 @@ properties:
|
||||||
description: |
|
description: |
|
||||||
Specify the message body.
|
Specify the message body.
|
||||||
example: Your backups have failed.
|
example: Your backups have failed.
|
||||||
|
log:
|
||||||
|
type: object
|
||||||
|
required: ['body']
|
||||||
|
properties:
|
||||||
|
title:
|
||||||
|
type: string
|
||||||
|
description: |
|
||||||
|
Specify the message title. If left unspecified, no
|
||||||
|
title is sent.
|
||||||
|
example: Ping!
|
||||||
|
body:
|
||||||
|
type: string
|
||||||
|
description: |
|
||||||
|
Specify the message body.
|
||||||
|
example: Here is some info about your backups.
|
||||||
states:
|
states:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
|
@ -1457,13 +1603,15 @@ properties:
|
||||||
- start
|
- start
|
||||||
- finish
|
- finish
|
||||||
- fail
|
- fail
|
||||||
|
- log
|
||||||
uniqueItems: true
|
uniqueItems: true
|
||||||
description: |
|
description: |
|
||||||
List of one or more monitoring states to ping for: "start",
|
List of one or more monitoring states to ping for:
|
||||||
"finish", and/or "fail". Defaults to pinging for failure
|
"start", "finish", "fail", and/or "log". Defaults to
|
||||||
only. For each selected state, corresponding configuration
|
pinging for failure only. For each selected state,
|
||||||
for the message title and body should be given. If any is
|
corresponding configuration for the message title and body
|
||||||
left unspecified, a generic message is emitted instead.
|
should be given. If any is left unspecified, a generic
|
||||||
|
message is emitted instead.
|
||||||
example:
|
example:
|
||||||
- start
|
- start
|
||||||
- finish
|
- finish
|
||||||
|
@ -1515,6 +1663,14 @@ properties:
|
||||||
states.
|
states.
|
||||||
example:
|
example:
|
||||||
- finish
|
- finish
|
||||||
|
create_slug:
|
||||||
|
type: boolean
|
||||||
|
description: |
|
||||||
|
Create the check if it does not exist. Only works with
|
||||||
|
the slug URL scheme (https://hc-ping.com/<ping-key>/<slug>
|
||||||
|
as opposed to https://hc-ping.com/<uuid>).
|
||||||
|
Defaults to false.
|
||||||
|
example: true
|
||||||
description: |
|
description: |
|
||||||
Configuration for a monitoring integration with Healthchecks. Create
|
Configuration for a monitoring integration with Healthchecks. Create
|
||||||
an account at https://healthchecks.io (or self-host Healthchecks) if
|
an account at https://healthchecks.io (or self-host Healthchecks) if
|
||||||
|
|
|
@ -167,11 +167,10 @@ def repositories_match(first, second):
|
||||||
def guard_configuration_contains_repository(repository, configurations):
|
def guard_configuration_contains_repository(repository, configurations):
|
||||||
'''
|
'''
|
||||||
Given a repository path and a dict mapping from config filename to corresponding parsed config
|
Given a repository path and a dict mapping from config filename to corresponding parsed config
|
||||||
dict, ensure that the repository is declared exactly once in all of the configurations. If no
|
dict, ensure that the repository is declared at least once in all of the configurations. If no
|
||||||
repository is given, skip this check.
|
repository is given, skip this check.
|
||||||
|
|
||||||
Raise ValueError if the repository is not found in a configuration, or is declared multiple
|
Raise ValueError if the repository is not found in any configurations.
|
||||||
times.
|
|
||||||
'''
|
'''
|
||||||
if not repository:
|
if not repository:
|
||||||
return
|
return
|
||||||
|
@ -186,9 +185,7 @@ def guard_configuration_contains_repository(repository, configurations):
|
||||||
)
|
)
|
||||||
|
|
||||||
if count == 0:
|
if count == 0:
|
||||||
raise ValueError(f'Repository {repository} not found in configuration files')
|
raise ValueError(f'Repository "{repository}" not found in configuration files')
|
||||||
if count > 1:
|
|
||||||
raise ValueError(f'Repository {repository} found in multiple configuration files')
|
|
||||||
|
|
||||||
|
|
||||||
def guard_single_repository_selected(repository, configurations):
|
def guard_single_repository_selected(repository, configurations):
|
||||||
|
|
|
@ -4,6 +4,7 @@ import logging
|
||||||
import os
|
import os
|
||||||
import select
|
import select
|
||||||
import subprocess
|
import subprocess
|
||||||
|
import textwrap
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
@ -219,13 +220,41 @@ def log_outputs(processes, exclude_stdouts, output_log_level, borg_local_path, b
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
SECRET_COMMAND_FLAG_NAMES = {'--password'}
|
||||||
|
|
||||||
|
|
||||||
|
def mask_command_secrets(full_command):
|
||||||
|
'''
|
||||||
|
Given a command as a sequence, mask secret values for flags like "--password" in preparation for
|
||||||
|
logging.
|
||||||
|
'''
|
||||||
|
masked_command = []
|
||||||
|
previous_piece = None
|
||||||
|
|
||||||
|
for piece in full_command:
|
||||||
|
masked_command.append('***' if previous_piece in SECRET_COMMAND_FLAG_NAMES else piece)
|
||||||
|
previous_piece = piece
|
||||||
|
|
||||||
|
return tuple(masked_command)
|
||||||
|
|
||||||
|
|
||||||
|
MAX_LOGGED_COMMAND_LENGTH = 1000
|
||||||
|
|
||||||
|
|
||||||
def log_command(full_command, input_file=None, output_file=None, environment=None):
|
def log_command(full_command, input_file=None, output_file=None, environment=None):
|
||||||
'''
|
'''
|
||||||
Log the given command (a sequence of command/argument strings), along with its input/output file
|
Log the given command (a sequence of command/argument strings), along with its input/output file
|
||||||
paths and extra environment variables (with omitted values in case they contain passwords).
|
paths and extra environment variables (with omitted values in case they contain passwords).
|
||||||
'''
|
'''
|
||||||
logger.debug(
|
logger.debug(
|
||||||
' '.join(tuple(f'{key}=***' for key in (environment or {}).keys()) + tuple(full_command))
|
textwrap.shorten(
|
||||||
|
' '.join(
|
||||||
|
tuple(f'{key}=***' for key in (environment or {}).keys())
|
||||||
|
+ mask_command_secrets(full_command)
|
||||||
|
),
|
||||||
|
width=MAX_LOGGED_COMMAND_LENGTH,
|
||||||
|
placeholder=' ...',
|
||||||
|
)
|
||||||
+ (f" < {getattr(input_file, 'name', '')}" if input_file else '')
|
+ (f" < {getattr(input_file, 'name', '')}" if input_file else '')
|
||||||
+ (f" > {getattr(output_file, 'name', '')}" if output_file else '')
|
+ (f" > {getattr(output_file, 'name', '')}" if output_file else '')
|
||||||
)
|
)
|
||||||
|
@ -376,9 +405,9 @@ def execute_command_with_processes(
|
||||||
command,
|
command,
|
||||||
stdin=input_file,
|
stdin=input_file,
|
||||||
stdout=None if do_not_capture else (output_file or subprocess.PIPE),
|
stdout=None if do_not_capture else (output_file or subprocess.PIPE),
|
||||||
stderr=None
|
stderr=(
|
||||||
if do_not_capture
|
None if do_not_capture else (subprocess.PIPE if output_file else subprocess.STDOUT)
|
||||||
else (subprocess.PIPE if output_file else subprocess.STDOUT),
|
),
|
||||||
shell=shell,
|
shell=shell,
|
||||||
env=environment,
|
env=environment,
|
||||||
cwd=working_directory,
|
cwd=working_directory,
|
||||||
|
|
|
@ -1,16 +1,36 @@
|
||||||
import logging
|
import logging
|
||||||
import operator
|
import operator
|
||||||
|
|
||||||
|
import borgmatic.hooks.logs
|
||||||
|
import borgmatic.hooks.monitor
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
|
||||||
|
|
||||||
def initialize_monitor(
|
DEFAULT_LOGS_SIZE_LIMIT_BYTES = 100000
|
||||||
ping_url, config, config_filename, monitoring_log_level, dry_run
|
HANDLER_IDENTIFIER = 'apprise'
|
||||||
): # pragma: no cover
|
|
||||||
|
|
||||||
|
def initialize_monitor(hook_config, config, config_filename, monitoring_log_level, dry_run):
|
||||||
'''
|
'''
|
||||||
No initialization is necessary for this monitor.
|
Add a handler to the root logger that stores in memory the most recent logs emitted. That way,
|
||||||
|
we can send them all to an Apprise notification service upon a finish or failure state. But skip
|
||||||
|
this if the "send_logs" option is false.
|
||||||
'''
|
'''
|
||||||
pass
|
if hook_config.get('send_logs') is False:
|
||||||
|
return
|
||||||
|
|
||||||
|
logs_size_limit = max(
|
||||||
|
hook_config.get('logs_size_limit', DEFAULT_LOGS_SIZE_LIMIT_BYTES)
|
||||||
|
- len(borgmatic.hooks.logs.PAYLOAD_TRUNCATION_INDICATOR),
|
||||||
|
0,
|
||||||
|
)
|
||||||
|
|
||||||
|
borgmatic.hooks.logs.add_handler(
|
||||||
|
borgmatic.hooks.logs.Forgetful_buffering_handler(
|
||||||
|
HANDLER_IDENTIFIER, logs_size_limit, monitoring_log_level
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def ping_monitor(hook_config, config, config_filename, state, monitoring_log_level, dry_run):
|
def ping_monitor(hook_config, config, config_filename, state, monitoring_log_level, dry_run):
|
||||||
|
@ -59,9 +79,20 @@ def ping_monitor(hook_config, config, config_filename, state, monitoring_log_lev
|
||||||
if dry_run:
|
if dry_run:
|
||||||
return
|
return
|
||||||
|
|
||||||
|
body = state_config.get('body')
|
||||||
|
|
||||||
|
if state in (
|
||||||
|
borgmatic.hooks.monitor.State.FINISH,
|
||||||
|
borgmatic.hooks.monitor.State.FAIL,
|
||||||
|
borgmatic.hooks.monitor.State.LOG,
|
||||||
|
):
|
||||||
|
formatted_logs = borgmatic.hooks.logs.format_buffered_logs_for_payload(HANDLER_IDENTIFIER)
|
||||||
|
if formatted_logs:
|
||||||
|
body += f'\n\n{formatted_logs}'
|
||||||
|
|
||||||
result = apprise_object.notify(
|
result = apprise_object.notify(
|
||||||
title=state_config.get('title', ''),
|
title=state_config.get('title', ''),
|
||||||
body=state_config.get('body'),
|
body=body,
|
||||||
body_format=NotifyFormat.TEXT,
|
body_format=NotifyFormat.TEXT,
|
||||||
notify_type=state_to_notify_type[state.name.lower()],
|
notify_type=state_to_notify_type[state.name.lower()],
|
||||||
)
|
)
|
||||||
|
@ -70,10 +101,9 @@ def ping_monitor(hook_config, config, config_filename, state, monitoring_log_lev
|
||||||
logger.warning(f'{config_filename}: Error sending some Apprise notifications')
|
logger.warning(f'{config_filename}: Error sending some Apprise notifications')
|
||||||
|
|
||||||
|
|
||||||
def destroy_monitor(
|
def destroy_monitor(hook_config, config, config_filename, monitoring_log_level, dry_run):
|
||||||
ping_url_or_uuid, config, config_filename, monitoring_log_level, dry_run
|
|
||||||
): # pragma: no cover
|
|
||||||
'''
|
'''
|
||||||
No destruction is necessary for this monitor.
|
Remove the monitor handler that was added to the root logger. This prevents the handler from
|
||||||
|
getting reused by other instances of this monitor.
|
||||||
'''
|
'''
|
||||||
pass
|
borgmatic.hooks.logs.remove_handler(HANDLER_IDENTIFIER)
|
||||||
|
|
|
@ -68,9 +68,9 @@ def execute_hook(commands, umask, config_filename, description, dry_run, **conte
|
||||||
if not dry_run:
|
if not dry_run:
|
||||||
execute.execute_command(
|
execute.execute_command(
|
||||||
[command],
|
[command],
|
||||||
output_log_level=logging.ERROR
|
output_log_level=(
|
||||||
if description == 'on-error'
|
logging.ERROR if description == 'on-error' else logging.WARNING
|
||||||
else logging.WARNING,
|
),
|
||||||
shell=True,
|
shell=True,
|
||||||
)
|
)
|
||||||
finally:
|
finally:
|
||||||
|
|
|
@ -1,7 +1,9 @@
|
||||||
import logging
|
import logging
|
||||||
|
import re
|
||||||
|
|
||||||
import requests
|
import requests
|
||||||
|
|
||||||
|
import borgmatic.hooks.logs
|
||||||
from borgmatic.hooks import monitor
|
from borgmatic.hooks import monitor
|
||||||
|
|
||||||
logger = logging.getLogger(__name__)
|
logger = logging.getLogger(__name__)
|
||||||
|
@ -13,61 +15,8 @@ MONITOR_STATE_TO_HEALTHCHECKS = {
|
||||||
monitor.State.LOG: 'log',
|
monitor.State.LOG: 'log',
|
||||||
}
|
}
|
||||||
|
|
||||||
PAYLOAD_TRUNCATION_INDICATOR = '...\n'
|
DEFAULT_PING_BODY_LIMIT_BYTES = 1500
|
||||||
DEFAULT_PING_BODY_LIMIT_BYTES = 100000
|
HANDLER_IDENTIFIER = 'healthchecks'
|
||||||
|
|
||||||
|
|
||||||
class Forgetful_buffering_handler(logging.Handler):
|
|
||||||
'''
|
|
||||||
A buffering log handler that stores log messages in memory, and throws away messages (oldest
|
|
||||||
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):
|
|
||||||
super().__init__()
|
|
||||||
|
|
||||||
self.byte_capacity = byte_capacity
|
|
||||||
self.byte_count = 0
|
|
||||||
self.buffer = []
|
|
||||||
self.forgot = False
|
|
||||||
self.setLevel(log_level)
|
|
||||||
|
|
||||||
def emit(self, record):
|
|
||||||
message = record.getMessage() + '\n'
|
|
||||||
self.byte_count += len(message)
|
|
||||||
self.buffer.append(message)
|
|
||||||
|
|
||||||
if not self.byte_capacity:
|
|
||||||
return
|
|
||||||
|
|
||||||
while self.byte_count > self.byte_capacity and self.buffer:
|
|
||||||
self.byte_count -= len(self.buffer[0])
|
|
||||||
self.buffer.pop(0)
|
|
||||||
self.forgot = True
|
|
||||||
|
|
||||||
|
|
||||||
def format_buffered_logs_for_payload():
|
|
||||||
'''
|
|
||||||
Get the handler previously added to the root logger, and slurp buffered logs out of it to
|
|
||||||
send to Healthchecks.
|
|
||||||
'''
|
|
||||||
try:
|
|
||||||
buffering_handler = next(
|
|
||||||
handler
|
|
||||||
for handler in logging.getLogger().handlers
|
|
||||||
if isinstance(handler, Forgetful_buffering_handler)
|
|
||||||
)
|
|
||||||
except StopIteration:
|
|
||||||
# No handler means no payload.
|
|
||||||
return ''
|
|
||||||
|
|
||||||
payload = ''.join(message for message in buffering_handler.buffer)
|
|
||||||
|
|
||||||
if buffering_handler.forgot:
|
|
||||||
return PAYLOAD_TRUNCATION_INDICATOR + payload
|
|
||||||
|
|
||||||
return payload
|
|
||||||
|
|
||||||
|
|
||||||
def initialize_monitor(hook_config, config, config_filename, monitoring_log_level, dry_run):
|
def initialize_monitor(hook_config, config, config_filename, monitoring_log_level, dry_run):
|
||||||
|
@ -81,12 +30,14 @@ def initialize_monitor(hook_config, config, config_filename, monitoring_log_leve
|
||||||
|
|
||||||
ping_body_limit = max(
|
ping_body_limit = max(
|
||||||
hook_config.get('ping_body_limit', DEFAULT_PING_BODY_LIMIT_BYTES)
|
hook_config.get('ping_body_limit', DEFAULT_PING_BODY_LIMIT_BYTES)
|
||||||
- len(PAYLOAD_TRUNCATION_INDICATOR),
|
- len(borgmatic.hooks.logs.PAYLOAD_TRUNCATION_INDICATOR),
|
||||||
0,
|
0,
|
||||||
)
|
)
|
||||||
|
|
||||||
logging.getLogger().addHandler(
|
borgmatic.hooks.logs.add_handler(
|
||||||
Forgetful_buffering_handler(ping_body_limit, monitoring_log_level)
|
borgmatic.hooks.logs.Forgetful_buffering_handler(
|
||||||
|
HANDLER_IDENTIFIER, ping_body_limit, monitoring_log_level
|
||||||
|
)
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@ -109,15 +60,25 @@ def ping_monitor(hook_config, config, config_filename, state, monitoring_log_lev
|
||||||
)
|
)
|
||||||
return
|
return
|
||||||
|
|
||||||
|
ping_url_is_uuid = re.search(r'\w{8}-\w{4}-\w{4}-\w{4}-\w{12}$', ping_url)
|
||||||
|
|
||||||
healthchecks_state = MONITOR_STATE_TO_HEALTHCHECKS.get(state)
|
healthchecks_state = MONITOR_STATE_TO_HEALTHCHECKS.get(state)
|
||||||
if healthchecks_state:
|
if healthchecks_state:
|
||||||
ping_url = f'{ping_url}/{healthchecks_state}'
|
ping_url = f'{ping_url}/{healthchecks_state}'
|
||||||
|
|
||||||
|
if hook_config.get('create_slug'):
|
||||||
|
if ping_url_is_uuid:
|
||||||
|
logger.warning(
|
||||||
|
f'{config_filename}: Healthchecks UUIDs do not support auto provisionning; ignoring'
|
||||||
|
)
|
||||||
|
else:
|
||||||
|
ping_url = f'{ping_url}?create=1'
|
||||||
|
|
||||||
logger.info(f'{config_filename}: Pinging Healthchecks {state.name.lower()}{dry_run_label}')
|
logger.info(f'{config_filename}: Pinging Healthchecks {state.name.lower()}{dry_run_label}')
|
||||||
logger.debug(f'{config_filename}: Using Healthchecks ping URL {ping_url}')
|
logger.debug(f'{config_filename}: Using Healthchecks ping URL {ping_url}')
|
||||||
|
|
||||||
if state in (monitor.State.FINISH, monitor.State.FAIL, monitor.State.LOG):
|
if state in (monitor.State.FINISH, monitor.State.FAIL, monitor.State.LOG):
|
||||||
payload = format_buffered_logs_for_payload()
|
payload = borgmatic.hooks.logs.format_buffered_logs_for_payload(HANDLER_IDENTIFIER)
|
||||||
else:
|
else:
|
||||||
payload = ''
|
payload = ''
|
||||||
|
|
||||||
|
@ -138,8 +99,4 @@ def destroy_monitor(hook_config, config, config_filename, monitoring_log_level,
|
||||||
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.
|
||||||
'''
|
'''
|
||||||
logger = logging.getLogger()
|
borgmatic.hooks.logs.remove_handler(HANDLER_IDENTIFIER)
|
||||||
|
|
||||||
for handler in tuple(logger.handlers):
|
|
||||||
if isinstance(handler, Forgetful_buffering_handler):
|
|
||||||
logger.removeHandler(handler)
|
|
||||||
|
|
|
@ -0,0 +1,91 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
PAYLOAD_TRUNCATION_INDICATOR = '...\n'
|
||||||
|
|
||||||
|
|
||||||
|
class Forgetful_buffering_handler(logging.Handler):
|
||||||
|
'''
|
||||||
|
A buffering log handler that stores log messages in memory, and throws away messages (oldest
|
||||||
|
first) once a particular capacity in bytes is reached. But if the given byte capacity is zero,
|
||||||
|
don't throw away any messages.
|
||||||
|
|
||||||
|
The given identifier is used to distinguish the instance of this handler used for one monitoring
|
||||||
|
hook from those instances used for other monitoring hooks.
|
||||||
|
'''
|
||||||
|
|
||||||
|
def __init__(self, identifier, byte_capacity, log_level):
|
||||||
|
super().__init__()
|
||||||
|
|
||||||
|
self.identifier = identifier
|
||||||
|
self.byte_capacity = byte_capacity
|
||||||
|
self.byte_count = 0
|
||||||
|
self.buffer = []
|
||||||
|
self.forgot = False
|
||||||
|
self.setLevel(log_level)
|
||||||
|
|
||||||
|
def emit(self, record):
|
||||||
|
message = record.getMessage() + '\n'
|
||||||
|
self.byte_count += len(message)
|
||||||
|
self.buffer.append(message)
|
||||||
|
|
||||||
|
if not self.byte_capacity:
|
||||||
|
return
|
||||||
|
|
||||||
|
while self.byte_count > self.byte_capacity and self.buffer:
|
||||||
|
self.byte_count -= len(self.buffer[0])
|
||||||
|
self.buffer.pop(0)
|
||||||
|
self.forgot = True
|
||||||
|
|
||||||
|
|
||||||
|
def add_handler(handler): # pragma: no cover
|
||||||
|
'''
|
||||||
|
Add the given handler to the global logger.
|
||||||
|
'''
|
||||||
|
logging.getLogger().addHandler(handler)
|
||||||
|
|
||||||
|
|
||||||
|
def get_handler(identifier):
|
||||||
|
'''
|
||||||
|
Given the identifier for an existing Forgetful_buffering_handler instance, return the handler.
|
||||||
|
|
||||||
|
Raise ValueError if the handler isn't found.
|
||||||
|
'''
|
||||||
|
try:
|
||||||
|
return next(
|
||||||
|
handler
|
||||||
|
for handler in logging.getLogger().handlers
|
||||||
|
if isinstance(handler, Forgetful_buffering_handler) and handler.identifier == identifier
|
||||||
|
)
|
||||||
|
except StopIteration:
|
||||||
|
raise ValueError(f'A buffering handler for {identifier} was not found')
|
||||||
|
|
||||||
|
|
||||||
|
def format_buffered_logs_for_payload(identifier):
|
||||||
|
'''
|
||||||
|
Get the handler previously added to the root logger, and slurp buffered logs out of it to
|
||||||
|
send to Healthchecks.
|
||||||
|
'''
|
||||||
|
try:
|
||||||
|
buffering_handler = get_handler(identifier)
|
||||||
|
except ValueError:
|
||||||
|
# No handler means no payload.
|
||||||
|
return ''
|
||||||
|
|
||||||
|
payload = ''.join(message for message in buffering_handler.buffer)
|
||||||
|
|
||||||
|
if buffering_handler.forgot:
|
||||||
|
return PAYLOAD_TRUNCATION_INDICATOR + payload
|
||||||
|
|
||||||
|
return payload
|
||||||
|
|
||||||
|
|
||||||
|
def remove_handler(identifier):
|
||||||
|
'''
|
||||||
|
Given the identifier for an existing Forgetful_buffering_handler instance, remove it.
|
||||||
|
'''
|
||||||
|
logger = logging.getLogger()
|
||||||
|
|
||||||
|
try:
|
||||||
|
logger.removeHandler(get_handler(identifier))
|
||||||
|
except ValueError:
|
||||||
|
pass
|
|
@ -1,6 +1,7 @@
|
||||||
import copy
|
import copy
|
||||||
import logging
|
import logging
|
||||||
import os
|
import os
|
||||||
|
import shlex
|
||||||
|
|
||||||
from borgmatic.execute import (
|
from borgmatic.execute import (
|
||||||
execute_command,
|
execute_command,
|
||||||
|
@ -35,8 +36,11 @@ def database_names_to_dump(database, extra_environment, log_prefix, dry_run):
|
||||||
if dry_run:
|
if dry_run:
|
||||||
return ()
|
return ()
|
||||||
|
|
||||||
|
mariadb_show_command = tuple(
|
||||||
|
shlex.quote(part) for part in shlex.split(database.get('mariadb_command') or 'mariadb')
|
||||||
|
)
|
||||||
show_command = (
|
show_command = (
|
||||||
('mariadb',)
|
mariadb_show_command
|
||||||
+ (tuple(database['list_options'].split(' ')) if 'list_options' in database else ())
|
+ (tuple(database['list_options'].split(' ')) if 'list_options' in database else ())
|
||||||
+ (('--host', database['hostname']) if 'hostname' in database else ())
|
+ (('--host', database['hostname']) if 'hostname' in database else ())
|
||||||
+ (('--port', str(database['port'])) if 'port' in database else ())
|
+ (('--port', str(database['port'])) if 'port' in database else ())
|
||||||
|
@ -79,8 +83,12 @@ def execute_dump_command(
|
||||||
)
|
)
|
||||||
return None
|
return None
|
||||||
|
|
||||||
|
mariadb_dump_command = tuple(
|
||||||
|
shlex.quote(part)
|
||||||
|
for part in shlex.split(database.get('mariadb_dump_command') or 'mariadb-dump')
|
||||||
|
)
|
||||||
dump_command = (
|
dump_command = (
|
||||||
('mariadb-dump',)
|
mariadb_dump_command
|
||||||
+ (tuple(database['options'].split(' ')) if 'options' in database else ())
|
+ (tuple(database['options'].split(' ')) if 'options' in database else ())
|
||||||
+ (('--add-drop-database',) if database.get('add_drop_database', True) else ())
|
+ (('--add-drop-database',) if database.get('add_drop_database', True) else ())
|
||||||
+ (('--host', database['hostname']) if 'hostname' in database else ())
|
+ (('--host', database['hostname']) if 'hostname' in database else ())
|
||||||
|
@ -107,6 +115,14 @@ def execute_dump_command(
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def use_streaming(databases, config, log_prefix):
|
||||||
|
'''
|
||||||
|
Given a sequence of MariaDB database configuration dicts, a configuration dict (ignored), and a
|
||||||
|
log prefix (ignored), return whether streaming will be using during dumps.
|
||||||
|
'''
|
||||||
|
return any(databases)
|
||||||
|
|
||||||
|
|
||||||
def dump_data_sources(databases, config, log_prefix, dry_run):
|
def dump_data_sources(databases, config, log_prefix, dry_run):
|
||||||
'''
|
'''
|
||||||
Dump the given MariaDB databases to a named pipe. The databases are supplied as a sequence of
|
Dump the given MariaDB databases to a named pipe. The databases are supplied as a sequence of
|
||||||
|
@ -208,8 +224,12 @@ def restore_data_source_dump(
|
||||||
'restore_password', data_source.get('password')
|
'restore_password', data_source.get('password')
|
||||||
)
|
)
|
||||||
|
|
||||||
|
mariadb_restore_command = tuple(
|
||||||
|
shlex.quote(part) for part in shlex.split(data_source.get('mariadb_command') or 'mariadb')
|
||||||
|
)
|
||||||
restore_command = (
|
restore_command = (
|
||||||
('mariadb', '--batch')
|
mariadb_restore_command
|
||||||
|
+ ('--batch',)
|
||||||
+ (
|
+ (
|
||||||
tuple(data_source['restore_options'].split(' '))
|
tuple(data_source['restore_options'].split(' '))
|
||||||
if 'restore_options' in data_source
|
if 'restore_options' in data_source
|
||||||
|
|
|
@ -16,6 +16,14 @@ def make_dump_path(config): # pragma: no cover
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def use_streaming(databases, config, log_prefix):
|
||||||
|
'''
|
||||||
|
Given a sequence of MongoDB database configuration dicts, a configuration dict (ignored), and a
|
||||||
|
log prefix (ignored), return whether streaming will be using during dumps.
|
||||||
|
'''
|
||||||
|
return any(database.get('format') != 'directory' for database in databases)
|
||||||
|
|
||||||
|
|
||||||
def dump_data_sources(databases, config, log_prefix, dry_run):
|
def dump_data_sources(databases, config, log_prefix, dry_run):
|
||||||
'''
|
'''
|
||||||
Dump the given MongoDB databases to a named pipe. The databases are supplied as a sequence of
|
Dump the given MongoDB databases to a named pipe. The databases are supplied as a sequence of
|
||||||
|
|
|
@ -1,6 +1,7 @@
|
||||||
import copy
|
import copy
|
||||||
import logging
|
import logging
|
||||||
import os
|
import os
|
||||||
|
import shlex
|
||||||
|
|
||||||
from borgmatic.execute import (
|
from borgmatic.execute import (
|
||||||
execute_command,
|
execute_command,
|
||||||
|
@ -35,8 +36,11 @@ def database_names_to_dump(database, extra_environment, log_prefix, dry_run):
|
||||||
if dry_run:
|
if dry_run:
|
||||||
return ()
|
return ()
|
||||||
|
|
||||||
|
mysql_show_command = tuple(
|
||||||
|
shlex.quote(part) for part in shlex.split(database.get('mysql_command') or 'mysql')
|
||||||
|
)
|
||||||
show_command = (
|
show_command = (
|
||||||
('mysql',)
|
mysql_show_command
|
||||||
+ (tuple(database['list_options'].split(' ')) if 'list_options' in database else ())
|
+ (tuple(database['list_options'].split(' ')) if 'list_options' in database else ())
|
||||||
+ (('--host', database['hostname']) if 'hostname' in database else ())
|
+ (('--host', database['hostname']) if 'hostname' in database else ())
|
||||||
+ (('--port', str(database['port'])) if 'port' in database else ())
|
+ (('--port', str(database['port'])) if 'port' in database else ())
|
||||||
|
@ -79,8 +83,11 @@ def execute_dump_command(
|
||||||
)
|
)
|
||||||
return None
|
return None
|
||||||
|
|
||||||
|
mysql_dump_command = tuple(
|
||||||
|
shlex.quote(part) for part in shlex.split(database.get('mysql_dump_command') or 'mysqldump')
|
||||||
|
)
|
||||||
dump_command = (
|
dump_command = (
|
||||||
('mysqldump',)
|
mysql_dump_command
|
||||||
+ (tuple(database['options'].split(' ')) if 'options' in database else ())
|
+ (tuple(database['options'].split(' ')) if 'options' in database else ())
|
||||||
+ (('--add-drop-database',) if database.get('add_drop_database', True) else ())
|
+ (('--add-drop-database',) if database.get('add_drop_database', True) else ())
|
||||||
+ (('--host', database['hostname']) if 'hostname' in database else ())
|
+ (('--host', database['hostname']) if 'hostname' in database else ())
|
||||||
|
@ -107,6 +114,14 @@ def execute_dump_command(
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def use_streaming(databases, config, log_prefix):
|
||||||
|
'''
|
||||||
|
Given a sequence of MySQL database configuration dicts, a configuration dict (ignored), and a
|
||||||
|
log prefix (ignored), return whether streaming will be using during dumps.
|
||||||
|
'''
|
||||||
|
return any(databases)
|
||||||
|
|
||||||
|
|
||||||
def dump_data_sources(databases, config, log_prefix, dry_run):
|
def dump_data_sources(databases, config, log_prefix, dry_run):
|
||||||
'''
|
'''
|
||||||
Dump the given MySQL/MariaDB databases to a named pipe. The databases are supplied as a sequence
|
Dump the given MySQL/MariaDB databases to a named pipe. The databases are supplied as a sequence
|
||||||
|
@ -207,8 +222,12 @@ def restore_data_source_dump(
|
||||||
'restore_password', data_source.get('password')
|
'restore_password', data_source.get('password')
|
||||||
)
|
)
|
||||||
|
|
||||||
|
mysql_restore_command = tuple(
|
||||||
|
shlex.quote(part) for part in shlex.split(data_source.get('mysql_command') or 'mysql')
|
||||||
|
)
|
||||||
restore_command = (
|
restore_command = (
|
||||||
('mysql', '--batch')
|
mysql_restore_command
|
||||||
|
+ ('--batch',)
|
||||||
+ (
|
+ (
|
||||||
tuple(data_source['restore_options'].split(' '))
|
tuple(data_source['restore_options'].split(' '))
|
||||||
if 'restore_options' in data_source
|
if 'restore_options' in data_source
|
||||||
|
|
|
@ -50,9 +50,16 @@ def ping_monitor(hook_config, config, config_filename, state, monitoring_log_lev
|
||||||
|
|
||||||
username = hook_config.get('username')
|
username = hook_config.get('username')
|
||||||
password = hook_config.get('password')
|
password = hook_config.get('password')
|
||||||
|
access_token = hook_config.get('access_token')
|
||||||
auth = None
|
auth = None
|
||||||
if (username and password) is not None:
|
|
||||||
|
if access_token is not None:
|
||||||
|
if username or password:
|
||||||
|
logger.warning(
|
||||||
|
f'{config_filename}: ntfy access_token is set but so is username/password, only using access_token'
|
||||||
|
)
|
||||||
|
auth = requests.auth.HTTPBasicAuth('', access_token)
|
||||||
|
elif (username and password) is not None:
|
||||||
auth = requests.auth.HTTPBasicAuth(username, password)
|
auth = requests.auth.HTTPBasicAuth(username, password)
|
||||||
logger.info(f'{config_filename}: Using basic auth with user {username} for ntfy')
|
logger.info(f'{config_filename}: Using basic auth with user {username} for ntfy')
|
||||||
elif username is not None:
|
elif username is not None:
|
||||||
|
|
|
@ -25,8 +25,8 @@ def make_dump_path(config): # pragma: no cover
|
||||||
|
|
||||||
def make_extra_environment(database, restore_connection_params=None):
|
def make_extra_environment(database, restore_connection_params=None):
|
||||||
'''
|
'''
|
||||||
Make the extra_environment dict from the given database configuration.
|
Make the extra_environment dict from the given database configuration. If restore connection
|
||||||
If restore connection params are given, this is for a restore operation.
|
params are given, this is for a restore operation.
|
||||||
'''
|
'''
|
||||||
extra = dict()
|
extra = dict()
|
||||||
|
|
||||||
|
@ -40,7 +40,8 @@ def make_extra_environment(database, restore_connection_params=None):
|
||||||
except (AttributeError, KeyError):
|
except (AttributeError, KeyError):
|
||||||
pass
|
pass
|
||||||
|
|
||||||
extra['PGSSLMODE'] = database.get('ssl_mode', 'disable')
|
if 'ssl_mode' in database:
|
||||||
|
extra['PGSSLMODE'] = database['ssl_mode']
|
||||||
if 'ssl_cert' in database:
|
if 'ssl_cert' in database:
|
||||||
extra['PGSSLCERT'] = database['ssl_cert']
|
extra['PGSSLCERT'] = database['ssl_cert']
|
||||||
if 'ssl_key' in database:
|
if 'ssl_key' in database:
|
||||||
|
@ -49,6 +50,7 @@ def make_extra_environment(database, restore_connection_params=None):
|
||||||
extra['PGSSLROOTCERT'] = database['ssl_root_cert']
|
extra['PGSSLROOTCERT'] = database['ssl_root_cert']
|
||||||
if 'ssl_crl' in database:
|
if 'ssl_crl' in database:
|
||||||
extra['PGSSLCRL'] = database['ssl_crl']
|
extra['PGSSLCRL'] = database['ssl_crl']
|
||||||
|
|
||||||
return extra
|
return extra
|
||||||
|
|
||||||
|
|
||||||
|
@ -71,9 +73,11 @@ def database_names_to_dump(database, extra_environment, log_prefix, dry_run):
|
||||||
if dry_run:
|
if dry_run:
|
||||||
return ()
|
return ()
|
||||||
|
|
||||||
psql_command = shlex.split(database.get('psql_command') or 'psql')
|
psql_command = tuple(
|
||||||
|
shlex.quote(part) for part in shlex.split(database.get('psql_command') or 'psql')
|
||||||
|
)
|
||||||
list_command = (
|
list_command = (
|
||||||
tuple(psql_command)
|
psql_command
|
||||||
+ ('--list', '--no-password', '--no-psqlrc', '--csv', '--tuples-only')
|
+ ('--list', '--no-password', '--no-psqlrc', '--csv', '--tuples-only')
|
||||||
+ (('--host', database['hostname']) if 'hostname' in database else ())
|
+ (('--host', database['hostname']) if 'hostname' in database else ())
|
||||||
+ (('--port', str(database['port'])) if 'port' in database else ())
|
+ (('--port', str(database['port'])) if 'port' in database else ())
|
||||||
|
@ -92,6 +96,14 @@ def database_names_to_dump(database, extra_environment, log_prefix, dry_run):
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def use_streaming(databases, config, log_prefix):
|
||||||
|
'''
|
||||||
|
Given a sequence of PostgreSQL database configuration dicts, a configuration dict (ignored), and
|
||||||
|
a log prefix (ignored), return whether streaming will be using during dumps.
|
||||||
|
'''
|
||||||
|
return any(database.get('format') != 'directory' for database in databases)
|
||||||
|
|
||||||
|
|
||||||
def dump_data_sources(databases, config, log_prefix, dry_run):
|
def dump_data_sources(databases, config, log_prefix, dry_run):
|
||||||
'''
|
'''
|
||||||
Dump the given PostgreSQL databases to a named pipe. The databases are supplied as a sequence of
|
Dump the given PostgreSQL databases to a named pipe. The databases are supplied as a sequence of
|
||||||
|
@ -125,7 +137,10 @@ def dump_data_sources(databases, config, log_prefix, dry_run):
|
||||||
for database_name in dump_database_names:
|
for database_name in dump_database_names:
|
||||||
dump_format = database.get('format', None if database_name == 'all' else 'custom')
|
dump_format = database.get('format', None if database_name == 'all' else 'custom')
|
||||||
default_dump_command = 'pg_dumpall' if database_name == 'all' else 'pg_dump'
|
default_dump_command = 'pg_dumpall' if database_name == 'all' else 'pg_dump'
|
||||||
dump_command = database.get('pg_dump_command') or default_dump_command
|
dump_command = tuple(
|
||||||
|
shlex.quote(part)
|
||||||
|
for part in shlex.split(database.get('pg_dump_command') or default_dump_command)
|
||||||
|
)
|
||||||
dump_filename = dump.make_data_source_dump_filename(
|
dump_filename = dump.make_data_source_dump_filename(
|
||||||
dump_path, database_name, database.get('hostname')
|
dump_path, database_name, database.get('hostname')
|
||||||
)
|
)
|
||||||
|
@ -136,8 +151,8 @@ def dump_data_sources(databases, config, log_prefix, dry_run):
|
||||||
continue
|
continue
|
||||||
|
|
||||||
command = (
|
command = (
|
||||||
(
|
dump_command
|
||||||
shlex.quote(dump_command),
|
+ (
|
||||||
'--no-password',
|
'--no-password',
|
||||||
'--clean',
|
'--clean',
|
||||||
'--if-exists',
|
'--if-exists',
|
||||||
|
@ -240,9 +255,11 @@ def restore_data_source_dump(
|
||||||
dump_filename = dump.make_data_source_dump_filename(
|
dump_filename = dump.make_data_source_dump_filename(
|
||||||
make_dump_path(config), data_source['name'], data_source.get('hostname')
|
make_dump_path(config), data_source['name'], data_source.get('hostname')
|
||||||
)
|
)
|
||||||
psql_command = shlex.split(data_source.get('psql_command') or 'psql')
|
psql_command = tuple(
|
||||||
|
shlex.quote(part) for part in shlex.split(data_source.get('psql_command') or 'psql')
|
||||||
|
)
|
||||||
analyze_command = (
|
analyze_command = (
|
||||||
tuple(psql_command)
|
psql_command
|
||||||
+ ('--no-password', '--no-psqlrc', '--quiet')
|
+ ('--no-password', '--no-psqlrc', '--quiet')
|
||||||
+ (('--host', hostname) if hostname else ())
|
+ (('--host', hostname) if hostname else ())
|
||||||
+ (('--port', port) if port else ())
|
+ (('--port', port) if port else ())
|
||||||
|
@ -256,9 +273,12 @@ def restore_data_source_dump(
|
||||||
+ ('--command', 'ANALYZE')
|
+ ('--command', 'ANALYZE')
|
||||||
)
|
)
|
||||||
use_psql_command = all_databases or data_source.get('format') == 'plain'
|
use_psql_command = all_databases or data_source.get('format') == 'plain'
|
||||||
pg_restore_command = shlex.split(data_source.get('pg_restore_command') or 'pg_restore')
|
pg_restore_command = tuple(
|
||||||
|
shlex.quote(part)
|
||||||
|
for part in shlex.split(data_source.get('pg_restore_command') or 'pg_restore')
|
||||||
|
)
|
||||||
restore_command = (
|
restore_command = (
|
||||||
tuple(psql_command if use_psql_command else pg_restore_command)
|
(psql_command if use_psql_command else pg_restore_command)
|
||||||
+ ('--no-password',)
|
+ ('--no-password',)
|
||||||
+ (('--no-psqlrc',) if use_psql_command else ('--if-exists', '--exit-on-error', '--clean'))
|
+ (('--no-psqlrc',) if use_psql_command else ('--if-exists', '--exit-on-error', '--clean'))
|
||||||
+ (('--dbname', data_source['name']) if not all_databases else ())
|
+ (('--dbname', data_source['name']) if not all_databases else ())
|
||||||
|
|
|
@ -17,9 +17,17 @@ def make_dump_path(config): # pragma: no cover
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def use_streaming(databases, config, log_prefix):
|
||||||
|
'''
|
||||||
|
Given a sequence of SQLite database configuration dicts, a configuration dict (ignored), and a
|
||||||
|
log prefix (ignored), return whether streaming will be using during dumps.
|
||||||
|
'''
|
||||||
|
return any(databases)
|
||||||
|
|
||||||
|
|
||||||
def dump_data_sources(databases, config, log_prefix, dry_run):
|
def dump_data_sources(databases, config, log_prefix, dry_run):
|
||||||
'''
|
'''
|
||||||
Dump the given SQLite3 databases to a named pipe. The databases are supplied as a sequence of
|
Dump the given SQLite databases to a named pipe. The databases are supplied as a sequence of
|
||||||
configuration dicts, as per the configuration schema. Use the given configuration dict to
|
configuration dicts, as per the configuration schema. Use the given configuration dict to
|
||||||
construct the destination path and the given log prefix in any log entries.
|
construct the destination path and the given log prefix in any log entries.
|
||||||
|
|
||||||
|
@ -71,7 +79,7 @@ def dump_data_sources(databases, config, log_prefix, dry_run):
|
||||||
|
|
||||||
def remove_data_source_dumps(databases, config, log_prefix, dry_run): # pragma: no cover
|
def remove_data_source_dumps(databases, config, log_prefix, dry_run): # pragma: no cover
|
||||||
'''
|
'''
|
||||||
Remove the given SQLite3 database dumps from the filesystem. The databases are supplied as a
|
Remove the given SQLite database dumps from the filesystem. The databases are supplied as a
|
||||||
sequence of configuration dicts, as per the configuration schema. Use the given configuration
|
sequence of configuration dicts, as per the configuration schema. Use the given configuration
|
||||||
dict to construct the destination path and the given log prefix in any log entries. If this is a
|
dict to construct the destination path and the given log prefix in any log entries. If this is a
|
||||||
dry run, then don't actually remove anything.
|
dry run, then don't actually remove anything.
|
||||||
|
@ -81,8 +89,8 @@ def remove_data_source_dumps(databases, config, log_prefix, dry_run): # pragma:
|
||||||
|
|
||||||
def make_data_source_dump_pattern(databases, config, log_prefix, name=None): # pragma: no cover
|
def make_data_source_dump_pattern(databases, config, log_prefix, name=None): # pragma: no cover
|
||||||
'''
|
'''
|
||||||
Make a pattern that matches the given SQLite3 databases. The databases are supplied as a
|
Make a pattern that matches the given SQLite databases. The databases are supplied as a sequence
|
||||||
sequence of configuration dicts, as per the configuration schema.
|
of configuration dicts, as per the configuration schema.
|
||||||
'''
|
'''
|
||||||
return dump.make_data_source_dump_filename(make_dump_path(config), name)
|
return dump.make_data_source_dump_filename(make_dump_path(config), name)
|
||||||
|
|
||||||
|
|
|
@ -41,6 +41,9 @@ def should_do_markup(no_color, configs):
|
||||||
if any(config.get('output', {}).get('color') is False for config in configs.values()):
|
if any(config.get('output', {}).get('color') is False for config in configs.values()):
|
||||||
return False
|
return False
|
||||||
|
|
||||||
|
if os.environ.get('NO_COLOR', None):
|
||||||
|
return False
|
||||||
|
|
||||||
py_colors = os.environ.get('PY_COLORS', None)
|
py_colors = os.environ.get('PY_COLORS', None)
|
||||||
|
|
||||||
if py_colors is not None:
|
if py_colors is not None:
|
||||||
|
@ -159,10 +162,11 @@ def configure_logging(
|
||||||
monitoring_log_level=None,
|
monitoring_log_level=None,
|
||||||
log_file=None,
|
log_file=None,
|
||||||
log_file_format=None,
|
log_file_format=None,
|
||||||
|
color_enabled=True,
|
||||||
):
|
):
|
||||||
'''
|
'''
|
||||||
Configure logging to go to both the console and (syslog or log file). Use the given log levels,
|
Configure logging to go to both the console and (syslog or log file). Use the given log levels,
|
||||||
respectively.
|
respectively. If color is enabled, set up log formatting accordingly.
|
||||||
|
|
||||||
Raise FileNotFoundError or PermissionError if the log file could not be opened for writing.
|
Raise FileNotFoundError or PermissionError if the log file could not be opened for writing.
|
||||||
'''
|
'''
|
||||||
|
@ -191,7 +195,10 @@ def configure_logging(
|
||||||
logging.DEBUG: console_standard_handler,
|
logging.DEBUG: console_standard_handler,
|
||||||
}
|
}
|
||||||
)
|
)
|
||||||
console_handler.setFormatter(Console_color_formatter())
|
|
||||||
|
if color_enabled:
|
||||||
|
console_handler.setFormatter(Console_color_formatter())
|
||||||
|
|
||||||
console_handler.setLevel(console_log_level)
|
console_handler.setLevel(console_log_level)
|
||||||
|
|
||||||
handlers = [console_handler]
|
handlers = [console_handler]
|
||||||
|
|
|
@ -206,6 +206,36 @@ hooks:
|
||||||
|
|
||||||
Alter the ports in these examples to suit your particular database system.
|
Alter the ports in these examples to suit your particular database system.
|
||||||
|
|
||||||
|
Normally, borgmatic dumps a database by running a database dump command (e.g.
|
||||||
|
`pg_dump`) on the host or wherever borgmatic is running, and this command
|
||||||
|
connects to your containerized database via the given `hostname` and `port`.
|
||||||
|
But if you don't have any database dump commands installed on your host and
|
||||||
|
you'd rather use the commands inside your database container itself, borgmatic
|
||||||
|
supports that too. Just configure borgmatic to `exec` into your container to
|
||||||
|
run the dump command.
|
||||||
|
|
||||||
|
For instance, if using Docker and PostgreSQL, something like this might work:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
hooks:
|
||||||
|
postgresql_databases:
|
||||||
|
- name: users
|
||||||
|
hostname: 127.0.0.1
|
||||||
|
port: 5433
|
||||||
|
username: postgres
|
||||||
|
password: trustsome1
|
||||||
|
pg_dump_command: docker exec my_pg_container pg_dump
|
||||||
|
```
|
||||||
|
|
||||||
|
... where `my_pg_container` is the name of your database container. In this
|
||||||
|
example, you'd also need to set the `pg_restore_command` and `psql_command`
|
||||||
|
options.
|
||||||
|
|
||||||
|
Similar command override options are available for (some of) the other
|
||||||
|
supported database types as well. See the [configuration
|
||||||
|
reference](https://torsion.org/borgmatic/docs/reference/configuration/) for
|
||||||
|
details.
|
||||||
|
|
||||||
|
|
||||||
### No source directories
|
### No source directories
|
||||||
|
|
||||||
|
@ -262,6 +292,10 @@ systems that you'd like supported.
|
||||||
|
|
||||||
## Database restoration
|
## Database restoration
|
||||||
|
|
||||||
|
When you want to replace an existing database with its backed-up contents, you
|
||||||
|
can restore it with borgmatic. Note that the database must already exist;
|
||||||
|
borgmatic does not currently create a database upon restore.
|
||||||
|
|
||||||
To restore a database dump from an archive, use the `borgmatic restore`
|
To restore a database dump from an archive, use the `borgmatic restore`
|
||||||
action. But the first step is to figure out which archive to restore from. A
|
action. But the first step is to figure out which archive to restore from. A
|
||||||
good way to do that is to use the `rlist` action:
|
good way to do that is to use the `rlist` action:
|
||||||
|
@ -403,19 +437,28 @@ borgmatic's own configuration file. So include your configuration file in
|
||||||
backups to avoid getting caught without a way to restore a database.
|
backups to avoid getting caught without a way to restore a database.
|
||||||
3. borgmatic does not currently support backing up or restoring multiple
|
3. borgmatic does not currently support backing up or restoring multiple
|
||||||
databases that share the exact same name on different hosts.
|
databases that share the exact same name on different hosts.
|
||||||
4. Because database hooks implicitly enable the `read_special` configuration,
|
4. When database hooks are enabled, borgmatic instructs Borg to consume
|
||||||
any special files are excluded from backups (named pipes, block devices,
|
special files (via `--read-special`) to support database dump
|
||||||
character devices, and sockets) to prevent hanging. Try a command like `find
|
streaming—regardless of the value of your `read_special` configuration option.
|
||||||
/your/source/path -type b -or -type c -or -type p -or -type s` to find such
|
And because this can cause Borg to hang, borgmatic also automatically excludes
|
||||||
files. Common directories to exclude are `/dev` and `/run`, but that may not
|
special files (and symlinks to them) that Borg may get stuck on. Even so,
|
||||||
be exhaustive. <span class="minilink minilink-addedin">New in version
|
there are still potential edge cases in which applications on your system
|
||||||
1.7.3</span> When database hooks are enabled, borgmatic automatically excludes
|
create new special files *after* borgmatic constructs its exclude list,
|
||||||
special files (and symlinks to special files) that may cause Borg to hang, so
|
resulting in Borg hangs. If that occurs, you can resort to manually excluding
|
||||||
generally you no longer need to manually exclude them. There are potential
|
those files. And if you explicitly set the `read-special` option to `true`,
|
||||||
edge cases though in which applications on your system create new special files
|
borgmatic will opt you out of the auto-exclude feature entirely, but will
|
||||||
*after* borgmatic constructs its exclude list, resulting in Borg hangs. If that
|
still instruct Borg to consume special files—you will just be on your own to
|
||||||
occurs, you can resort to the manual excludes described above. And to opt out
|
exclude them. <span class="minilink minilink-addedin">Prior to version
|
||||||
of the auto-exclude feature entirely, explicitly set `read_special` to true.
|
1.7.3</span>Special files were not auto-excluded, and you were responsible for
|
||||||
|
excluding them yourself. Common directories to exclude are `/dev` and `/run`,
|
||||||
|
but that may not be exhaustive.
|
||||||
|
5. Database hooks also implicitly enable the `one_file_system` option, which
|
||||||
|
means Borg won't cross filesystem boundaries when looking for files to backup.
|
||||||
|
This is especially important when running borgmatic in a container, as
|
||||||
|
container volumes are mounted as separate filesystems. One work-around is to
|
||||||
|
explicitly add each mounted volume you'd like to backup to
|
||||||
|
`source_directories` instead of relying on Borg to include them implicitly via
|
||||||
|
a parent directory.
|
||||||
|
|
||||||
|
|
||||||
### Manual restoration
|
### Manual restoration
|
||||||
|
|
|
@ -91,8 +91,9 @@ 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.
|
||||||
* `archives`: Checks all of the archives in the repository.
|
* `archives`: Checks all of the archives in the repository.
|
||||||
* `extract`: Performs an extraction dry-run of the most recent archive.
|
* `extract`: Performs an extraction dry-run of the latest archive.
|
||||||
* `data`: Verifies the data integrity of all archives contents, decrypting and decompressing all data.
|
* `data`: Verifies the data integrity of all archives contents, decrypting and decompressing all data.
|
||||||
|
* `spot`: Compares file counts and contents between your source files and the latest archive.
|
||||||
|
|
||||||
Note that the `data` check is a more thorough version of the `archives` check,
|
Note that the `data` check is a more thorough version of the `archives` check,
|
||||||
so enabling the `data` check implicitly enables the `archives` check as well.
|
so enabling the `data` check implicitly enables the `archives` check as well.
|
||||||
|
@ -102,6 +103,88 @@ documentation](https://borgbackup.readthedocs.io/en/stable/usage/check.html)
|
||||||
for more information.
|
for more information.
|
||||||
|
|
||||||
|
|
||||||
|
### Spot check
|
||||||
|
|
||||||
|
The various consistency checks all have trade-offs around speed and
|
||||||
|
thoroughness, but most of them don't even look at your original source
|
||||||
|
files—arguably one important way to ensure your backups contain the files
|
||||||
|
you'll want to restore in the case of catastrophe (or just an accidentally
|
||||||
|
deleted file). Because if something goes wrong with your source files, most
|
||||||
|
consistency checks will still pass with flying colors and you won't discover
|
||||||
|
there's a problem until you go to restore.
|
||||||
|
|
||||||
|
<span class="minilink minilink-addedin">New in version 1.8.10</span> <span
|
||||||
|
class="minilink minilink-addedin">Beta feature</span> That's where the spot
|
||||||
|
check comes in. This check actually compares your source file counts and data
|
||||||
|
against those in the latest archive, potentially catching problems like
|
||||||
|
incorrect excludes, inadvertent deletes, files changed by malware, etc.
|
||||||
|
|
||||||
|
However, because an exhaustive comparison of all source files against the
|
||||||
|
latest archive might be too slow, the spot check supports *sampling* a
|
||||||
|
percentage of your source files for the comparison, ensuring they fall within
|
||||||
|
configured tolerances.
|
||||||
|
|
||||||
|
Here's how it works. Start by installing the `xxhash` OS package if you don't
|
||||||
|
already have it, so the spot check can run the `xxh64sum` command and
|
||||||
|
efficiently hash files for comparison. Then add something like the following
|
||||||
|
to your borgmatic configuration:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
checks:
|
||||||
|
- name: spot
|
||||||
|
count_tolerance_percentage: 10
|
||||||
|
data_sample_percentage: 1
|
||||||
|
data_tolerance_percentage: 0.5
|
||||||
|
```
|
||||||
|
|
||||||
|
The `count_tolerance_percentage` is the percentage delta between the source
|
||||||
|
directories file count and the latest backup archive file count that is
|
||||||
|
allowed before the entire consistency check fails. For instance, if the spot
|
||||||
|
check runs and finds 100 source files on disk and 105 files in the latest
|
||||||
|
archive, that would be within the configured 10% count tolerance and the check
|
||||||
|
would succeed. But if there were 100 source files and 200 archive files, the
|
||||||
|
check would fail. (100 source files and only 50 archive files would also
|
||||||
|
fail.)
|
||||||
|
|
||||||
|
The `data_sample_percentage` is the percentage of total files in the source
|
||||||
|
directories to randomly sample and compare to their corresponding files in the
|
||||||
|
latest backup archive. A higher value allows a more accurate check—and a
|
||||||
|
slower one. The comparison is performed by hashing the selected source files
|
||||||
|
and counting hashes that don't match the latest archive. For instance, if you
|
||||||
|
have 1,000 source files and your sample percentage is 1%, then only 10 source
|
||||||
|
files will be compared against the latest archive. These sampled files are
|
||||||
|
selected randomly each time, so in effect the spot check is probabilistic.
|
||||||
|
|
||||||
|
The `data_tolerance_percentage` is the percentage of total files in the source
|
||||||
|
directories that can fail a spot check data comparison without failing the
|
||||||
|
entire consistency check. The value must be lower than or equal to the
|
||||||
|
`contents_sample_percentage`.
|
||||||
|
|
||||||
|
All three options are required when using the spot check. And because the
|
||||||
|
check relies on these configured tolerances, it may not be a
|
||||||
|
set-it-and-forget-it type of consistency check, at least until you get the
|
||||||
|
tolerances dialed in so there are minimal false positives or negatives. It is
|
||||||
|
recommended you run `borgmatic check` several times after configuring the spot
|
||||||
|
check, tweaking your tolerances as needed. For certain workloads where your
|
||||||
|
source files experience wild swings of file contents or counts, the spot check
|
||||||
|
may not suitable at all.
|
||||||
|
|
||||||
|
What if you add, delete, or change a bunch of your source files and you don't
|
||||||
|
want the spot check to fail the next time it's run? Run `borgmatic create` to
|
||||||
|
create a new backup, thereby allowing the next spot check to run against an
|
||||||
|
archive that contains your recent changes.
|
||||||
|
|
||||||
|
Because the spot check only looks at the most recent archive, you may not want
|
||||||
|
to run it immediately after a `create` action (borgmatic's default behavior).
|
||||||
|
Instead, it may make more sense to run the spot check on a separate schedule
|
||||||
|
from `create`.
|
||||||
|
|
||||||
|
As long as the spot check feature is in beta, it may be subject to breaking
|
||||||
|
changes. But feel free to use it in production if you're okay with that
|
||||||
|
caveat, and please [provide any
|
||||||
|
feedback](https://torsion.org/borgmatic/#issues) you have on this feature.
|
||||||
|
|
||||||
|
|
||||||
### Check frequency
|
### Check frequency
|
||||||
|
|
||||||
<span class="minilink minilink-addedin">New in version 1.6.2</span> You can
|
<span class="minilink minilink-addedin">New in version 1.6.2</span> You can
|
||||||
|
|
|
@ -35,6 +35,14 @@ pipx ensurepath
|
||||||
pipx install --editable .
|
pipx install --editable .
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Or to work on the [Apprise
|
||||||
|
hook](https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#apprise-hook),
|
||||||
|
change that last line to:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
pipx install --editable .[Apprise]
|
||||||
|
```
|
||||||
|
|
||||||
To get oriented with the borgmatic source code, have a look at the [source
|
To get oriented with the borgmatic source code, have a look at the [source
|
||||||
code reference](https://torsion.org/borgmatic/docs/reference/source-code/).
|
code reference](https://torsion.org/borgmatic/docs/reference/source-code/).
|
||||||
|
|
||||||
|
@ -92,14 +100,14 @@ with Borg and supported databases for a few representative scenarios. These
|
||||||
tests don't run by default when running `tox`, because they're relatively slow
|
tests don't run by default when running `tox`, because they're relatively slow
|
||||||
and depend on containers for runtime dependencies. These tests do run on the
|
and depend on containers for runtime dependencies. These tests do run on the
|
||||||
continuous integration (CI) server, and running them on your developer machine
|
continuous integration (CI) server, and running them on your developer machine
|
||||||
is the closest thing to CI-test parity.
|
is the closest thing to dev-CI parity.
|
||||||
|
|
||||||
If you would like to run the full test suite, first install Docker (or Podman;
|
If you would like to run the full test suite, first install Docker (or Podman;
|
||||||
see below) and [Docker Compose](https://docs.docker.com/compose/install/).
|
see below) and [Docker Compose](https://docs.docker.com/compose/install/).
|
||||||
Then run:
|
Then run:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
scripts/run-end-to-end-dev-tests
|
scripts/run-end-to-end-tests
|
||||||
```
|
```
|
||||||
|
|
||||||
This script assumes you have permission to run `docker`. If you don't, then
|
This script assumes you have permission to run `docker`. If you don't, then
|
||||||
|
@ -141,6 +149,9 @@ the following deviations from it:
|
||||||
separate from their contents.
|
separate from their contents.
|
||||||
* Within multiline constructs, use standard four-space indentation. Don't align
|
* Within multiline constructs, use standard four-space indentation. Don't align
|
||||||
indentation with an opening delimiter.
|
indentation with an opening delimiter.
|
||||||
|
* In general, spell out words in variable names instead of shortening them.
|
||||||
|
So, think `index` instead of `idx`. There are some notable exceptions to
|
||||||
|
this though (like `config`).
|
||||||
|
|
||||||
borgmatic code uses the [Black](https://black.readthedocs.io/en/stable/) code
|
borgmatic code uses the [Black](https://black.readthedocs.io/en/stable/) code
|
||||||
formatter, the [Flake8](http://flake8.pycqa.org/en/latest/) code checker, and
|
formatter, the [Flake8](http://flake8.pycqa.org/en/latest/) code checker, and
|
||||||
|
@ -148,12 +159,17 @@ the [isort](https://github.com/timothycrosley/isort) import orderer, so
|
||||||
certain code style requirements will be enforced when running automated tests.
|
certain code style requirements will be enforced when running automated tests.
|
||||||
See the Black, Flake8, and isort documentation for more information.
|
See the Black, Flake8, and isort documentation for more information.
|
||||||
|
|
||||||
|
|
||||||
## Continuous integration
|
## Continuous integration
|
||||||
|
|
||||||
Each pull request triggers a continuous integration build which runs the test
|
Each commit to
|
||||||
suite. You can view these builds on
|
[main](https://projects.torsion.org/borgmatic-collective/borgmatic/branches)
|
||||||
[build.torsion.org](https://build.torsion.org/borgmatic-collective/borgmatic),
|
triggers [a continuous integration
|
||||||
and they're also linked from the commits list on each pull request.
|
build](https://projects.torsion.org/borgmatic-collective/borgmatic/actions)
|
||||||
|
which runs the test suite and updates
|
||||||
|
[documentation](https://torsion.org/borgmatic/). These builds are also linked
|
||||||
|
from the [commits for the main
|
||||||
|
branch](https://projects.torsion.org/borgmatic-collective/borgmatic/commits/branch/main).
|
||||||
|
|
||||||
## Documentation development
|
## Documentation development
|
||||||
|
|
||||||
|
|
|
@ -101,7 +101,7 @@ script to handle the alerting:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
on_error:
|
on_error:
|
||||||
- send-text-message.sh "{configuration_filename}" "{repository}"
|
- send-text-message.sh {configuration_filename} {repository}
|
||||||
```
|
```
|
||||||
|
|
||||||
In this example, when the error occurs, borgmatic interpolates runtime values
|
In this example, when the error occurs, borgmatic interpolates runtime values
|
||||||
|
@ -124,6 +124,27 @@ actions. borgmatic does not run `on_error` hooks if an error occurs within a
|
||||||
documentation](https://torsion.org/borgmatic/docs/how-to/add-preparation-and-cleanup-steps-to-backups/),
|
documentation](https://torsion.org/borgmatic/docs/how-to/add-preparation-and-cleanup-steps-to-backups/),
|
||||||
especially the security information.
|
especially the security information.
|
||||||
|
|
||||||
|
<span class="minilink minilink-addedin">New in version 1.8.7</span> borgmatic
|
||||||
|
automatically escapes these interpolated values to prevent shell injection
|
||||||
|
attacks. One implication of this change is that you shouldn't wrap the
|
||||||
|
interpolated values in your own quotes, as that will interfere with the
|
||||||
|
quoting performed by borgmatic and result in your command receiving incorrect
|
||||||
|
arguments. For instance, this won't work:
|
||||||
|
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
on_error:
|
||||||
|
# Don't do this! It won't work, as the {error} value is already quoted.
|
||||||
|
- send-text-message.sh "Uh oh: {error}"
|
||||||
|
```
|
||||||
|
|
||||||
|
Do this instead:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
on_error:
|
||||||
|
- send-text-message.sh {error}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
## Healthchecks hook
|
## Healthchecks hook
|
||||||
|
|
||||||
|
@ -149,7 +170,7 @@ backup begins, ends, or errors, but only when any of the `create`, `prune`,
|
||||||
Then, if the actions complete successfully, borgmatic notifies Healthchecks of
|
Then, if the actions complete successfully, borgmatic notifies Healthchecks of
|
||||||
the success and includes borgmatic logs in the payload data sent to
|
the success and includes borgmatic logs in the payload data sent to
|
||||||
Healthchecks. This means that borgmatic logs show up in the Healthchecks UI,
|
Healthchecks. This means that borgmatic logs show up in the Healthchecks UI,
|
||||||
although be aware that Healthchecks currently has a 10-kilobyte limit for the
|
although be aware that Healthchecks currently has a 100-kilobyte limit for the
|
||||||
logs in each ping.
|
logs in each ping.
|
||||||
|
|
||||||
If an error occurs during any action or hook, borgmatic notifies Healthchecks,
|
If an error occurs during any action or hook, borgmatic notifies Healthchecks,
|
||||||
|
@ -277,22 +298,22 @@ platforms including [web](https://ntfy.sh/stats),
|
||||||
[iOS](https://apps.apple.com/us/app/ntfy/id1625396347).
|
[iOS](https://apps.apple.com/us/app/ntfy/id1625396347).
|
||||||
|
|
||||||
Since push notifications for regular events might soon become quite annoying,
|
Since push notifications for regular events might soon become quite annoying,
|
||||||
this hook only fires on any errors by default in order to instantly alert you to issues.
|
this hook only fires on any errors by default in order to instantly alert you
|
||||||
The `states` list can override this.
|
to issues. The `states` list can override this. Each state can have its own
|
||||||
|
custom messages, priorities and tags or, if none are provided, will use the
|
||||||
|
default.
|
||||||
|
|
||||||
As ntfy is unauthenticated, it isn't a suitable channel for any private information
|
An example configuration is shown here with all the available options,
|
||||||
so the default messages are intentionally generic. These can be overridden, depending
|
including [priorities](https://ntfy.sh/docs/publish/#message-priority) and
|
||||||
on your risk assessment. Each `state` can have its own custom messages, priorities and tags
|
|
||||||
or, if none are provided, will use the default.
|
|
||||||
|
|
||||||
An example configuration is shown here, with all the available options, including
|
|
||||||
[priorities](https://ntfy.sh/docs/publish/#message-priority) and
|
|
||||||
[tags](https://ntfy.sh/docs/publish/#tags-emojis):
|
[tags](https://ntfy.sh/docs/publish/#tags-emojis):
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
ntfy:
|
ntfy:
|
||||||
topic: my-unique-topic
|
topic: my-unique-topic
|
||||||
server: https://ntfy.my-domain.com
|
server: https://ntfy.my-domain.com
|
||||||
|
username: myuser
|
||||||
|
password: secret
|
||||||
|
|
||||||
start:
|
start:
|
||||||
title: A borgmatic backup started
|
title: A borgmatic backup started
|
||||||
message: Watch this space...
|
message: Watch this space...
|
||||||
|
@ -317,6 +338,16 @@ ntfy:
|
||||||
<span class="minilink minilink-addedin">Prior to version 1.8.0</span> Put
|
<span class="minilink minilink-addedin">Prior to version 1.8.0</span> Put
|
||||||
the `ntfy:` option in the `hooks:` section of your configuration.
|
the `ntfy:` option in the `hooks:` section of your configuration.
|
||||||
|
|
||||||
|
<span class="minilink minilink-addedin">New in version 1.8.9</span> Instead of
|
||||||
|
`username`/`password`, you can specify an [ntfy access
|
||||||
|
token](https://docs.ntfy.sh/config/#access-tokens):
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
ntfy:
|
||||||
|
topic: my-unique-topic
|
||||||
|
server: https://ntfy.my-domain.com
|
||||||
|
access_token: tk_AgQdq7mVBoFD37zQVN29RhuMzNIz2
|
||||||
|
````
|
||||||
|
|
||||||
## Loki hook
|
## Loki hook
|
||||||
|
|
||||||
|
@ -370,6 +401,10 @@ loki:
|
||||||
hostname: __hostname
|
hostname: __hostname
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Also check out this [Loki dashboard for
|
||||||
|
borgmatic](https://grafana.com/grafana/dashboards/20736-borgmatic-logs/) if
|
||||||
|
you'd like to see your backup logs and statistics in one place.
|
||||||
|
|
||||||
|
|
||||||
## Apprise hook
|
## Apprise hook
|
||||||
|
|
||||||
|
@ -385,7 +420,8 @@ pipx](https://torsion.org/borgmatic/docs/how-to/set-up-backups/#installation),
|
||||||
run the following to install Apprise so borgmatic can use it:
|
run the following to install Apprise so borgmatic can use it:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
sudo pipx install --editable --force borgmatic[Apprise]
|
sudo pipx uninstall borgmatic
|
||||||
|
sudo pipx install borgmatic[Apprise]
|
||||||
```
|
```
|
||||||
|
|
||||||
Omit `sudo` if borgmatic is installed as a non-root user.
|
Omit `sudo` if borgmatic is installed as a non-root user.
|
||||||
|
@ -400,11 +436,16 @@ apprise:
|
||||||
label: gotify
|
label: gotify
|
||||||
- url: mastodons://access_key@hostname/@user
|
- url: mastodons://access_key@hostname/@user
|
||||||
label: mastodon
|
label: mastodon
|
||||||
|
states:
|
||||||
|
- start
|
||||||
|
- finish
|
||||||
|
- fail
|
||||||
```
|
```
|
||||||
|
|
||||||
With this configuration, borgmatic pings each of the configured Apprise
|
With this configuration, borgmatic pings each of the configured Apprise
|
||||||
services when a backup begins, ends, or errors, but only when any of the
|
services when a backup begins, ends, or errors, but only when any of the
|
||||||
`prune`, `compact`, `create`, or `check` actions are run.
|
`prune`, `compact`, `create`, or `check` actions are run. (By default, if
|
||||||
|
`states` is not specified, Apprise services are only pinged on error.)
|
||||||
|
|
||||||
You can optionally customize the contents of the default messages sent to
|
You can optionally customize the contents of the default messages sent to
|
||||||
these services:
|
these services:
|
||||||
|
@ -429,6 +470,37 @@ apprise:
|
||||||
- fail
|
- fail
|
||||||
```
|
```
|
||||||
|
|
||||||
|
<span class="minilink minilink-addedin">New in version 1.8.9</span> borgmatic
|
||||||
|
logs are automatically included in the body data sent to your Apprise services
|
||||||
|
when a backup finishes or fails.
|
||||||
|
|
||||||
|
You can customize the verbosity of the logs that are sent with borgmatic's
|
||||||
|
`--monitoring-verbosity` flag. The `--list` and `--stats` flags may also be of
|
||||||
|
use. See `borgmatic create --help` for more information.
|
||||||
|
|
||||||
|
If you don't want any logs sent, you can disable this feature by setting
|
||||||
|
`send_logs` to `false`:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
apprise:
|
||||||
|
services:
|
||||||
|
- url: gotify://hostname/token
|
||||||
|
label: gotify
|
||||||
|
send_logs: false
|
||||||
|
```
|
||||||
|
|
||||||
|
Or to limit the size of logs sent to Apprise services:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
apprise:
|
||||||
|
services:
|
||||||
|
- url: gotify://hostname/token
|
||||||
|
label: gotify
|
||||||
|
logs_size_limit: 500
|
||||||
|
```
|
||||||
|
|
||||||
|
This may be necessary for some services that reject large requests.
|
||||||
|
|
||||||
See the [configuration
|
See the [configuration
|
||||||
reference](https://torsion.org/borgmatic/docs/reference/configuration/) for
|
reference](https://torsion.org/borgmatic/docs/reference/configuration/) for
|
||||||
details.
|
details.
|
||||||
|
|
|
@ -406,8 +406,9 @@ source /usr/share/fish/vendor_completions.d/borgmatic.fish
|
||||||
borgmatic produces colored terminal output by default. It is disabled when a
|
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 variables `PY_COLORS=False` or `NO_COLOR=True`, or
|
||||||
option to `false` in the `output` section of configuration.
|
setting the `color` option to `false` in the `output` section of
|
||||||
|
configuration.
|
||||||
|
|
||||||
|
|
||||||
## Troubleshooting
|
## Troubleshooting
|
||||||
|
|
|
@ -16,5 +16,7 @@ if [ -e "$USER_PODMAN_SOCKET_PATH" ]; then
|
||||||
export DOCKER_HOST="unix://$USER_PODMAN_SOCKET_PATH"
|
export DOCKER_HOST="unix://$USER_PODMAN_SOCKET_PATH"
|
||||||
fi
|
fi
|
||||||
|
|
||||||
docker-compose --file tests/end-to-end/docker-compose.yaml up --force-recreate \
|
docker-compose --file tests/end-to-end/docker-compose.yaml --progress quiet up --force-recreate \
|
||||||
--renew-anon-volumes --abort-on-container-exit
|
--renew-anon-volumes --detach
|
||||||
|
docker-compose --file tests/end-to-end/docker-compose.yaml --progress quiet attach tests
|
||||||
|
docker-compose --file tests/end-to-end/docker-compose.yaml --progress quiet down
|
|
@ -3,7 +3,7 @@
|
||||||
# This script installs test dependencies and runs all tests, including end-to-end tests. It
|
# This script installs test dependencies and runs all tests, including end-to-end tests. It
|
||||||
# is designed to run inside a test container, and presumes that other test infrastructure like
|
# is designed to run inside a test container, and presumes that other test infrastructure like
|
||||||
# databases are already running. Therefore, on a developer machine, you should not run this script
|
# databases are already running. Therefore, on a developer machine, you should not run this script
|
||||||
# directly. Instead, run scripts/run-end-to-end-dev-tests
|
# directly. Instead, run scripts/run-end-to-end-tests
|
||||||
#
|
#
|
||||||
# For more information, see:
|
# For more information, see:
|
||||||
# https://torsion.org/borgmatic/docs/how-to/develop-on-borgmatic/
|
# https://torsion.org/borgmatic/docs/how-to/develop-on-borgmatic/
|
||||||
|
@ -25,8 +25,5 @@ python3 -m pip install --no-cache --upgrade pip==22.2.2 setuptools==64.0.1
|
||||||
pip3 install --ignore-installed tox==4.11.3
|
pip3 install --ignore-installed tox==4.11.3
|
||||||
export COVERAGE_FILE=/tmp/.coverage
|
export COVERAGE_FILE=/tmp/.coverage
|
||||||
|
|
||||||
if [ "$1" != "--end-to-end-only" ]; then
|
tox --workdir /tmp/.tox --sitepackages
|
||||||
tox --workdir /tmp/.tox --sitepackages
|
|
||||||
fi
|
|
||||||
|
|
||||||
tox --workdir /tmp/.tox --sitepackages -e end-to-end
|
tox --workdir /tmp/.tox --sitepackages -e end-to-end
|
||||||
|
|
2
setup.py
2
setup.py
|
@ -1,6 +1,6 @@
|
||||||
from setuptools import find_packages, setup
|
from setuptools import find_packages, setup
|
||||||
|
|
||||||
VERSION = '1.8.7'
|
VERSION = '1.8.12.dev0'
|
||||||
|
|
||||||
|
|
||||||
setup(
|
setup(
|
||||||
|
|
|
@ -1,10 +1,10 @@
|
||||||
appdirs==1.4.4; python_version >= '3.8'
|
appdirs==1.4.4
|
||||||
apprise==1.3.0
|
apprise==1.3.0
|
||||||
attrs==22.2.0; python_version >= '3.8'
|
attrs==22.2.0
|
||||||
black==23.3.0; python_version >= '3.8'
|
black==24.3.0
|
||||||
certifi==2023.7.22
|
certifi==2023.7.22
|
||||||
chardet==5.1.0
|
chardet==5.1.0
|
||||||
click==8.1.3; python_version >= '3.8'
|
click==8.1.3
|
||||||
codespell==2.2.4
|
codespell==2.2.4
|
||||||
colorama==0.4.6
|
colorama==0.4.6
|
||||||
coverage==7.2.3
|
coverage==7.2.3
|
||||||
|
@ -13,7 +13,7 @@ flake8-quotes==3.3.2
|
||||||
flake8-use-fstring==1.4
|
flake8-use-fstring==1.4
|
||||||
flake8-variables-names==0.0.5
|
flake8-variables-names==0.0.5
|
||||||
flexmock==0.11.3
|
flexmock==0.11.3
|
||||||
idna==3.4
|
idna==3.7
|
||||||
isort==5.12.0
|
isort==5.12.0
|
||||||
jsonschema==4.17.3
|
jsonschema==4.17.3
|
||||||
Markdown==3.4.1
|
Markdown==3.4.1
|
||||||
|
|
|
@ -49,14 +49,13 @@ services:
|
||||||
environment:
|
environment:
|
||||||
TEST_CONTAINER: true
|
TEST_CONTAINER: true
|
||||||
volumes:
|
volumes:
|
||||||
- "../..:/app:ro"
|
- "../..:/app"
|
||||||
tmpfs:
|
tmpfs:
|
||||||
- "/app/borgmatic.egg-info"
|
- "/app/borgmatic.egg-info"
|
||||||
- "/app/build"
|
- "/app/build"
|
||||||
tty: true
|
tty: true
|
||||||
working_dir: /app
|
working_dir: /app
|
||||||
entrypoint: /app/scripts/run-full-tests
|
entrypoint: /app/scripts/run-full-tests
|
||||||
command: --end-to-end-only
|
|
||||||
depends_on:
|
depends_on:
|
||||||
- postgresql
|
- postgresql
|
||||||
- postgresql2
|
- postgresql2
|
||||||
|
|
|
@ -1,38 +0,0 @@
|
||||||
import ruamel.yaml
|
|
||||||
|
|
||||||
|
|
||||||
def test_dev_docker_compose_has_same_services_as_build_server_configuration():
|
|
||||||
'''
|
|
||||||
The end-to-end test configuration for local development and the build server's test
|
|
||||||
configuration use two different mechanisms for configuring and spinning up "services"—the
|
|
||||||
database containers upon which the end-to-end tests are reliant. The dev configuration uses
|
|
||||||
Docker Compose, while the Drone build server configuration uses its own similar-but-different
|
|
||||||
configuration file format.
|
|
||||||
|
|
||||||
Therefore, to ensure dev-build parity, these tests assert that the services are the same across
|
|
||||||
the dev and build configurations. This includes service name, container image, environment
|
|
||||||
variables, and commands.
|
|
||||||
|
|
||||||
This test only compares services and does not assert anything else about the respective testing
|
|
||||||
environments.
|
|
||||||
'''
|
|
||||||
yaml = ruamel.yaml.YAML(typ='safe')
|
|
||||||
dev_services = {
|
|
||||||
name: service
|
|
||||||
for name, service in yaml.load(open('tests/end-to-end/docker-compose.yaml').read())[
|
|
||||||
'services'
|
|
||||||
].items()
|
|
||||||
if name != 'tests'
|
|
||||||
}
|
|
||||||
build_server_services = tuple(yaml.load_all(open('.drone.yml').read()))[0]['services']
|
|
||||||
|
|
||||||
assert len(dev_services) == len(build_server_services)
|
|
||||||
|
|
||||||
for build_service in build_server_services:
|
|
||||||
dev_service = dev_services[build_service['name']]
|
|
||||||
assert dev_service['image'] == build_service['image']
|
|
||||||
assert dev_service['environment'] == build_service['environment']
|
|
||||||
|
|
||||||
if 'command' in dev_service or 'commands' in build_service:
|
|
||||||
assert len(build_service['commands']) <= 1
|
|
||||||
assert dev_service['command'] == build_service['commands'][0]
|
|
|
@ -29,6 +29,7 @@ def test_apply_overrides_updates_config():
|
||||||
'section.key=value1',
|
'section.key=value1',
|
||||||
'other_section.thing=value2',
|
'other_section.thing=value2',
|
||||||
'section.nested.key=value3',
|
'section.nested.key=value3',
|
||||||
|
'location.no_longer_in_location=value4',
|
||||||
'new.foo=bar',
|
'new.foo=bar',
|
||||||
'new.mylist=[baz]',
|
'new.mylist=[baz]',
|
||||||
'new.nonlist=[quux]',
|
'new.nonlist=[quux]',
|
||||||
|
@ -36,6 +37,7 @@ def test_apply_overrides_updates_config():
|
||||||
config = {
|
config = {
|
||||||
'section': {'key': 'value', 'other': 'other_value'},
|
'section': {'key': 'value', 'other': 'other_value'},
|
||||||
'other_section': {'thing': 'thing_value'},
|
'other_section': {'thing': 'thing_value'},
|
||||||
|
'no_longer_in_location': 'because_location_is_deprecated',
|
||||||
}
|
}
|
||||||
schema = {
|
schema = {
|
||||||
'properties': {
|
'properties': {
|
||||||
|
@ -49,4 +51,6 @@ def test_apply_overrides_updates_config():
|
||||||
'section': {'key': 'value1', 'other': 'other_value', 'nested': {'key': 'value3'}},
|
'section': {'key': 'value1', 'other': 'other_value', 'nested': {'key': 'value3'}},
|
||||||
'other_section': {'thing': 'value2'},
|
'other_section': {'thing': 'value2'},
|
||||||
'new': {'foo': 'bar', 'mylist': ['baz'], 'nonlist': '[quux]'},
|
'new': {'foo': 'bar', 'mylist': ['baz'], 'nonlist': '[quux]'},
|
||||||
|
'location': {'no_longer_in_location': 'value4'},
|
||||||
|
'no_longer_in_location': 'value4',
|
||||||
}
|
}
|
||||||
|
|
|
@ -241,7 +241,7 @@ def test_parse_configuration_applies_overrides():
|
||||||
)
|
)
|
||||||
|
|
||||||
config, config_paths, logs = module.parse_configuration(
|
config, config_paths, logs = module.parse_configuration(
|
||||||
'/tmp/config.yaml', '/tmp/schema.yaml', overrides=['location.local_path=borg2']
|
'/tmp/config.yaml', '/tmp/schema.yaml', overrides=['local_path=borg2']
|
||||||
)
|
)
|
||||||
|
|
||||||
assert config == {
|
assert config == {
|
||||||
|
|
|
@ -0,0 +1,28 @@
|
||||||
|
import logging
|
||||||
|
|
||||||
|
from flexmock import flexmock
|
||||||
|
|
||||||
|
from borgmatic.hooks import apprise as module
|
||||||
|
|
||||||
|
|
||||||
|
def test_destroy_monitor_removes_apprise_handler():
|
||||||
|
logger = logging.getLogger()
|
||||||
|
original_handlers = list(logger.handlers)
|
||||||
|
module.borgmatic.hooks.logs.add_handler(
|
||||||
|
module.borgmatic.hooks.logs.Forgetful_buffering_handler(
|
||||||
|
identifier=module.HANDLER_IDENTIFIER, byte_capacity=100, log_level=1
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
module.destroy_monitor(flexmock(), flexmock(), flexmock(), flexmock(), flexmock())
|
||||||
|
|
||||||
|
assert logger.handlers == original_handlers
|
||||||
|
|
||||||
|
|
||||||
|
def test_destroy_monitor_without_apprise_handler_does_not_raise():
|
||||||
|
logger = logging.getLogger()
|
||||||
|
original_handlers = list(logger.handlers)
|
||||||
|
|
||||||
|
module.destroy_monitor(flexmock(), flexmock(), flexmock(), flexmock(), flexmock())
|
||||||
|
|
||||||
|
assert logger.handlers == original_handlers
|
|
@ -8,7 +8,11 @@ from borgmatic.hooks import healthchecks as module
|
||||||
def test_destroy_monitor_removes_healthchecks_handler():
|
def test_destroy_monitor_removes_healthchecks_handler():
|
||||||
logger = logging.getLogger()
|
logger = logging.getLogger()
|
||||||
original_handlers = list(logger.handlers)
|
original_handlers = list(logger.handlers)
|
||||||
logger.addHandler(module.Forgetful_buffering_handler(byte_capacity=100, log_level=1))
|
module.borgmatic.hooks.logs.add_handler(
|
||||||
|
module.borgmatic.hooks.logs.Forgetful_buffering_handler(
|
||||||
|
identifier=module.HANDLER_IDENTIFIER, byte_capacity=100, log_level=1
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
module.destroy_monitor(flexmock(), flexmock(), flexmock(), flexmock(), flexmock())
|
module.destroy_monitor(flexmock(), flexmock(), flexmock(), flexmock(), flexmock())
|
||||||
|
|
||||||
|
|
File diff suppressed because it is too large
Load Diff
|
@ -1,25 +1,31 @@
|
||||||
from flexmock import flexmock
|
import pytest
|
||||||
|
|
||||||
from borgmatic.actions import json as module
|
from borgmatic.actions import json as module
|
||||||
|
|
||||||
|
|
||||||
def test_parse_json_loads_json_from_string():
|
def test_parse_json_loads_json_from_string():
|
||||||
flexmock(module.json).should_receive('loads').and_return({'repository': {'id': 'foo'}})
|
|
||||||
|
|
||||||
assert module.parse_json('{"repository": {"id": "foo"}}', label=None) == {
|
assert module.parse_json('{"repository": {"id": "foo"}}', label=None) == {
|
||||||
'repository': {'id': 'foo', 'label': ''}
|
'repository': {'id': 'foo', 'label': ''}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
def test_parse_json_injects_label_into_parsed_data():
|
def test_parse_json_skips_non_json_warnings_and_loads_subsequent_json():
|
||||||
flexmock(module.json).should_receive('loads').and_return({'repository': {'id': 'foo'}})
|
assert module.parse_json(
|
||||||
|
'/non/existent/path: stat: [Errno 2] No such file or directory: /non/existent/path\n{"repository":\n{"id": "foo"}}',
|
||||||
|
label=None,
|
||||||
|
) == {'repository': {'id': 'foo', 'label': ''}}
|
||||||
|
|
||||||
|
|
||||||
|
def test_parse_json_skips_with_invalid_json_raises():
|
||||||
|
with pytest.raises(module.json.JSONDecodeError):
|
||||||
|
module.parse_json('this is not valid JSON }', label=None)
|
||||||
|
|
||||||
|
|
||||||
|
def test_parse_json_injects_label_into_parsed_data():
|
||||||
assert module.parse_json('{"repository": {"id": "foo"}}', label='bar') == {
|
assert module.parse_json('{"repository": {"id": "foo"}}', label='bar') == {
|
||||||
'repository': {'id': 'foo', 'label': 'bar'}
|
'repository': {'id': 'foo', 'label': 'bar'}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
def test_parse_json_injects_nothing_when_repository_missing():
|
def test_parse_json_injects_nothing_when_repository_missing():
|
||||||
flexmock(module.json).should_receive('loads').and_return({'stuff': {'id': 'foo'}})
|
|
||||||
|
|
||||||
assert module.parse_json('{"stuff": {"id": "foo"}}', label='bar') == {'stuff': {'id': 'foo'}}
|
assert module.parse_json('{"stuff": {"id": "foo"}}', label='bar') == {'stuff': {'id': 'foo'}}
|
||||||
|
|
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
|
@ -507,6 +507,39 @@ def test_extract_archive_calls_borg_with_strip_components_calculated_from_all():
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_extract_archive_calls_borg_with_strip_components_calculated_from_all_with_leading_slash():
|
||||||
|
flexmock(module.os.path).should_receive('abspath').and_return('repo')
|
||||||
|
insert_execute_command_mock(
|
||||||
|
(
|
||||||
|
'borg',
|
||||||
|
'extract',
|
||||||
|
'--strip-components',
|
||||||
|
'2',
|
||||||
|
'repo::archive',
|
||||||
|
'/foo/bar/baz.txt',
|
||||||
|
'/foo/bar.txt',
|
||||||
|
)
|
||||||
|
)
|
||||||
|
flexmock(module.feature).should_receive('available').and_return(True)
|
||||||
|
flexmock(module.flags).should_receive('make_repository_archive_flags').and_return(
|
||||||
|
('repo::archive',)
|
||||||
|
)
|
||||||
|
flexmock(module.borgmatic.config.validate).should_receive(
|
||||||
|
'normalize_repository_path'
|
||||||
|
).and_return('repo')
|
||||||
|
|
||||||
|
module.extract_archive(
|
||||||
|
dry_run=False,
|
||||||
|
repository='repo',
|
||||||
|
archive='archive',
|
||||||
|
paths=['/foo/bar/baz.txt', '/foo/bar.txt'],
|
||||||
|
config={},
|
||||||
|
local_borg_version='1.2.3',
|
||||||
|
global_arguments=flexmock(log_json=False),
|
||||||
|
strip_components='all',
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_extract_archive_with_strip_components_all_and_no_paths_raises():
|
def test_extract_archive_with_strip_components_all_and_no_paths_raises():
|
||||||
flexmock(module.os.path).should_receive('abspath').and_return('repo')
|
flexmock(module.os.path).should_receive('abspath').and_return('repo')
|
||||||
flexmock(module.feature).should_receive('available').and_return(True)
|
flexmock(module.feature).should_receive('available').and_return(True)
|
||||||
|
|
|
@ -151,6 +151,30 @@ def test_make_repository_archive_flags_with_borg_features_joins_repository_and_a
|
||||||
False,
|
False,
|
||||||
('--glob-archives', '*-docs-{user}'), # noqa: FS003
|
('--glob-archives', '*-docs-{user}'), # noqa: FS003
|
||||||
),
|
),
|
||||||
|
(
|
||||||
|
'*',
|
||||||
|
'{now}', # noqa: FS003
|
||||||
|
True,
|
||||||
|
(),
|
||||||
|
),
|
||||||
|
(
|
||||||
|
'*',
|
||||||
|
'{now}', # noqa: FS003
|
||||||
|
False,
|
||||||
|
(),
|
||||||
|
),
|
||||||
|
(
|
||||||
|
're:.*',
|
||||||
|
'{now}', # noqa: FS003
|
||||||
|
True,
|
||||||
|
(),
|
||||||
|
),
|
||||||
|
(
|
||||||
|
'sh:*',
|
||||||
|
'{now}', # noqa: FS003
|
||||||
|
True,
|
||||||
|
(),
|
||||||
|
),
|
||||||
),
|
),
|
||||||
)
|
)
|
||||||
def test_make_match_archives_flags_makes_flags_with_globs(
|
def test_make_match_archives_flags_makes_flags_with_globs(
|
||||||
|
|
|
@ -13,12 +13,14 @@ RCREATE_COMMAND = ('borg', 'rcreate', '--encryption', 'repokey')
|
||||||
|
|
||||||
|
|
||||||
def insert_rinfo_command_found_mock():
|
def insert_rinfo_command_found_mock():
|
||||||
flexmock(module.rinfo).should_receive('display_repository_info')
|
flexmock(module.rinfo).should_receive('display_repository_info').and_return(
|
||||||
|
'{"encryption": {"mode": "repokey"}}'
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def insert_rinfo_command_not_found_mock():
|
def insert_rinfo_command_not_found_mock():
|
||||||
flexmock(module.rinfo).should_receive('display_repository_info').and_raise(
|
flexmock(module.rinfo).should_receive('display_repository_info').and_raise(
|
||||||
subprocess.CalledProcessError(module.RINFO_REPOSITORY_NOT_FOUND_EXIT_CODE, [])
|
subprocess.CalledProcessError(sorted(module.RINFO_REPOSITORY_NOT_FOUND_EXIT_CODES)[0], [])
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@ -120,6 +122,27 @@ def test_create_repository_skips_creation_when_repository_already_exists():
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_create_repository_errors_when_repository_with_differing_encryption_mode_already_exists():
|
||||||
|
insert_rinfo_command_found_mock()
|
||||||
|
flexmock(module.feature).should_receive('available').and_return(True)
|
||||||
|
flexmock(module.flags).should_receive('make_repository_flags').and_return(
|
||||||
|
(
|
||||||
|
'--repo',
|
||||||
|
'repo',
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
with pytest.raises(ValueError):
|
||||||
|
module.create_repository(
|
||||||
|
dry_run=False,
|
||||||
|
repository_path='repo',
|
||||||
|
config={},
|
||||||
|
local_borg_version='2.3.4',
|
||||||
|
global_arguments=flexmock(log_json=False),
|
||||||
|
encryption_mode='repokey-blake2',
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_create_repository_raises_for_unknown_rinfo_command_error():
|
def test_create_repository_raises_for_unknown_rinfo_command_error():
|
||||||
flexmock(module.rinfo).should_receive('display_repository_info').and_raise(
|
flexmock(module.rinfo).should_receive('display_repository_info').and_raise(
|
||||||
subprocess.CalledProcessError(RINFO_SOME_UNKNOWN_EXIT_CODE, [])
|
subprocess.CalledProcessError(RINFO_SOME_UNKNOWN_EXIT_CODE, [])
|
||||||
|
|
|
@ -61,7 +61,7 @@ def test_run_configuration_with_invalid_borg_version_errors():
|
||||||
flexmock(module.command).should_receive('execute_hook').never()
|
flexmock(module.command).should_receive('execute_hook').never()
|
||||||
flexmock(module.dispatch).should_receive('call_hooks').never()
|
flexmock(module.dispatch).should_receive('call_hooks').never()
|
||||||
flexmock(module).should_receive('run_actions').never()
|
flexmock(module).should_receive('run_actions').never()
|
||||||
config = {'repositories': ['foo']}
|
config = {'repositories': [{'path': 'foo'}]}
|
||||||
arguments = {'global': flexmock(monitoring_verbosity=1, dry_run=False), 'prune': flexmock()}
|
arguments = {'global': flexmock(monitoring_verbosity=1, dry_run=False), 'prune': flexmock()}
|
||||||
|
|
||||||
list(module.run_configuration('test.yaml', config, ['/tmp/test.yaml'], arguments))
|
list(module.run_configuration('test.yaml', config, ['/tmp/test.yaml'], arguments))
|
||||||
|
@ -77,7 +77,7 @@ def test_run_configuration_logs_monitor_start_error():
|
||||||
expected_results = [flexmock()]
|
expected_results = [flexmock()]
|
||||||
flexmock(module).should_receive('log_error_records').and_return(expected_results)
|
flexmock(module).should_receive('log_error_records').and_return(expected_results)
|
||||||
flexmock(module).should_receive('run_actions').never()
|
flexmock(module).should_receive('run_actions').never()
|
||||||
config = {'repositories': ['foo']}
|
config = {'repositories': [{'path': 'foo'}]}
|
||||||
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, ['/tmp/test.yaml'], arguments))
|
results = list(module.run_configuration('test.yaml', config, ['/tmp/test.yaml'], arguments))
|
||||||
|
@ -93,7 +93,7 @@ def test_run_configuration_bails_for_monitor_start_soft_failure():
|
||||||
flexmock(module.dispatch).should_receive('call_hooks').and_raise(error)
|
flexmock(module.dispatch).should_receive('call_hooks').and_raise(error)
|
||||||
flexmock(module).should_receive('log_error_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 = {'repositories': ['foo']}
|
config = {'repositories': [{'path': 'foo'}]}
|
||||||
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, ['/tmp/test.yaml'], arguments))
|
results = list(module.run_configuration('test.yaml', config, ['/tmp/test.yaml'], arguments))
|
||||||
|
@ -118,11 +118,11 @@ def test_run_configuration_logs_actions_error():
|
||||||
assert results == expected_results
|
assert results == expected_results
|
||||||
|
|
||||||
|
|
||||||
def test_run_configuration_bails_for_actions_soft_failure():
|
def test_run_configuration_skips_remaining_actions_for_actions_soft_failure_but_still_pings_monitor():
|
||||||
flexmock(module).should_receive('verbosity_to_log_level').and_return(logging.INFO)
|
flexmock(module).should_receive('verbosity_to_log_level').and_return(logging.INFO)
|
||||||
flexmock(module).should_receive('get_skip_actions').and_return([])
|
flexmock(module).should_receive('get_skip_actions').and_return([])
|
||||||
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.dispatch).should_receive('call_hooks')
|
flexmock(module.dispatch).should_receive('call_hooks').times(5)
|
||||||
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).should_receive('run_actions').and_raise(error)
|
flexmock(module).should_receive('run_actions').and_raise(error)
|
||||||
flexmock(module).should_receive('log_error_records').never()
|
flexmock(module).should_receive('log_error_records').never()
|
||||||
|
@ -153,14 +153,14 @@ def test_run_configuration_logs_monitor_log_error():
|
||||||
assert results == expected_results
|
assert results == expected_results
|
||||||
|
|
||||||
|
|
||||||
def test_run_configuration_bails_for_monitor_log_soft_failure():
|
def test_run_configuration_still_pings_monitor_for_monitor_log_soft_failure():
|
||||||
flexmock(module).should_receive('verbosity_to_log_level').and_return(logging.INFO)
|
flexmock(module).should_receive('verbosity_to_log_level').and_return(logging.INFO)
|
||||||
flexmock(module).should_receive('get_skip_actions').and_return([])
|
flexmock(module).should_receive('get_skip_actions').and_return([])
|
||||||
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.dispatch).should_receive('call_hooks').and_return(None).and_return(
|
flexmock(module.dispatch).should_receive('call_hooks').and_return(None).and_return(
|
||||||
None
|
None
|
||||||
).and_raise(error)
|
).and_raise(error).and_return(None).and_return(None).times(5)
|
||||||
flexmock(module).should_receive('log_error_records').never()
|
flexmock(module).should_receive('log_error_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)
|
flexmock(module.command).should_receive('considered_soft_failure').and_return(True)
|
||||||
|
@ -259,7 +259,7 @@ def test_run_configuration_bails_for_on_error_hook_soft_failure():
|
||||||
|
|
||||||
|
|
||||||
def test_run_configuration_retries_soft_error():
|
def test_run_configuration_retries_soft_error():
|
||||||
# Run action first fails, second passes
|
# Run action first fails, second passes.
|
||||||
flexmock(module).should_receive('verbosity_to_log_level').and_return(logging.INFO)
|
flexmock(module).should_receive('verbosity_to_log_level').and_return(logging.INFO)
|
||||||
flexmock(module).should_receive('get_skip_actions').and_return([])
|
flexmock(module).should_receive('get_skip_actions').and_return([])
|
||||||
flexmock(module.borg_version).should_receive('local_borg_version').and_return(flexmock())
|
flexmock(module.borg_version).should_receive('local_borg_version').and_return(flexmock())
|
||||||
|
@ -273,7 +273,7 @@ def test_run_configuration_retries_soft_error():
|
||||||
|
|
||||||
|
|
||||||
def test_run_configuration_retries_hard_error():
|
def test_run_configuration_retries_hard_error():
|
||||||
# Run action fails twice
|
# Run action fails twice.
|
||||||
flexmock(module).should_receive('verbosity_to_log_level').and_return(logging.INFO)
|
flexmock(module).should_receive('verbosity_to_log_level').and_return(logging.INFO)
|
||||||
flexmock(module).should_receive('get_skip_actions').and_return([])
|
flexmock(module).should_receive('get_skip_actions').and_return([])
|
||||||
flexmock(module.borg_version).should_receive('local_borg_version').and_return(flexmock())
|
flexmock(module.borg_version).should_receive('local_borg_version').and_return(flexmock())
|
||||||
|
|
|
@ -50,6 +50,16 @@ def test_apply_constants_with_empty_constants_passes_through_value():
|
||||||
({'before_backup': '{inject}'}, {'before_backup': "'echo hi; naughty-command'"}),
|
({'before_backup': '{inject}'}, {'before_backup': "'echo hi; naughty-command'"}),
|
||||||
({'after_backup': '{inject}'}, {'after_backup': "'echo hi; naughty-command'"}),
|
({'after_backup': '{inject}'}, {'after_backup': "'echo hi; naughty-command'"}),
|
||||||
({'on_error': '{inject}'}, {'on_error': "'echo hi; naughty-command'"}),
|
({'on_error': '{inject}'}, {'on_error': "'echo hi; naughty-command'"}),
|
||||||
|
(
|
||||||
|
{
|
||||||
|
'before_backup': '{env_pass}',
|
||||||
|
'postgresql_databases': [{'name': 'users', 'password': '{env_pass}'}],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
'before_backup': "'${PASS}'",
|
||||||
|
'postgresql_databases': [{'name': 'users', 'password': '${PASS}'}],
|
||||||
|
},
|
||||||
|
),
|
||||||
(3, 3),
|
(3, 3),
|
||||||
(True, True),
|
(True, True),
|
||||||
(False, False),
|
(False, False),
|
||||||
|
@ -63,6 +73,7 @@ def test_apply_constants_makes_string_substitutions(value, expected_value):
|
||||||
'int': 3,
|
'int': 3,
|
||||||
'bool': True,
|
'bool': True,
|
||||||
'inject': 'echo hi; naughty-command',
|
'inject': 'echo hi; naughty-command',
|
||||||
|
'env_pass': '${PASS}',
|
||||||
}
|
}
|
||||||
|
|
||||||
assert module.apply_constants(value, constants) == expected_value
|
assert module.apply_constants(value, constants) == expected_value
|
||||||
|
|
|
@ -6,9 +6,48 @@ from flexmock import flexmock
|
||||||
from borgmatic.config import generate as module
|
from borgmatic.config import generate as module
|
||||||
|
|
||||||
|
|
||||||
|
def test_get_properties_with_simple_object():
|
||||||
|
schema = {
|
||||||
|
'type': 'object',
|
||||||
|
'properties': OrderedDict(
|
||||||
|
[
|
||||||
|
('field1', {'example': 'Example'}),
|
||||||
|
]
|
||||||
|
),
|
||||||
|
}
|
||||||
|
|
||||||
|
assert module.get_properties(schema) == schema['properties']
|
||||||
|
|
||||||
|
|
||||||
|
def test_get_properties_merges_one_of_list_properties():
|
||||||
|
schema = {
|
||||||
|
'type': 'object',
|
||||||
|
'oneOf': [
|
||||||
|
{
|
||||||
|
'properties': OrderedDict(
|
||||||
|
[
|
||||||
|
('field1', {'example': 'Example 1'}),
|
||||||
|
('field2', {'example': 'Example 2'}),
|
||||||
|
]
|
||||||
|
),
|
||||||
|
},
|
||||||
|
{
|
||||||
|
'properties': OrderedDict(
|
||||||
|
[
|
||||||
|
('field2', {'example': 'Example 2'}),
|
||||||
|
('field3', {'example': 'Example 3'}),
|
||||||
|
]
|
||||||
|
),
|
||||||
|
},
|
||||||
|
],
|
||||||
|
}
|
||||||
|
|
||||||
|
assert module.get_properties(schema) == dict(
|
||||||
|
schema['oneOf'][0]['properties'], **schema['oneOf'][1]['properties']
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_schema_to_sample_configuration_generates_config_map_with_examples():
|
def test_schema_to_sample_configuration_generates_config_map_with_examples():
|
||||||
flexmock(module.ruamel.yaml.comments).should_receive('CommentedMap').replace_with(OrderedDict)
|
|
||||||
flexmock(module).should_receive('add_comments_to_configuration_object')
|
|
||||||
schema = {
|
schema = {
|
||||||
'type': 'object',
|
'type': 'object',
|
||||||
'properties': OrderedDict(
|
'properties': OrderedDict(
|
||||||
|
@ -19,6 +58,9 @@ def test_schema_to_sample_configuration_generates_config_map_with_examples():
|
||||||
]
|
]
|
||||||
),
|
),
|
||||||
}
|
}
|
||||||
|
flexmock(module).should_receive('get_properties').and_return(schema['properties'])
|
||||||
|
flexmock(module.ruamel.yaml.comments).should_receive('CommentedMap').replace_with(OrderedDict)
|
||||||
|
flexmock(module).should_receive('add_comments_to_configuration_object')
|
||||||
|
|
||||||
config = module.schema_to_sample_configuration(schema)
|
config = module.schema_to_sample_configuration(schema)
|
||||||
|
|
||||||
|
@ -42,9 +84,6 @@ def test_schema_to_sample_configuration_generates_config_sequence_of_strings_wit
|
||||||
|
|
||||||
|
|
||||||
def test_schema_to_sample_configuration_generates_config_sequence_of_maps_with_examples():
|
def test_schema_to_sample_configuration_generates_config_sequence_of_maps_with_examples():
|
||||||
flexmock(module.ruamel.yaml.comments).should_receive('CommentedSeq').replace_with(list)
|
|
||||||
flexmock(module).should_receive('add_comments_to_configuration_sequence')
|
|
||||||
flexmock(module).should_receive('add_comments_to_configuration_object')
|
|
||||||
schema = {
|
schema = {
|
||||||
'type': 'array',
|
'type': 'array',
|
||||||
'items': {
|
'items': {
|
||||||
|
@ -54,6 +93,10 @@ def test_schema_to_sample_configuration_generates_config_sequence_of_maps_with_e
|
||||||
),
|
),
|
||||||
},
|
},
|
||||||
}
|
}
|
||||||
|
flexmock(module).should_receive('get_properties').and_return(schema['items']['properties'])
|
||||||
|
flexmock(module.ruamel.yaml.comments).should_receive('CommentedSeq').replace_with(list)
|
||||||
|
flexmock(module).should_receive('add_comments_to_configuration_sequence')
|
||||||
|
flexmock(module).should_receive('add_comments_to_configuration_object')
|
||||||
|
|
||||||
config = module.schema_to_sample_configuration(schema)
|
config = module.schema_to_sample_configuration(schema)
|
||||||
|
|
||||||
|
|
|
@ -184,21 +184,6 @@ def test_guard_configuration_contains_repository_errors_when_repository_missing_
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_guard_configuration_contains_repository_errors_when_repository_matches_config_twice():
|
|
||||||
flexmock(module).should_receive('repositories_match').replace_with(
|
|
||||||
lambda first, second: first == second
|
|
||||||
)
|
|
||||||
|
|
||||||
with pytest.raises(ValueError):
|
|
||||||
module.guard_configuration_contains_repository(
|
|
||||||
repository='repo',
|
|
||||||
configurations={
|
|
||||||
'config.yaml': {'repositories': ['repo', 'repo2']},
|
|
||||||
'other.yaml': {'repositories': ['repo']},
|
|
||||||
},
|
|
||||||
)
|
|
||||||
|
|
||||||
|
|
||||||
def test_guard_single_repository_selected_raises_when_multiple_repositories_configured_and_none_selected():
|
def test_guard_single_repository_selected_raises_when_multiple_repositories_configured_and_none_selected():
|
||||||
with pytest.raises(ValueError):
|
with pytest.raises(ValueError):
|
||||||
module.guard_single_repository_selected(
|
module.guard_single_repository_selected(
|
||||||
|
|
|
@ -13,10 +13,63 @@ def mock_apprise():
|
||||||
add=lambda servers: None, notify=lambda title, body, body_format, notify_type: None
|
add=lambda servers: None, notify=lambda title, body, body_format, notify_type: None
|
||||||
)
|
)
|
||||||
flexmock(apprise.Apprise).new_instances(apprise_mock)
|
flexmock(apprise.Apprise).new_instances(apprise_mock)
|
||||||
|
|
||||||
return apprise_mock
|
return apprise_mock
|
||||||
|
|
||||||
|
|
||||||
def test_ping_monitor_adheres_dry_run():
|
def test_initialize_monitor_with_send_logs_false_does_not_add_handler():
|
||||||
|
flexmock(module.borgmatic.hooks.logs).should_receive('add_handler').never()
|
||||||
|
|
||||||
|
module.initialize_monitor(
|
||||||
|
hook_config={'send_logs': False},
|
||||||
|
config={},
|
||||||
|
config_filename='test.yaml',
|
||||||
|
monitoring_log_level=1,
|
||||||
|
dry_run=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_initialize_monitor_with_send_logs_true_adds_handler_with_default_log_size_limit():
|
||||||
|
truncation_indicator_length = 4
|
||||||
|
flexmock(module.borgmatic.hooks.logs).should_receive('Forgetful_buffering_handler').with_args(
|
||||||
|
module.HANDLER_IDENTIFIER,
|
||||||
|
module.DEFAULT_LOGS_SIZE_LIMIT_BYTES - truncation_indicator_length,
|
||||||
|
1,
|
||||||
|
).once()
|
||||||
|
flexmock(module.borgmatic.hooks.logs).should_receive('add_handler').once()
|
||||||
|
|
||||||
|
module.initialize_monitor(
|
||||||
|
hook_config={'send_logs': True},
|
||||||
|
config={},
|
||||||
|
config_filename='test.yaml',
|
||||||
|
monitoring_log_level=1,
|
||||||
|
dry_run=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_initialize_monitor_without_send_logs_adds_handler_with_default_log_size_limit():
|
||||||
|
truncation_indicator_length = 4
|
||||||
|
flexmock(module.borgmatic.hooks.logs).should_receive('Forgetful_buffering_handler').with_args(
|
||||||
|
module.HANDLER_IDENTIFIER,
|
||||||
|
module.DEFAULT_LOGS_SIZE_LIMIT_BYTES - truncation_indicator_length,
|
||||||
|
1,
|
||||||
|
).once()
|
||||||
|
flexmock(module.borgmatic.hooks.logs).should_receive('add_handler').once()
|
||||||
|
|
||||||
|
module.initialize_monitor(
|
||||||
|
hook_config={},
|
||||||
|
config={},
|
||||||
|
config_filename='test.yaml',
|
||||||
|
monitoring_log_level=1,
|
||||||
|
dry_run=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_ping_monitor_respects_dry_run():
|
||||||
|
flexmock(module.borgmatic.hooks.logs).should_receive('get_handler')
|
||||||
|
flexmock(module.borgmatic.hooks.logs).should_receive(
|
||||||
|
'format_buffered_logs_for_payload'
|
||||||
|
).and_return('loggy log')
|
||||||
mock_apprise().should_receive('notify').never()
|
mock_apprise().should_receive('notify').never()
|
||||||
|
|
||||||
module.ping_monitor(
|
module.ping_monitor(
|
||||||
|
@ -29,7 +82,9 @@ def test_ping_monitor_adheres_dry_run():
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_ping_monitor_does_not_hit_with_no_states():
|
def test_ping_monitor_with_no_states_does_not_notify():
|
||||||
|
flexmock(module.borgmatic.hooks.logs).should_receive('get_handler').never()
|
||||||
|
flexmock(module.borgmatic.hooks.logs).should_receive('format_buffered_logs_for_payload').never()
|
||||||
mock_apprise().should_receive('notify').never()
|
mock_apprise().should_receive('notify').never()
|
||||||
|
|
||||||
module.ping_monitor(
|
module.ping_monitor(
|
||||||
|
@ -42,7 +97,11 @@ def test_ping_monitor_does_not_hit_with_no_states():
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_ping_monitor_hits_fail_by_default():
|
def test_ping_monitor_notifies_fail_by_default():
|
||||||
|
flexmock(module.borgmatic.hooks.logs).should_receive('get_handler')
|
||||||
|
flexmock(module.borgmatic.hooks.logs).should_receive(
|
||||||
|
'format_buffered_logs_for_payload'
|
||||||
|
).and_return('')
|
||||||
mock_apprise().should_receive('notify').with_args(
|
mock_apprise().should_receive('notify').with_args(
|
||||||
title='A borgmatic FAIL event happened',
|
title='A borgmatic FAIL event happened',
|
||||||
body='A borgmatic FAIL event happened',
|
body='A borgmatic FAIL event happened',
|
||||||
|
@ -61,7 +120,34 @@ def test_ping_monitor_hits_fail_by_default():
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_ping_monitor_hits_with_finish_default_config():
|
def test_ping_monitor_with_logs_appends_logs_to_body():
|
||||||
|
flexmock(module.borgmatic.hooks.logs).should_receive('get_handler')
|
||||||
|
flexmock(module.borgmatic.hooks.logs).should_receive(
|
||||||
|
'format_buffered_logs_for_payload'
|
||||||
|
).and_return('loggy log')
|
||||||
|
mock_apprise().should_receive('notify').with_args(
|
||||||
|
title='A borgmatic FAIL event happened',
|
||||||
|
body='A borgmatic FAIL event happened\n\nloggy log',
|
||||||
|
body_format=NotifyFormat.TEXT,
|
||||||
|
notify_type=NotifyType.FAILURE,
|
||||||
|
).once()
|
||||||
|
|
||||||
|
for state in borgmatic.hooks.monitor.State:
|
||||||
|
module.ping_monitor(
|
||||||
|
{'services': [{'url': f'ntfys://{TOPIC}', 'label': 'ntfys'}]},
|
||||||
|
{},
|
||||||
|
'config.yaml',
|
||||||
|
state,
|
||||||
|
monitoring_log_level=1,
|
||||||
|
dry_run=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_ping_monitor_with_finish_default_config_notifies():
|
||||||
|
flexmock(module.borgmatic.hooks.logs).should_receive('get_handler')
|
||||||
|
flexmock(module.borgmatic.hooks.logs).should_receive(
|
||||||
|
'format_buffered_logs_for_payload'
|
||||||
|
).and_return('')
|
||||||
mock_apprise().should_receive('notify').with_args(
|
mock_apprise().should_receive('notify').with_args(
|
||||||
title='A borgmatic FINISH event happened',
|
title='A borgmatic FINISH event happened',
|
||||||
body='A borgmatic FINISH event happened',
|
body='A borgmatic FINISH event happened',
|
||||||
|
@ -79,7 +165,9 @@ def test_ping_monitor_hits_with_finish_default_config():
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_ping_monitor_hits_with_start_default_config():
|
def test_ping_monitor_with_start_default_config_notifies():
|
||||||
|
flexmock(module.borgmatic.hooks.logs).should_receive('get_handler').never()
|
||||||
|
flexmock(module.borgmatic.hooks.logs).should_receive('format_buffered_logs_for_payload').never()
|
||||||
mock_apprise().should_receive('notify').with_args(
|
mock_apprise().should_receive('notify').with_args(
|
||||||
title='A borgmatic START event happened',
|
title='A borgmatic START event happened',
|
||||||
body='A borgmatic START event happened',
|
body='A borgmatic START event happened',
|
||||||
|
@ -97,7 +185,11 @@ def test_ping_monitor_hits_with_start_default_config():
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_ping_monitor_hits_with_fail_default_config():
|
def test_ping_monitor_with_fail_default_config_notifies():
|
||||||
|
flexmock(module.borgmatic.hooks.logs).should_receive('get_handler')
|
||||||
|
flexmock(module.borgmatic.hooks.logs).should_receive(
|
||||||
|
'format_buffered_logs_for_payload'
|
||||||
|
).and_return('')
|
||||||
mock_apprise().should_receive('notify').with_args(
|
mock_apprise().should_receive('notify').with_args(
|
||||||
title='A borgmatic FAIL event happened',
|
title='A borgmatic FAIL event happened',
|
||||||
body='A borgmatic FAIL event happened',
|
body='A borgmatic FAIL event happened',
|
||||||
|
@ -115,7 +207,11 @@ def test_ping_monitor_hits_with_fail_default_config():
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_ping_monitor_hits_with_log_default_config():
|
def test_ping_monitor_with_log_default_config_notifies():
|
||||||
|
flexmock(module.borgmatic.hooks.logs).should_receive('get_handler')
|
||||||
|
flexmock(module.borgmatic.hooks.logs).should_receive(
|
||||||
|
'format_buffered_logs_for_payload'
|
||||||
|
).and_return('')
|
||||||
mock_apprise().should_receive('notify').with_args(
|
mock_apprise().should_receive('notify').with_args(
|
||||||
title='A borgmatic LOG event happened',
|
title='A borgmatic LOG event happened',
|
||||||
body='A borgmatic LOG event happened',
|
body='A borgmatic LOG event happened',
|
||||||
|
@ -134,6 +230,10 @@ def test_ping_monitor_hits_with_log_default_config():
|
||||||
|
|
||||||
|
|
||||||
def test_ping_monitor_passes_through_custom_message_title():
|
def test_ping_monitor_passes_through_custom_message_title():
|
||||||
|
flexmock(module.borgmatic.hooks.logs).should_receive('get_handler')
|
||||||
|
flexmock(module.borgmatic.hooks.logs).should_receive(
|
||||||
|
'format_buffered_logs_for_payload'
|
||||||
|
).and_return('')
|
||||||
mock_apprise().should_receive('notify').with_args(
|
mock_apprise().should_receive('notify').with_args(
|
||||||
title='foo',
|
title='foo',
|
||||||
body='bar',
|
body='bar',
|
||||||
|
@ -156,6 +256,10 @@ def test_ping_monitor_passes_through_custom_message_title():
|
||||||
|
|
||||||
|
|
||||||
def test_ping_monitor_passes_through_custom_message_body():
|
def test_ping_monitor_passes_through_custom_message_body():
|
||||||
|
flexmock(module.borgmatic.hooks.logs).should_receive('get_handler')
|
||||||
|
flexmock(module.borgmatic.hooks.logs).should_receive(
|
||||||
|
'format_buffered_logs_for_payload'
|
||||||
|
).and_return('')
|
||||||
mock_apprise().should_receive('notify').with_args(
|
mock_apprise().should_receive('notify').with_args(
|
||||||
title='',
|
title='',
|
||||||
body='baz',
|
body='baz',
|
||||||
|
@ -177,7 +281,37 @@ def test_ping_monitor_passes_through_custom_message_body():
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_ping_monitor_passes_through_custom_message_body_and_appends_logs():
|
||||||
|
flexmock(module.borgmatic.hooks.logs).should_receive('get_handler')
|
||||||
|
flexmock(module.borgmatic.hooks.logs).should_receive(
|
||||||
|
'format_buffered_logs_for_payload'
|
||||||
|
).and_return('loggy log')
|
||||||
|
mock_apprise().should_receive('notify').with_args(
|
||||||
|
title='',
|
||||||
|
body='baz\n\nloggy log',
|
||||||
|
body_format=NotifyFormat.TEXT,
|
||||||
|
notify_type=NotifyType.FAILURE,
|
||||||
|
).once()
|
||||||
|
|
||||||
|
module.ping_monitor(
|
||||||
|
{
|
||||||
|
'services': [{'url': f'ntfys://{TOPIC}', 'label': 'ntfys'}],
|
||||||
|
'states': ['fail'],
|
||||||
|
'fail': {'body': 'baz'},
|
||||||
|
},
|
||||||
|
{},
|
||||||
|
'config.yaml',
|
||||||
|
borgmatic.hooks.monitor.State.FAIL,
|
||||||
|
monitoring_log_level=1,
|
||||||
|
dry_run=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_ping_monitor_pings_multiple_services():
|
def test_ping_monitor_pings_multiple_services():
|
||||||
|
flexmock(module.borgmatic.hooks.logs).should_receive('get_handler')
|
||||||
|
flexmock(module.borgmatic.hooks.logs).should_receive(
|
||||||
|
'format_buffered_logs_for_payload'
|
||||||
|
).and_return('')
|
||||||
mock_apprise().should_receive('add').with_args([f'ntfys://{TOPIC}', f'ntfy://{TOPIC}']).once()
|
mock_apprise().should_receive('add').with_args([f'ntfys://{TOPIC}', f'ntfy://{TOPIC}']).once()
|
||||||
|
|
||||||
module.ping_monitor(
|
module.ping_monitor(
|
||||||
|
@ -196,6 +330,8 @@ def test_ping_monitor_pings_multiple_services():
|
||||||
|
|
||||||
|
|
||||||
def test_ping_monitor_logs_info_for_no_services():
|
def test_ping_monitor_logs_info_for_no_services():
|
||||||
|
flexmock(module.borgmatic.hooks.logs).should_receive('get_handler').never()
|
||||||
|
flexmock(module.borgmatic.hooks.logs).should_receive('format_buffered_logs_for_payload').never()
|
||||||
flexmock(module.logger).should_receive('info').once()
|
flexmock(module.logger).should_receive('info').once()
|
||||||
|
|
||||||
module.ping_monitor(
|
module.ping_monitor(
|
||||||
|
@ -209,6 +345,10 @@ def test_ping_monitor_logs_info_for_no_services():
|
||||||
|
|
||||||
|
|
||||||
def test_ping_monitor_logs_warning_when_notify_fails():
|
def test_ping_monitor_logs_warning_when_notify_fails():
|
||||||
|
flexmock(module.borgmatic.hooks.logs).should_receive('get_handler')
|
||||||
|
flexmock(module.borgmatic.hooks.logs).should_receive(
|
||||||
|
'format_buffered_logs_for_payload'
|
||||||
|
).and_return('')
|
||||||
mock_apprise().should_receive('notify').and_return(False)
|
mock_apprise().should_receive('notify').and_return(False)
|
||||||
flexmock(module.logger).should_receive('warning').once()
|
flexmock(module.logger).should_receive('warning').once()
|
||||||
|
|
||||||
|
@ -221,3 +361,15 @@ def test_ping_monitor_logs_warning_when_notify_fails():
|
||||||
monitoring_log_level=1,
|
monitoring_log_level=1,
|
||||||
dry_run=False,
|
dry_run=False,
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_destroy_monitor_does_not_raise():
|
||||||
|
flexmock(module.borgmatic.hooks.logs).should_receive('remove_handler')
|
||||||
|
|
||||||
|
module.destroy_monitor(
|
||||||
|
hook_config={},
|
||||||
|
config={},
|
||||||
|
config_filename='test.yaml',
|
||||||
|
monitoring_log_level=1,
|
||||||
|
dry_run=False,
|
||||||
|
)
|
||||||
|
|
|
@ -3,72 +3,6 @@ from flexmock import flexmock
|
||||||
from borgmatic.hooks import healthchecks as module
|
from borgmatic.hooks import healthchecks as module
|
||||||
|
|
||||||
|
|
||||||
def test_forgetful_buffering_handler_emit_collects_log_records():
|
|
||||||
handler = module.Forgetful_buffering_handler(byte_capacity=100, 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_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():
|
|
||||||
handler = module.Forgetful_buffering_handler(byte_capacity=len('foo\nbar\n'), log_level=1)
|
|
||||||
handler.emit(flexmock(getMessage=lambda: 'foo'))
|
|
||||||
assert handler.buffer == ['foo\n']
|
|
||||||
handler.emit(flexmock(getMessage=lambda: 'bar'))
|
|
||||||
assert handler.buffer == ['foo\n', 'bar\n']
|
|
||||||
handler.emit(flexmock(getMessage=lambda: 'baz'))
|
|
||||||
assert handler.buffer == ['bar\n', 'baz\n']
|
|
||||||
handler.emit(flexmock(getMessage=lambda: 'quux'))
|
|
||||||
assert handler.buffer == ['quux\n']
|
|
||||||
assert handler.forgot
|
|
||||||
|
|
||||||
|
|
||||||
def test_format_buffered_logs_for_payload_flattens_log_buffer():
|
|
||||||
handler = module.Forgetful_buffering_handler(byte_capacity=100, log_level=1)
|
|
||||||
handler.buffer = ['foo\n', 'bar\n']
|
|
||||||
logger = flexmock(handlers=[handler])
|
|
||||||
logger.should_receive('removeHandler')
|
|
||||||
flexmock(module.logging).should_receive('getLogger').and_return(logger)
|
|
||||||
|
|
||||||
payload = module.format_buffered_logs_for_payload()
|
|
||||||
|
|
||||||
assert payload == 'foo\nbar\n'
|
|
||||||
|
|
||||||
|
|
||||||
def test_format_buffered_logs_for_payload_inserts_truncation_indicator_when_logs_forgotten():
|
|
||||||
handler = module.Forgetful_buffering_handler(byte_capacity=100, log_level=1)
|
|
||||||
handler.buffer = ['foo\n', 'bar\n']
|
|
||||||
handler.forgot = True
|
|
||||||
logger = flexmock(handlers=[handler])
|
|
||||||
logger.should_receive('removeHandler')
|
|
||||||
flexmock(module.logging).should_receive('getLogger').and_return(logger)
|
|
||||||
|
|
||||||
payload = module.format_buffered_logs_for_payload()
|
|
||||||
|
|
||||||
assert payload == '...\nfoo\nbar\n'
|
|
||||||
|
|
||||||
|
|
||||||
def test_format_buffered_logs_for_payload_without_handler_produces_empty_payload():
|
|
||||||
logger = flexmock(handlers=[module.logging.Handler()])
|
|
||||||
logger.should_receive('removeHandler')
|
|
||||||
flexmock(module.logging).should_receive('getLogger').and_return(logger)
|
|
||||||
|
|
||||||
payload = module.format_buffered_logs_for_payload()
|
|
||||||
|
|
||||||
assert payload == ''
|
|
||||||
|
|
||||||
|
|
||||||
def mock_logger():
|
def mock_logger():
|
||||||
logger = flexmock()
|
logger = flexmock()
|
||||||
logger.should_receive('addHandler')
|
logger.should_receive('addHandler')
|
||||||
|
@ -81,8 +15,10 @@ def test_initialize_monitor_creates_log_handler_with_ping_body_limit():
|
||||||
monitoring_log_level = 1
|
monitoring_log_level = 1
|
||||||
|
|
||||||
mock_logger()
|
mock_logger()
|
||||||
flexmock(module).should_receive('Forgetful_buffering_handler').with_args(
|
flexmock(module.borgmatic.hooks.logs).should_receive('Forgetful_buffering_handler').with_args(
|
||||||
ping_body_limit - len(module.PAYLOAD_TRUNCATION_INDICATOR), monitoring_log_level
|
module.HANDLER_IDENTIFIER,
|
||||||
|
ping_body_limit - len(module.borgmatic.hooks.logs.PAYLOAD_TRUNCATION_INDICATOR),
|
||||||
|
monitoring_log_level,
|
||||||
).once()
|
).once()
|
||||||
|
|
||||||
module.initialize_monitor(
|
module.initialize_monitor(
|
||||||
|
@ -94,8 +30,10 @@ def test_initialize_monitor_creates_log_handler_with_default_ping_body_limit():
|
||||||
monitoring_log_level = 1
|
monitoring_log_level = 1
|
||||||
|
|
||||||
mock_logger()
|
mock_logger()
|
||||||
flexmock(module).should_receive('Forgetful_buffering_handler').with_args(
|
flexmock(module.borgmatic.hooks.logs).should_receive('Forgetful_buffering_handler').with_args(
|
||||||
module.DEFAULT_PING_BODY_LIMIT_BYTES - len(module.PAYLOAD_TRUNCATION_INDICATOR),
|
module.HANDLER_IDENTIFIER,
|
||||||
|
module.DEFAULT_PING_BODY_LIMIT_BYTES
|
||||||
|
- len(module.borgmatic.hooks.logs.PAYLOAD_TRUNCATION_INDICATOR),
|
||||||
monitoring_log_level,
|
monitoring_log_level,
|
||||||
).once()
|
).once()
|
||||||
|
|
||||||
|
@ -107,8 +45,8 @@ def test_initialize_monitor_creates_log_handler_with_zero_ping_body_limit():
|
||||||
monitoring_log_level = 1
|
monitoring_log_level = 1
|
||||||
|
|
||||||
mock_logger()
|
mock_logger()
|
||||||
flexmock(module).should_receive('Forgetful_buffering_handler').with_args(
|
flexmock(module.borgmatic.hooks.logs).should_receive('Forgetful_buffering_handler').with_args(
|
||||||
ping_body_limit, monitoring_log_level
|
module.HANDLER_IDENTIFIER, ping_body_limit, monitoring_log_level
|
||||||
).once()
|
).once()
|
||||||
|
|
||||||
module.initialize_monitor(
|
module.initialize_monitor(
|
||||||
|
@ -118,7 +56,7 @@ def test_initialize_monitor_creates_log_handler_with_zero_ping_body_limit():
|
||||||
|
|
||||||
def test_initialize_monitor_creates_log_handler_when_send_logs_true():
|
def test_initialize_monitor_creates_log_handler_when_send_logs_true():
|
||||||
mock_logger()
|
mock_logger()
|
||||||
flexmock(module).should_receive('Forgetful_buffering_handler').once()
|
flexmock(module.borgmatic.hooks.logs).should_receive('Forgetful_buffering_handler').once()
|
||||||
|
|
||||||
module.initialize_monitor(
|
module.initialize_monitor(
|
||||||
{'send_logs': True}, {}, 'test.yaml', monitoring_log_level=1, dry_run=False
|
{'send_logs': True}, {}, 'test.yaml', monitoring_log_level=1, dry_run=False
|
||||||
|
@ -127,7 +65,7 @@ def test_initialize_monitor_creates_log_handler_when_send_logs_true():
|
||||||
|
|
||||||
def test_initialize_monitor_bails_when_send_logs_false():
|
def test_initialize_monitor_bails_when_send_logs_false():
|
||||||
mock_logger()
|
mock_logger()
|
||||||
flexmock(module).should_receive('Forgetful_buffering_handler').never()
|
flexmock(module.borgmatic.hooks.logs).should_receive('Forgetful_buffering_handler').never()
|
||||||
|
|
||||||
module.initialize_monitor(
|
module.initialize_monitor(
|
||||||
{'send_logs': False}, {}, 'test.yaml', monitoring_log_level=1, dry_run=False
|
{'send_logs': False}, {}, 'test.yaml', monitoring_log_level=1, dry_run=False
|
||||||
|
@ -135,7 +73,7 @@ def test_initialize_monitor_bails_when_send_logs_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.borgmatic.hooks.logs).should_receive('Forgetful_buffering_handler').never()
|
||||||
hook_config = {'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(
|
||||||
'https://example.com/start', data=''.encode('utf-8'), verify=True
|
'https://example.com/start', data=''.encode('utf-8'), verify=True
|
||||||
|
@ -154,7 +92,10 @@ 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():
|
||||||
hook_config = {'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.borgmatic.hooks.logs).should_receive('get_handler')
|
||||||
|
flexmock(module.borgmatic.hooks.logs).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://example.com', data=payload.encode('utf-8'), verify=True
|
'https://example.com', data=payload.encode('utf-8'), verify=True
|
||||||
).and_return(flexmock(ok=True))
|
).and_return(flexmock(ok=True))
|
||||||
|
@ -172,7 +113,10 @@ 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():
|
||||||
hook_config = {'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.borgmatic.hooks.logs).should_receive('get_handler')
|
||||||
|
flexmock(module.borgmatic.hooks.logs).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://example.com/fail', data=payload.encode('utf'), verify=True
|
'https://example.com/fail', data=payload.encode('utf'), verify=True
|
||||||
).and_return(flexmock(ok=True))
|
).and_return(flexmock(ok=True))
|
||||||
|
@ -190,7 +134,10 @@ def test_ping_monitor_hits_ping_url_for_fail_state():
|
||||||
def test_ping_monitor_hits_ping_url_for_log_state():
|
def test_ping_monitor_hits_ping_url_for_log_state():
|
||||||
hook_config = {'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.borgmatic.hooks.logs).should_receive('get_handler')
|
||||||
|
flexmock(module.borgmatic.hooks.logs).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://example.com/log', data=payload.encode('utf'), verify=True
|
'https://example.com/log', data=payload.encode('utf'), verify=True
|
||||||
).and_return(flexmock(ok=True))
|
).and_return(flexmock(ok=True))
|
||||||
|
@ -208,7 +155,10 @@ def test_ping_monitor_hits_ping_url_for_log_state():
|
||||||
def test_ping_monitor_with_ping_uuid_hits_corresponding_url():
|
def test_ping_monitor_with_ping_uuid_hits_corresponding_url():
|
||||||
hook_config = {'ping_url': '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.borgmatic.hooks.logs).should_receive('get_handler')
|
||||||
|
flexmock(module.borgmatic.hooks.logs).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(
|
||||||
f"https://hc-ping.com/{hook_config['ping_url']}",
|
f"https://hc-ping.com/{hook_config['ping_url']}",
|
||||||
data=payload.encode('utf-8'),
|
data=payload.encode('utf-8'),
|
||||||
|
@ -228,7 +178,10 @@ def test_ping_monitor_with_ping_uuid_hits_corresponding_url():
|
||||||
def test_ping_monitor_skips_ssl_verification_when_verify_tls_false():
|
def test_ping_monitor_skips_ssl_verification_when_verify_tls_false():
|
||||||
hook_config = {'ping_url': 'https://example.com', 'verify_tls': False}
|
hook_config = {'ping_url': 'https://example.com', 'verify_tls': False}
|
||||||
payload = 'data'
|
payload = 'data'
|
||||||
flexmock(module).should_receive('format_buffered_logs_for_payload').and_return(payload)
|
flexmock(module.borgmatic.hooks.logs).should_receive('get_handler')
|
||||||
|
flexmock(module.borgmatic.hooks.logs).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://example.com', data=payload.encode('utf-8'), verify=False
|
'https://example.com', data=payload.encode('utf-8'), verify=False
|
||||||
).and_return(flexmock(ok=True))
|
).and_return(flexmock(ok=True))
|
||||||
|
@ -246,7 +199,10 @@ def test_ping_monitor_skips_ssl_verification_when_verify_tls_false():
|
||||||
def test_ping_monitor_executes_ssl_verification_when_verify_tls_true():
|
def test_ping_monitor_executes_ssl_verification_when_verify_tls_true():
|
||||||
hook_config = {'ping_url': 'https://example.com', 'verify_tls': True}
|
hook_config = {'ping_url': 'https://example.com', 'verify_tls': True}
|
||||||
payload = 'data'
|
payload = 'data'
|
||||||
flexmock(module).should_receive('format_buffered_logs_for_payload').and_return(payload)
|
flexmock(module.borgmatic.hooks.logs).should_receive('get_handler')
|
||||||
|
flexmock(module.borgmatic.hooks.logs).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://example.com', data=payload.encode('utf-8'), verify=True
|
'https://example.com', data=payload.encode('utf-8'), verify=True
|
||||||
).and_return(flexmock(ok=True))
|
).and_return(flexmock(ok=True))
|
||||||
|
@ -262,7 +218,7 @@ def test_ping_monitor_executes_ssl_verification_when_verify_tls_true():
|
||||||
|
|
||||||
|
|
||||||
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.borgmatic.hooks.logs).should_receive('Forgetful_buffering_handler').never()
|
||||||
hook_config = {'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()
|
||||||
|
|
||||||
|
@ -277,7 +233,7 @@ def test_ping_monitor_dry_run_does_not_hit_ping_url():
|
||||||
|
|
||||||
|
|
||||||
def test_ping_monitor_does_not_hit_ping_url_when_states_not_matching():
|
def test_ping_monitor_does_not_hit_ping_url_when_states_not_matching():
|
||||||
flexmock(module).should_receive('Forgetful_buffering_handler')
|
flexmock(module.borgmatic.hooks.logs).should_receive('Forgetful_buffering_handler').never()
|
||||||
hook_config = {'ping_url': 'https://example.com', 'states': ['finish']}
|
hook_config = {'ping_url': 'https://example.com', 'states': ['finish']}
|
||||||
flexmock(module.requests).should_receive('post').never()
|
flexmock(module.requests).should_receive('post').never()
|
||||||
|
|
||||||
|
@ -292,7 +248,7 @@ def test_ping_monitor_does_not_hit_ping_url_when_states_not_matching():
|
||||||
|
|
||||||
|
|
||||||
def test_ping_monitor_hits_ping_url_when_states_matching():
|
def test_ping_monitor_hits_ping_url_when_states_matching():
|
||||||
flexmock(module).should_receive('Forgetful_buffering_handler')
|
flexmock(module.borgmatic.hooks.logs).should_receive('Forgetful_buffering_handler').never()
|
||||||
hook_config = {'ping_url': 'https://example.com', 'states': ['start', 'finish']}
|
hook_config = {'ping_url': 'https://example.com', 'states': ['start', 'finish']}
|
||||||
flexmock(module.requests).should_receive('post').with_args(
|
flexmock(module.requests).should_receive('post').with_args(
|
||||||
'https://example.com/start', data=''.encode('utf-8'), verify=True
|
'https://example.com/start', data=''.encode('utf-8'), verify=True
|
||||||
|
@ -308,8 +264,74 @@ def test_ping_monitor_hits_ping_url_when_states_matching():
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_ping_monitor_adds_create_query_parameter_when_create_slug_true():
|
||||||
|
flexmock(module.borgmatic.hooks.logs).should_receive('Forgetful_buffering_handler').never()
|
||||||
|
hook_config = {'ping_url': 'https://example.com', 'create_slug': True}
|
||||||
|
flexmock(module.requests).should_receive('post').with_args(
|
||||||
|
'https://example.com/start?create=1', data=''.encode('utf-8'), verify=True
|
||||||
|
).and_return(flexmock(ok=True))
|
||||||
|
|
||||||
|
module.ping_monitor(
|
||||||
|
hook_config,
|
||||||
|
{},
|
||||||
|
'config.yaml',
|
||||||
|
state=module.monitor.State.START,
|
||||||
|
monitoring_log_level=1,
|
||||||
|
dry_run=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_ping_monitor_does_not_add_create_query_parameter_when_create_slug_false():
|
||||||
|
flexmock(module.borgmatic.hooks.logs).should_receive('Forgetful_buffering_handler').never()
|
||||||
|
hook_config = {'ping_url': 'https://example.com', 'create_slug': False}
|
||||||
|
flexmock(module.requests).should_receive('post').with_args(
|
||||||
|
'https://example.com/start', data=''.encode('utf-8'), verify=True
|
||||||
|
).and_return(flexmock(ok=True))
|
||||||
|
|
||||||
|
module.ping_monitor(
|
||||||
|
hook_config,
|
||||||
|
{},
|
||||||
|
'config.yaml',
|
||||||
|
state=module.monitor.State.START,
|
||||||
|
monitoring_log_level=1,
|
||||||
|
dry_run=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_ping_monitor_does_not_add_create_query_parameter_when_ping_url_is_uuid():
|
||||||
|
hook_config = {'ping_url': 'b3611b24-df9c-4d36-9203-fa292820bf2a', 'create_slug': True}
|
||||||
|
flexmock(module.requests).should_receive('post').with_args(
|
||||||
|
f"https://hc-ping.com/{hook_config['ping_url']}",
|
||||||
|
data=''.encode('utf-8'),
|
||||||
|
verify=True,
|
||||||
|
).and_return(flexmock(ok=True))
|
||||||
|
|
||||||
|
module.ping_monitor(
|
||||||
|
hook_config,
|
||||||
|
{},
|
||||||
|
'config.yaml',
|
||||||
|
state=module.monitor.State.FINISH,
|
||||||
|
monitoring_log_level=1,
|
||||||
|
dry_run=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_ping_monitor_issues_warning_when_ping_url_is_uuid_and_create_slug_true():
|
||||||
|
hook_config = {'ping_url': 'b3611b24-df9c-4d36-9203-fa292820bf2a', 'create_slug': True}
|
||||||
|
flexmock(module.logger).should_receive('warning').once()
|
||||||
|
|
||||||
|
module.ping_monitor(
|
||||||
|
hook_config,
|
||||||
|
{},
|
||||||
|
'config.yaml',
|
||||||
|
state=module.monitor.State.FINISH,
|
||||||
|
monitoring_log_level=1,
|
||||||
|
dry_run=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_ping_monitor_with_connection_error_logs_warning():
|
def test_ping_monitor_with_connection_error_logs_warning():
|
||||||
flexmock(module).should_receive('Forgetful_buffering_handler')
|
flexmock(module.borgmatic.hooks.logs).should_receive('Forgetful_buffering_handler').never()
|
||||||
hook_config = {'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(
|
||||||
'https://example.com/start', data=''.encode('utf-8'), verify=True
|
'https://example.com/start', data=''.encode('utf-8'), verify=True
|
||||||
|
@ -327,7 +349,7 @@ def test_ping_monitor_with_connection_error_logs_warning():
|
||||||
|
|
||||||
|
|
||||||
def test_ping_monitor_with_other_error_logs_warning():
|
def test_ping_monitor_with_other_error_logs_warning():
|
||||||
flexmock(module).should_receive('Forgetful_buffering_handler')
|
flexmock(module.borgmatic.hooks.logs).should_receive('Forgetful_buffering_handler').never()
|
||||||
hook_config = {'ping_url': 'https://example.com'}
|
hook_config = {'ping_url': 'https://example.com'}
|
||||||
response = flexmock(ok=False)
|
response = flexmock(ok=False)
|
||||||
response.should_receive('raise_for_status').and_raise(
|
response.should_receive('raise_for_status').and_raise(
|
||||||
|
|
|
@ -0,0 +1,103 @@
|
||||||
|
import pytest
|
||||||
|
from flexmock import flexmock
|
||||||
|
|
||||||
|
from borgmatic.hooks import logs as module
|
||||||
|
|
||||||
|
|
||||||
|
def test_forgetful_buffering_handler_emit_collects_log_records():
|
||||||
|
handler = module.Forgetful_buffering_handler(identifier='test', byte_capacity=100, 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_collects_log_records_with_zero_byte_capacity():
|
||||||
|
handler = module.Forgetful_buffering_handler(identifier='test', 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():
|
||||||
|
handler = module.Forgetful_buffering_handler(
|
||||||
|
identifier='test', byte_capacity=len('foo\nbar\n'), log_level=1
|
||||||
|
)
|
||||||
|
handler.emit(flexmock(getMessage=lambda: 'foo'))
|
||||||
|
assert handler.buffer == ['foo\n']
|
||||||
|
handler.emit(flexmock(getMessage=lambda: 'bar'))
|
||||||
|
assert handler.buffer == ['foo\n', 'bar\n']
|
||||||
|
handler.emit(flexmock(getMessage=lambda: 'baz'))
|
||||||
|
assert handler.buffer == ['bar\n', 'baz\n']
|
||||||
|
handler.emit(flexmock(getMessage=lambda: 'quux'))
|
||||||
|
assert handler.buffer == ['quux\n']
|
||||||
|
assert handler.forgot
|
||||||
|
|
||||||
|
|
||||||
|
def test_get_handler_matches_by_identifier():
|
||||||
|
handlers = [
|
||||||
|
flexmock(),
|
||||||
|
flexmock(),
|
||||||
|
module.Forgetful_buffering_handler(identifier='other', byte_capacity=100, log_level=1),
|
||||||
|
module.Forgetful_buffering_handler(identifier='test', byte_capacity=100, log_level=1),
|
||||||
|
flexmock(),
|
||||||
|
]
|
||||||
|
flexmock(module.logging.getLogger(), handlers=handlers)
|
||||||
|
|
||||||
|
assert module.get_handler('test') == handlers[3]
|
||||||
|
|
||||||
|
|
||||||
|
def test_get_handler_without_match_raises():
|
||||||
|
handlers = [
|
||||||
|
flexmock(),
|
||||||
|
module.Forgetful_buffering_handler(identifier='other', byte_capacity=100, log_level=1),
|
||||||
|
]
|
||||||
|
flexmock(module.logging.getLogger(), handlers=handlers)
|
||||||
|
|
||||||
|
with pytest.raises(ValueError):
|
||||||
|
assert module.get_handler('test')
|
||||||
|
|
||||||
|
|
||||||
|
def test_format_buffered_logs_for_payload_flattens_log_buffer():
|
||||||
|
handler = module.Forgetful_buffering_handler(identifier='test', byte_capacity=100, log_level=1)
|
||||||
|
handler.buffer = ['foo\n', 'bar\n']
|
||||||
|
flexmock(module).should_receive('get_handler').and_return(handler)
|
||||||
|
|
||||||
|
payload = module.format_buffered_logs_for_payload(identifier='test')
|
||||||
|
|
||||||
|
assert payload == 'foo\nbar\n'
|
||||||
|
|
||||||
|
|
||||||
|
def test_format_buffered_logs_for_payload_inserts_truncation_indicator_when_logs_forgotten():
|
||||||
|
handler = module.Forgetful_buffering_handler(identifier='test', byte_capacity=100, log_level=1)
|
||||||
|
handler.buffer = ['foo\n', 'bar\n']
|
||||||
|
handler.forgot = True
|
||||||
|
flexmock(module).should_receive('get_handler').and_return(handler)
|
||||||
|
|
||||||
|
payload = module.format_buffered_logs_for_payload(identifier='test')
|
||||||
|
|
||||||
|
assert payload == '...\nfoo\nbar\n'
|
||||||
|
|
||||||
|
|
||||||
|
def test_format_buffered_logs_for_payload_without_handler_produces_empty_payload():
|
||||||
|
flexmock(module).should_receive('get_handler').and_raise(ValueError)
|
||||||
|
|
||||||
|
payload = module.format_buffered_logs_for_payload(identifier='test')
|
||||||
|
|
||||||
|
assert payload == ''
|
||||||
|
|
||||||
|
|
||||||
|
def test_remove_handler_with_matching_handler_does_not_raise():
|
||||||
|
flexmock(module).should_receive('get_handler').and_return(flexmock())
|
||||||
|
flexmock(module.logging.getLogger()).should_receive('removeHandler')
|
||||||
|
|
||||||
|
module.remove_handler('test')
|
||||||
|
|
||||||
|
|
||||||
|
def test_remove_handler_without_matching_handler_does_not_raise():
|
||||||
|
flexmock(module).should_receive('get_handler').and_raise(ValueError)
|
||||||
|
|
||||||
|
module.remove_handler('test')
|
|
@ -44,6 +44,16 @@ def test_database_names_to_dump_queries_mariadb_for_database_names():
|
||||||
assert names == ('foo', 'bar')
|
assert names == ('foo', 'bar')
|
||||||
|
|
||||||
|
|
||||||
|
def test_use_streaming_true_for_any_databases():
|
||||||
|
assert module.use_streaming(
|
||||||
|
databases=[flexmock(), flexmock()], config=flexmock(), log_prefix=flexmock()
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_use_streaming_false_for_no_databases():
|
||||||
|
assert not module.use_streaming(databases=[], config=flexmock(), log_prefix=flexmock())
|
||||||
|
|
||||||
|
|
||||||
def test_dump_data_sources_dumps_each_database():
|
def test_dump_data_sources_dumps_each_database():
|
||||||
databases = [{'name': 'foo'}, {'name': 'bar'}]
|
databases = [{'name': 'foo'}, {'name': 'bar'}]
|
||||||
processes = [flexmock(), flexmock()]
|
processes = [flexmock(), flexmock()]
|
||||||
|
@ -142,6 +152,27 @@ def test_database_names_to_dump_runs_mariadb_with_list_options():
|
||||||
assert module.database_names_to_dump(database, None, 'test.yaml', '') == ('foo', 'bar')
|
assert module.database_names_to_dump(database, None, 'test.yaml', '') == ('foo', 'bar')
|
||||||
|
|
||||||
|
|
||||||
|
def test_database_names_to_dump_runs_non_default_mariadb_with_list_options():
|
||||||
|
database = {
|
||||||
|
'name': 'all',
|
||||||
|
'list_options': '--defaults-extra-file=mariadb.cnf',
|
||||||
|
'mariadb_command': 'custom_mariadb',
|
||||||
|
}
|
||||||
|
flexmock(module).should_receive('execute_command_and_capture_output').with_args(
|
||||||
|
extra_environment=None,
|
||||||
|
full_command=(
|
||||||
|
'custom_mariadb', # Custom MariaDB command
|
||||||
|
'--defaults-extra-file=mariadb.cnf',
|
||||||
|
'--skip-column-names',
|
||||||
|
'--batch',
|
||||||
|
'--execute',
|
||||||
|
'show schemas',
|
||||||
|
),
|
||||||
|
).and_return(('foo\nbar')).once()
|
||||||
|
|
||||||
|
assert module.database_names_to_dump(database, None, 'test.yaml', '') == ('foo', 'bar')
|
||||||
|
|
||||||
|
|
||||||
def test_execute_dump_command_runs_mariadb_dump():
|
def test_execute_dump_command_runs_mariadb_dump():
|
||||||
process = flexmock()
|
process = flexmock()
|
||||||
flexmock(module.dump).should_receive('make_data_source_dump_filename').and_return('dump')
|
flexmock(module.dump).should_receive('make_data_source_dump_filename').and_return('dump')
|
||||||
|
@ -315,6 +346,44 @@ def test_execute_dump_command_runs_mariadb_dump_with_options():
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_execute_dump_command_runs_non_default_mariadb_dump_with_options():
|
||||||
|
process = flexmock()
|
||||||
|
flexmock(module.dump).should_receive('make_data_source_dump_filename').and_return('dump')
|
||||||
|
flexmock(module.os.path).should_receive('exists').and_return(False)
|
||||||
|
flexmock(module.dump).should_receive('create_named_pipe_for_dump')
|
||||||
|
|
||||||
|
flexmock(module).should_receive('execute_command').with_args(
|
||||||
|
(
|
||||||
|
'custom_mariadb_dump', # Custom MariaDB dump command
|
||||||
|
'--stuff=such',
|
||||||
|
'--add-drop-database',
|
||||||
|
'--databases',
|
||||||
|
'foo',
|
||||||
|
'--result-file',
|
||||||
|
'dump',
|
||||||
|
),
|
||||||
|
extra_environment=None,
|
||||||
|
run_to_completion=False,
|
||||||
|
).and_return(process).once()
|
||||||
|
|
||||||
|
assert (
|
||||||
|
module.execute_dump_command(
|
||||||
|
database={
|
||||||
|
'name': 'foo',
|
||||||
|
'mariadb_dump_command': 'custom_mariadb_dump',
|
||||||
|
'options': '--stuff=such',
|
||||||
|
}, # Custom MariaDB dump command specified
|
||||||
|
log_prefix='log',
|
||||||
|
dump_path=flexmock(),
|
||||||
|
database_names=('foo',),
|
||||||
|
extra_environment=None,
|
||||||
|
dry_run=False,
|
||||||
|
dry_run_label='',
|
||||||
|
)
|
||||||
|
== process
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_execute_dump_command_with_duplicate_dump_skips_mariadb_dump():
|
def test_execute_dump_command_with_duplicate_dump_skips_mariadb_dump():
|
||||||
flexmock(module.dump).should_receive('make_data_source_dump_filename').and_return('dump')
|
flexmock(module.dump).should_receive('make_data_source_dump_filename').and_return('dump')
|
||||||
flexmock(module.os.path).should_receive('exists').and_return(True)
|
flexmock(module.os.path).should_receive('exists').and_return(True)
|
||||||
|
@ -435,6 +504,36 @@ def test_restore_data_source_dump_runs_mariadb_with_options():
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_restore_data_source_dump_runs_non_default_mariadb_with_options():
|
||||||
|
hook_config = [
|
||||||
|
{'name': 'foo', 'restore_options': '--harder', 'mariadb_command': 'custom_mariadb'}
|
||||||
|
]
|
||||||
|
extract_process = flexmock(stdout=flexmock())
|
||||||
|
|
||||||
|
flexmock(module).should_receive('execute_command_with_processes').with_args(
|
||||||
|
('custom_mariadb', '--batch', '--harder'),
|
||||||
|
processes=[extract_process],
|
||||||
|
output_log_level=logging.DEBUG,
|
||||||
|
input_file=extract_process.stdout,
|
||||||
|
extra_environment=None,
|
||||||
|
).once()
|
||||||
|
|
||||||
|
module.restore_data_source_dump(
|
||||||
|
hook_config,
|
||||||
|
{},
|
||||||
|
'test.yaml',
|
||||||
|
data_source=hook_config[0],
|
||||||
|
dry_run=False,
|
||||||
|
extract_process=extract_process,
|
||||||
|
connection_params={
|
||||||
|
'hostname': None,
|
||||||
|
'port': None,
|
||||||
|
'username': None,
|
||||||
|
'password': None,
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_restore_data_source_dump_runs_mariadb_with_hostname_and_port():
|
def test_restore_data_source_dump_runs_mariadb_with_hostname_and_port():
|
||||||
hook_config = [{'name': 'foo', 'hostname': 'database.example.org', 'port': 5433}]
|
hook_config = [{'name': 'foo', 'hostname': 'database.example.org', 'port': 5433}]
|
||||||
extract_process = flexmock(stdout=flexmock())
|
extract_process = flexmock(stdout=flexmock())
|
||||||
|
|
|
@ -5,6 +5,26 @@ from flexmock import flexmock
|
||||||
from borgmatic.hooks import mongodb as module
|
from borgmatic.hooks import mongodb as module
|
||||||
|
|
||||||
|
|
||||||
|
def test_use_streaming_true_for_any_non_directory_format_databases():
|
||||||
|
assert module.use_streaming(
|
||||||
|
databases=[{'format': 'stuff'}, {'format': 'directory'}, {}],
|
||||||
|
config=flexmock(),
|
||||||
|
log_prefix=flexmock(),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_use_streaming_false_for_all_directory_format_databases():
|
||||||
|
assert not module.use_streaming(
|
||||||
|
databases=[{'format': 'directory'}, {'format': 'directory'}],
|
||||||
|
config=flexmock(),
|
||||||
|
log_prefix=flexmock(),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_use_streaming_false_for_no_databases():
|
||||||
|
assert not module.use_streaming(databases=[], config=flexmock(), log_prefix=flexmock())
|
||||||
|
|
||||||
|
|
||||||
def test_dump_data_sources_runs_mongodump_for_each_database():
|
def test_dump_data_sources_runs_mongodump_for_each_database():
|
||||||
databases = [{'name': 'foo'}, {'name': 'bar'}]
|
databases = [{'name': 'foo'}, {'name': 'bar'}]
|
||||||
processes = [flexmock(), flexmock()]
|
processes = [flexmock(), flexmock()]
|
||||||
|
|
|
@ -44,6 +44,16 @@ def test_database_names_to_dump_queries_mysql_for_database_names():
|
||||||
assert names == ('foo', 'bar')
|
assert names == ('foo', 'bar')
|
||||||
|
|
||||||
|
|
||||||
|
def test_use_streaming_true_for_any_databases():
|
||||||
|
assert module.use_streaming(
|
||||||
|
databases=[flexmock(), flexmock()], config=flexmock(), log_prefix=flexmock()
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_use_streaming_false_for_no_databases():
|
||||||
|
assert not module.use_streaming(databases=[], config=flexmock(), log_prefix=flexmock())
|
||||||
|
|
||||||
|
|
||||||
def test_dump_data_sources_dumps_each_database():
|
def test_dump_data_sources_dumps_each_database():
|
||||||
databases = [{'name': 'foo'}, {'name': 'bar'}]
|
databases = [{'name': 'foo'}, {'name': 'bar'}]
|
||||||
processes = [flexmock(), flexmock()]
|
processes = [flexmock(), flexmock()]
|
||||||
|
@ -142,6 +152,27 @@ def test_database_names_to_dump_runs_mysql_with_list_options():
|
||||||
assert module.database_names_to_dump(database, None, 'test.yaml', '') == ('foo', 'bar')
|
assert module.database_names_to_dump(database, None, 'test.yaml', '') == ('foo', 'bar')
|
||||||
|
|
||||||
|
|
||||||
|
def test_database_names_to_dump_runs_non_default_mysql_with_list_options():
|
||||||
|
database = {
|
||||||
|
'name': 'all',
|
||||||
|
'list_options': '--defaults-extra-file=my.cnf',
|
||||||
|
'mysql_command': 'custom_mysql',
|
||||||
|
}
|
||||||
|
flexmock(module).should_receive('execute_command_and_capture_output').with_args(
|
||||||
|
extra_environment=None,
|
||||||
|
full_command=(
|
||||||
|
'custom_mysql', # Custom MySQL command
|
||||||
|
'--defaults-extra-file=my.cnf',
|
||||||
|
'--skip-column-names',
|
||||||
|
'--batch',
|
||||||
|
'--execute',
|
||||||
|
'show schemas',
|
||||||
|
),
|
||||||
|
).and_return(('foo\nbar')).once()
|
||||||
|
|
||||||
|
assert module.database_names_to_dump(database, None, 'test.yaml', '') == ('foo', 'bar')
|
||||||
|
|
||||||
|
|
||||||
def test_execute_dump_command_runs_mysqldump():
|
def test_execute_dump_command_runs_mysqldump():
|
||||||
process = flexmock()
|
process = flexmock()
|
||||||
flexmock(module.dump).should_receive('make_data_source_dump_filename').and_return('dump')
|
flexmock(module.dump).should_receive('make_data_source_dump_filename').and_return('dump')
|
||||||
|
@ -315,6 +346,42 @@ def test_execute_dump_command_runs_mysqldump_with_options():
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_execute_dump_command_runs_non_default_mysqldump():
|
||||||
|
process = flexmock()
|
||||||
|
flexmock(module.dump).should_receive('make_data_source_dump_filename').and_return('dump')
|
||||||
|
flexmock(module.os.path).should_receive('exists').and_return(False)
|
||||||
|
flexmock(module.dump).should_receive('create_named_pipe_for_dump')
|
||||||
|
|
||||||
|
flexmock(module).should_receive('execute_command').with_args(
|
||||||
|
(
|
||||||
|
'custom_mysqldump', # Custom MySQL dump command
|
||||||
|
'--add-drop-database',
|
||||||
|
'--databases',
|
||||||
|
'foo',
|
||||||
|
'--result-file',
|
||||||
|
'dump',
|
||||||
|
),
|
||||||
|
extra_environment=None,
|
||||||
|
run_to_completion=False,
|
||||||
|
).and_return(process).once()
|
||||||
|
|
||||||
|
assert (
|
||||||
|
module.execute_dump_command(
|
||||||
|
database={
|
||||||
|
'name': 'foo',
|
||||||
|
'mysql_dump_command': 'custom_mysqldump',
|
||||||
|
}, # Custom MySQL dump command specified
|
||||||
|
log_prefix='log',
|
||||||
|
dump_path=flexmock(),
|
||||||
|
database_names=('foo',),
|
||||||
|
extra_environment=None,
|
||||||
|
dry_run=False,
|
||||||
|
dry_run_label='',
|
||||||
|
)
|
||||||
|
== process
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_execute_dump_command_with_duplicate_dump_skips_mysqldump():
|
def test_execute_dump_command_with_duplicate_dump_skips_mysqldump():
|
||||||
flexmock(module.dump).should_receive('make_data_source_dump_filename').and_return('dump')
|
flexmock(module.dump).should_receive('make_data_source_dump_filename').and_return('dump')
|
||||||
flexmock(module.os.path).should_receive('exists').and_return(True)
|
flexmock(module.os.path).should_receive('exists').and_return(True)
|
||||||
|
@ -435,6 +502,34 @@ def test_restore_data_source_dump_runs_mysql_with_options():
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_restore_data_source_dump_runs_non_default_mysql_with_options():
|
||||||
|
hook_config = [{'name': 'foo', 'mysql_command': 'custom_mysql', 'restore_options': '--harder'}]
|
||||||
|
extract_process = flexmock(stdout=flexmock())
|
||||||
|
|
||||||
|
flexmock(module).should_receive('execute_command_with_processes').with_args(
|
||||||
|
('custom_mysql', '--batch', '--harder'),
|
||||||
|
processes=[extract_process],
|
||||||
|
output_log_level=logging.DEBUG,
|
||||||
|
input_file=extract_process.stdout,
|
||||||
|
extra_environment=None,
|
||||||
|
).once()
|
||||||
|
|
||||||
|
module.restore_data_source_dump(
|
||||||
|
hook_config,
|
||||||
|
{},
|
||||||
|
'test.yaml',
|
||||||
|
data_source=hook_config[0],
|
||||||
|
dry_run=False,
|
||||||
|
extract_process=extract_process,
|
||||||
|
connection_params={
|
||||||
|
'hostname': None,
|
||||||
|
'port': None,
|
||||||
|
'username': None,
|
||||||
|
'password': None,
|
||||||
|
},
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_restore_data_source_dump_runs_mysql_with_hostname_and_port():
|
def test_restore_data_source_dump_runs_mysql_with_hostname_and_port():
|
||||||
hook_config = [{'name': 'foo', 'hostname': 'database.example.org', 'port': 5433}]
|
hook_config = [{'name': 'foo', 'hostname': 'database.example.org', 'port': 5433}]
|
||||||
extract_process = flexmock(stdout=flexmock())
|
extract_process = flexmock(stdout=flexmock())
|
||||||
|
|
|
@ -52,7 +52,52 @@ def test_ping_monitor_minimal_config_hits_hosted_ntfy_on_fail():
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_ping_monitor_with_auth_hits_hosted_ntfy_on_fail():
|
def test_ping_monitor_with_access_token_hits_hosted_ntfy_on_fail():
|
||||||
|
hook_config = {
|
||||||
|
'topic': topic,
|
||||||
|
'access_token': 'abc123',
|
||||||
|
}
|
||||||
|
flexmock(module.requests).should_receive('post').with_args(
|
||||||
|
f'{default_base_url}/{topic}',
|
||||||
|
headers=return_default_message_headers(borgmatic.hooks.monitor.State.FAIL),
|
||||||
|
auth=module.requests.auth.HTTPBasicAuth('', 'abc123'),
|
||||||
|
).and_return(flexmock(ok=True)).once()
|
||||||
|
|
||||||
|
module.ping_monitor(
|
||||||
|
hook_config,
|
||||||
|
{},
|
||||||
|
'config.yaml',
|
||||||
|
borgmatic.hooks.monitor.State.FAIL,
|
||||||
|
monitoring_log_level=1,
|
||||||
|
dry_run=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_ping_monitor_with_username_password_and_access_token_ignores_username_password():
|
||||||
|
hook_config = {
|
||||||
|
'topic': topic,
|
||||||
|
'username': 'testuser',
|
||||||
|
'password': 'fakepassword',
|
||||||
|
'access_token': 'abc123',
|
||||||
|
}
|
||||||
|
flexmock(module.requests).should_receive('post').with_args(
|
||||||
|
f'{default_base_url}/{topic}',
|
||||||
|
headers=return_default_message_headers(borgmatic.hooks.monitor.State.FAIL),
|
||||||
|
auth=module.requests.auth.HTTPBasicAuth('', 'abc123'),
|
||||||
|
).and_return(flexmock(ok=True)).once()
|
||||||
|
flexmock(module.logger).should_receive('warning').once()
|
||||||
|
|
||||||
|
module.ping_monitor(
|
||||||
|
hook_config,
|
||||||
|
{},
|
||||||
|
'config.yaml',
|
||||||
|
borgmatic.hooks.monitor.State.FAIL,
|
||||||
|
monitoring_log_level=1,
|
||||||
|
dry_run=False,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_ping_monitor_with_username_password_hits_hosted_ntfy_on_fail():
|
||||||
hook_config = {
|
hook_config = {
|
||||||
'topic': topic,
|
'topic': topic,
|
||||||
'username': 'testuser',
|
'username': 'testuser',
|
||||||
|
@ -74,7 +119,7 @@ def test_ping_monitor_with_auth_hits_hosted_ntfy_on_fail():
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_ping_monitor_auth_with_no_username_warning():
|
def test_ping_monitor_with_password_but_no_username_warns():
|
||||||
hook_config = {'topic': topic, 'password': 'fakepassword'}
|
hook_config = {'topic': topic, 'password': 'fakepassword'}
|
||||||
flexmock(module.requests).should_receive('post').with_args(
|
flexmock(module.requests).should_receive('post').with_args(
|
||||||
f'{default_base_url}/{topic}',
|
f'{default_base_url}/{topic}',
|
||||||
|
@ -93,7 +138,7 @@ def test_ping_monitor_auth_with_no_username_warning():
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_ping_monitor_auth_with_no_password_warning():
|
def test_ping_monitor_with_username_but_no_password_warns():
|
||||||
hook_config = {'topic': topic, 'username': 'testuser'}
|
hook_config = {'topic': topic, 'username': 'testuser'}
|
||||||
flexmock(module.requests).should_receive('post').with_args(
|
flexmock(module.requests).should_receive('post').with_args(
|
||||||
f'{default_base_url}/{topic}',
|
f'{default_base_url}/{topic}',
|
||||||
|
|
|
@ -50,6 +50,14 @@ def test_make_extra_environment_without_cli_password_or_configured_password_does
|
||||||
assert 'PGPASSWORD' not in extra
|
assert 'PGPASSWORD' not in extra
|
||||||
|
|
||||||
|
|
||||||
|
def test_make_extra_environment_without_ssl_mode_does_not_set_ssl_mode():
|
||||||
|
database = {'name': 'foo'}
|
||||||
|
|
||||||
|
extra = module.make_extra_environment(database)
|
||||||
|
|
||||||
|
assert 'PGSSLMODE' not in extra
|
||||||
|
|
||||||
|
|
||||||
def test_database_names_to_dump_passes_through_individual_database_name():
|
def test_database_names_to_dump_passes_through_individual_database_name():
|
||||||
database = {'name': 'foo'}
|
database = {'name': 'foo'}
|
||||||
|
|
||||||
|
@ -164,11 +172,17 @@ def test_database_names_to_dump_with_all_and_format_excludes_particular_database
|
||||||
|
|
||||||
|
|
||||||
def test_database_names_to_dump_with_all_and_psql_command_uses_custom_command():
|
def test_database_names_to_dump_with_all_and_psql_command_uses_custom_command():
|
||||||
database = {'name': 'all', 'format': 'custom', 'psql_command': 'docker exec mycontainer psql'}
|
database = {
|
||||||
|
'name': 'all',
|
||||||
|
'format': 'custom',
|
||||||
|
'psql_command': 'docker exec --workdir * mycontainer psql',
|
||||||
|
}
|
||||||
flexmock(module).should_receive('execute_command_and_capture_output').with_args(
|
flexmock(module).should_receive('execute_command_and_capture_output').with_args(
|
||||||
(
|
(
|
||||||
'docker',
|
'docker',
|
||||||
'exec',
|
'exec',
|
||||||
|
'--workdir',
|
||||||
|
"'*'", # Should get shell escaped to prevent injection attacks.
|
||||||
'mycontainer',
|
'mycontainer',
|
||||||
'psql',
|
'psql',
|
||||||
'--list',
|
'--list',
|
||||||
|
@ -185,6 +199,26 @@ def test_database_names_to_dump_with_all_and_psql_command_uses_custom_command():
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_use_streaming_true_for_any_non_directory_format_databases():
|
||||||
|
assert module.use_streaming(
|
||||||
|
databases=[{'format': 'stuff'}, {'format': 'directory'}, {}],
|
||||||
|
config=flexmock(),
|
||||||
|
log_prefix=flexmock(),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_use_streaming_false_for_all_directory_format_databases():
|
||||||
|
assert not module.use_streaming(
|
||||||
|
databases=[{'format': 'directory'}, {'format': 'directory'}],
|
||||||
|
config=flexmock(),
|
||||||
|
log_prefix=flexmock(),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_use_streaming_false_for_no_databases():
|
||||||
|
assert not module.use_streaming(databases=[], config=flexmock(), log_prefix=flexmock())
|
||||||
|
|
||||||
|
|
||||||
def test_dump_data_sources_runs_pg_dump_for_each_database():
|
def test_dump_data_sources_runs_pg_dump_for_each_database():
|
||||||
databases = [{'name': 'foo'}, {'name': 'bar'}]
|
databases = [{'name': 'foo'}, {'name': 'bar'}]
|
||||||
processes = [flexmock(), flexmock()]
|
processes = [flexmock(), flexmock()]
|
||||||
|
@ -468,7 +502,7 @@ def test_dump_data_sources_runs_pg_dumpall_for_all_databases():
|
||||||
|
|
||||||
|
|
||||||
def test_dump_data_sources_runs_non_default_pg_dump():
|
def test_dump_data_sources_runs_non_default_pg_dump():
|
||||||
databases = [{'name': 'foo', 'pg_dump_command': 'special_pg_dump'}]
|
databases = [{'name': 'foo', 'pg_dump_command': 'special_pg_dump --compress *'}]
|
||||||
process = flexmock()
|
process = flexmock()
|
||||||
flexmock(module).should_receive('make_extra_environment').and_return({'PGSSLMODE': 'disable'})
|
flexmock(module).should_receive('make_extra_environment').and_return({'PGSSLMODE': 'disable'})
|
||||||
flexmock(module).should_receive('make_dump_path').and_return('')
|
flexmock(module).should_receive('make_dump_path').and_return('')
|
||||||
|
@ -482,6 +516,8 @@ def test_dump_data_sources_runs_non_default_pg_dump():
|
||||||
flexmock(module).should_receive('execute_command').with_args(
|
flexmock(module).should_receive('execute_command').with_args(
|
||||||
(
|
(
|
||||||
'special_pg_dump',
|
'special_pg_dump',
|
||||||
|
'--compress',
|
||||||
|
"'*'", # Should get shell escaped to prevent injection attacks.
|
||||||
'--no-password',
|
'--no-password',
|
||||||
'--clean',
|
'--clean',
|
||||||
'--if-exists',
|
'--if-exists',
|
||||||
|
@ -979,8 +1015,8 @@ def test_restore_data_source_dump_runs_non_default_pg_restore_and_psql():
|
||||||
hook_config = [
|
hook_config = [
|
||||||
{
|
{
|
||||||
'name': 'foo',
|
'name': 'foo',
|
||||||
'pg_restore_command': 'docker exec mycontainer pg_restore',
|
'pg_restore_command': 'docker exec --workdir * mycontainer pg_restore',
|
||||||
'psql_command': 'docker exec mycontainer psql',
|
'psql_command': 'docker exec --workdir * mycontainer psql',
|
||||||
'schemas': None,
|
'schemas': None,
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
|
@ -993,6 +1029,8 @@ def test_restore_data_source_dump_runs_non_default_pg_restore_and_psql():
|
||||||
(
|
(
|
||||||
'docker',
|
'docker',
|
||||||
'exec',
|
'exec',
|
||||||
|
'--workdir',
|
||||||
|
"'*'", # Should get shell escaped to prevent injection attacks.
|
||||||
'mycontainer',
|
'mycontainer',
|
||||||
'pg_restore',
|
'pg_restore',
|
||||||
'--no-password',
|
'--no-password',
|
||||||
|
@ -1011,6 +1049,8 @@ def test_restore_data_source_dump_runs_non_default_pg_restore_and_psql():
|
||||||
(
|
(
|
||||||
'docker',
|
'docker',
|
||||||
'exec',
|
'exec',
|
||||||
|
'--workdir',
|
||||||
|
"'*'", # Should get shell escaped to prevent injection attacks.
|
||||||
'mycontainer',
|
'mycontainer',
|
||||||
'psql',
|
'psql',
|
||||||
'--no-password',
|
'--no-password',
|
||||||
|
|
|
@ -5,6 +5,16 @@ from flexmock import flexmock
|
||||||
from borgmatic.hooks import sqlite as module
|
from borgmatic.hooks import sqlite as module
|
||||||
|
|
||||||
|
|
||||||
|
def test_use_streaming_true_for_any_databases():
|
||||||
|
assert module.use_streaming(
|
||||||
|
databases=[flexmock(), flexmock()], config=flexmock(), log_prefix=flexmock()
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_use_streaming_false_for_no_databases():
|
||||||
|
assert not module.use_streaming(databases=[], config=flexmock(), log_prefix=flexmock())
|
||||||
|
|
||||||
|
|
||||||
def test_dump_data_sources_logs_and_skips_if_dump_already_exists():
|
def test_dump_data_sources_logs_and_skips_if_dump_already_exists():
|
||||||
databases = [{'path': '/path/to/database', 'name': 'database'}]
|
databases = [{'path': '/path/to/database', 'name': 'database'}]
|
||||||
|
|
||||||
|
|
|
@ -117,12 +117,37 @@ def test_append_last_lines_with_output_log_level_none_appends_captured_output():
|
||||||
assert captured_output == ['captured', 'line']
|
assert captured_output == ['captured', 'line']
|
||||||
|
|
||||||
|
|
||||||
|
def test_mask_command_secrets_masks_password_flag_value():
|
||||||
|
assert module.mask_command_secrets(('cooldb', '--username', 'bob', '--password', 'pass')) == (
|
||||||
|
'cooldb',
|
||||||
|
'--username',
|
||||||
|
'bob',
|
||||||
|
'--password',
|
||||||
|
'***',
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
|
def test_mask_command_secrets_passes_through_other_commands():
|
||||||
|
assert module.mask_command_secrets(('cooldb', '--username', 'bob')) == (
|
||||||
|
'cooldb',
|
||||||
|
'--username',
|
||||||
|
'bob',
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
@pytest.mark.parametrize(
|
@pytest.mark.parametrize(
|
||||||
'full_command,input_file,output_file,environment,expected_result',
|
'full_command,input_file,output_file,environment,expected_result',
|
||||||
(
|
(
|
||||||
(('foo', 'bar'), None, None, None, 'foo bar'),
|
(('foo', 'bar'), None, None, None, 'foo bar'),
|
||||||
(('foo', 'bar'), flexmock(name='input'), None, None, 'foo bar < input'),
|
(('foo', 'bar'), flexmock(name='input'), None, None, 'foo bar < input'),
|
||||||
(('foo', 'bar'), None, flexmock(name='output'), None, 'foo bar > output'),
|
(('foo', 'bar'), None, flexmock(name='output'), None, 'foo bar > output'),
|
||||||
|
(
|
||||||
|
('A',) * module.MAX_LOGGED_COMMAND_LENGTH,
|
||||||
|
None,
|
||||||
|
None,
|
||||||
|
None,
|
||||||
|
'A ' * (module.MAX_LOGGED_COMMAND_LENGTH // 2 - 2) + '...',
|
||||||
|
),
|
||||||
(
|
(
|
||||||
('foo', 'bar'),
|
('foo', 'bar'),
|
||||||
flexmock(name='input'),
|
flexmock(name='input'),
|
||||||
|
@ -142,6 +167,7 @@ def test_append_last_lines_with_output_log_level_none_appends_captured_output():
|
||||||
def test_log_command_logs_command_constructed_from_arguments(
|
def test_log_command_logs_command_constructed_from_arguments(
|
||||||
full_command, input_file, output_file, environment, expected_result
|
full_command, input_file, output_file, environment, expected_result
|
||||||
):
|
):
|
||||||
|
flexmock(module).should_receive('mask_command_secrets').replace_with(lambda command: command)
|
||||||
flexmock(module.logger).should_receive('debug').with_args(expected_result).once()
|
flexmock(module.logger).should_receive('debug').with_args(expected_result).once()
|
||||||
|
|
||||||
module.log_command(full_command, input_file, output_file, environment)
|
module.log_command(full_command, input_file, output_file, environment)
|
||||||
|
|
|
@ -69,7 +69,11 @@ def test_should_do_markup_prefers_any_false_config_value():
|
||||||
|
|
||||||
|
|
||||||
def test_should_do_markup_respects_PY_COLORS_environment_variable():
|
def test_should_do_markup_respects_PY_COLORS_environment_variable():
|
||||||
flexmock(module.os.environ).should_receive('get').and_return('True')
|
flexmock(module.os.environ).should_receive('get').with_args('PY_COLORS', None).and_return(
|
||||||
|
'True'
|
||||||
|
)
|
||||||
|
flexmock(module.os.environ).should_receive('get').with_args('NO_COLOR', None).and_return(None)
|
||||||
|
|
||||||
flexmock(module).should_receive('to_bool').and_return(True)
|
flexmock(module).should_receive('to_bool').and_return(True)
|
||||||
|
|
||||||
assert module.should_do_markup(no_color=False, configs={}) is True
|
assert module.should_do_markup(no_color=False, configs={}) is True
|
||||||
|
@ -82,7 +86,7 @@ def test_should_do_markup_prefers_no_color_value_to_config_value():
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_should_do_markup_prefers_config_value_to_PY_COLORS():
|
def test_should_do_markup_prefers_config_value_to_environment_variables():
|
||||||
flexmock(module.os.environ).should_receive('get').and_return('True')
|
flexmock(module.os.environ).should_receive('get').and_return('True')
|
||||||
flexmock(module).should_receive('to_bool').and_return(True)
|
flexmock(module).should_receive('to_bool').and_return(True)
|
||||||
|
|
||||||
|
@ -92,7 +96,7 @@ def test_should_do_markup_prefers_config_value_to_PY_COLORS():
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
def test_should_do_markup_prefers_no_color_value_to_PY_COLORS():
|
def test_should_do_markup_prefers_no_color_value_to_environment_variables():
|
||||||
flexmock(module.os.environ).should_receive('get').and_return('True')
|
flexmock(module.os.environ).should_receive('get').and_return('True')
|
||||||
flexmock(module).should_receive('to_bool').and_return(True)
|
flexmock(module).should_receive('to_bool').and_return(True)
|
||||||
|
|
||||||
|
@ -107,13 +111,49 @@ def test_should_do_markup_respects_interactive_console_value():
|
||||||
|
|
||||||
|
|
||||||
def test_should_do_markup_prefers_PY_COLORS_to_interactive_console_value():
|
def test_should_do_markup_prefers_PY_COLORS_to_interactive_console_value():
|
||||||
flexmock(module.os.environ).should_receive('get').and_return('True')
|
flexmock(module.os.environ).should_receive('get').with_args('PY_COLORS', None).and_return(
|
||||||
|
'True'
|
||||||
|
)
|
||||||
|
flexmock(module.os.environ).should_receive('get').with_args('NO_COLOR', None).and_return(None)
|
||||||
flexmock(module).should_receive('to_bool').and_return(True)
|
flexmock(module).should_receive('to_bool').and_return(True)
|
||||||
flexmock(module).should_receive('interactive_console').and_return(False)
|
flexmock(module).should_receive('interactive_console').never()
|
||||||
|
|
||||||
assert module.should_do_markup(no_color=False, configs={}) is True
|
assert module.should_do_markup(no_color=False, configs={}) is True
|
||||||
|
|
||||||
|
|
||||||
|
def test_should_do_markup_prefers_NO_COLOR_to_interactive_console_value():
|
||||||
|
flexmock(module.os.environ).should_receive('get').with_args('PY_COLORS', None).and_return(None)
|
||||||
|
flexmock(module.os.environ).should_receive('get').with_args('NO_COLOR', None).and_return('True')
|
||||||
|
|
||||||
|
assert module.should_do_markup(no_color=False, configs={}) is False
|
||||||
|
|
||||||
|
|
||||||
|
def test_should_do_markup_respects_NO_COLOR_environment_variable():
|
||||||
|
flexmock(module.os.environ).should_receive('get').with_args('NO_COLOR', None).and_return('True')
|
||||||
|
flexmock(module.os.environ).should_receive('get').with_args('PY_COLORS', None).and_return(None)
|
||||||
|
|
||||||
|
assert module.should_do_markup(no_color=False, configs={}) is False
|
||||||
|
|
||||||
|
|
||||||
|
def test_should_do_markup_ignores_empty_NO_COLOR_environment_variable():
|
||||||
|
flexmock(module.os.environ).should_receive('get').with_args('NO_COLOR', None).and_return('')
|
||||||
|
flexmock(module.os.environ).should_receive('get').with_args('PY_COLORS', None).and_return(None)
|
||||||
|
flexmock(module).should_receive('interactive_console').and_return(True)
|
||||||
|
|
||||||
|
assert module.should_do_markup(no_color=False, configs={}) is True
|
||||||
|
|
||||||
|
|
||||||
|
def test_should_do_markup_prefers_NO_COLOR_to_PY_COLORS():
|
||||||
|
flexmock(module.os.environ).should_receive('get').with_args('PY_COLORS', None).and_return(
|
||||||
|
'True'
|
||||||
|
)
|
||||||
|
flexmock(module.os.environ).should_receive('get').with_args('NO_COLOR', None).and_return(
|
||||||
|
'SomeValue'
|
||||||
|
)
|
||||||
|
|
||||||
|
assert module.should_do_markup(no_color=False, configs={}) is False
|
||||||
|
|
||||||
|
|
||||||
def test_multi_stream_handler_logs_to_handler_for_log_level():
|
def test_multi_stream_handler_logs_to_handler_for_log_level():
|
||||||
error_handler = flexmock()
|
error_handler = flexmock()
|
||||||
error_handler.should_receive('emit').once()
|
error_handler.should_receive('emit').once()
|
||||||
|
@ -177,11 +217,9 @@ def test_add_logging_level_skips_global_setting_if_already_set():
|
||||||
def test_configure_logging_with_syslog_log_level_probes_for_log_socket_on_linux():
|
def test_configure_logging_with_syslog_log_level_probes_for_log_socket_on_linux():
|
||||||
flexmock(module).should_receive('add_custom_log_levels')
|
flexmock(module).should_receive('add_custom_log_levels')
|
||||||
flexmock(module.logging).ANSWER = module.ANSWER
|
flexmock(module.logging).ANSWER = module.ANSWER
|
||||||
flexmock(module).should_receive('Multi_stream_handler').and_return(
|
multi_stream_handler = flexmock(setLevel=lambda level: None, level=logging.INFO)
|
||||||
flexmock(
|
multi_stream_handler.should_receive('setFormatter').once()
|
||||||
setFormatter=lambda formatter: None, setLevel=lambda level: None, level=logging.INFO
|
flexmock(module).should_receive('Multi_stream_handler').and_return(multi_stream_handler)
|
||||||
)
|
|
||||||
)
|
|
||||||
flexmock(module).should_receive('Console_color_formatter')
|
flexmock(module).should_receive('Console_color_formatter')
|
||||||
flexmock(module).should_receive('interactive_console').and_return(False)
|
flexmock(module).should_receive('interactive_console').and_return(False)
|
||||||
flexmock(module.logging).should_receive('basicConfig').with_args(
|
flexmock(module.logging).should_receive('basicConfig').with_args(
|
||||||
|
@ -199,11 +237,9 @@ def test_configure_logging_with_syslog_log_level_probes_for_log_socket_on_linux(
|
||||||
def test_configure_logging_with_syslog_log_level_probes_for_log_socket_on_macos():
|
def test_configure_logging_with_syslog_log_level_probes_for_log_socket_on_macos():
|
||||||
flexmock(module).should_receive('add_custom_log_levels')
|
flexmock(module).should_receive('add_custom_log_levels')
|
||||||
flexmock(module.logging).ANSWER = module.ANSWER
|
flexmock(module.logging).ANSWER = module.ANSWER
|
||||||
flexmock(module).should_receive('Multi_stream_handler').and_return(
|
multi_stream_handler = flexmock(setLevel=lambda level: None, level=logging.INFO)
|
||||||
flexmock(
|
multi_stream_handler.should_receive('setFormatter').once()
|
||||||
setFormatter=lambda formatter: None, setLevel=lambda level: None, level=logging.INFO
|
flexmock(module).should_receive('Multi_stream_handler').and_return(multi_stream_handler)
|
||||||
)
|
|
||||||
)
|
|
||||||
flexmock(module).should_receive('Console_color_formatter')
|
flexmock(module).should_receive('Console_color_formatter')
|
||||||
flexmock(module).should_receive('interactive_console').and_return(False)
|
flexmock(module).should_receive('interactive_console').and_return(False)
|
||||||
flexmock(module.logging).should_receive('basicConfig').with_args(
|
flexmock(module.logging).should_receive('basicConfig').with_args(
|
||||||
|
@ -222,11 +258,9 @@ def test_configure_logging_with_syslog_log_level_probes_for_log_socket_on_macos(
|
||||||
def test_configure_logging_with_syslog_log_level_probes_for_log_socket_on_freebsd():
|
def test_configure_logging_with_syslog_log_level_probes_for_log_socket_on_freebsd():
|
||||||
flexmock(module).should_receive('add_custom_log_levels')
|
flexmock(module).should_receive('add_custom_log_levels')
|
||||||
flexmock(module.logging).ANSWER = module.ANSWER
|
flexmock(module.logging).ANSWER = module.ANSWER
|
||||||
flexmock(module).should_receive('Multi_stream_handler').and_return(
|
multi_stream_handler = flexmock(setLevel=lambda level: None, level=logging.INFO)
|
||||||
flexmock(
|
multi_stream_handler.should_receive('setFormatter').once()
|
||||||
setFormatter=lambda formatter: None, setLevel=lambda level: None, level=logging.INFO
|
flexmock(module).should_receive('Multi_stream_handler').and_return(multi_stream_handler)
|
||||||
)
|
|
||||||
)
|
|
||||||
flexmock(module).should_receive('Console_color_formatter')
|
flexmock(module).should_receive('Console_color_formatter')
|
||||||
flexmock(module).should_receive('interactive_console').and_return(False)
|
flexmock(module).should_receive('interactive_console').and_return(False)
|
||||||
flexmock(module.logging).should_receive('basicConfig').with_args(
|
flexmock(module.logging).should_receive('basicConfig').with_args(
|
||||||
|
@ -246,11 +280,9 @@ def test_configure_logging_with_syslog_log_level_probes_for_log_socket_on_freebs
|
||||||
def test_configure_logging_without_syslog_log_level_skips_syslog():
|
def test_configure_logging_without_syslog_log_level_skips_syslog():
|
||||||
flexmock(module).should_receive('add_custom_log_levels')
|
flexmock(module).should_receive('add_custom_log_levels')
|
||||||
flexmock(module.logging).ANSWER = module.ANSWER
|
flexmock(module.logging).ANSWER = module.ANSWER
|
||||||
flexmock(module).should_receive('Multi_stream_handler').and_return(
|
multi_stream_handler = flexmock(setLevel=lambda level: None, level=logging.INFO)
|
||||||
flexmock(
|
multi_stream_handler.should_receive('setFormatter').once()
|
||||||
setFormatter=lambda formatter: None, setLevel=lambda level: None, level=logging.INFO
|
flexmock(module).should_receive('Multi_stream_handler').and_return(multi_stream_handler)
|
||||||
)
|
|
||||||
)
|
|
||||||
flexmock(module).should_receive('Console_color_formatter')
|
flexmock(module).should_receive('Console_color_formatter')
|
||||||
flexmock(module.logging).should_receive('basicConfig').with_args(
|
flexmock(module.logging).should_receive('basicConfig').with_args(
|
||||||
level=logging.INFO, handlers=list
|
level=logging.INFO, handlers=list
|
||||||
|
@ -264,11 +296,9 @@ def test_configure_logging_without_syslog_log_level_skips_syslog():
|
||||||
def test_configure_logging_skips_syslog_if_not_found():
|
def test_configure_logging_skips_syslog_if_not_found():
|
||||||
flexmock(module).should_receive('add_custom_log_levels')
|
flexmock(module).should_receive('add_custom_log_levels')
|
||||||
flexmock(module.logging).ANSWER = module.ANSWER
|
flexmock(module.logging).ANSWER = module.ANSWER
|
||||||
flexmock(module).should_receive('Multi_stream_handler').and_return(
|
multi_stream_handler = flexmock(setLevel=lambda level: None, level=logging.INFO)
|
||||||
flexmock(
|
multi_stream_handler.should_receive('setFormatter').once()
|
||||||
setFormatter=lambda formatter: None, setLevel=lambda level: None, level=logging.INFO
|
flexmock(module).should_receive('Multi_stream_handler').and_return(multi_stream_handler)
|
||||||
)
|
|
||||||
)
|
|
||||||
flexmock(module).should_receive('Console_color_formatter')
|
flexmock(module).should_receive('Console_color_formatter')
|
||||||
flexmock(module.logging).should_receive('basicConfig').with_args(
|
flexmock(module.logging).should_receive('basicConfig').with_args(
|
||||||
level=logging.INFO, handlers=list
|
level=logging.INFO, handlers=list
|
||||||
|
@ -282,11 +312,9 @@ def test_configure_logging_skips_syslog_if_not_found():
|
||||||
def test_configure_logging_skips_log_file_if_log_file_logging_is_disabled():
|
def test_configure_logging_skips_log_file_if_log_file_logging_is_disabled():
|
||||||
flexmock(module).should_receive('add_custom_log_levels')
|
flexmock(module).should_receive('add_custom_log_levels')
|
||||||
flexmock(module.logging).DISABLED = module.DISABLED
|
flexmock(module.logging).DISABLED = module.DISABLED
|
||||||
flexmock(module).should_receive('Multi_stream_handler').and_return(
|
multi_stream_handler = flexmock(setLevel=lambda level: None, level=logging.INFO)
|
||||||
flexmock(
|
multi_stream_handler.should_receive('setFormatter').once()
|
||||||
setFormatter=lambda formatter: None, setLevel=lambda level: None, level=logging.INFO
|
flexmock(module).should_receive('Multi_stream_handler').and_return(multi_stream_handler)
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
flexmock(module.logging).should_receive('basicConfig').with_args(
|
flexmock(module.logging).should_receive('basicConfig').with_args(
|
||||||
level=logging.INFO, handlers=list
|
level=logging.INFO, handlers=list
|
||||||
|
@ -303,11 +331,9 @@ def test_configure_logging_skips_log_file_if_log_file_logging_is_disabled():
|
||||||
def test_configure_logging_to_log_file_instead_of_syslog():
|
def test_configure_logging_to_log_file_instead_of_syslog():
|
||||||
flexmock(module).should_receive('add_custom_log_levels')
|
flexmock(module).should_receive('add_custom_log_levels')
|
||||||
flexmock(module.logging).ANSWER = module.ANSWER
|
flexmock(module.logging).ANSWER = module.ANSWER
|
||||||
flexmock(module).should_receive('Multi_stream_handler').and_return(
|
multi_stream_handler = flexmock(setLevel=lambda level: None, level=logging.INFO)
|
||||||
flexmock(
|
multi_stream_handler.should_receive('setFormatter').once()
|
||||||
setFormatter=lambda formatter: None, setLevel=lambda level: None, level=logging.INFO
|
flexmock(module).should_receive('Multi_stream_handler').and_return(multi_stream_handler)
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
flexmock(module.logging).should_receive('basicConfig').with_args(
|
flexmock(module.logging).should_receive('basicConfig').with_args(
|
||||||
level=logging.DEBUG, handlers=list
|
level=logging.DEBUG, handlers=list
|
||||||
|
@ -330,11 +356,9 @@ def test_configure_logging_to_log_file_instead_of_syslog():
|
||||||
def test_configure_logging_to_both_log_file_and_syslog():
|
def test_configure_logging_to_both_log_file_and_syslog():
|
||||||
flexmock(module).should_receive('add_custom_log_levels')
|
flexmock(module).should_receive('add_custom_log_levels')
|
||||||
flexmock(module.logging).ANSWER = module.ANSWER
|
flexmock(module.logging).ANSWER = module.ANSWER
|
||||||
flexmock(module).should_receive('Multi_stream_handler').and_return(
|
multi_stream_handler = flexmock(setLevel=lambda level: None, level=logging.INFO)
|
||||||
flexmock(
|
multi_stream_handler.should_receive('setFormatter').once()
|
||||||
setFormatter=lambda formatter: None, setLevel=lambda level: None, level=logging.INFO
|
flexmock(module).should_receive('Multi_stream_handler').and_return(multi_stream_handler)
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
flexmock(module.logging).should_receive('basicConfig').with_args(
|
flexmock(module.logging).should_receive('basicConfig').with_args(
|
||||||
level=logging.DEBUG, handlers=list
|
level=logging.DEBUG, handlers=list
|
||||||
|
@ -363,11 +387,9 @@ def test_configure_logging_to_log_file_formats_with_custom_log_format():
|
||||||
flexmock(module.logging).should_receive('Formatter').with_args(
|
flexmock(module.logging).should_receive('Formatter').with_args(
|
||||||
'{message}', style='{' # noqa: FS003
|
'{message}', style='{' # noqa: FS003
|
||||||
).once()
|
).once()
|
||||||
flexmock(module).should_receive('Multi_stream_handler').and_return(
|
multi_stream_handler = flexmock(setLevel=lambda level: None, level=logging.INFO)
|
||||||
flexmock(
|
multi_stream_handler.should_receive('setFormatter').once()
|
||||||
setFormatter=lambda formatter: None, setLevel=lambda level: None, level=logging.INFO
|
flexmock(module).should_receive('Multi_stream_handler').and_return(multi_stream_handler)
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
flexmock(module).should_receive('interactive_console').and_return(False)
|
flexmock(module).should_receive('interactive_console').and_return(False)
|
||||||
flexmock(module.logging).should_receive('basicConfig').with_args(
|
flexmock(module.logging).should_receive('basicConfig').with_args(
|
||||||
|
@ -391,11 +413,9 @@ def test_configure_logging_to_log_file_formats_with_custom_log_format():
|
||||||
def test_configure_logging_skips_log_file_if_argument_is_none():
|
def test_configure_logging_skips_log_file_if_argument_is_none():
|
||||||
flexmock(module).should_receive('add_custom_log_levels')
|
flexmock(module).should_receive('add_custom_log_levels')
|
||||||
flexmock(module.logging).ANSWER = module.ANSWER
|
flexmock(module.logging).ANSWER = module.ANSWER
|
||||||
flexmock(module).should_receive('Multi_stream_handler').and_return(
|
multi_stream_handler = flexmock(setLevel=lambda level: None, level=logging.INFO)
|
||||||
flexmock(
|
multi_stream_handler.should_receive('setFormatter').once()
|
||||||
setFormatter=lambda formatter: None, setLevel=lambda level: None, level=logging.INFO
|
flexmock(module).should_receive('Multi_stream_handler').and_return(multi_stream_handler)
|
||||||
)
|
|
||||||
)
|
|
||||||
|
|
||||||
flexmock(module.logging).should_receive('basicConfig').with_args(
|
flexmock(module.logging).should_receive('basicConfig').with_args(
|
||||||
level=logging.INFO, handlers=list
|
level=logging.INFO, handlers=list
|
||||||
|
@ -404,3 +424,19 @@ def test_configure_logging_skips_log_file_if_argument_is_none():
|
||||||
flexmock(module.logging.handlers).should_receive('WatchedFileHandler').never()
|
flexmock(module.logging.handlers).should_receive('WatchedFileHandler').never()
|
||||||
|
|
||||||
module.configure_logging(console_log_level=logging.INFO, log_file=None)
|
module.configure_logging(console_log_level=logging.INFO, log_file=None)
|
||||||
|
|
||||||
|
|
||||||
|
def test_configure_logging_skips_console_color_formatter_if_color_disabled():
|
||||||
|
flexmock(module).should_receive('add_custom_log_levels')
|
||||||
|
flexmock(module.logging).ANSWER = module.ANSWER
|
||||||
|
multi_stream_handler = flexmock(setLevel=lambda level: None, level=logging.INFO)
|
||||||
|
multi_stream_handler.should_receive('setFormatter').never()
|
||||||
|
flexmock(module).should_receive('Multi_stream_handler').and_return(multi_stream_handler)
|
||||||
|
|
||||||
|
flexmock(module.logging).should_receive('basicConfig').with_args(
|
||||||
|
level=logging.INFO, handlers=list
|
||||||
|
)
|
||||||
|
flexmock(module.os.path).should_receive('exists').and_return(False)
|
||||||
|
flexmock(module.logging.handlers).should_receive('WatchedFileHandler').never()
|
||||||
|
|
||||||
|
module.configure_logging(console_log_level=logging.INFO, log_file=None, color_enabled=False)
|
||||||
|
|
Loading…
Reference in New Issue