Add borgmatic --version command-line flag to get the current installed version number.

NEWS

@@ -1,3 +1,10 @@
+1.2.14
+ * #103: When generating sample configuration with generate-borgmatic-config, document the defaults
+   for each option.
+ * #116: When running multiple configuration files, attempt all configuration files even if one of
+   them errors. Log a summary of results at the end.
+ * Add borgmatic --version command-line flag to get the current installed version number.
+
 1.2.13
  * #100: Support for --stats command-line flag independent of --verbosity.
  * #117: With borgmatic --init command-line flag, proceed without erroring if a repository already

borgmatic/commands/borgmatic.py

@@ -5,6 +5,8 @@ import os
 from subprocess import CalledProcessError
 import sys
 
+import pkg_resources
+
 from borgmatic.borg import (
     check as borg_check,
     create as borg_create,
@@ -29,7 +31,7 @@ LEGACY_CONFIG_PATH = '/etc/borgmatic/config'
 def parse_arguments(*arguments):
     '''
     Given command-line arguments with which this script was invoked, parse the arguments and return
-    them as an ArgumentParser instance.
+    them as an argparse.ArgumentParser instance.
     '''
     config_paths = collect.get_default_config_paths()
 
@@ -136,6 +138,13 @@ def parse_arguments(*arguments):
         default=0,
         help='Display verbose progress (1 for some, 2 for lots)',
     )
+    parser.add_argument(
+        '--version',
+        dest='version',
+        default=False,
+        action='store_true',
+        help='Display installed version number of borgmatic and exit',
+    )
 
     args = parser.parse_args(arguments)
 
@@ -308,25 +317,57 @@ def _run_commands_on_repository(
             sys.stdout.write(output)
 
 
-def main():  # pragma: no cover
-    try:
-        configure_signals()
-        args = parse_arguments(*sys.argv[1:])
-        logging.basicConfig(level=verbosity_to_log_level(args.verbosity), format='%(message)s')
-
-        config_filenames = tuple(collect.collect_config_filenames(args.config_paths))
-        logger.debug('Ensuring legacy configuration is upgraded')
-        convert.guard_configuration_upgraded(LEGACY_CONFIG_PATH, config_filenames)
-
-        if len(config_filenames) == 0:
-            raise ValueError(
-                'Error: No configuration files found in: {}'.format(' '.join(args.config_paths))
-            )
-
-        for config_filename in config_filenames:
+def collect_configuration_run_summary_logs(config_filenames, args):
+    '''
+    Given a sequence of configuration filenames and parsed command-line arguments as an
+    argparse.ArgumentParser instance, run each configuration file and yield a series of
+    logging.LogRecord instances containing summary information about each run.
+    '''
+    for config_filename in config_filenames:
+        try:
             run_configuration(config_filename, args)
-    except (ValueError, OSError, CalledProcessError) as error:
-        print(error, file=sys.stderr)
-        print(file=sys.stderr)
-        print('Need some help? https://torsion.org/borgmatic/#issues', file=sys.stderr)
+            yield logging.makeLogRecord(
+                dict(
+                    levelno=logging.INFO,
+                    msg='{}: Successfully ran configuration file'.format(config_filename),
+                )
+            )
+        except (ValueError, OSError, CalledProcessError) as error:
+            yield logging.makeLogRecord(
+                dict(
+                    levelno=logging.CRITICAL,
+                    msg='{}: Error running configuration file'.format(config_filename),
+                )
+            )
+            yield logging.makeLogRecord(dict(levelno=logging.CRITICAL, msg=error))
+
+    if not config_filenames:
+        yield logging.makeLogRecord(
+            dict(
+                levelno=logging.CRITICAL,
+                msg='{}: No configuration files found'.format(' '.join(args.config_paths)),
+            )
+        )
+
+
+def main():  # pragma: no cover
+    configure_signals()
+    args = parse_arguments(*sys.argv[1:])
+    logging.basicConfig(level=verbosity_to_log_level(args.verbosity), format='%(message)s')
+
+    if args.version:
+        print(pkg_resources.require('borgmatic')[0].version)
+        sys.exit(0)
+
+    config_filenames = tuple(collect.collect_config_filenames(args.config_paths))
+    logger.debug('Ensuring legacy configuration is upgraded')
+    convert.guard_configuration_upgraded(LEGACY_CONFIG_PATH, config_filenames)
+
+    summary_logs = tuple(collect_configuration_run_summary_logs(config_filenames, args))
+
+    logger.info('\nsummary:')
+    [logger.handle(log) for log in summary_logs if log.levelno >= logger.getEffectiveLevel()]
+
+    if any(log.levelno == logging.CRITICAL for log in summary_logs):
+        logger.critical('\nNeed some help? https://torsion.org/borgmatic/#issues')
         sys.exit(1)

borgmatic/config/schema.yaml

@@ -30,14 +30,14 @@ map:
                     - user@backupserver:sourcehostname.borg
             one_file_system:
                 type: bool
-                desc: Stay in same file system (do not cross mount points).
+                desc: Stay in same file system (do not cross mount points). Defaults to false.
                 example: true
             read_special:
                 type: bool
                 desc: |
                     Use Borg's --read-special flag to allow backup of block and other special
                     devices. Use with caution, as it will lead to problems if used when
-                    backing up special devices such as /dev/zero.
+                    backing up special devices such as /dev/zero. Defaults to false.
                 example: false
             bsd_flags:
                 type: bool
@@ -48,7 +48,7 @@ map:
                 desc: |
                     Mode in which to operate the files cache. See
                     https://borgbackup.readthedocs.io/en/stable/usage/create.html#description for
-                    details.
+                    details. Defaults to "ctime,size,inode".
                 example: ctime,size,inode
             local_path:
                 type: scalar
@@ -102,11 +102,13 @@ map:
                 type: bool
                 desc: |
                     Exclude directories that contain a CACHEDIR.TAG file. See
-                    http://www.brynosaurus.com/cachedir/spec.html for details.
+                    http://www.brynosaurus.com/cachedir/spec.html for details. Defaults to false.
                 example: true
             exclude_if_present:
                 type: scalar
-                desc: Exclude directories that contain a file with the given filename.
+                desc: |
+                    Exclude directories that contain a file with the given filename. Defaults to not
+                    set.
                 example: .nobackup
     storage:
         desc: |
@@ -121,7 +123,7 @@ map:
                     The standard output of this command is used to unlock the encryption key. Only
                     use on repositories that were initialized with passcommand/repokey encryption.
                     Note that if both encryption_passcommand and encryption_passphrase are set,
-                    then encryption_passphrase takes precedence.
+                    then encryption_passphrase takes precedence. Defaults to not set.
                 example: "secret-tool lookup borg-repository repo-name"
             encryption_passphrase:
                 type: scalar
@@ -129,7 +131,7 @@ map:
                     Passphrase to unlock the encryption key with. Only use on repositories that were
                     initialized with passphrase/repokey encryption. Quote the value if it contains
                     punctuation, so it parses correctly. And backslash any quote or backslash
-                    literals as well.
+                    literals as well. Defaults to not set.
                 example: "!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~"
             checkpoint_interval:
                 type: int
@@ -143,7 +145,7 @@ map:
                 desc: |
                     Specify the parameters passed to then chunker (CHUNK_MIN_EXP, CHUNK_MAX_EXP,
                     HASH_MASK_BITS, HASH_WINDOW_SIZE). See https://borgbackup.readthedocs.io/en/stable/internals.html
-                    for details.
+                    for details. Defaults to "19,23,21,4095".
                 example: 19,23,21,4095
             compression:
                 type: scalar
@@ -154,25 +156,27 @@ map:
                 example: lz4
             remote_rate_limit:
                 type: int
-                desc: Remote network upload rate limit in kiBytes/second.
+                desc: Remote network upload rate limit in kiBytes/second. Defaults to unlimited.
                 example: 100
             ssh_command:
                 type: scalar
-                desc: Command to use instead of just "ssh". This can be used to specify ssh options.
+                desc: |
+                    Command to use instead of just "ssh". This can be used to specify ssh options.
+                    Defaults to not set.
                 example: ssh -i /path/to/private/key
             umask:
                 type: scalar
-                desc: Umask to be used for borg create.
+                desc: Umask to be used for borg create. Defaults to 0077.
                 example: 0077
             lock_wait:
                 type: int
-                desc: Maximum seconds to wait for acquiring a repository/cache lock.
+                desc: Maximum seconds to wait for acquiring a repository/cache lock. Defaults to 1.
                 example: 5
             archive_name_format:
                 type: scalar
                 desc: |
                     Name of the archive. Borg placeholders can be used. See the output of
-                    "borg help placeholders" for details. Default is
+                    "borg help placeholders" for details. Defaults to
                     "{hostname}-{now:%Y-%m-%dT%H:%M:%S.%f}". If you specify this option, you must
                     also specify a prefix in the retention section to avoid accidental pruning of
                     archives with a different archive name format. And you should also specify a
@@ -221,7 +225,7 @@ map:
                 desc: |
                     When pruning, only consider archive names starting with this prefix.
                     Borg placeholders can be used. See the output of "borg help placeholders" for
-                    details. Default is "{hostname}-".
+                    details. Defaults to "{hostname}-".
                 example: sourcehostname
     consistency:
         desc: |
@@ -256,14 +260,14 @@ map:
             check_last:
                 type: int
                 desc: Restrict the number of checked archives to the last n. Applies only to the
-                      "archives" check.
+                      "archives" check. Defaults to checking all archives.
                 example: 3
             prefix:
                 type: scalar
                 desc: |
                     When performing the "archives" check, only consider archive names starting with
                     this prefix. Borg placeholders can be used. See the output of
-                    "borg help placeholders" for details. Default is "{hostname}-".
+                    "borg help placeholders" for details. Defaults to "{hostname}-".
                 example: sourcehostname
     hooks:
         desc: |

setup.py

@@ -1,7 +1,7 @@
 from setuptools import setup, find_packages
 
 
-VERSION = '1.2.13'
+VERSION = '1.2.14'
 
 
 setup(

tests/integration/commands/test_borgmatic.py

@@ -1,3 +1,5 @@
+import subprocess
+
 from flexmock import flexmock
 import pytest
 
@@ -169,3 +171,10 @@ def test_parse_arguments_disallows_json_without_list_or_info():
 def test_parse_arguments_disallows_json_with_both_list_and_info():
     with pytest.raises(ValueError):
         module.parse_arguments('--list', '--info', '--json')
+
+
+def test_borgmatic_version_matches_news_version():
+    borgmatic_version = subprocess.check_output(('borgmatic', '--version')).decode('ascii')
+    news_version = open('NEWS').readline()
+
+    assert borgmatic_version == news_version

tests/integration/test_version.py

@@ -1,8 +0,0 @@
-import subprocess
-
-
-def test_setup_version_matches_news_version():
-    setup_version = subprocess.check_output(('python', 'setup.py', '--version')).decode('ascii')
-    news_version = open('NEWS').readline()
-
-    assert setup_version == news_version

tests/unit/commands/test_borgmatic.py

@@ -3,12 +3,12 @@ import sys
 
 from flexmock import flexmock
 
-from borgmatic.commands import borgmatic
+from borgmatic.commands import borgmatic as module
 
 
 def test_run_commands_handles_multiple_json_outputs_in_array():
     (
-        flexmock(borgmatic)
+        flexmock(module)
         .should_receive('_run_commands_on_repository')
         .times(3)
         .replace_with(
@@ -36,7 +36,7 @@ def test_run_commands_handles_multiple_json_outputs_in_array():
         )
     )
 
-    borgmatic._run_commands(
+    module._run_commands(
         args=flexmock(json=True),
         consistency=None,
         local_path=None,
@@ -45,3 +45,29 @@ def test_run_commands_handles_multiple_json_outputs_in_array():
         retention=None,
         storage=None,
     )
+
+
+def test_collect_configuration_run_summary_logs_info_for_success():
+    flexmock(module).should_receive('run_configuration')
+
+    logs = tuple(module.collect_configuration_run_summary_logs(('test.yaml',), args=()))
+
+    assert any(log for log in logs if log.levelno == module.logging.INFO)
+
+
+def test_collect_configuration_run_summary_logs_critical_for_error():
+    flexmock(module).should_receive('run_configuration').and_raise(ValueError)
+
+    logs = tuple(module.collect_configuration_run_summary_logs(('test.yaml',), args=()))
+
+    assert any(log for log in logs if log.levelno == module.logging.CRITICAL)
+
+
+def test_collect_configuration_run_summary_logs_critical_for_missing_configs():
+    logs = tuple(
+        module.collect_configuration_run_summary_logs(
+            config_filenames=(), args=flexmock(config_paths=())
+        )
+    )
+
+    assert any(log for log in logs if log.levelno == module.logging.CRITICAL)