add support for `--list --json`

borgmatic/borg/list.py

@@ -1,5 +1,8 @@
+import sys
+
 import logging
 import subprocess
+import tempfile
 
 from borgmatic.verbosity import VERBOSITY_SOME, VERBOSITY_LOTS
 
@@ -7,7 +10,7 @@ from borgmatic.verbosity import VERBOSITY_SOME, VERBOSITY_LOTS
 logger = logging.getLogger(__name__)
 
 
-def list_archives(verbosity, repository, storage_config, local_path='borg', remote_path=None):
+def list_archives(verbosity, repository, storage_config, local_path='borg', remote_path=None, json=False):
     '''
     Given a verbosity flag, a local or remote repository path, and a storage config dict,
     list Borg archives in the repository.
@@ -18,6 +21,7 @@ def list_archives(verbosity, repository, storage_config, local_path='borg', remo
         (local_path, 'list', repository)
         + (('--remote-path', remote_path) if remote_path else ())
         + (('--lock-wait', str(lock_wait)) if lock_wait else ())
+        + (('--json',) if json else ())
         + {
             VERBOSITY_SOME: ('--info',),
             VERBOSITY_LOTS: ('--debug',),
@@ -25,4 +29,13 @@ def list_archives(verbosity, repository, storage_config, local_path='borg', remo
     )
 
     logger.debug(' '.join(full_command))
-    subprocess.check_call(full_command)
+
+    with tempfile.TemporaryFile() as f_output:
+        subprocess.check_call(full_command, stdout=f_output)
+        f_output.seek(0)
+        output = f_output.read().decode()
+
+    if json:
+        return output
+    else:
+        sys.stdout.write(output)

borgmatic/commands/borgmatic.py

@@ -1,4 +1,4 @@
-
+import json
 from argparse import ArgumentParser
 import logging
 import os
@@ -76,6 +76,13 @@ def parse_arguments(*arguments):
         action='store_true',
         help='Display summary information on archives',
     )
+    parser.add_argument(
+        '--json',
+        dest='json',
+        default=False,
+        action='store_true',
+        help='Output results from the --list option as json',
+    )
     parser.add_argument(
         '-n', '--dry-run',
         dest='dry_run',
@@ -90,6 +97,9 @@ def parse_arguments(*arguments):
 
     args = parser.parse_args(arguments)
 
+    if args.json and not args.list:
+        raise ValueError("The --json option can only be used with the --list option")
+
     # If any of the action flags are explicitly requested, leave them as-is. Otherwise, assume
     # defaults: Mutate the given arguments to enable the default actions.
     if args.prune or args.create or args.check or args.list or args.info:
@@ -121,6 +131,7 @@ def run_configuration(config_filename, args):  # pragma: no cover
         if args.create:
             hook.execute_hook(hooks.get('before_backup'), config_filename, 'pre-backup')
 
+        json_results = []
         for unexpanded_repository in location['repositories']:
             repository = os.path.expanduser(unexpanded_repository)
             dry_run_label = ' (dry run; not making any changes)' if args.dry_run else ''
@@ -158,13 +169,16 @@ def run_configuration(config_filename, args):  # pragma: no cover
                 )
             if args.list:
                 logger.info('{}: Listing archives'.format(repository))
-                borg_list.list_archives(
+                result = borg_list.list_archives(
                     args.verbosity,
                     repository,
                     storage,
                     local_path=local_path,
                     remote_path=remote_path,
+                    json=args.json,
                 )
+                if args.json:
+                    json_results.append(json.loads(result))
             if args.info:
                 logger.info('{}: Displaying summary info for archives'.format(repository))
                 borg_info.display_archives_info(
@@ -174,6 +188,8 @@ def run_configuration(config_filename, args):  # pragma: no cover
                     local_path=local_path,
                     remote_path=remote_path,
                 )
+        if args.json:
+            sys.stdout.write(json.dumps(json_results))
 
         if args.create:
             hook.execute_hook(hooks.get('after_backup'), config_filename, 'post-backup')

borgmatic/tests/integration/commands/test_borgmatic.py

@@ -15,6 +15,7 @@ def test_parse_arguments_with_no_arguments_uses_defaults():
     assert parser.config_paths == config_paths
     assert parser.excludes_filename == None
     assert parser.verbosity is None
+    assert parser.json is False
 
 
 def test_parse_arguments_with_path_arguments_overrides_defaults():
@@ -47,6 +48,11 @@ def test_parse_arguments_with_verbosity_flag_overrides_default():
     assert parser.verbosity == 1
 
 
+def test_parse_arguments_with_json_flag_overrides_default():
+    parser = module.parse_arguments('--list', '--json')
+    assert parser.json is True
+
+
 def test_parse_arguments_with_no_actions_defaults_to_all_actions_enabled():
     flexmock(module.collect).should_receive('get_default_config_paths').and_return(['default'])
 
@@ -82,3 +88,8 @@ def test_parse_arguments_with_invalid_arguments_exits():
 
     with pytest.raises(SystemExit):
         module.parse_arguments('--posix-me-harder')
+
+
+def test_parse_arguments_with_json_flag_but_no_list_flag_raises_value_error():
+    with pytest.raises(ValueError):
+        module.parse_arguments('--json')

borgmatic/tests/unit/borg/test_list.py

@@ -8,7 +8,7 @@ from borgmatic.verbosity import VERBOSITY_SOME, VERBOSITY_LOTS
 
 def insert_subprocess_mock(check_call_command, **kwargs):
     subprocess = flexmock(module.subprocess)
-    subprocess.should_receive('check_call').with_args(check_call_command, **kwargs).once()
+    subprocess.should_receive('check_call').with_args(check_call_command, stdout=object, **kwargs).once()
 
 
 LIST_COMMAND = ('borg', 'list', 'repo')
@@ -44,6 +44,17 @@ def test_list_archives_with_verbosity_lots_calls_borg_with_debug_parameter():
     )
 
 
+def test_list_archives_with_json_calls_borg_with_json_parameter():
+    insert_subprocess_mock(LIST_COMMAND + ('--json',))
+
+    module.list_archives(
+        verbosity=None,
+        repository='repo',
+        storage_config={},
+        json=True,
+    )
+
+
 def test_list_archives_with_local_path_calls_borg_via_local_path():
     insert_subprocess_mock(('borg1',) + LIST_COMMAND[1:])