-
Notifications
You must be signed in to change notification settings - Fork 68
/
Copy pathcheck_request_property_updated_test.go
130 lines (118 loc) · 5 KB
/
check_request_property_updated_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
package checker_test
import (
"testing"
"github.com/stretchr/testify/require"
"github.com/tufin/oasdiff/checker"
"github.com/tufin/oasdiff/diff"
"github.com/tufin/oasdiff/load"
)
// CL: adding a new required request property
func TestRequiredRequestPropertyAdded(t *testing.T) {
s1, err := open("../data/checker/request_property_added_base.yaml")
require.NoError(t, err)
s2, err := open("../data/checker/request_property_added_revision.yaml")
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(diff.NewConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibilityUntilLevel(singleCheckConfig(checker.RequestPropertyUpdatedCheck), d, osm, checker.INFO)
require.Len(t, errs, 1)
require.Equal(t, checker.ApiChange{
Id: checker.NewRequiredRequestPropertyId,
Args: []any{"description"},
Level: checker.ERR,
Operation: "POST",
Path: "/products",
Source: load.NewSource("../data/checker/request_property_added_revision.yaml"),
OperationId: "addProduct",
}, errs[0])
}
// CL: adding two new request properties, one required, one optional
func TestRequiredRequestPropertiesAdded(t *testing.T) {
s1, err := open("../data/checker/request_property_added_base.yaml")
require.NoError(t, err)
s2, err := open("../data/checker/request_property_added_revision2.yaml")
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(diff.NewConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibilityUntilLevel(singleCheckConfig(checker.RequestPropertyUpdatedCheck), d, osm, checker.INFO)
require.ElementsMatch(t, []checker.ApiChange{
{
Id: checker.NewRequiredRequestPropertyId,
Args: []any{"description"},
Level: checker.ERR,
Operation: "POST",
Path: "/products",
Source: load.NewSource("../data/checker/request_property_added_revision2.yaml"),
OperationId: "addProduct",
},
{
Id: checker.NewOptionalRequestPropertyId,
Args: []any{"info"},
Level: checker.INFO,
Operation: "POST",
Path: "/products",
Source: load.NewSource("../data/checker/request_property_added_revision2.yaml"),
OperationId: "addProduct",
}}, errs)
}
// CL: adding a new optional request property
func TestRequiredOptionalPropertyAdded(t *testing.T) {
s1, err := open("../data/checker/request_property_added_base.yaml")
require.NoError(t, err)
s2, err := open("../data/checker/request_property_added_revision.yaml")
require.NoError(t, err)
s2.Spec.Paths.Value("/products").Post.RequestBody.Value.Content["application/json"].Schema.Value.Required = []string{"name"}
d, osm, err := diff.GetWithOperationsSourcesMap(diff.NewConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibilityUntilLevel(singleCheckConfig(checker.RequestPropertyUpdatedCheck), d, osm, checker.INFO)
require.Len(t, errs, 1)
require.Equal(t, checker.ApiChange{
Id: checker.NewOptionalRequestPropertyId,
Args: []any{"description"},
Level: checker.INFO,
Operation: "POST",
Path: "/products",
Source: load.NewSource("../data/checker/request_property_added_revision.yaml"),
OperationId: "addProduct",
}, errs[0])
}
// CL: removing a required request property
func TestRequiredRequestPropertyRemoved(t *testing.T) {
s1, err := open("../data/checker/request_property_added_revision.yaml")
require.NoError(t, err)
s2, err := open("../data/checker/request_property_added_base.yaml")
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(diff.NewConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibilityUntilLevel(singleCheckConfig(checker.RequestPropertyUpdatedCheck), d, osm, checker.INFO)
require.Len(t, errs, 1)
require.Equal(t, checker.ApiChange{
Id: checker.RequestPropertyRemovedId,
Args: []any{"description"},
Level: checker.WARN,
Operation: "POST",
Path: "/products",
Source: load.NewSource("../data/checker/request_property_added_base.yaml"),
OperationId: "addProduct",
}, errs[0])
}
// CL: adding a new required request property with a default value
func TestRequiredRequestPropertyAddedWithDefault(t *testing.T) {
s1, err := open("../data/checker/request_property_added_base.yaml")
require.NoError(t, err)
s2, err := open("../data/checker/request_property_added_with_default.yaml")
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(diff.NewConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibilityUntilLevel(singleCheckConfig(checker.RequestPropertyUpdatedCheck), d, osm, checker.INFO)
require.Len(t, errs, 1)
require.Equal(t, checker.ApiChange{
Id: checker.NewRequiredRequestPropertyWithDefaultId,
Args: []any{"description"},
Level: checker.INFO,
Operation: "POST",
Path: "/products",
Source: load.NewSource("../data/checker/request_property_added_with_default.yaml"),
OperationId: "addProduct",
}, errs[0])
}