mirror of
https://github.com/opentffoundation/opentf.git
synced 2026-03-21 07:00:37 -04:00
a800d250e5
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>
113 lines
3.2 KiB
Go
113 lines
3.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 views
|
|
|
|
import (
|
|
"strings"
|
|
"testing"
|
|
|
|
"github.com/opentofu/opentofu/internal/command/arguments"
|
|
"github.com/opentofu/opentofu/internal/lang/marks"
|
|
"github.com/opentofu/opentofu/internal/states"
|
|
"github.com/opentofu/opentofu/internal/terminal"
|
|
"github.com/zclconf/go-cty/cty"
|
|
)
|
|
|
|
// Ensure that the correct view type and in-automation settings propagate to the
|
|
// Operation view.
|
|
func TestRefreshHuman_operation(t *testing.T) {
|
|
streams, done := terminal.StreamsForTesting(t)
|
|
defer done(t)
|
|
v := NewRefresh(arguments.ViewOptions{ViewType: arguments.ViewHuman}, NewView(streams).SetRunningInAutomation(true)).Operation()
|
|
if hv, ok := v.(*OperationHuman); !ok {
|
|
t.Fatalf("unexpected return type %t", v)
|
|
} else if hv.inAutomation != true {
|
|
t.Fatalf("unexpected inAutomation value on Operation view")
|
|
}
|
|
}
|
|
|
|
// Verify that Hooks includes a UI hook
|
|
func TestRefreshHuman_hooks(t *testing.T) {
|
|
streams, done := terminal.StreamsForTesting(t)
|
|
defer done(t)
|
|
v := NewRefresh(arguments.ViewOptions{ViewType: arguments.ViewHuman}, NewView(streams).SetRunningInAutomation(true))
|
|
hooks := v.Hooks()
|
|
|
|
var uiHook *UiHook
|
|
for _, hook := range hooks {
|
|
if ch, ok := hook.(*UiHook); ok {
|
|
uiHook = ch
|
|
}
|
|
}
|
|
if uiHook == nil {
|
|
t.Fatalf("expected Hooks to include a UiHook: %#v", hooks)
|
|
}
|
|
}
|
|
|
|
// Basic test coverage of Outputs, since most of its functionality is tested
|
|
// elsewhere.
|
|
func TestRefreshHuman_outputs(t *testing.T) {
|
|
streams, done := terminal.StreamsForTesting(t)
|
|
v := NewRefresh(arguments.ViewOptions{ViewType: arguments.ViewHuman}, NewView(streams))
|
|
|
|
v.Outputs(map[string]*states.OutputValue{
|
|
"foo": {Value: cty.StringVal("secret")},
|
|
})
|
|
|
|
got := done(t).Stdout()
|
|
for _, want := range []string{"Outputs:", `foo = "secret"`} {
|
|
if !strings.Contains(got, want) {
|
|
t.Errorf("wrong result\ngot: %q\nwant: %q", got, want)
|
|
}
|
|
}
|
|
}
|
|
|
|
// Outputs should do nothing if there are no outputs to render.
|
|
func TestRefreshHuman_outputsEmpty(t *testing.T) {
|
|
streams, done := terminal.StreamsForTesting(t)
|
|
v := NewRefresh(arguments.ViewOptions{ViewType: arguments.ViewHuman}, NewView(streams))
|
|
|
|
v.Outputs(map[string]*states.OutputValue{})
|
|
|
|
got := done(t).Stdout()
|
|
if got != "" {
|
|
t.Errorf("output should be empty, but got: %q", got)
|
|
}
|
|
}
|
|
|
|
// Basic test coverage of Outputs, since most of its functionality is tested
|
|
// elsewhere.
|
|
func TestRefreshJSON_outputs(t *testing.T) {
|
|
streams, done := terminal.StreamsForTesting(t)
|
|
v := NewRefresh(arguments.ViewOptions{ViewType: arguments.ViewJSON}, NewView(streams))
|
|
|
|
v.Outputs(map[string]*states.OutputValue{
|
|
"boop_count": {Value: cty.NumberIntVal(92)},
|
|
"password": {Value: cty.StringVal("horse-battery").Mark(marks.Sensitive), Sensitive: true},
|
|
})
|
|
|
|
want := []map[string]any{
|
|
{
|
|
"@level": "info",
|
|
"@message": "Outputs: 2",
|
|
"@module": "tofu.ui",
|
|
"type": "outputs",
|
|
"outputs": map[string]any{
|
|
"boop_count": map[string]any{
|
|
"sensitive": false,
|
|
"value": float64(92),
|
|
"type": "number",
|
|
},
|
|
"password": map[string]any{
|
|
"sensitive": true,
|
|
"type": "string",
|
|
},
|
|
},
|
|
},
|
|
}
|
|
testJSONViewOutputEquals(t, done(t).Stdout(), want)
|
|
}
|