Format bool arguments in a way it expected by kopia's cmd lib. (#1849)

* Format bool arguments in a way it expected by kopia's cmd lib. See https://github.com/alecthomas/kingpin/blob/master/README.md#boolean-values * Add dashes to func's description to describe the k[2:] behaviour * Implement simple version of check * Revert changes Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
kanisterio · Jan 9, 2023 · 48f08e1 · 48f08e1
1 parent 15157fb
commit 48f08e1
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 9 deletions.
diff --git a/pkg/kopia/command/const.go b/pkg/kopia/command/const.go
@@ -53,6 +53,7 @@ const (
 	ownerFlag                  = "--owner"
 	sparseFlag                 = "--write-sparse-files"
 	ignorePermissionsError     = "--ignore-permission-errors"
+	noIgnorePermissionsError   = "--no-ignore-permission-errors"
 
 	// Server specific
 	addSubCommand             = "add"

diff --git a/pkg/kopia/command/restore.go b/pkg/kopia/command/restore.go
@@ -14,8 +14,6 @@
 
 package command
 
-import "strconv"
-
 type RestoreCommandArgs struct {
 	*CommandArgs
 	RootID                 string
@@ -27,7 +25,11 @@ type RestoreCommandArgs struct {
 func Restore(cmdArgs RestoreCommandArgs) []string {
 	args := commonArgs(cmdArgs.CommandArgs, false)
 	args = args.AppendLoggable(restoreSubCommand, cmdArgs.RootID, cmdArgs.TargetPath)
-	args = args.AppendLoggableKV(ignorePermissionsError, strconv.FormatBool(cmdArgs.IgnorePermissionErrors))
+	if cmdArgs.IgnorePermissionErrors {
+		args = args.AppendLoggable(ignorePermissionsError)
+	} else {
+		args = args.AppendLoggable(noIgnorePermissionsError)
+	}
 
 	return stringSliceCommand(args)
 }
diff --git a/pkg/kopia/command/restore_test.go b/pkg/kopia/command/restore_test.go
@@ -42,7 +42,7 @@ func (kRestore *KopiaRestoreTestSuite) TestRestoreCommands(c *C) {
 				}
 				return Restore(args)
 			},
-			expectedLog: "kopia --log-level=error --config-file=path/kopia.config --log-dir=cache/log --password=encr-key restore snapshot-id target/path --ignore-permission-errors=false",
+			expectedLog: "kopia --log-level=error --config-file=path/kopia.config --log-dir=cache/log --password=encr-key restore snapshot-id target/path --no-ignore-permission-errors",
 		},
 		{
 			f: func() []string {
@@ -58,7 +58,7 @@ func (kRestore *KopiaRestoreTestSuite) TestRestoreCommands(c *C) {
 				}
 				return Restore(args)
 			},
-			expectedLog: "kopia --log-level=error --config-file=path/kopia.config --log-dir=cache/log --password=encr-key restore snapshot-id target/path --ignore-permission-errors=true",
+			expectedLog: "kopia --log-level=error --config-file=path/kopia.config --log-dir=cache/log --password=encr-key restore snapshot-id target/path --ignore-permission-errors",
 		},
 	} {
 		cmd := strings.Join(tc.f(), " ")

diff --git a/pkg/kopia/command/snapshot.go b/pkg/kopia/command/snapshot.go
@@ -64,7 +64,11 @@ type SnapshotRestoreCommandArgs struct {
 func SnapshotRestore(cmdArgs SnapshotRestoreCommandArgs) []string {
 	args := commonArgs(cmdArgs.CommandArgs, false)
 	args = args.AppendLoggable(snapshotSubCommand, restoreSubCommand, cmdArgs.SnapID, cmdArgs.TargetPath)
-	args = args.AppendLoggableKV(ignorePermissionsError, strconv.FormatBool(cmdArgs.IgnorePermissionErrors))
+	if cmdArgs.IgnorePermissionErrors {
+		args = args.AppendLoggable(ignorePermissionsError)
+	} else {
+		args = args.AppendLoggable(noIgnorePermissionsError)
+	}
 	if cmdArgs.SparseRestore {
 		args = args.AppendLoggable(sparseFlag)
 	}

diff --git a/pkg/kopia/command/snapshot_test.go b/pkg/kopia/command/snapshot_test.go
@@ -80,7 +80,7 @@ func (kSnapshot *KopiaSnapshotTestSuite) TestSnapshotCommands(c *C) {
 				}
 				return SnapshotRestore(args)
 			},
-			expectedLog: "kopia --log-level=error --config-file=path/kopia.config --log-dir=cache/log --password=encr-key snapshot restore snapshot-id target/path --ignore-permission-errors=false",
+			expectedLog: "kopia --log-level=error --config-file=path/kopia.config --log-dir=cache/log --password=encr-key snapshot restore snapshot-id target/path --no-ignore-permission-errors",
 		},
 		{
 			f: func() []string {
@@ -91,7 +91,7 @@ func (kSnapshot *KopiaSnapshotTestSuite) TestSnapshotCommands(c *C) {
 				}
 				return SnapshotRestore(args)
 			},
-			expectedLog: "kopia --log-level=error --config-file=path/kopia.config --log-dir=cache/log --password=encr-key snapshot restore snapshot-id target/path --ignore-permission-errors=false",
+			expectedLog: "kopia --log-level=error --config-file=path/kopia.config --log-dir=cache/log --password=encr-key snapshot restore snapshot-id target/path --no-ignore-permission-errors",
 		},
 		{
 			f: func() []string {
@@ -104,7 +104,7 @@ func (kSnapshot *KopiaSnapshotTestSuite) TestSnapshotCommands(c *C) {
 				}
 				return SnapshotRestore(args)
 			},
-			expectedLog: "kopia --log-level=error --config-file=path/kopia.config --log-dir=cache/log --password=encr-key snapshot restore snapshot-id target/path --ignore-permission-errors=true --write-sparse-files",
+			expectedLog: "kopia --log-level=error --config-file=path/kopia.config --log-dir=cache/log --password=encr-key snapshot restore snapshot-id target/path --ignore-permission-errors --write-sparse-files",
 		},
 		{
 			f: func() []string {