forked from bflad/tfproviderlint
/
type_schema.go
397 lines (339 loc) · 11.7 KB
/
type_schema.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
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
package schema
import (
"go/ast"
"go/constant"
"go/types"
"github.com/bflad/tfproviderlint/helper/astutils"
)
const (
SchemaFieldAtLeastOneOf = `AtLeastOneOf`
SchemaFieldComputed = `Computed`
SchemaFieldComputedWhen = `ComputedWhen`
SchemaFieldConfigMode = `ConfigMode`
SchemaFieldConflictsWith = `ConflictsWith`
SchemaFieldDefault = `Default`
SchemaFieldDefaultFunc = `DefaultFunc`
SchemaFieldDeprecated = `Deprecated`
SchemaFieldDescription = `Description`
SchemaFieldDiffSuppressFunc = `DiffSuppressFunc`
SchemaFieldElem = `Elem`
SchemaFieldExactlyOneOf = `ExactlyOneOf`
SchemaFieldForceNew = `ForceNew`
SchemaFieldInputDefault = `InputDefault`
SchemaFieldMaxItems = `MaxItems`
SchemaFieldMinItems = `MinItems`
SchemaFieldOptional = `Optional`
SchemaFieldPromoteSingle = `PromoteSingle`
SchemaFieldRemoved = `Removed`
SchemaFieldRequired = `Required`
SchemaFieldSensitive = `Sensitive`
SchemaFieldSet = `Set`
SchemaFieldStateFunc = `StateFunc`
SchemaFieldType = `Type`
SchemaFieldValidateFunc = `ValidateFunc`
SchemaValueTypeBool = `TypeBool`
SchemaValueTypeFloat = `TypeFloat`
SchemaValueTypeInt = `TypeInt`
SchemaValueTypeList = `TypeList`
SchemaValueTypeMap = `TypeMap`
SchemaValueTypeSet = `TypeSet`
SchemaValueTypeString = `TypeString`
TypeNameSchema = `Schema`
TypeNameSet = `Set`
TypeNameValueType = `ValueType`
)
// schemaType is an internal representation of the SDK helper/schema.Schema type
//
// This is used to prevent importing the real type since the project supports
// multiple versions of the Terraform Plugin SDK, while allowing passes to
// access the data in a familiar manner.
type schemaType struct {
AtLeastOneOf []string
Computed bool
ConflictsWith []string
Default interface{}
DefaultFunc func() (interface{}, error)
DiffSuppressFunc func(string, string, string, interface{}) bool
Description string
Elem interface{}
ExactlyOneOf []string
ForceNew bool
InputDefault string
MaxItems int
MinItems int
Optional bool
PromoteSingle bool
Required bool
RequiredWith []string
Sensitive bool
StateFunc func(interface{}) string
Type valueType
ValidateFunc func(interface{}, string) ([]string, []error)
}
// ValueType is an internal representation of the SDK helper/schema.ValueType type
//
// This is used to prevent importing the real type since the project supports
// multiple versions of the Terraform Plugin SDK, while allowing passes to
// access the data in a familiar manner.
type valueType int
const (
typeInvalid valueType = iota
typeBool
typeInt
typeFloat
typeString
typeList
typeMap
typeSet
typeObject
)
// SchemaInfo represents all gathered Schema data for easier access
type SchemaInfo struct {
AstCompositeLit *ast.CompositeLit
Fields map[string]*ast.KeyValueExpr
Schema *schemaType
SchemaValueType string
TypesInfo *types.Info
}
// NewSchemaInfo instantiates a SchemaInfo
func NewSchemaInfo(cl *ast.CompositeLit, info *types.Info) *SchemaInfo {
result := &SchemaInfo{
AstCompositeLit: cl,
Fields: astutils.CompositeLitFields(cl),
Schema: &schemaType{},
SchemaValueType: typeSchemaType(cl, info),
TypesInfo: info,
}
if kvExpr := result.Fields[SchemaFieldType]; kvExpr != nil && astutils.ExprValue(kvExpr.Value) != nil {
result.Schema.Type = ValueType(kvExpr.Value, info)
}
if kvExpr := result.Fields[SchemaFieldAtLeastOneOf]; kvExpr != nil && astutils.ExprValue(kvExpr.Value) != nil {
result.Schema.AtLeastOneOf = []string{}
}
if kvExpr := result.Fields[SchemaFieldComputed]; kvExpr != nil && astutils.ExprBoolValue(kvExpr.Value) != nil {
result.Schema.Computed = *astutils.ExprBoolValue(kvExpr.Value)
}
if kvExpr := result.Fields[SchemaFieldConflictsWith]; kvExpr != nil && astutils.ExprValue(kvExpr.Value) != nil {
result.Schema.ConflictsWith = []string{}
}
if kvExpr := result.Fields[SchemaFieldDefault]; kvExpr != nil && astutils.ExprValue(kvExpr.Value) != nil {
switch result.Schema.Type {
case typeBool:
if ptr := astutils.ExprBoolValue(kvExpr.Value); ptr != nil {
result.Schema.Default = *ptr
}
case typeInt:
if ptr := astutils.ExprIntValue(kvExpr.Value); ptr != nil {
result.Schema.Default = *ptr
}
case typeString:
if ptr := astutils.ExprStringValue(kvExpr.Value); ptr != nil {
result.Schema.Default = *ptr
}
default:
result.Schema.Default = func() (interface{}, error) { return nil, nil }
}
}
if kvExpr := result.Fields[SchemaFieldDefaultFunc]; kvExpr != nil && astutils.ExprValue(kvExpr.Value) != nil {
result.Schema.DefaultFunc = func() (interface{}, error) { return nil, nil }
}
if kvExpr := result.Fields[SchemaFieldDescription]; kvExpr != nil && astutils.ExprStringValue(kvExpr.Value) != nil {
result.Schema.Description = *astutils.ExprStringValue(kvExpr.Value)
}
if kvExpr := result.Fields[SchemaFieldExactlyOneOf]; kvExpr != nil && astutils.ExprValue(kvExpr.Value) != nil {
result.Schema.ExactlyOneOf = []string{}
}
if kvExpr := result.Fields[SchemaFieldDiffSuppressFunc]; kvExpr != nil && astutils.ExprValue(kvExpr.Value) != nil {
result.Schema.DiffSuppressFunc = func(k, old, new string, d interface{}) bool { return false }
}
if kvExpr := result.Fields[SchemaFieldForceNew]; kvExpr != nil && astutils.ExprBoolValue(kvExpr.Value) != nil {
result.Schema.ForceNew = *astutils.ExprBoolValue(kvExpr.Value)
}
if kvExpr := result.Fields[SchemaFieldInputDefault]; kvExpr != nil && astutils.ExprStringValue(kvExpr.Value) != nil {
result.Schema.InputDefault = *astutils.ExprStringValue(kvExpr.Value)
}
if kvExpr := result.Fields[SchemaFieldMaxItems]; kvExpr != nil && astutils.ExprIntValue(kvExpr.Value) != nil {
result.Schema.MaxItems = *astutils.ExprIntValue(kvExpr.Value)
}
if kvExpr := result.Fields[SchemaFieldMinItems]; kvExpr != nil && astutils.ExprIntValue(kvExpr.Value) != nil {
result.Schema.MinItems = *astutils.ExprIntValue(kvExpr.Value)
}
if kvExpr := result.Fields[SchemaFieldOptional]; kvExpr != nil && astutils.ExprBoolValue(kvExpr.Value) != nil {
result.Schema.Optional = *astutils.ExprBoolValue(kvExpr.Value)
}
if kvExpr := result.Fields[SchemaFieldPromoteSingle]; kvExpr != nil && astutils.ExprBoolValue(kvExpr.Value) != nil {
result.Schema.PromoteSingle = *astutils.ExprBoolValue(kvExpr.Value)
}
if kvExpr := result.Fields[SchemaFieldRequired]; kvExpr != nil && astutils.ExprBoolValue(kvExpr.Value) != nil {
result.Schema.Required = *astutils.ExprBoolValue(kvExpr.Value)
}
if kvExpr := result.Fields[SchemaFieldSensitive]; kvExpr != nil && astutils.ExprBoolValue(kvExpr.Value) != nil {
result.Schema.Sensitive = *astutils.ExprBoolValue(kvExpr.Value)
}
if kvExpr := result.Fields[SchemaFieldStateFunc]; kvExpr != nil && astutils.ExprValue(kvExpr.Value) != nil {
result.Schema.StateFunc = func(interface{}) string { return "" }
}
if kvExpr := result.Fields[SchemaFieldValidateFunc]; kvExpr != nil && astutils.ExprValue(kvExpr.Value) != nil {
result.Schema.ValidateFunc = func(interface{}, string) ([]string, []error) { return nil, nil }
}
if kvExpr := result.Fields[SchemaFieldElem]; kvExpr != nil && astutils.ExprValue(kvExpr.Value) != nil {
if uexpr, ok := kvExpr.Value.(*ast.UnaryExpr); ok {
if cl, ok := uexpr.X.(*ast.CompositeLit); ok {
switch {
case IsTypeResource(info.TypeOf(cl.Type)):
resourceInfo := NewResourceInfo(cl, info)
result.Schema.Elem = resourceInfo.Resource
case IsTypeSchema(info.TypeOf(cl.Type)):
schemaInfo := NewSchemaInfo(cl, info)
result.Schema.Elem = schemaInfo.Schema
}
}
}
}
return result
}
// DeclaresField returns true if the field name is present in the AST
func (info *SchemaInfo) DeclaresField(fieldName string) bool {
return info.Fields[fieldName] != nil
}
// DeclaresBoolFieldWithZeroValue returns true if the field name is present and is false
func (info *SchemaInfo) DeclaresBoolFieldWithZeroValue(fieldName string) bool {
kvExpr := info.Fields[fieldName]
// Field not declared
if kvExpr == nil {
return false
}
valuePtr := astutils.ExprBoolValue(kvExpr.Value)
// Value not readable
if valuePtr == nil {
return false
}
return !*valuePtr
}
// IsType returns true if the given input is equal to the Type
func (info *SchemaInfo) IsType(valueType string) bool {
return info.SchemaValueType == valueType
}
// IsOneOfTypes returns true if one of the given input is equal to the Type
func (info *SchemaInfo) IsOneOfTypes(valueTypes ...string) bool {
for _, valueType := range valueTypes {
if info.SchemaValueType == valueType {
return true
}
}
return false
}
// GetSchemaMapAttributeNames returns all attribute names held in a map[string]*schema.Schema
func GetSchemaMapAttributeNames(cl *ast.CompositeLit) []ast.Expr {
var result []ast.Expr
for _, elt := range cl.Elts {
switch v := elt.(type) {
case *ast.KeyValueExpr:
result = append(result, v.Key)
}
}
return result
}
// GetSchemaMapSchemas returns all Schema held in a map[string]*schema.Schema
func GetSchemaMapSchemas(cl *ast.CompositeLit) []*ast.CompositeLit {
var result []*ast.CompositeLit
for _, elt := range cl.Elts {
switch v := elt.(type) {
case *ast.KeyValueExpr:
switch v := v.Value.(type) {
case *ast.CompositeLit:
result = append(result, v)
}
}
}
return result
}
// IsTypeSchema returns if the type is Schema from the helper/schema package
func IsTypeSchema(t types.Type) bool {
switch t := t.(type) {
case *types.Named:
return IsNamedType(t, TypeNameSchema)
case *types.Pointer:
return IsTypeSchema(t.Elem())
default:
return false
}
}
// IsValueType returns if the Schema field Type matches
func IsValueType(e ast.Expr, info *types.Info) bool {
switch e := e.(type) {
case *ast.SelectorExpr:
switch t := info.TypeOf(e).(type) {
case *types.Named:
return IsNamedType(t, TypeNameValueType)
default:
return false
}
default:
return false
}
}
// ValueType returns the schema value type
func ValueType(e ast.Expr, info *types.Info) valueType {
switch e := e.(type) {
case *ast.SelectorExpr:
switch t := info.ObjectOf(e.Sel).(type) {
case *types.Const:
v, ok := constant.Int64Val(t.Val())
if !ok {
return typeInvalid
}
return valueType(v)
default:
return typeInvalid
}
default:
return typeInvalid
}
}
// IsTypeSet returns if the type is Set from the helper/schema package
// Use IsTypeSchemaFieldType for verifying Type: schema.TypeSet ValueType
func IsTypeSet(t types.Type) bool {
switch t := t.(type) {
case *types.Named:
return IsNamedType(t, TypeNameSet)
case *types.Pointer:
return IsTypeSet(t.Elem())
default:
return false
}
}
// IsMapStringSchema returns if the type is map[string]*Schema from the helper/schema package
func IsMapStringSchema(cl *ast.CompositeLit, info *types.Info) bool {
switch v := cl.Type.(type) {
case *ast.MapType:
switch k := v.Key.(type) {
case *ast.Ident:
if k.Name != "string" {
return false
}
}
return IsTypeSchema(info.TypeOf(v.Value))
}
return false
}
// typeSchemaType extracts the string representation of a Schema Type value
func typeSchemaType(schema *ast.CompositeLit, info *types.Info) string {
kvExpr := astutils.CompositeLitField(schema, SchemaFieldType)
if kvExpr == nil {
return ""
}
if !IsValueType(kvExpr.Value, info) {
return ""
}
return valueTypeString(kvExpr.Value)
}
// valueTypeString extracts the string representation of a Schema ValueType
func valueTypeString(e ast.Expr) string {
switch e := e.(type) {
case *ast.SelectorExpr:
return e.Sel.Name
default:
return ""
}
}