Remove unused DescribeBackups function and related code (#2401)

* Remove unused DescribeBackups function * Remove related tests * Remove related docs * Use a different constant
kanisterio · Oct 15, 2023 · 2167aef · 2167aef
1 parent d4e4b79
commit 2167aef
Show file tree

Hide file tree

Showing 4 changed files with 1 addition and 352 deletions.
diff --git a/docs/functions.rst b/docs/functions.rst
@@ -889,57 +889,6 @@ Example:
             mode: restore-size
             backupID: "{{ .ArtifactsIn.snapshot.KeyValue.backupIdentifier }}"
 
-DescribeBackups
----------------
-
-This function describes the backups for an object store location
-
-.. note::
-   It is important that the application includes a ``kanister-tools``
-   sidecar container. This sidecar is necessary to run the
-   tools that get the information from the object store.
-
-Arguments:
-
-.. csv-table::
-   :header: "Argument", "Required", "Type", "Description"
-   :align: left
-   :widths: 5,5,5,15
-
-   `backupArtifactPrefix`, Yes, `string`, path to the object store location
-   `encryptionKey`, No, `string`, encryption key to be used for backups
-
-Outputs:
-
-.. csv-table::
-   :header: "Output", "Type", "Description"
-   :align: left
-   :widths: 5,5,15
-
-   `fileCount`,`string`, number of files in backup object store location
-   `size`, `string`, size of the number of files in in backup object store location
-   `passwordIncorrect`, `string`, true if encryption key is incorrect
-   `repoDoesNotExist`, `string`, true if object store location does not exist
-
-Example:
-
-.. code-block:: yaml
-  :linenos:
-
-  actions:
-    backupStats:
-      outputArtifacts:
-        backupStats:
-          keyValue:
-            fileCount: "{{ .Phases.DescribeBackupsFromObjectStore.Output.fileCount }}"
-            size: "{{ .Phases.DescribeBackupsFromObjectStore.Output.size }}"
-            passwordIncorrect: "{{ .Phases.DescribeBackupsFromObjectStore.Output.passwordIncorrect }}"
-            repoDoesNotExist: "{{ .Phases.DescribeBackupsFromObjectStore.Output.repoDoesNotExist }}"
-      phases:
-        - func: DescribeBackups
-          name: DescribeBackupsFromObjectStore
-          args:
-            backupArtifactPrefix: s3-bucket/path/artifactPrefix
 
 CreateRDSSnapshot
 -----------------

diff --git a/pkg/function/backup_data_stats.go b/pkg/function/backup_data_stats.go
@@ -157,7 +157,7 @@ func (b *BackupDataStatsFunc) Exec(ctx context.Context, tp param.TemplateParams,
 	if err = OptArg(args, BackupDataStatsEncryptionKeyArg, &encryptionKey, restic.GeneratePassword()); err != nil {
 		return nil, err
 	}
-	podOverride, err := GetPodSpecOverride(tp, args, DescribeBackupsPodOverrideArg)
+	podOverride, err := GetPodSpecOverride(tp, args, CheckRepositoryPodOverrideArg)
 	if err != nil {
 		return nil, err
 	}

diff --git a/pkg/function/data_test.go b/pkg/function/data_test.go
@@ -175,26 +175,6 @@ func newBackupDataBlueprint() *crv1alpha1.Blueprint {
 	}
 }
 
-func newDescribeBackupsBlueprint() *crv1alpha1.Blueprint {
-	return &crv1alpha1.Blueprint{
-		Actions: map[string]*crv1alpha1.BlueprintAction{
-			"describeBackups": {
-				Kind: param.StatefulSetKind,
-				Phases: []crv1alpha1.BlueprintPhase{
-					{
-						Name: "testDescribeBackups",
-						Func: DescribeBackupsFuncName,
-						Args: map[string]interface{}{
-							DescribeBackupsArtifactPrefixArg: "{{ .Profile.Location.Prefix }}",
-							DescribeBackupsEncryptionKeyArg:  "{{ .Secrets.backupKey.Data.password | toString }}",
-						},
-					},
-				},
-			},
-		},
-	}
-}
-
 func newCheckRepositoryBlueprint() *crv1alpha1.Blueprint {
 	return &crv1alpha1.Blueprint{
 		Actions: map[string]*crv1alpha1.BlueprintAction{
@@ -590,63 +570,6 @@ func (s *DataSuite) initPVCTemplateParams(c *C, pvc *v1.PersistentVolumeClaim, o
 	tp.Profile = s.profile
 	return tp
 }
-func (s *DataSuite) TestDescribeBackups(c *C) {
-	tp, _ := s.getTemplateParamsAndPVCName(c, 1)
-
-	// Test backup
-	bp := *newBackupDataBlueprint()
-	out := runAction(c, bp, "backup", tp)
-	c.Assert(out[BackupDataOutputBackupID].(string), Not(Equals), "")
-	c.Assert(out[BackupDataOutputBackupTag].(string), Not(Equals), "")
-	c.Assert(out[FunctionOutputVersion].(string), Equals, kanister.DefaultVersion)
-
-	// Test DescribeBackups
-	bp2 := *newDescribeBackupsBlueprint()
-	out2 := runAction(c, bp2, "describeBackups", tp)
-	c.Assert(out2[DescribeBackupsFileCount].(string), Not(Equals), "")
-	c.Assert(out2[DescribeBackupsSize].(string), Not(Equals), "")
-	c.Assert(out2[DescribeBackupsPasswordIncorrect].(string), Not(Equals), "")
-	c.Assert(out2[DescribeBackupsRepoDoesNotExist].(string), Not(Equals), "")
-	c.Assert(out2[FunctionOutputVersion].(string), Equals, kanister.DefaultVersion)
-}
-
-func (s *DataSuite) TestDescribeBackupsWrongPassword(c *C) {
-	tp, _ := s.getTemplateParamsAndPVCName(c, 1)
-
-	// Test backup
-	bp := *newBackupDataBlueprint()
-	bp.Actions["backup"].Phases[0].Args[BackupDataBackupArtifactPrefixArg] = fmt.Sprintf("%s/%s", bp.Actions["backup"].Phases[0].Args[BackupDataBackupArtifactPrefixArg], "abcde")
-	bp.Actions["backup"].Phases[0].Args[BackupDataEncryptionKeyArg] = "foobar"
-	out := runAction(c, bp, "backup", tp)
-	c.Assert(out[BackupDataOutputBackupID].(string), Not(Equals), "")
-	c.Assert(out[BackupDataOutputBackupTag].(string), Not(Equals), "")
-	c.Assert(out[FunctionOutputVersion].(string), Equals, kanister.DefaultVersion)
-
-	// Test DescribeBackups
-	bp2 := *newDescribeBackupsBlueprint()
-	bp2.Actions["describeBackups"].Phases[0].Args[DescribeBackupsArtifactPrefixArg] = fmt.Sprintf("%s/%s", bp2.Actions["describeBackups"].Phases[0].Args[DescribeBackupsArtifactPrefixArg], "abcde")
-	out2 := runAction(c, bp2, "describeBackups", tp)
-	c.Assert(out2[DescribeBackupsPasswordIncorrect].(string), Equals, "true")
-	c.Assert(out2[FunctionOutputVersion].(string), Equals, kanister.DefaultVersion)
-}
-
-func (s *DataSuite) TestDescribeBackupsRepoNotAvailable(c *C) {
-	tp, _ := s.getTemplateParamsAndPVCName(c, 1)
-
-	// Test backup
-	bp := *newBackupDataBlueprint()
-	out := runAction(c, bp, "backup", tp)
-	c.Assert(out[BackupDataOutputBackupID].(string), Not(Equals), "")
-	c.Assert(out[BackupDataOutputBackupTag].(string), Not(Equals), "")
-	c.Assert(out[FunctionOutputVersion].(string), Equals, kanister.DefaultVersion)
-
-	// Test DescribeBackups
-	bp2 := *newDescribeBackupsBlueprint()
-	bp2.Actions["describeBackups"].Phases[0].Args[DescribeBackupsArtifactPrefixArg] = fmt.Sprintf("%s/%s", bp2.Actions["describeBackups"].Phases[0].Args[DescribeBackupsArtifactPrefixArg], c.TestName())
-	out2 := runAction(c, bp2, "describeBackups", tp)
-	c.Assert(out2[DescribeBackupsRepoDoesNotExist].(string), Equals, "true")
-	c.Assert(out2[FunctionOutputVersion].(string), Equals, kanister.DefaultVersion)
-}
 
 func (s *DataSuite) TestCheckRepository(c *C) {
 	tp, _ := s.getTemplateParamsAndPVCName(c, 1)

diff --git a/pkg/function/describe_backups.go b/pkg/function/describe_backups.go