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
|
/*
Copyright 2017 The Kubernetes Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package schemaconv
import (
"os"
"path/filepath"
"testing"
"github.com/google/go-cmp/cmp"
yaml "sigs.k8s.io/yaml/goyaml.v2"
"k8s.io/kube-openapi/pkg/util/proto"
prototesting "k8s.io/kube-openapi/pkg/util/proto/testing"
)
func TestToSchema(t *testing.T) {
tests := []struct {
name string
openAPIFilename string
expectedSchemaFilename string
}{
{
name: "kubernetes",
openAPIFilename: "swagger.json",
expectedSchemaFilename: "new-schema.yaml",
},
{
name: "atomics",
openAPIFilename: "atomic-types.json",
expectedSchemaFilename: "atomic-types.yaml",
},
{
name: "defaults",
openAPIFilename: "defaults.json",
expectedSchemaFilename: "defaults.yaml",
},
{
name: "preserve-unknown",
openAPIFilename: "preserve-unknown.json",
expectedSchemaFilename: "preserve-unknown.yaml",
},
}
for _, tc := range tests {
t.Run(tc.name, func(t *testing.T) {
openAPIPath := filepath.Join("testdata", tc.openAPIFilename)
expectedNewSchemaPath := filepath.Join("testdata", tc.expectedSchemaFilename)
testToSchema(t, openAPIPath, expectedNewSchemaPath)
})
}
}
func testToSchema(t *testing.T, openAPIPath, expectedNewSchemaPath string) {
fakeSchema := prototesting.Fake{Path: openAPIPath}
s, err := fakeSchema.OpenAPISchema()
if err != nil {
t.Fatalf("failed to get schema for %s: %v", openAPIPath, err)
}
models, err := proto.NewOpenAPIData(s)
if err != nil {
t.Fatal(err)
}
ns, err := ToSchema(models)
if err != nil {
t.Fatal(err)
}
got, err := yaml.Marshal(ns)
if err != nil {
t.Fatal(err)
}
expect, err := os.ReadFile(expectedNewSchemaPath)
if err != nil {
t.Fatalf("Unable to read golden data file %q: %v", expectedNewSchemaPath, err)
}
if string(expect) != string(got) {
t.Errorf("Computed schema did not match %q.", expectedNewSchemaPath)
t.Logf("To recompute this file, run:\n\tgo run ./cmd/openapi2smd/openapi2smd.go < %q > %q",
filepath.Join("pkg", "schemaconv", openAPIPath),
filepath.Join("pkg", "schemaconv", expectedNewSchemaPath),
)
t.Log("You can then use `git diff` to see the changes.")
t.Error(cmp.Diff(string(expect), string(got)))
}
}
func TestFieldLevelAnnotation(t *testing.T) {
openAPIPath := filepath.Join("testdata", "field-level-annotation.json")
fakeSchema := prototesting.Fake{Path: openAPIPath}
s, err := fakeSchema.OpenAPISchema()
if err != nil {
t.Fatalf("failed to get schema for %s: %v", openAPIPath, err)
}
models, err := proto.NewOpenAPIData(s)
if err != nil {
t.Fatal(err)
}
ns, err := ToSchema(models)
if err != nil {
t.Fatal(err)
}
_ = ns
// Test to make sure that MapElementRelationship is populated correctly
// after being converted from proto type
endpointAddress, ok := ns.FindNamedType("io.k8s.api.core.v1.EndpointAddress")
if !ok {
t.Fatalf("expected to find EndpointAddress")
}
targetRef, ok := endpointAddress.FindField("targetRef")
if !ok {
t.Fatalf("expected to find EndpointAddress field 'targetRef'")
}
if targetRef.Type.ElementRelationship == nil {
t.Fatalf("expected targetRef MapElementRelationship to be atomic")
}
// Test to make sure that schema.Resolve overrides the ElementRelationship
// when asked to resolve a reference
resolved, ok := ns.Resolve(targetRef.Type)
if !ok {
t.Fatalf("failed to resolve targetRef type")
}
if resolved.Map == nil {
t.Fatalf("expected to resolve to a Map")
}
if resolved.Map.ElementRelationship != *targetRef.Type.ElementRelationship {
t.Fatalf("resolved element relationship not converted")
}
// Make sure our test is actually testing something by ensuring the original
// relationship is different from what we are changing it to.
targetRefWithoutRelationship := targetRef
targetRefWithoutRelationship.Type.ElementRelationship = nil
originalResolved, ok := ns.Resolve(targetRefWithoutRelationship.Type)
if !ok {
t.Fatalf("failed to resolve targetRef type")
}
if originalResolved.Map.ElementRelationship == *targetRef.Type.ElementRelationship {
t.Fatalf("expected original element relationship to differ from field-level override for test")
}
}
|
