fix: Allow HIL parser to parse CF request context by dropping annotation keys

docs/brokerpak-specification.md

@@ -558,7 +558,7 @@ The order of combining all plan properties before invoking OpenTofu is as follow
    * `request.default_labels.pcf-organization-guid` - _string_ Mapped from [cloudfoundry context](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#cloud-foundry-context-object) `organization_guid` (provision only).
    * `request.default_labels.pcf-space-guid` - _string_ Mapped from [cloudfoundry context](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#cloud-foundry-context-object) `space_guid` (provision only).
    * `request.default_labels.pcf-instance-id` - _string_ Mapped from the ID of the requested instance.
-* `request.context` - _map[string]any_ Mapped from [cloudfoundry context](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#cloud-foundry-context-object) (provision only).
+* `request.context` - _map[string]any_ Mapped from [cloudfoundry context](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#cloud-foundry-context-object) (provision only). Does not include `organization_annotation` and `space_annotation` keys; see [issue](https://github.com/cloudfoundry/cloud-service-broker/issues/1086).
 * `request.x_broker_api_originating_identity` - _map[string]any_ Mapped from [cloudfoundry `x_broker_api_originating_identity` header](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#originating-identity-header)
 
 #### Bind/Unbind
@@ -571,7 +571,7 @@ The order of combining all plan properties before invoking OpenTofu is as follow
 * `request.app_guid` - _string_ The ID of the application this binding is for. (bind only)
 * `instance.name` - _string_ The name of the instance.
 * `instance.details` - _map[string]any_ Output variables of the instance as specified by ProvisionOutputVariables.
-* `request.context` - _map[string]any_ Mapped from [cloudfoundry context](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#cloud-foundry-context-object) (bind only).
+* `request.context` - _map[string]any_ Mapped from [cloudfoundry context](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#cloud-foundry-context-object) (bind only). Does not include `organization_annotation` and `space_annotation` keys; see [issue](https://github.com/cloudfoundry/cloud-service-broker/issues/1086).
 * `request.x_broker_api_originating_identity` - _map[string]any_ Mapped from [cloudfoundry `x_broker_api_originating_identity` header](https://github.com/openservicebrokerapi/servicebroker/blob/master/profile.md#originating-identity-header)
 
 ## File format

internal/paramparser/parse_provision_details.go

@@ -36,6 +36,16 @@ func ParseProvisionDetails(input domain.ProvisionDetails) (ProvisionDetails, err
 		}
 	}
 
+	// Special case: These two values are maps and must be removed so the HIL parser
+	// can access the rest of the values, which are strings.
+	// See: https://github.com/cloudfoundry/cloud-service-broker/issues/1086
+	if s, ok := result.RequestContext["platform"].(string); ok {
+		if s == "cloudfoundry" {
+			delete(result.RequestContext, "organization_annotations")
+			delete(result.RequestContext, "space_annotations")
+		}
+	}
+
 	if s, ok := result.RequestContext["organization_guid"].(string); ok {
 		result.OrganizationGUID = s
 	}

internal/paramparser/parse_provision_details_test.go

@@ -104,4 +104,46 @@ var _ = Describe("ParseProvisionDetails", func() {
 			Expect(pd.SpaceGUID).To(Equal("fake-space-guid-1"))
 		})
 	})
+
+	When("a cloudfoundry context contains space_annotations or organization_annotations keys", func() {
+		ctx := `{"platform": "cloudfoundry", "space_guid": "fake-space-guid", "space_annotations": {"a": "b"}, "organization_guid": "fake-org-guid", "organization_annotations": {"a": "b"}}`
+		It("removes the annotation keys", func() {
+			pd, err := paramparser.ParseProvisionDetails(domain.ProvisionDetails{
+				RawContext: []byte(ctx),
+			})
+
+			Expect(err).NotTo(HaveOccurred())
+			Expect(pd.RequestContext).ToNot(HaveKey("organization_annotations"))
+			Expect(pd.RequestContext).ToNot(HaveKey("space_annotations"))
+		})
+
+		It("ignores all other keys and their values", func() {
+			pd, err := paramparser.ParseProvisionDetails(domain.ProvisionDetails{
+				RawContext: []byte(ctx),
+			})
+
+			Expect(err).NotTo(HaveOccurred())
+			Expect(pd.RequestContext).To(HaveKey("platform"))
+			Expect(pd.RequestContext["platform"]).To(Equal("cloudfoundry"))
+			Expect(pd.RequestContext).To(HaveKey("space_guid"))
+			Expect(pd.RequestContext["space_guid"]).To(Equal("fake-space-guid"))
+			Expect(pd.RequestContext).To(HaveKey("organization_guid"))
+			Expect(pd.RequestContext["organization_guid"]).To(Equal("fake-org-guid"))
+		})
+	})
+
+	When("non-cloudfoundry context contains space_annotations or organization_annotations keys", func() {
+		ctx := `{"platform": "kubernetes", "space_guid": "fake-space-guid", "space_annotations": {"a": "b"}, "organization_guid": "fake-org-guid", "organization_annotations": {"a": "b"}}`
+		It("ignores the annotation keys and their values", func() {
+			pd, err := paramparser.ParseProvisionDetails(domain.ProvisionDetails{
+				RawContext: []byte(ctx),
+			})
+
+			Expect(err).NotTo(HaveOccurred())
+			Expect(pd.RequestContext).To(HaveKey("organization_annotations"))
+			Expect(pd.RequestContext["organization_annotations"]).To(HaveKey("a"))
+			Expect(pd.RequestContext).To(HaveKey("space_annotations"))
+			Expect(pd.RequestContext["space_annotations"]).To(HaveKey("a"))
+		})
+	})
 })