forked from oasdiff/oasdiff
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcheck_api_operation_id_updated_test.go
86 lines (73 loc) · 3.22 KB
/
check_api_operation_id_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
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: removing an existing operation id
func TestOperationIdRemoved(t *testing.T) {
s1, err := open("../data/checker/operation_id_removed_base.yaml")
require.NoError(t, err)
s2, err := open("../data/checker/operation_id_removed_base.yaml")
require.NoError(t, err)
s2.Spec.Paths.Value("/api/v1.0/groups").Post.OperationID = ""
d, osm, err := diff.GetWithOperationsSourcesMap(diff.NewConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibilityUntilLevel(singleCheckConfig(checker.APIOperationIdUpdatedCheck), d, osm, checker.INFO)
require.Len(t, errs, 1)
require.Equal(t, checker.ApiChange{
Id: checker.APIOperationIdRemovedId,
Args: []any{"createOneGroup", ""},
Level: checker.INFO,
Operation: "POST",
Path: "/api/v1.0/groups",
Source: load.NewSource("../data/checker/operation_id_removed_base.yaml"),
OperationId: "createOneGroup",
}, errs[0])
}
// CL: updating an existing operation id
func TestOperationIdUpdated(t *testing.T) {
s1, err := open("../data/checker/operation_id_removed_base.yaml")
require.NoError(t, err)
s2, err := open("../data/checker/operation_id_removed_base.yaml")
require.NoError(t, err)
s2.Spec.Paths.Value("/api/v1.0/groups").Post.OperationID = "newOperationId"
d, osm, err := diff.GetWithOperationsSourcesMap(diff.NewConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibilityUntilLevel(singleCheckConfig(checker.APIOperationIdUpdatedCheck), d, osm, checker.INFO)
require.Len(t, errs, 1)
require.Equal(t, checker.ApiChange{
Id: checker.APIOperationIdRemovedId,
Args: []any{"createOneGroup", "newOperationId"},
Level: checker.INFO,
Operation: "POST",
Path: "/api/v1.0/groups",
Source: load.NewSource("../data/checker/operation_id_removed_base.yaml"),
OperationId: "createOneGroup",
}, errs[0])
require.Equal(t, "api operation id 'createOneGroup' removed and replaced with 'newOperationId'", errs[0].GetUncolorizedText(checker.NewDefaultLocalizer()))
}
// CL: adding a new operation id
func TestOperationIdAdded(t *testing.T) {
s1, err := open("../data/checker/operation_id_added_base.yaml")
require.NoError(t, err)
s2, err := open("../data/checker/operation_id_added_base.yaml")
require.NoError(t, err)
s2.Spec.Paths.Value("/api/v1.0/groups").Post.OperationID = "NewOperationId"
d, osm, err := diff.GetWithOperationsSourcesMap(diff.NewConfig(), s1, s2)
require.NoError(t, err)
errs := checker.CheckBackwardCompatibilityUntilLevel(singleCheckConfig(checker.APIOperationIdUpdatedCheck), d, osm, checker.INFO)
require.Len(t, errs, 1)
require.Equal(t, checker.ApiChange{
Id: checker.APIOperationIdAddId,
Args: []any{"NewOperationId"},
Level: checker.INFO,
Operation: "POST",
Path: "/api/v1.0/groups",
Source: load.NewSource("../data/checker/operation_id_added_base.yaml"),
OperationId: "NewOperationId",
}, errs[0])
require.Equal(t, "api operation id 'NewOperationId' was added", errs[0].GetUncolorizedText(checker.NewDefaultLocalizer()))
}