borgmatic-collective/borgmatic
borgmatic-collective/borgmatic
15
60
Fork 43
Code Issues 59 Pull Requests Actions Packages Releases 123 Activity

[Feature] Add label variable interpolation in hook context #861

Closed
codimp wants to merge 5 commits from codimp/borgmatic:label-variable-interpolation-in-hook-context into main
pull from: codimp/borgmatic:label-variable-interpolation-in-hook-context
merge into: borgmatic-collective:main
Conversation 1 Commits 5 Files Changed 3 +11 -3
3 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
borgmatic/commands/borgmatic.py
View File

@ -286,6 +286,7 @@ def run_actions(
global_arguments = arguments['global']
dry_run_label = ' (dry run; not making any changes)' if global_arguments.dry_run else ''
hook_context = {
'repository_label': repository.get('label', ''),
codimp marked this conversation as resolved Outdated
witten commented 2024-04-29 01:39:05 +00:00
Outdated
Review
Copy Link

You could simplify this all to just: repository_label = repository.get('label', '')

It could even be inline below without the temporary variable. (Do not feel strongly.)

You could simplify this all to just: `repository_label = repository.get('label', '')` It could even be inline below without the temporary variable. (Do not feel strongly.)
codimp commented 2024-04-29 08:39:11 +00:00
Outdated
Review
Copy Link

Good idea!

Good idea!
'repository': repository_path,
# Deprecated: For backwards compatibility with borgmatic < 1.6.0.
'repositories': ','.join([repo['path'] for repo in config['repositories']]),

2
docs/how-to/add-preparation-and-cleanup-steps-to-backups.md
View File

@ -84,6 +84,8 @@ variables you can use here:
path of the borgmatic log file, only set when the `--log-file` flag is used
* `repository`: path of the current repository as configured in the current
borgmatic configuration file
* `repository_label`: current repository label as configured in the current
codimp marked this conversation as resolved Outdated
witten commented 2024-04-29 16:09:36 +00:00
Outdated
Review
Copy Link

Sorry, another thing I think I mentioned on IRC.. What do you think of calling this repository_label instead of just label?

Sorry, another thing I think I mentioned on IRC.. What do you think of calling this `repository_label` instead of just `label`?
codimp commented 2024-04-29 19:04:44 +00:00
Outdated
Review
Copy Link

oups, right, my bad!

oups, right, my bad!
borgmatic configuration file
Note that you can also interpolate in [arbitrary environment
variables](https://torsion.org/borgmatic/docs/how-to/provide-your-passwords/).

11
tests/unit/commands/test_borgmatic.py
View File

@ -494,10 +494,15 @@ def test_run_actions_adds_log_file_to_hook_context():
expected = flexmock()
flexmock(borgmatic.actions.create).should_receive('run_create').with_args(
config_filename=object,
repository={'path': 'repo'},
repository={'path': 'repo', 'label': ''},
config={'repositories': []},
config_paths=[],
hook_context={'repository': 'repo', 'repositories': '', 'log_file': 'foo'},
hook_context={
'repository': 'repo',
'repository_label': '',
'repositories': '',
'log_file': 'foo',
},
local_borg_version=object,
create_arguments=object,
global_arguments=object,
@ -515,7 +520,7 @@ def test_run_actions_adds_log_file_to_hook_context():
local_path=flexmock(),
remote_path=flexmock(),
local_borg_version=flexmock(),
repository={'path': 'repo'},
repository={'path': 'repo', 'label': ''},
)
)
assert result == (expected,)