-
Notifications
You must be signed in to change notification settings - Fork 98
/
main.go
187 lines (170 loc) · 4.74 KB
/
main.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
/*
Copyright 2022 The Numaproj 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 main
import (
"encoding/json"
"log"
"os"
"strings"
"k8s.io/kube-openapi/pkg/common"
"k8s.io/kube-openapi/pkg/validation/spec"
dfv1 "github.com/numaproj/numaflow/pkg/apis/numaflow/v1alpha1"
)
type (
obj = map[string]interface{}
)
// Generate OpenAPI spec definitions for Workflow Resource
func main() {
if len(os.Args) <= 3 {
log.Fatal("Supply a version")
}
log.Println(os.Args)
version := os.Args[1]
kubeSwaggerPath := os.Args[2]
output := os.Args[3]
if version != "latest" && !strings.HasPrefix(version, "v") {
version = "v" + version
}
referenceCallback := func(name string) spec.Ref {
return spec.MustCreateRef("#/definitions/" + common.EscapeJsonPointer(swaggify(name)))
}
defs := spec.Definitions{}
dependencies := []string{}
for defName, val := range dfv1.GetOpenAPIDefinitions(referenceCallback) {
defs[swaggify(defName)] = val.Schema
dependencies = append(dependencies, val.Dependencies...)
}
k8sDefinitions := getKubernetesSwagger(kubeSwaggerPath)
for _, dep := range dependencies {
if !strings.Contains(dep, "k8s.io") {
continue
}
d := swaggify(dep)
if kd, ok := k8sDefinitions[d]; ok {
defs[d] = kd
}
}
for d, s := range k8sDefinitions {
defs[d] = s
}
swagger := &spec.Swagger{
SwaggerProps: spec.SwaggerProps{
Swagger: "2.0",
Definitions: defs,
Paths: &spec.Paths{Paths: map[string]spec.PathItem{}},
Info: &spec.Info{
InfoProps: spec.InfoProps{
Title: "Numaflow",
Version: version,
},
},
},
}
jsonBytes, err := json.MarshalIndent(swagger, "", " ")
if err != nil {
log.Fatal(err.Error())
}
err = os.WriteFile(output, jsonBytes, 0644)
if err != nil {
panic(err)
}
f, err := os.Open(output)
if err != nil {
panic(err)
}
// filter out "default" fields from swagger definitions properties because they are being set to empty strings and it makes the swagger validation fail.
swaggerObj := obj{}
err = json.NewDecoder(f).Decode(&swaggerObj)
if err != nil {
panic(err)
}
definitions := swaggerObj["definitions"].(obj)
for _, d := range definitions {
props, ok := d.(obj)["properties"].(obj)
if ok {
for _, prop := range props {
prop := prop.(obj)
delete(prop, "default")
items, ok := prop["items"].(obj)
if ok {
delete(items, "default")
}
additionalProperties, ok := prop["additionalProperties"].(obj)
if ok {
delete(additionalProperties, "default")
}
}
}
props, ok = d.(obj)["additionalProperties"].(obj)
if ok {
delete(props, "default")
}
}
f, err = os.Create(output)
if err != nil {
panic(err)
}
e := json.NewEncoder(f)
e.SetIndent("", " ")
err = e.Encode(swaggerObj)
if err != nil {
panic(err)
}
err = f.Close()
if err != nil {
panic(err)
}
}
// swaggify converts the github package
// e.g.:
// github.com/numaproj/numaflow/pkg/apis/numaflow/v1alpha1/Pipeline
// to:
// io.numaproj.numaflow.v1alpha1.Pipeline
func swaggify(name string) string {
name = strings.ReplaceAll(name, "github.com/numaproj/numaflow/pkg/apis/numaflow", "numaflow.numaproj.io")
parts := strings.Split(name, "/")
hostParts := strings.Split(parts[0], ".")
// reverses something like k8s.io to io.k8s
for i, j := 0, len(hostParts)-1; i < j; i, j = i+1, j-1 {
hostParts[i], hostParts[j] = hostParts[j], hostParts[i]
}
parts[0] = strings.Join(hostParts, ".")
return strings.Join(parts, ".")
}
func getKubernetesSwagger(kubeSwaggerPath string) spec.Definitions {
data, err := os.ReadFile(kubeSwaggerPath)
if err != nil {
panic(err)
}
swagger := &spec.Swagger{}
err = json.Unmarshal(data, swagger)
if err != nil {
panic(err)
}
result := swagger.Definitions
for k, v := range missingMachinerySwagger() {
result[k] = v
}
return result
}
// missingMachinerySwagger generates missing definitions from k8s
func missingMachinerySwagger() spec.Definitions {
r := make(map[string]spec.Schema)
r["io.k8s.apimachinery.pkg.apis.meta.v1.Duration"] = spec.Schema{
SchemaProps: spec.SchemaProps{
Type: spec.StringOrArray{"string"},
Description: "Duration is a wrapper around time.Duration which supports correct marshaling to YAML and JSON. In particular, it marshals into strings, which can be used as map keys in json.",
},
}
return r
}