forked from pivotal-cf/brokerapi
-
Notifications
You must be signed in to change notification settings - Fork 0
/
api_test.go
2259 lines (1889 loc) · 85.3 KB
/
api_test.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright (C) 2015-Present Pivotal Software, Inc. All rights reserved.
// This program and the accompanying materials are made available under
// the terms of the under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
// http://www.apache.org/licenses/LICENSE-2.0
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package brokerapi_test
import (
"bytes"
"context"
"encoding/json"
"errors"
"fmt"
"net/http"
"net/http/httptest"
"net/url"
"strings"
"code.cloudfoundry.org/lager"
"code.cloudfoundry.org/lager/lagertest"
"github.com/drewolson/testflight"
. "github.com/onsi/ginkgo"
. "github.com/onsi/gomega"
"github.com/pivotal-cf/brokerapi"
"github.com/pivotal-cf/brokerapi/fakes"
)
var _ = Describe("Service Broker API", func() {
var fakeServiceBroker *fakes.FakeServiceBroker
var brokerAPI http.Handler
var brokerLogger *lagertest.TestLogger
var apiVersion string
var credentials = brokerapi.BrokerCredentials{
Username: "username",
Password: "password",
}
makeInstanceProvisioningRequest := func(instanceID string, details map[string]interface{}, queryString string) *testflight.Response {
response := &testflight.Response{}
testflight.WithServer(brokerAPI, func(r *testflight.Requester) {
path := "/v2/service_instances/" + instanceID + queryString
buffer := &bytes.Buffer{}
json.NewEncoder(buffer).Encode(details)
request, err := http.NewRequest("PUT", path, buffer)
Expect(err).NotTo(HaveOccurred())
request.Header.Add("Content-Type", "application/json")
if apiVersion != "" {
request.Header.Add("X-Broker-API-Version", apiVersion)
}
request.SetBasicAuth(credentials.Username, credentials.Password)
response = r.Do(request)
})
return response
}
makeInstanceProvisioningRequestWithAcceptsIncomplete := func(instanceID string, details map[string]interface{}, acceptsIncomplete bool) *testflight.Response {
var acceptsIncompleteFlag string
if acceptsIncomplete {
acceptsIncompleteFlag = "?accepts_incomplete=true"
} else {
acceptsIncompleteFlag = "?accepts_incomplete=false"
}
return makeInstanceProvisioningRequest(instanceID, details, acceptsIncompleteFlag)
}
lastLogLine := func() lager.LogFormat {
noOfLogLines := len(brokerLogger.Logs())
if noOfLogLines == 0 {
// better way to raise error?
err := errors.New("expected some log lines but there were none")
Expect(err).NotTo(HaveOccurred())
}
return brokerLogger.Logs()[noOfLogLines-1]
}
BeforeEach(func() {
apiVersion = "2.14"
fakeServiceBroker = &fakes.FakeServiceBroker{
InstanceLimit: 3,
ServiceID: "0A789746-596F-4CEA-BFAC-A0795DA056E3",
PlanID: "plan-id",
}
brokerLogger = lagertest.NewTestLogger("broker-api")
brokerAPI = brokerapi.New(fakeServiceBroker, brokerLogger, credentials)
})
Describe("response headers", func() {
makeRequest := func() *httptest.ResponseRecorder {
recorder := httptest.NewRecorder()
request, _ := http.NewRequest("GET", "/v2/catalog", nil)
request.SetBasicAuth(credentials.Username, credentials.Password)
brokerAPI.ServeHTTP(recorder, request)
return recorder
}
It("has a Content-Type header", func() {
response := makeRequest()
header := response.Header().Get("Content-Type")
Expect(header).Should(Equal("application/json"))
})
})
Describe("request context", func() {
var (
ctx context.Context
reqBody string
)
makeRequest := func(method, path, body string) *httptest.ResponseRecorder {
recorder := httptest.NewRecorder()
request, _ := http.NewRequest(method, path, strings.NewReader(body))
request.Header.Add("X-Broker-API-Version", "2.14")
request.SetBasicAuth(credentials.Username, credentials.Password)
request = request.WithContext(ctx)
brokerAPI.ServeHTTP(recorder, request)
return recorder
}
BeforeEach(func() {
ctx = context.WithValue(context.Background(), "test_context", true)
reqBody = fmt.Sprintf(`{"service_id":"%s","plan_id":"456"}`, fakeServiceBroker.ServiceID)
})
Specify("a catalog endpoint which passes the request context to the broker", func() {
makeRequest("GET", "/v2/catalog", "")
Expect(fakeServiceBroker.ReceivedContext).To(BeTrue())
})
Specify("a provision endpoint which passes the request context to the broker", func() {
makeRequest("PUT", "/v2/service_instances/instance-id", reqBody)
Expect(fakeServiceBroker.ReceivedContext).To(BeTrue())
})
Specify("a deprovision endpoint which passes the request context to the broker", func() {
makeRequest("DELETE", "/v2/service_instances/instance-id?service_id=asdf&plan_id=fdsa", "")
Expect(fakeServiceBroker.ReceivedContext).To(BeTrue())
})
Specify("a bind endpoint which passes the request context to the broker", func() {
makeRequest("PUT", "/v2/service_instances/instance-id/service_bindings/binding-id", reqBody)
Expect(fakeServiceBroker.ReceivedContext).To(BeTrue())
})
Specify("an unbind endpoint which passes the request context to the broker", func() {
makeRequest("DELETE", "/v2/service_instances/instance-id/service_bindings/binding-id?plan_id=plan-id&service_id=service-id", "")
Expect(fakeServiceBroker.ReceivedContext).To(BeTrue())
})
Specify("an update endpoint which passes the request context to the broker", func() {
makeRequest("PATCH", "/v2/service_instances/instance-id", `{"service_id":"123"}`)
Expect(fakeServiceBroker.ReceivedContext).To(BeTrue())
})
Specify("a get binding operation endpoint which passes the request context to the broker", func() {
makeRequest("GET", "/v2/service_instances/instance-id/service_bindings/binding-id", "{}")
Expect(fakeServiceBroker.ReceivedContext).To(BeTrue())
})
Specify("a last binding operation endpoint which passes the request context to the broker", func() {
makeRequest("GET", "/v2/service_instances/instance-id/service_bindings/binding-id/last_operation", "{}")
Expect(fakeServiceBroker.ReceivedContext).To(BeTrue())
})
Specify("a last operation endpoint which passes the request context to the broker", func() {
makeRequest("GET", "/v2/service_instances/instance-id/last_operation", "{}")
Expect(fakeServiceBroker.ReceivedContext).To(BeTrue())
})
Specify("a get instance operation endpoint which passes the request context to the broker", func() {
makeRequest("GET", "/v2/service_instances/instance-id", "{}")
Expect(fakeServiceBroker.ReceivedContext).To(BeTrue())
})
})
Describe("authentication", func() {
makeRequestWithoutAuth := func() *testflight.Response {
response := &testflight.Response{}
testflight.WithServer(brokerAPI, func(r *testflight.Requester) {
request, _ := http.NewRequest("GET", "/v2/catalog", nil)
response = r.Do(request)
})
return response
}
makeRequestWithAuth := func(username string, password string) *testflight.Response {
response := &testflight.Response{}
testflight.WithServer(brokerAPI, func(r *testflight.Requester) {
request, _ := http.NewRequest("GET", "/v2/catalog", nil)
request.SetBasicAuth(username, password)
response = r.Do(request)
})
return response
}
makeRequestWithUnrecognizedAuth := func() *testflight.Response {
response := &testflight.Response{}
testflight.WithServer(brokerAPI, func(r *testflight.Requester) {
request, _ := http.NewRequest("GET", "/v2/catalog", nil)
// dXNlcm5hbWU6cGFzc3dvcmQ= is base64 encoding of 'username:password',
// ie, a correctly encoded basic authorization header
request.Header["Authorization"] = []string{"NOTBASIC dXNlcm5hbWU6cGFzc3dvcmQ="}
response = r.Do(request)
})
return response
}
It("returns 401 when the authorization header has an incorrect password", func() {
response := makeRequestWithAuth("username", "fake_password")
Expect(response.StatusCode).To(Equal(401))
})
It("returns 401 when the authorization header has an incorrect username", func() {
response := makeRequestWithAuth("fake_username", "password")
Expect(response.StatusCode).To(Equal(401))
})
It("returns 401 when there is no authorization header", func() {
response := makeRequestWithoutAuth()
Expect(response.StatusCode).To(Equal(401))
})
It("returns 401 when there is a unrecognized authorization header", func() {
response := makeRequestWithUnrecognizedAuth()
Expect(response.StatusCode).To(Equal(401))
})
It("does not call through to the service broker when not authenticated", func() {
makeRequestWithAuth("username", "fake_password")
Ω(fakeServiceBroker.BrokerCalled).ShouldNot(BeTrue(),
"broker should not have been hit when authentication failed",
)
})
})
Describe("OriginatingIdentityHeader", func() {
var (
fakeServiceBroker *fakes.AutoFakeServiceBroker
req *http.Request
testServer *httptest.Server
)
BeforeEach(func() {
fakeServiceBroker = new(fakes.AutoFakeServiceBroker)
brokerAPI = brokerapi.New(fakeServiceBroker, brokerLogger, credentials)
testServer = httptest.NewServer(brokerAPI)
var err error
req, err = http.NewRequest("GET", testServer.URL+"/v2/catalog", nil)
Expect(err).NotTo(HaveOccurred())
req.Header.Add("X-Broker-API-Version", "2.14")
req.SetBasicAuth(credentials.Username, credentials.Password)
})
AfterEach(func() {
testServer.Close()
})
When("X-Broker-API-Originating-Identity is passed", func() {
It("Adds it to the context", func() {
originatingIdentity := "Originating Identity Name"
req.Header.Add("X-Broker-API-Originating-Identity", originatingIdentity)
_, err := http.DefaultClient.Do(req)
Expect(err).NotTo(HaveOccurred())
Expect(fakeServiceBroker.ServicesCallCount()).To(Equal(1), "Services was not called")
ctx := fakeServiceBroker.ServicesArgsForCall(0)
Expect(ctx.Value("originatingIdentity")).To(Equal(originatingIdentity))
})
})
When("X-Broker-API-Originating-Identity is not passed", func() {
It("Adds empty originatingIdentity to the context", func() {
_, err := http.DefaultClient.Do(req)
Expect(err).NotTo(HaveOccurred())
Expect(fakeServiceBroker.ServicesCallCount()).To(Equal(1), "Services was not called")
ctx := fakeServiceBroker.ServicesArgsForCall(0)
Expect(ctx.Value("originatingIdentity")).To(Equal(""))
})
})
})
Describe("catalog endpoint", func() {
makeCatalogRequest := func(apiVersion string, fail bool) *httptest.ResponseRecorder {
recorder := httptest.NewRecorder()
request, _ := http.NewRequest(http.MethodGet, "/v2/catalog", nil)
if apiVersion != "" {
request.Header.Add("X-Broker-API-Version", apiVersion)
}
request.SetBasicAuth(credentials.Username, credentials.Password)
ctx := context.Background()
if fail {
ctx = context.WithValue(ctx, "fails", true)
}
request = request.WithContext(ctx)
brokerAPI.ServeHTTP(recorder, request)
return recorder
}
It("returns a 200", func() {
response := makeCatalogRequest("2.14", false)
Expect(response.Code).To(Equal(200))
})
It("returns valid catalog json", func() {
response := makeCatalogRequest("2.14", false)
Expect(response.Body).To(MatchJSON(fixture("catalog.json")))
})
It("returns a 500", func() {
response := makeCatalogRequest("2.14", true)
Expect(response.Code).To(Equal(500))
Expect(response.Body.String()).To(MatchJSON(`{ "description": "something went wrong!" }`))
})
Context("the request is malformed", func() {
It("missing header X-Broker-API-Version", func() {
response := makeCatalogRequest("", false)
Expect(response.Code).To(Equal(412))
Expect(lastLogLine().Message).To(ContainSubstring("version-header-check.broker-api-version-invalid"))
Expect(lastLogLine().Data["error"]).To(ContainSubstring("X-Broker-API-Version Header not set"))
})
It("has wrong version of API", func() {
response := makeCatalogRequest("1.14", false)
Expect(response.Code).To(Equal(412))
Expect(lastLogLine().Message).To(ContainSubstring("version-header-check.broker-api-version-invalid"))
Expect(lastLogLine().Data["error"]).To(ContainSubstring("X-Broker-API-Version Header must be 2.x"))
})
})
})
Describe("instance lifecycle endpoint", func() {
makeGetInstanceRequest := func(instanceID string) *testflight.Response {
response := &testflight.Response{}
testflight.WithServer(brokerAPI, func(r *testflight.Requester) {
path := fmt.Sprintf("/v2/service_instances/%s", instanceID)
request, err := http.NewRequest("GET", path, strings.NewReader(""))
Expect(err).NotTo(HaveOccurred())
request.Header.Add("X-Broker-API-Version", apiVersion)
request.SetBasicAuth("username", "password")
response = r.Do(request)
})
return response
}
makeInstanceDeprovisioningRequestFull := func(instanceID, serviceID, planID, queryString string) *testflight.Response {
response := &testflight.Response{}
testflight.WithServer(brokerAPI, func(r *testflight.Requester) {
path := fmt.Sprintf("/v2/service_instances/%s?plan_id=%s&service_id=%s", instanceID, planID, serviceID)
if queryString != "" {
path = fmt.Sprintf("%s&%s", path, queryString)
}
request, err := http.NewRequest("DELETE", path, strings.NewReader(""))
Expect(err).NotTo(HaveOccurred())
request.Header.Add("Content-Type", "application/json")
request.SetBasicAuth("username", "password")
request.Header.Add("X-Broker-API-Version", apiVersion)
response = r.Do(request)
})
return response
}
makeInstanceDeprovisioningRequest := func(instanceID, queryString string) *testflight.Response {
return makeInstanceDeprovisioningRequestFull(instanceID, "service-id", "plan-id", queryString)
}
Describe("provisioning", func() {
var instanceID string
var provisionDetails map[string]interface{}
BeforeEach(func() {
instanceID = uniqueInstanceID()
provisionDetails = map[string]interface{}{
"service_id": fakeServiceBroker.ServiceID,
"plan_id": "plan-id",
"organization_guid": "organization-guid",
"space_guid": "space-guid",
"maintenance_info": map[string]interface{}{
"public": map[string]string{
"k8s-version": "0.0.1-alpha2",
},
"private": "just a sha thing",
},
}
})
It("calls Provision on the service broker with all params", func() {
makeInstanceProvisioningRequest(instanceID, provisionDetails, "")
Expect(fakeServiceBroker.ProvisionDetails).To(Equal(brokerapi.ProvisionDetails{
ServiceID: fakeServiceBroker.ServiceID,
PlanID: "plan-id",
OrganizationGUID: "organization-guid",
SpaceGUID: "space-guid",
MaintenanceInfo: brokerapi.MaintenanceInfo{
Public: map[string]string{
"k8s-version": "0.0.1-alpha2",
},
Private: "just a sha thing",
},
}))
})
It("calls Provision on the service broker with the instance id", func() {
makeInstanceProvisioningRequest(instanceID, provisionDetails, "")
Expect(fakeServiceBroker.ProvisionedInstanceIDs).To(ContainElement(instanceID))
})
It("calls GetInstance on the service broker with the instance id", func() {
makeInstanceProvisioningRequest(instanceID, provisionDetails, "")
Expect(fakeServiceBroker.ProvisionedInstanceIDs).To(ContainElement(instanceID))
fakeServiceBroker.DashboardURL = "https://example.com/dashboard/some-instance"
resp := makeGetInstanceRequest(instanceID)
Expect(fakeServiceBroker.GetInstanceIDs).To(ContainElement(instanceID))
Expect(resp.Body).To(MatchJSON(fixture("get_instance.json")))
})
Context("when the broker returns some operation data", func() {
BeforeEach(func() {
fakeServiceBroker = &fakes.FakeServiceBroker{
InstanceLimit: 3,
OperationDataToReturn: "some-operation-data",
ServiceID: fakeServiceBroker.ServiceID,
PlanID: fakeServiceBroker.PlanID,
}
fakeAsyncServiceBroker := &fakes.FakeAsyncServiceBroker{
FakeServiceBroker: *fakeServiceBroker,
ShouldProvisionAsync: true,
}
brokerAPI = brokerapi.New(fakeAsyncServiceBroker, brokerLogger, credentials)
})
It("returns the operation data to the cloud controller", func() {
resp := makeInstanceProvisioningRequest(instanceID, provisionDetails, "")
Expect(resp.Body).To(MatchJSON(fixture("operation_data_response.json")))
})
})
Context("when there are arbitrary params", func() {
var rawParams string
var rawCtx string
BeforeEach(func() {
provisionDetails["parameters"] = map[string]interface{}{
"string": "some-string",
"number": 1,
"object": struct{ Name string }{"some-name"},
"array": []interface{}{"a", "b", "c"},
}
rawParams = `{
"string":"some-string",
"number":1,
"object": { "Name": "some-name" },
"array": [ "a", "b", "c" ]
}`
provisionDetails["context"] = map[string]interface{}{
"platform": "fake-platform",
"serial-number": 12648430,
"object": struct{ Name string }{"parameter"},
"array": []interface{}{"1", "2", "3"},
}
rawCtx = `{
"platform":"fake-platform",
"serial-number":12648430,
"object": {"Name":"parameter"},
"array":[ "1", "2", "3" ]
}`
})
It("calls Provision on the service broker with all params", func() {
makeInstanceProvisioningRequest(instanceID, provisionDetails, "")
Expect(string(fakeServiceBroker.ProvisionDetails.RawParameters)).To(MatchJSON(rawParams))
})
It("calls Provision with details with raw parameters", func() {
makeInstanceProvisioningRequest(instanceID, provisionDetails, "")
detailsWithRawParameters := brokerapi.DetailsWithRawParameters(fakeServiceBroker.ProvisionDetails)
rawParameters := detailsWithRawParameters.GetRawParameters()
Expect(string(rawParameters)).To(MatchJSON(rawParams))
})
It("calls Provision with details with raw context", func() {
makeInstanceProvisioningRequest(instanceID, provisionDetails, "")
detailsWithRawContext := brokerapi.DetailsWithRawContext(fakeServiceBroker.ProvisionDetails)
rawContext := detailsWithRawContext.GetRawContext()
Expect(string(rawContext)).To(MatchJSON(rawCtx))
})
})
Context("when the instance does not exist", func() {
It("returns a 201", func() {
response := makeInstanceProvisioningRequest(instanceID, provisionDetails, "")
Expect(response.StatusCode).To(Equal(201))
})
It("returns empty json", func() {
response := makeInstanceProvisioningRequest(instanceID, provisionDetails, "")
Expect(response.Body).To(MatchJSON(fixture("provisioning.json")))
})
Context("when the broker returns a dashboard URL", func() {
BeforeEach(func() {
fakeServiceBroker.DashboardURL = "some-dashboard-url"
})
It("returns json with dashboard URL", func() {
response := makeInstanceProvisioningRequest(instanceID, provisionDetails, "")
Expect(response.Body).To(MatchJSON(fixture("provisioning_with_dashboard.json")))
})
})
Context("when the instance limit has been reached", func() {
BeforeEach(func() {
for i := 0; i < fakeServiceBroker.InstanceLimit; i++ {
makeInstanceProvisioningRequest(uniqueInstanceID(), provisionDetails, "")
}
})
It("returns a 500", func() {
response := makeInstanceProvisioningRequest(instanceID, provisionDetails, "")
Expect(response.StatusCode).To(Equal(500))
})
It("returns json with a description field and a useful error message", func() {
response := makeInstanceProvisioningRequest(instanceID, provisionDetails, "")
Expect(response.Body).To(MatchJSON(fixture("instance_limit_error.json")))
})
It("logs an appropriate error", func() {
makeInstanceProvisioningRequest(instanceID, provisionDetails, "")
Expect(lastLogLine().Message).To(ContainSubstring(".provision.instance-limit-reached"))
Expect(lastLogLine().Data["error"]).To(ContainSubstring("instance limit for this service has been reached"))
})
})
Context("when an unexpected error occurs", func() {
BeforeEach(func() {
fakeServiceBroker.ProvisionError = errors.New("broker failed")
})
It("returns a 500", func() {
response := makeInstanceProvisioningRequest(instanceID, provisionDetails, "")
Expect(response.StatusCode).To(Equal(500))
})
It("returns json with a description field and a useful error message", func() {
response := makeInstanceProvisioningRequest(instanceID, provisionDetails, "")
Expect(response.Body).To(MatchJSON(`{"description":"broker failed"}`))
})
It("logs an appropriate error", func() {
makeInstanceProvisioningRequest(instanceID, provisionDetails, "")
Expect(lastLogLine().Message).To(ContainSubstring(".provision.unknown-error"))
Expect(lastLogLine().Data["error"]).To(ContainSubstring("broker failed"))
})
})
Context("when a custom error occurs", func() {
BeforeEach(func() {
fakeServiceBroker.ProvisionError = brokerapi.NewFailureResponse(
errors.New("I failed in unique and interesting ways"),
http.StatusTeapot,
"interesting-failure",
)
})
It("returns status teapot", func() {
response := makeInstanceProvisioningRequest(instanceID, provisionDetails, "")
Expect(response.StatusCode).To(Equal(http.StatusTeapot))
})
It("returns json with a description field and a useful error message", func() {
response := makeInstanceProvisioningRequest(instanceID, provisionDetails, "")
Expect(response.Body).To(MatchJSON(`{"description":"I failed in unique and interesting ways"}`))
})
It("logs an appropriate error", func() {
makeInstanceProvisioningRequest(instanceID, provisionDetails, "")
Expect(lastLogLine().Message).To(ContainSubstring(".provision.interesting-failure"))
Expect(lastLogLine().Data["error"]).To(ContainSubstring("I failed in unique and interesting ways"))
})
})
Context("RawParameters are not valid JSON", func() {
BeforeEach(func() {
fakeServiceBroker.ProvisionError = brokerapi.ErrRawParamsInvalid
})
It("returns a 422", func() {
response := makeInstanceProvisioningRequest(instanceID, provisionDetails, "")
Expect(response.StatusCode).To(Equal(http.StatusUnprocessableEntity))
})
It("returns json with a description field and a useful error message", func() {
response := makeInstanceProvisioningRequest(instanceID, provisionDetails, "")
Expect(response.Body).To(MatchJSON(`{"description":"The format of the parameters is not valid JSON"}`))
})
It("logs an appropriate error", func() {
makeInstanceProvisioningRequest(instanceID, provisionDetails, "")
Expect(lastLogLine().Message).To(ContainSubstring(".provision.invalid-raw-params"))
Expect(lastLogLine().Data["error"]).To(ContainSubstring("The format of the parameters is not valid JSON"))
})
})
Context("when we send invalid json", func() {
makeBadInstanceProvisioningRequest := func(instanceID string) *testflight.Response {
response := &testflight.Response{}
testflight.WithServer(brokerAPI, func(r *testflight.Requester) {
path := "/v2/service_instances/" + instanceID
body := strings.NewReader("{{{{{")
request, err := http.NewRequest("PUT", path, body)
Expect(err).NotTo(HaveOccurred())
request.Header.Add("Content-Type", "application/json")
if apiVersion != "" {
request.Header.Add("X-Broker-Api-Version", apiVersion)
}
request.SetBasicAuth(credentials.Username, credentials.Password)
response = r.Do(request)
})
return response
}
It("returns a 422 bad request", func() {
response := makeBadInstanceProvisioningRequest(instanceID)
Expect(response.StatusCode).Should(Equal(http.StatusUnprocessableEntity))
})
It("logs a message", func() {
makeBadInstanceProvisioningRequest(instanceID)
Expect(lastLogLine().Message).To(ContainSubstring(".provision.invalid-service-details"))
})
})
})
Context("when the instance already exists", func() {
BeforeEach(func() {
makeInstanceProvisioningRequest(instanceID, provisionDetails, "")
})
It("returns a 409", func() {
response := makeInstanceProvisioningRequest(instanceID, provisionDetails, "")
Expect(response.StatusCode).To(Equal(409))
})
It("returns an empty JSON object", func() {
response := makeInstanceProvisioningRequest(instanceID, provisionDetails, "")
Expect(response.Body).To(MatchJSON(`{}`))
})
It("logs an appropriate error", func() {
makeInstanceProvisioningRequest(instanceID, provisionDetails, "")
Expect(lastLogLine().Message).To(ContainSubstring(".provision.instance-already-exists"))
Expect(lastLogLine().Data["error"]).To(ContainSubstring("instance already exists"))
})
})
Describe("accepts_incomplete", func() {
Context("when the accepts_incomplete flag is true", func() {
It("calls ProvisionAsync on the service broker", func() {
acceptsIncomplete := true
makeInstanceProvisioningRequestWithAcceptsIncomplete(instanceID, provisionDetails, acceptsIncomplete)
Expect(fakeServiceBroker.ProvisionDetails).To(Equal(brokerapi.ProvisionDetails{
ServiceID: fakeServiceBroker.ServiceID,
PlanID: "plan-id",
OrganizationGUID: "organization-guid",
SpaceGUID: "space-guid",
MaintenanceInfo: brokerapi.MaintenanceInfo{
Public: map[string]string{
"k8s-version": "0.0.1-alpha2",
},
Private: "just a sha thing",
},
}))
Expect(fakeServiceBroker.ProvisionedInstanceIDs).To(ContainElement(instanceID))
})
Context("when the broker chooses to provision asynchronously", func() {
BeforeEach(func() {
fakeServiceBroker = &fakes.FakeServiceBroker{
InstanceLimit: 3,
ServiceID: fakeServiceBroker.ServiceID,
PlanID: fakeServiceBroker.PlanID,
}
fakeAsyncServiceBroker := &fakes.FakeAsyncServiceBroker{
FakeServiceBroker: *fakeServiceBroker,
ShouldProvisionAsync: true,
}
brokerAPI = brokerapi.New(fakeAsyncServiceBroker, brokerLogger, credentials)
})
It("returns a 202", func() {
response := makeInstanceProvisioningRequestWithAcceptsIncomplete(instanceID, provisionDetails, true)
Expect(response.StatusCode).To(Equal(http.StatusAccepted))
})
})
Context("when the broker chooses to provision synchronously", func() {
BeforeEach(func() {
fakeServiceBroker = &fakes.FakeServiceBroker{
InstanceLimit: 3,
ServiceID: fakeServiceBroker.ServiceID,
PlanID: fakeServiceBroker.PlanID,
}
fakeAsyncServiceBroker := &fakes.FakeAsyncServiceBroker{
FakeServiceBroker: *fakeServiceBroker,
ShouldProvisionAsync: false,
}
brokerAPI = brokerapi.New(fakeAsyncServiceBroker, brokerLogger, credentials)
})
It("returns a 201", func() {
response := makeInstanceProvisioningRequestWithAcceptsIncomplete(instanceID, provisionDetails, true)
Expect(response.StatusCode).To(Equal(http.StatusCreated))
})
})
})
Context("when the accepts_incomplete flag is false", func() {
It("returns a 201", func() {
response := makeInstanceProvisioningRequestWithAcceptsIncomplete(instanceID, provisionDetails, false)
Expect(response.StatusCode).To(Equal(http.StatusCreated))
})
Context("when broker can only respond asynchronously", func() {
BeforeEach(func() {
fakeServiceBroker = &fakes.FakeServiceBroker{
InstanceLimit: 3,
ServiceID: fakeServiceBroker.ServiceID,
PlanID: fakeServiceBroker.PlanID,
}
fakeAsyncServiceBroker := &fakes.FakeAsyncOnlyServiceBroker{
FakeServiceBroker: *fakeServiceBroker,
}
brokerAPI = brokerapi.New(fakeAsyncServiceBroker, brokerLogger, credentials)
})
It("returns a 422", func() {
acceptsIncomplete := false
response := makeInstanceProvisioningRequestWithAcceptsIncomplete(instanceID, provisionDetails, acceptsIncomplete)
Expect(response.StatusCode).To(Equal(http.StatusUnprocessableEntity))
Expect(response.Body).To(MatchJSON(fixture("async_required.json")))
})
})
})
Context("when the accepts_incomplete flag is missing", func() {
It("returns a 201", func() {
response := makeInstanceProvisioningRequest(instanceID, provisionDetails, "")
Expect(response.StatusCode).To(Equal(http.StatusCreated))
})
Context("when broker can only respond asynchronously", func() {
BeforeEach(func() {
fakeServiceBroker = &fakes.FakeServiceBroker{
InstanceLimit: 3,
ServiceID: fakeServiceBroker.ServiceID,
PlanID: fakeServiceBroker.PlanID,
}
fakeAsyncServiceBroker := &fakes.FakeAsyncOnlyServiceBroker{
FakeServiceBroker: *fakeServiceBroker,
}
brokerAPI = brokerapi.New(fakeAsyncServiceBroker, brokerLogger, credentials)
})
It("returns a 422", func() {
acceptsIncomplete := false
response := makeInstanceProvisioningRequestWithAcceptsIncomplete(instanceID, provisionDetails, acceptsIncomplete)
Expect(response.StatusCode).To(Equal(http.StatusUnprocessableEntity))
Expect(response.Body).To(MatchJSON(fixture("async_required.json")))
})
})
})
})
Context("the request is malformed", func() {
It("missing header X-Broker-API-Version", func() {
apiVersion = ""
response := makeInstanceProvisioningRequest(instanceID, provisionDetails, "")
Expect(response.StatusCode).To(Equal(412))
Expect(lastLogLine().Message).To(ContainSubstring("version-header-check.broker-api-version-invalid"))
Expect(lastLogLine().Data["error"]).To(ContainSubstring("X-Broker-API-Version Header not set"))
})
It("has wrong version of API", func() {
apiVersion = "1.14"
response := makeInstanceProvisioningRequest(instanceID, provisionDetails, "")
Expect(response.StatusCode).To(Equal(412))
Expect(lastLogLine().Message).To(ContainSubstring("version-header-check.broker-api-version-invalid"))
Expect(lastLogLine().Data["error"]).To(ContainSubstring("X-Broker-API-Version Header must be 2.x"))
})
It("missing service_id", func() {
delete(provisionDetails, "service_id")
response := makeInstanceProvisioningRequest(instanceID, provisionDetails, "")
Expect(response.StatusCode).To(Equal(400))
Expect(lastLogLine().Message).To(ContainSubstring(".provision.service-id-missing"))
Expect(lastLogLine().Data["error"]).To(ContainSubstring("service_id missing"))
})
It("missing plan_id", func() {
delete(provisionDetails, "plan_id")
response := makeInstanceProvisioningRequest(instanceID, provisionDetails, "")
Expect(response.StatusCode).To(Equal(400))
Expect(lastLogLine().Message).To(ContainSubstring(".provision.plan-id-missing"))
Expect(lastLogLine().Data["error"]).To(ContainSubstring("plan_id missing"))
})
It("service_id not in the catalog", func() {
provisionDetails["service_id"] = "not-in-the-catalogue"
response := makeInstanceProvisioningRequest(instanceID, provisionDetails, "")
Expect(response.StatusCode).To(Equal(400))
Expect(lastLogLine().Message).To(ContainSubstring(".provision.invalid-service-id"))
Expect(lastLogLine().Data["error"]).To(ContainSubstring("service-id not in the catalog"))
})
It("plan_id not in the catalog", func() {
provisionDetails["plan_id"] = "not-in-the-catalogue"
response := makeInstanceProvisioningRequest(instanceID, provisionDetails, "")
Expect(response.StatusCode).To(Equal(400))
Expect(lastLogLine().Message).To(ContainSubstring(".provision.invalid-plan-id"))
Expect(lastLogLine().Data["error"]).To(ContainSubstring("plan-id not in the catalog"))
})
})
})
Describe("updating", func() {
var (
instanceID string
details map[string]interface{}
queryString string
response *testflight.Response
)
makeInstanceUpdateRequest := func(instanceID string, details map[string]interface{}, queryString string, apiVersion string) *testflight.Response {
response := &testflight.Response{}
testflight.WithServer(brokerAPI, func(r *testflight.Requester) {
path := "/v2/service_instances/" + instanceID + queryString
buffer := &bytes.Buffer{}
json.NewEncoder(buffer).Encode(details)
request, err := http.NewRequest("PATCH", path, buffer)
Expect(err).NotTo(HaveOccurred())
if apiVersion != "" {
request.Header.Add("X-Broker-Api-Version", apiVersion)
}
request.Header.Add("Content-Type", "application/json")
request.SetBasicAuth(credentials.Username, credentials.Password)
response = r.Do(request)
})
return response
}
BeforeEach(func() {
instanceID = uniqueInstanceID()
details = map[string]interface{}{
"service_id": "some-service-id",
"plan_id": "new-plan",
"parameters": map[string]interface{}{
"new-param": "new-param-value",
},
"previous_values": map[string]interface{}{
"service_id": "service-id",
"plan_id": "old-plan",
"organization_id": "org-id",
"space_id": "space-id",
},
"context": map[string]interface{}{
"new-context": "new-context-value",
},
"maintenance_info": map[string]interface{}{
"public": map[string]string{
"k8s-version": "0.0.1-alpha2",
},
"private": "just a sha thing",
},
}
queryString = "?accept_incomplete=true"
})
JustBeforeEach(func() {
response = makeInstanceUpdateRequest(instanceID, details, queryString, "2.14")
})
Context("the request is malformed", func() {
It("missing header X-Broker-API-Version", func() {
instanceID := "instance-id"
response := makeInstanceUpdateRequest(instanceID, details, queryString, "")
Expect(response.StatusCode).To(Equal(412))
Expect(lastLogLine().Message).To(ContainSubstring("version-header-check.broker-api-version-invalid"))
Expect(lastLogLine().Data["error"]).To(ContainSubstring("X-Broker-API-Version Header not set"))
})
It("has wrong version of API", func() {
instanceID := "instance-id"
response := makeInstanceUpdateRequest(instanceID, details, queryString, "1.14")
Expect(response.StatusCode).To(Equal(412))
Expect(lastLogLine().Message).To(ContainSubstring("version-header-check.broker-api-version-invalid"))
Expect(lastLogLine().Data["error"]).To(ContainSubstring("X-Broker-API-Version Header must be 2.x"))
})
It("missing service-id", func() {
delete(details, "service_id")
response := makeInstanceUpdateRequest("instance-id", details, queryString, "2.14")
Expect(response.StatusCode).To(Equal(400))
Expect(lastLogLine().Message).To(ContainSubstring(".update.service-id-missing"))
Expect(lastLogLine().Data["error"]).To(ContainSubstring("service_id missing"))
})
})
Context("when the broker returns no error", func() {
Context("when the broker responds synchronously", func() {
It("returns HTTP 200", func() {
Expect(response.StatusCode).To(Equal(http.StatusOK))
})
It("returns JSON content type", func() {
Expect(response.RawResponse.Header.Get("Content-Type")).To(Equal("application/json"))
})
It("returns empty JSON body", func() {
Expect(response.Body).To(Equal("{}\n"))
})
It("calls broker with instanceID and update details", func() {
Expect(fakeServiceBroker.UpdatedInstanceIDs).To(ConsistOf(instanceID))
Expect(fakeServiceBroker.UpdateDetails.ServiceID).To(Equal("some-service-id"))
Expect(fakeServiceBroker.UpdateDetails.PlanID).To(Equal("new-plan"))
Expect(fakeServiceBroker.UpdateDetails.PreviousValues).To(Equal(brokerapi.PreviousValues{
PlanID: "old-plan",
ServiceID: "service-id",
OrgID: "org-id",
SpaceID: "space-id",
},
))
Expect(fakeServiceBroker.UpdateDetails.RawParameters).To(Equal(json.RawMessage(`{"new-param":"new-param-value"}`)))
Expect(fakeServiceBroker.UpdateDetails.MaintenanceInfo).To(Equal(brokerapi.MaintenanceInfo{
Public: map[string]string{"k8s-version": "0.0.1-alpha2"},
Private: "just a sha thing"},
))
})
It("calls update with details with raw parameters", func() {
detailsWithRawParameters := brokerapi.DetailsWithRawParameters(fakeServiceBroker.UpdateDetails)
rawParameters := detailsWithRawParameters.GetRawParameters()
Expect(rawParameters).To(Equal(json.RawMessage(`{"new-param":"new-param-value"}`)))
})
It("calls update with details with raw context", func() {
Expect(fakeServiceBroker.UpdateDetails.RawContext).To(
Equal(json.RawMessage(`{"new-context":"new-context-value"}`)),
)
})
Context("when accepts_incomplete=true", func() {
BeforeEach(func() {
queryString = "?accepts_incomplete=true"
})
It("tells broker async is allowed", func() {
Expect(fakeServiceBroker.AsyncAllowed).To(BeTrue())
})
})
Context("when accepts_incomplete is not supplied", func() {
BeforeEach(func() {
queryString = ""
})
It("tells broker async not allowed", func() {