/
AirlinesAppTest.java
1075 lines (905 loc) · 55 KB
/
AirlinesAppTest.java
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) 2017-2019 Contributors to the Eclipse Foundation
* <p>
* Licensed 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
* <p>
* http://www.apache.org/licenses/LICENSE-2.0
* <p>
* 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 org.eclipse.microprofile.openapi.tck;
import static org.hamcrest.Matchers.both;
import static org.hamcrest.Matchers.contains;
import static org.hamcrest.Matchers.containsInAnyOrder;
import static org.hamcrest.Matchers.containsString;
import static org.hamcrest.Matchers.equalTo;
import static org.hamcrest.Matchers.greaterThan;
import static org.hamcrest.Matchers.hasEntry;
import static org.hamcrest.Matchers.hasItems;
import static org.hamcrest.Matchers.hasKey;
import static org.hamcrest.Matchers.hasSize;
import static org.hamcrest.Matchers.not;
import static org.hamcrest.Matchers.notNullValue;
import static org.hamcrest.Matchers.startsWith;
import static org.hamcrest.collection.IsEmptyCollection.empty;
import static org.hamcrest.collection.IsMapWithSize.aMapWithSize;
import static org.hamcrest.core.CombinableMatcher.either;
import java.util.ArrayList;
import java.util.List;
import org.hamcrest.collection.IsMapWithSize;
import org.jboss.arquillian.container.test.api.Deployment;
import org.jboss.arquillian.container.test.api.RunAsClient;
import org.jboss.shrinkwrap.api.ShrinkWrap;
import org.jboss.shrinkwrap.api.spec.WebArchive;
import org.testng.annotations.Test;
import io.restassured.response.ValidatableResponse;
public class AirlinesAppTest extends AppTestBase {
@Deployment(name = "airlines")
public static WebArchive createDeployment() {
return ShrinkWrap.create(WebArchive.class, "airlines.war")
.addPackages(true, "org.eclipse.microprofile.openapi.apps.airlines")
.addAsManifestResource("openapi.yaml", "openapi.yaml");
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testVersion(String type) {
ValidatableResponse vr = callEndpoint(type);
vr.body("openapi", startsWith("3.0."));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testInfo(String type) {
ValidatableResponse vr = callEndpoint(type);
vr.body("info.title", equalTo("AirlinesRatingApp API"));
vr.body("info.version", equalTo("1.0"));
vr.body("info.termsOfService", equalTo("http://airlinesratingapp.com/terms"));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testContact(String type) {
ValidatableResponse vr = callEndpoint(type);
vr.body("info.contact.name", equalTo("AirlinesRatingApp API Support"));
vr.body("info.contact.url", equalTo("http://exampleurl.com/contact"));
vr.body("info.contact.email", equalTo("techsupport@airlinesratingapp.com"));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testLicense(String type) {
ValidatableResponse vr = callEndpoint(type);
vr.body("info.license.name", equalTo("Apache 2.0"));
vr.body("info.license.url", equalTo("http://www.apache.org/licenses/LICENSE-2.0.html"));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testExternalDocumentation(String type) {
ValidatableResponse vr = callEndpoint(type);
vr.body("externalDocs.description", equalTo("instructions for how to deploy this app"));
vr.body("externalDocs.url", containsString("README.md"));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testServer(String type) {
ValidatableResponse vr = callEndpoint(type);
vr.body("servers", hasSize(2));
vr.body("servers.url", hasSize(2));
String url = "https://{username}.gigantic-server.com:{port}/{basePath}";
String serverPath = "servers.find { it.url == '" + url + "' }";
vr.body(serverPath + ".description", equalTo("The production API server"));
vr.body(serverPath + ".variables", aMapWithSize(4));
vr.body(serverPath + ".variables.username.description", equalTo("Reviews of the app by users"));
vr.body(serverPath + ".variables.username.default", equalTo("user1"));
vr.body(serverPath + ".variables.username.enum", containsInAnyOrder("user1", "user2"));
vr.body(serverPath + ".variables.port.description", equalTo("Booking data"));
vr.body(serverPath + ".variables.port.default", equalTo("8443"));
vr.body(serverPath + ".variables.user.description", equalTo("User data"));
vr.body(serverPath + ".variables.user.default", equalTo("user"));
vr.body(serverPath + ".variables.basePath.default", equalTo("v2"));
url = "https://test-server.com:80/basePath";
serverPath = "servers.find { it.url == '" + url + "' }";
vr.body(serverPath + ".description", equalTo("The test API server"));
// Testing @Servers and @Server defined on top of a class with @Server
// defined in an operation
// org.eclipse.microprofile.openapi.apps.airlines.resources.ReviewResource
vr.body("paths.'/reviews/{id}'.delete.servers", hasSize(3));
vr.body("paths.'/reviews/{id}'.delete.servers.url", hasSize(3));
url = "https://gigantic-server.com:443";
serverPath = "paths.'/reviews/{id}'.delete.servers.find { it.url == '" + url + "' }";
vr.body(serverPath + ".description", equalTo("Secure server"));
url = "http://gigantic-server.com:80";
serverPath = "paths.'/reviews/{id}'.delete.servers.find { it.url == '" + url + "' }";
vr.body(serverPath + ".description", equalTo("Unsecure server"));
vr.body(serverPath + ".variables", not(hasSize(greaterThan(0))));
url = "{protocol}://test-server.com";
serverPath = "paths.'/reviews/{id}'.delete.servers.find { it.url == '" + url + "' }";
vr.body(serverPath + ".description", equalTo("The production API server"));
vr.body(serverPath + ".variables", aMapWithSize(1));
vr.body(serverPath + ".variables.protocol.default", equalTo("https"));
vr.body(serverPath + ".variables.protocol.enum", containsInAnyOrder("http", "https"));
// Testing two @Server defined in an @operation annotation on a method
// org.eclipse.microprofile.openapi.apps.airlines.resources.ReviewResource.createReview(Review)
vr.body("paths.'/reviews'.post.servers", hasSize(2));
vr.body("paths.'/reviews'.post.servers.url", hasSize(2));
url = "localhost:9080/{proxyPath}/reviews/id";
serverPath = "paths.'/reviews'.post.servers.find { it.url == '" + url + "' }";
vr.body(serverPath + ".description", equalTo("view of all the reviews"));
vr.body(serverPath + ".variables", aMapWithSize(1));
vr.body(serverPath + ".variables.proxyPath.description", equalTo("Base path of the proxy"));
vr.body(serverPath + ".variables.proxyPath.default", equalTo("proxy"));
url = "http://random.url/reviews";
serverPath = "paths.'/reviews'.post.servers.find { it.url == '" + url + "' }";
vr.body(serverPath + ".description", equalTo("random text"));
// Testing two @Server defined on top of a class
// org.eclipse.microprofile.openapi.apps.airlines.resources.BookingResource
vr.body("paths.'/bookings'.get.servers", hasSize(2));
vr.body("paths.'/bookings'.get.servers.url", hasSize(2));
url = "http://gigantic-server.com:80";
serverPath = "paths.'/bookings'.get.servers.find { it.url == '" + url + "' }";
vr.body(serverPath + ".description", equalTo("Unsecure server"));
vr.body(serverPath + ".variables", not(hasSize(greaterThan(0))));
url = "https://gigantic-server.com:443";
serverPath = "paths.'/bookings'.get.servers.find { it.url == '" + url + "' }";
vr.body(serverPath + ".description", equalTo("Secure server"));
vr.body(serverPath + ".variables", not(hasSize(greaterThan(0))));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testOperationAirlinesResource(String type) {
ValidatableResponse vr = callEndpoint(type);
vr.body("paths.'/'.get.summary", equalTo("Retrieve all available airlines"));
vr.body("paths.'/'.get.operationId", equalTo("getAirlines"));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testOperationAvailabilityResource(String type) {
ValidatableResponse vr = callEndpoint(type);
vr.body("paths.'/availability'.get.summary", equalTo("Retrieve all available flights"));
vr.body("paths.'/availability'.get.operationId", equalTo("getFlights"));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testRestClientNotPickedUp(String type) {
ValidatableResponse vr = callEndpoint(type);
// We should not be picking up interfaces annotated with @RegisterRestClient
vr.body("paths.'/player/{playerId}'", equalTo(null));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testOperationBookingResource(String type) {
ValidatableResponse vr = callEndpoint(type);
vr.body("paths.'/bookings'.get.summary", equalTo("Retrieve all bookings for current user"));
vr.body("paths.'/bookings'.get.operationId", equalTo("getAllBookings"));
vr.body("paths.'/bookings'.post.summary", equalTo("Create a booking"));
vr.body("paths.'/bookings'.post.description",
equalTo("Create a new booking record with the booking information provided."));
vr.body("paths.'/bookings'.post.operationId", equalTo("createBooking"));
vr.body("paths.'/bookings/{id}'.get.summary", equalTo("Get a booking with ID"));
vr.body("paths.'/bookings/{id}'.get.operationId", equalTo("getBookingById"));
vr.body("paths.'/bookings/{id}'.put.summary", equalTo("Update a booking with ID"));
vr.body("paths.'/bookings/{id}'.put.operationId", equalTo("updateBookingId"));
vr.body("paths.'/bookings/{id}'.delete.summary", equalTo("Delete a booking with ID"));
vr.body("paths.'/bookings/{id}'.delete.operationId", equalTo("deleteBookingById"));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testOperationReviewResource(String type) {
ValidatableResponse vr = callEndpoint(type);
vr.body("paths.'/reviews'.get.summary", equalTo("get all the reviews"));
vr.body("paths.'/reviews'.get.operationId", equalTo("getAllReviews"));
vr.body("paths.'/reviews'.post.summary", equalTo("Create a Review"));
vr.body("paths.'/reviews'.post.operationId", equalTo("createReview"));
vr.body("paths.'/reviews/{id}'.get.summary", equalTo("Get a review with ID"));
vr.body("paths.'/reviews/{id}'.get.operationId", equalTo("getReviewById"));
vr.body("paths.'/reviews/{id}'.delete.summary", equalTo("Delete a Review with ID"));
vr.body("paths.'/reviews/{id}'.delete.operationId", equalTo("deleteReview"));
vr.body("paths.'/reviews/users/{user}'.get.summary", equalTo("Get all reviews by user"));
vr.body("paths.'/reviews/users/{user}'.get.operationId", equalTo("getReviewByUser"));
vr.body("paths.'/reviews/airlines/{airline}'.get.summary", equalTo("Get all reviews by airlines"));
vr.body("paths.'/reviews/airlines/{airline}'.get.operationId", equalTo("getReviewByAirline"));
vr.body("paths.'/reviews/{user}/{airlines}'.get.summary", equalTo("Get all reviews for an airline by User"));
vr.body("paths.'/reviews/{user}/{airlines}'.get.operationId", equalTo("getReviewByAirlineAndUser"));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testOperationUserResource(String type) {
ValidatableResponse vr = callEndpoint(type);
vr.body("paths.'/user'.post.summary", equalTo("Create user"));
vr.body("paths.'/user'.post.description", equalTo("This can only be done by the logged in user."));
vr.body("paths.'/user'.post.operationId", equalTo("createUser"));
vr.body("paths.'/user/createWithArray'.post.summary", equalTo("Creates list of users with given input array"));
vr.body("paths.'/user/createWithArray'.post.operationId", equalTo("createUsersFromArray"));
vr.body("paths.'/user/createWithList'.post.summary", equalTo("Creates list of users with given input list"));
vr.body("paths.'/user/createWithList'.post.operationId", equalTo("createUsersFromList"));
vr.body("paths.'/user/{username}'.put.summary", equalTo("Update user"));
vr.body("paths.'/user/{username}'.put.description", equalTo("This can only be done by the logged in user."));
vr.body("paths.'/user/{username}'.put.operationId", equalTo("updateUser"));
vr.body("paths.'/user/{username}'.delete.summary", equalTo("Delete user"));
vr.body("paths.'/user/{username}'.delete.description", equalTo("This can only be done by the logged in user."));
vr.body("paths.'/user/{username}'.delete.operationId", equalTo("deleteUser"));
vr.body("paths.'/user/{username}'.get.summary", equalTo("Get user by user name"));
vr.body("paths.'/user/{username}'.get.operationId", equalTo("getUserByName"));
vr.body("paths.'/user/{id}'.get.summary", equalTo("Get user by id"));
vr.body("paths.'/user/{id}'.get.operationId", equalTo("getUserById"));
vr.body("paths.'/user/login'.get.summary", equalTo("Logs user into the system"));
vr.body("paths.'/user/login'.get.operationId", equalTo("logInUser"));
vr.body("paths.'/user/logout'.get.summary", equalTo("Logs out current logged in user session"));
vr.body("paths.'/user/logout'.get.operationId", equalTo("logOutUser"));
vr.body("paths.'/user/{username}'.patch.summary", equalTo("Change user password"));
vr.body("paths.'/user/{username}'.patch.description",
equalTo("This changes the password for the logged in user."));
vr.body("paths.'/user/{username}'.patch.operationId", equalTo("changePassword"));
vr.body("paths.'/user/{username}'.patch.parameters", hasSize(3));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testAPIResponse(String type) {
ValidatableResponse vr = callEndpoint(type);
// @APIResponse at method level
vr.body("paths.'/availability'.get.responses", aMapWithSize(2));
vr.body("paths.'/availability'.get.responses.'200'.description", equalTo("successful operation"));
vr.body("paths.'/availability'.get.responses.'404'.description", equalTo("No available flights found"));
vr.body("paths.'/bookings'.post.responses", aMapWithSize(1));
vr.body("paths.'/bookings'.post.responses.'201'.description", equalTo("Booking created"));
vr.body("paths.'/user/{username}'.delete.responses", aMapWithSize(3));
vr.body("paths.'/user/{username}'.delete.responses.'200'.description", equalTo("User deleted successfully"));
vr.body("paths.'/user/{username}'.delete.responses.'400'.description", equalTo("Invalid username supplied"));
vr.body("paths.'/user/{username}'.delete.responses.'404'.description", equalTo("User not found"));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testAPIResponses(String type) {
ValidatableResponse vr = callEndpoint(type);
// @APIResponse annotations nested within @APIResponses
vr.body("paths.'/bookings/{id}'.get.responses", aMapWithSize(2));
vr.body("paths.'/bookings/{id}'.get.responses.'200'.description", equalTo("Booking retrieved"));
vr.body("paths.'/bookings/{id}'.get.responses.'404'.description", equalTo("Booking not found"));
vr.body("paths.'/reviews/users/{user}'.get.responses", aMapWithSize(2));
vr.body("paths.'/reviews/users/{user}'.get.responses.'200'.description", equalTo("Review(s) retrieved"));
vr.body("paths.'/reviews/users/{user}'.get.responses.'404'.description", equalTo("Review(s) not found"));
vr.body("paths.'/user/{username}'.put.responses", aMapWithSize(3));
vr.body("paths.'/user/{username}'.put.responses.'200'.description", equalTo("User updated successfully"));
vr.body("paths.'/user/{username}'.put.responses.'400'.description", equalTo("Invalid user supplied"));
vr.body("paths.'/user/{username}'.put.responses.'404'.description", equalTo("User not found"));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testParameter(String type) {
ValidatableResponse vr = callEndpoint(type);
testAvailabilityGetParamater(vr);
testBookingIdMethods(vr);
testReviewIdMethods(vr);
testUserLoginMethods(vr);
}
private void testUserLoginMethods(ValidatableResponse vr) {
String reviewParameters = "paths.'/user/login'.get.parameters";
vr.body(reviewParameters, hasSize(2));
vr.body(reviewParameters + ".findAll { it }.name", hasItems("username", "password"));
List<String[]> list = new ArrayList<String[]>();
list.add(new String[]{"username", "The user name for login"});
list.add(new String[]{"password", "The password for login in clear text"});
for (int i = 0; i < list.size(); i++) {
String currentParam = list.get(i)[0];
String query = reviewParameters + ".findAll { it.name == '" + currentParam + "' }";
vr.body(query + ".in", both(hasSize(1)).and(contains("query")));
vr.body(query + ".description", both(hasSize(1)).and(contains(list.get(i)[1])));
vr.body(query + ".required", both(hasSize(1)).and(contains(true)));
vr.body(query + ".schema.type", both(hasSize(1)).and(contains("string")));
}
}
private void testReviewIdMethods(ValidatableResponse vr) {
String reviewParameters = "paths.'/reviews/{id}'.get.parameters";
vr.body(reviewParameters, hasSize(1));
vr.body(reviewParameters + ".findAll { it }.name", contains("id"));
vr.body(reviewParameters + ".findAll { it.name == 'id' }.in", both(hasSize(1)).and(contains("path")));
vr.body(reviewParameters + ".findAll { it.name == 'id' }.description",
both(hasSize(1)).and(contains("ID of the booking")));
vr.body(reviewParameters + ".findAll { it.name == 'id' }.required", both(hasSize(1)).and(contains(true)));
vr.body(reviewParameters + ".findAll { it.name == 'id' }.content.'*/*'.schema.type",
both(hasSize(1)).and(contains("integer")));
}
private void testBookingIdMethods(ValidatableResponse vr) {
String bookingParameters = "paths.'/bookings/{id}'.%s.parameters";
for (String method : new String[]{"put", "delete", "get"}) {
bookingParameters = String.format(bookingParameters, method);
vr.body(bookingParameters, hasSize(1));
vr.body(bookingParameters + ".findAll { it }.name", contains("id"));
vr.body(bookingParameters + ".findAll { it.name == 'id' }.required", both(hasSize(1)).and(contains(true)));
vr.body(bookingParameters + ".findAll { it.name == 'id' }.schema.type",
both(hasSize(1)).and(contains("integer")));
}
bookingParameters = "paths.'/bookings/{id}'.get.parameters";
vr.body(bookingParameters + ".findAll { it.name == 'id' }.style", both(hasSize(1)).and(contains("simple")));
}
private void testAvailabilityGetParamater(ValidatableResponse vr) {
String availabilityParameters = "paths.'/availability'.get.parameters";
vr.body(availabilityParameters, hasSize(6));
vr.body(availabilityParameters + ".findAll { it }.name",
hasItems("airportFrom", "returningDate", "airportTo", "numberOfAdults", "numberOfChildren"));
List<String[]> list = new ArrayList<String[]>();
list.add(new String[]{"airportFrom", "Airport the customer departs from"});
list.add(new String[]{"returningDate", "Customer return date"});
list.add(new String[]{"airportTo", "Airport the customer returns to"});
list.add(new String[]{"numberOfAdults", "Number of adults on the flight"});
list.add(new String[]{"numberOfChildren", "Number of children on the flight"});
for (int i = 0; i < list.size(); i++) {
String currentParam = list.get(i)[0];
String query = availabilityParameters + ".findAll { it.name == '" + currentParam + "' }";
vr.body(query + ".in", both(hasSize(1)).and(contains("query")));
vr.body(query + ".description", both(hasSize(1)).and(contains(list.get(i)[1])));
vr.body(query + ".required", both(hasSize(1)).and(contains(true)));
vr.body(query + ".schema.type", both(hasSize(1)).and(contains("string")));
}
vr.body(availabilityParameters + ".findAll { it.name == 'numberOfAdults' }.schema.minimum",
both(hasSize(1)).and(contains(0)));
vr.body(availabilityParameters + ".findAll { it.name == 'numberOfChildren' }.schema.minimum",
both(hasSize(1)).and(contains(0)));
vr.body(availabilityParameters + ".findAll { it.$ref == '#/components/parameters/departureDate'}",
notNullValue());
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testExplode(String type) {
ValidatableResponse vr = callEndpoint(type);
String explode =
"paths.'/user/{username}'.put.responses.'200'.content.'application/xml'.encoding.password.explode";
vr.body(explode, equalTo(true));
explode = "paths.'/user/{username}'.put.responses.'200'.content.'application/xml'.encoding.password.explode";
vr.body(explode, equalTo(true));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testCallbackAnnotations(String type) {
ValidatableResponse vr = callEndpoint(type);
String endpoint = "paths.'/streams'.post.callbacks";
vr.body(endpoint, hasKey("onData"));
vr.body(endpoint + ".onData", hasKey("{$request.query.callbackUrl}/data"));
endpoint = "paths.'/reviews'.post.callbacks";
vr.body(endpoint, hasKey("testCallback"));
vr.body(endpoint + ".testCallback", hasKey("http://localhost:9080/oas3-airlines/reviews"));
endpoint = "paths.'/bookings'.post.callbacks";
vr.body(endpoint, hasKey("bookingCallback"));
vr.body(endpoint + ".'bookingCallback'", hasKey("http://localhost:9080/airlines/bookings"));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testCallbackOperationAnnotations(String type) {
ValidatableResponse vr = callEndpoint(type);
// TODO: cover /streams endpoint
String endpoint =
"paths.'/bookings'.post.callbacks.'bookingCallback'.'http://localhost:9080/airlines/bookings'";
vr.body(endpoint, hasKey("get"));
vr.body(endpoint + ".get.summary", equalTo("Retrieve all bookings for current user"));
vr.body(endpoint + ".get.responses.'200'.description", equalTo("Bookings retrieved"));
vr.body(endpoint + ".get.responses.'200'.content.'application/json'.schema.type", equalTo("array"));
endpoint = "paths.'/reviews'.post.callbacks.testCallback.'http://localhost:9080/oas3-airlines/reviews'";
vr.body(endpoint, hasKey("get"));
vr.body(endpoint + ".get.summary", equalTo("Get all reviews"));
vr.body(endpoint + ".get.responses.'200'.description", equalTo("successful operation"));
vr.body(endpoint + ".get.responses.'200'.content.'application/json'.schema.type", equalTo("array"));
vr.body(endpoint + ".get.responses.'200'.content.'application/json'.schema.items", notNullValue());
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testRequestBodyAnnotations(String type) {
ValidatableResponse vr = callEndpoint(type);
String endpoint = "paths.'/bookings'.post.requestBody";
vr.body(endpoint + ".description", equalTo("Create a new booking with the provided information."));
vr.body(endpoint + ".content", notNullValue());
endpoint = "paths.'/bookings/{id}'.put.requestBody";
vr.body(endpoint + ".content", notNullValue());
endpoint = "paths.'/user'.post.requestBody";
vr.body(endpoint + ".description", equalTo("Record of a new user to be created in the system."));
vr.body(endpoint + ".content", notNullValue());
vr.body(endpoint + ".required", equalTo(true));
endpoint = "paths.'/user/{username}'.put.requestBody";
vr.body(endpoint + ".description", equalTo("Record of a new user to be created in the system."));
vr.body(endpoint + ".content", notNullValue());
endpoint = "paths.'/user/createWithArray'.post.requestBody";
vr.body(endpoint + ".description", equalTo("Array of user object"));
vr.body(endpoint + ".content", notNullValue());
vr.body(endpoint + ".required", equalTo(true));
endpoint = "paths.'/user/createWithList'.post.requestBody";
vr.body(endpoint + ".description", equalTo("List of user object"));
vr.body(endpoint + ".content", notNullValue());
vr.body(endpoint + ".required", equalTo(true));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testSecurityRequirement(String type) {
ValidatableResponse vr = callEndpoint(type);
vr.body("security.airlinesRatingApp_auth[0][0]", equalTo(null));
vr.body("paths.'/reviews'.post.security.reviewoauth2[0][0]", equalTo("write:reviews"));
vr.body("paths.'/reviews'.post.security.reviewoauth2", hasSize(1));
vr.body("paths.'/bookings'.post.security.bookingSecurityScheme[0][0]", equalTo("write:bookings"));
vr.body("paths.'/bookings'.post.security.bookingSecurityScheme[0][1]", equalTo("read:bookings"));
vr.body("paths.'/reviews'.post.security.bookingSecurityScheme", hasSize(1));
vr.body("paths.'/bookings'.post.security.bookingSecurityScheme[0]", hasSize(2));
vr.body("paths.'/user'.post.security.httpSchemeForTest[0][0]", equalTo(null));
vr.body("paths.'/user/login'.get.security.find { it.httpTestScheme != null }.httpTestScheme", empty());
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testSecuritySchemes(String type) {
ValidatableResponse vr = callEndpoint(type);
String s = "components.securitySchemes";
vr.body(s, hasKey("httpSchemeForTest"));
vr.body(s, hasKey("airlinesRatingApp_auth"));
vr.body(s, hasKey("reviewoauth2"));
vr.body(s, hasKey("bookingSecurityScheme"));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testSecurityScheme(String type) {
ValidatableResponse vr = callEndpoint(type);
String http = "components.securitySchemes.httpSchemeForTest.";
vr.body(http + "type", equalTo("http"));
vr.body(http + "description", equalTo("user security scheme"));
vr.body(http + "scheme", equalTo("testScheme"));
String booking = "components.securitySchemes.bookingSecurityScheme.";
vr.body(booking + "type", equalTo("openIdConnect"));
vr.body(booking + "description", equalTo("Security Scheme for booking resource"));
vr.body(booking + "openIdConnectUrl", equalTo("http://openidconnect.com/testurl"));
String auth = "components.securitySchemes.airlinesRatingApp_auth.";
vr.body(auth + "type", equalTo("apiKey"));
vr.body(auth + "description", equalTo("authentication needed to access Airlines app"));
vr.body(auth + "name", equalTo("api_key"));
vr.body(auth + "in", equalTo("header"));
String reviewoauth2 = "components.securitySchemes.reviewoauth2.";
vr.body(reviewoauth2 + "type", equalTo("oauth2"));
vr.body(reviewoauth2 + "description", equalTo("authentication needed to create and delete reviews"));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testOAuthFlows(String type) {
ValidatableResponse vr = callEndpoint(type);
String t = "components.securitySchemes.reviewoauth2.flows";
vr.body(t, hasKey("implicit"));
vr.body(t, hasKey("authorizationCode"));
vr.body(t, hasKey("password"));
vr.body(t, hasKey("clientCredentials"));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testOAuthFlow(String type) {
ValidatableResponse vr = callEndpoint(type);
String implicit = "components.securitySchemes.reviewoauth2.flows.implicit.";
vr.body(implicit + "authorizationUrl", equalTo("https://example.com/api/oauth/dialog"));
String authCode = "components.securitySchemes.reviewoauth2.flows.authorizationCode.";
vr.body(authCode + "authorizationUrl", equalTo("https://example.com/api/oauth/dialog"));
vr.body(authCode + "tokenUrl", equalTo("https://example.com/api/oauth/token"));
String password = "components.securitySchemes.reviewoauth2.flows.password.";
vr.body(password + "refreshUrl", equalTo("https://example.com/api/oauth/refresh"));
String client = "components.securitySchemes.reviewoauth2.flows.clientCredentials.";
vr.body(client + "tokenUrl", equalTo("https://example.com/api/oauth/token"));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testOAuthScope(String type) {
ValidatableResponse vr = callEndpoint(type);
String implicit = "components.securitySchemes.reviewoauth2.flows.implicit.";
vr.body(implicit + "scopes.'write:reviews'", equalTo("create a review"));
String client = "components.securitySchemes.reviewoauth2.flows.clientCredentials.";
vr.body(client + "scopes.'read:reviews'", equalTo("search for a review"));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testEncodingRequestBody(String type) {
ValidatableResponse vr = callEndpoint(type);
String s = "paths.'/user'.post.requestBody.content.'application/json'.encoding.email.";
vr.body(s + "contentType", equalTo("text/plain"));
vr.body(s + "style", equalTo("form"));
vr.body(s + "explode", equalTo(true));
vr.body(s + "allowReserved", equalTo(true));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testEncodingResponses(String type) {
ValidatableResponse vr = callEndpoint(type);
String s = "paths.'/user/{username}'.put.responses.'200'.content.'application/json'.encoding.password.";
vr.body(s + "contentType", equalTo("text/plain"));
vr.body(s + "style", equalTo("form"));
vr.body(s + "explode", equalTo(true));
vr.body(s + "allowReserved", equalTo(true));
String t = "paths.'/user/{username}'.put.responses.'200'.content.'application/xml'.encoding.password.";
vr.body(t + "contentType", equalTo("text/plain"));
vr.body(t + "style", equalTo("form"));
vr.body(t + "explode", equalTo(true));
vr.body(t + "allowReserved", equalTo(true));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testLink(String type) {
ValidatableResponse vr = callEndpoint(type);
String s = "paths.'/user/{id}'.get.responses.'200'.links.'User name'.";
vr.body(s + "operationId", equalTo("getUserByName"));
vr.body(s + "description", equalTo("The username corresponding to provided user id"));
String t = "paths.'/user/{id}'.get.responses.'200'.links.Review.";
vr.body(t + "operationRef", equalTo("/db/reviews/{userName}"));
vr.body(t + "description", equalTo("The reviews provided by user"));
String k = "paths.'/reviews'.post.responses.'201'.links.Review.";
vr.body(k + "operationId", equalTo("getReviewById"));
vr.body(k + "description", equalTo("get the review that was added"));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testLinkParameter(String type) {
ValidatableResponse vr = callEndpoint(type);
String s = "paths.'/user/{id}'.get.responses.'200'.links.'User name'.";
vr.body(s + "parameters.userId", equalTo("$request.path.id"));
String t = "paths.'/user/{id}'.get.responses.'200'.links.Review.";
vr.body(t + "parameters.'path.userName'", equalTo("$response.body#userName"));
String k = "paths.'/reviews'.post.responses.'201'.links.Review.";
vr.body(k + "parameters.reviewId", equalTo("$request.path.id"));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testSchema(String type) {
ValidatableResponse vr = callEndpoint(type);
// Basic properties
vr.body("components.schemas.AirlinesRef.$ref", equalTo("#/components/schemas/Airlines"));
vr.body("components.schemas.Airlines.title", equalTo("Airlines"));
vr.body("paths.'/bookings'.post.responses.'201'.content.'application/json'.schema.type", equalTo("string"));
vr.body("components.schemas.id.format", equalTo("int32"));
vr.body("paths.'/bookings'.post.responses.'201'.content.'application/json'.schema.description",
equalTo("id of the new booking"));
vr.body("components.schemas.User.properties.password.example", equalTo("bobSm37"));
// Object properties
vr.body("paths.'/user'.post.requestBody.content.'application/json'.schema.maxProperties", equalTo(1024));
vr.body("paths.'/user'.post.requestBody.content.'application/json'.schema.minProperties", equalTo(1));
vr.body("components.schemas.User.required", hasItems("id", "username", "password")); // requiredProperties
vr.body("components.schemas.Gender.enum", hasItems("Male", "Female", "Other"));
// Array properties
String createSchema = "paths.'/user/createWithArray'.post.requestBody.content.'application/json'.schema";
vr.body(createSchema + ".nullable", equalTo(true));
vr.body(createSchema + ".writeOnly", equalTo(true));
vr.body(createSchema + ".maxItems", equalTo(20));
vr.body(createSchema + ".minItems", equalTo(2));
vr.body(createSchema + ".uniqueItems", equalTo(true));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testSchemaProperty(String type) {
ValidatableResponse vr = callEndpoint(type);
vr.body("components.schemas.User.properties", IsMapWithSize.aMapWithSize(10));
vr.body("components.schemas.User.properties.phone.example", equalTo("123-456-7891"));
vr.body("components.schemas.User.properties.phone.description",
equalTo("Telephone number to contact the user"));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testSchemaPropertyValuesOverrideClassPropertyValues(String type) {
ValidatableResponse vr = callEndpoint(type);
vr.body("components.schemas.User.properties", IsMapWithSize.aMapWithSize(10));
vr.body("components.schemas.User.properties.phone.example", not("123-456-7890"));
vr.body("components.schemas.User.properties.phone.example", equalTo("123-456-7891"));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testExampleObject(String type) {
ValidatableResponse vr = callEndpoint(type);
// Example in Components
vr.body("components.examples.review.summary", equalTo("External review example"));
vr.body("components.examples.review.description", equalTo("This example exemplifies the content on our site."));
vr.body("components.examples.review.externalValue", equalTo("http://foo.bar/examples/review-example.json"));
// Example in Parameter Content
vr.body("paths.'/reviews/users/{user}'.get.parameters.find{ it.name=='user'}.content.'*/*'.examples.example.value",
equalTo("bsmith"));
// Example in Parameter
vr.body("paths.'/reviews/users/{user}'.get.parameters.find{ it.name=='user'}.examples.example1.value",
equalTo("bsmith"));
vr.body("paths.'/reviews/users/{user}'.get.parameters.find{ it.name=='user'}.examples.example2.value",
equalTo("pat@example.com"));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testContentExampleAttribute(String type) {
ValidatableResponse vr = callEndpoint(type);
vr.body("paths.'/reviews/{user}/{airlines}'.get.parameters.find{it.name=='airlines'}.content.'*/*'.example",
equalTo("Acme Air"));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testTagDeclarations(String type) {
ValidatableResponse vr = callEndpoint(type);
String tagsPath = "tags.find { it.name == '";
String desc = "' }.description";
vr.body(tagsPath + "user" + desc, equalTo("Operations about user"));
vr.body(tagsPath + "create" + desc, equalTo("Operations about create"));
vr.body(tagsPath + "Airlines" + desc, equalTo("All the airlines methods"));
vr.body(tagsPath + "Availability" + desc, equalTo("All the availability methods"));
vr.body(tagsPath + "Get Flights" + desc, equalTo("method to retrieve all flights available"));
vr.body(tagsPath + "Get Flights" + "' }.externalDocs.description",
equalTo("A list of all the flights offered by the app"));
vr.body(tagsPath + "Get Flights" + "' }.externalDocs.url", equalTo("http://airlinesratingapp.com/ourflights"));
vr.body(tagsPath + "Bookings" + desc, equalTo("All the bookings methods"));
vr.body(tagsPath + "Reservations" + desc, equalTo("All the reservation methods"));
vr.body(tagsPath + "Reviews" + desc, equalTo("All the review methods"));
vr.body(tagsPath + "Ratings" + desc, equalTo("All the ratings methods"));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testTagsInOperations(String type) {
ValidatableResponse vr = callEndpoint(type);
vr.body("paths.'/availability'.get.tags", containsInAnyOrder("Get Flights", "Availability"));
vr.body("paths.'/bookings'.get.tags", containsInAnyOrder("bookings"));
vr.body("paths.'/bookings'.post.tags", containsInAnyOrder("Bookings", "Reservations"));
vr.body("paths.'/bookings/{id}'.get.tags", containsInAnyOrder("Bookings", "Reservations"));
vr.body("paths.'/bookings/{id}'.put.tags", containsInAnyOrder("Bookings", "Reservations"));
// no tag - class Tag was overwritten with empty Tag
vr.body("paths.'/bookings/{id}'.delete.tags", not(hasSize(greaterThan(0))));
vr.body("paths.'/reviews'.get.tags", containsInAnyOrder("Reviews", "Ratings"));
vr.body("paths.'/reviews'.post.tags", containsInAnyOrder("Reviews"));
vr.body("paths.'/reviews/{id}'.get.tags", containsInAnyOrder("Reviews", "Ratings"));
vr.body("paths.'/reviews/{id}'.delete.tags", containsInAnyOrder("Reviews", "Ratings"));
vr.body("paths.'/reviews/users/{user}'.get.tags", containsInAnyOrder("Reviews", "Ratings"));
vr.body("paths.'/reviews/airlines/{airline}'.get.tags", containsInAnyOrder("Reviews", "Ratings"));
vr.body("paths.'/reviews/{user}/{airlines}'.get.tags", containsInAnyOrder("Reviews", "Ratings"));
vr.body("paths.'/user'.post.tags", containsInAnyOrder("user", "create"));
vr.body("paths.'/user/createWithArray'.post.tags", containsInAnyOrder("user", "create"));
vr.body("paths.'/user/createWithList'.post.tags", containsInAnyOrder("user", "create"));
vr.body("paths.'/user/{username}'.get.tags", containsInAnyOrder("user"));
vr.body("paths.'/user/{username}'.put.tags", containsInAnyOrder("user"));
vr.body("paths.'/user/{username}'.delete.tags", containsInAnyOrder("user"));
vr.body("paths.'/user/{id}'.get.tags", containsInAnyOrder("user"));
// empty tag was defined
vr.body("paths.'/user/login'.get.tags", not(hasSize(greaterThan(0))));
// no tag was defined
vr.body("paths.'/user/logout'.get.tags", not(hasSize(greaterThan(0))));
vr.body("paths.'/'.get.tags", containsInAnyOrder("Airlines"));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testComponents(String type) {
ValidatableResponse vr = callEndpoint(type);
// Tests to ensure that the reusable items declared using the
// @Components annotation (within @OpenAPIDefinition) exist.
// Each of these item types are tested elsewhere, so no need to test the
// content of them here.
vr.body("components.schemas.Bookings", notNullValue());
vr.body("components.schemas.Airlines", notNullValue());
vr.body("components.schemas.AirlinesRef", notNullValue());
vr.body("components.responses.FoundAirlines", notNullValue());
vr.body("components.responses.FoundBookings", notNullValue());
vr.body("components.parameters.departureDate", notNullValue());
vr.body("components.parameters.username", notNullValue());
vr.body("components.examples.review", notNullValue());
vr.body("components.examples.user", notNullValue());
vr.body("components.requestBodies.review", notNullValue());
vr.body("components.headers.Max-Rate", notNullValue());
vr.body("components.headers.Request-Limit", notNullValue());
vr.body("components.securitySchemes.httpTestScheme", notNullValue());
vr.body("components.links.UserName", notNullValue());
vr.body("components.callbacks.GetBookings", notNullValue());
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testHeaderInAPIResponse(String type) {
ValidatableResponse vr = callEndpoint(type);
// Headers within APIResponse
String responseHeader1 = "paths.'/reviews/{id}'.get.responses.'200'.headers.responseHeader1";
vr.body(responseHeader1, notNullValue());
vr.body(responseHeader1 + ".description", equalTo("Max rate"));
vr.body(responseHeader1 + ".required", equalTo(true));
vr.body(responseHeader1 + ".deprecated", equalTo(true));
vr.body(responseHeader1 + ".allowEmptyValue", equalTo(true));
vr.body(responseHeader1 + ".style", equalTo("simple"));
vr.body(responseHeader1 + ".schema.type", equalTo("integer"));
String responseHeader2 = "paths.'/reviews/{id}'.get.responses.'200'.headers.responseHeader2";
vr.body(responseHeader2, notNullValue());
vr.body(responseHeader2 + ".description", equalTo("Input value"));
vr.body(responseHeader2 + ".required", equalTo(true));
vr.body(responseHeader2 + ".deprecated", equalTo(true));
vr.body(responseHeader2 + ".allowEmptyValue", equalTo(true));
vr.body(responseHeader2 + ".style", equalTo("simple"));
vr.body(responseHeader2 + ".schema.type", equalTo("string"));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testHeaderInEncoding(String type) {
ValidatableResponse vr = callEndpoint(type);
// Header within Encoding
String testHeader =
"paths.'/user'.post.requestBody.content.'application/json'.encoding.email.headers.testHeader";
vr.body(testHeader, notNullValue());
vr.body(testHeader + ".description", equalTo("Minimum rate"));
vr.body(testHeader + ".required", equalTo(true));
vr.body(testHeader + ".deprecated", equalTo(true));
vr.body(testHeader + ".allowEmptyValue", equalTo(true));
vr.body(testHeader + ".style", equalTo("simple"));
vr.body(testHeader + ".schema.type", equalTo("integer"));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testRefHeaderInAPIResponse(String type) {
ValidatableResponse vr = callEndpoint(type);
// Reference to Header within APIResponse
String responseRefHeader = "paths.'/reviews'.get.responses.'200'.headers.Request-Limit";
vr.body(responseRefHeader, notNullValue());
vr.body(responseRefHeader + ".$ref", equalTo("#/components/headers/Request-Limit"));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testRefHeaderInEncoding(String type) {
ValidatableResponse vr = callEndpoint(type);
// Reference to Header within Encoding
String encodingRefHeader =
"paths.'/user/{username}'.put.responses.'200'.content.'application/json'.encoding.password.headers.Max-Rate";
vr.body(encodingRefHeader, notNullValue());
vr.body(encodingRefHeader + ".$ref", equalTo("#/components/headers/Max-Rate"));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testHeaderInComponents(String type) {
ValidatableResponse vr = callEndpoint(type);
String maxRate = "components.headers.Max-Rate";
vr.body(maxRate + ".description", equalTo("Maximum rate"));
vr.body(maxRate + ".required", equalTo(true));
vr.body(maxRate + ".deprecated", equalTo(true));
vr.body(maxRate + ".allowEmptyValue", equalTo(true));
vr.body(maxRate + ".style", equalTo("simple"));
vr.body(maxRate + ".schema.type", equalTo("integer"));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testContentInAPIResponse(String type) {
ValidatableResponse vr = callEndpoint(type);
String content1 = "paths.'/availability'.get.responses.'200'.content.'application/json'";
vr.body(content1, notNullValue());
vr.body(content1 + ".schema.type", equalTo("array"));
vr.body(content1 + ".schema.items", notNullValue());
String content2 = "paths.'/user/{username}'.put.responses.'200'.content";
vr.body(content2, notNullValue());
vr.body(content2 + ".'application/json'", notNullValue());
vr.body(content2 + ".'application/json'.schema.$ref", equalTo("#/components/schemas/User"));
vr.body(content2 + ".'application/json'.encoding.password", notNullValue());
vr.body(content2, notNullValue());
vr.body(content2 + ".'application/xml'", notNullValue());
vr.body(content2 + ".'application/xml'.schema.$ref", equalTo("#/components/schemas/User"));
vr.body(content2 + ".'application/xml'.encoding.password", notNullValue());
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testContentInRequestBody(String type) {
ValidatableResponse vr = callEndpoint(type);
String contentJson = "paths.'/bookings'.post.requestBody.content.'application/json'";
vr.body(contentJson, notNullValue());
vr.body(contentJson + ".schema.$ref", equalTo("#/components/schemas/Booking"));
vr.body(contentJson + ".examples.booking.summary", equalTo("External booking example"));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testContentInParameter(String type) {
ValidatableResponse vr = callEndpoint(type);
String content = "paths.'/reviews/users/{user}'.get.parameters.find{ it.name == 'user' }.content";
vr.body(content, notNullValue());
vr.body(content + ".'*/*'", notNullValue());
vr.body(content + ".'*/*'.schema.type", equalTo("string"));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testDefaultParameterRequirement(String type) {
ValidatableResponse vr = callEndpoint(type);
String params = "paths.'/reviews/users/{user}'.get.parameters";
vr.body(params, notNullValue());
vr.body(params + ".find{ it.name == 'user' }", hasEntry(equalTo("in"), equalTo("path")));
vr.body(params + ".find{ it.name == 'user' }", hasEntry(equalTo("required"), equalTo(true)));
vr.body(params + ".find{ it.name == 'minRating' }", hasEntry(equalTo("in"), equalTo("query")));
vr.body(params + ".find{ it.name == 'minRating' }", either(not(hasKey("required")))
.or(hasEntry(equalTo("required"), equalTo(false))));
vr.body(params + ".find{ it.name == 'If-Match' }", hasEntry(equalTo("in"), equalTo("header")));
vr.body(params + ".find{ it.name == 'If-Match' }", either(not(hasKey("required")))
.or(hasEntry(equalTo("required"), equalTo(false))));
vr.body(params + ".find{ it.name == 'trackme' }", hasEntry(equalTo("in"), equalTo("cookie")));
vr.body(params + ".find{ it.name == 'trackme' }", either(not(hasKey("required")))
.or(hasEntry(equalTo("required"), equalTo(false))));
}
@RunAsClient
@Test(dataProvider = "formatProvider")
public void testStaticFileDefinitions(String type) {
ValidatableResponse vr = callEndpoint(type);
vr.body("paths.'/streams'.post.description", equalTo("subscribes a client to receive out-of-band data"));
final String parametersPath = "paths.'/streams'.post.parameters";
vr.body(parametersPath, hasSize(1));
vr.body(parametersPath + ".find{ it.name == 'callbackUrl' }.in", equalTo("query"));
vr.body(parametersPath + ".find{ it.name == 'callbackUrl' }.required", equalTo(true));
vr.body(parametersPath + ".find{ it.name == 'callbackUrl' }.description",
containsString("the location where data will be sent."));
vr.body(parametersPath + ".find{ it.name == 'callbackUrl' }.schema.type", equalTo("string"));
vr.body(parametersPath + ".find{ it.name == 'callbackUrl' }.schema.format", equalTo("uri"));
vr.body(parametersPath + ".find{ it.name == 'callbackUrl' }.schema.example",
equalTo("https://tonys-server.com"));
final String responsePath = "paths.'/streams'.post.responses";
vr.body(responsePath, aMapWithSize(1));
final String response201Path = responsePath + ".'201'";
vr.body(response201Path + ".description", equalTo("subscription successfully created"));
vr.body(response201Path + ".content.'application/json'.schema.description",
equalTo("subscription information"));
vr.body(response201Path + ".content.'application/json'.schema.required",
both(hasSize(1)).and(contains("subscriptionId")));
vr.body(response201Path + ".content.'application/json'.schema.properties.subscriptionId.description",
equalTo("this unique identifier allows management of the subscription"));
vr.body(response201Path + ".content.'application/json'.schema.properties.subscriptionId.type",
equalTo("string"));
vr.body(response201Path + ".content.'application/json'.schema.properties.subscriptionId.example",
equalTo("2531329f-fb09-4ef7-887e-84e648214436"));
final String callbacksPath = "paths.'/streams'.post.callbacks.onData.'{$request.query.callbackUrl}/data'.post";
vr.body(callbacksPath + ".requestBody.description", equalTo("subscription payload"));
vr.body(callbacksPath + ".requestBody.content.'application/json'.schema.properties.timestamp.type",
equalTo("string"));
vr.body(callbacksPath + ".requestBody.content.'application/json'.schema.properties.timestamp.format",
equalTo("date-time"));
vr.body(callbacksPath + ".requestBody.content.'application/json'.schema.properties.userData.type",
equalTo("string"));
vr.body(callbacksPath + ".responses", aMapWithSize(2));
vr.body(callbacksPath + ".responses.'202'.description",
both(containsString("Your server implementation should return this HTTP status code"))
.and(containsString("if the data was received successfully")));
vr.body(callbacksPath + ".responses.'204'.description",
both(containsString("Your server should return this HTTP status code if no longer interested"))
.and(containsString("in further updates")));
}
@RunAsClient