910ccdb092
Bumps [github.com/hashicorp/terraform-plugin-sdk/v2](https://github.com/hashicorp/terraform-plugin-sdk) from 2.26.1 to 2.27.0. - [Release notes](https://github.com/hashicorp/terraform-plugin-sdk/releases) - [Changelog](https://github.com/hashicorp/terraform-plugin-sdk/blob/main/CHANGELOG.md) - [Commits](https://github.com/hashicorp/terraform-plugin-sdk/compare/v2.26.1...v2.27.0) --- updated-dependencies: - dependency-name: github.com/hashicorp/terraform-plugin-sdk/v2 dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com>
245 lines
6.6 KiB
Go
245 lines
6.6 KiB
Go
// Copyright (c) HashiCorp, Inc.
|
|
// SPDX-License-Identifier: MPL-2.0
|
|
|
|
package resource
|
|
|
|
import (
|
|
"context"
|
|
"errors"
|
|
"fmt"
|
|
|
|
tfjson "github.com/hashicorp/terraform-json"
|
|
testing "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 testStepNewConfig(ctx context.Context, t testing.T, c TestCase, wd *plugintest.WorkingDir, step TestStep, providers *providerFactories) error {
|
|
t.Helper()
|
|
|
|
err := wd.SetConfig(ctx, step.mergedConfig(ctx, c))
|
|
if err != nil {
|
|
return fmt.Errorf("Error setting config: %w", err)
|
|
}
|
|
|
|
// require a refresh before applying
|
|
// failing to do this will result in data sources not being updated
|
|
err = runProviderCommand(ctx, t, func() error {
|
|
return wd.Refresh(ctx)
|
|
}, wd, providers)
|
|
if err != nil {
|
|
return fmt.Errorf("Error running pre-apply refresh: %w", err)
|
|
}
|
|
|
|
// If this step is a PlanOnly step, skip over this first Plan and
|
|
// subsequent Apply, and use the follow-up Plan that checks for
|
|
// permadiffs
|
|
if !step.PlanOnly {
|
|
logging.HelperResourceDebug(ctx, "Running Terraform CLI plan and apply")
|
|
|
|
// Plan!
|
|
err := runProviderCommand(ctx, t, func() error {
|
|
if step.Destroy {
|
|
return wd.CreateDestroyPlan(ctx)
|
|
}
|
|
return wd.CreatePlan(ctx)
|
|
}, wd, providers)
|
|
if err != nil {
|
|
return fmt.Errorf("Error running pre-apply plan: %w", err)
|
|
}
|
|
|
|
// We need to keep a copy of the state prior to destroying such
|
|
// that the destroy steps can verify their behavior in the
|
|
// check function
|
|
var stateBeforeApplication *terraform.State
|
|
err = runProviderCommand(ctx, t, func() error {
|
|
stateBeforeApplication, err = getState(ctx, t, wd)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return nil
|
|
}, wd, providers)
|
|
if err != nil {
|
|
return fmt.Errorf("Error retrieving pre-apply state: %w", err)
|
|
}
|
|
|
|
// Apply the diff, creating real resources
|
|
err = runProviderCommand(ctx, t, func() error {
|
|
return wd.Apply(ctx)
|
|
}, wd, providers)
|
|
if err != nil {
|
|
if step.Destroy {
|
|
return fmt.Errorf("Error running destroy: %w", err)
|
|
}
|
|
return fmt.Errorf("Error running apply: %w", err)
|
|
}
|
|
|
|
// Get the new state
|
|
var state *terraform.State
|
|
err = runProviderCommand(ctx, t, func() error {
|
|
state, err = getState(ctx, t, wd)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return nil
|
|
}, wd, providers)
|
|
if err != nil {
|
|
return fmt.Errorf("Error retrieving state after apply: %w", err)
|
|
}
|
|
|
|
// Run any configured checks
|
|
if step.Check != nil {
|
|
logging.HelperResourceTrace(ctx, "Using TestStep Check")
|
|
|
|
state.IsBinaryDrivenTest = true
|
|
if step.Destroy {
|
|
if err := step.Check(stateBeforeApplication); err != nil {
|
|
return fmt.Errorf("Check failed: %w", err)
|
|
}
|
|
} else {
|
|
if err := step.Check(state); err != nil {
|
|
return fmt.Errorf("Check failed: %w", err)
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
// Test for perpetual diffs by performing a plan, a refresh, and another plan
|
|
logging.HelperResourceDebug(ctx, "Running Terraform CLI plan to check for perpetual differences")
|
|
|
|
// do a plan
|
|
err = runProviderCommand(ctx, t, func() error {
|
|
if step.Destroy {
|
|
return wd.CreateDestroyPlan(ctx)
|
|
}
|
|
return wd.CreatePlan(ctx)
|
|
}, wd, providers)
|
|
if err != nil {
|
|
return fmt.Errorf("Error running post-apply plan: %w", err)
|
|
}
|
|
|
|
var plan *tfjson.Plan
|
|
err = runProviderCommand(ctx, t, func() error {
|
|
var err error
|
|
plan, err = wd.SavedPlan(ctx)
|
|
return err
|
|
}, wd, providers)
|
|
if err != nil {
|
|
return fmt.Errorf("Error retrieving post-apply plan: %w", err)
|
|
}
|
|
|
|
if !planIsEmpty(plan) && !step.ExpectNonEmptyPlan {
|
|
var stdout string
|
|
err = runProviderCommand(ctx, t, func() error {
|
|
var err error
|
|
stdout, err = wd.SavedPlanRawStdout(ctx)
|
|
return err
|
|
}, wd, providers)
|
|
if err != nil {
|
|
return fmt.Errorf("Error retrieving formatted plan output: %w", err)
|
|
}
|
|
return fmt.Errorf("After applying this test step, the plan was not empty.\nstdout:\n\n%s", stdout)
|
|
}
|
|
|
|
// do a refresh
|
|
if !step.Destroy || (step.Destroy && !step.PreventPostDestroyRefresh) {
|
|
err := runProviderCommand(ctx, t, func() error {
|
|
return wd.Refresh(ctx)
|
|
}, wd, providers)
|
|
if err != nil {
|
|
return fmt.Errorf("Error running post-apply refresh: %w", err)
|
|
}
|
|
}
|
|
|
|
// do another plan
|
|
err = runProviderCommand(ctx, t, func() error {
|
|
if step.Destroy {
|
|
return wd.CreateDestroyPlan(ctx)
|
|
}
|
|
return wd.CreatePlan(ctx)
|
|
}, wd, providers)
|
|
if err != nil {
|
|
return fmt.Errorf("Error running second post-apply plan: %w", err)
|
|
}
|
|
|
|
err = runProviderCommand(ctx, t, func() error {
|
|
var err error
|
|
plan, err = wd.SavedPlan(ctx)
|
|
return err
|
|
}, wd, providers)
|
|
if err != nil {
|
|
return fmt.Errorf("Error retrieving second post-apply plan: %w", err)
|
|
}
|
|
|
|
// check if plan is empty
|
|
if !planIsEmpty(plan) && !step.ExpectNonEmptyPlan {
|
|
var stdout string
|
|
err = runProviderCommand(ctx, t, func() error {
|
|
var err error
|
|
stdout, err = wd.SavedPlanRawStdout(ctx)
|
|
return err
|
|
}, wd, providers)
|
|
if err != nil {
|
|
return fmt.Errorf("Error retrieving formatted second plan output: %w", err)
|
|
}
|
|
return fmt.Errorf("After applying this test step and performing a `terraform refresh`, the plan was not empty.\nstdout\n\n%s", stdout)
|
|
} else if step.ExpectNonEmptyPlan && planIsEmpty(plan) {
|
|
return errors.New("Expected a non-empty plan, but got an empty plan")
|
|
}
|
|
|
|
// ID-ONLY REFRESH
|
|
// If we've never checked an id-only refresh and our state isn't
|
|
// empty, find the first resource and test it.
|
|
if c.IDRefreshName != "" {
|
|
logging.HelperResourceTrace(ctx, "Using TestCase IDRefreshName")
|
|
|
|
var state *terraform.State
|
|
|
|
err = runProviderCommand(ctx, t, func() error {
|
|
state, err = getState(ctx, t, wd)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
return nil
|
|
}, wd, providers)
|
|
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
if state.Empty() {
|
|
return nil
|
|
}
|
|
|
|
var idRefreshCheck *terraform.ResourceState
|
|
|
|
// Find the first non-nil resource in the state
|
|
for _, m := range state.Modules {
|
|
if len(m.Resources) > 0 {
|
|
if v, ok := m.Resources[c.IDRefreshName]; ok {
|
|
idRefreshCheck = v
|
|
}
|
|
|
|
break
|
|
}
|
|
}
|
|
|
|
// If we have an instance to check for refreshes, do it
|
|
// immediately. We do it in the middle of another test
|
|
// because it shouldn't affect the overall state (refresh
|
|
// is read-only semantically) and we want to fail early if
|
|
// this fails. If refresh isn't read-only, then this will have
|
|
// caught a different bug.
|
|
if idRefreshCheck != nil {
|
|
if err := testIDRefresh(ctx, t, c, wd, step, idRefreshCheck, providers); err != nil {
|
|
return fmt.Errorf(
|
|
"[ERROR] Test: ID-only test failed: %s", err)
|
|
}
|
|
}
|
|
}
|
|
|
|
return nil
|
|
}
|