Changes to use tags for GetSnapshot in vSphere (#1158)

* changes to use tags for GetSnapshot * augment additional tags Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
kanisterio · Dec 15, 2021 · 12157ea · 12157ea
1 parent 4e65d7d
commit 12157ea
Show file tree

Hide file tree

Showing 2 changed files with 98 additions and 3 deletions.
diff --git a/pkg/blockstorage/vmware/vmware.go b/pkg/blockstorage/vmware/vmware.go
@@ -354,7 +354,13 @@ func (p *FcdProvider) SnapshotGet(ctx context.Context, id string) (*blockstorage
 				return nil, errors.Wrap(err, "Failed to get snapshot metadata")
 			}
 			log.Debug().Print("RetrieveMetadata done: " + volID + "," + snapshotID)
-			snapshot.Tags = convertKeyValueToTags(kvs)
+			tags := convertKeyValueToTags(kvs)
+			additonalTags, err := p.getSnapshotTags(ctx, id)
+			if err != nil {
+				return nil, errors.Wrap(err, "Failed to get snapshot tags")
+			}
+			tags = append(tags, additonalTags...)
+			snapshot.Tags = tags
 			return snapshot, nil
 		}
 	}
@@ -508,6 +514,18 @@ func (p *FcdProvider) VolumesList(ctx context.Context, tags map[string]string, z
 	return nil, errors.New("Not implemented")
 }
 
+func (p *FcdProvider) getSnapshotTags(ctx context.Context, fullSnapshotID string) ([]*blockstorage.KeyValue, error) {
+	if p.categoryID == "" {
+		log.Debug().Print("vSphere snapshot tagging is disabled (categoryID not set). Cannot get snapshot tags")
+		return nil, nil
+	}
+	categoryTags, err := p.tagManager.GetTagsForCategory(ctx, p.categoryID)
+	if err != nil {
+		return nil, errors.Wrap(err, "Failed to list tags")
+	}
+	return p.getTagsFromSnapshotID(categoryTags, fullSnapshotID)
+}
+
 // SnapshotsList is part of blockstorage.Provider
 func (p *FcdProvider) SnapshotsList(ctx context.Context, tags map[string]string) ([]*blockstorage.Snapshot, error) {
 	if p.categoryID == "" {
@@ -538,12 +556,26 @@ func (p *FcdProvider) SnapshotsList(ctx context.Context, tags map[string]string)
 	return snapshots, nil
 }
 
+func (p *FcdProvider) getTagsFromSnapshotID(categoryTags []vapitags.Tag, fullSnapshotID string) ([]*blockstorage.KeyValue, error) {
+	tags := map[string]string{}
+	for _, catTag := range categoryTags {
+		parsedTag := &snapshotTag{}
+		if err := parsedTag.Parse(catTag.Name); err != nil {
+			return nil, errors.Wrapf(err, "Failed to parse tag")
+		}
+		snapId := SnapshotFullID(parsedTag.volid, parsedTag.snapid)
+		if snapId == fullSnapshotID {
+			tags[parsedTag.key] = parsedTag.value
+		}
+	}
+	return blockstorage.MapToKeyValue(tags), nil
+}
+
 func (p *FcdProvider) getSnapshotIDsFromTags(categoryTags []vapitags.Tag, tags map[string]string) ([]string, error) {
 	snapshotTagMap := map[string]map[string]string{}
 	for _, catTag := range categoryTags {
 		parsedTag := &snapshotTag{}
-		err := parsedTag.Parse(catTag.Name)
-		if err != nil {
+		if err := parsedTag.Parse(catTag.Name); err != nil {
 			return nil, errors.Wrapf(err, "Failed to parse tag")
 		}
 		snapId := SnapshotFullID(parsedTag.volid, parsedTag.snapid)

diff --git a/pkg/blockstorage/vmware/vmware_test.go b/pkg/blockstorage/vmware/vmware_test.go
@@ -2,6 +2,7 @@ package vmware
 
 import (
 	"context"
+	"errors"
 	"fmt"
 	"os"
 	"sort"
@@ -304,6 +305,68 @@ func (s *VMWareSuite) TestDeleteTagsSnapshot(c *C) {
 	}
 }
 
+func (s *VMWareSuite) TestGetSnapshotTags(c *C) {
+	ctx := context.Background()
+	for _, tc := range []struct {
+		snapshotID   string
+		catID        string
+		categoryTags []vapitags.Tag
+		expNumTags   int
+		errGetTags   error
+		errChecker   Checker
+	}{
+		{ // success
+			snapshotID: "v1:s1",
+			categoryTags: []vapitags.Tag{
+				{Name: "v1:s1:t1:v1"},
+				{Name: "v1:s1:t2:v2"},
+				{Name: "v1:s2:t3:v3"},
+				{Name: "v3:s2:t4:v4"},
+			},
+			errChecker: IsNil,
+			catID:      "something",
+			expNumTags: 2,
+		},
+		{ // bad tag
+			snapshotID: "v1:s1",
+			categoryTags: []vapitags.Tag{
+				{Name: "v1:s1:t1:v1"},
+				{Name: "v1:s1:t2:v2"},
+				{Name: "v1:s2:t3:v3"},
+				{Name: "v3:s2t4:v4"},
+			},
+			catID:      "something",
+			errChecker: NotNil,
+		},
+		{ // bad tag
+			snapshotID:   "v1:s1",
+			categoryTags: []vapitags.Tag{},
+			errGetTags:   errors.New("get tags error"),
+			errChecker:   NotNil,
+			catID:        "something",
+		},
+		{ // empty cat id
+			errChecker: IsNil,
+			catID:      "",
+			expNumTags: 0,
+		},
+	} {
+		ftm := &fakeTagManager{
+			retGetTagsForCategory: tc.categoryTags,
+			errGetTagsForCategory: tc.errGetTags,
+		}
+		provider := &FcdProvider{
+			categoryID: tc.catID,
+			tagManager: ftm,
+		}
+		tags, err := provider.getSnapshotTags(ctx, tc.snapshotID)
+		c.Assert(err, tc.errChecker)
+		if tc.errChecker == IsNil {
+			c.Assert(len(tags), Equals, tc.expNumTags)
+		}
+	}
+}
+
 type fakeTagManager struct {
 	retGetTagsForCategory []vapitags.Tag
 	errGetTagsForCategory error