Do not ignore permission errors in kopia restore command (#1835)

* Do not ignore permission errors * Fix snapshot command. Tests added * Add optional ignore permission arg * Fix order of args in UT * Additional UT cases added
kanisterio · Jan 5, 2023 · 4c3858a · 4c3858a
1 parent e9fe7ec
commit 4c3858a
Show file tree

Hide file tree

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

diff --git a/pkg/kopia/command/restore.go b/pkg/kopia/command/restore.go
@@ -14,16 +14,20 @@
 
 package command
 
+import "strconv"
+
 type RestoreCommandArgs struct {
 	*CommandArgs
-	RootID     string
-	TargetPath string
+	RootID                 string
+	TargetPath             string
+	IgnorePermissionErrors bool
 }
 
 // Restore returns the kopia command for restoring root of a snapshot with given root ID
 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))
 
 	return stringSliceCommand(args)
 }
diff --git a/pkg/kopia/command/restore_test.go b/pkg/kopia/command/restore_test.go
@@ -42,7 +42,23 @@ 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",
+			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",
+		},
+		{
+			f: func() []string {
+				args := RestoreCommandArgs{
+					CommandArgs: &CommandArgs{
+						RepoPassword:   "encr-key",
+						ConfigFilePath: "path/kopia.config",
+						LogDirectory:   "cache/log",
+					},
+					RootID:                 "snapshot-id",
+					TargetPath:             "target/path",
+					IgnorePermissionErrors: true,
+				}
+				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",
 		},
 	} {
 		cmd := strings.Join(tc.f(), " ")

diff --git a/pkg/kopia/command/snapshot.go b/pkg/kopia/command/snapshot.go
@@ -54,15 +54,17 @@ func SnapshotCreate(cmdArgs SnapshotCreateCommandArgs) []string {
 
 type SnapshotRestoreCommandArgs struct {
 	*CommandArgs
-	SnapID        string
-	TargetPath    string
-	SparseRestore bool
+	SnapID                 string
+	TargetPath             string
+	SparseRestore          bool
+	IgnorePermissionErrors bool
 }
 
 // SnapshotRestore returns kopia command restoring snapshots with given snap ID
 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.SparseRestore {
 		args = args.AppendLoggable(sparseFlag)
 	}

diff --git a/pkg/kopia/command/snapshot_test.go b/pkg/kopia/command/snapshot_test.go
@@ -72,26 +72,39 @@ func (kSnapshot *KopiaSnapshotTestSuite) TestSnapshotCommands(c *C) {
 		{
 			f: func() []string {
 				args := SnapshotRestoreCommandArgs{
-					CommandArgs:   commandArgs,
-					SnapID:        "snapshot-id",
-					TargetPath:    "target/path",
-					SparseRestore: false,
+					CommandArgs:            commandArgs,
+					SnapID:                 "snapshot-id",
+					TargetPath:             "target/path",
+					SparseRestore:          false,
+					IgnorePermissionErrors: false,
+				}
+				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",
+		},
+		{
+			f: func() []string {
+				args := SnapshotRestoreCommandArgs{
+					CommandArgs: commandArgs,
+					SnapID:      "snapshot-id",
+					TargetPath:  "target/path",
 				}
 				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",
+			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",
 		},
 		{
 			f: func() []string {
 				args := SnapshotRestoreCommandArgs{
-					CommandArgs:   commandArgs,
-					SnapID:        "snapshot-id",
-					TargetPath:    "target/path",
-					SparseRestore: true,
+					CommandArgs:            commandArgs,
+					SnapID:                 "snapshot-id",
+					TargetPath:             "target/path",
+					SparseRestore:          true,
+					IgnorePermissionErrors: true,
 				}
 				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 --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=true --write-sparse-files",
 		},
 		{
 			f: func() []string {