Files
opentf/internal/command/show_test.go
Martin Atkins a800d250e5 command: "go fix" on various files we've changed recently anyway
We don't typically just broadly run automatic rewriting tools like "go fix"
across our codebase because that tends to cause annoying and unnecessary
merge conflicts when we're backporting to earlier release branches.

But all of the files in this commit were changed in some non-trivial way
already during the OpenTofu v1.11 development period anyway, and so the
likelyhood we'd be able to successfully backport from them is reduced and
therefore this seems like a good opportunity to do some focused
modernization using "go fix".

My rules for what to include or not are admittedly quite "vibes-based", but
the general idea was:

 - Focusing on files under the "command" directory only, because that's
   already been an area of intentional refactoring during this development
   period.
 - If the existing diff in a file is already significantly larger than
   the changes the fixer proposed to make, or if the fixer is proposing
   to change a line that was already changed in this development period.
 - More willing to include "_test.go" files than non-test files, even if
   they hadn't changed as much already, just because backports from test
   files for bug fixes tend to be entirely new test cases more than they
   are modifications to existing test cases, and so the risk of conflicts
   is lower there.

Signed-off-by: Martin Atkins <mart@degeneration.co.uk>
2026-03-17 15:25:30 -07:00

1746 lines
44 KiB
Go

// Copyright (c) The OpenTofu Authors
// SPDX-License-Identifier: MPL-2.0
// Copyright (c) 2023 HashiCorp, Inc.
// SPDX-License-Identifier: MPL-2.0
package command
import (
"encoding/json"
"io"
"os"
"path/filepath"
"strings"
"syscall"
"testing"
"github.com/google/go-cmp/cmp"
"github.com/opentofu/opentofu/internal/command/workdir"
"github.com/zclconf/go-cty/cty"
"github.com/opentofu/opentofu/internal/addrs"
"github.com/opentofu/opentofu/internal/configs/configschema"
"github.com/opentofu/opentofu/internal/plans"
"github.com/opentofu/opentofu/internal/providers"
"github.com/opentofu/opentofu/internal/states"
"github.com/opentofu/opentofu/internal/states/statemgr"
"github.com/opentofu/opentofu/internal/tofu"
"github.com/opentofu/opentofu/version"
)
func TestShow_badArgs(t *testing.T) {
view, done := testView(t)
c := &ShowCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(testProvider()),
View: view,
},
}
args := []string{
"bad",
"bad",
"-no-color",
}
code := c.Run(args)
output := done(t)
if code != 1 {
t.Fatalf("unexpected exit status %d; want 1\ngot: %s", code, output.Stdout())
}
}
func TestShow_noArgsNoState(t *testing.T) {
view, done := testView(t)
c := &ShowCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(testProvider()),
View: view,
},
}
code := c.Run([]string{})
output := done(t)
if code != 0 {
t.Fatalf("unexpected exit status %d; want 0\ngot: %s", code, output.Stderr())
}
got := output.Stdout()
want := `No state.`
if !strings.Contains(got, want) {
t.Fatalf("unexpected output\ngot: %s\nwant: %s", got, want)
}
}
func TestShow_noArgsWithState(t *testing.T) {
// Get a temp cwd
testCwdTemp(t)
// Create the default state
testStateFileDefault(t, testState())
view, done := testView(t)
c := &ShowCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(showFixtureProvider()),
View: view,
},
}
code := c.Run([]string{})
output := done(t)
if code != 0 {
t.Fatalf("unexpected exit status %d; want 0\ngot: %s", code, output.Stderr())
}
got := output.Stdout()
want := `# test_instance.foo:`
if !strings.Contains(got, want) {
t.Fatalf("unexpected output\ngot: %s\nwant: %s", got, want)
}
}
func TestShow_argsWithState(t *testing.T) {
// Create the default state
statePath := testStateFile(t, testState())
t.Chdir(filepath.Dir(statePath))
view, done := testView(t)
c := &ShowCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(showFixtureProvider()),
View: view,
},
}
path := filepath.Base(statePath)
args := []string{
path,
"-no-color",
}
code := c.Run(args)
output := done(t)
if code != 0 {
t.Fatalf("unexpected exit status %d; want 0\ngot: %s", code, output.Stderr())
}
}
// https://github.com/hashicorp/terraform/issues/21462
func TestShow_argsWithStateAliasedProvider(t *testing.T) {
// Create the default state with aliased resource
testState := states.BuildState(func(s *states.SyncState) {
s.SetResourceInstanceCurrent(
addrs.Resource{
Mode: addrs.ManagedResourceMode,
Type: "test_instance",
Name: "foo",
}.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance),
&states.ResourceInstanceObjectSrc{
// The weird whitespace here is reflective of how this would
// get written out in a real state file, due to the indentation
// of all of the containing wrapping objects and arrays.
AttrsJSON: []byte("{\n \"id\": \"bar\"\n }"),
Status: states.ObjectReady,
Dependencies: []addrs.ConfigResource{},
},
addrs.RootModuleInstance.ProviderConfigAliased(addrs.NewDefaultProvider("test"), "alias"),
addrs.NoKey,
)
})
statePath := testStateFile(t, testState)
t.Chdir(filepath.Dir(statePath))
view, done := testView(t)
c := &ShowCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(showFixtureProvider()),
View: view,
},
}
path := filepath.Base(statePath)
args := []string{
path,
"-no-color",
}
code := c.Run(args)
output := done(t)
if code != 0 {
t.Fatalf("unexpected exit status %d; want 0\ngot: %s", code, output.Stderr())
}
got := output.Stdout()
want := `# missing schema for provider \"test.alias\"`
if strings.Contains(got, want) {
t.Fatalf("unexpected output\ngot: %s", got)
}
}
func TestShow_argsPlanFileDoesNotExist(t *testing.T) {
tests := map[string][]string{
"modern": {"-plan=doesNotExist.tfplan", "-no-color"},
"legacy": {"doesNotExist.tfplan", "-no-color"},
}
for name, args := range tests {
t.Run(name, func(t *testing.T) {
view, done := testView(t)
c := &ShowCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(testProvider()),
View: view,
},
}
code := c.Run(args)
output := done(t)
if code != 1 {
t.Fatalf("unexpected exit status %d; want 1\ngot: %s", code, output.Stdout())
}
got := output.Stderr()
want1 := `couldn't load the provided path`
want2 := `open doesNotExist.tfplan: ` + syscall.ENOENT.Error()
if !strings.Contains(got, want1) {
t.Errorf("unexpected output\ngot: %s\nwant:\n%s", got, want1)
}
if !strings.Contains(got, want2) {
t.Errorf("unexpected output\ngot: %s\nwant:\n%s", got, want2)
}
})
}
}
func TestShow_argsStatefileDoesNotExist(t *testing.T) {
view, done := testView(t)
c := &ShowCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(testProvider()),
View: view,
},
}
args := []string{
"doesNotExist.tfstate",
"-no-color",
}
code := c.Run(args)
output := done(t)
if code != 1 {
t.Fatalf("unexpected exit status %d; want 1\ngot: %s", code, output.Stdout())
}
got := output.Stderr()
want := `State read error: Error loading statefile:`
if !strings.Contains(got, want) {
t.Errorf("unexpected output\ngot: %s\nwant:\n%s", got, want)
}
}
func TestShow_json_argsPlanFileDoesNotExist(t *testing.T) {
tests := map[string][]string{
"modern": {"-plan=doesNotExist.tfplan", "-json", "-no-color"},
"legacy": {"-json", "doesNotExist.tfplan", "-no-color"},
}
for name, args := range tests {
t.Run(name, func(t *testing.T) {
view, done := testView(t)
c := &ShowCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(testProvider()),
View: view,
},
}
code := c.Run(args)
output := done(t)
if code != 1 {
t.Fatalf("unexpected exit status %d; want 1\ngot: %s", code, output.Stdout())
}
got := output.Stderr()
want1 := `couldn't load the provided path`
want2 := `open doesNotExist.tfplan: ` + syscall.ENOENT.Error()
if !strings.Contains(got, want1) {
t.Errorf("unexpected output\ngot: %s\nwant:\n%s", got, want1)
}
if !strings.Contains(got, want2) {
t.Errorf("unexpected output\ngot: %s\nwant:\n%s", got, want2)
}
})
}
}
func TestShow_json_argsStatefileDoesNotExist(t *testing.T) {
view, done := testView(t)
c := &ShowCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(testProvider()),
View: view,
},
}
args := []string{
"-json",
"doesNotExist.tfstate",
"-no-color",
}
code := c.Run(args)
output := done(t)
if code != 1 {
t.Fatalf("unexpected exit status %d; want 1\ngot: %s", code, output.Stdout())
}
got := output.Stderr()
want := `State read error: Error loading statefile:`
if !strings.Contains(got, want) {
t.Errorf("unexpected output\ngot: %s\nwant:\n%s", got, want)
}
}
func TestShow_planNoop(t *testing.T) {
planPath := testPlanFileNoop(t)
tests := map[string][]string{
"modern": {"-plan=" + planPath, "-no-color"},
"legacy": {planPath, "-no-color"},
}
for name, args := range tests {
t.Run(name, func(t *testing.T) {
view, done := testView(t)
c := &ShowCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(testProvider()),
View: view,
},
}
code := c.Run(args)
output := done(t)
if code != 0 {
t.Fatalf("unexpected exit status %d; want 0\ngot: %s", code, output.Stderr())
}
got := output.Stdout()
want := `No changes. Your infrastructure matches the configuration.`
if !strings.Contains(got, want) {
t.Errorf("unexpected output\ngot: %s\nwant:\n%s", got, want)
}
})
}
}
func TestShow_planWithChanges(t *testing.T) {
planPathWithChanges := showFixturePlanFile(t, plans.DeleteThenCreate)
tests := map[string][]string{
"modern": {"-plan=" + planPathWithChanges, "-no-color"},
"legacy": {planPathWithChanges, "-no-color"},
}
for name, args := range tests {
t.Run(name, func(t *testing.T) {
view, done := testView(t)
c := &ShowCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(showFixtureProvider()),
View: view,
},
}
code := c.Run(args)
output := done(t)
if code != 0 {
t.Fatalf("unexpected exit status %d; want 0\ngot: %s", code, output.Stderr())
}
got := output.Stdout()
want := `test_instance.foo must be replaced`
if !strings.Contains(got, want) {
t.Fatalf("unexpected output\ngot: %s\nwant: %s", got, want)
}
})
}
}
func TestShow_planWithForceReplaceChange(t *testing.T) {
// The main goal of this test is to see that the "replace by request"
// resource instance action reason can round-trip through a plan file and
// be reflected correctly in the "tofu show" output, the same way
// as it would appear in "tofu plan" output.
_, snap := testModuleWithSnapshot(t, "show")
plannedVal := cty.ObjectVal(map[string]cty.Value{
"id": cty.UnknownVal(cty.String),
"ami": cty.StringVal("bar"),
})
priorValRaw, err := plans.NewDynamicValue(cty.NullVal(plannedVal.Type()), plannedVal.Type())
if err != nil {
t.Fatal(err)
}
plannedValRaw, err := plans.NewDynamicValue(plannedVal, plannedVal.Type())
if err != nil {
t.Fatal(err)
}
plan := testPlan(t)
plan.Changes.SyncWrapper().AppendResourceInstanceChange(&plans.ResourceInstanceChangeSrc{
Addr: addrs.Resource{
Mode: addrs.ManagedResourceMode,
Type: "test_instance",
Name: "foo",
}.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance),
ProviderAddr: addrs.AbsProviderConfig{
Provider: addrs.NewDefaultProvider("test"),
Module: addrs.RootModule,
},
ChangeSrc: plans.ChangeSrc{
Action: plans.CreateThenDelete,
Before: priorValRaw,
After: plannedValRaw,
},
ActionReason: plans.ResourceInstanceReplaceByRequest,
})
planFilePath := testPlanFile(
t,
snap,
states.NewState(),
plan,
)
view, done := testView(t)
c := &ShowCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(showFixtureProvider()),
View: view,
},
}
args := []string{
"-plan=" + planFilePath,
"-no-color",
}
code := c.Run(args)
output := done(t)
if code != 0 {
t.Fatalf("unexpected exit status %d; want 0\ngot: %s", code, output.Stderr())
}
got := output.Stdout()
want := `test_instance.foo will be replaced, as requested`
if !strings.Contains(got, want) {
t.Fatalf("unexpected output\ngot: %s\nwant: %s", got, want)
}
want = `Plan: 1 to add, 0 to change, 1 to destroy.`
if !strings.Contains(got, want) {
t.Fatalf("unexpected output\ngot: %s\nwant: %s", got, want)
}
}
func TestShow_planErrored(t *testing.T) {
_, snap := testModuleWithSnapshot(t, "show")
plan := testPlan(t)
plan.Errored = true
planFilePath := testPlanFile(
t,
snap,
states.NewState(),
plan,
)
view, done := testView(t)
c := &ShowCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(showFixtureProvider()),
View: view,
},
}
args := []string{
"-plan=" + planFilePath,
"-no-color",
}
code := c.Run(args)
output := done(t)
if code != 0 {
t.Fatalf("unexpected exit status %d; want 0\ngot: %s", code, output.Stderr())
}
got := output.Stdout()
want := `Planning failed. OpenTofu encountered an error while generating this plan.`
if !strings.Contains(got, want) {
t.Fatalf("unexpected output\ngot: %s\nwant: %s", got, want)
}
}
func TestShow_plan_json(t *testing.T) {
planPath := showFixturePlanFile(t, plans.Create)
view, done := testView(t)
c := &ShowCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(showFixtureProvider()),
View: view,
},
}
args := []string{
"-plan=" + planPath,
"-json",
"-no-color",
}
code := c.Run(args)
output := done(t)
if code != 0 {
t.Fatalf("unexpected exit status %d; want 0\ngot: %s", code, output.Stderr())
}
}
func TestShow_state(t *testing.T) {
originalState := testState()
root := originalState.RootModule()
root.SetOutputValue("test", cty.ObjectVal(map[string]cty.Value{
"attr": cty.NullVal(cty.DynamicPseudoType),
"null": cty.NullVal(cty.String),
"list": cty.ListVal([]cty.Value{cty.NullVal(cty.Number)}),
}), false, "")
statePath := testStateFile(t, originalState)
defer os.RemoveAll(filepath.Dir(statePath))
view, done := testView(t)
c := &ShowCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(showFixtureProvider()),
View: view,
},
}
args := []string{
statePath,
"-no-color",
}
code := c.Run(args)
output := done(t)
if code != 0 {
t.Fatalf("unexpected exit status %d; want 0\ngot: %s", code, output.Stderr())
}
}
func TestShow_json_output(t *testing.T) {
fixtureDir := "testdata/show-json"
testDirs, err := os.ReadDir(fixtureDir)
if err != nil {
t.Fatal(err)
}
for _, entry := range testDirs {
if !entry.IsDir() {
continue
}
t.Run(entry.Name(), func(t *testing.T) {
td := t.TempDir()
inputDir := filepath.Join(fixtureDir, entry.Name())
testCopyDir(t, inputDir, td)
t.Chdir(td)
expectError := strings.Contains(entry.Name(), "error")
providerSource, close := newMockProviderSource(t, map[string][]string{
"test": {"1.2.3"},
"hashicorp2/test": {"1.2.3"},
})
defer close()
p := showFixtureProvider()
// init
view, done := testView(t)
ic := &InitCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(p),
View: view,
ProviderSource: providerSource,
},
}
code := ic.Run([]string{})
output := done(t)
if code != 0 {
if expectError {
// this should error, but not panic.
return
}
t.Fatalf("init failed\n%s", output.Stderr())
}
// read expected output
wantFile, err := os.Open("output.json")
if err != nil {
t.Fatalf("unexpected err: %s", err)
}
defer wantFile.Close()
byteValue, err := io.ReadAll(wantFile)
if err != nil {
t.Fatalf("unexpected err: %s", err)
}
var want plan
if err := json.Unmarshal([]byte(byteValue), &want); err != nil {
t.Fatal(err)
}
// plan
planView, planDone := testView(t)
pc := &PlanCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(p),
View: planView,
ProviderSource: providerSource,
},
}
args := []string{
"-out=tofu.plan",
}
code = pc.Run(args)
planOutput := planDone(t)
var wantedCode int
if want.Errored {
wantedCode = 1
} else {
wantedCode = 0
}
if code != wantedCode {
t.Fatalf("unexpected exit status %d; want %d\ngot: %s", code, wantedCode, planOutput.Stderr())
}
// show
showView, showDone := testView(t)
sc := &ShowCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(p),
View: showView,
ProviderSource: providerSource,
},
}
args = []string{
"-json",
"tofu.plan",
}
defer os.Remove("tofu.plan")
code = sc.Run(args)
showOutput := showDone(t)
if code != 0 {
t.Fatalf("unexpected exit status %d; want 0\ngot: %s", code, showOutput.Stderr())
}
// compare view output to wanted output
var got plan
gotString := showOutput.Stdout()
if err := json.Unmarshal([]byte(gotString), &got); err != nil {
t.Fatal(err)
}
// Disregard format version to reduce needless test fixture churn
want.FormatVersion = got.FormatVersion
if diff := cmp.Diff(want, got); diff != "" {
t.Fatal("wrong result:\n" + diff)
}
})
}
}
func TestShow_json_output_sensitive(t *testing.T) {
td := t.TempDir()
inputDir := "testdata/show-json-sensitive"
testCopyDir(t, inputDir, td)
t.Chdir(td)
providerSource, close := newMockProviderSource(t, map[string][]string{"test": {"1.2.3"}})
defer close()
p := showFixtureSensitiveProvider()
// init
initView, initDone := testView(t)
ic := &InitCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(p),
View: initView,
ProviderSource: providerSource,
},
}
code := ic.Run([]string{})
output := initDone(t)
if code != 0 {
t.Fatalf("init failed\n%s", output.Stderr())
}
// plan
planView, planDone := testView(t)
pc := &PlanCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(p),
View: planView,
ProviderSource: providerSource,
},
}
args := []string{
"-out=tofu.plan",
}
code = pc.Run(args)
planOutput := planDone(t)
if code != 0 {
t.Fatalf("unexpected exit status %d; want 0\ngot: %s", code, planOutput.Stderr())
}
// show
showView, showDone := testView(t)
sc := &ShowCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(p),
View: showView,
ProviderSource: providerSource,
},
}
args = []string{
"-json",
"-plan=tofu.plan",
}
defer os.Remove("tofu.plan")
code = sc.Run(args)
showOutput := showDone(t)
if code != 0 {
t.Fatalf("unexpected exit status %d; want 0\ngot: %s", code, showOutput.Stderr())
}
// compare ui output to wanted output
var got, want plan
gotString := showOutput.Stdout()
if err := json.Unmarshal([]byte(gotString), &got); err != nil {
t.Fatal(err)
}
wantFile, err := os.Open("output.json")
if err != nil {
t.Fatalf("unexpected err: %s", err)
}
defer wantFile.Close()
byteValue, err := io.ReadAll(wantFile)
if err != nil {
t.Fatalf("unexpected err: %s", err)
}
if err := json.Unmarshal([]byte(byteValue), &want); err != nil {
t.Fatal(err)
}
// Disregard format version to reduce needless test fixture churn
want.FormatVersion = got.FormatVersion
if !cmp.Equal(got, want) {
t.Fatalf("wrong result:\n %v\n", cmp.Diff(got, want))
}
}
// Failing conditions are only present in JSON output for refresh-only plans,
// so we test that separately here.
func TestShow_json_output_conditions_refresh_only(t *testing.T) {
td := t.TempDir()
inputDir := "testdata/show-json/conditions"
testCopyDir(t, inputDir, td)
t.Chdir(td)
providerSource, close := newMockProviderSource(t, map[string][]string{"test": {"1.2.3"}})
defer close()
p := showFixtureSensitiveProvider()
// init
initView, initDone := testView(t)
ic := &InitCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(p),
ProviderSource: providerSource,
View: initView,
},
}
initCode := ic.Run([]string{})
output := initDone(t)
if initCode != 0 {
t.Fatalf("init failed\n%s", output.Stderr())
}
// plan
planView, planDone := testView(t)
pc := &PlanCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(p),
View: planView,
ProviderSource: providerSource,
},
}
args := []string{
"-refresh-only",
"-out=tofu.plan",
"-var=ami=bad-ami",
"-state=for-refresh.tfstate",
}
code := pc.Run(args)
planOutput := planDone(t)
if code != 0 {
t.Fatalf("unexpected exit status %d; want 0\ngot: %s", code, planOutput.Stderr())
}
// show
showView, showDone := testView(t)
sc := &ShowCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(p),
View: showView,
ProviderSource: providerSource,
},
}
args = []string{
"-json",
"-plan=tofu.plan",
}
defer os.Remove("tofu.plan")
code = sc.Run(args)
showOutput := showDone(t)
if code != 0 {
t.Fatalf("unexpected exit status %d; want 0\ngot: %s", code, showOutput.Stderr())
}
// compare JSON output to wanted output
var got, want plan
gotString := showOutput.Stdout()
if err := json.Unmarshal([]byte(gotString), &got); err != nil {
t.Fatal(err)
}
wantFile, err := os.Open("output-refresh-only.json")
if err != nil {
t.Fatalf("unexpected err: %s", err)
}
defer wantFile.Close()
byteValue, err := io.ReadAll(wantFile)
if err != nil {
t.Fatalf("unexpected err: %s", err)
}
if err := json.Unmarshal([]byte(byteValue), &want); err != nil {
t.Fatal(err)
}
// Disregard format version to reduce needless test fixture churn
want.FormatVersion = got.FormatVersion
if diff := cmp.Diff(want, got); diff != "" {
t.Fatal("wrong result:\n" + diff)
}
}
// similar test as above, without the plan
func TestShow_json_output_state(t *testing.T) {
fixtureDir := "testdata/show-json-state"
testDirs, err := os.ReadDir(fixtureDir)
if err != nil {
t.Fatal(err)
}
for _, entry := range testDirs {
if !entry.IsDir() {
continue
}
t.Run(entry.Name(), func(t *testing.T) {
td := t.TempDir()
inputDir := filepath.Join(fixtureDir, entry.Name())
testCopyDir(t, inputDir, td)
t.Chdir(td)
providerSource, close := newMockProviderSource(t, map[string][]string{
"test": {"1.2.3"},
})
defer close()
p := showFixtureProvider()
// init
initView, initDone := testView(t)
ic := &InitCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(p),
View: initView,
ProviderSource: providerSource,
},
}
initCode := ic.Run([]string{})
output := initDone(t)
if initCode != 0 {
t.Fatalf("init failed\n%s", output.Stderr())
}
// show
showView, showDone := testView(t)
sc := &ShowCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(p),
View: showView,
ProviderSource: providerSource,
},
}
code := sc.Run([]string{"-state", "-json"})
showOutput := showDone(t)
if code != 0 {
t.Fatalf("unexpected exit status %d; want 0\ngot: %s", code, showOutput.Stderr())
}
// compare ui output to wanted output
type state struct {
FormatVersion string `json:"format_version,omitempty"`
TerraformVersion string `json:"terraform_version"`
Values map[string]any `json:"values,omitempty"`
SensitiveValues map[string]bool `json:"sensitive_values,omitempty"`
}
var got, want state
gotString := showOutput.Stdout()
err := json.Unmarshal([]byte(gotString), &got)
if err != nil {
t.Fatalf("invalid JSON output: %s\n%s", err, gotString)
}
wantFile, err := os.Open("output.json")
if err != nil {
t.Fatalf("unexpected error: %s", err)
}
defer wantFile.Close()
byteValue, err := io.ReadAll(wantFile)
if err != nil {
t.Fatalf("unexpected err: %s", err)
}
if err := json.Unmarshal([]byte(byteValue), &want); err != nil {
t.Fatal(err)
}
if !cmp.Equal(got, want) {
t.Fatalf("wrong result:\n %v\n", cmp.Diff(got, want))
}
})
}
}
func TestShow_planWithNonDefaultStateLineage(t *testing.T) {
// Create a temporary working directory that is empty
td := t.TempDir()
testCopyDir(t, testFixturePath("show"), td)
t.Chdir(td)
// Write default state file with a testing lineage ("fake-for-testing")
testStateFileDefault(t, testState())
// Create a plan with a different lineage, which we should still be able
// to show
_, snap := testModuleWithSnapshot(t, "show")
state := testState()
plan := testPlan(t)
stateMeta := statemgr.SnapshotMeta{
Lineage: "fake-for-plan",
Serial: 1,
TerraformVersion: version.SemVer,
}
planPath := testPlanFileMatchState(t, snap, state, plan, stateMeta)
view, done := testView(t)
c := &ShowCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(testProvider()),
View: view,
},
}
args := []string{
"-plan=" + planPath,
"-no-color",
}
code := c.Run(args)
output := done(t)
if code != 0 {
t.Fatalf("unexpected exit status %d; want 0\ngot: %s", code, output.Stderr())
}
got := output.Stdout()
want := `No changes. Your infrastructure matches the configuration.`
if !strings.Contains(got, want) {
t.Fatalf("unexpected output\ngot: %s\nwant: %s", got, want)
}
}
func TestShow_corruptStatefile(t *testing.T) {
td := t.TempDir()
inputDir := "testdata/show-corrupt-statefile"
testCopyDir(t, inputDir, td)
t.Chdir(td)
view, done := testView(t)
c := &ShowCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(testProvider()),
View: view,
},
}
code := c.Run([]string{})
output := done(t)
if code != 1 {
t.Fatalf("unexpected exit status %d; want 1\ngot: %s", code, output.Stdout())
}
got := output.Stderr()
want := `Unsupported state file format`
if !strings.Contains(got, want) {
t.Errorf("unexpected output\ngot: %s\nwant:\n%s", got, want)
}
}
func TestShow_showSensitiveArg(t *testing.T) {
td := t.TempDir()
t.Chdir(td)
originalState := stateWithSensitiveValueForShow()
testStateFileDefault(t, originalState)
view, done := testView(t)
c := &ShowCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(testProvider()),
View: view,
},
}
args := []string{
"-show-sensitive",
}
code := c.Run(args)
output := done(t)
if code != 0 {
t.Fatalf("bad: \n%s", output.Stderr())
}
actual := strings.TrimSpace(output.Stdout())
expected := "Outputs:\n\nfoo = \"bar\""
if actual != expected {
t.Fatalf("got incorrect output: %#v", actual)
}
}
func TestShow_withoutShowSensitiveArg(t *testing.T) {
td := t.TempDir()
t.Chdir(td)
originalState := stateWithSensitiveValueForShow()
testStateFileDefault(t, originalState)
view, done := testView(t)
c := &ShowCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(testProvider()),
View: view,
},
}
code := c.Run([]string{})
output := done(t)
if code != 0 {
t.Fatalf("bad: \n%s", output.Stderr())
}
actual := strings.TrimSpace(output.Stdout())
expected := "Outputs:\n\nfoo = (sensitive value)"
if actual != expected {
t.Fatalf("got incorrect output: %#v", actual)
}
}
// stateWithSensitiveValueForShow return a state with an output value
// marked as sensitive.
func stateWithSensitiveValueForShow() *states.State {
state := states.BuildState(func(s *states.SyncState) {
s.SetOutputValue(
addrs.OutputValue{Name: "foo"}.Absolute(addrs.RootModuleInstance),
cty.StringVal("bar"),
true,
"",
)
})
return state
}
// showFixtureSchema returns a schema suitable for processing the configuration
// in testdata/show. This schema should be assigned to a mock provider
// named "test".
func showFixtureSchema() *providers.GetProviderSchemaResponse {
return &providers.GetProviderSchemaResponse{
Provider: providers.Schema{
Block: &configschema.Block{
Attributes: map[string]*configschema.Attribute{
"region": {Type: cty.String, Optional: true},
},
},
},
ResourceTypes: map[string]providers.Schema{
"test_instance": {
Block: &configschema.Block{
Attributes: map[string]*configschema.Attribute{
"id": {Type: cty.String, Optional: true, Computed: true},
"ami": {Type: cty.String, Optional: true},
},
},
},
},
}
}
// showFixtureSensitiveSchema returns a schema suitable for processing the configuration
// in testdata/show. This schema should be assigned to a mock provider
// named "test". It includes a sensitive attribute.
func showFixtureSensitiveSchema() *providers.GetProviderSchemaResponse {
return &providers.GetProviderSchemaResponse{
Provider: providers.Schema{
Block: &configschema.Block{
Attributes: map[string]*configschema.Attribute{
"region": {Type: cty.String, Optional: true},
},
},
},
ResourceTypes: map[string]providers.Schema{
"test_instance": {
Block: &configschema.Block{
Attributes: map[string]*configschema.Attribute{
"id": {Type: cty.String, Optional: true, Computed: true},
"ami": {Type: cty.String, Optional: true},
"password": {Type: cty.String, Optional: true, Sensitive: true},
},
},
},
},
}
}
// showFixtureProvider returns a mock provider that is configured for basic
// operation with the configuration in testdata/show. This mock has
// GetSchemaResponse, PlanResourceChangeFn, and ApplyResourceChangeFn populated,
// with the plan/apply steps just passing through the data determined by
// OpenTofu Core.
func showFixtureProvider() *tofu.MockProvider {
p := testProvider()
p.GetProviderSchemaResponse = showFixtureSchema()
p.ReadResourceFn = func(req providers.ReadResourceRequest) providers.ReadResourceResponse {
idVal := req.PriorState.GetAttr("id")
amiVal := req.PriorState.GetAttr("ami")
if amiVal.RawEquals(cty.StringVal("refresh-me")) {
amiVal = cty.StringVal("refreshed")
}
return providers.ReadResourceResponse{
NewState: cty.ObjectVal(map[string]cty.Value{
"id": idVal,
"ami": amiVal,
}),
Private: req.Private,
}
}
p.PlanResourceChangeFn = func(req providers.PlanResourceChangeRequest) (resp providers.PlanResourceChangeResponse) {
// this is a destroy plan,
if req.ProposedNewState.IsNull() {
resp.PlannedState = req.ProposedNewState
resp.PlannedPrivate = req.PriorPrivate
return resp
}
idVal := req.ProposedNewState.GetAttr("id")
amiVal := req.ProposedNewState.GetAttr("ami")
if idVal.IsNull() {
idVal = cty.UnknownVal(cty.String)
}
var reqRep []cty.Path
if amiVal.RawEquals(cty.StringVal("force-replace")) {
reqRep = append(reqRep, cty.GetAttrPath("ami"))
}
return providers.PlanResourceChangeResponse{
PlannedState: cty.ObjectVal(map[string]cty.Value{
"id": idVal,
"ami": amiVal,
}),
RequiresReplace: reqRep,
}
}
p.ApplyResourceChangeFn = func(req providers.ApplyResourceChangeRequest) providers.ApplyResourceChangeResponse {
idVal := req.PlannedState.GetAttr("id")
amiVal := req.PlannedState.GetAttr("ami")
if !idVal.IsKnown() {
idVal = cty.StringVal("placeholder")
}
return providers.ApplyResourceChangeResponse{
NewState: cty.ObjectVal(map[string]cty.Value{
"id": idVal,
"ami": amiVal,
}),
}
}
return p
}
// showFixtureSensitiveProvider returns a mock provider that is configured for basic
// operation with the configuration in testdata/show. This mock has
// GetSchemaResponse, PlanResourceChangeFn, and ApplyResourceChangeFn populated,
// with the plan/apply steps just passing through the data determined by
// OpenTofu Core. It also has a sensitive attribute in the provider schema.
func showFixtureSensitiveProvider() *tofu.MockProvider {
p := testProvider()
p.GetProviderSchemaResponse = showFixtureSensitiveSchema()
p.PlanResourceChangeFn = func(req providers.PlanResourceChangeRequest) providers.PlanResourceChangeResponse {
idVal := req.ProposedNewState.GetAttr("id")
if idVal.IsNull() {
idVal = cty.UnknownVal(cty.String)
}
return providers.PlanResourceChangeResponse{
PlannedState: cty.ObjectVal(map[string]cty.Value{
"id": idVal,
"ami": req.ProposedNewState.GetAttr("ami"),
"password": req.ProposedNewState.GetAttr("password"),
}),
}
}
p.ApplyResourceChangeFn = func(req providers.ApplyResourceChangeRequest) providers.ApplyResourceChangeResponse {
idVal := req.PlannedState.GetAttr("id")
if !idVal.IsKnown() {
idVal = cty.StringVal("placeholder")
}
return providers.ApplyResourceChangeResponse{
NewState: cty.ObjectVal(map[string]cty.Value{
"id": idVal,
"ami": req.PlannedState.GetAttr("ami"),
"password": req.PlannedState.GetAttr("password"),
}),
}
}
return p
}
// showFixturePlanFile creates a plan file at a temporary location containing a
// single change to create or update the test_instance.foo that is included in the "show"
// test fixture, returning the location of that plan file.
// `action` is the planned change you would like to elicit
func showFixturePlanFile(t *testing.T, action plans.Action) string {
_, snap := testModuleWithSnapshot(t, "show")
plannedVal := cty.ObjectVal(map[string]cty.Value{
"id": cty.UnknownVal(cty.String),
"ami": cty.StringVal("bar"),
})
priorValRaw, err := plans.NewDynamicValue(cty.NullVal(plannedVal.Type()), plannedVal.Type())
if err != nil {
t.Fatal(err)
}
plannedValRaw, err := plans.NewDynamicValue(plannedVal, plannedVal.Type())
if err != nil {
t.Fatal(err)
}
plan := testPlan(t)
plan.Changes.SyncWrapper().AppendResourceInstanceChange(&plans.ResourceInstanceChangeSrc{
Addr: addrs.Resource{
Mode: addrs.ManagedResourceMode,
Type: "test_instance",
Name: "foo",
}.Instance(addrs.NoKey).Absolute(addrs.RootModuleInstance),
ProviderAddr: addrs.AbsProviderConfig{
Provider: addrs.NewDefaultProvider("test"),
Module: addrs.RootModule,
},
ChangeSrc: plans.ChangeSrc{
Action: action,
Before: priorValRaw,
After: plannedValRaw,
},
})
return testPlanFile(
t,
snap,
states.NewState(),
plan,
)
}
// this simplified plan struct allows us to preserve field order when marshaling
// the command output. NOTE: we are leaving "terraform_version" out of this test
// to avoid needing to constantly update the expected output; as a potential
// TODO we could write a jsonplan compare function.
type plan struct {
FormatVersion string `json:"format_version,omitempty"`
Variables map[string]any `json:"variables,omitempty"`
PlannedValues map[string]any `json:"planned_values,omitempty"`
ResourceDrift []any `json:"resource_drift,omitempty"`
ResourceChanges []any `json:"resource_changes,omitempty"`
OutputChanges map[string]any `json:"output_changes,omitempty"`
PriorState priorState `json:"prior_state"`
Config map[string]any `json:"configuration,omitempty"`
Errored bool `json:"errored"`
}
type priorState struct {
FormatVersion string `json:"format_version,omitempty"`
Values map[string]any `json:"values,omitempty"`
SensitiveValues map[string]bool `json:"sensitive_values,omitempty"`
}
func TestShow_config(t *testing.T) {
// Create a temporary working directory that is empty
td := t.TempDir()
testCopyDir(t, testFixturePath("show-config-module"), td)
t.Chdir(td)
providerSource, close := newMockProviderSource(t, map[string][]string{
"test": {"1.0.0"},
})
defer close()
// Initialize the module
initView, initDone := testView(t)
ic := &InitCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(showFixtureProvider()),
View: initView,
ProviderSource: providerSource,
},
}
initCode := ic.Run([]string{})
initOutput := initDone(t)
if initCode != 0 {
t.Fatalf("init failed\n%s", initOutput.Stderr())
}
view, done := testView(t)
c := &ShowCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(showFixtureProvider()),
View: view,
ProviderSource: providerSource,
},
}
args := []string{
"-config",
"-json",
"-no-color",
}
code := c.Run(args)
output := done(t)
if code != 0 {
t.Fatalf("unexpected exit status %d; want 0\ngot: %s", code, output.Stderr())
}
// Verify that the output is valid JSON
var got map[string]any
if err := json.Unmarshal([]byte(output.Stdout()), &got); err != nil {
t.Fatalf("invalid JSON output: %s\n%s", err, output.Stdout())
}
// Verify the basic structure of the configuration output
if _, ok := got["root_module"]; !ok {
t.Errorf("missing root_module in configuration output. Actual output: %v", got)
}
// Verify that module_calls (and its child entry) are included
rootModule, ok := got["root_module"].(map[string]any)
if !ok {
t.Fatal("root_module is not a map")
}
moduleCalls, ok := rootModule["module_calls"].(map[string]any)
if !ok || len(moduleCalls) == 0 {
t.Errorf("missing or empty module_calls in configuration output. Actual output: %v", got)
}
_, ok = moduleCalls["child"]
if !ok {
t.Errorf("missing 'child' entry in module_calls. Actual module_calls: %v", moduleCalls)
}
}
func TestShow_config_noArgs(t *testing.T) {
td := t.TempDir()
t.Chdir(td)
view, done := testView(t)
c := &ShowCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(showFixtureProvider()),
View: view,
},
}
args := []string{
"-config",
"-json",
"-no-color",
}
code := c.Run(args)
output := done(t)
if code != 1 {
t.Fatalf("unexpected exit status %d; want 1\ngot: %s", code, output.Stderr())
}
got := output.Stderr()
want := "This directory contains no OpenTofu configuration files."
if !strings.Contains(got, want) {
t.Errorf("unexpected output\ngot: %s\nwant:\n%s", got, want)
}
}
func TestShow_config_withModule(t *testing.T) {
// Create a temporary working directory
td := t.TempDir()
testCopyDir(t, "testdata/show-config-module", td)
t.Chdir(td)
providerSource, close := newMockProviderSource(t, map[string][]string{
"test": {"1.0.0"},
})
defer close()
// Initialize the module
initView, initDone := testView(t)
ic := &InitCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(showFixtureProvider()),
View: initView,
ProviderSource: providerSource,
},
}
initCode := ic.Run([]string{})
initOutput := initDone(t)
if initCode != 0 {
t.Fatalf("init failed\n%s", initOutput.Stderr())
}
view, done := testView(t)
c := &ShowCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(showFixtureProvider()),
View: view,
ProviderSource: providerSource,
},
}
args := []string{
"-config",
"-json",
"-no-color",
}
code := c.Run(args)
output := done(t)
if code != 0 {
t.Fatalf("unexpected exit status %d; want 0\ngot: %s", code, output.Stderr())
}
// Verify that the output is valid JSON
var got map[string]any
if err := json.Unmarshal([]byte(output.Stdout()), &got); err != nil {
t.Fatalf("invalid JSON output: %s\n%s", err, output.Stdout())
}
// Verify the basic structure of the configuration output
if _, ok := got["root_module"]; !ok {
t.Error("missing root_module in configuration output")
}
// Verify that module_calls (and its child entry) are included
rootModule, ok := got["root_module"].(map[string]any)
if !ok {
t.Fatal("root_module is not a map")
}
moduleCalls, ok := rootModule["module_calls"].(map[string]any)
if !ok || len(moduleCalls) == 0 {
t.Errorf("missing or empty module_calls in configuration output. Actual output: %v", got)
}
_, ok = moduleCalls["child"]
if !ok {
t.Errorf("missing 'child' entry in module_calls. Actual module_calls: %v", moduleCalls)
}
}
func TestShow_config_badArgs(t *testing.T) {
view, done := testView(t)
c := &ShowCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(showFixtureProvider()),
View: view,
},
}
args := []string{
"-config",
"bad",
"-json",
"-no-color",
}
code := c.Run(args)
output := done(t)
if code != 1 {
t.Fatalf("unexpected exit status %d; want 1\ngot: %s", code, output.Stdout())
}
got := output.Stderr()
want := "JSON output required for configuration"
if !strings.Contains(got, want) {
t.Errorf("unexpected output\ngot: %s\nwant:\n%s", got, want)
}
}
func TestShow_config_noJson(t *testing.T) {
view, done := testView(t)
c := &ShowCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(testProvider()),
View: view,
},
}
args := []string{
"-config",
"-no-color",
}
code := c.Run(args)
output := done(t)
if code != 1 {
t.Fatalf("unexpected exit status %d; want 1\ngot: %s", code, output.Stdout())
}
got := output.Stderr()
want := "JSON output required for configuration"
if !strings.Contains(got, want) {
t.Errorf("unexpected output\ngot: %s\nwant:\n%s", got, want)
}
}
func TestShow_config_conflictingOptions(t *testing.T) {
view, done := testView(t)
c := &ShowCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
testingOverrides: metaOverridesForProvider(testProvider()),
View: view,
},
}
args := []string{
"-config",
"-state",
"-json",
"-no-color",
}
code := c.Run(args)
output := done(t)
if code != 1 {
t.Fatalf("unexpected exit status %d; want 1\ngot: %s", code, output.Stdout())
}
got := output.Stderr()
want := "Conflicting object types to show"
if !strings.Contains(got, want) {
t.Errorf("unexpected output\ngot: %s\nwant:\n%s", got, want)
}
}
func TestShow_module(t *testing.T) {
// We intentionally don't cause the effect of a "tofu init" for this one,
// because the single-module mode is required to work without any
// dependencies installed and without a backend initialized so it can
// be used by the OpenTofu module registry indexing process.
view, done := testView(t)
c := &ShowCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
View: view,
},
}
args := []string{
"-module=testdata/show-config-single-module",
"-json",
"-no-color",
}
code := c.Run(args)
output := done(t)
if code != 0 {
t.Fatalf("wrong exit status %d; want 0\ngot: %s", code, output.Stderr())
}
var got map[string]any
if err := json.Unmarshal([]byte(output.Stdout()), &got); err != nil {
t.Fatalf("invalid JSON output: %s\n%s", err, output.Stdout())
}
want := map[string]any{
"provider_config": map[string]any{
"test": map[string]any{
"full_name": "example.com/bar/test",
"name": "test",
"version_constraint": "~> 2.0.0",
// "expressions" intentionally omitted in single-module mode
},
},
"root_module": map[string]any{
"module_calls": map[string]any{
"child": map[string]any{
"source": "example.com/not/actually/used",
"version_constraint": "~> 1.0.0",
// "module" intentionally omitted in single-module mode
// "expressions" intentionally omitted in single-module mode
},
},
"outputs": map[string]any{
"foo": map[string]any{
// "expression" intentionally omitted in single-module mode
"sensitive": true,
},
},
"resources": []any{
map[string]any{
"address": "test_instance.foo",
"mode": "managed",
"type": "test_instance",
"name": "foo",
"provider_config_key": "test",
// "expressions" intentionally omitted in single-module mode
// "schema_version" intentionally omitted in single-module mode (because we're not including anything that's schema-sensitive)
// "for_each_expression" intentionally omitted in single-module mode
"provisioners": []any{
map[string]any{
"type": "local-exec",
// "expressions" intentionally omitted in single-module mode
},
},
},
},
"variables": map[string]any{
"foo": map[string]any{
"type": "string",
"required": true,
"sensitive": true,
},
},
},
}
if diff := cmp.Diff(want, got); diff != "" {
t.Error("wrong result\n" + diff)
}
}
func TestShow_module_noJson(t *testing.T) {
view, done := testView(t)
c := &ShowCommand{
Meta: Meta{
WorkingDir: workdir.NewDir("."),
View: view,
},
}
args := []string{
"-module=testdata/show-config-module",
"-no-color",
}
code := c.Run(args)
output := done(t)
if code != 1 {
t.Fatalf("unexpected exit status %d; want 1\ngot: %s", code, output.Stdout())
}
got := output.Stderr()
want := "JSON output required for module"
if !strings.Contains(got, want) {
t.Errorf("unexpected output\ngot: %s\nwant:\n%s", got, want)
}
}