-
Notifications
You must be signed in to change notification settings - Fork 230
/
testing_new.go
443 lines (374 loc) · 12.9 KB
/
testing_new.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
// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0
package resource
import (
"context"
"fmt"
"reflect"
"strings"
"github.com/google/go-cmp/cmp"
tfjson "github.com/hashicorp/terraform-json"
"github.com/mitchellh/go-testing-interface"
"github.com/hashicorp/terraform-plugin-sdk/v2/internal/logging"
"github.com/hashicorp/terraform-plugin-sdk/v2/internal/plugintest"
"github.com/hashicorp/terraform-plugin-sdk/v2/terraform"
)
func runPostTestDestroy(ctx context.Context, t testing.T, c TestCase, wd *plugintest.WorkingDir, providers *providerFactories, statePreDestroy *terraform.State) error {
t.Helper()
err := runProviderCommand(ctx, t, func() error {
return wd.Destroy(ctx)
}, wd, providers)
if err != nil {
return err
}
if c.CheckDestroy != nil {
logging.HelperResourceTrace(ctx, "Using TestCase CheckDestroy")
logging.HelperResourceDebug(ctx, "Calling TestCase CheckDestroy")
if err := c.CheckDestroy(statePreDestroy); err != nil {
return err
}
logging.HelperResourceDebug(ctx, "Called TestCase CheckDestroy")
}
return nil
}
func runNewTest(ctx context.Context, t testing.T, c TestCase, helper *plugintest.Helper) {
t.Helper()
wd := helper.RequireNewWorkingDir(ctx, t)
ctx = logging.TestTerraformPathContext(ctx, wd.GetHelper().TerraformExecPath())
ctx = logging.TestWorkingDirectoryContext(ctx, wd.GetHelper().WorkingDirectory())
providers := &providerFactories{
legacy: c.ProviderFactories,
protov5: c.ProtoV5ProviderFactories,
protov6: c.ProtoV6ProviderFactories,
}
defer func() {
var statePreDestroy *terraform.State
var err error
err = runProviderCommand(ctx, t, func() error {
statePreDestroy, err = getState(ctx, t, wd)
if err != nil {
return err
}
return nil
}, wd, providers)
if err != nil {
logging.HelperResourceError(ctx,
"Error retrieving state, there may be dangling resources",
map[string]interface{}{logging.KeyError: err},
)
t.Fatalf("Error retrieving state, there may be dangling resources: %s", err.Error())
return
}
if !stateIsEmpty(statePreDestroy) {
err := runPostTestDestroy(ctx, t, c, wd, providers, statePreDestroy)
if err != nil {
logging.HelperResourceError(ctx,
"Error running post-test destroy, there may be dangling resources",
map[string]interface{}{logging.KeyError: err},
)
t.Fatalf("Error running post-test destroy, there may be dangling resources: %s", err.Error())
}
}
wd.Close()
}()
if c.hasProviders(ctx) {
err := wd.SetConfig(ctx, c.providerConfig(ctx, false))
if err != nil {
logging.HelperResourceError(ctx,
"TestCase error setting provider configuration",
map[string]interface{}{logging.KeyError: err},
)
t.Fatalf("TestCase error setting provider configuration: %s", err)
}
err = runProviderCommand(ctx, t, func() error {
return wd.Init(ctx)
}, wd, providers)
if err != nil {
logging.HelperResourceError(ctx,
"TestCase error running init",
map[string]interface{}{logging.KeyError: err},
)
t.Fatalf("TestCase error running init: %s", err.Error())
}
}
logging.HelperResourceDebug(ctx, "Starting TestSteps")
// use this to track last step successfully applied
// acts as default for import tests
var appliedCfg string
for stepIndex, step := range c.Steps {
stepNumber := stepIndex + 1 // 1-based indexing for humans
ctx = logging.TestStepNumberContext(ctx, stepNumber)
logging.HelperResourceDebug(ctx, "Starting TestStep")
if step.PreConfig != nil {
logging.HelperResourceDebug(ctx, "Calling TestStep PreConfig")
step.PreConfig()
logging.HelperResourceDebug(ctx, "Called TestStep PreConfig")
}
if step.SkipFunc != nil {
logging.HelperResourceDebug(ctx, "Calling TestStep SkipFunc")
skip, err := step.SkipFunc()
if err != nil {
logging.HelperResourceError(ctx,
"Error calling TestStep SkipFunc",
map[string]interface{}{logging.KeyError: err},
)
t.Fatalf("Error calling TestStep SkipFunc: %s", err.Error())
}
logging.HelperResourceDebug(ctx, "Called TestStep SkipFunc")
if skip {
t.Logf("Skipping step %d/%d due to SkipFunc", stepNumber, len(c.Steps))
logging.HelperResourceWarn(ctx, "Skipping TestStep due to SkipFunc")
continue
}
}
if step.Config != "" && !step.Destroy && len(step.Taint) > 0 {
err := testStepTaint(ctx, step, wd)
if err != nil {
logging.HelperResourceError(ctx,
"TestStep error tainting resources",
map[string]interface{}{logging.KeyError: err},
)
t.Fatalf("TestStep %d/%d error tainting resources: %s", stepNumber, len(c.Steps), err)
}
}
if step.hasProviders(ctx) {
providers = &providerFactories{
legacy: sdkProviderFactories(c.ProviderFactories).merge(step.ProviderFactories),
protov5: protov5ProviderFactories(c.ProtoV5ProviderFactories).merge(step.ProtoV5ProviderFactories),
protov6: protov6ProviderFactories(c.ProtoV6ProviderFactories).merge(step.ProtoV6ProviderFactories),
}
providerCfg := step.providerConfig(ctx, step.configHasProviderBlock(ctx))
err := wd.SetConfig(ctx, providerCfg)
if err != nil {
logging.HelperResourceError(ctx,
"TestStep error setting provider configuration",
map[string]interface{}{logging.KeyError: err},
)
t.Fatalf("TestStep %d/%d error setting test provider configuration: %s", stepNumber, len(c.Steps), err)
}
err = runProviderCommand(
ctx,
t,
func() error {
return wd.Init(ctx)
},
wd,
providers,
)
if err != nil {
logging.HelperResourceError(ctx,
"TestStep error running init",
map[string]interface{}{logging.KeyError: err},
)
t.Fatalf("TestStep %d/%d running init: %s", stepNumber, len(c.Steps), err.Error())
return
}
}
if step.ImportState {
logging.HelperResourceTrace(ctx, "TestStep is ImportState mode")
err := testStepNewImportState(ctx, t, helper, wd, step, appliedCfg, providers)
if step.ExpectError != nil {
logging.HelperResourceDebug(ctx, "Checking TestStep ExpectError")
if err == nil {
logging.HelperResourceError(ctx,
"Error running import: expected an error but got none",
)
t.Fatalf("Step %d/%d error running import: expected an error but got none", stepNumber, len(c.Steps))
}
if !step.ExpectError.MatchString(err.Error()) {
logging.HelperResourceError(ctx,
fmt.Sprintf("Error running import: expected an error with pattern (%s)", step.ExpectError.String()),
map[string]interface{}{logging.KeyError: err},
)
t.Fatalf("Step %d/%d error running import, expected an error with pattern (%s), no match on: %s", stepNumber, len(c.Steps), step.ExpectError.String(), err)
}
} else {
if err != nil && c.ErrorCheck != nil {
logging.HelperResourceDebug(ctx, "Calling TestCase ErrorCheck")
err = c.ErrorCheck(err)
logging.HelperResourceDebug(ctx, "Called TestCase ErrorCheck")
}
if err != nil {
logging.HelperResourceError(ctx,
"Error running import",
map[string]interface{}{logging.KeyError: err},
)
t.Fatalf("Step %d/%d error running import: %s", stepNumber, len(c.Steps), err)
}
}
logging.HelperResourceDebug(ctx, "Finished TestStep")
continue
}
if step.RefreshState {
logging.HelperResourceTrace(ctx, "TestStep is RefreshState mode")
err := testStepNewRefreshState(ctx, t, wd, step, providers)
if step.ExpectError != nil {
logging.HelperResourceDebug(ctx, "Checking TestStep ExpectError")
if err == nil {
logging.HelperResourceError(ctx,
"Error running refresh: expected an error but got none",
)
t.Fatalf("Step %d/%d error running refresh: expected an error but got none", stepNumber, len(c.Steps))
}
if !step.ExpectError.MatchString(err.Error()) {
logging.HelperResourceError(ctx,
fmt.Sprintf("Error running refresh: expected an error with pattern (%s)", step.ExpectError.String()),
map[string]interface{}{logging.KeyError: err},
)
t.Fatalf("Step %d/%d error running refresh, expected an error with pattern (%s), no match on: %s", stepNumber, len(c.Steps), step.ExpectError.String(), err)
}
} else {
if err != nil && c.ErrorCheck != nil {
logging.HelperResourceDebug(ctx, "Calling TestCase ErrorCheck")
err = c.ErrorCheck(err)
logging.HelperResourceDebug(ctx, "Called TestCase ErrorCheck")
}
if err != nil {
logging.HelperResourceError(ctx,
"Error running refresh",
map[string]interface{}{logging.KeyError: err},
)
t.Fatalf("Step %d/%d error running refresh: %s", stepNumber, len(c.Steps), err)
}
}
logging.HelperResourceDebug(ctx, "Finished TestStep")
continue
}
if step.Config != "" {
logging.HelperResourceTrace(ctx, "TestStep is Config mode")
err := testStepNewConfig(ctx, t, c, wd, step, providers)
if step.ExpectError != nil {
logging.HelperResourceDebug(ctx, "Checking TestStep ExpectError")
if err == nil {
logging.HelperResourceError(ctx,
"Expected an error but got none",
)
t.Fatalf("Step %d/%d, expected an error but got none", stepNumber, len(c.Steps))
}
if !step.ExpectError.MatchString(err.Error()) {
logging.HelperResourceError(ctx,
fmt.Sprintf("Expected an error with pattern (%s)", step.ExpectError.String()),
map[string]interface{}{logging.KeyError: err},
)
t.Fatalf("Step %d/%d, expected an error with pattern, no match on: %s", stepNumber, len(c.Steps), err)
}
} else {
if err != nil && c.ErrorCheck != nil {
logging.HelperResourceDebug(ctx, "Calling TestCase ErrorCheck")
err = c.ErrorCheck(err)
logging.HelperResourceDebug(ctx, "Called TestCase ErrorCheck")
}
if err != nil {
logging.HelperResourceError(ctx,
"Unexpected error",
map[string]interface{}{logging.KeyError: err},
)
t.Fatalf("Step %d/%d error: %s", stepNumber, len(c.Steps), err)
}
}
appliedCfg = step.mergedConfig(ctx, c)
logging.HelperResourceDebug(ctx, "Finished TestStep")
continue
}
t.Fatalf("Step %d/%d, unsupported test mode", stepNumber, len(c.Steps))
}
}
func getState(ctx context.Context, t testing.T, wd *plugintest.WorkingDir) (*terraform.State, error) {
t.Helper()
jsonState, err := wd.State(ctx)
if err != nil {
return nil, err
}
state, err := shimStateFromJson(jsonState)
if err != nil {
t.Fatal(err)
}
return state, nil
}
func stateIsEmpty(state *terraform.State) bool {
return state.Empty() || !state.HasResources()
}
func planIsEmpty(plan *tfjson.Plan) bool {
for _, rc := range plan.ResourceChanges {
for _, a := range rc.Change.Actions {
if a != tfjson.ActionNoop {
return false
}
}
}
return true
}
func testIDRefresh(ctx context.Context, t testing.T, c TestCase, wd *plugintest.WorkingDir, step TestStep, r *terraform.ResourceState, providers *providerFactories) error {
t.Helper()
// Build the state. The state is just the resource with an ID. There
// are no attributes. We only set what is needed to perform a refresh.
state := terraform.NewState()
state.RootModule().Resources = make(map[string]*terraform.ResourceState)
state.RootModule().Resources[c.IDRefreshName] = &terraform.ResourceState{}
// Temporarily set the config to a minimal provider config for the refresh
// test. After the refresh we can reset it.
err := wd.SetConfig(ctx, c.providerConfig(ctx, step.configHasProviderBlock(ctx)))
if err != nil {
t.Fatalf("Error setting import test config: %s", err)
}
defer func() {
err = wd.SetConfig(ctx, step.Config)
if err != nil {
t.Fatalf("Error resetting test config: %s", err)
}
}()
// Refresh!
err = runProviderCommand(ctx, t, func() error {
err = wd.Refresh(ctx)
if err != nil {
t.Fatalf("Error running terraform refresh: %s", err)
}
state, err = getState(ctx, t, wd)
if err != nil {
return err
}
return nil
}, wd, providers)
if err != nil {
return err
}
// Verify attribute equivalence.
actualR := state.RootModule().Resources[c.IDRefreshName]
if actualR == nil {
return fmt.Errorf("Resource gone!")
}
if actualR.Primary == nil {
return fmt.Errorf("Resource has no primary instance")
}
actual := actualR.Primary.Attributes
expected := r.Primary.Attributes
if len(c.IDRefreshIgnore) > 0 {
logging.HelperResourceTrace(ctx, fmt.Sprintf("Using TestCase IDRefreshIgnore: %v", c.IDRefreshIgnore))
}
// Remove fields we're ignoring
for _, v := range c.IDRefreshIgnore {
for k := range actual {
if strings.HasPrefix(k, v) {
delete(actual, k)
}
}
for k := range expected {
if strings.HasPrefix(k, v) {
delete(expected, k)
}
}
}
if !reflect.DeepEqual(actual, expected) {
// Determine only the different attributes
for k, v := range expected {
if av, ok := actual[k]; ok && v == av {
delete(expected, k)
delete(actual, k)
}
}
if diff := cmp.Diff(expected, actual); diff != "" {
return fmt.Errorf("IDRefreshName attributes not equivalent. Difference is shown below. The - symbol indicates attributes missing after refresh.\n\n%s", diff)
}
}
return nil
}