forked from Jonathan-Rosenberg/oasdiff
-
Notifications
You must be signed in to change notification settings - Fork 1
/
checker_breaking_property_test.go
681 lines (554 loc) · 26.1 KB
/
checker_breaking_property_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
package checker_test
import (
"fmt"
"testing"
"github.com/getkin/kin-openapi/openapi3"
"github.com/stretchr/testify/require"
"github.com/treeverse/oasdiff/checker"
"github.com/treeverse/oasdiff/diff"
)
func getReqPropFile(file string) string {
return fmt.Sprintf("../data/required-properties/%s", file)
}
// BC: new required property in request header is breaking
func TestBreaking_NewRequiredProperty(t *testing.T) {
s1 := l(t, 1)
s2 := l(t, 1)
s2.Spec.Paths[installCommandPath].Get.Parameters.GetByInAndName(openapi3.ParameterInHeader, "network-policies").Schema.Value.Properties["courseId"] = &openapi3.SchemaRef{
Value: &openapi3.Schema{
Type: "string",
Description: "Unique ID of the course",
},
}
s2.Spec.Paths[installCommandPath].Get.Parameters.GetByInAndName(openapi3.ParameterInHeader, "network-policies").Schema.Value.Required = []string{"courseId"}
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), &s1, &s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.NotEmpty(t, errs)
require.Len(t, errs, 1)
require.Equal(t, "new-required-request-header-property", errs[0].GetId())
}
// BC: new optional property in request header is not breaking
func TestBreaking_NewNonRequiredProperty(t *testing.T) {
s1 := l(t, 1)
s2 := l(t, 1)
s2.Spec.Paths[installCommandPath].Get.Parameters.GetByInAndName(openapi3.ParameterInHeader, "network-policies").Schema.Value.Properties["courseId"] = &openapi3.SchemaRef{
Value: &openapi3.Schema{
Type: "string",
Description: "Unique ID of the course",
},
}
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), &s1, &s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.Empty(t, errs)
}
// BC: changing an existing property in request header to required is breaking
func TestBreaking_PropertyRequiredEnabled(t *testing.T) {
s1 := l(t, 1)
s2 := l(t, 1)
sr := openapi3.SchemaRef{
Value: &openapi3.Schema{
Type: "string",
Description: "Unique ID of the course",
},
}
s1.Spec.Paths[installCommandPath].Get.Parameters.GetByInAndName(openapi3.ParameterInHeader, "network-policies").Schema.Value.Properties["courseId"] = &sr
s1.Spec.Paths[installCommandPath].Get.Parameters.GetByInAndName(openapi3.ParameterInHeader, "network-policies").Schema.Value.Required = []string{}
s2.Spec.Paths[installCommandPath].Get.Parameters.GetByInAndName(openapi3.ParameterInHeader, "network-policies").Schema.Value.Properties["courseId"] = &sr
s2.Spec.Paths[installCommandPath].Get.Parameters.GetByInAndName(openapi3.ParameterInHeader, "network-policies").Schema.Value.Required = []string{"courseId"}
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), &s1, &s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.NotEmpty(t, errs)
require.Len(t, errs, 1)
require.Equal(t, "request-header-property-became-required", errs[0].GetId())
}
// BC: changing an existing property in request header to optional is not breaking
func TestBreaking_PropertyRequiredDisabled(t *testing.T) {
s1 := l(t, 1)
s2 := l(t, 1)
sr := openapi3.SchemaRef{
Value: &openapi3.Schema{
Type: "string",
Description: "Unique ID of the course",
},
}
s1.Spec.Paths[installCommandPath].Get.Parameters.GetByInAndName(openapi3.ParameterInHeader, "network-policies").Schema.Value.Properties["courseId"] = &sr
s1.Spec.Paths[installCommandPath].Get.Parameters.GetByInAndName(openapi3.ParameterInHeader, "network-policies").Schema.Value.Required = []string{"courseId"}
s2.Spec.Paths[installCommandPath].Get.Parameters.GetByInAndName(openapi3.ParameterInHeader, "network-policies").Schema.Value.Properties["courseId"] = &sr
s2.Spec.Paths[installCommandPath].Get.Parameters.GetByInAndName(openapi3.ParameterInHeader, "network-policies").Schema.Value.Required = []string{}
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), &s1, &s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.Empty(t, errs)
}
// BC: changing an existing property in response body to optional is breaking
func TestBreaking_RespBodyRequiredPropertyDisabled(t *testing.T) {
s1, err := open(getReqPropFile("response-base.json"))
require.NoError(t, err)
s2, err := open(getReqPropFile("response-revision.json"))
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.NotEmpty(t, errs)
require.Len(t, errs, 1)
require.Equal(t, "response-property-became-optional", errs[0].GetId())
}
// BC: changing a request body to enum is breaking
func TestBreaking_ReqBodyBecameEnum(t *testing.T) {
s1, err := open("../data/enums/request-body-no-enum.yaml")
require.NoError(t, err)
s2, err := open("../data/enums/request-body-enum.yaml")
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.NotEmpty(t, errs)
require.Len(t, errs, 1)
require.Equal(t, "request-body-became-enum", errs[0].GetId())
}
// BC: adding an enum value to request body is not breaking
func TestBreaking_ReqBodyEnumValueAdded(t *testing.T) {
s1, err := open("../data/enums/request-body-enum.yaml")
require.NoError(t, err)
s2, err := open("../data/enums/request-body-enum-revision.yaml")
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.Empty(t, errs)
}
// BC: changing a request body type and changing it to enum simultaneously is breaking
func TestBreaking_ReqBodyBecameEnumAndTypeChanged(t *testing.T) {
s1, err := open("../data/enums/request-body-no-enum.yaml")
require.NoError(t, err)
s2, err := open("../data/enums/request-body-enum-int.yaml")
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.Len(t, errs, 2)
require.Equal(t, "request-body-became-enum", errs[0].GetId())
require.Equal(t, "request-body-type-changed", errs[1].GetId())
}
// BC: changing an existing property in request body to enum is breaking
func TestBreaking_ReqPropertyBecameEnum(t *testing.T) {
s1, err := open("../data/enums/request-property-no-enum.yaml")
require.NoError(t, err)
s2, err := open("../data/enums/request-property-enum.yaml")
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.NotEmpty(t, errs)
require.Len(t, errs, 1)
require.Equal(t, "request-property-became-enum", errs[0].GetId())
}
// BC: changing an existing header param to enum is breaking
func TestBreaking_ReqParameterBecameEnum(t *testing.T) {
s1, err := open("../data/enums/request-parameter-op-no-enum.yaml")
require.NoError(t, err)
s2, err := open("../data/enums/request-parameter-op-enum.yaml")
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.NotEmpty(t, errs)
require.Len(t, errs, 1)
require.Equal(t, "request-parameter-became-enum", errs[0].GetId())
}
// BC: changing an existing property in request header to enum is breaking
func TestBreaking_ReqParameterHeaderPropertyBecameEnum(t *testing.T) {
s1, err := open("../data/enums/request-parameter-property-no-enum.yaml")
require.NoError(t, err)
s2, err := open("../data/enums/request-parameter-property-enum.yaml")
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.NotEmpty(t, errs)
require.Len(t, errs, 1)
require.Equal(t, "request-header-property-became-enum", errs[0].GetId())
}
// BC: changing a response body to nullable is breaking
func TestBreaking_RespBodyNullable(t *testing.T) {
s1, err := open("../data/nullable/base-body.yaml")
require.NoError(t, err)
s2, err := open("../data/nullable/revision-body.yaml")
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.NotEmpty(t, errs)
require.Len(t, errs, 1)
require.Equal(t, "response-body-became-nullable", errs[0].GetId())
}
// BC: changing a request property to not nullable is breaking
func TestBreaking_ReqBodyPropertyNotNullable(t *testing.T) {
s1, err := open("../data/nullable/base-req.yaml")
require.NoError(t, err)
s2, err := open("../data/nullable/revision-req.yaml")
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.NotEmpty(t, errs)
require.Len(t, errs, 1)
require.Equal(t, "request-property-became-not-nullable", errs[0].GetId())
}
// BC: changing a response property to nullable is breaking
func TestBreaking_RespBodyPropertyNullable(t *testing.T) {
s1, err := open("../data/nullable/base-property.yaml")
require.NoError(t, err)
s2, err := open("../data/nullable/revision-property.yaml")
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.NotEmpty(t, errs)
require.Len(t, errs, 1)
require.Equal(t, "response-property-became-nullable", errs[0].GetId())
}
// BC: changing an embedded response property to nullable is breaking
func TestBreaking_RespBodyEmbeddedPropertyNullable(t *testing.T) {
s1, err := open("../data/nullable/base-embedded-property.yaml")
require.NoError(t, err)
s2, err := open("../data/nullable/revision-embedded-property.yaml")
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.NotEmpty(t, errs)
require.Len(t, errs, 1)
require.Equal(t, "response-property-became-nullable", errs[0].GetId())
}
// BC: changing a required property in response body to optional and also deleting it is breaking
func TestBreaking_RespBodyDeleteAndDisableRequiredProperty(t *testing.T) {
s1, err := open(getReqPropFile("response-del-required-prop-base.yaml"))
require.NoError(t, err)
s2, err := open(getReqPropFile("response-del-required-prop-revision.yaml"))
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.NotEmpty(t, errs)
}
// BC: adding a non-existent required property in request body is not breaking
func TestBreaking_ReqBodyNewRequiredPropertyNew(t *testing.T) {
s1, err := open(getReqPropFile("request-new-required-prop-base.yaml"))
require.NoError(t, err)
s2, err := open(getReqPropFile("request-new-required-prop-revision.yaml"))
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.Empty(t, errs)
}
// BC: changing an existing property in response body to required is not breaking
func TestBreaking_RespBodyRequiredPropertyEnabled(t *testing.T) {
s1, err := open(getReqPropFile("response-revision.json"))
require.NoError(t, err)
s2, err := open(getReqPropFile("response-base.json"))
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.Empty(t, errs)
}
// BC: changing an existing property in request body to optional is not breaking
func TestBreaking_ReqBodyRequiredPropertyDisabled(t *testing.T) {
s1, err := open(getReqPropFile("request-base.yaml"))
require.NoError(t, err)
s2, err := open(getReqPropFile("request-revision.yaml"))
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.Empty(t, errs)
}
// BC: changing an existing property in request body to required is breaking
func TestBreaking_ReqBodyRequiredPropertyEnabled(t *testing.T) {
s1, err := open(getReqPropFile("request-revision.yaml"))
require.NoError(t, err)
s2, err := open(getReqPropFile("request-base.yaml"))
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.NotEmpty(t, errs)
require.Len(t, errs, 1)
require.Equal(t, "request-property-became-required", errs[0].GetId())
}
// BC: adding a new required property in request body is breaking
func TestBreaking_ReqBodyNewRequiredProperty(t *testing.T) {
s1, err := open(getReqPropFile("request-new-base.yaml"))
require.NoError(t, err)
s2, err := open(getReqPropFile("request-new-revision.yaml"))
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.NotEmpty(t, errs)
require.Len(t, errs, 1)
require.Equal(t, "new-required-request-property", errs[0].GetId())
}
// BC: deleting a required property in request is breaking with warn
func TestBreaking_ReqBodyDeleteRequiredProperty(t *testing.T) {
s1, err := open(getReqPropFile("request-new-revision.yaml"))
require.NoError(t, err)
s2, err := open(getReqPropFile("request-new-base.yaml"))
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.NotEmpty(t, errs)
require.Len(t, errs, 1)
require.Equal(t, "request-property-removed", errs[0].GetId())
require.Equal(t, checker.WARN, errs[0].GetLevel())
}
// BC: deleting an embedded optional property in request is breaking with warn
func TestBreaking_ReqBodyDeleteRequiredProperty2(t *testing.T) {
s1, err := open(getReqPropFile("request-property-items.yaml"))
require.NoError(t, err)
s2, err := open(getReqPropFile("request-property-items-2.yaml"))
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.Contains(t, errs, checker.ApiChange{
Id: "request-property-removed",
Text: "removed the request property 'roleAssignments/items/role'",
Comment: "",
Level: checker.WARN,
Operation: "POST",
OperationId: "",
Path: "/api/roleMappings",
Source: "../data/required-properties/request-property-items-2.yaml",
})
}
// BC: adding a new required property in response body is not breaking
func TestBreaking_RespBodyNewRequiredProperty(t *testing.T) {
s1, err := open(getReqPropFile("response-new-base.json"))
require.NoError(t, err)
s2, err := open(getReqPropFile("response-new-revision.json"))
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.Empty(t, errs)
}
// BC: deleting a required property in response body is breaking
func TestBreaking_RespBodyDeleteRequiredProperty(t *testing.T) {
s1, err := open(getReqPropFile("response-new-revision.json"))
require.NoError(t, err)
s2, err := open(getReqPropFile("response-new-base.json"))
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.NotEmpty(t, errs)
require.Len(t, errs, 1)
require.Equal(t, "response-required-property-removed", errs[0].GetId())
}
// BC: adding a new required property under AllOf in response body is not breaking
func TestBreaking_RespBodyNewAllOfRequiredProperty(t *testing.T) {
s1, err := open(getReqPropFile("response-allof-base.json"))
require.NoError(t, err)
s2, err := open(getReqPropFile("response-allof-revision.json"))
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.Empty(t, errs)
}
// BC: deleting a required property under AllOf in response body is breaking
func TestBreaking_RespBodyDeleteAllOfRequiredProperty(t *testing.T) {
s1, err := open(getReqPropFile("response-allof-revision.json"))
require.NoError(t, err)
s2, err := open(getReqPropFile("response-allof-base.json"))
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.NotEmpty(t, errs)
require.Len(t, errs, 1)
require.Equal(t, "response-required-property-removed", errs[0].GetId())
}
// Old BC: adding a new required property under AllOf in response body is not breaking but when multiple inline (without $ref) schemas under AllOf are modified simultaneously, we detect is as breaking
// explanation: when multiple inline (without $ref) schemas under AllOf are modified we can't correlate schemas across base and revision
// as a result we can't determine that the change was "a new required property" and the change appears as breaking
// New BC: this "breaking change" is only the tip of the iceberg. The real problem is that allOf / anyOf must be processed specifically.
// For allOf all subSchemas must be merged before diff checking
// For anyOf schemas must be compared one-by-one
// I am going to change the behaviour in this case because currently it is false-positive case which can't correctly be checked
// At least now it is a warn
func TestBreaking_RespBodyNewAllOfMultiRequiredProperty(t *testing.T) {
s1, err := open(getReqPropFile("response-allof-multi-base.json"))
require.NoError(t, err)
s2, err := open(getReqPropFile("response-allof-multi-revision.json"))
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.NotEmpty(t, errs)
require.Len(t, errs, 1)
require.Equal(t, "response-allOf-modified", errs[0].GetId())
require.Equal(t, checker.WARN, errs[0].GetLevel())
}
// BC: adding a new required read-only property in request body is not breaking
func TestBreaking_ReadOnlyNewRequiredProperty(t *testing.T) {
s1, err := open(getReqPropFile("read-only-new-base.yaml"))
require.NoError(t, err)
s2, err := open(getReqPropFile("read-only-new-revision.yaml"))
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.Empty(t, errs)
}
// BC: changing an existing read-only property in request body to required is not breaking
func TestBreaking_ReadOnlyPropertyRequiredEnabled(t *testing.T) {
s1, err := open(getReqPropFile("read-only-base.yaml"))
require.NoError(t, err)
s2, err := open(getReqPropFile("read-only-revision.yaml"))
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.Empty(t, errs)
}
// BC: deleting a required write-only property in response body is not breaking
func TestBreaking_WriteOnlyDeleteRequiredProperty(t *testing.T) {
s1, err := open(getReqPropFile("write-only-delete-base.yaml"))
require.NoError(t, err)
s2, err := open(getReqPropFile("write-only-delete-revision.yaml"))
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.NotEmpty(t, errs)
require.Len(t, errs, 1)
require.Equal(t, "request-property-removed", errs[0].GetId())
require.Equal(t, checker.WARN, errs[0].GetLevel())
}
// BC: deleting a non-required non-write-only property in response body is breaking with warning
func TestBreaking_WriteOnlyDeleteNonRequiredProperty(t *testing.T) {
s1, err := open(getReqPropFile("write-only-delete-partial-base.yaml"))
require.NoError(t, err)
s2, err := open(getReqPropFile("write-only-delete-partial-revision.yaml"))
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.NotEmpty(t, errs)
require.Len(t, errs, 3)
require.Equal(t, "request-property-removed", errs[0].GetId())
require.Equal(t, checker.WARN, errs[0].GetLevel())
require.Equal(t, "response-optional-property-removed", errs[1].GetId())
require.Equal(t, checker.WARN, errs[1].GetLevel())
require.Equal(t, "response-optional-property-removed", errs[2].GetId())
require.Equal(t, checker.WARN, errs[2].GetLevel())
}
// BC: changing an existing write-only property in response body to optional is not breaking
func TestBreaking_WriteOnlyPropertyRequiredDisabled(t *testing.T) {
s1, err := open(getReqPropFile("write-only-base.yaml"))
require.NoError(t, err)
s2, err := open(getReqPropFile("write-only-revision.yaml"))
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.Empty(t, errs)
}
// BC: changing an existing required property in response body to write-only is not breaking
func TestBreaking_RequiredPropertyWriteOnlyEnabled(t *testing.T) {
s1, err := open(getReqPropFile("write-only-changed-base.yaml"))
require.NoError(t, err)
s2, err := open(getReqPropFile("write-only-changed-revision.yaml"))
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.Empty(t, errs)
}
// BC: changing an existing required property in response body to not-write-only is breaking
func TestBreaking_RequiredPropertyWriteOnlyDisabled(t *testing.T) {
s1, err := open(getReqPropFile("write-only-changed-revision.yaml"))
require.NoError(t, err)
s2, err := open(getReqPropFile("write-only-changed-base.yaml"))
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.NotEmpty(t, errs)
require.Len(t, errs, 2)
require.Equal(t, "response-required-property-became-not-write-only", errs[0].GetId())
require.Equal(t, checker.WARN, errs[0].GetLevel())
require.Equal(t, "response-required-property-became-not-write-only", errs[1].GetId())
require.Equal(t, checker.WARN, errs[1].GetLevel())
}
// BC: changing an existing property in request body to required is breaking
func TestBreaking_Body(t *testing.T) {
s1, err := open(getReqPropFile("body1.yaml"))
require.NoError(t, err)
s2, err := open(getReqPropFile("body2.yaml"))
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.NotEmpty(t, errs)
require.Len(t, errs, 1)
require.Equal(t, "request-property-became-required", errs[0].GetId())
}
// BC: changing an existing property in request body items to required is breaking
func TestBreaking_Items(t *testing.T) {
s1, err := open(getReqPropFile("items1.yaml"))
require.NoError(t, err)
s2, err := open(getReqPropFile("items2.yaml"))
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.NotEmpty(t, errs)
require.Len(t, errs, 1)
require.Equal(t, "request-property-became-required", errs[0].GetId())
}
// BC: changing an existing property in request body anyOf to required is breaking
func TestBreaking_AnyOf(t *testing.T) {
s1, err := open(getReqPropFile("anyOf1.yaml"))
require.NoError(t, err)
s2, err := open(getReqPropFile("anyOf2.yaml"))
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.NotEmpty(t, errs)
require.Len(t, errs, 1)
require.Equal(t, "request-property-became-required", errs[0].GetId())
}
// BC: changing an existing property under another property in request body to required is breaking
func TestBreaking_NestedProp(t *testing.T) {
s1, err := open(getReqPropFile("nested-property1.yaml"))
require.NoError(t, err)
s2, err := open(getReqPropFile("nested-property2.yaml"))
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.NotEmpty(t, errs)
require.Len(t, errs, 1)
require.Equal(t, "request-property-became-required", errs[0].GetId())
}
// BC: changing a response property to optional under AllOf, AnyOf or OneOf is breaking
func TestBreaking_OneOf(t *testing.T) {
s1, err := open("../data/x-of/base.json")
require.NoError(t, err)
s2, err := open("../data/x-of/revision.json")
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibility(checker.GetDefaultChecks(), d, osm)
require.Len(t, errs, 3)
}