opentofu/internal/command/console_test.go
Nathan Baulch 9b7bec31b4
Another batch of minor typos (#1953)
Signed-off-by: Nathan Baulch <nathan.baulch@gmail.com>
2024-09-09 07:51:39 -04:00

353 lines
8.2 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 (
"bytes"
"os"
"path/filepath"
"strings"
"testing"
"github.com/mitchellh/cli"
"github.com/opentofu/opentofu/internal/configs/configschema"
"github.com/opentofu/opentofu/internal/providers"
"github.com/opentofu/opentofu/internal/terminal"
"github.com/zclconf/go-cty/cty"
)
// ConsoleCommand is tested primarily with tests in the "repl" package.
// It is not tested here because the Console uses a readline-like library
// that takes over stdin/stdout. It is difficult to test directly. The
// core logic is tested in "repl"
//
// This file still contains some tests using the stdin-based input.
func TestConsole_basic(t *testing.T) {
testCwd(t)
p := testProvider()
ui := cli.NewMockUi()
view, _ := testView(t)
c := &ConsoleCommand{
Meta: Meta{
testingOverrides: metaOverridesForProvider(p),
Ui: ui,
View: view,
},
}
var output bytes.Buffer
defer testStdinPipe(t, strings.NewReader("1+5\n"))()
outCloser := testStdoutCapture(t, &output)
args := []string{}
code := c.Run(args)
outCloser()
if code != 0 {
t.Fatalf("bad: %d\n\n%s", code, ui.ErrorWriter.String())
}
actual := output.String()
if actual != "6\n" {
t.Fatalf("bad: %q", actual)
}
}
func TestConsole_tfvars(t *testing.T) {
td := t.TempDir()
testCopyDir(t, testFixturePath("apply-vars"), td)
defer testChdir(t, td)()
// Write a terraform.tfvars
varFilePath := filepath.Join(td, "terraform.tfvars")
if err := os.WriteFile(varFilePath, []byte(applyVarFile), 0644); err != nil {
t.Fatalf("err: %s", err)
}
p := testProvider()
p.GetProviderSchemaResponse = &providers.GetProviderSchemaResponse{
ResourceTypes: map[string]providers.Schema{
"test_instance": {
Block: &configschema.Block{
Attributes: map[string]*configschema.Attribute{
"value": {Type: cty.String, Optional: true},
},
},
},
},
}
ui := cli.NewMockUi()
view, _ := testView(t)
c := &ConsoleCommand{
Meta: Meta{
testingOverrides: metaOverridesForProvider(p),
Ui: ui,
View: view,
},
}
var output bytes.Buffer
defer testStdinPipe(t, strings.NewReader("var.foo\n"))()
outCloser := testStdoutCapture(t, &output)
args := []string{}
code := c.Run(args)
outCloser()
if code != 0 {
t.Fatalf("bad: %d\n\n%s", code, ui.ErrorWriter.String())
}
actual := output.String()
if actual != "\"bar\"\n" {
t.Fatalf("bad: %q", actual)
}
}
func TestConsole_unsetRequiredVars(t *testing.T) {
// This test is verifying that it's possible to run "tofu console"
// without providing values for all required variables, without
// "tofu console" producing an interactive prompt for those variables
// or producing errors. Instead, it should allow evaluation in that
// partial context but see the unset variables values as being unknown.
//
// This test fixture includes variable "foo" {}, which we are
// intentionally not setting here.
td := t.TempDir()
testCopyDir(t, testFixturePath("apply-vars"), td)
defer testChdir(t, td)()
p := testProvider()
p.GetProviderSchemaResponse = &providers.GetProviderSchemaResponse{
ResourceTypes: map[string]providers.Schema{
"test_instance": {
Block: &configschema.Block{
Attributes: map[string]*configschema.Attribute{
"value": {Type: cty.String, Optional: true},
},
},
},
},
}
ui := cli.NewMockUi()
view, _ := testView(t)
c := &ConsoleCommand{
Meta: Meta{
testingOverrides: metaOverridesForProvider(p),
Ui: ui,
View: view,
},
}
var output bytes.Buffer
defer testStdinPipe(t, strings.NewReader("var.foo\n"))()
outCloser := testStdoutCapture(t, &output)
args := []string{}
code := c.Run(args)
outCloser()
if code != 0 {
t.Fatalf("bad: %d\n\n%s", code, ui.ErrorWriter.String())
}
if got, want := output.String(), "(known after apply)\n"; got != want {
t.Fatalf("unexpected output\n got: %q\nwant: %q", got, want)
}
}
func TestConsole_variables(t *testing.T) {
td := t.TempDir()
testCopyDir(t, testFixturePath("variables"), td)
defer testChdir(t, td)()
p := testProvider()
ui := cli.NewMockUi()
view, _ := testView(t)
c := &ConsoleCommand{
Meta: Meta{
testingOverrides: metaOverridesForProvider(p),
Ui: ui,
View: view,
},
}
commands := map[string]string{
"var.foo\n": "\"bar\"\n",
"var.snack\n": "\"popcorn\"\n",
"var.secret_snack\n": "(sensitive value)\n",
"local.snack_bar\n": "[\n \"popcorn\",\n (sensitive value),\n]\n",
}
args := []string{}
for cmd, val := range commands {
var output bytes.Buffer
defer testStdinPipe(t, strings.NewReader(cmd))()
outCloser := testStdoutCapture(t, &output)
code := c.Run(args)
outCloser()
if code != 0 {
t.Fatalf("bad: %d\n\n%s", code, ui.ErrorWriter.String())
}
actual := output.String()
if output.String() != val {
t.Fatalf("bad: %q, expected %q", actual, val)
}
}
}
func TestConsole_modules(t *testing.T) {
td := t.TempDir()
testCopyDir(t, testFixturePath("modules"), td)
defer testChdir(t, td)()
p := applyFixtureProvider()
ui := cli.NewMockUi()
view, _ := testView(t)
c := &ConsoleCommand{
Meta: Meta{
testingOverrides: metaOverridesForProvider(p),
Ui: ui,
View: view,
},
}
commands := map[string]string{
"module.child.myoutput\n": "\"bar\"\n",
"module.count_child[0].myoutput\n": "\"bar\"\n",
"local.foo\n": "3\n",
}
args := []string{}
for cmd, val := range commands {
var output bytes.Buffer
defer testStdinPipe(t, strings.NewReader(cmd))()
outCloser := testStdoutCapture(t, &output)
code := c.Run(args)
outCloser()
if code != 0 {
t.Fatalf("bad: %d\n\n%s", code, ui.ErrorWriter.String())
}
actual := output.String()
if output.String() != val {
t.Fatalf("bad: %q, expected %q", actual, val)
}
}
}
func TestConsole_multiline_pipe(t *testing.T) {
td := t.TempDir()
testCopyDir(t, testFixturePath("console-multiline-vars"), td)
defer testChdir(t, td)()
p := testProvider()
p.GetProviderSchemaResponse = &providers.GetProviderSchemaResponse{
ResourceTypes: map[string]providers.Schema{
"test_instance": {
Block: &configschema.Block{
Attributes: map[string]*configschema.Attribute{
"value": {Type: cty.String, Optional: true},
},
},
},
},
}
type testCase struct {
input string
expected string
}
tests := map[string]testCase{
"single_line": {
input: `var.counts.lalala`,
expected: "1\n",
},
"basic_multi_line": {
input: `
var.counts.lalala
var.counts.lololo`,
expected: "\n1\n2\n",
},
"brackets_multi_line": {
input: `
var.counts.lalala
split(
"_",
"lalala_lolol_lelelele"
)`,
expected: "\n1\ntolist([\n \"lalala\",\n \"lolol\",\n \"lelelele\",\n])\n",
},
"braces_multi_line": {
input: `
{
for key, value in var.counts : key => value
if value == 1
}`,
expected: "\n{\n \"lalala\" = 1\n}\n",
},
"escaped_new_line": {
input: `
5 + 4 \
`,
expected: "\n9\n\n",
},
"heredoc": {
input: `
{
default = <<-EOT
lulululu
EOT
}`,
expected: "\n{\n \"default\" = <<-EOT\n lulululu\n \n EOT\n}\n",
},
"quoted_braces": {
input: "{\ndefault = format(\"%s%s%s\",\"{\",var.counts.lalala,\"}\")\n}",
expected: "{\n \"default\" = \"{1}\"\n}\n",
},
}
for testName, tc := range tests {
t.Run(testName, func(t *testing.T) {
streams, _ := terminal.StreamsForTesting(t)
ui := cli.NewMockUi()
view, _ := testView(t)
c := &ConsoleCommand{
Meta: Meta{
testingOverrides: metaOverridesForProvider(p),
Ui: ui,
View: view,
Streams: streams,
},
}
var output bytes.Buffer
defer testStdinPipe(t, strings.NewReader(tc.input))()
outCloser := testStdoutCapture(t, &output)
args := []string{}
code := c.Run(args)
outCloser()
if code != 0 {
t.Fatalf("bad: %d\n\n%s", code, ui.ErrorWriter.String())
}
got := output.String()
if got != tc.expected {
t.Fatalf("unexpected output\ngot: %q\nexpected: %q", got, tc.expected)
}
})
}
}