blob: adc7f4a6f96697d6b1ef27edabfb3356fbae270b [file] [log] [blame] [edit]
// Copyright (c) HashiCorp, Inc.
// SPDX-License-Identifier: BUSL-1.1
package stackruntime
import (
"context"
"path/filepath"
"testing"
"github.com/hashicorp/hcl/v2"
"github.com/zclconf/go-cty/cty"
"github.com/hashicorp/terraform/internal/addrs"
"github.com/hashicorp/terraform/internal/depsfile"
"github.com/hashicorp/terraform/internal/getproviders/providerreqs"
"github.com/hashicorp/terraform/internal/providers"
stacks_testing_provider "github.com/hashicorp/terraform/internal/stacks/stackruntime/testing"
"github.com/hashicorp/terraform/internal/tfdiags"
)
type validateTestInput struct {
// skip lets us write tests for behaviour we want to add in the future. Set
// this to true for any tests that are not yet implemented.
skip bool
// diags is a function that returns the expected diagnostics for the
// test.
diags func() tfdiags.Diagnostics
// planInputVars is used only in the plan tests to provide a set of input
// variables to use for the plan request. Validate operates statically so
// does not need any input variables.
planInputVars map[string]cty.Value
}
var (
// validConfigurations are shared between the validate and plan tests.
validConfigurations = map[string]validateTestInput{
"empty": {},
"plan-variable-defaults": {},
"variable-output-roundtrip": {},
"variable-output-roundtrip-nested": {},
"aliased-provider": {},
filepath.Join("with-single-input", "input-from-component"): {},
filepath.Join("with-single-input", "input-from-component-list"): {
planInputVars: map[string]cty.Value{
"components": cty.SetVal([]cty.Value{
cty.StringVal("one"),
cty.StringVal("two"),
cty.StringVal("three"),
}),
},
},
filepath.Join("with-single-input", "provider-name-clash"): {
planInputVars: map[string]cty.Value{
"input": cty.StringVal("input"),
},
},
filepath.Join("with-single-input", "valid"): {
planInputVars: map[string]cty.Value{
"input": cty.StringVal("input"),
},
},
filepath.Join("with-single-input", "provider-for-each"): {
planInputVars: map[string]cty.Value{
"input": cty.StringVal("input"),
},
},
}
// invalidConfigurations are shared between the validate and plan tests.
invalidConfigurations = map[string]validateTestInput{
"validate-undeclared-variable": {
diags: func() tfdiags.Diagnostics {
var diags tfdiags.Diagnostics
diags = diags.Append(&hcl.Diagnostic{
Severity: hcl.DiagError,
Summary: "Reference to undeclared input variable",
Detail: `There is no variable "a" block declared in this stack.`,
Subject: &hcl.Range{
Filename: mainBundleSourceAddrStr("validate-undeclared-variable/validate-undeclared-variable.tfstack.hcl"),
Start: hcl.Pos{Line: 3, Column: 11, Byte: 40},
End: hcl.Pos{Line: 3, Column: 16, Byte: 45},
},
})
return diags
},
},
"invalid-configuration": {
diags: func() tfdiags.Diagnostics {
var diags tfdiags.Diagnostics
diags = diags.Append(&hcl.Diagnostic{
Severity: hcl.DiagError,
Summary: "Unsupported argument",
Detail: "An argument named \"invalid\" is not expected here.",
Subject: &hcl.Range{
Filename: mainBundleSourceAddrStr("invalid-configuration/invalid-configuration.tf"),
Start: hcl.Pos{Line: 11, Column: 3, Byte: 163},
End: hcl.Pos{Line: 11, Column: 10, Byte: 170},
},
})
return diags
},
},
filepath.Join("with-single-input", "undeclared-provider"): {
diags: func() tfdiags.Diagnostics {
var diags tfdiags.Diagnostics
diags = diags.Append(&hcl.Diagnostic{
Severity: hcl.DiagError,
Summary: "Reference to undeclared provider configuration",
Detail: "There is no provider \"testing\" \"default\" block declared in this stack.",
Subject: &hcl.Range{
Filename: mainBundleSourceAddrStr("with-single-input/undeclared-provider/undeclared-provider.tfstack.hcl"),
Start: hcl.Pos{Line: 10, Column: 15, Byte: 163},
End: hcl.Pos{Line: 10, Column: 39, Byte: 187},
},
})
diags = diags.Append(&hcl.Diagnostic{
Severity: hcl.DiagError,
Summary: "Reference to undeclared provider configuration",
Detail: "There is no provider \"testing\" \"default\" block declared in this stack.",
Subject: &hcl.Range{
Filename: mainBundleSourceAddrStr("with-single-input/undeclared-provider/undeclared-provider.tfstack.hcl"),
Start: hcl.Pos{Line: 25, Column: 15, Byte: 379},
End: hcl.Pos{Line: 25, Column: 39, Byte: 403},
},
})
return diags
},
},
filepath.Join("with-single-input", "missing-provider"): {
diags: func() tfdiags.Diagnostics {
var diags tfdiags.Diagnostics
diags = diags.Append(&hcl.Diagnostic{
Severity: hcl.DiagError,
Summary: "Missing required provider configuration",
Detail: "The root module for component.removed requires a provider configuration named \"testing\" for provider \"hashicorp/testing\", which is not assigned in the block's \"providers\" argument.",
Subject: &hcl.Range{
Filename: mainBundleSourceAddrStr("with-single-input/missing-provider/missing-provider.tfstack.hcl"),
Start: hcl.Pos{Line: 25, Column: 1, Byte: 337},
End: hcl.Pos{Line: 25, Column: 8, Byte: 344},
},
})
diags = diags.Append(&hcl.Diagnostic{
Severity: hcl.DiagError,
Summary: "Missing required provider configuration",
Detail: "The root module for component.self requires a provider configuration named \"testing\" for provider \"hashicorp/testing\", which is not assigned in the block's \"providers\" argument.",
Subject: &hcl.Range{
Filename: mainBundleSourceAddrStr("with-single-input/missing-provider/missing-provider.tfstack.hcl"),
Start: hcl.Pos{Line: 14, Column: 1, Byte: 169},
End: hcl.Pos{Line: 14, Column: 17, Byte: 185},
},
})
return diags
},
},
filepath.Join("with-single-input", "invalid-provider-type"): {
diags: func() tfdiags.Diagnostics {
var diags tfdiags.Diagnostics
diags = diags.Append(&hcl.Diagnostic{
Severity: hcl.DiagError,
Summary: "Invalid provider configuration",
Detail: "The provider configuration slot \"testing\" requires a configuration for provider \"registry.terraform.io/hashicorp/testing\", not for provider \"terraform.io/builtin/testing\".",
Subject: &hcl.Range{
Filename: mainBundleSourceAddrStr("with-single-input/invalid-provider-type/invalid-provider-type.tfstack.hcl"),
Start: hcl.Pos{Line: 22, Column: 15, Byte: 378},
End: hcl.Pos{Line: 22, Column: 39, Byte: 402},
},
})
diags = diags.Append(&hcl.Diagnostic{
Severity: hcl.DiagError,
Summary: "Invalid provider configuration",
Detail: "The provider configuration slot \"testing\" requires a configuration for provider \"registry.terraform.io/hashicorp/testing\", not for provider \"terraform.io/builtin/testing\".",
Subject: &hcl.Range{
Filename: mainBundleSourceAddrStr("with-single-input/invalid-provider-type/invalid-provider-type.tfstack.hcl"),
Start: hcl.Pos{Line: 37, Column: 15, Byte: 614},
End: hcl.Pos{Line: 37, Column: 39, Byte: 638},
},
})
return diags
},
},
filepath.Join("with-single-input", "invalid-provider-config"): {
diags: func() tfdiags.Diagnostics {
var diags tfdiags.Diagnostics
diags = diags.Append(&hcl.Diagnostic{
Severity: hcl.DiagError,
Summary: "Unsupported argument",
Detail: "An argument named \"imaginary\" is not expected here.",
Subject: &hcl.Range{
Filename: mainBundleSourceAddrStr("with-single-input/invalid-provider-config/invalid-provider-config.tfstack.hcl"),
Start: hcl.Pos{Line: 11, Column: 5, Byte: 218},
End: hcl.Pos{Line: 11, Column: 14, Byte: 227},
},
})
return diags
},
},
filepath.Join("with-single-input", "undeclared-variable"): {
diags: func() tfdiags.Diagnostics {
var diags tfdiags.Diagnostics
diags = diags.Append(&hcl.Diagnostic{
Severity: hcl.DiagError,
Summary: "Reference to undeclared input variable",
Detail: `There is no variable "input" block declared in this stack.`,
Subject: &hcl.Range{
Filename: mainBundleSourceAddrStr("with-single-input/undeclared-variable/undeclared-variable.tfstack.hcl"),
Start: hcl.Pos{Line: 19, Column: 13, Byte: 284},
End: hcl.Pos{Line: 19, Column: 22, Byte: 293},
},
})
return diags
},
},
filepath.Join("with-single-input", "missing-variable"): {
diags: func() tfdiags.Diagnostics {
var diags tfdiags.Diagnostics
diags = diags.Append(&hcl.Diagnostic{
Severity: hcl.DiagError,
Summary: "Invalid inputs for component",
Detail: "Invalid input variable definition object: attribute \"input\" is required.",
Subject: &hcl.Range{
Filename: mainBundleSourceAddrStr("with-single-input/missing-variable/missing-variable.tfstack.hcl"),
Start: hcl.Pos{Line: 22, Column: 12, Byte: 338},
End: hcl.Pos{Line: 22, Column: 14, Byte: 340},
},
})
return diags
},
},
filepath.Join("with-single-input", "input-from-missing-component"): {
diags: func() tfdiags.Diagnostics {
var diags tfdiags.Diagnostics
diags = diags.Append(&hcl.Diagnostic{
Severity: hcl.DiagError,
Summary: "Reference to undeclared component",
Detail: "There is no component \"output\" block declared in this stack.",
Subject: &hcl.Range{
Filename: mainBundleSourceAddrStr("with-single-input/input-from-missing-component/input-from-missing-component.tfstack.hcl"),
Start: hcl.Pos{Line: 19, Column: 13, Byte: 314},
End: hcl.Pos{Line: 19, Column: 29, Byte: 330},
},
})
return diags
},
},
filepath.Join("with-single-input", "input-from-provider"): {
diags: func() tfdiags.Diagnostics {
var diags tfdiags.Diagnostics
diags = diags.Append(&hcl.Diagnostic{
Severity: hcl.DiagError,
Summary: "Invalid inputs for component",
Detail: "Invalid input variable definition object: attribute \"input\": string required.",
Subject: &hcl.Range{
Filename: mainBundleSourceAddrStr("with-single-input/input-from-provider/input-from-provider.tfstack.hcl"),
Start: hcl.Pos{Line: 17, Column: 12, Byte: 239},
End: hcl.Pos{Line: 20, Column: 4, Byte: 339},
},
})
return diags
},
},
filepath.Join("with-single-input", "depends-on-invalid"): {
diags: func() tfdiags.Diagnostics {
var diags tfdiags.Diagnostics
diags = diags.Append(&hcl.Diagnostic{
Severity: hcl.DiagError,
Summary: "Invalid depends_on target",
Detail: "The depends_on argument must refer to an embedded stack or component, but this reference refers to \"var.input\".",
Subject: &hcl.Range{
Filename: mainBundleSourceAddrStr("with-single-input/depends-on-invalid/depends-on-invalid.tfstack.hcl"),
Start: hcl.Pos{Line: 22, Column: 17, Byte: 293},
End: hcl.Pos{Line: 22, Column: 26, Byte: 302},
},
})
diags = diags.Append(&hcl.Diagnostic{
Severity: hcl.DiagError,
Summary: "Invalid depends_on target",
Detail: "The depends_on argument must refer to an embedded stack or component, but this reference refers to \"var.input\".",
Subject: &hcl.Range{
Filename: mainBundleSourceAddrStr("with-single-input/depends-on-invalid/depends-on-invalid.tfstack.hcl"),
Start: hcl.Pos{Line: 37, Column: 17, Byte: 509},
End: hcl.Pos{Line: 37, Column: 26, Byte: 518},
},
})
diags = diags.Append(&hcl.Diagnostic{
Severity: hcl.DiagError,
Summary: "Invalid depends_on target",
Detail: "The depends_on reference \"component.missing\" does not exist.",
Subject: &hcl.Range{
Filename: mainBundleSourceAddrStr("with-single-input/depends-on-invalid/depends-on-invalid.tfstack.hcl"),
Start: hcl.Pos{Line: 22, Column: 28, Byte: 304},
End: hcl.Pos{Line: 22, Column: 45, Byte: 321},
},
})
diags = diags.Append(&hcl.Diagnostic{
Severity: hcl.DiagError,
Summary: "Invalid depends_on target",
Detail: "The depends_on reference \"stack.missing\" does not exist.",
Subject: &hcl.Range{
Filename: mainBundleSourceAddrStr("with-single-input/depends-on-invalid/depends-on-invalid.tfstack.hcl"),
Start: hcl.Pos{Line: 37, Column: 28, Byte: 520},
End: hcl.Pos{Line: 37, Column: 41, Byte: 533},
},
})
diags = diags.Append(&hcl.Diagnostic{
Severity: hcl.DiagWarning,
Summary: "Non-valid depends_on target",
Detail: "The depends_on argument should refer directly to an embedded stack or component in configuration, but this reference is too deep.\n\n" +
"Terraform Stacks has simplified the reference to the nearest valid target, \"component.first\". To remove this warning, update the configuration to the same target.",
Subject: &hcl.Range{
Filename: mainBundleSourceAddrStr("with-single-input/depends-on-invalid/depends-on-invalid.tfstack.hcl"),
Start: hcl.Pos{Line: 52, Column: 17, Byte: 722},
End: hcl.Pos{Line: 52, Column: 32, Byte: 737},
},
})
return diags
},
},
}
)
// TestValidate_valid tests that a variety of configurations under the main
// test source bundle each generate no diagnostics at all, as a
// relatively-simple way to detect accidental regressions.
//
// Any stack configuration directory that we expect should be valid can
// potentially be included in here unless it depends on provider plugins
// to complete validation, since this test cannot supply provider plugins.
func TestValidate_valid(t *testing.T) {
for name, tc := range validConfigurations {
t.Run(name, func(t *testing.T) {
if tc.skip {
// We've added this test before the implementation was ready.
t.SkipNow()
}
ctx := context.Background()
lock := depsfile.NewLocks()
lock.SetProvider(
addrs.NewDefaultProvider("testing"),
providerreqs.MustParseVersion("0.0.0"),
providerreqs.MustParseVersionConstraints("=0.0.0"),
providerreqs.PreferredHashes([]providerreqs.Hash{}),
)
lock.SetProvider(
addrs.NewDefaultProvider("other"),
providerreqs.MustParseVersion("0.0.0"),
providerreqs.MustParseVersionConstraints("=0.0.0"),
providerreqs.PreferredHashes([]providerreqs.Hash{}),
)
testContext := TestContext{
config: loadMainBundleConfigForTest(t, name),
providers: map[addrs.Provider]providers.Factory{
// We support both hashicorp/testing and
// terraform.io/builtin/testing as providers. This lets us
// test the provider aliasing feature. Both providers
// support the same set of resources and data sources.
addrs.NewDefaultProvider("testing"): func() (providers.Interface, error) {
return stacks_testing_provider.NewProvider(t), nil
},
addrs.NewBuiltInProvider("testing"): func() (providers.Interface, error) {
return stacks_testing_provider.NewProvider(t), nil
},
// We also support an "other" provider out of the box to
// test the provider aliasing feature.
addrs.NewDefaultProvider("other"): func() (providers.Interface, error) {
return stacks_testing_provider.NewProvider(t), nil
},
},
dependencyLocks: *lock,
}
cycle := TestCycle{} // empty, as we expect no diagnostics
testContext.Validate(t, ctx, cycle)
})
}
}
func TestValidate_invalid(t *testing.T) {
for name, tc := range invalidConfigurations {
t.Run(name, func(t *testing.T) {
if tc.skip {
// We've added this test before the implementation was ready.
t.SkipNow()
}
ctx := context.Background()
lock := depsfile.NewLocks()
lock.SetProvider(
addrs.NewDefaultProvider("testing"),
providerreqs.MustParseVersion("0.0.0"),
providerreqs.MustParseVersionConstraints("=0.0.0"),
providerreqs.PreferredHashes([]providerreqs.Hash{}),
)
lock.SetProvider(
addrs.NewDefaultProvider("other"),
providerreqs.MustParseVersion("0.0.0"),
providerreqs.MustParseVersionConstraints("=0.0.0"),
providerreqs.PreferredHashes([]providerreqs.Hash{}),
)
testContext := TestContext{
config: loadMainBundleConfigForTest(t, name),
providers: map[addrs.Provider]providers.Factory{
// We support both hashicorp/testing and
// terraform.io/builtin/testing as providers. This lets us
// test the provider aliasing feature. Both providers
// support the same set of resources and data sources.
addrs.NewDefaultProvider("testing"): func() (providers.Interface, error) {
return stacks_testing_provider.NewProvider(t), nil
},
addrs.NewBuiltInProvider("testing"): func() (providers.Interface, error) {
return stacks_testing_provider.NewProvider(t), nil
},
// We also support an "other" provider out of the box to
// test the provider aliasing feature.
addrs.NewDefaultProvider("other"): func() (providers.Interface, error) {
return stacks_testing_provider.NewProvider(t), nil
},
},
dependencyLocks: *lock,
}
testContext.Validate(t, ctx, TestCycle{
wantValidateDiags: tc.diags(),
})
})
}
}
func TestValidate(t *testing.T) {
tcs := map[string]struct {
path string
providers map[addrs.Provider]providers.Factory
locks *depsfile.Locks
wantDiags tfdiags.Diagnostics
}{
"embedded-stack-selfref": {
path: "validate-embedded-stack-selfref",
wantDiags: initDiags(func(diags tfdiags.Diagnostics) tfdiags.Diagnostics {
return diags.Append(tfdiags.Sourceless(
tfdiags.Error,
"Self-dependent items in configuration",
`The following items in your configuration form a circular dependency chain through their references:
- stack.a collected outputs
- stack.a.output.a
- stack.a inputs
Terraform uses references to decide a suitable order for performing operations, so configuration items may not refer to their own results either directly or indirectly.`,
))
}),
},
"cyclic-component-dependency": {
path: "validate-cyclic-dependency",
wantDiags: initDiags(func(diags tfdiags.Diagnostics) tfdiags.Diagnostics {
return diags.Append(tfdiags.Sourceless(
tfdiags.Error,
"Self-dependent items in configuration",
`The following items in your configuration form a circular dependency chain through their references:
- component.boundary
- component.vault-config
Terraform uses references to decide a suitable order for performing operations, so configuration items may not refer to their own results either directly or indirectly.`,
))
}),
},
"missing-provider-from-lockfile": {
path: filepath.Join("with-single-input", "input-from-component"),
providers: map[addrs.Provider]providers.Factory{
addrs.NewDefaultProvider("testing"): func() (providers.Interface, error) {
return stacks_testing_provider.NewProvider(t), nil
},
},
locks: depsfile.NewLocks(), // deliberately empty
wantDiags: initDiags(func(diags tfdiags.Diagnostics) tfdiags.Diagnostics {
return diags.Append(&hcl.Diagnostic{
Severity: hcl.DiagError,
Summary: "Provider missing from lockfile",
Detail: "Provider \"registry.terraform.io/hashicorp/testing\" is not in the lockfile. This provider must be in the lockfile to be used in the configuration. Please run `tfstacks providers lock` to update the lockfile and run this operation again with an updated configuration.",
Subject: &hcl.Range{
Filename: "git::https://example.com/test.git//with-single-input/input-from-component/input-from-component.tfstack.hcl",
Start: hcl.Pos{Line: 8, Column: 1, Byte: 98},
End: hcl.Pos{Line: 8, Column: 29, Byte: 126},
},
})
}),
},
"implied-provider-type-with-hashicorp-provider": {
path: filepath.Join("legacy-module", "with-hashicorp-provider"),
providers: map[addrs.Provider]providers.Factory{
addrs.NewDefaultProvider("testing"): func() (providers.Interface, error) {
return stacks_testing_provider.NewProvider(t), nil
},
},
},
"implied-provider-type-with-non-hashicorp-provider": {
path: filepath.Join("legacy-module", "with-non-hashicorp-provider"),
providers: map[addrs.Provider]providers.Factory{
addrs.NewProvider(addrs.DefaultProviderRegistryHost, "other", "testing"): func() (providers.Interface, error) {
return stacks_testing_provider.NewProvider(t), nil
},
},
wantDiags: initDiags(func(diags tfdiags.Diagnostics) tfdiags.Diagnostics {
return diags.Append(&hcl.Diagnostic{
Severity: hcl.DiagError,
Summary: "Invalid provider configuration",
Detail: "The provider configuration slot \"testing\" requires a configuration for provider \"registry.terraform.io/hashicorp/testing\", not for provider \"registry.terraform.io/other/testing\"." +
"\n\nThe module does not declare a source address for \"testing\" in its required_providers block, so Terraform assumed \"hashicorp/testing\" for backward-compatibility with older versions of Terraform",
Subject: &hcl.Range{
Filename: mainBundleSourceAddrStr("legacy-module/with-non-hashicorp-provider/with-non-hashicorp-provider.tfstack.hcl"),
Start: hcl.Pos{Line: 21, Column: 15, Byte: 447},
End: hcl.Pos{Line: 21, Column: 39, Byte: 471},
},
})
}),
},
}
for name, tc := range tcs {
t.Run(name, func(t *testing.T) {
ctx := context.Background()
ctx, span := tracer.Start(ctx, name)
defer span.End()
locks := tc.locks
if locks == nil {
locks = depsfile.NewLocks()
for addr := range tc.providers {
locks.SetProvider(
addr,
providerreqs.MustParseVersion("0.0.0"),
providerreqs.MustParseVersionConstraints("=0.0.0"),
providerreqs.PreferredHashes([]providerreqs.Hash{}),
)
}
}
testContext := TestContext{
config: loadMainBundleConfigForTest(t, tc.path),
providers: tc.providers,
dependencyLocks: *locks,
}
testContext.Validate(t, ctx, TestCycle{
wantValidateDiags: tc.wantDiags,
})
})
}
}