forked from hashicorp/hcl
/
test_file.go
353 lines (307 loc) · 8.18 KB
/
test_file.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
// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0
package main
import (
"fmt"
"github.com/zclconf/go-cty/cty"
"github.com/zclconf/go-cty/cty/convert"
"github.com/ryan-jan/hcl"
"github.com/ryan-jan/hcl/ext/typeexpr"
"github.com/ryan-jan/hcl/gohcl"
)
type TestFile struct {
Result cty.Value
ResultType cty.Type
ChecksTraversals bool
ExpectedTraversals []*TestFileExpectTraversal
ExpectedDiags []*TestFileExpectDiag
ResultRange hcl.Range
ResultTypeRange hcl.Range
}
type TestFileExpectTraversal struct {
Traversal hcl.Traversal
Range hcl.Range
DeclRange hcl.Range
}
type TestFileExpectDiag struct {
Severity hcl.DiagnosticSeverity
Range hcl.Range
DeclRange hcl.Range
}
func (r *Runner) LoadTestFile(filename string) (*TestFile, hcl.Diagnostics) {
f, diags := r.parser.ParseHCLFile(filename)
if diags.HasErrors() {
return nil, diags
}
content, moreDiags := f.Body.Content(testFileSchema)
diags = append(diags, moreDiags...)
if moreDiags.HasErrors() {
return nil, diags
}
ret := &TestFile{
ResultType: cty.DynamicPseudoType,
}
if typeAttr, exists := content.Attributes["result_type"]; exists {
ty, moreDiags := typeexpr.TypeConstraint(typeAttr.Expr)
diags = append(diags, moreDiags...)
if !moreDiags.HasErrors() {
ret.ResultType = ty
}
ret.ResultTypeRange = typeAttr.Expr.Range()
}
if resultAttr, exists := content.Attributes["result"]; exists {
resultVal, moreDiags := resultAttr.Expr.Value(nil)
diags = append(diags, moreDiags...)
if !moreDiags.HasErrors() {
resultVal, err := convert.Convert(resultVal, ret.ResultType)
if err != nil {
diags = diags.Append(&hcl.Diagnostic{
Severity: hcl.DiagError,
Summary: "Invalid result value",
Detail: fmt.Sprintf("The result value does not conform to the given result type: %s.", err),
Subject: resultAttr.Expr.Range().Ptr(),
})
} else {
ret.Result = resultVal
}
}
ret.ResultRange = resultAttr.Expr.Range()
}
for _, block := range content.Blocks {
switch block.Type {
case "traversals":
if ret.ChecksTraversals {
// Indicates a duplicate traversals block
diags = diags.Append(&hcl.Diagnostic{
Severity: hcl.DiagError,
Summary: "Duplicate \"traversals\" block",
Detail: fmt.Sprintf("Only one traversals block is expected."),
Subject: &block.TypeRange,
})
continue
}
expectTraversals, moreDiags := r.decodeTraversalsBlock(block)
diags = append(diags, moreDiags...)
if !moreDiags.HasErrors() {
ret.ChecksTraversals = true
ret.ExpectedTraversals = expectTraversals
}
case "diagnostics":
if len(ret.ExpectedDiags) > 0 {
// Indicates a duplicate diagnostics block
diags = diags.Append(&hcl.Diagnostic{
Severity: hcl.DiagError,
Summary: "Duplicate \"diagnostics\" block",
Detail: fmt.Sprintf("Only one diagnostics block is expected."),
Subject: &block.TypeRange,
})
continue
}
expectDiags, moreDiags := r.decodeDiagnosticsBlock(block)
diags = append(diags, moreDiags...)
ret.ExpectedDiags = expectDiags
default:
// Shouldn't get here, because the above cases are exhaustive for
// our test file schema.
panic(fmt.Sprintf("unsupported block type %q", block.Type))
}
}
if ret.Result != cty.NilVal && len(ret.ExpectedDiags) > 0 {
diags = diags.Append(&hcl.Diagnostic{
Severity: hcl.DiagError,
Summary: "Conflicting spec expectations",
Detail: "This test spec includes expected diagnostics, so it may not also include an expected result.",
Subject: &content.Attributes["result"].Range,
})
}
return ret, diags
}
func (r *Runner) decodeTraversalsBlock(block *hcl.Block) ([]*TestFileExpectTraversal, hcl.Diagnostics) {
var diags hcl.Diagnostics
content, moreDiags := block.Body.Content(testFileTraversalsSchema)
diags = append(diags, moreDiags...)
if moreDiags.HasErrors() {
return nil, diags
}
var ret []*TestFileExpectTraversal
for _, block := range content.Blocks {
// There's only one block type in our schema, so we can assume all
// blocks are of that type.
expectTraversal, moreDiags := r.decodeTraversalExpectBlock(block)
diags = append(diags, moreDiags...)
if expectTraversal != nil {
ret = append(ret, expectTraversal)
}
}
return ret, diags
}
func (r *Runner) decodeTraversalExpectBlock(block *hcl.Block) (*TestFileExpectTraversal, hcl.Diagnostics) {
var diags hcl.Diagnostics
rng, body, moreDiags := r.decodeRangeFromBody(block.Body)
diags = append(diags, moreDiags...)
content, moreDiags := body.Content(testFileTraversalExpectSchema)
diags = append(diags, moreDiags...)
if moreDiags.HasErrors() {
return nil, diags
}
var traversal hcl.Traversal
{
refAttr := content.Attributes["ref"]
traversal, moreDiags = hcl.AbsTraversalForExpr(refAttr.Expr)
diags = append(diags, moreDiags...)
if moreDiags.HasErrors() {
return nil, diags
}
}
return &TestFileExpectTraversal{
Traversal: traversal,
Range: rng,
DeclRange: block.DefRange,
}, diags
}
func (r *Runner) decodeDiagnosticsBlock(block *hcl.Block) ([]*TestFileExpectDiag, hcl.Diagnostics) {
var diags hcl.Diagnostics
content, moreDiags := block.Body.Content(testFileDiagnosticsSchema)
diags = append(diags, moreDiags...)
if moreDiags.HasErrors() {
return nil, diags
}
if len(content.Blocks) == 0 {
diags = diags.Append(&hcl.Diagnostic{
Severity: hcl.DiagError,
Summary: "Empty diagnostics block",
Detail: "If a diagnostics block is present, at least one expectation statement (\"error\" or \"warning\" block) must be included.",
Subject: &block.TypeRange,
})
return nil, diags
}
ret := make([]*TestFileExpectDiag, 0, len(content.Blocks))
for _, block := range content.Blocks {
rng, remain, moreDiags := r.decodeRangeFromBody(block.Body)
diags = append(diags, moreDiags...)
if diags.HasErrors() {
continue
}
// Should have nothing else in the block aside from the range definition.
_, moreDiags = remain.Content(&hcl.BodySchema{})
diags = append(diags, moreDiags...)
var severity hcl.DiagnosticSeverity
switch block.Type {
case "error":
severity = hcl.DiagError
case "warning":
severity = hcl.DiagWarning
default:
panic(fmt.Sprintf("unsupported block type %q", block.Type))
}
ret = append(ret, &TestFileExpectDiag{
Severity: severity,
Range: rng,
DeclRange: block.TypeRange,
})
}
return ret, diags
}
func (r *Runner) decodeRangeFromBody(body hcl.Body) (hcl.Range, hcl.Body, hcl.Diagnostics) {
type RawPos struct {
Line int `hcl:"line"`
Column int `hcl:"column"`
Byte int `hcl:"byte"`
}
type RawRange struct {
From RawPos `hcl:"from,block"`
To RawPos `hcl:"to,block"`
Remain hcl.Body `hcl:",remain"`
}
var raw RawRange
diags := gohcl.DecodeBody(body, nil, &raw)
return hcl.Range{
// We intentionally omit Filename here, because the test spec doesn't
// need to specify that explicitly: we can infer it to be the file
// path we pass to hcldec.
Start: hcl.Pos{
Line: raw.From.Line,
Column: raw.From.Column,
Byte: raw.From.Byte,
},
End: hcl.Pos{
Line: raw.To.Line,
Column: raw.To.Column,
Byte: raw.To.Byte,
},
}, raw.Remain, diags
}
var testFileSchema = &hcl.BodySchema{
Attributes: []hcl.AttributeSchema{
{
Name: "result",
},
{
Name: "result_type",
},
},
Blocks: []hcl.BlockHeaderSchema{
{
Type: "traversals",
},
{
Type: "diagnostics",
},
},
}
var testFileTraversalsSchema = &hcl.BodySchema{
Blocks: []hcl.BlockHeaderSchema{
{
Type: "expect",
},
},
}
var testFileTraversalExpectSchema = &hcl.BodySchema{
Attributes: []hcl.AttributeSchema{
{
Name: "ref",
Required: true,
},
},
Blocks: []hcl.BlockHeaderSchema{
{
Type: "range",
},
},
}
var testFileDiagnosticsSchema = &hcl.BodySchema{
Blocks: []hcl.BlockHeaderSchema{
{
Type: "error",
},
{
Type: "warning",
},
},
}
var testFileRangeSchema = &hcl.BodySchema{
Blocks: []hcl.BlockHeaderSchema{
{
Type: "from",
},
{
Type: "to",
},
},
}
var testFilePosSchema = &hcl.BodySchema{
Attributes: []hcl.AttributeSchema{
{
Name: "line",
Required: true,
},
{
Name: "column",
Required: true,
},
{
Name: "byte",
Required: true,
},
},
}