Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[QT-601] Nest scenario step variables in eval context #107

Merged
merged 1 commit into from
Sep 15, 2023
Merged

[QT-601] Nest scenario step variables in eval context #107

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions acceptance/scenarios/build_pgo/enos-sample.hcl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,10 @@ scenario "upgrade" {

step "upgrade" {
module = module.upgrade
}

variables {
az = matrix.distro
variables {
az = matrix.distro
}
}
}

Expand Down Expand Up @@ -79,10 +79,10 @@ scenario "replication" {

step "replication" {
module = module.replication
}

variables {
az = matrix.distro
variables {
az = matrix.distro
}
}
}

Expand Down
13 changes: 6 additions & 7 deletions acceptance/scenarios/sample_list/enos-sample.hcl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,10 +14,10 @@ scenario "upgrade" {

step "upgrade" {
module = module.upgrade
}

variables {
az = matrix.az
variables {
az = matrix.az
}
}
}

Expand All @@ -29,10 +29,9 @@ scenario "replication" {

step "replication" {
module = module.replication
}

variables {
az = matrix.az
variables {
az = matrix.az
}
}
}

Expand Down
4 changes: 2 additions & 2 deletions acceptance/scenarios/scenario_generate_step_vars/enos.hcl
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,12 +63,12 @@ scenario "step_vars" {

output "module_default" {
description = "a known value inherited through module defaults"
value = step.infra_default.az
value = step.infra_default.variables.az
Copy link

@moduli moduli Sep 15, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh neat. I didn't know you could do this. To clarify, this is just taking the value that you're inputting into step infra_default? I have been doing something like...

  locals {
    network_cluster  = "e2e_cluster"
  }

  step "create_docker_network_cluster" {
    module = module.docker_network
    variables {
      network_name = local.network_cluster
    }
  }

  step "create_boundary" {
    module = module.docker_boundary
    depends_on = [
      step.create_docker_network_cluster,
    ]
    variables {
      network_name     = [local.network_cluster]
    }
  }

but I could change that to...

  step "create_docker_network_cluster" {
    module = module.docker_network
    variables {
      network_name = "e2e_cluster"
    }
  }

  step "create_boundary" {
    module = module.docker_boundary
    depends_on = [
      step.create_docker_network_cluster,
    ]
    variables {
      network_name     = [step.create_docker_network_cluster.variables.network_name]
    }
  }

Is that correct?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

you can after this ships!

}

output "step_known" {
description = "a known value set at a step"
value = step.infra_west.az
value = step.infra_west.variables.az
}

output "step_reference_output_ref" {
Expand Down
4 changes: 4 additions & 0 deletions acceptance/scenarios/scenario_generate_step_vars/modules/target/main.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@ variable "ami" {
type = string
}

output "ami" {
value = var.ami
}

output "ips" {
value = ["127.0.0.1"]
}
13 changes: 11 additions & 2 deletions internal/flightplan/decoder_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,12 @@ func testRequireEqualFP(t *testing.T, fp, expected *FlightPlan) {
eAttr := expected.ScenarioBlocks[i].Scenarios[j].Steps[is].Module.Attrs[isa]
aAttr := fp.ScenarioBlocks[i].Scenarios[j].Steps[is].Module.Attrs[isa]

require.True(t, eAttr.Type().Equals(aAttr.Type()))
require.Truef(
t, eAttr.Type().Equals(aAttr.Type()),
fmt.Sprintf("expected %s type to have type %s, got %s",
isa, eAttr.Type().GoString(), aAttr.Type().GoString(),
),
)
if !eAttr.IsNull() {
testMostlyEqualStepVar(t, eAttr, aAttr)
}
Expand All @@ -209,7 +214,11 @@ func testMostlyEqualStepVar(t *testing.T, expected cty.Value, got cty.Value) {
aVal, diags := StepVariableFromVal(got)
require.False(t, diags.HasErrors(), diags.Error())
require.EqualValues(t, eVal.Value, aVal.Value)
require.Len(t, eVal.Traversal, len(aVal.Traversal))
require.Lenf(t, eVal.Traversal, len(aVal.Traversal),
"expected %s to have a traversal of: %+v, got: %+v", eVal.Value.GoString(),
eVal.Traversal, aVal.Traversal,
)

for i := range eVal.Traversal {
if i == 0 {
eAttr, ok := eVal.Traversal[i].(hcl.TraverseRoot)
Expand Down
9 changes: 3 additions & 6 deletions internal/flightplan/scenario_step.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -821,17 +821,14 @@ func (ss *ScenarioStep) insertIntoCtx(ctx *hcl.EvalContext) hcl.Diagnostics {
}

vals := map[string]cty.Value{
"source": cty.StringVal(ss.Module.Source),
"name": cty.StringVal(ss.Name),
"source": cty.StringVal(ss.Module.Source),
"name": cty.StringVal(ss.Name),
"variables": cty.ObjectVal(ss.Module.Attrs),
}
if ss.Module.Version != "" {
vals["version"] = cty.StringVal(ss.Module.Version)
}

for k, v := range ss.Module.Attrs {
vals[k] = v
}

steps[ss.Name] = cty.ObjectVal(vals)
if ctx.Variables == nil {
ctx.Variables = map[string]cty.Value{}
Expand Down
143 changes: 123 additions & 20 deletions internal/flightplan/scenario_step_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -625,24 +625,25 @@ scenario "step_vars" {
step "one" {
module = module.one

variables {
variables {
concrete = "oneconcrete"
matrixinput = matrix.input
}
matrixinput = matrix.input
}
}

step "two" {
module = module.two

variables {
concrete = "twoconcrete"
inherited_concrete = step.one.concrete
reference = step.one.reference
oneattr = step.one.oneattr
matrixconcrete = matrix.input
matrixinherited = step.one.matrixinput
fromvariables = var.something
}
variables {
concrete = "twoconcrete"
reference = step.one.reference
reference_same_name = step.one.concrete
inherited_concrete = step.one.variables.concrete
oneattr = step.one.oneattr
matrixconcrete = matrix.input
matrixreference = step.one.matrixinput
fromvariables = var.something
}
}
}
`, modulePath),
Expand Down Expand Up @@ -693,14 +694,116 @@ scenario "step_vars" {
Name: "two",
Source: modulePath,
Attrs: map[string]cty.Value{
"twoattr": testMakeStepVarValue(cty.StringVal("twoattrval")),
"concrete": testMakeStepVarValue(cty.StringVal("twoconcrete")),
"inherited_concrete": testMakeStepVarValue(cty.StringVal("oneconcrete")),
"reference": testMakeStepVarTraversal("step", "one", "reference"),
"oneattr": testMakeStepVarValue(cty.StringVal("oneattrval")),
"matrixconcrete": testMakeStepVarValue(cty.StringVal("matrixinput")),
"matrixinherited": testMakeStepVarValue(cty.StringVal("matrixinput")),
"fromvariables": testMakeStepVarValue(cty.StringVal("somethingval")),
"twoattr": testMakeStepVarValue(cty.StringVal("twoattrval")),
"concrete": testMakeStepVarValue(cty.StringVal("twoconcrete")),
"inherited_concrete": testMakeStepVarValue(cty.StringVal("oneconcrete")),
"reference": testMakeStepVarTraversal("step", "one", "reference"),
"reference_same_name": testMakeStepVarTraversal("step", "one", "concrete"),
"oneattr": testMakeStepVarTraversal("step", "one", "oneattr"),
"matrixconcrete": testMakeStepVarValue(cty.StringVal("matrixinput")),
"matrixreference": testMakeStepVarTraversal("step", "one", "matrixinput"),
"fromvariables": testMakeStepVarValue(cty.StringVal("somethingval")),
},
},
},
},
},
},
},
},
},
},
{
desc: "step variables with vars and outputs of same name",
hcl: fmt.Sprintf(`
module "cluster" {
source = "%s"
}

module "worker" {
source = "%[1]s"
}

variable "addr" {
type = string
default = "http://192.168.0.1"
}

scenario "boundary" {
step "cluster" {
module = module.cluster

variables {
addr = var.addr
}
}

step "worker" {
module = module.worker

variables {
upstream_addr = step.cluster.addr
}
}

step "worker_downstream" {
module = module.worker

variables {
upstream_addr = step.worker.upstream_addr
}
}
}
`, modulePath),
expected: &FlightPlan{
TerraformCLIs: []*TerraformCLI{
DefaultTerraformCLI(),
},
Modules: []*Module{
{
Name: "cluster",
Source: modulePath,
},
{
Name: "worker",
Source: modulePath,
},
},
ScenarioBlocks: DecodedScenarioBlocks{
{
Name: "boundary",
Scenarios: []*Scenario{
{
Name: "boundary",
TerraformCLI: DefaultTerraformCLI(),
Steps: []*ScenarioStep{
{
Name: "cluster",
Module: &Module{
Name: "cluster",
Source: modulePath,
Attrs: map[string]cty.Value{
"addr": testMakeStepVarValue(cty.StringVal("http://192.168.0.1")),
},
},
},
{
Name: "worker",
Module: &Module{
Name: "worker",
Source: modulePath,
Attrs: map[string]cty.Value{
"upstream_addr": testMakeStepVarTraversal("step", "cluster", "addr"),
},
},
},
{
Name: "worker_downstream",
Module: &Module{
Name: "worker",
Source: modulePath,
Attrs: map[string]cty.Value{
"upstream_addr": testMakeStepVarTraversal("step", "worker", "upstream_addr"),
},
},
},
Expand Down