opentofu/internal/tofu/node_module_variable_test.go
namgyalangmo cb2e9119aa
Update copyright notice (#1232)
Signed-off-by: namgyalangmo <75657887+namgyalangmo@users.noreply.github.com>
2024-02-08 09:48:59 +00:00

309 lines
7.9 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 tofu
import (
"errors"
"reflect"
"testing"
"github.com/go-test/deep"
"github.com/hashicorp/hcl/v2"
"github.com/hashicorp/hcl/v2/hclsyntax"
"github.com/zclconf/go-cty/cty"
"github.com/opentofu/opentofu/internal/addrs"
"github.com/opentofu/opentofu/internal/checks"
"github.com/opentofu/opentofu/internal/configs"
"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/tfdiags"
)
func TestNodeModuleVariablePath(t *testing.T) {
n := &nodeModuleVariable{
Addr: addrs.RootModuleInstance.InputVariable("foo"),
Config: &configs.Variable{
Name: "foo",
Type: cty.String,
ConstraintType: cty.String,
},
}
want := addrs.RootModuleInstance
got := n.Path()
if got.String() != want.String() {
t.Fatalf("wrong module address %s; want %s", got, want)
}
}
func TestNodeModuleVariableReferenceableName(t *testing.T) {
n := &nodeExpandModuleVariable{
Addr: addrs.InputVariable{Name: "foo"},
Config: &configs.Variable{
Name: "foo",
Type: cty.String,
ConstraintType: cty.String,
},
}
{
expected := []addrs.Referenceable{
addrs.InputVariable{Name: "foo"},
}
actual := n.ReferenceableAddrs()
if !reflect.DeepEqual(actual, expected) {
t.Fatalf("%#v != %#v", actual, expected)
}
}
{
gotSelfPath, gotReferencePath := n.ReferenceOutside()
wantSelfPath := addrs.RootModuleInstance
wantReferencePath := addrs.RootModuleInstance
if got, want := gotSelfPath.String(), wantSelfPath.String(); got != want {
t.Errorf("wrong self path\ngot: %s\nwant: %s", got, want)
}
if got, want := gotReferencePath.String(), wantReferencePath.String(); got != want {
t.Errorf("wrong reference path\ngot: %s\nwant: %s", got, want)
}
}
}
func TestNodeModuleVariableReference(t *testing.T) {
n := &nodeExpandModuleVariable{
Addr: addrs.InputVariable{Name: "foo"},
Module: addrs.RootModule.Child("bar"),
Config: &configs.Variable{
Name: "foo",
Type: cty.String,
ConstraintType: cty.String,
},
Expr: &hclsyntax.ScopeTraversalExpr{
Traversal: hcl.Traversal{
hcl.TraverseRoot{Name: "var"},
hcl.TraverseAttr{Name: "foo"},
},
},
}
want := []*addrs.Reference{
{
Subject: addrs.InputVariable{Name: "foo"},
},
}
got := n.References()
for _, problem := range deep.Equal(got, want) {
t.Error(problem)
}
}
func TestNodeModuleVariableReference_grandchild(t *testing.T) {
n := &nodeExpandModuleVariable{
Addr: addrs.InputVariable{Name: "foo"},
Module: addrs.RootModule.Child("bar"),
Config: &configs.Variable{
Name: "foo",
Type: cty.String,
ConstraintType: cty.String,
},
Expr: &hclsyntax.ScopeTraversalExpr{
Traversal: hcl.Traversal{
hcl.TraverseRoot{Name: "var"},
hcl.TraverseAttr{Name: "foo"},
},
},
}
want := []*addrs.Reference{
{
Subject: addrs.InputVariable{Name: "foo"},
},
}
got := n.References()
for _, problem := range deep.Equal(got, want) {
t.Error(problem)
}
}
func TestNodeModuleVariableConstraints(t *testing.T) {
// This is a little extra convoluted to poke at some edge cases that have cropped up in the past around
// evaluating dependent nodes between the plan -> apply and destroy cycle.
m := testModuleInline(t, map[string]string{
"main.tf": `
variable "input" {
type = string
validation {
condition = var.input != ""
error_message = "Input must not be empty."
}
}
module "child" {
source = "./child"
input = var.input
}
provider "test" {
alias = "secondary"
test_string = module.child.output
}
resource "test_object" "resource" {
provider = test.secondary
test_string = "test string"
}
`,
"child/main.tf": `
variable "input" {
type = string
validation {
condition = var.input != ""
error_message = "Input must not be empty."
}
}
provider "test" {
test_string = "foo"
}
resource "test_object" "resource" {
test_string = var.input
}
output "output" {
value = test_object.resource.id
}
`,
})
checkableObjects := []addrs.Checkable{
addrs.InputVariable{Name: "input"}.Absolute(addrs.RootModuleInstance),
addrs.InputVariable{Name: "input"}.Absolute(addrs.RootModuleInstance.Child("child", addrs.NoKey)),
}
p := &MockProvider{
GetProviderSchemaResponse: &providers.GetProviderSchemaResponse{
Provider: providers.Schema{Block: simpleTestSchema()},
ResourceTypes: map[string]providers.Schema{
"test_object": providers.Schema{Block: &configschema.Block{
Attributes: map[string]*configschema.Attribute{
"id": {
Type: cty.String,
Computed: true,
},
"test_string": {
Type: cty.String,
Required: true,
},
},
}},
},
},
}
p.ConfigureProviderFn = func(req providers.ConfigureProviderRequest) (resp providers.ConfigureProviderResponse) {
if req.Config.GetAttr("test_string").IsNull() {
resp.Diagnostics = resp.Diagnostics.Append(errors.New("missing test_string value"))
}
return resp
}
ctxOpts := &ContextOpts{
Providers: map[addrs.Provider]providers.Factory{
addrs.NewDefaultProvider("test"): testProviderFuncFixed(p),
},
}
t.Run("pass", func(t *testing.T) {
ctx := testContext2(t, ctxOpts)
plan, diags := ctx.Plan(m, states.NewState(), &PlanOpts{
Mode: plans.NormalMode,
SetVariables: InputValues{
"input": &InputValue{
Value: cty.StringVal("beep"),
SourceType: ValueFromCLIArg,
},
},
})
assertNoDiagnostics(t, diags)
for _, addr := range checkableObjects {
result := plan.Checks.GetObjectResult(addr)
if result == nil {
t.Fatalf("no check result for %s in the plan", addr)
}
if got, want := result.Status, checks.StatusPass; got != want {
t.Fatalf("wrong check status for %s during planning\ngot: %s\nwant: %s", addr, got, want)
}
}
state, diags := ctx.Apply(plan, m)
assertNoDiagnostics(t, diags)
for _, addr := range checkableObjects {
result := state.CheckResults.GetObjectResult(addr)
if result == nil {
t.Fatalf("no check result for %s in the final state", addr)
}
if got, want := result.Status, checks.StatusPass; got != want {
t.Errorf("wrong check status for %s after apply\ngot: %s\nwant: %s", addr, got, want)
}
}
plan, diags = ctx.Plan(m, state, &PlanOpts{
Mode: plans.DestroyMode,
SetVariables: InputValues{
"input": &InputValue{
Value: cty.StringVal("beep"),
SourceType: ValueFromCLIArg,
},
},
})
assertNoDiagnostics(t, diags)
state, diags = ctx.Apply(plan, m)
assertNoDiagnostics(t, diags)
for _, addr := range checkableObjects {
result := state.CheckResults.GetObjectResult(addr)
if result == nil {
t.Fatalf("no check result for %s in the final state", addr)
}
if got, want := result.Status, checks.StatusPass; got != want {
t.Errorf("wrong check status for %s after apply\ngot: %s\nwant: %s", addr, got, want)
}
}
})
t.Run("fail", func(t *testing.T) {
ctx := testContext2(t, ctxOpts)
_, diags := ctx.Plan(m, states.NewState(), &PlanOpts{
Mode: plans.NormalMode,
SetVariables: InputValues{
"input": &InputValue{
Value: cty.StringVal(""),
SourceType: ValueFromCLIArg,
},
},
})
if !diags.HasErrors() {
t.Fatalf("succeeded; want error")
}
const wantSummary = "Invalid value for variable"
found := false
for _, diag := range diags {
if diag.Severity() == tfdiags.Error && diag.Description().Summary == wantSummary {
found = true
break
}
}
if !found {
t.Fatalf("missing expected error\nwant summary: %s\ngot: %s", wantSummary, diags.Err().Error())
}
})
}