Added code to create, query, and delete network tags

Author: mrog

pkg/cloud/tags.go

@@ -18,11 +18,42 @@ package cloud
 
 type TagIFace interface {
 	TagNetwork(string, map[string]string) error
+	GetNetworkTags(string) (map[string]string, error)
+	DeleteNetworkTags(string, map[string]string) error
 }
 
+const resourceTypeNetwork = "network"
+
 // TagNetwork adds tags to a network by network id.
-func (c *client) TagNetwork(networkId string, tag map[string]string) error {
-	p := c.cs.Resourcetags.NewCreateTagsParams([]string{"someid"}, "network", map[string]string{"some": "tag"})
+func (c *client) TagNetwork(networkId string, tags map[string]string) error {
+	// https://cloudstack.apache.org/api/apidocs-4.16/apis/createTags.html
+	p := c.cs.Resourcetags.NewCreateTagsParams([]string{networkId}, resourceTypeNetwork, tags)
 	_, err := c.cs.Resourcetags.CreateTags(p)
 	return err
 }
+
+// GetNetworkTags gets tags by network id.
+func (c *client) GetNetworkTags(networkId string) (map[string]string, error) {
+	// https://cloudstack.apache.org/api/apidocs-4.16/apis/listTags.html
+	p := c.cs.Resourcetags.NewListTagsParams()
+	p.SetResourceid(networkId)
+	p.SetResourcetype(resourceTypeNetwork)
+	if listTagResponse, err := c.cs.Resourcetags.ListTags(p); err != nil {
+		return nil, err
+	} else {
+		tags := make(map[string]string, listTagResponse.Count)
+		for _, t := range listTagResponse.Tags {
+			tags[t.Key] = t.Value
+		}
+		return tags, nil
+	}
+}
+
+// DeleteNetworkTags deletes matching tags from a network
+func (c *client) DeleteNetworkTags(networkId string, tagsToDelete map[string]string) error {
+	// https://cloudstack.apache.org/api/apidocs-4.16/apis/deleteTags.html
+	p := c.cs.Resourcetags.NewDeleteTagsParams([]string{networkId}, resourceTypeNetwork)
+	p.SetTags(tagsToDelete)
+	_, err := c.cs.Resourcetags.DeleteTags(p)
+	return err
+}

pkg/cloud/tags_test.go

@@ -19,99 +19,62 @@ package cloud_test
 import (
 	infrav1 "github.com/aws/cluster-api-provider-cloudstack/api/v1beta1"
 	"github.com/aws/cluster-api-provider-cloudstack/pkg/cloud"
-	"github.com/golang/mock/gomock"
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
 )
 
 var _ = Describe("Tag Unit Tests", func() {
-	var ( // Declare shared vars.
-		mockCtrl *gomock.Controller
-		// 	mockClient  *cloudstack.CloudStackClient
-		// 	ags         *cloudstack.MockAffinityGroupServiceIface
-		// 	fakeAG      *cloud.AffinityGroup
+	var (
 		cluster *infrav1.CloudStackCluster
-		// machine     *infrav1.CloudStackMachine
-		// capiMachine *capiv1.Machine
-	// 	client      cloud.Client
 	)
 
 	BeforeEach(func() {
-		// 	// Setup new mock services.
-		// 	mockCtrl = gomock.NewController(GinkgoT())
-		// 	mockClient = cloudstack.NewMockClient(mockCtrl)
-		// 	ags = mockClient.AffinityGroup.(*cloudstack.MockAffinityGroupServiceIface)
-		// 	client = cloud.NewClientFromCSAPIClient(mockClient)
-		// 	fakeAG = &cloud.AffinityGroup{
-		// 		Name: "FakeAffinityGroup",
-		// 		Type: cloud.AffinityGroupType}
 		cluster = &infrav1.CloudStackCluster{Spec: infrav1.CloudStackClusterSpec{
 			Zone: "Zone1", Network: "SharedGuestNet1"}}
-		// machine = &infrav1.CloudStackMachine{Spec: infrav1.CloudStackMachineSpec{
-		// 	Offering: "Medium Instance", Template: "Ubuntu20"}}
-		// 	machine.ObjectMeta.SetName("rejoshed-affinity-group-test-vm")
-		// capiMachine = &capiv1.Machine{}
 	})
 
-	AfterEach(func() {
-		mockCtrl.Finish()
-	})
-
-	// It("fetches an affinity group", func() {
-	// 	ags.EXPECT().GetAffinityGroupByName(fakeAG.Name).Return(&cloudstack.AffinityGroup{}, 1, nil)
-
-	// 	Ω(client.GetOrCreateAffinityGroup(cluster, fakeAG)).Should(Succeed())
-	// })
-	// It("creates an affinity group", func() {
-	// 	fakeAG.Id = "FakeID"
-	// 	cluster.Spec.Account = "FakeAccount"
-	// 	cluster.Status.DomainID = "FakeDomainId"
-	// 	ags.EXPECT().GetAffinityGroupByID(fakeAG.Id).Return(nil, -1, errors.New("FakeError"))
-	// 	ags.EXPECT().NewCreateAffinityGroupParams(fakeAG.Name, fakeAG.Type).
-	// 		Return(&cloudstack.CreateAffinityGroupParams{})
-	// 	ags.EXPECT().CreateAffinityGroup(ParamMatch(And(AccountEquals("FakeAccount"), DomainIdEquals("FakeDomainId")))).
-	// 		Return(&cloudstack.CreateAffinityGroupResponse{}, nil)
-
-	// 	Ω(client.GetOrCreateAffinityGroup(cluster, fakeAG)).Should(Succeed())
-	// })
-
 	Context("Tag Integ Tests", func() {
 		client, connectionErr := cloud.NewClient("../../cloud-config")
 
-		var ( // Declare shared vars.
-			arbitraryTag *map[string]string
-			networkId    string
+		const (
+			tagKey   = "TestTag"
+			tagValue = "ArbitraryValue"
+		)
+
+		var (
+			networkId string
 		)
 
 		BeforeEach(func() {
 			if connectionErr != nil { // Only do these tests if an actual ACS instance is available via cloud-config.
 				Skip("Could not connect to ACS instance.")
 			}
-			arbitraryTag = &map[string]string{"Arbitrary": "Tag"}
+
 			if err := client.GetOrCreateNetwork(cluster); err != nil {
 				Skip("Could not find network.")
 			}
+
 			networkId = cluster.Status.NetworkID
 		})
 
-		AfterEach(func() {
-			mockCtrl.Finish()
+		It("Tags a network with an arbitrary tag.", func() {
+			tags := map[string]string{tagKey: tagValue}
+			// Delete the tag if it already exists from a prior test run, otherwise the test will fail.
+			_ = client.DeleteNetworkTags(networkId, tags)
+			Ω(client.TagNetwork(networkId, tags)).Should(Succeed())
 		})
 
-		PIt("Tags a network with an arbitrary tag.", func() {
-			// https://cloudstack.apache.org/api/apidocs-4.16/apis/createTags.html
-			Ω(client.TagNetwork(networkId, *arbitraryTag)).Should(Succeed())
+		It("Fetches said tag.", func() {
+			tags, err := client.GetNetworkTags(networkId)
+			Ω(err).Should(BeNil())
+			Ω(tags[tagKey]).Should(Equal(tagValue))
 		})
-		PIt("Fethes said tag.", func() {
-			// It's hard to say what exactly the best method here is. I assume there are many ways to fetch a tag.
-			// Maybe something like GetNetworkTags, GetLBTags, etc...
-			// https://cloudstack.apache.org/api/apidocs-4.16/apis/listTags.html
-			// Ω(client.FetchTag(*arbitraryTag)).Should(Succeed())
-		})
-		PIt("Deletes said tag.", func() {
-			// Same, need some design through around how to delete tags.
-			// https://cloudstack.apache.org/api/apidocs-4.16/apis/deleteTags.html
-			// Ω(client.DeleteTags(networkId, *arbitraryTag)).Should(Succeed())
+
+		It("Deletes said tag.", func() {
+			Ω(client.DeleteNetworkTags(networkId, map[string]string{tagKey: tagValue})).Should(Succeed())
+			remainingTags, err := client.GetNetworkTags(networkId)
+			Ω(err).Should(BeNil())
+			Ω(remainingTags[tagKey]).Should(Equal(""))
 		})
 	})
 })