Add support for binding details

Author: st3v

api.go

@@ -18,6 +18,7 @@ const instanceDetailsLogKey = "instance-details"
 const bindingIDLogKey = "binding-id"
 
 const invalidServiceDetailsErrorKey = "invalid-service-details"
+const invalidBindDetailsErrorKey = "invalid-bind-details"
 const instanceLimitReachedErrorKey = "instance-limit-reached"
 const instanceAlreadyExistsErrorKey = "instance-already-exists"
 const bindingAlreadyExistsErrorKey = "binding-already-exists"
@@ -142,7 +143,16 @@ func bind(serviceBroker ServiceBroker, router httpRouter, logger lager.Logger) h
 			bindingIDLogKey:  bindingID,
 		})
 
-		credentials, err := serviceBroker.Bind(instanceID, bindingID)
+		var details BindDetails
+		if err := json.NewDecoder(req.Body).Decode(&details); err != nil {
+			logger.Error(invalidBindDetailsErrorKey, err)
+			respond(w, statusUnprocessableEntity, ErrorResponse{
+				Description: err.Error(),
+			})
+			return
+		}
+
+		credentials, err := serviceBroker.Bind(instanceID, bindingID, details)
 		if err != nil {
 			switch err {
 			case ErrInstanceDoesNotExist:

api_test.go

@@ -428,12 +428,22 @@ var _ = Describe("Service Broker API", func() {
 	})
 
 	Describe("binding lifecycle endpoint", func() {
-		makeBindingRequest := func(instanceID string, bindingID string) *testflight.Response {
+		makeBindingRequest := func(instanceID, bindingID string, details *brokerapi.BindDetails) *testflight.Response {
 			response := &testflight.Response{}
 			testflight.WithServer(brokerAPI, func(r *testflight.Requester) {
 				path := fmt.Sprintf("/v2/service_instances/%s/service_bindings/%s",
 					instanceID, bindingID)
-				request, _ := http.NewRequest("PUT", path, strings.NewReader(""))
+
+				buffer := &bytes.Buffer{}
+
+				if details != nil {
+					json.NewEncoder(buffer).Encode(details)
+				}
+
+				request, err := http.NewRequest("PUT", path, buffer)
+
+				Expect(err).NotTo(HaveOccurred())
+
 				request.Header.Add("Content-Type", "application/json")
 				request.SetBasicAuth("username", "password")
 
@@ -443,24 +453,42 @@ var _ = Describe("Service Broker API", func() {
 		}
 
 		Describe("binding", func() {
+			var details *brokerapi.BindDetails
+
+			BeforeEach(func() {
+				details = &brokerapi.BindDetails{
+					AppGUID:   "app_guid",
+					PlanID:    "plan_id",
+					ServiceID: "service_id",
+				}
+			})
+
 			Context("when the associated instance exists", func() {
 				It("calls Bind on the service broker with the instance and binding ids", func() {
 					instanceID := uniqueInstanceID()
 					bindingID := uniqueBindingID()
-					makeBindingRequest(instanceID, bindingID)
+					makeBindingRequest(instanceID, bindingID, details)
 					Expect(fakeServiceBroker.BoundInstanceIDs).To(ContainElement(instanceID))
 					Expect(fakeServiceBroker.BoundBindingIDs).To(ContainElement(bindingID))
+					Expect(fakeServiceBroker.BoundBindingDetails).To(Equal(*details))
 				})
 
 				It("returns the credentials returned by Bind", func() {
-					response := makeBindingRequest(uniqueInstanceID(), uniqueBindingID())
+					response := makeBindingRequest(uniqueInstanceID(), uniqueBindingID(), details)
 					Expect(response.Body).To(MatchJSON(fixture("binding.json")))
 				})
 
 				It("returns a 201", func() {
-					response := makeBindingRequest(uniqueInstanceID(), uniqueBindingID())
+					response := makeBindingRequest(uniqueInstanceID(), uniqueBindingID(), details)
 					Expect(response.StatusCode).To(Equal(201))
 				})
+
+				Context("when no bind details are being passed", func() {
+					It("returns a 422", func() {
+						response := makeBindingRequest(uniqueInstanceID(), uniqueBindingID(), nil)
+						Expect(response.StatusCode).To(Equal(422))
+					})
+				})
 			})
 
 			Context("when the associated instance does not exist", func() {
@@ -471,18 +499,18 @@ var _ = Describe("Service Broker API", func() {
 				})
 
 				It("returns a 404", func() {
-					response := makeBindingRequest(uniqueInstanceID(), uniqueBindingID())
+					response := makeBindingRequest(uniqueInstanceID(), uniqueBindingID(), details)
 					Expect(response.StatusCode).To(Equal(404))
 				})
 
 				It("returns an error JSON object", func() {
-					response := makeBindingRequest(uniqueInstanceID(), uniqueBindingID())
+					response := makeBindingRequest(uniqueInstanceID(), uniqueBindingID(), details)
 					Expect(response.Body).To(MatchJSON(`{"description":"instance does not exist"}`))
 				})
 
 				It("logs an appropriate error", func() {
 					instanceID = uniqueInstanceID()
-					makeBindingRequest(instanceID, uniqueBindingID())
+					makeBindingRequest(instanceID, uniqueBindingID(), details)
 					Expect(lastLogLine().Message).To(ContainSubstring("bind.instance-missing"))
 					Expect(lastLogLine().Data["error"]).To(ContainSubstring("instance does not exist"))
 				})
@@ -496,19 +524,19 @@ var _ = Describe("Service Broker API", func() {
 				})
 
 				It("returns a 409", func() {
-					response := makeBindingRequest(uniqueInstanceID(), uniqueBindingID())
+					response := makeBindingRequest(uniqueInstanceID(), uniqueBindingID(), details)
 					Expect(response.StatusCode).To(Equal(409))
 				})
 
 				It("returns an error JSON object", func() {
-					response := makeBindingRequest(uniqueInstanceID(), uniqueBindingID())
+					response := makeBindingRequest(uniqueInstanceID(), uniqueBindingID(), details)
 					Expect(response.Body).To(MatchJSON(`{"description":"binding already exists"}`))
 				})
 
 				It("logs an appropriate error", func() {
 					instanceID = uniqueInstanceID()
-					makeBindingRequest(instanceID, uniqueBindingID())
-					makeBindingRequest(instanceID, uniqueBindingID())
+					makeBindingRequest(instanceID, uniqueBindingID(), details)
+					makeBindingRequest(instanceID, uniqueBindingID(), details)
 
 					Expect(lastLogLine().Message).To(ContainSubstring("bind.binding-already-exists"))
 					Expect(lastLogLine().Data["error"]).To(ContainSubstring("binding already exists"))
@@ -521,13 +549,13 @@ var _ = Describe("Service Broker API", func() {
 				})
 
 				It("returns a generic 500 error response", func() {
-					response := makeBindingRequest(uniqueInstanceID(), uniqueBindingID())
+					response := makeBindingRequest(uniqueInstanceID(), uniqueBindingID(), details)
 					Expect(response.StatusCode).To(Equal(500))
 					Expect(response.Body).To(MatchJSON(`{"description":"random error"}`))
 				})
 
 				It("logs a detailed error message", func() {
-					makeBindingRequest(uniqueInstanceID(), uniqueBindingID())
+					makeBindingRequest(uniqueInstanceID(), uniqueBindingID(), details)
 
 					Expect(lastLogLine().Message).To(ContainSubstring("bind.unknown-error"))
 					Expect(lastLogLine().Data["error"]).To(ContainSubstring("random error"))
@@ -569,7 +597,7 @@ var _ = Describe("Service Broker API", func() {
 
 					BeforeEach(func() {
 						bindingID = uniqueBindingID()
-						makeBindingRequest(instanceID, bindingID)
+						makeBindingRequest(instanceID, bindingID, &brokerapi.BindDetails{})
 					})
 
 					It("returns a 200", func() {

fakes/fake_service_broker.go

@@ -8,8 +8,9 @@ type FakeServiceBroker struct {
 	ProvisionedInstanceIDs   []string
 	DeprovisionedInstanceIDs []string
 
-	BoundInstanceIDs []string
-	BoundBindingIDs  []string
+	BoundInstanceIDs    []string
+	BoundBindingIDs     []string
+	BoundBindingDetails brokerapi.BindDetails
 
 	InstanceLimit int
 
@@ -96,13 +97,15 @@ func (fakeBroker *FakeServiceBroker) Deprovision(instanceID string) error {
 	return brokerapi.ErrInstanceDoesNotExist
 }
 
-func (fakeBroker *FakeServiceBroker) Bind(instanceID, bindingID string) (interface{}, error) {
+func (fakeBroker *FakeServiceBroker) Bind(instanceID, bindingID string, details brokerapi.BindDetails) (interface{}, error) {
 	fakeBroker.BrokerCalled = true
 
 	if fakeBroker.BindError != nil {
 		return nil, fakeBroker.BindError
 	}
 
+	fakeBroker.BoundBindingDetails = details
+
 	fakeBroker.BoundInstanceIDs = append(fakeBroker.BoundInstanceIDs, instanceID)
 	fakeBroker.BoundBindingIDs = append(fakeBroker.BoundBindingIDs, bindingID)
 

service_broker.go

@@ -8,7 +8,7 @@ type ServiceBroker interface {
 	Provision(instanceID string, serviceDetails ServiceDetails) error
 	Deprovision(instanceID string) error
 
-	Bind(instanceID, bindingID string) (interface{}, error)
+	Bind(instanceID, bindingID string, details BindDetails) (interface{}, error)
 	Unbind(instanceID, bindingID string) error
 }
 
@@ -20,6 +20,12 @@ type ServiceDetails struct {
 	Parameters       map[string]interface{} `json:"parameters"`
 }
 
+type BindDetails struct {
+	AppGUID   string `json:"app_guid"`
+	PlanID    string `json:"plan_id"`
+	ServiceID string `json:"service_id"`
+}
+
 var (
 	ErrInstanceAlreadyExists = errors.New("instance already exists")
 	ErrInstanceDoesNotExist  = errors.New("instance does not exist")