borgmatic borg with --dry-run passed to borgmatic does not actually perform a dry run #774

New issue

Closed

opened 2023-10-21 04:13:18 +00:00 by SimonPilkington · 3 comments

SimonPilkington commented 2023-10-21 04:13:18 +00:00

Contributor

Copy link

What I'm trying to do and why

If borgmatic borg is run with the --dry-run flag passed to borgmatic the arbitrary borg command will be run without a corresponding --dry-run flag. This seems like a good way for a naive user to shoot themselves in the foot.

Steps to reproduce

e.g. borgmatic --dry-run -v 2 borg recreate

Actual behavior

borg --version --debug --show-rc
local: Running actions for repository
/etc/borgmatic/config.yaml: No commands to run for pre-actions hook
local: Running arbitrary Borg command
borg recreate --debug --show-rc --remote-path borg1 > 

Notice no --dry-run in the borg cmdline.

Expected behavior

Nothing potentially destructive happens.

Other notes / implementation ideas

I see two solutions to this.

1. Make sure to pass on --dry-run to borg.
2. Yell at the user that passing --dry-run to borgmatic when running borgmatic borg is not supported and to use --dry-run in the borg cmdline instead. Don't actually do anything.

I prefer 2.

borgmatic version

1.8.3

borgmatic installation method

n/a

Borg version

n/a

Python version

n/a

Database version (if applicable)

n/a

Operating system and version

n/a

### What I'm trying to do and why If `borgmatic borg` is run with the `--dry-run` flag passed to borgmatic the arbitrary borg command will be run without a corresponding `--dry-run` flag. This seems like a good way for a naive user to shoot themselves in the foot. ### Steps to reproduce e.g. `borgmatic --dry-run -v 2 borg recreate` ### Actual behavior ``` borg --version --debug --show-rc local: Running actions for repository /etc/borgmatic/config.yaml: No commands to run for pre-actions hook local: Running arbitrary Borg command borg recreate --debug --show-rc --remote-path borg1 > ``` Notice no `--dry-run` in the borg cmdline. ### Expected behavior Nothing potentially destructive happens. ### Other notes / implementation ideas I see two solutions to this. 1. Make sure to pass on `--dry-run` to borg. 2. Yell at the user that passing `--dry-run` to borgmatic when running `borgmatic borg` is not supported and to use `--dry-run` in the borg cmdline instead. Don't actually do anything. I prefer 2. ### borgmatic version 1.8.3 ### borgmatic installation method n/a ### Borg version n/a ### Python version n/a ### Database version (if applicable) n/a ### Operating system and version n/a

witten commented 2023-10-21 06:09:57 +00:00

Owner

Copy link

Thanks for filing this! Of the two options you presented, I agree that number 2 probably makes the most sense given the nature of the borgmatic borg action.

Thanks for filing this! Of the two options you presented, I agree that number 2 probably makes the most sense given the nature of the `borgmatic borg` action.

witten added the

good first issue

label 2023-10-21 06:10:10 +00:00

witten referenced this issue from a commit 2023-10-24 00:23:51 +00:00

Disallow the "--dry-run" flag with the "borg" action (#774).

witten commented 2023-10-24 00:23:54 +00:00

Owner

Copy link

This is done in main and will be part of the next release. Thanks again for the suggestion!

This is done in main and will be part of the next release. Thanks again for the suggestion!

👍 1

witten closed this issue 2023-10-24 00:23:54 +00:00

witten commented 2023-10-27 05:22:50 +00:00

Owner

Copy link

Released in borgmatic 1.8.4!

Released in borgmatic 1.8.4!

Sign in to join this conversation.

No Branch/Tag specified

Branches Tags

main

bootstrap-multiple-latest-archives

parallel-borgmatic

command-hook-steps

2.1.6

2.1.5

2.1.4

2.1.3

2.1.2

2.1.1

2.1.0

2.0.13

2.0.12

2.0.11

2.0.10

2.0.9

2.0.8

2.0.7

2.0.6

2.0.5

2.0.4

2.0.3

2.0.2

2.0.1

2.0.0

1.9.14

1.9.13

1.9.12

1.9.11

1.9.10

1.9.9

1.9.8

1.9.7

1.9.6

1.9.5

1.9.4

1.9.3

1.9.2

1.9.1

1.9.0

1.8.14

1.8.13

1.8.12

1.8.11

1.8.10

1.8.9

1.8.8

1.8.7

1.8.6

1.8.5

1.8.4

1.8.3

1.8.2

1.8.1

1.8.0

1.7.15

1.7.14

1.7.13

1.7.12

1.7.11

1.7.10

1.7.9

1.7.8

1.7.7

1.7.6

1.7.5

1.7.4

1.7.3

1.7.2

1.7.1

1.7.0

1.6.6

1.6.5

1.6.4

1.6.3

1.6.2

1.6.1

1.6.0

1.5.24

1.5.23

1.5.22

1.5.21

1.5.20

1.5.19

1.5.18

1.5.17

1.5.16

1.5.15

1.5.14

1.5.13

1.5.12

1.5.11

1.5.10

1.5.9

1.5.8

1.5.7

1.5.7.dev0

1.5.6

1.5.5

1.5.4

1.5.3

1.5.2

1.5.1

1.5.0

1.4.22

1.4.21

1.4.20

1.4.19

1.4.18

1.4.17

1.4.16

1.4.15

1.4.14

1.4.13

1.4.12

1.4.11

1.4.10

1.4.9

1.4.8

1.4.7

1.4.6

1.4.5

1.4.4

1.4.3

1.4.2

1.4.1

1.4.0

1.3.26

1.3.25

1.3.24

1.3.23

1.3.22

1.3.21

1.3.20

1.3.19

1.3.18

1.3.17

1.3.16

1.3.15

1.3.14

1.3.13

1.3.12

1.3.11

1.3.10

1.3.9

1.3.8

1.3.7

1.3.6

1.3.5

1.3.4

1.3.3

1.3.2

1.3.1

1.3.0

1.2.18

1.2.17

1.2.16

1.2.15

1.2.14

1.2.13

1.2.12

1.2.11

1.2.10

1.2.9

1.2.8

1.2.7

1.2.6

1.2.5

1.2.4

1.2.3

1.2.2

1.2.1

1.2.0

1.1.15

1.1.14

1.1.13

1.1.12

1.1.11

1.1.10

1.1.9

1.1.7

1.1.6

1.1.5

1.1.4

1.1.3

1.1.2

1.1.1

1.1.0

1.0.3

1.0.2

1.0.1

1.0.0

0.1.8

0.1.7

0.1.6

0.1.5

0.1.4

0.1.3

0.1.2

0.1.1

0.1.0

0.0.7

0.0.6

0.0.5

0.0.4

0.0.3

0.0.2

Labels

Clear labels   

blocked

  

breaking

  

bug

  

data loss

  

design finalized

  

good first issue

  

new feature area

  

question / support

  

security

  

waiting for response

No labels

blocked

breaking

bug

data loss

design finalized

good first issue

new feature area

question / support

security

waiting for response

Milestone

Clear milestone

No items

No milestone

Projects

Clear projects

No items

No project

Assignees

Clear assignees

No assignees

2 participants

Notifications

Subscribe

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference

borgmatic-collective/borgmatic#774

No description provided.