forked from Jonathan-Rosenberg/oasdiff
-
Notifications
You must be signed in to change notification settings - Fork 1
/
check-request-property-write-only-read-only_test.go
209 lines (175 loc) · 9.25 KB
/
check-request-property-write-only-read-only_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
package checker_test
import (
"testing"
"github.com/stretchr/testify/require"
"github.com/treeverse/oasdiff/checker"
"github.com/treeverse/oasdiff/diff"
)
// CL: changing optional request property to write-only
func TestRequestOptionalPropertyBecameWriteOnly(t *testing.T) {
s1, err := open("../data/checker/request_optional_property_write_only_read_only_base.yaml")
require.NoError(t, err)
s2, err := open("../data/checker/request_optional_property_write_only_read_only_base.yaml")
require.NoError(t, err)
s2.Spec.Paths["/api/v1.0/groups"].Post.RequestBody.Value.Content["application/json"].Schema.Value.Properties["name"].Value.WriteOnly = true
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibilityUntilLevel(singleCheckConfig(checker.RequestPropertyWriteOnlyReadOnlyCheck), d, osm, checker.INFO)
require.Len(t, errs, 1)
require.Equal(t, checker.ApiChange{
Id: "request-optional-property-became-write-only",
Text: "the request optional property 'name' became write-only",
Operation: "POST",
Path: "/api/v1.0/groups",
Level: checker.INFO,
Source: "../data/checker/request_optional_property_write_only_read_only_base.yaml",
OperationId: "createOneGroup",
}, errs[0])
}
// CL: changing optional request property to not write-only
func TestRequestOptionalPropertyBecameNotWriteOnly(t *testing.T) {
s1, err := open("../data/checker/request_optional_property_write_only_read_only_base.yaml")
require.NoError(t, err)
s2, err := open("../data/checker/request_optional_property_write_only_read_only_base.yaml")
require.NoError(t, err)
s1.Spec.Paths["/api/v1.0/groups"].Post.RequestBody.Value.Content["application/json"].Schema.Value.Properties["name"].Value.WriteOnly = true
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibilityUntilLevel(singleCheckConfig(checker.RequestPropertyWriteOnlyReadOnlyCheck), d, osm, checker.INFO)
require.Len(t, errs, 1)
require.Equal(t, checker.ApiChange{
Id: "request-optional-property-became-not-write-only",
Text: "the request optional property 'name' became not write-only",
Level: checker.INFO,
Operation: "POST",
Path: "/api/v1.0/groups",
Source: "../data/checker/request_optional_property_write_only_read_only_base.yaml",
OperationId: "createOneGroup",
}, errs[0])
}
// CL: changing optional request property to read-only
func TestRequestOptionalPropertyBecameReadOnly(t *testing.T) {
s1, err := open("../data/checker/request_optional_property_write_only_read_only_base.yaml")
require.NoError(t, err)
s2, err := open("../data/checker/request_optional_property_write_only_read_only_base.yaml")
require.NoError(t, err)
s2.Spec.Paths["/api/v1.0/groups"].Post.RequestBody.Value.Content["application/json"].Schema.Value.Properties["name"].Value.ReadOnly = true
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibilityUntilLevel(singleCheckConfig(checker.RequestPropertyWriteOnlyReadOnlyCheck), d, osm, checker.INFO)
require.Len(t, errs, 1)
require.Equal(t, checker.ApiChange{
Id: "request-optional-property-became-read-only",
Text: "the request optional property 'name' became read-only",
Level: checker.INFO,
Operation: "POST",
Path: "/api/v1.0/groups",
Source: "../data/checker/request_optional_property_write_only_read_only_base.yaml",
OperationId: "createOneGroup",
}, errs[0])
}
// CL: changing optional request property to not read-only
func TestRequestOptionalPropertyBecameNonReadOnly(t *testing.T) {
s1, err := open("../data/checker/request_optional_property_write_only_read_only_base.yaml")
require.NoError(t, err)
s2, err := open("../data/checker/request_optional_property_write_only_read_only_base.yaml")
require.NoError(t, err)
s1.Spec.Paths["/api/v1.0/groups"].Post.RequestBody.Value.Content["application/json"].Schema.Value.Properties["name"].Value.ReadOnly = true
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibilityUntilLevel(singleCheckConfig(checker.RequestPropertyWriteOnlyReadOnlyCheck), d, osm, checker.INFO)
require.Len(t, errs, 1)
require.Equal(t, checker.ApiChange{
Id: "request-optional-property-became-not-read-only",
Text: "the request optional property 'name' became not read-only",
Level: checker.INFO,
Operation: "POST",
Path: "/api/v1.0/groups",
Source: "../data/checker/request_optional_property_write_only_read_only_base.yaml",
OperationId: "createOneGroup",
}, errs[0])
}
// CL: changing required request property to write-only
func TestRequestRequiredPropertyBecameWriteOnly(t *testing.T) {
s1, err := open("../data/checker/request_optional_property_write_only_read_only_base.yaml")
require.NoError(t, err)
s2, err := open("../data/checker/request_optional_property_write_only_read_only_base.yaml")
require.NoError(t, err)
s2.Spec.Paths["/api/v1.0/groups"].Post.RequestBody.Value.Content["application/json"].Schema.Value.Properties["id"].Value.WriteOnly = true
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibilityUntilLevel(singleCheckConfig(checker.RequestPropertyWriteOnlyReadOnlyCheck), d, osm, checker.INFO)
require.Len(t, errs, 1)
require.Equal(t, checker.ApiChange{
Id: "request-required-property-became-write-only",
Text: "the request required property 'id' became write-only",
Operation: "POST",
Path: "/api/v1.0/groups",
Level: checker.INFO,
Source: "../data/checker/request_optional_property_write_only_read_only_base.yaml",
OperationId: "createOneGroup",
}, errs[0])
}
// CL: changing required request property to not write-only
func TestRequestRequiredPropertyBecameNotWriteOnly(t *testing.T) {
s1, err := open("../data/checker/request_optional_property_write_only_read_only_base.yaml")
require.NoError(t, err)
s2, err := open("../data/checker/request_optional_property_write_only_read_only_base.yaml")
require.NoError(t, err)
s1.Spec.Paths["/api/v1.0/groups"].Post.RequestBody.Value.Content["application/json"].Schema.Value.Properties["id"].Value.WriteOnly = true
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibilityUntilLevel(singleCheckConfig(checker.RequestPropertyWriteOnlyReadOnlyCheck), d, osm, checker.INFO)
require.Len(t, errs, 1)
require.Equal(t, checker.ApiChange{
Id: "request-required-property-became-not-write-only",
Text: "the request required property 'id' became not write-only",
Level: checker.INFO,
Operation: "POST",
Path: "/api/v1.0/groups",
Source: "../data/checker/request_optional_property_write_only_read_only_base.yaml",
OperationId: "createOneGroup",
}, errs[0])
}
// CL: changing required request property to read-only
func TestRequestRequiredPropertyBecameReadOnly(t *testing.T) {
s1, err := open("../data/checker/request_optional_property_write_only_read_only_base.yaml")
require.NoError(t, err)
s2, err := open("../data/checker/request_optional_property_write_only_read_only_base.yaml")
require.NoError(t, err)
s2.Spec.Paths["/api/v1.0/groups"].Post.RequestBody.Value.Content["application/json"].Schema.Value.Properties["id"].Value.ReadOnly = true
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibilityUntilLevel(singleCheckConfig(checker.RequestPropertyWriteOnlyReadOnlyCheck), d, osm, checker.INFO)
require.Len(t, errs, 1)
require.Equal(t, checker.ApiChange{
Id: "request-required-property-became-read-only",
Text: "the request required property 'id' became read-only",
Level: checker.INFO,
Operation: "POST",
Path: "/api/v1.0/groups",
Source: "../data/checker/request_optional_property_write_only_read_only_base.yaml",
OperationId: "createOneGroup",
}, errs[0])
}
// CL: changing required request property to not read-only
func TestRequestRequiredPropertyBecameNonReadOnly(t *testing.T) {
s1, err := open("../data/checker/request_optional_property_write_only_read_only_base.yaml")
require.NoError(t, err)
s2, err := open("../data/checker/request_optional_property_write_only_read_only_base.yaml")
require.NoError(t, err)
s1.Spec.Paths["/api/v1.0/groups"].Post.RequestBody.Value.Content["application/json"].Schema.Value.Properties["id"].Value.ReadOnly = true
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibilityUntilLevel(singleCheckConfig(checker.RequestPropertyWriteOnlyReadOnlyCheck), d, osm, checker.INFO)
require.Len(t, errs, 1)
require.Equal(t, checker.ApiChange{
Id: "request-required-property-became-not-read-only",
Text: "the request required property 'id' became not read-only",
Level: checker.INFO,
Operation: "POST",
Path: "/api/v1.0/groups",
Source: "../data/checker/request_optional_property_write_only_read_only_base.yaml",
OperationId: "createOneGroup",
}, errs[0])
}