/
binder_resource.go
447 lines (398 loc) 路 13.8 KB
/
binder_resource.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
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
// Copyright 2016-2020, Pulumi Corporation.
//
// 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.
// nolint: goconst
package pcl
import (
"github.com/hashicorp/hcl/v2"
"github.com/hashicorp/hcl/v2/hclsyntax"
"github.com/pulumi/pulumi/pkg/v3/codegen"
"github.com/pulumi/pulumi/pkg/v3/codegen/hcl2/model"
"github.com/pulumi/pulumi/pkg/v3/codegen/hcl2/syntax"
"github.com/pulumi/pulumi/pkg/v3/codegen/schema"
"github.com/pulumi/pulumi/sdk/v3/go/common/util/contract"
"github.com/zclconf/go-cty/cty"
)
func getResourceToken(node *Resource) (string, hcl.Range) {
return node.syntax.Labels[1], node.syntax.LabelRanges[1]
}
func (b *binder) bindResource(node *Resource) hcl.Diagnostics {
var diagnostics hcl.Diagnostics
typeDiags := b.bindResourceTypes(node)
diagnostics = append(diagnostics, typeDiags...)
bodyDiags := b.bindResourceBody(node)
diagnostics = append(diagnostics, bodyDiags...)
return diagnostics
}
func annotateAttributeValue(expr model.Expression, attributeType schema.Type) model.Expression {
if optionalType, ok := attributeType.(*schema.OptionalType); ok {
return annotateAttributeValue(expr, optionalType.ElementType)
}
switch attrValue := expr.(type) {
case *model.ObjectConsExpression:
if schemaObjectType, ok := attributeType.(*schema.ObjectType); ok {
schemaProperties := make(map[string]schema.Type)
for _, schemaProperty := range schemaObjectType.Properties {
schemaProperties[schemaProperty.Name] = schemaProperty.Type
}
for _, item := range attrValue.Items {
keyLiteral, isLit := item.Key.(*model.LiteralValueExpression)
if isLit {
correspondingSchemaType, ok := schemaProperties[keyLiteral.Value.AsString()]
if ok {
item.Value = annotateAttributeValue(item.Value, correspondingSchemaType)
}
}
}
return attrValue.WithType(func(attrValueType model.Type) *model.ObjectConsExpression {
annotateObjectProperties(attrValueType, attributeType)
return attrValue
})
}
return attrValue
case *model.TupleConsExpression:
if schemaArrayType, ok := attributeType.(*schema.ArrayType); ok {
elementType := schemaArrayType.ElementType
for _, arrayExpr := range attrValue.Expressions {
annotateAttributeValue(arrayExpr, elementType)
}
}
return attrValue
case *model.FunctionCallExpression:
if attrValue.Name == IntrinsicConvert {
converterArg := attrValue.Args[0]
annotateAttributeValue(converterArg, attributeType)
}
return attrValue
default:
return expr
}
}
func AnnotateAttributeValue(expr model.Expression, attributeType schema.Type) model.Expression {
return annotateAttributeValue(expr, attributeType)
}
func AnnotateResourceInputs(node *Resource) {
resourceProperties := make(map[string]*schema.Property)
for _, property := range node.Schema.Properties {
resourceProperties[property.Name] = property
}
// add type annotations to the attributes
// and their nested objects
for index := range node.Inputs {
attr := node.Inputs[index]
if property, ok := resourceProperties[attr.Name]; ok {
node.Inputs[index] = &model.Attribute{
Tokens: attr.Tokens,
Name: attr.Name,
Syntax: attr.Syntax,
Value: AnnotateAttributeValue(attr.Value, property.Type),
}
}
}
}
// bindResourceTypes binds the input and output types for a resource.
func (b *binder) bindResourceTypes(node *Resource) hcl.Diagnostics {
// Set the input and output types to dynamic by default.
node.InputType, node.OutputType = model.DynamicType, model.DynamicType
// Find the resource's schema.
token, tokenRange := getResourceToken(node)
pkg, module, name, diagnostics := DecomposeToken(token, tokenRange)
if diagnostics.HasErrors() {
return diagnostics
}
isProvider := false
if pkg == "pulumi" && module == "providers" {
pkg, isProvider = name, true
}
var pkgSchema *packageSchema
// It is important that we call `loadPackageSchema` instead of `getPackageSchema` here
// because the the version may be wrong. When the version should not be empty,
// `loadPackageSchema` will load the default version while `getPackageSchema` will
// simply fail. We can't give a populated version field since we have not processed
// the body, and thus the version yet.
pkgSchema, err := b.options.packageCache.loadPackageSchema(b.options.loader, pkg, "")
if err != nil {
e := unknownPackage(pkg, tokenRange)
e.Detail = err.Error()
return hcl.Diagnostics{e}
}
var res *schema.Resource
var inputProperties, properties []*schema.Property
if isProvider {
r, err := pkgSchema.schema.Provider()
if err != nil {
return hcl.Diagnostics{resourceLoadError(token, err, tokenRange)}
}
res = r
} else {
r, tk, ok, err := pkgSchema.LookupResource(token)
if err != nil {
return hcl.Diagnostics{resourceLoadError(token, err, tokenRange)}
} else if !ok {
return hcl.Diagnostics{unknownResourceType(token, tokenRange)}
}
res = r
token = tk
}
node.Schema = res
inputProperties, properties = res.InputProperties, res.Properties
node.Token = token
// Create input and output types for the schema.
inputType := b.schemaTypeToType(&schema.ObjectType{Properties: inputProperties})
outputProperties := map[string]model.Type{
"id": model.NewOutputType(model.StringType),
"urn": model.NewOutputType(model.StringType),
}
for _, prop := range properties {
outputProperties[prop.Name] = model.NewOutputType(b.schemaTypeToType(prop.Type))
}
outputType := model.NewObjectType(outputProperties, &schema.ObjectType{Properties: properties})
node.InputType, node.OutputType = inputType, outputType
return diagnostics
}
type resourceScopes struct {
root *model.Scope
withRange *model.Scope
resource *Resource
}
func newResourceScopes(root *model.Scope, resource *Resource, rangeKey, rangeValue model.Type) model.Scopes {
scopes := &resourceScopes{
root: root,
withRange: root,
resource: resource,
}
if rangeValue != nil {
properties := map[string]model.Type{
"value": rangeValue,
}
if rangeKey != nil {
properties["key"] = rangeKey
}
scopes.withRange = root.Push(syntax.None)
scopes.withRange.Define("range", &model.Variable{
Name: "range",
VariableType: model.NewObjectType(properties),
})
}
return scopes
}
func (s *resourceScopes) GetScopesForBlock(block *hclsyntax.Block) (model.Scopes, hcl.Diagnostics) {
if block.Type == "options" {
return &optionsScopes{root: s.root, resource: s.resource}, nil
}
return model.StaticScope(s.withRange), nil
}
func (s *resourceScopes) GetScopeForAttribute(attr *hclsyntax.Attribute) (*model.Scope, hcl.Diagnostics) {
return s.withRange, nil
}
type optionsScopes struct {
root *model.Scope
resource *Resource
}
func (s *optionsScopes) GetScopesForBlock(block *hclsyntax.Block) (model.Scopes, hcl.Diagnostics) {
return model.StaticScope(s.root), nil
}
func (s *optionsScopes) GetScopeForAttribute(attr *hclsyntax.Attribute) (*model.Scope, hcl.Diagnostics) {
if attr.Name == "ignoreChanges" {
obj, ok := model.ResolveOutputs(s.resource.InputType).(*model.ObjectType)
if !ok {
return nil, nil
}
scope := model.NewRootScope(syntax.None)
for k, t := range obj.Properties {
scope.Define(k, &ResourceProperty{
Path: hcl.Traversal{hcl.TraverseRoot{Name: k}},
PropertyType: t,
})
}
return scope, nil
}
return s.root, nil
}
// bindResourceBody binds the body of a resource.
func (b *binder) bindResourceBody(node *Resource) hcl.Diagnostics {
var diagnostics hcl.Diagnostics
// If the resource has a range option, we need to know the type of the collection being ranged over. Pre-bind the
// range expression now, but ignore the diagnostics.
node.VariableType = node.OutputType
var rangeKey, rangeValue model.Type
for _, block := range node.syntax.Body.Blocks {
if block.Type == "options" {
if rng, hasRange := block.Body.Attributes["range"]; hasRange {
expr, _ := model.BindExpression(rng.Expr, b.root, b.tokens, b.options.modelOptions()...)
typ := model.ResolveOutputs(expr.Type())
resourceVar := &model.Variable{
Name: "r",
VariableType: node.VariableType,
}
switch {
case model.InputType(model.BoolType).ConversionFrom(typ) == model.SafeConversion:
condExpr := &model.ConditionalExpression{
Condition: expr,
TrueResult: model.VariableReference(resourceVar),
FalseResult: model.ConstantReference(&model.Constant{
Name: "null",
ConstantValue: cty.NullVal(cty.DynamicPseudoType),
}),
}
diags := condExpr.Typecheck(false)
contract.Assert(len(diags) == 0)
node.VariableType = condExpr.Type()
case model.InputType(model.NumberType).ConversionFrom(typ) != model.NoConversion:
rangeArgs := []model.Expression{expr}
rangeSig, _ := pulumiBuiltins["range"].GetSignature(rangeArgs)
rangeExpr := &model.ForExpression{
ValueVariable: &model.Variable{
Name: "_",
VariableType: model.NumberType,
},
Collection: &model.FunctionCallExpression{
Name: "range",
Signature: rangeSig,
Args: rangeArgs,
},
Value: model.VariableReference(resourceVar),
}
diags := rangeExpr.Typecheck(false)
contract.Assert(len(diags) == 0)
node.VariableType = rangeExpr.Type()
default:
rk, rv, diags := model.GetCollectionTypes(typ, rng.Range())
rangeKey, rangeValue, diagnostics = rk, rv, append(diagnostics, diags...)
iterationExpr := &model.ForExpression{
ValueVariable: &model.Variable{
Name: "_",
VariableType: rangeValue,
},
Collection: expr,
Value: model.VariableReference(resourceVar),
}
diags = iterationExpr.Typecheck(false)
contract.Ignore(diags) // Any relevant diagnostics were reported by GetCollectionTypes.
node.VariableType = iterationExpr.Type()
}
}
}
}
// Bind the resource's body.
scopes := newResourceScopes(b.root, node, rangeKey, rangeValue)
block, blockDiags := model.BindBlock(node.syntax, scopes, b.tokens, b.options.modelOptions()...)
diagnostics = append(diagnostics, blockDiags...)
var options *model.Block
for _, item := range block.Body.Items {
switch item := item.(type) {
case *model.Attribute:
if item.Name == LogicalNamePropertyKey {
logicalName, lDiags := getStringAttrValue(item)
if lDiags != nil {
diagnostics = diagnostics.Append(lDiags)
} else {
node.logicalName = logicalName
}
continue
}
node.Inputs = append(node.Inputs, item)
case *model.Block:
switch item.Type {
case "options":
if options != nil {
diagnostics = append(diagnostics, duplicateBlock(item.Type, item.Syntax.TypeRange))
} else {
options = item
}
default:
diagnostics = append(diagnostics, unsupportedBlock(item.Type, item.Syntax.TypeRange))
}
}
}
// Typecheck the attributes.
if objectType, ok := node.InputType.(*model.ObjectType); ok {
diag := func(d *hcl.Diagnostic) {
if b.options.skipResourceTypecheck && d.Severity == hcl.DiagError {
d.Severity = hcl.DiagWarning
}
diagnostics = append(diagnostics, d)
}
attrNames := codegen.StringSet{}
for _, attr := range node.Inputs {
attrNames.Add(attr.Name)
if typ, ok := objectType.Properties[attr.Name]; ok {
if !typ.ConversionFrom(attr.Value.Type()).Exists() {
diag(model.ExprNotConvertible(typ, attr.Value))
}
} else {
diag(unsupportedAttribute(attr.Name, attr.Syntax.NameRange))
}
}
for _, k := range codegen.SortedKeys(objectType.Properties) {
typ := objectType.Properties[k]
if model.IsOptionalType(typ) || attrNames.Has(k) {
// The type is present or optional. No error.
continue
}
if model.IsConstType(objectType.Properties[k]) {
// The type is const, so the value is implied. No error.
continue
}
diag(missingRequiredAttribute(k, block.Body.Syntax.MissingItemRange()))
}
}
// Typecheck the options block.
if options != nil {
resourceOptions := &ResourceOptions{}
for _, item := range options.Body.Items {
switch item := item.(type) {
case *model.Attribute:
var t model.Type
switch item.Name {
case "range":
t = model.NewUnionType(model.BoolType, model.NumberType, model.NewListType(model.DynamicType),
model.NewMapType(model.DynamicType))
resourceOptions.Range = item.Value
case "parent":
t = model.DynamicType
resourceOptions.Parent = item.Value
case "provider":
t = model.DynamicType
resourceOptions.Provider = item.Value
case "dependsOn":
t = model.NewListType(model.DynamicType)
resourceOptions.DependsOn = item.Value
case "protect":
t = model.BoolType
resourceOptions.Protect = item.Value
case "ignoreChanges":
t = model.NewListType(ResourcePropertyType)
resourceOptions.IgnoreChanges = item.Value
case "version":
t = model.StringType
resourceOptions.Version = item.Value
case "pluginDownloadURL":
t = model.StringType
resourceOptions.PluginDownloadURL = item.Value
default:
diagnostics = append(diagnostics, unsupportedAttribute(item.Name, item.Syntax.NameRange))
continue
}
if model.InputType(t).ConversionFrom(item.Value.Type()) == model.NoConversion {
diagnostics = append(diagnostics, model.ExprNotConvertible(model.InputType(t), item.Value))
}
case *model.Block:
diagnostics = append(diagnostics, unsupportedBlock(item.Type, item.Syntax.TypeRange))
}
}
node.Options = resourceOptions
}
node.Definition = block
return diagnostics
}