forked from hashicorp/terraform-provider-google
-
Notifications
You must be signed in to change notification settings - Fork 0
/
schemagen.go
311 lines (270 loc) · 8.46 KB
/
schemagen.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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
// Generates an initial version of a schema for a new resource type.
//
// This script draws heavily from https://github.com/radeksimko/terraform-gen,
// but uses GCP's discovery API instead of the struct definition to generate
// the schemas.
//
// This is not meant to be a definitive source of truth for resource schemas,
// just a starting point. It has some notable deficiencies, such as:
// * No way to differentiate between fields that are/are not updateable.
// * Required/Optional/Computed are set based on keywords in the description.
//
// Usage requires credentials. Obtain via gcloud:
//
// gcloud auth application-default login
//
// Usage example (from root dir):
//
// go run ./scripts/schemagen.go -api pubsub -resource Subscription -version v1
//
// This will output a file in the directory from which the script is run named `gen_resource_[api]_[resource].go`.
package main
import (
"bytes"
"flag"
"fmt"
"go/format"
"log"
"os"
"regexp"
"sort"
"strings"
"text/template"
"github.com/hashicorp/terraform/helper/schema"
"golang.org/x/oauth2"
"golang.org/x/oauth2/google"
"google.golang.org/api/discovery/v1"
)
func main() {
api := flag.String("api", "", "api to query")
resource := flag.String("resource", "", "resource to generate")
version := flag.String("version", "v1", "api version to query")
flag.Parse()
if *api == "" || *resource == "" {
flag.PrintDefaults()
log.Fatal("usage: go run schemagen.go -api $API -resource $RESOURCE -version $VERSION")
}
// Discovery API doesn't need authentication
client, err := google.DefaultClient(oauth2.NoContext, []string{}...)
if err != nil {
log.Fatal(fmt.Errorf("Error creating client: %v", err))
}
discoveryService, err := discovery.New(client)
if err != nil {
log.Fatal(fmt.Errorf("Error creating service: %v", err))
}
resp, err := discoveryService.Apis.GetRest(*api, *version).Fields("schemas").Do()
if err != nil {
log.Fatal(fmt.Errorf("Error reading API: %v", err))
}
fileName := fmt.Sprintf("gen_resource_%s_%s.go", *api, underscore(*resource))
f, err := os.Create(fileName)
defer f.Close()
if err != nil {
log.Fatal(err)
}
required, optional, computed := generateFields(resp.Schemas, *resource)
buf := &bytes.Buffer{}
err = googleTemplate.Execute(buf, struct {
TypeName string
ReqFields map[string]string
OptFields map[string]string
ComFields map[string]string
}{
// Capitalize the first letter of the api name, then concatenate the resource name onto it.
// e.g. compute, instance -> ComputeInstance
TypeName: strings.ToUpper((*api)[0:1]) + (*api)[1:] + *resource,
ReqFields: required,
OptFields: optional,
ComFields: computed,
})
if err != nil {
log.Fatal(err)
}
fmtd, err := format.Source(buf.Bytes())
if err != nil {
log.Printf("Formatting error: %s", err)
}
if _, err := f.Write(fmtd); err != nil {
log.Fatal(err)
}
}
func generateFields(jsonSchemas map[string]discovery.JsonSchema, property string) (required, optional, computed map[string]string) {
required = make(map[string]string, 0)
optional = make(map[string]string, 0)
computed = make(map[string]string, 0)
for k, v := range jsonSchemas[property].Properties {
content, err := generateField(jsonSchemas, k, v, false)
if err != nil {
log.Printf("ERROR: %s", err)
} else {
if strings.Contains(content, "Required:") {
required[underscore(k)] = content
} else if strings.Contains(content, "Optional:") {
optional[underscore(k)] = content
} else if strings.Contains(content, "Computed:") {
computed[underscore(k)] = content
} else {
log.Println("ERROR: Found property that is neither required, optional, nor computed")
}
}
}
return
}
func generateField(jsonSchemas map[string]discovery.JsonSchema, field string, v discovery.JsonSchema, isNested bool) (string, error) {
s := &schema.Schema{
Description: v.Description,
}
if field != "" {
setProperties(v, s)
}
// JSON field types: https://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.1
switch v.Type {
case "integer":
s.Type = schema.TypeInt
case "number":
s.Type = schema.TypeFloat
case "string":
s.Type = schema.TypeString
case "boolean":
s.Type = schema.TypeBool
case "array":
s.Type = schema.TypeList
elem, err := generateField(jsonSchemas, "", *v.Items, true)
if err != nil {
return "", fmt.Errorf("Unable to generate Elem for %q: %s", field, err)
}
s.Elem = elem
case "object":
s.Type = schema.TypeMap
case "":
s.Type = schema.TypeList
s.MaxItems = 1
elem := "&schema.Resource{\nSchema: map[string]*schema.Schema{\n"
required, optional, computed := generateFields(jsonSchemas, v.Ref)
elem += generateNestedElem(required)
elem += generateNestedElem(optional)
elem += generateNestedElem(computed)
elem += "},\n}"
if isNested {
return elem, nil
}
s.Elem = elem
default:
return "", fmt.Errorf("Unable to process: %s %s", field, v.Type)
}
return schemaCode(s, isNested)
}
func setProperties(v discovery.JsonSchema, s *schema.Schema) {
if v.ReadOnly || strings.HasPrefix(v.Description, "Output-only") || strings.HasPrefix(v.Description, "[Output Only]") {
s.Computed = true
} else {
if v.Required || strings.HasPrefix(v.Description, "Required") {
s.Required = true
} else {
s.Optional = true
}
}
s.ForceNew = true
}
func generateNestedElem(fields map[string]string) (elem string) {
fieldNames := []string{}
for k, _ := range fields {
fieldNames = append(fieldNames, k)
}
sort.Strings(fieldNames)
for _, k := range fieldNames {
elem += fmt.Sprintf("%q: %s,\n", k, fields[k])
}
return
}
func schemaCode(s *schema.Schema, isNested bool) (string, error) {
buf := bytes.NewBuffer([]byte{})
err := schemaTemplate.Execute(buf, struct {
Schema *schema.Schema
IsNested bool
}{
Schema: s,
IsNested: isNested,
})
if err != nil {
return "", err
}
return buf.String(), nil
}
// go version of https://stackoverflow.com/questions/1175208/elegant-python-function-to-convert-camelcase-to-snake-case,
// with some extra logic around ending in 's' to handle the "externalIPs" case.
func underscore(name string) string {
endsInS := strings.HasSuffix(name, "s")
if endsInS {
name = strings.TrimSuffix(name, "s")
}
firstCap := regexp.MustCompile("(.)([A-Z][a-z]+)").ReplaceAllString(name, "${1}_${2}")
allCap := regexp.MustCompile("([a-z0-9])([A-Z])").ReplaceAllString(firstCap, "${1}_${2}")
if endsInS {
allCap = allCap + "s"
}
return strings.ToLower(allCap)
}
var schemaTemplate = template.Must(template.New("schema").Parse(`{{if .IsNested}}&schema.Schema{{end}}{{"{"}}{{if not .IsNested}}
{{end}}Type: schema.{{.Schema.Type}},{{if ne .Schema.Description ""}}
Description: {{printf "%q" .Schema.Description}},{{end}}{{if .Schema.Required}}
Required: {{.Schema.Required}},{{end}}{{if .Schema.Optional}}
Optional: {{.Schema.Optional}},{{end}}{{if .Schema.ForceNew}}
ForceNew: {{.Schema.ForceNew}},{{end}}{{if .Schema.Computed}}
Computed: {{.Schema.Computed}},{{end}}{{if gt .Schema.MaxItems 0}}
MaxItems: {{.Schema.MaxItems}},{{end}}{{if .Schema.Elem}}
Elem: {{.Schema.Elem}},{{end}}{{if not .IsNested}}
{{end}}{{"}"}}`))
var googleTemplate = template.Must(template.New("google").Parse(`package google
import(
"github.com/hashicorp/terraform/helper/schema"
)
func resource{{.TypeName}}() *schema.Resource {
return &schema.Resource{
Create: resource{{.TypeName}}Create,
Read: resource{{.TypeName}}Read,
Update: resource{{.TypeName}}Update,
Delete: resource{{.TypeName}}Delete,
Importer: &schema.ResourceImporter{
State: schema.ImportStatePassthrough,
},
Schema: map[string]*schema.Schema{ {{range $name, $schema := .ReqFields}}
"{{ $name }}": {{ $schema }},
{{end}}{{range $name, $schema := .OptFields}}
"{{ $name }}": {{ $schema }},
{{end}}{{range $name, $schema := .ComFields}}
"{{ $name }}": {{ $schema }},
{{end}}
},
}
}
func resource{{.TypeName}}Create(d *schema.ResourceData, meta interface{}) error {
config := meta.(*Config)
project, err := getProject(d, config)
if err != nil {
return err
}
}
func resource{{.TypeName}}Read(d *schema.ResourceData, meta interface{}) error {
config := meta.(*Config)
project, err := getProject(d, config)
if err != nil {
return err
}
}
func resource{{.TypeName}}Update(d *schema.ResourceData, meta interface{}) error {
config := meta.(*Config)
project, err := getProject(d, config)
if err != nil {
return err
}
}
func resource{{.TypeName}}Delete(d *schema.ResourceData, meta interface{}) error {
config := meta.(*Config)
project, err := getProject(d, config)
if err != nil {
return err
}
}
`))