Modify describe to not list snapshots (#376)

* Modify describe to not list snapshots

* Minor refactoring

* Fix params

* Modify func name

pkg/function/data_test.go

@@ -575,7 +575,6 @@ func (s *DataSuite) TestDescribeBackups(c *C) {
 	// Test DescribeBackups
 	bp2 := *newDescribeBackupsBlueprint()
 	out2 := runAction(c, bp2, "describeBackups", tp)
-	c.Assert(out2[DescribeBackupsSnapshotIDs], NotNil)
 	c.Assert(out2[DescribeBackupsFileCount].(string), Not(Equals), "")
 	c.Assert(out2[DescribeBackupsSize].(string), Not(Equals), "")
 	c.Assert(out2[DescribeBackupsPasswordIncorrect].(string), Not(Equals), "")

pkg/function/describe_backups.go

@@ -40,7 +40,6 @@ const (
 	DescribeBackupsJobPrefix         = "describe-backups-"
 	DescribeBackupsFileCount         = "fileCount"
 	DescribeBackupsSize              = "size"
-	DescribeBackupsSnapshotIDs       = "snapshotIDs"
 	DescribeBackupsPasswordIncorrect = "passwordIncorrect"
 	DescribeBackupsRepoDoesNotExist  = "repoUnavailable"
 	rawDataStatsMode                 = "raw-data"
@@ -86,13 +85,12 @@ func describeBackupsPodFunc(cli kubernetes.Interface, tp param.TemplateParams, n
 			return nil, err
 		}
 		defer CleanUpCredsFile(ctx, pw, pod.Namespace, pod.Name, pod.Spec.Containers[0].Name)
-		snapshotIDs, err := restic.GetSnapshotIDs(tp.Profile, cli, targetPath, encryptionKey, namespace, pod.Name, pod.Spec.Containers[0].Name)
+		err = restic.CheckIfRepoIsReachable(tp.Profile, targetPath, encryptionKey, cli, namespace, pod.Name, pod.Spec.Containers[0].Name)
 		switch {
 		case err == nil:
 			break
 		case strings.Contains(err.Error(), restic.PasswordIncorrect):
 			return map[string]interface{}{
-					DescribeBackupsSnapshotIDs:       nil,
 					DescribeBackupsFileCount:         nil,
 					DescribeBackupsSize:              nil,
 					DescribeBackupsPasswordIncorrect: "true",
@@ -102,7 +100,6 @@ func describeBackupsPodFunc(cli kubernetes.Interface, tp param.TemplateParams, n
 
 		case strings.Contains(err.Error(), restic.RepoDoesNotExist):
 			return map[string]interface{}{
-					DescribeBackupsSnapshotIDs:       nil,
 					DescribeBackupsFileCount:         nil,
 					DescribeBackupsSize:              nil,
 					DescribeBackupsPasswordIncorrect: "false",
@@ -129,7 +126,6 @@ func describeBackupsPodFunc(cli kubernetes.Interface, tp param.TemplateParams, n
 			return nil, errors.New("Failed to parse snapshot stats from logs")
 		}
 		return map[string]interface{}{
-				DescribeBackupsSnapshotIDs:       snapshotIDs,
 				DescribeBackupsFileCount:         fc,
 				DescribeBackupsSize:              size,
 				DescribeBackupsPasswordIncorrect: "false",

pkg/restic/restic.go

@@ -99,6 +99,17 @@ func SnapshotsCommand(profile *param.Profile, repository, encryptionKey string)
 	return shCommand(command), nil
 }
 
+// LatestSnapshotsCommand returns restic snapshots command for last snapshots
+func LatestSnapshotsCommand(profile *param.Profile, repository, encryptionKey string) ([]string, error) {
+	cmd, err := resticArgs(profile, repository, encryptionKey)
+	if err != nil {
+		return nil, err
+	}
+	cmd = append(cmd, "snapshots", "--last", "--json")
+	command := strings.Join(cmd, " ")
+	return shCommand(command), nil
+}
+
 // SnapshotsCommandByTag returns restic snapshots command
 func SnapshotsCommandByTag(profile *param.Profile, repository, tag, encryptionKey string) ([]string, error) {
 	cmd, err := resticArgs(profile, repository, encryptionKey)
@@ -255,9 +266,7 @@ func resticAzureArgs(profile *param.Profile, repository string) []string {
 
 // GetOrCreateRepository will check if the repository already exists and initialize one if not
 func GetOrCreateRepository(cli kubernetes.Interface, namespace, pod, container, artifactPrefix, encryptionKey string, profile *param.Profile) error {
-	stdout, stderr, err := listSnapshots(profile, artifactPrefix, encryptionKey, cli, namespace, pod, container)
-	format.Log(pod, container, stdout)
-	format.Log(pod, container, stderr)
+	stdout, stderr, err := getLatestSnapshots(profile, artifactPrefix, encryptionKey, cli, namespace, pod, container)
 	if err == nil {
 		return nil
 	}
@@ -272,38 +281,24 @@ func GetOrCreateRepository(cli kubernetes.Interface, namespace, pod, container,
 	return errors.Wrapf(err, "Failed to create object store backup location")
 }
 
-// GetSnapshotIDs checks if repo is reachable with current encryptionKey, and get a list of snapshot IDs
-func GetSnapshotIDs(profile *param.Profile, cli kubernetes.Interface, artifactPrefix, encryptionKey, namespace, pod, container string) ([]string, error) {
-	stdout, err := CheckIfRepoIsReachable(profile, artifactPrefix, encryptionKey, cli, namespace, pod, container)
-	if err != nil {
-		return nil, errors.Wrap(err, "Failed to connect to object store location")
-	}
-	// parse snapshots for list of IDs
-	snapshots, err := SnapshotIDsFromSnapshotCommand(stdout)
-	if err != nil {
-		return nil, errors.Wrap(err, "Failed to list snapshots")
-	}
-	return snapshots, nil
-}
-
 // CheckIfRepoIsReachable checks if repo can be reached by trying to list snapshots
-func CheckIfRepoIsReachable(profile *param.Profile, artifactPrefix string, encryptionKey string, cli kubernetes.Interface, namespace string, pod string, container string) (string, error) {
-	stdout, stderr, err := listSnapshots(profile, artifactPrefix, encryptionKey, cli, namespace, pod, container)
+func CheckIfRepoIsReachable(profile *param.Profile, artifactPrefix string, encryptionKey string, cli kubernetes.Interface, namespace string, pod string, container string) error {
+	_, stderr, err := getLatestSnapshots(profile, artifactPrefix, encryptionKey, cli, namespace, pod, container)
 	if IsPasswordIncorrect(stderr) { // If password didn't work
-		return "", errors.New(PasswordIncorrect)
+		return errors.New(PasswordIncorrect)
 	}
 	if DoesRepoExist(stderr) {
-		return "", errors.New(RepoDoesNotExist)
+		return errors.New(RepoDoesNotExist)
 	}
 	if err != nil {
-		return "", errors.Wrap(err, "Failed to list snapshots")
+		return errors.Wrap(err, "Failed to list snapshots")
 	}
-	return stdout, nil
+	return nil
 }
 
-func listSnapshots(profile *param.Profile, artifactPrefix string, encryptionKey string, cli kubernetes.Interface, namespace string, pod string, container string) (string, string, error) {
-	// Use the snapshots command to check if the repository exists
-	cmd, err := SnapshotsCommand(profile, artifactPrefix, encryptionKey)
+func getLatestSnapshots(profile *param.Profile, artifactPrefix string, encryptionKey string, cli kubernetes.Interface, namespace string, pod string, container string) (string, string, error) {
+	// Use the latest snapshots command to check if the repository exists
+	cmd, err := LatestSnapshotsCommand(profile, artifactPrefix, encryptionKey)
 	if err != nil {
 		return "", "", errors.Wrap(err, "Failed to create snapshot command")
 	}