File: testutil.go

package info (click to toggle)
golang-k8s-kube-openapi 0.0~git20241212.2c72e55-2
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 23,396 kB
  • sloc: sh: 50; makefile: 5
file content (164 lines) | stat: -rw-r--r-- 5,193 bytes parent folder | download
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
/*
Copyright 2021 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 testutil

import (
	"fmt"
	"strings"

	"github.com/emicklei/go-restful/v3"
	"k8s.io/kube-openapi/pkg/common"
	"k8s.io/kube-openapi/pkg/spec3"
	"k8s.io/kube-openapi/pkg/util"
	"k8s.io/kube-openapi/pkg/validation/spec"
)

// CreateOpenAPIBuilderConfig hard-codes some values in the API builder
// config for testing.
func CreateOpenAPIBuilderConfig() *common.Config {
	return &common.Config{
		ProtocolList:   []string{"https"},
		IgnorePrefixes: []string{"/swaggerapi"},
		Info: &spec.Info{
			InfoProps: spec.InfoProps{
				Title:   "Integration Test",
				Version: "1.0",
			},
		},
		ResponseDefinitions: map[string]spec.Response{
			"NotFound": {
				ResponseProps: spec.ResponseProps{
					Description: "Entity not found.",
				},
			},
		},
		CommonResponses: map[int]spec.Response{
			404: *spec.ResponseRef("#/responses/NotFound"),
		},
	}
}

func CreateOpenAPIV3BuilderConfig() *common.OpenAPIV3Config {
	return &common.OpenAPIV3Config{
		IgnorePrefixes: []string{"/swaggerapi"},
		Info: &spec.Info{
			InfoProps: spec.InfoProps{
				Title:   "Integration Test",
				Version: "1.0",
			},
		},
		ResponseDefinitions: map[string]*spec3.Response{
			"NotFound": {
				ResponseProps: spec3.ResponseProps{
					Description: "Entity not found.",
				},
			},
		},
		CommonResponses: map[int]*spec3.Response{
			404: {
				Refable: spec.Refable{Ref: spec.MustCreateRef("#/components/responses/NotFound")},
			},
		},
	}

}

// CreateWebServices hard-codes a simple WebService which only defines a GET and POST paths
// for testing.
func CreateWebServices(includeV2SchemaAnnotation bool) []*restful.WebService {
	w := new(restful.WebService)
	addRoutes(w, buildRouteForType(w, "dummytype", "Foo")...)
	addRoutes(w, buildRouteForType(w, "dummytype", "Bar")...)
	addRoutes(w, buildRouteForType(w, "dummytype", "Baz")...)
	addRoutes(w, buildRouteForType(w, "dummytype", "Waldo")...)
	addRoutes(w, buildRouteForType(w, "listtype", "AtomicList")...)
	addRoutes(w, buildRouteForType(w, "listtype", "MapList")...)
	addRoutes(w, buildRouteForType(w, "listtype", "SetList")...)
	addRoutes(w, buildRouteForType(w, "uniontype", "TopLevelUnion")...)
	addRoutes(w, buildRouteForType(w, "uniontype", "InlinedUnion")...)
	addRoutes(w, buildRouteForType(w, "custom", "Bal")...)
	addRoutes(w, buildRouteForType(w, "custom", "Bak")...)
	if includeV2SchemaAnnotation {
		addRoutes(w, buildRouteForType(w, "custom", "Bac")...)
		addRoutes(w, buildRouteForType(w, "custom", "Bah")...)
		addRoutes(w, buildRouteForType(w, "valuevalidation", "Foo2")...)
		addRoutes(w, buildRouteForType(w, "valuevalidation", "Foo3")...)
		addRoutes(w, buildRouteForType(w, "valuevalidation", "Foo4")...)
		addRoutes(w, buildRouteForType(w, "valuevalidation", "Foo5")...)
	}
	addRoutes(w, buildRouteForType(w, "maptype", "GranularMap")...)
	addRoutes(w, buildRouteForType(w, "maptype", "AtomicMap")...)
	addRoutes(w, buildRouteForType(w, "structtype", "GranularStruct")...)
	addRoutes(w, buildRouteForType(w, "structtype", "FieldLevelOverrideStruct")...)
	addRoutes(w, buildRouteForType(w, "structtype", "AtomicStruct")...)
	addRoutes(w, buildRouteForType(w, "structtype", "DeclaredAtomicStruct")...)
	addRoutes(w, buildRouteForType(w, "defaults", "Defaulted")...)
	addRoutes(w, buildRouteForType(w, "valuevalidation", "Foo")...)
	return []*restful.WebService{w}
}

func addRoutes(ws *restful.WebService, routes ...*restful.RouteBuilder) {
	for _, r := range routes {
		ws.Route(r)
	}
}

// Implements OpenAPICanonicalTypeNamer
var _ = util.OpenAPICanonicalTypeNamer(&typeNamer{})

type typeNamer struct {
	pkg  string
	name string
}

func (t *typeNamer) OpenAPICanonicalTypeName() string {
	return fmt.Sprintf("k8s.io/kube-openapi/test/integration/testdata/%s.%s", t.pkg, t.name)
}

func buildRouteForType(ws *restful.WebService, pkg, name string) []*restful.RouteBuilder {
	namer := typeNamer{
		pkg:  pkg,
		name: name,
	}

	routes := []*restful.RouteBuilder{
		ws.GET(fmt.Sprintf("/test/%s/%s", pkg, strings.ToLower(name))).
			Operation(fmt.Sprintf("get-%s.%s", pkg, name)).
			Produces("application/json").
			To(func(*restful.Request, *restful.Response) {}).
			Writes(&namer),
		ws.POST(fmt.Sprintf("/test/%s", pkg)).
			Operation(fmt.Sprintf("create-%s.%s", pkg, name)).
			Produces("application/json").
			To(func(*restful.Request, *restful.Response) {}).
			Returns(201, "Created", &namer).
			Writes(&namer),
	}

	if pkg == "dummytype" {
		statusErrType := typeNamer{
			pkg:  "dummytype",
			name: "StatusError",
		}

		for _, route := range routes {
			route.Returns(500, "Internal Service Error", &statusErrType)
		}
	}

	return routes
}