Add CRUD metadata functions to CatalogItem

.changes/v2.16.0/471-features.md

@@ -0,0 +1,3 @@
+* Added support to set, get and delete metadata to CatalogItem with the methods
+  `CatalogItem.AddMetadataEntry`, `CatalogItem.AddMetadataEntryAsync`, `CatalogItem.GetMetadata`,
+  `CatalogItem.DeleteMetadataEntry` and `CatalogItem.DeleteMetadataEntryAsync`. [GH-471]

govcd/metadata.go

@@ -878,6 +878,44 @@ func (orgVdcNetwork *OrgVDCNetwork) DeleteMetadataEntryAsync(key string) (Task,
 	return deleteMetadata(orgVdcNetwork.client, key, strings.ReplaceAll(orgVdcNetwork.OrgVDCNetwork.HREF, "/api/", "/api/admin/"))
 }
 
+// GetMetadata returns CatalogItem metadata.
+func (catalogItem *CatalogItem) GetMetadata() (*types.Metadata, error) {
+	return getMetadata(catalogItem.client, catalogItem.CatalogItem.HREF)
+}
+
+// AddMetadataEntry adds CatalogItem metadata typedValue and key/value pair provided as input
+// and waits for the task to finish.
+func (catalogItem *CatalogItem) AddMetadataEntry(typedValue, key, value string) error {
+	task, err := catalogItem.AddMetadataEntryAsync(typedValue, key, value)
+	if err != nil {
+		return err
+	}
+	return task.WaitTaskCompletion()
+}
+
+// AddMetadataEntryAsync adds CatalogItem metadata typedValue and key/value pair provided as input
+// and returns the task.
+func (catalogItem *CatalogItem) AddMetadataEntryAsync(typedValue, key, value string) (Task, error) {
+	return addMetadata(catalogItem.client, typedValue, key, value, catalogItem.CatalogItem.HREF)
+}
+
+// DeleteMetadataEntry deletes CatalogItem metadata depending on key provided as input
+// and waits for the task to finish.
+func (catalogItem *CatalogItem) DeleteMetadataEntry(key string) error {
+	task, err := catalogItem.DeleteMetadataEntryAsync(key)
+	if err != nil {
+		return err
+	}
+
+	return task.WaitTaskCompletion()
+}
+
+// DeleteMetadataEntryAsync deletes CatalogItem metadata depending on key provided as input
+// and returns a task.
+func (catalogItem *CatalogItem) DeleteMetadataEntryAsync(key string) (Task, error) {
+	return deleteMetadata(catalogItem.client, key, catalogItem.CatalogItem.HREF)
+}
+
 // OpenAPI metadata functions
 
 // GetMetadata returns OpenApiOrgVdcNetwork metadata.

govcd/metadata_test.go

@@ -900,6 +900,54 @@ func (vcd *TestVCD) Test_MetadataOnVdcNetworkCRUD(check *C) {
 	check.Assert(len(metadata.MetadataEntry), Equals, 0)
 }
 
+func (vcd *TestVCD) Test_MetadataOnCatalogItemCRUD(check *C) {
+	fmt.Printf("Running: %s\n", check.TestName())
+	catalog, err := vcd.org.GetCatalogByName(vcd.config.VCD.Catalog.Name, false)
+	if err != nil {
+		check.Skip(fmt.Sprintf("%s: Catalog %s not found. Test can't proceed", check.TestName(), vcd.config.VCD.Catalog.Name))
+		return
+	}
+
+	catalogItem, err := catalog.GetCatalogItemByName(vcd.config.VCD.Catalog.CatalogItem, false)
+	if err != nil {
+		check.Skip(fmt.Sprintf("%s: Catalog item %s not found. Test can't proceed", check.TestName(), vcd.config.VCD.Catalog.CatalogItem))
+		return
+	}
+
+	// Check how much metadata exists
+	metadata, err := catalogItem.GetMetadata()
+	check.Assert(err, IsNil)
+	check.Assert(metadata, NotNil)
+	existingMetaDataCount := len(metadata.MetadataEntry)
+
+	// Add metadata
+	err = catalogItem.AddMetadataEntry(types.MetadataStringValue, "key", "value")
+	check.Assert(err, IsNil)
+
+	// Check if metadata was added correctly
+	metadata, err = catalogItem.GetMetadata()
+	check.Assert(err, IsNil)
+	check.Assert(metadata, NotNil)
+	check.Assert(len(metadata.MetadataEntry), Equals, existingMetaDataCount+1)
+	var foundEntry *types.MetadataEntry
+	for _, entry := range metadata.MetadataEntry {
+		if entry.Key == "key" {
+			foundEntry = entry
+		}
+	}
+	check.Assert(foundEntry, NotNil)
+	check.Assert(foundEntry.Key, Equals, "key")
+	check.Assert(foundEntry.TypedValue.Value, Equals, "value")
+
+	err = catalogItem.DeleteMetadataEntry("key")
+	check.Assert(err, IsNil)
+	// Check if metadata was deleted correctly
+	metadata, err = catalogItem.GetMetadata()
+	check.Assert(err, IsNil)
+	check.Assert(metadata, NotNil)
+	check.Assert(len(metadata.MetadataEntry), Equals, 0)
+}
+
 func (vcd *TestVCD) Test_MetadataOnOpenApiOrgVdcNetworkCRUD(check *C) {
 	fmt.Printf("Running: %s\n", check.TestName())
 	net, err := vcd.vdc.GetOpenApiOrgVdcNetworkByName(vcd.config.VCD.Network.Net1)