forked from Jonathan-Rosenberg/oasdiff
-
Notifications
You must be signed in to change notification settings - Fork 1
/
check-response-required-property-updated_test.go
108 lines (95 loc) · 4.67 KB
/
check-response-required-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
package checker_test
import (
"testing"
"github.com/stretchr/testify/require"
"github.com/treeverse/oasdiff/checker"
"github.com/treeverse/oasdiff/diff"
)
// CL: adding a required property to response body is detected
func TestResponseRequiredPropertyAdded(t *testing.T) {
s1, err := open("../data/checker/response_required_property_added_base.yaml")
require.NoError(t, err)
s2, err := open("../data/checker/response_required_property_added_revision.yaml")
require.NoError(t, err)
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibilityUntilLevel(singleCheckConfig(checker.ResponseRequiredPropertyUpdatedCheck), d, osm, checker.INFO)
require.Len(t, errs, 1)
require.Equal(t, checker.ApiChange{
Id: "response-required-property-added",
Text: "added the required property 'data/new' to the response with the '200' status",
Comment: "",
Level: checker.INFO,
Operation: "POST",
Path: "/api/v1.0/groups",
Source: "../data/checker/response_required_property_added_revision.yaml",
OperationId: "createOneGroup",
}, errs[0])
}
// CL: removing an existent property that was required in response body is detected
func TestResponseRequiredPropertyRemoved(t *testing.T) {
s1, err := open("../data/checker/response_required_property_added_revision.yaml")
require.NoError(t, err)
s2, err := open("../data/checker/response_required_property_added_base.yaml")
require.NoError(t, err)
s2.Spec.Components.Schemas["GroupView"].Value.Properties["data"].Value.Required = []string{"name", "id"}
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibilityUntilLevel(singleCheckConfig(checker.ResponseRequiredPropertyUpdatedCheck), d, osm, checker.INFO)
require.Len(t, errs, 1)
require.Equal(t, checker.ApiChange{
Id: "response-required-property-removed",
Text: "removed the required property 'data/new' from the response with the '200' status",
Comment: "",
Level: checker.ERR,
Operation: "POST",
Path: "/api/v1.0/groups",
Source: "../data/checker/response_required_property_added_base.yaml",
OperationId: "createOneGroup",
}, errs[0])
}
// CL: adding a required write-only property to response body is detected
func TestResponseRequiredWriteOnlyPropertyAdded(t *testing.T) {
s1, err := open("../data/checker/response_required_property_added_base.yaml")
require.NoError(t, err)
s2, err := open("../data/checker/response_required_property_added_revision.yaml")
require.NoError(t, err)
s2.Spec.Components.Schemas["GroupView"].Value.Properties["data"].Value.Properties["new"].Value.WriteOnly = true
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibilityUntilLevel(singleCheckConfig(checker.ResponseRequiredPropertyUpdatedCheck), d, osm, checker.INFO)
require.Len(t, errs, 1)
require.Equal(t, checker.ApiChange{
Id: "response-required-write-only-property-added",
Text: "added the required write-only property 'data/new' to the response with the '200' status",
Comment: "",
Level: checker.INFO,
Operation: "POST",
Path: "/api/v1.0/groups",
Source: "../data/checker/response_required_property_added_revision.yaml",
OperationId: "createOneGroup",
}, errs[0])
}
// CL: removing a required write-only property that was required in response body is detected
func TestResponseRequiredWriteOnlyPropertyRemoved(t *testing.T) {
s1, err := open("../data/checker/response_required_property_added_revision.yaml")
require.NoError(t, err)
s2, err := open("../data/checker/response_required_property_added_base.yaml")
require.NoError(t, err)
s1.Spec.Components.Schemas["GroupView"].Value.Properties["data"].Value.Properties["new"].Value.WriteOnly = true
s2.Spec.Components.Schemas["GroupView"].Value.Properties["data"].Value.Required = []string{"name", "id"}
d, osm, err := diff.GetWithOperationsSourcesMap(getConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibilityUntilLevel(singleCheckConfig(checker.ResponseRequiredPropertyUpdatedCheck), d, osm, checker.INFO)
require.Len(t, errs, 1)
require.Equal(t, checker.ApiChange{
Id: "response-required-write-only-property-removed",
Text: "removed the required write-only property 'data/new' from the response with the '200' status",
Comment: "",
Level: checker.INFO,
Operation: "POST",
Path: "/api/v1.0/groups",
Source: "../data/checker/response_required_property_added_base.yaml",
OperationId: "createOneGroup",
}, errs[0])
}