Update cf service instance test go for metadata label (#543)

* Add metadata label to cf service instance logic

* Update cf service instance test go for metadata label

* fix golint error in switch type assertion

* update service instance doc

---------

Co-authored-by: Jessica Kim <[email protected]>

Author: Jess713

cloudfoundry/resource_cf_service_instance.go

@@ -88,6 +88,8 @@ func resourceServiceInstance() *schema.Resource {
 					return true
 				},
 			},
+			labelsKey:      labelsSchema(),
+			annotationsKey: annotationsSchema(),
 		},
 		CustomizeDiff: customdiff.All(
 			customdiff.ForceNewIf(
@@ -117,6 +119,22 @@ func resourceServiceInstanceCreate(ctx context.Context, d *schema.ResourceData,
 	space := d.Get("space").(string)
 	jsonParameters := d.Get("json_params").(string)
 	tags := make([]string, 0)
+	labels := d.Get("labels").(map[string]interface{})
+	metadata := resources.Metadata{
+		Labels: map[string]types.NullString{},
+	}
+
+	for key, label := range labels {
+		switch v := label.(type) {
+		case types.NullString:
+			metadata.Labels[key] = v
+		case string:
+			metadata.Labels[key] = types.NullString{
+				Value: v,
+				IsSet: true,
+			}
+		}
+	}
 
 	for _, v := range d.Get("tags").([]interface{}) {
 		tags = append(tags, v.(string))
@@ -145,6 +163,7 @@ func resourceServiceInstanceCreate(ctx context.Context, d *schema.ResourceData,
 	serviceInstance.ServicePlanGUID = servicePlan
 	serviceInstance.Tags = tagsFormatted
 	serviceInstance.Parameters = paramsFormatted
+	serviceInstance.Metadata = &metadata
 
 	jobURL, _, err := session.ClientV3.CreateServiceInstance(serviceInstance)
 	if err != nil {
@@ -219,6 +238,15 @@ func resourceServiceInstanceRead(ctx context.Context, d *schema.ResourceData, me
 	d.Set("service_plan", serviceInstance.ServicePlanGUID)
 	d.Set("space", serviceInstance.SpaceGUID)
 
+	labels := make(map[string]string)
+
+	for key, label := range serviceInstance.Metadata.Labels {
+		if label.IsSet {
+			labels[key] = label.Value
+		}
+	}
+	d.Set("labels", labels)
+
 	if serviceInstance.Tags.IsSet {
 		tags := make([]interface{}, len(serviceInstance.Tags.Value))
 		for i, v := range serviceInstance.Tags.Value {
@@ -270,6 +298,10 @@ func resourceServiceInstanceUpdate(ctx context.Context, d *schema.ResourceData,
 	id = d.Id()
 	jsonParameters := d.Get("json_params").(string)
 	space := d.Get("space").(string)
+	labels := d.Get("labels").(map[string]interface{})
+	metadata := resources.Metadata{
+		Labels: map[string]types.NullString{},
+	}
 
 	if len(jsonParameters) > 0 {
 		err := json.Unmarshal([]byte(jsonParameters), &params)
@@ -280,6 +312,18 @@ func resourceServiceInstanceUpdate(ctx context.Context, d *schema.ResourceData,
 	tags = make([]string, 0)
 	// log.Printf("Tags : %+v", tags)
 
+	for key, label := range labels {
+		switch v := label.(type) {
+		case types.NullString:
+			metadata.Labels[key] = v
+		case string:
+			metadata.Labels[key] = types.NullString{
+				Value: v,
+				IsSet: true,
+			}
+		}
+	}
+
 	for _, v := range d.Get("tags").([]interface{}) {
 		tags = append(tags, v.(string))
 	}
@@ -304,6 +348,7 @@ func resourceServiceInstanceUpdate(ctx context.Context, d *schema.ResourceData,
 		Name:       name,
 		Parameters: paramsFormatted,
 		Tags:       tagsFormatted,
+		Metadata:   &metadata,
 	}
 	// Some services don't support changing service plan, so we only add it to request body only if changed by user
 	if d.HasChange("service_plan") {
@@ -441,5 +486,5 @@ func resourceServiceInstanceImport(ctx context.Context, d *schema.ResourceData,
 }
 
 func isServiceInstanceUpdateRequired(d ResourceChanger) bool {
-	return d.HasChange("name") || d.HasChange("service_plan") || d.HasChange("json_params") || d.HasChange("tags")
+	return d.HasChange("name") || d.HasChange("service_plan") || d.HasChange("json_params") || d.HasChange("tags") || d.HasChange("labels")
 }

cloudfoundry/resource_cf_service_instance_test.go

@@ -2,10 +2,12 @@ package cloudfoundry
 
 import (
 	"fmt"
+	"log"
 	"testing"
 
 	"code.cloudfoundry.org/cli/api/cloudcontroller/ccv2"
 	"code.cloudfoundry.org/cli/api/cloudcontroller/ccv2/constant"
+	"code.cloudfoundry.org/cli/api/cloudcontroller/ccv3"
 	"github.com/terraform-providers/terraform-provider-cloudfoundry/cloudfoundry/managers"
 
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/resource"
@@ -22,6 +24,9 @@ resource "cloudfoundry_service_instance" "test-service-instance" {
   space = "%s"
   service_plan = "${data.cloudfoundry_service.test-service.service_plans["%s"]}"
   tags = [ "tag-1" , "tag-2" ]
+  labels = {
+	instance-name = "test-service-instance"
+  }
 }
 `
 
@@ -35,6 +40,9 @@ resource "cloudfoundry_service_instance" "test-service-instance" {
   space = "%s"
   service_plan = "${data.cloudfoundry_service.test-service.service_plans["%s"]}"
   tags = [ "tag-2", "tag-3", "tag-4" ]
+  labels = {
+	instance-name = "%s"
+  }
 }
 `
 
@@ -97,6 +105,7 @@ func TestAccResServiceInstance_normal(t *testing.T) {
 
 	spaceId, _ := defaultTestSpace(t)
 	serviceName1, _, servicePlan := getTestServiceBrokers(t)
+	labelVal := "new-service-label-updated"
 
 	ref := "cloudfoundry_service_instance.test-service-instance"
 
@@ -125,12 +134,14 @@ func TestAccResServiceInstance_normal(t *testing.T) {
 							ref, "tags.0", "tag-1"),
 						resource.TestCheckResourceAttr(
 							ref, "tags.1", "tag-2"),
+						resource.TestCheckResourceAttr(
+							ref, "labels.instance-name", "test-service-instance"),
 					),
 				},
 
 				resource.TestStep{
 					Config: fmt.Sprintf(serviceInstanceResourceUpdate,
-						serviceName1, spaceId, servicePlan,
+						serviceName1, spaceId, servicePlan, labelVal,
 					),
 					Check: resource.ComposeTestCheckFunc(
 						testAccCheckServiceInstanceExists(ref),
@@ -144,8 +155,16 @@ func TestAccResServiceInstance_normal(t *testing.T) {
 							ref, "tags.1", "tag-3"),
 						resource.TestCheckResourceAttr(
 							ref, "tags.2", "tag-4"),
+						resource.TestCheckResourceAttr(
+							ref, "labels.instance-name", labelVal),
 					),
 				},
+				resource.TestStep{
+					Config: fmt.Sprintf(serviceInstanceResourceCreate,
+						serviceName1, spaceId, servicePlan,
+					),
+					Check: testAccCheckServiceInstanceMetadataExists(ref),
+				},
 			},
 		})
 }
@@ -186,6 +205,52 @@ func TestAccResServiceInstances_withFakePlans(t *testing.T) {
 		})
 }
 
+func testAccCheckServiceInstanceMetadataExists(resource string) resource.TestCheckFunc {
+
+	return func(s *terraform.State) error {
+		// Retrieve the currently active session object
+		session := testAccProvider.Meta().(*managers.Session)
+
+		// rs : represents the resource from Terraform statefile
+		rs, ok := s.RootModule().Resources[resource]
+
+		if !ok {
+			return fmt.Errorf("service instance '%s' not found in terraform state", resource)
+		}
+
+		// It retrieves the ID of the resource from the Terraform state.
+		GUID := rs.Primary.ID
+
+		serviceInstances, _, _, err := session.ClientV3.GetServiceInstances(ccv3.Query{
+			Key:    ccv3.GUIDFilter,
+			Values: []string{GUID},
+		})
+		if err != nil {
+			return err
+		}
+
+		if len(serviceInstances) == 0 {
+			return fmt.Errorf("Service instance with guid: %s not found", GUID)
+		} else {
+			// _ is used to ignore the i of this loop
+			for _, instance := range serviceInstances {
+				metadata := instance.Metadata
+				labelVal, found := metadata.Labels["instance-name"]
+				log.Printf("!!!! Found service instance : %+v", serviceInstances)
+				if found {
+					fmt.Printf("Label 'Instance-name' is: %v\n", labelVal)
+					return nil
+				} else {
+					return fmt.Errorf("Label 'instance-name' does not exist in this resource\n")
+				}
+			}
+
+		}
+
+		return fmt.Errorf("Unexpected condition, no return hit")
+	}
+}
+
 func testAccCheckServiceInstanceExists(resource string) resource.TestCheckFunc {
 
 	return func(s *terraform.State) error {

docs/resources/service_instance.md

@@ -37,6 +37,16 @@ The following arguments are supported:
 * `recursive_delete` - DEPRECATED, Since CF API v3, recursive delete is done automatically by the cloudcontroller. This will be removed in future releases.
 * `replace_on_params_change` - (Optional, Bool) Default: `false`. If set `true`, Cloud Foundry will replace the resource on any params change. This is useful if the service does not support parameter updates.
 * `replace_on_service_plan_change` - (Optional, Bool) Default: `false`. If set `true`, Cloud Foundry will replace the resource on any service plan changes. Some brokered services do not support plan changes and this allows the provider to handle those cases.
+* `labels` - (Optional, map string of string) Add labels as described [here](https://docs.cloudfoundry.org/adminguide/metadata.html#-view-metadata-for-an-object). Works only on cloud foundry with api >= v3.63. Below is an example usage.
+
+```hcl
+resource "cf_service_instance" "my-cloud" {
+  name   = "service-in-my-cloud"
+  labels = {
+    instance-name = "service-in-my-cloud"
+    instance-type = "my-type"
+  }
+```
 
 ## Attributes Reference