-
Notifications
You must be signed in to change notification settings - Fork 1.9k
/
dec.go
331 lines (269 loc) · 8.47 KB
/
dec.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
package hclspecutils
import (
"fmt"
"github.com/hashicorp/hcl2/hcl"
"github.com/hashicorp/hcl2/hcl/hclsyntax"
"github.com/hashicorp/hcl2/hcldec"
"github.com/hashicorp/nomad/plugins/shared/hclspec"
)
var (
// nilSpecDiagnostic is the diagnostic value returned if a nil value is
// given
nilSpecDiagnostic = &hcl.Diagnostic{
Severity: hcl.DiagError,
Summary: "nil spec given",
Detail: "Can not convert a nil specification. Pass a valid spec",
}
// emptyPos is the position used when parsing hcl expressions
emptyPos = hcl.Pos{
Line: 0,
Column: 0,
Byte: 0,
}
// specCtx is the context used to evaluate expressions.
specCtx = &hcl.EvalContext{
Functions: specFuncs,
}
)
// Convert converts a Spec to an hcl specification.
func Convert(spec *hclspec.Spec) (hcldec.Spec, hcl.Diagnostics) {
if spec == nil {
return nil, hcl.Diagnostics([]*hcl.Diagnostic{nilSpecDiagnostic})
}
return decodeSpecBlock(spec, "")
}
// decodeSpecBlock is the recursive entry point that converts between the two
// spec types.
func decodeSpecBlock(spec *hclspec.Spec, impliedName string) (hcldec.Spec, hcl.Diagnostics) {
switch spec.Block.(type) {
case *hclspec.Spec_Object:
return decodeObjectSpec(spec.GetObject())
case *hclspec.Spec_Array:
return decodeArraySpec(spec.GetArray())
case *hclspec.Spec_Attr:
return decodeAttrSpec(spec.GetAttr(), impliedName)
case *hclspec.Spec_BlockValue:
return decodeBlockSpec(spec.GetBlockValue(), impliedName)
case *hclspec.Spec_BlockAttrs:
return decodeBlockAttrsSpec(spec.GetBlockAttrs(), impliedName)
case *hclspec.Spec_BlockList:
return decodeBlockListSpec(spec.GetBlockList(), impliedName)
case *hclspec.Spec_BlockSet:
return decodeBlockSetSpec(spec.GetBlockSet(), impliedName)
case *hclspec.Spec_BlockMap:
return decodeBlockMapSpec(spec.GetBlockMap(), impliedName)
case *hclspec.Spec_Default:
return decodeDefaultSpec(spec.GetDefault())
case *hclspec.Spec_Literal:
return decodeLiteralSpec(spec.GetLiteral())
default:
// Should never happen, because the above cases should be exhaustive
// for our schema.
var diags hcl.Diagnostics
diags = append(diags, &hcl.Diagnostic{
Severity: hcl.DiagError,
Summary: "Invalid spec block",
Detail: fmt.Sprintf("Blocks of type %T are not expected here.", spec.Block),
})
return nil, diags
}
}
func decodeObjectSpec(obj *hclspec.Object) (hcldec.Spec, hcl.Diagnostics) {
var diags hcl.Diagnostics
spec := make(hcldec.ObjectSpec)
for attr, block := range obj.GetAttributes() {
propSpec, propDiags := decodeSpecBlock(block, attr)
diags = append(diags, propDiags...)
spec[attr] = propSpec
}
return spec, diags
}
func decodeArraySpec(a *hclspec.Array) (hcldec.Spec, hcl.Diagnostics) {
values := a.GetValues()
var diags hcl.Diagnostics
spec := make(hcldec.TupleSpec, 0, len(values))
for _, block := range values {
elemSpec, elemDiags := decodeSpecBlock(block, "")
diags = append(diags, elemDiags...)
spec = append(spec, elemSpec)
}
return spec, diags
}
func decodeAttrSpec(attr *hclspec.Attr, impliedName string) (hcldec.Spec, hcl.Diagnostics) {
// Convert the string type to an hcl.Expression
typeExpr, diags := hclsyntax.ParseExpression([]byte(attr.GetType()), "proto", emptyPos)
if diags.HasErrors() {
return nil, diags
}
spec := &hcldec.AttrSpec{
Name: impliedName,
Required: attr.GetRequired(),
}
if n := attr.GetName(); n != "" {
spec.Name = n
}
var typeDiags hcl.Diagnostics
spec.Type, typeDiags = evalTypeExpr(typeExpr)
diags = append(diags, typeDiags...)
if spec.Name == "" {
diags = append(diags, &hcl.Diagnostic{
Severity: hcl.DiagError,
Summary: "Missing name in attribute spec",
Detail: "The name attribute is required, to specify the attribute name that is expected in an input HCL file.",
})
return nil, diags
}
return spec, diags
}
func decodeBlockSpec(block *hclspec.Block, impliedName string) (hcldec.Spec, hcl.Diagnostics) {
spec := &hcldec.BlockSpec{
TypeName: impliedName,
Required: block.GetRequired(),
}
if n := block.GetName(); n != "" {
spec.TypeName = n
}
nested, diags := decodeBlockNestedSpec(block.GetNested())
spec.Nested = nested
return spec, diags
}
func decodeBlockAttrsSpec(block *hclspec.BlockAttrs, impliedName string) (hcldec.Spec, hcl.Diagnostics) {
// Convert the string type to an hcl.Expression
typeExpr, diags := hclsyntax.ParseExpression([]byte(block.GetType()), "proto", emptyPos)
if diags.HasErrors() {
return nil, diags
}
spec := &hcldec.BlockAttrsSpec{
TypeName: impliedName,
Required: block.GetRequired(),
}
if n := block.GetName(); n != "" {
spec.TypeName = n
}
var typeDiags hcl.Diagnostics
spec.ElementType, typeDiags = evalTypeExpr(typeExpr)
diags = append(diags, typeDiags...)
if spec.TypeName == "" {
diags = append(diags, &hcl.Diagnostic{
Severity: hcl.DiagError,
Summary: "Missing name in block_attrs spec",
Detail: "The name attribute is required, to specify the block attr name that is expected in an input HCL file.",
})
return nil, diags
}
return spec, diags
}
func decodeBlockListSpec(block *hclspec.BlockList, impliedName string) (hcldec.Spec, hcl.Diagnostics) {
spec := &hcldec.BlockListSpec{
TypeName: impliedName,
MinItems: int(block.GetMinItems()),
MaxItems: int(block.GetMaxItems()),
}
if n := block.GetName(); n != "" {
spec.TypeName = n
}
nested, diags := decodeBlockNestedSpec(block.GetNested())
spec.Nested = nested
if spec.TypeName == "" {
diags = append(diags, &hcl.Diagnostic{
Severity: hcl.DiagError,
Summary: "Missing name in block_list spec",
Detail: "The name attribute is required, to specify the block type name that is expected in an input HCL file.",
})
return nil, diags
}
return spec, diags
}
func decodeBlockSetSpec(block *hclspec.BlockSet, impliedName string) (hcldec.Spec, hcl.Diagnostics) {
spec := &hcldec.BlockSetSpec{
TypeName: impliedName,
MinItems: int(block.GetMinItems()),
MaxItems: int(block.GetMaxItems()),
}
if n := block.GetName(); n != "" {
spec.TypeName = n
}
nested, diags := decodeBlockNestedSpec(block.GetNested())
spec.Nested = nested
if spec.TypeName == "" {
diags = append(diags, &hcl.Diagnostic{
Severity: hcl.DiagError,
Summary: "Missing name in block_set spec",
Detail: "The name attribute is required, to specify the block type name that is expected in an input HCL file.",
})
return nil, diags
}
return spec, diags
}
func decodeBlockMapSpec(block *hclspec.BlockMap, impliedName string) (hcldec.Spec, hcl.Diagnostics) {
spec := &hcldec.BlockMapSpec{
TypeName: impliedName,
LabelNames: block.GetLabels(),
}
if n := block.GetName(); n != "" {
spec.TypeName = n
}
nested, diags := decodeBlockNestedSpec(block.GetNested())
spec.Nested = nested
if spec.TypeName == "" {
diags = append(diags, &hcl.Diagnostic{
Severity: hcl.DiagError,
Summary: "Missing name in block_map spec",
Detail: "The name attribute is required, to specify the block type name that is expected in an input HCL file.",
})
return nil, diags
}
if len(spec.LabelNames) < 1 {
diags = append(diags, &hcl.Diagnostic{
Severity: hcl.DiagError,
Summary: "Invalid block label name list",
Detail: "A block_map must have at least one label specified.",
})
return nil, diags
}
return spec, diags
}
func decodeBlockNestedSpec(spec *hclspec.Spec) (hcldec.Spec, hcl.Diagnostics) {
if spec == nil {
return nil, hcl.Diagnostics([]*hcl.Diagnostic{
{
Severity: hcl.DiagError,
Summary: "Missing spec block",
Detail: "A block spec must have exactly one child spec specifying how to decode block contents.",
}})
}
return decodeSpecBlock(spec, "")
}
func decodeLiteralSpec(l *hclspec.Literal) (hcldec.Spec, hcl.Diagnostics) {
// Convert the string value to an hcl.Expression
valueExpr, diags := hclsyntax.ParseExpression([]byte(l.GetValue()), "proto", emptyPos)
if diags.HasErrors() {
return nil, diags
}
value, valueDiags := valueExpr.Value(specCtx)
diags = append(diags, valueDiags...)
if diags.HasErrors() {
return nil, diags
}
return &hcldec.LiteralSpec{
Value: value,
}, diags
}
func decodeDefaultSpec(d *hclspec.Default) (hcldec.Spec, hcl.Diagnostics) {
// Parse the primary
primary, diags := decodeSpecBlock(d.GetPrimary(), "")
if diags.HasErrors() {
return nil, diags
}
// Parse the default
def, defDiags := decodeSpecBlock(d.GetDefault(), "")
diags = append(diags, defDiags...)
if diags.HasErrors() {
return nil, diags
}
spec := &hcldec.DefaultSpec{
Primary: primary,
Default: def,
}
return spec, diags
}