Merge pull request #499 from stoyangenchev/feature/service-broker-provided-metadata

Add support for Service Broker-provided metadata on Service Instances

Author: sneal

CHANGELOG.md

@@ -7,6 +7,7 @@
 - Support for setting and reading application lifecycle (`buildpack`, `docker`, and `cnb`/Cloud Native Buildpacks) in V3 API.
 - Custom marshaling/unmarshaling for `Lifecycle` struct to support multiple lifecycle types.
 - Unit tests for all lifecycle types, including CNB.
+- Support for Service Broker-provided metadata (labels and attributes) on Service Instances. This includes the `BrokerProvidedMetadata` field on `ServiceInstance`, `ServiceInstanceManagedCreate`, and `ServiceInstanceManagedUpdate` structs, along with fluent builder methods for managing labels and attributes.
 
 ### Changed
 

resource/broker_provided_metadata.go

@@ -0,0 +1,100 @@
+package resource
+
+import (
+	"fmt"
+	"strings"
+)
+
+// BrokerProvidedMetadata allows the Service Broker to tag API resources with information that does not directly affect their functionality.
+type BrokerProvidedMetadata struct {
+	Labels     map[string]*string `json:"labels"`
+	Attributes map[string]*string `json:"attributes"`
+}
+
+// NewBrokerProvidedMetadata creates a new broker provided metadata instance
+func NewBrokerProvidedMetadata() *BrokerProvidedMetadata {
+	return &BrokerProvidedMetadata{}
+}
+
+// WithAttribute is a fluent method alias for SetAttribute
+func (m *BrokerProvidedMetadata) WithAttribute(prefix, key string, v string) *BrokerProvidedMetadata {
+	m.SetAttribute(prefix, key, v)
+	return m
+}
+
+// WithLabel is a fluent method alias for SetLabel
+func (m *BrokerProvidedMetadata) WithLabel(prefix, key string, v string) *BrokerProvidedMetadata {
+	m.SetLabel(prefix, key, v)
+	return m
+}
+
+// SetAttribute to the broker provided metadata instance
+//
+// The prefix and value are optional and may be an empty string. The key must be at least 1 character in length.
+func (m *BrokerProvidedMetadata) SetAttribute(prefix, key string, v string) {
+	if m.Attributes == nil {
+		m.Attributes = make(map[string]*string)
+	}
+	if len(prefix) > 0 {
+		m.Attributes[fmt.Sprintf("%s/%s", prefix, key)] = &v
+	} else {
+		m.Attributes[key] = &v
+	}
+}
+
+// RemoveAttribute removes an attribute by setting the specified key's value to nil which can then be passed to the API
+func (m *BrokerProvidedMetadata) RemoveAttribute(prefix, key string) {
+	if m.Attributes == nil {
+		m.Attributes = make(map[string]*string)
+	}
+	if len(prefix) > 0 {
+		m.Attributes[fmt.Sprintf("%s/%s", prefix, key)] = nil
+	} else {
+		m.Attributes[key] = nil
+	}
+}
+
+// SetLabel to the broker provided metadata instance
+//
+// The prefix and value are optional and may be an empty string. The key must be at least 1 character in length.
+func (m *BrokerProvidedMetadata) SetLabel(prefix, key string, v string) {
+	if m.Labels == nil {
+		m.Labels = make(map[string]*string)
+	}
+	if len(prefix) > 0 {
+		m.Labels[fmt.Sprintf("%s/%s", prefix, key)] = &v
+	} else {
+		m.Labels[key] = &v
+	}
+}
+
+// RemoveLabel removes a label by setting the specified key's value to nil which can then be passed to the API
+func (m *BrokerProvidedMetadata) RemoveLabel(prefix, key string) {
+	if m.Labels == nil {
+		m.Labels = make(map[string]*string)
+	}
+	if len(prefix) > 0 {
+		m.Labels[fmt.Sprintf("%s/%s", prefix, key)] = nil
+	} else {
+		m.Labels[key] = nil
+	}
+}
+
+// Clear automatically calls Remove on all attributes and labels present in the broker provided metadata instance
+func (m *BrokerProvidedMetadata) Clear() {
+	splitKey := func(k string) (string, string) {
+		p := strings.Split(k, "/")
+		if len(p) == 1 {
+			return "", p[0]
+		}
+		return p[0], p[1]
+	}
+	for k := range m.Attributes {
+		prefix, key := splitKey(k)
+		m.RemoveAttribute(prefix, key)
+	}
+	for k := range m.Labels {
+		prefix, key := splitKey(k)
+		m.RemoveLabel(prefix, key)
+	}
+}

resource/broker_provided_metadata_test.go

@@ -0,0 +1,77 @@
+package resource_test
+
+import (
+	"fmt"
+	"testing"
+
+	"github.com/cloudfoundry/go-cfclient/v3/resource"
+
+	"github.com/stretchr/testify/require"
+)
+
+func TestBrokerProvidedMetadata(t *testing.T) {
+	type metaTest struct {
+		prefix string
+		key    string
+		value  string
+	}
+	tests := []metaTest{
+		{
+			prefix: "pre",
+			key:    "key",
+			value:  "val",
+		},
+		{
+			prefix: "",
+			key:    "empty-pre-key",
+			value:  "val",
+		},
+		{
+			prefix: "cf.example.org",
+			key:    "key",
+			value:  "val",
+		},
+		{
+			prefix: "pre",
+			key:    "no-val-key",
+			value:  "",
+		},
+		{
+			prefix: "",
+			key:    "only-key",
+			value:  "",
+		},
+	}
+
+	for _, tt := range tests {
+		k := fmt.Sprintf("%s/%s", tt.prefix, tt.key)
+		if tt.prefix == "" {
+			k = tt.key
+		}
+
+		// add some attributes and labels
+		m := resource.BrokerProvidedMetadata{}
+		m.SetAttribute(tt.prefix, tt.key, tt.value)
+		m.SetLabel(tt.prefix, tt.key, tt.value)
+		require.Equal(t, tt.value, *m.Attributes[k], "key: %s", k)
+		require.Equal(t, tt.value, *m.Labels[k], "key: %s", k)
+
+		// remove them
+		m.RemoveAttribute(tt.prefix, tt.key)
+		m.RemoveLabel(tt.prefix, tt.key)
+		require.Nil(t, m.Attributes[k], "key: %s", k)
+		require.Nil(t, m.Labels[k], "key: %s", k)
+
+		// new attributes and labels
+		m = resource.BrokerProvidedMetadata{}
+		m.SetAttribute(tt.prefix, tt.key, tt.value)
+		m.SetLabel(tt.prefix, tt.key, tt.value)
+		require.Equal(t, tt.value, *m.Attributes[k], "key: %s", k)
+		require.Equal(t, tt.value, *m.Labels[k], "key: %s", k)
+
+		// clear
+		m.Clear()
+		require.Nil(t, m.Attributes[k], "key: %s", k)
+		require.Nil(t, m.Labels[k], "key: %s", k)
+	}
+}

resource/service_instance.go

@@ -5,12 +5,13 @@ import (
 )
 
 type ServiceInstance struct {
-	Name          string                       `json:"name"`
-	Tags          []string                     `json:"tags"` // Used by apps to identify service instances; they are shown in the app VCAP_SERVICES env
-	Type          string                       `json:"type"` // Either managed or user-provided
-	LastOperation LastOperation                `json:"last_operation"`
-	Relationships ServiceInstanceRelationships `json:"relationships"`
-	Metadata      *Metadata                    `json:"metadata"`
+	Name                   string                       `json:"name"`
+	Tags                   []string                     `json:"tags"` // Used by apps to identify service instances; they are shown in the app VCAP_SERVICES env
+	Type                   string                       `json:"type"` // Either managed or user-provided
+	LastOperation          LastOperation                `json:"last_operation"`
+	Relationships          ServiceInstanceRelationships `json:"relationships"`
+	Metadata               *Metadata                    `json:"metadata"`
+	BrokerProvidedMetadata *BrokerProvidedMetadata      `json:"broker_provided_metadata"`
 
 	// Information about the version of this service instance; only shown when type is managed
 	MaintenanceInfo *ServiceInstanceMaintenanceInfo `json:"maintenance_info,omitempty"`
@@ -32,12 +33,13 @@ type ServiceInstance struct {
 }
 
 type ServiceInstanceManagedCreate struct {
-	Type          string                       `json:"type"` // Either managed or user-provided
-	Name          string                       `json:"name"`
-	Relationships ServiceInstanceRelationships `json:"relationships"`
-	Metadata      *Metadata                    `json:"metadata,omitempty"`
-	Parameters    *json.RawMessage             `json:"parameters,omitempty"` // A JSON object that is passed to the service broker
-	Tags          []string                     `json:"tags,omitempty"`
+	Type                   string                       `json:"type"` // Either managed or user-provided
+	Name                   string                       `json:"name"`
+	Relationships          ServiceInstanceRelationships `json:"relationships"`
+	Metadata               *Metadata                    `json:"metadata,omitempty"`
+	BrokerProvidedMetadata *BrokerProvidedMetadata      `json:"broker_provided_metadata,omitempty"`
+	Parameters             *json.RawMessage             `json:"parameters,omitempty"` // A JSON object that is passed to the service broker
+	Tags                   []string                     `json:"tags,omitempty"`
 }
 type ServiceInstanceUserProvidedCreate struct {
 	Type            string                       `json:"type"` // Either managed or user-provided
@@ -51,12 +53,13 @@ type ServiceInstanceUserProvidedCreate struct {
 }
 
 type ServiceInstanceManagedUpdate struct {
-	Name            *string                         `json:"name,omitempty"`
-	Relationships   *ServiceInstanceRelationships   `json:"relationships,omitempty"`
-	MaintenanceInfo *ServiceInstanceMaintenanceInfo `json:"maintenance_info,omitempty"`
-	Parameters      *json.RawMessage                `json:"parameters,omitempty"` // A JSON object that is passed to the service broker
-	Tags            []string                        `json:"tags"`
-	Metadata        *Metadata                       `json:"metadata,omitempty"`
+	Name                   *string                         `json:"name,omitempty"`
+	Relationships          *ServiceInstanceRelationships   `json:"relationships,omitempty"`
+	MaintenanceInfo        *ServiceInstanceMaintenanceInfo `json:"maintenance_info,omitempty"`
+	Parameters             *json.RawMessage                `json:"parameters,omitempty"` // A JSON object that is passed to the service broker
+	Tags                   []string                        `json:"tags"`
+	Metadata               *Metadata                       `json:"metadata,omitempty"`
+	BrokerProvidedMetadata *BrokerProvidedMetadata         `json:"broker_provided_metadata,omitempty"`
 }
 
 type ServiceInstanceUserProvidedUpdate struct {
@@ -140,6 +143,11 @@ func (u *ServiceInstanceManagedCreate) WithParameters(parameters json.RawMessage
 	return u
 }
 
+func (u *ServiceInstanceManagedCreate) WithBrokerProvidedMetadata(metadata *BrokerProvidedMetadata) *ServiceInstanceManagedCreate {
+	u.BrokerProvidedMetadata = metadata
+	return u
+}
+
 func NewServiceInstanceCreateUserProvided(name, spaceGUID string) *ServiceInstanceUserProvidedCreate {
 	return &ServiceInstanceUserProvidedCreate{
 		Type: "user-provided",
@@ -212,6 +220,11 @@ func (u *ServiceInstanceManagedUpdate) WithMaintenanceInfo(version, description
 	return u
 }
 
+func (u *ServiceInstanceManagedUpdate) WithBrokerProvidedMetadata(metadata *BrokerProvidedMetadata) *ServiceInstanceManagedUpdate {
+	u.BrokerProvidedMetadata = metadata
+	return u
+}
+
 func NewServiceInstanceUserProvidedUpdate() *ServiceInstanceUserProvidedUpdate {
 	return &ServiceInstanceUserProvidedUpdate{}
 }

testutil/template/service_instance.json

@@ -33,6 +33,10 @@
     "labels": {},
     "annotations": {}
   },
+  "broker_provided_metadata": {
+    "labels": {},
+    "attributes": {}
+  },
   "links": {
     "self": {
       "href": "https://api.example.org/v3/service_instances/{{.GUID}}"

testutil/template/service_instance_user_provided.json

@@ -25,6 +25,10 @@
     "labels": {},
     "annotations": {}
   },
+  "broker_provided_metadata": {
+    "labels": {},
+    "attributes": {}
+  },
   "links": {
     "self": {
       "href": "https://api.example.org/v3/service_instances/88ce23e5-27c3-4381-a2df-32a28ec43133"