Add "break-lock" action for removing any repository and cache locks leftover from Borg aborting (#357).

tests/unit/borg/test_break_lock.py

@@ -0,0 +1,70 @@
+import logging
+
+from flexmock import flexmock
+
+from borgmatic.borg import break_lock as module
+
+from ..test_verbosity import insert_logging_mock
+
+
+def insert_execute_command_mock(command):
+    flexmock(module.environment).should_receive('make_environment')
+    flexmock(module).should_receive('execute_command').with_args(
+        command, borg_local_path='borg', extra_environment=None,
+    ).once()
+
+
+def test_break_lock_calls_borg_with_required_flags():
+    flexmock(module.flags).should_receive('make_repository_flags').and_return(('repo',))
+    insert_execute_command_mock(('borg', 'break-lock', 'repo'))
+
+    module.break_lock(
+        repository='repo', storage_config={}, local_borg_version='1.2.3',
+    )
+
+
+def test_break_lock_calls_borg_with_remote_path_flags():
+    flexmock(module.flags).should_receive('make_repository_flags').and_return(('repo',))
+    insert_execute_command_mock(('borg', 'break-lock', '--remote-path', 'borg1', 'repo'))
+
+    module.break_lock(
+        repository='repo', storage_config={}, local_borg_version='1.2.3', remote_path='borg1',
+    )
+
+
+def test_break_lock_calls_borg_with_umask_flags():
+    flexmock(module.flags).should_receive('make_repository_flags').and_return(('repo',))
+    insert_execute_command_mock(('borg', 'break-lock', '--umask', '0770', 'repo'))
+
+    module.break_lock(
+        repository='repo', storage_config={'umask': '0770'}, local_borg_version='1.2.3',
+    )
+
+
+def test_break_lock_calls_borg_with_lock_wait_flags():
+    flexmock(module.flags).should_receive('make_repository_flags').and_return(('repo',))
+    insert_execute_command_mock(('borg', 'break-lock', '--lock-wait', '5', 'repo'))
+
+    module.break_lock(
+        repository='repo', storage_config={'lock_wait': '5'}, local_borg_version='1.2.3',
+    )
+
+
+def test_break_lock_with_log_info_calls_borg_with_info_parameter():
+    flexmock(module.flags).should_receive('make_repository_flags').and_return(('repo',))
+    insert_execute_command_mock(('borg', 'break-lock', '--info', 'repo'))
+    insert_logging_mock(logging.INFO)
+
+    module.break_lock(
+        repository='repo', storage_config={}, local_borg_version='1.2.3',
+    )
+
+
+def test_break_lock_with_log_debug_calls_borg_with_debug_flags():
+    flexmock(module.flags).should_receive('make_repository_flags').and_return(('repo',))
+    insert_execute_command_mock(('borg', 'break-lock', '--debug', '--show-rc', 'repo'))
+    insert_logging_mock(logging.DEBUG)
+
+    module.break_lock(
+        repository='repo', storage_config={}, local_borg_version='1.2.3',
+    )

tests/unit/commands/test_borgmatic.py

@@ -712,6 +712,31 @@ def test_run_actions_does_not_raise_for_info_action():
     )
 
 
+def test_run_actions_does_not_raise_for_break_lock_action():
+    flexmock(module.validate).should_receive('repositories_match').and_return(True)
+    flexmock(module.borg_break_lock).should_receive('break_lock')
+    arguments = {
+        'global': flexmock(monitoring_verbosity=1, dry_run=False),
+        'break-lock': flexmock(repository=flexmock()),
+    }
+
+    list(
+        module.run_actions(
+            arguments=arguments,
+            config_filename='test.yaml',
+            location={'repositories': ['repo']},
+            storage={},
+            retention={},
+            consistency={},
+            hooks={},
+            local_path=None,
+            remote_path=None,
+            local_borg_version=None,
+            repository_path='repo',
+        )
+    )
+
+
 def test_run_actions_does_not_raise_for_borg_action():
     flexmock(module.validate).should_receive('repositories_match').and_return(True)
     flexmock(module.borg_rlist).should_receive('resolve_archive_name').and_return(flexmock())