mirror of https://github.com/hashicorp/terraform
testing framework: allow providers to reference run blocks (#34118)
* testing framework: allow providers to reference run block * missing copywrite headerpull/34190/head
Liam Cervante
3 years ago
committed by
GitHub
parent
10f4567fcc
commit
f90d71f723
@ -0,0 +1,6 @@
|
||||
|
||||
provider "test" {
|
||||
resource_prefix = var.default
|
||||
}
|
||||
|
||||
run "test" {}
|
||||
@ -0,0 +1 @@
|
||||
resource "test_resource" "foo" {}
|
||||
@ -0,0 +1,24 @@
|
||||
variables {
|
||||
resource_directory = "resources"
|
||||
}
|
||||
|
||||
provider "test" {
|
||||
alias = "setup"
|
||||
resource_prefix = var.resource_directory
|
||||
}
|
||||
|
||||
run "setup" {
|
||||
module {
|
||||
source = "./setup"
|
||||
}
|
||||
|
||||
providers = {
|
||||
test = test.setup
|
||||
}
|
||||
}
|
||||
|
||||
provider "test" {
|
||||
resource_prefix = run.setup.resource_directory
|
||||
}
|
||||
|
||||
run "main" {}
|
||||
@ -0,0 +1,11 @@
|
||||
variable "resource_directory" {
|
||||
type = string
|
||||
}
|
||||
|
||||
resource "test_resource" "foo" {
|
||||
value = var.resource_directory
|
||||
}
|
||||
|
||||
output "resource_directory" {
|
||||
value = test_resource.foo.value
|
||||
}
|
||||
@ -0,0 +1,11 @@
|
||||
variable "resource_directory" {
|
||||
type = string
|
||||
}
|
||||
|
||||
resource "test_resource" "foo" {
|
||||
value = var.resource_directory
|
||||
}
|
||||
|
||||
output "resource_directory" {
|
||||
value = test_resource.foo.value
|
||||
}
|
||||
@ -0,0 +1,9 @@
|
||||
provider "test" {
|
||||
resource_prefix = run.missing.resource_directory
|
||||
}
|
||||
|
||||
run "main" {
|
||||
variables {
|
||||
resource_directory = "resource"
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,9 @@
|
||||
provider "test" {
|
||||
resource_prefix = run.main.resource_directory
|
||||
}
|
||||
|
||||
run "main" {
|
||||
variables {
|
||||
resource_directory = "resource"
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,17 @@
|
||||
provider "test" {
|
||||
resource_prefix = run.main.resource_directory
|
||||
}
|
||||
|
||||
provider "test" {
|
||||
alias = "usable"
|
||||
}
|
||||
|
||||
run "main" {
|
||||
providers = {
|
||||
test = test.usable
|
||||
}
|
||||
|
||||
variables {
|
||||
resource_directory = "resource"
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,272 @@
|
||||
// Copyright (c) HashiCorp, Inc.
|
||||
// SPDX-License-Identifier: BUSL-1.1
|
||||
|
||||
package hcl
|
||||
|
||||
import (
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
"github.com/google/go-cmp/cmp"
|
||||
"github.com/hashicorp/hcl/v2"
|
||||
"github.com/hashicorp/hcl/v2/hclsyntax"
|
||||
"github.com/zclconf/go-cty/cty"
|
||||
|
||||
"github.com/hashicorp/terraform/internal/addrs"
|
||||
"github.com/hashicorp/terraform/internal/backend"
|
||||
"github.com/hashicorp/terraform/internal/configs"
|
||||
"github.com/hashicorp/terraform/internal/states"
|
||||
"github.com/hashicorp/terraform/internal/terraform"
|
||||
"github.com/hashicorp/terraform/internal/tfdiags"
|
||||
)
|
||||
|
||||
func TestProviderConfig(t *testing.T) {
|
||||
|
||||
tcs := map[string]struct {
|
||||
content string
|
||||
schema *hcl.BodySchema
|
||||
variables map[string]cty.Value
|
||||
runBlockOutputs map[string]map[string]cty.Value
|
||||
validate func(t *testing.T, content *hcl.BodyContent)
|
||||
expectedErrors []string
|
||||
}{
|
||||
"simple_no_vars": {
|
||||
content: "attribute = \"string\"",
|
||||
schema: &hcl.BodySchema{
|
||||
Attributes: []hcl.AttributeSchema{
|
||||
{
|
||||
Name: "attribute",
|
||||
},
|
||||
},
|
||||
},
|
||||
validate: func(t *testing.T, content *hcl.BodyContent) {
|
||||
equals(t, content, "attribute", cty.StringVal("string"))
|
||||
},
|
||||
},
|
||||
"simple_var_ref": {
|
||||
content: "attribute = var.input",
|
||||
schema: &hcl.BodySchema{
|
||||
Attributes: []hcl.AttributeSchema{
|
||||
{
|
||||
Name: "attribute",
|
||||
},
|
||||
},
|
||||
},
|
||||
variables: map[string]cty.Value{
|
||||
"input": cty.StringVal("string"),
|
||||
},
|
||||
validate: func(t *testing.T, content *hcl.BodyContent) {
|
||||
equals(t, content, "attribute", cty.StringVal("string"))
|
||||
},
|
||||
},
|
||||
"missing_var_ref": {
|
||||
content: "attribute = var.missing",
|
||||
schema: &hcl.BodySchema{
|
||||
Attributes: []hcl.AttributeSchema{
|
||||
{
|
||||
Name: "attribute",
|
||||
},
|
||||
},
|
||||
},
|
||||
variables: map[string]cty.Value{
|
||||
"input": cty.StringVal("string"),
|
||||
},
|
||||
expectedErrors: []string{
|
||||
"The input variable \"missing\" is not available to the current run block. You can only reference variables defined at the file or global levels when populating the variables block within a run block.",
|
||||
},
|
||||
validate: func(t *testing.T, content *hcl.BodyContent) {
|
||||
if len(content.Attributes) > 0 {
|
||||
t.Errorf("should have excluded the invalid attribute but found %d", len(content.Attributes))
|
||||
}
|
||||
},
|
||||
},
|
||||
"simple_run_block": {
|
||||
content: "attribute = run.setup.value",
|
||||
schema: &hcl.BodySchema{
|
||||
Attributes: []hcl.AttributeSchema{
|
||||
{
|
||||
Name: "attribute",
|
||||
},
|
||||
},
|
||||
},
|
||||
runBlockOutputs: map[string]map[string]cty.Value{
|
||||
"setup": {
|
||||
"value": cty.StringVal("string"),
|
||||
},
|
||||
},
|
||||
validate: func(t *testing.T, content *hcl.BodyContent) {
|
||||
equals(t, content, "attribute", cty.StringVal("string"))
|
||||
},
|
||||
},
|
||||
"missing_run_block": {
|
||||
content: "attribute = run.missing.value",
|
||||
schema: &hcl.BodySchema{
|
||||
Attributes: []hcl.AttributeSchema{
|
||||
{
|
||||
Name: "attribute",
|
||||
},
|
||||
},
|
||||
},
|
||||
runBlockOutputs: map[string]map[string]cty.Value{
|
||||
"setup": {
|
||||
"value": cty.StringVal("string"),
|
||||
},
|
||||
},
|
||||
expectedErrors: []string{
|
||||
"The run block \"missing\" does not exist within this test file. You can only reference run blocks that are in the same test file and will execute before the provider is required.",
|
||||
},
|
||||
validate: func(t *testing.T, content *hcl.BodyContent) {
|
||||
if len(content.Attributes) > 0 {
|
||||
t.Errorf("should have excluded the invalid attribute but found %d", len(content.Attributes))
|
||||
}
|
||||
},
|
||||
},
|
||||
"late_run_block": {
|
||||
content: "attribute = run.setup.value",
|
||||
schema: &hcl.BodySchema{
|
||||
Attributes: []hcl.AttributeSchema{
|
||||
{
|
||||
Name: "attribute",
|
||||
},
|
||||
},
|
||||
},
|
||||
runBlockOutputs: map[string]map[string]cty.Value{
|
||||
"setup": nil,
|
||||
},
|
||||
expectedErrors: []string{
|
||||
"The run block \"setup\" has not executed yet. You can only reference run blocks that are in the same test file and will execute before the provider is required.",
|
||||
},
|
||||
validate: func(t *testing.T, content *hcl.BodyContent) {
|
||||
if len(content.Attributes) > 0 {
|
||||
t.Errorf("should have excluded the invalid attribute but found %d", len(content.Attributes))
|
||||
}
|
||||
},
|
||||
},
|
||||
"invalid_ref": {
|
||||
content: "attribute = data.type.name.value",
|
||||
schema: &hcl.BodySchema{
|
||||
Attributes: []hcl.AttributeSchema{
|
||||
{
|
||||
Name: "attribute",
|
||||
},
|
||||
},
|
||||
},
|
||||
runBlockOutputs: map[string]map[string]cty.Value{
|
||||
"setup": nil,
|
||||
},
|
||||
expectedErrors: []string{
|
||||
"You can only reference earlier run blocks, file level, and global variables while defining variables from inside a run block.",
|
||||
},
|
||||
validate: func(t *testing.T, content *hcl.BodyContent) {
|
||||
if len(content.Attributes) > 0 {
|
||||
t.Errorf("should have excluded the invalid attribute but found %d", len(content.Attributes))
|
||||
}
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
for name, tc := range tcs {
|
||||
t.Run(name, func(t *testing.T) {
|
||||
|
||||
file, diags := hclsyntax.ParseConfig([]byte(tc.content), "main.tf", hcl.Pos{Line: 1, Column: 1})
|
||||
if diags.HasErrors() {
|
||||
t.Fatalf("failed to parse hcl: %s", diags.Error())
|
||||
}
|
||||
|
||||
config := ProviderConfig{
|
||||
Original: file.Body,
|
||||
ConfigVariables: func() map[string]*configs.Variable {
|
||||
variables := make(map[string]*configs.Variable)
|
||||
for variable := range tc.variables {
|
||||
variables[variable] = &configs.Variable{
|
||||
Name: variable,
|
||||
}
|
||||
}
|
||||
return variables
|
||||
}(),
|
||||
AvailableVariables: func() map[string]backend.UnparsedVariableValue {
|
||||
variables := make(map[string]backend.UnparsedVariableValue)
|
||||
for name, value := range tc.variables {
|
||||
variables[name] = &variable{value}
|
||||
}
|
||||
return variables
|
||||
}(),
|
||||
AvailableRunBlocks: func() map[string]*terraform.TestContext {
|
||||
statuses := make(map[string]*terraform.TestContext)
|
||||
for name, values := range tc.runBlockOutputs {
|
||||
if values == nil {
|
||||
statuses[name] = nil
|
||||
continue
|
||||
}
|
||||
|
||||
state := states.BuildState(func(state *states.SyncState) {
|
||||
for name, value := range values {
|
||||
state.SetOutputValue(addrs.AbsOutputValue{
|
||||
Module: addrs.RootModuleInstance,
|
||||
OutputValue: addrs.OutputValue{
|
||||
Name: name,
|
||||
},
|
||||
}, value, false)
|
||||
}
|
||||
})
|
||||
|
||||
config := &configs.Config{
|
||||
Module: &configs.Module{
|
||||
Outputs: func() map[string]*configs.Output {
|
||||
outputs := make(map[string]*configs.Output)
|
||||
for name := range values {
|
||||
outputs[name] = &configs.Output{
|
||||
Name: name,
|
||||
}
|
||||
}
|
||||
return outputs
|
||||
}(),
|
||||
},
|
||||
}
|
||||
|
||||
statuses[name] = &terraform.TestContext{
|
||||
Config: config,
|
||||
State: state,
|
||||
}
|
||||
}
|
||||
return statuses
|
||||
}(),
|
||||
}
|
||||
|
||||
content, diags := config.Content(tc.schema)
|
||||
|
||||
var actualErrs []string
|
||||
for _, diag := range diags {
|
||||
actualErrs = append(actualErrs, diag.Detail)
|
||||
}
|
||||
if diff := cmp.Diff(actualErrs, tc.expectedErrors); len(diff) > 0 {
|
||||
t.Errorf("unmatched errors\nexpected:\n%s\nactual:\n%s\ndiff:\n%s", strings.Join(tc.expectedErrors, "\n"), strings.Join(actualErrs, "\n"), diff)
|
||||
}
|
||||
|
||||
tc.validate(t, content)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func equals(t *testing.T, content *hcl.BodyContent, attribute string, expected cty.Value) {
|
||||
value, diags := content.Attributes[attribute].Expr.Value(nil)
|
||||
if diags.HasErrors() {
|
||||
t.Errorf("failed to get value from attribute %s: %s", attribute, diags.Error())
|
||||
}
|
||||
if !value.RawEquals(expected) {
|
||||
t.Errorf("expected:\n%s\nbut got:\n%s", expected.GoString(), value.GoString())
|
||||
}
|
||||
}
|
||||
|
||||
var _ backend.UnparsedVariableValue = (*variable)(nil)
|
||||
|
||||
type variable struct {
|
||||
value cty.Value
|
||||
}
|
||||
|
||||
func (v *variable) ParseVariableValue(mode configs.VariableParsingMode) (*terraform.InputValue, tfdiags.Diagnostics) {
|
||||
return &terraform.InputValue{
|
||||
Value: v.value,
|
||||
SourceType: terraform.ValueFromUnknown,
|
||||
}, nil
|
||||
}
|
||||
Loading…
Reference in new issue