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

command/jsonplan: fix bug with nested modules output #23092

Merged
merged 1 commit into from
Oct 17, 2019
Merged

command/jsonplan: fix bug with nested modules output #23092

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
26 changes: 23 additions & 3 deletions command/jsonplan/values.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -96,16 +96,36 @@ func marshalPlannedValues(changes *plans.Changes, schemas *terraform.Schemas) (m
containingModule := resource.Addr.Module.String()
moduleResourceMap[containingModule] = append(moduleResourceMap[containingModule], resource.Addr)

// root has no parents.
if containingModule != "" {
// the root module has no parents
if !resource.Addr.Module.IsRoot() {
parent := resource.Addr.Module.Parent().String()
// we likely will see multiple resources in one module, so we
// we expect to see multiple resources in one module, so we
// only need to report the "parent" module for each child module
// once.
if !seenModules[containingModule] {
moduleMap[parent] = append(moduleMap[parent], resource.Addr.Module)
seenModules[containingModule] = true
}

// If any given parent module has no resources, it needs to be
// added to the moduleMap. This walks through the current
// resources' modules' ancestors, taking advantage of the fact
// that Ancestors() returns an ordered slice, and verifies that
// each one is in the map.
ancestors := resource.Addr.Module.Ancestors()
for i, ancestor := range ancestors[:len(ancestors)-1] {
Copy link
Contributor

Choose a reason for hiding this comment

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

It took me a little to understand the slicing here -- you drop the last so that you can do the i+1, I figured. I looked at Ancestors and it looks like this always includes the root module, so is it necessary to check that? Basically means that the first pass of this loop does what we've already done above, yes?

And if that is true, would that mean we could remove the above and just let this loop run? (this is an untested theory)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Unfortunately, no. I tried a few variations and ended up with either missing or duplicate results that way.

Copy link
Contributor

Choose a reason for hiding this comment

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

Fair enough!

aStr := ancestor.String()

// childStr here is the immediate child of the current step
childStr := ancestors[i+1].String()
// we likely will see multiple resources in one module, so we
// only need to report the "parent" module for each child module
// once.
if !seenModules[childStr] {
moduleMap[aStr] = append(moduleMap[aStr], ancestors[i+1])
seenModules[childStr] = true
}
}
}
}
}
Expand Down
9 changes: 6 additions & 3 deletions command/testdata/show-json/nested-modules/modules/more-modules/main.tf
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
variable "ok" {
default = "something"
description = "description"
variable "test_var" {
default = "bar-var"
}

resource "test_instance" "test" {
ami = var.test_var
}
77 changes: 69 additions & 8 deletions command/testdata/show-json/nested-modules/output.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,54 @@
{
"format_version": "0.1",
"terraform_version": "0.12.1-dev",
"planned_values": {
"root_module": {}
"root_module": {
"child_modules": [
{
"address": "module.my_module",
"child_modules": [
{
"resources": [
{
"address": "module.my_module.module.more.test_instance.test",
"mode": "managed",
"type": "test_instance",
"name": "test",
"provider_name": "test",
"schema_version": 0,
"values": {
"ami": "bar-var"
}
}
],
"address": "module.my_module.module.more"
}
]
}
]
}
},
"resource_changes": [
{
"address": "module.my_module.module.more.test_instance.test",
"module_address": "module.my_module.module.more",
"mode": "managed",
"type": "test_instance",
"name": "test",
"provider_name": "test",
"change": {
"actions": [
"create"
],
"before": null,
"after": {
"ami": "bar-var"
},
"after_unknown": {
"id": true
}
}
}
],
"configuration": {
"root_module": {
"module_calls": {
Expand All @@ -12,20 +57,36 @@
"module": {
"module_calls": {
"more": {
"source": "./more-modules",
"module": {
"resources": [
{
"address": "test_instance.test",
"mode": "managed",
"type": "test_instance",
"name": "test",
"provider_config_key": "more:test",
"expressions": {
"ami": {
"references": [
"var.test_var"
]
}
},
"schema_version": 0
}
],
"variables": {
"ok": {
"default": "something",
"description": "description"
"test_var": {
"default": "bar-var"
}
}
},
"source": "./more-modules"
}
}
}
}
}
}
}
}
}
}