resilien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #30525 from nozaq/provider-config-default 

jsonconfig: fix keys for default providers
This commit is contained in:
Alisdair McDiarmid 2022-02-22 16:13:41 -05:00 committed by GitHub
parent 17492285f4 3c32f7a56c
commit 70db495d00
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
23 changed files with 713 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
internal/command/command_test.go
View File

@ -171,7 +171,8 @@ func testFixturePath(name string) string {
func metaOverridesForProvider(p providers.Interface) *testingOverrides {
return &testingOverrides{
Providers: map[addrs.Provider]providers.Factory{
addrs.NewDefaultProvider("test"): providers.FactoryFixed(p),
addrs.NewDefaultProvider("test"): providers.FactoryFixed(p),
addrs.NewProvider(addrs.DefaultProviderRegistryHost, "hashicorp2", "test"): providers.FactoryFixed(p),
},
}
}

68
internal/command/jsonconfig/config.go
View File

@ -231,6 +231,36 @@ func marshalProviderConfigs(
p.VersionConstraint = getproviders.VersionConstraintsString(vc)
}
if c.Parent != nil {
parentKey := opaqueProviderKey(pr.Name, c.Parent.Path.String())
p.parentKey = findSourceProviderKey(parentKey, p.FullName, m)
}
m[key] = p
}
// Providers could be implicitly created or inherited from the parent module
// when no requirements and configuration block defined.
for req := range reqs {
// Only default providers could implicitly exist,
// so the provider name must be same as the provider type.
key := opaqueProviderKey(req.Type, c.Path.String())
if _, exists := m[key]; exists {
continue
}
p := providerConfig{
Name: req.Type,
FullName: req.String(),
ModuleAddress: c.Path.String(),
}
// In child modules, providers defined in the parent module can be implicitly used.
if c.Parent != nil {
parentKey := opaqueProviderKey(req.Type, c.Parent.Path.String())
p.parentKey = findSourceProviderKey(parentKey, p.FullName, m)
}
m[key] = p
}
@ -259,22 +289,7 @@ func marshalProviderConfigs(
key := opaqueProviderKey(moduleProviderName, cc.Path.String())
parentKey := opaqueProviderKey(parentProviderName, cc.Parent.Path.String())
// Traverse up the module call tree until we find the provider
// configuration which has no linked parent config. This is then
// the source of the configuration used in this module call, so
// we link to it directly
for {
parent, exists := m[parentKey]
if !exists {
break
}
p.parentKey = parentKey
parentKey = parent.parentKey
if parentKey == "" {
break
}
}
p.parentKey = findSourceProviderKey(parentKey, p.FullName, m)
m[key] = p
}
@ -527,3 +542,24 @@ func opaqueProviderKey(provider string, addr string) (key string) {
}
return key
}
// Traverse up the module call tree until we find the provider
// configuration which has no linked parent config. This is then
// the source of the configuration used in this module call, so
// we link to it directly
func findSourceProviderKey(startKey string, fullName string, m map[string]providerConfig) string {
var parentKey string
key := startKey
for key != "" {
parent, exists := m[key]
if !exists || parent.FullName != fullName {
break
}
parentKey = key
key = parent.parentKey
}
return parentKey
}

100
internal/command/jsonconfig/config_test.go Normal file
View File

@ -0,0 +1,100 @@
package jsonconfig
import (
"testing"
)
func TestFindSourceProviderConfig(t *testing.T) {
tests := []struct {
StartKey string
FullName string
ProviderMap map[string]providerConfig
Want string
}{
{
StartKey: "null",
FullName: "hashicorp/null",
ProviderMap: map[string]providerConfig{},
Want: "",
},
{
StartKey: "null",
FullName: "hashicorp/null",
ProviderMap: map[string]providerConfig{
"null": {
Name: "null",
FullName: "hashicorp/null",
ModuleAddress: "",
},
},
Want: "null",
},
{
StartKey: "null2",
FullName: "hashicorp/null",
ProviderMap: map[string]providerConfig{
"null": {
Name: "null",
FullName: "hashicorp/null",
ModuleAddress: "",
},
},
Want: "",
},
{
StartKey: "null",
FullName: "hashicorp2/null",
ProviderMap: map[string]providerConfig{
"null": {
Name: "null",
FullName: "hashicorp/null",
ModuleAddress: "",
},
},
Want: "",
},
{
StartKey: "module.a:null",
FullName: "hashicorp/null",
ProviderMap: map[string]providerConfig{
"null": {
Name: "null",
FullName: "hashicorp/null",
ModuleAddress: "",
},
"module.a:null": {
Name: "module.a:null",
FullName: "hashicorp/null",
ModuleAddress: "module.a",
parentKey: "null",
},
},
Want: "null",
},
{
StartKey: "module.a:null",
FullName: "hashicorp2/null",
ProviderMap: map[string]providerConfig{
"null": {
Name: "null",
FullName: "hashicorp/null",
ModuleAddress: "",
},
"module.a:null": {
Name: "module.a:null",
FullName: "hashicorp2/null",
ModuleAddress: "module.a",
parentKey: "null",
},
},
Want: "module.a:null",
},
}
for _, test := range tests {
got := findSourceProviderKey(test.StartKey, test.FullName, test.ProviderMap)
if got != test.Want {
t.Errorf("wrong result:\nGot: %#v\nWant: %#v\n", got, test.Want)
}
}
}

3
internal/command/show_test.go
View File

@ -493,7 +493,8 @@ func TestShow_json_output(t *testing.T) {
expectError := strings.Contains(entry.Name(), "error")
providerSource, close := newMockProviderSource(t, map[string][]string{
"test": {"1.2.3"},
"test": {"1.2.3"},
"hashicorp2/test": {"1.2.3"},
})
defer close()

6
internal/command/testdata/show-json/basic-delete/output.json vendored
View File

@ -130,6 +130,12 @@
}
},
"configuration": {
"provider_config": {
"test": {
"name": "test",
"full_name": "registry.terraform.io/hashicorp/test"
}
},
"root_module": {
"outputs": {
"test": {

6
internal/command/testdata/show-json/basic-update/output.json vendored
View File

@ -96,6 +96,12 @@
}
},
"configuration": {
"provider_config": {
"test": {
"name": "test",
"full_name": "registry.terraform.io/hashicorp/test"
}
},
"root_module": {
"outputs": {
"test": {

6
internal/command/testdata/show-json/drift/output.json vendored
View File

@ -141,6 +141,12 @@
}
},
"configuration": {
"provider_config": {
"test": {
"name": "test",
"full_name": "registry.terraform.io/hashicorp/test"
}
},
"root_module": {
"resources": [
{

6
internal/command/testdata/show-json/module-depends-on/output.json vendored
View File

@ -43,6 +43,12 @@
}
],
"configuration": {
"provider_config": {
"test": {
"name": "test",
"full_name": "registry.terraform.io/hashicorp/test"
}
},
"root_module": {
"resources": [
{

5
internal/command/testdata/show-json/modules/output.json vendored
View File

@ -293,6 +293,11 @@
"module_address": "module.module_test_foo",
"name": "test",
"full_name": "registry.terraform.io/hashicorp/test"
},
"module.module_test_bar:test": {
"module_address": "module.module_test_bar",
"name": "test",
"full_name": "registry.terraform.io/hashicorp/test"
}
}
}

6
internal/command/testdata/show-json/moved-drift/output.json vendored
View File

@ -143,6 +143,12 @@
}
},
"configuration": {
"provider_config": {
"test": {
"name": "test",
"full_name": "registry.terraform.io/hashicorp/test"
}
},
"root_module": {
"resources": [
{

6
internal/command/testdata/show-json/moved/output.json vendored
View File

@ -68,6 +68,12 @@
}
},
"configuration": {
"provider_config": {
"test": {
"name": "test",
"full_name": "registry.terraform.io/hashicorp/test"
}
},
"root_module": {
"resources": [
{

6
internal/command/testdata/show-json/multi-resource-update/output.json vendored
View File

@ -137,6 +137,12 @@
}
},
"configuration": {
"provider_config": {
"test": {
"name": "test",
"full_name": "registry.terraform.io/hashicorp/test"
}
},
"root_module": {
"outputs": {
"test": {

15
internal/command/testdata/show-json/nested-modules/output.json vendored
View File

@ -37,9 +37,7 @@
"name": "test",
"provider_name": "registry.terraform.io/hashicorp/test",
"change": {
"actions": [
"create"
],
"actions": ["create"],
"before": null,
"after": {
"ami": "bar-var"
@ -53,6 +51,13 @@
}
],
"configuration": {
"provider_config": {
"module.my_module.module.more:test": {
"module_address": "module.my_module.module.more",
"name": "test",
"full_name": "registry.terraform.io/hashicorp/test"
}
},
"root_module": {
"module_calls": {
"my_module": {
@ -71,9 +76,7 @@
"provider_config_key": "module.my_module.module.more:test",
"expressions": {
"ami": {
"references": [
"var.test_var"
]
"references": ["var.test_var"]
}
},
"schema_version": 0

11
internal/command/testdata/show-json/provider-aliasing-conflict/child/main.tf vendored Normal file
View File

@ -0,0 +1,11 @@
terraform {
required_providers {
test = {
source = "hashicorp2/test"
}
}
}
resource "test_instance" "test" {
ami = "bar"
}

11
internal/command/testdata/show-json/provider-aliasing-conflict/main.tf vendored Normal file
View File

@ -0,0 +1,11 @@
provider "test" {
region = "somewhere"
}
resource "test_instance" "test" {
ami = "foo"
}
module "child" {
source = "./child"
}

143
internal/command/testdata/show-json/provider-aliasing-conflict/output.json vendored Normal file
View File

@ -0,0 +1,143 @@
{
"format_version": "1.0",
"terraform_version": "1.1.0-dev",
"planned_values": {
"root_module": {
"resources": [
{
"address": "test_instance.test",
"mode": "managed",
"type": "test_instance",
"name": "test",
"provider_name": "registry.terraform.io/hashicorp/test",
"schema_version": 0,
"values": {
"ami": "foo"
},
"sensitive_values": {}
}
],
"child_modules": [
{
"resources": [
{
"address": "module.child.test_instance.test",
"mode": "managed",
"type": "test_instance",
"name": "test",
"provider_name": "registry.terraform.io/hashicorp2/test",
"schema_version": 0,
"values": {
"ami": "bar"
},
"sensitive_values": {}
}
],
"address": "module.child"
}
]
}
},
"resource_changes": [
{
"address": "module.child.test_instance.test",
"module_address": "module.child",
"mode": "managed",
"type": "test_instance",
"name": "test",
"provider_name": "registry.terraform.io/hashicorp2/test",
"change": {
"actions": [
"create"
],
"before": null,
"after": {
"ami": "bar"
},
"after_unknown": {
"id": true
},
"before_sensitive": false,
"after_sensitive": {}
}
},
{
"address": "test_instance.test",
"mode": "managed",
"type": "test_instance",
"name": "test",
"provider_name": "registry.terraform.io/hashicorp/test",
"change": {
"actions": [
"create"
],
"before": null,
"after": {
"ami": "foo"
},
"after_unknown": {
"id": true
},
"before_sensitive": false,
"after_sensitive": {}
}
}
],
"configuration": {
"provider_config": {
"test": {
"name": "test",
"full_name": "registry.terraform.io/hashicorp/test",
"expressions": {
"region": {
"constant_value": "somewhere"
}
}
},
"module.child:test": {
"module_address": "module.child",
"name": "test",
"full_name": "registry.terraform.io/hashicorp2/test"
}
},
"root_module": {
"resources": [
{
"address": "test_instance.test",
"mode": "managed",
"type": "test_instance",
"name": "test",
"provider_config_key": "test",
"expressions": {
"ami": {
"constant_value": "foo"
}
},
"schema_version": 0
}
],
"module_calls": {
"child": {
"source": "./child",
"module": {
"resources": [
{
"address": "test_instance.test",
"mode": "managed",
"type": "test_instance",
"name": "test",
"provider_config_key": "module.child:test",
"expressions": {
"ami": {
"constant_value": "bar"
}
},
"schema_version": 0
}
]
}
}
}
}
}
}

20
internal/command/testdata/show-json/provider-aliasing-default/child/main.tf vendored Normal file
View File

@ -0,0 +1,20 @@
terraform {
required_providers {
test = {
source = "hashicorp/test"
}
}
}
resource "test_instance" "test" {
ami = "bar"
}
module "with_requirement" {
source = "./nested"
depends_on = [module.no_requirements]
}
module "no_requirements" {
source = "./nested-no-requirements"
}

3
internal/command/testdata/show-json/provider-aliasing-default/child/nested-no-requirements/main.tf vendored Normal file
View File

@ -0,0 +1,3 @@
resource "test_instance" "test" {
ami = "qux"
}

11
internal/command/testdata/show-json/provider-aliasing-default/child/nested/main.tf vendored Normal file
View File

@ -0,0 +1,11 @@
terraform {
required_providers {
test = {
source = "hashicorp/test"
}
}
}
resource "test_instance" "test" {
ami = "baz"
}

19
internal/command/testdata/show-json/provider-aliasing-default/main.tf vendored Normal file
View File

@ -0,0 +1,19 @@
provider "test" {
region = "somewhere"
}
provider "test" {
alias = "backup"
region = "elsewhere"
}
resource "test_instance" "test" {
ami = "foo"
}
module "child" {
source = "./child"
providers = {
test = test.backup
}
}

271
internal/command/testdata/show-json/provider-aliasing-default/output.json vendored Normal file
View File

@ -0,0 +1,271 @@
{
"format_version": "1.0",
"terraform_version": "1.1.0-dev",
"planned_values": {
"root_module": {
"resources": [
{
"address": "test_instance.test",
"mode": "managed",
"type": "test_instance",
"name": "test",
"provider_name": "registry.terraform.io/hashicorp/test",
"schema_version": 0,
"values": {
"ami": "foo"
},
"sensitive_values": {}
}
],
"child_modules": [
{
"resources": [
{
"address": "module.child.test_instance.test",
"mode": "managed",
"type": "test_instance",
"name": "test",
"provider_name": "registry.terraform.io/hashicorp/test",
"schema_version": 0,
"values": {
"ami": "bar"
},
"sensitive_values": {}
}
],
"address": "module.child",
"child_modules": [
{
"resources": [
{
"address": "module.child.module.no_requirements.test_instance.test",
"mode": "managed",
"type": "test_instance",
"name": "test",
"provider_name": "registry.terraform.io/hashicorp/test",
"schema_version": 0,
"values": {
"ami": "qux"
},
"sensitive_values": {}
}
],
"address": "module.child.module.no_requirements"
},
{
"resources": [
{
"address": "module.child.module.with_requirement.test_instance.test",
"mode": "managed",
"type": "test_instance",
"name": "test",
"provider_name": "registry.terraform.io/hashicorp/test",
"schema_version": 0,
"values": {
"ami": "baz"
},
"sensitive_values": {}
}
],
"address": "module.child.module.with_requirement"
}
]
}
]
}
},
"resource_changes": [
{
"address": "module.child.module.no_requirements.test_instance.test",
"module_address": "module.child.module.no_requirements",
"mode": "managed",
"type": "test_instance",
"name": "test",
"provider_name": "registry.terraform.io/hashicorp/test",
"change": {
"actions": [
"create"
],
"before": null,
"after": {
"ami": "qux"
},
"after_unknown": {
"id": true
},
"before_sensitive": false,
"after_sensitive": {}
}
},
{
"address": "module.child.module.with_requirement.test_instance.test",
"module_address": "module.child.module.with_requirement",
"mode": "managed",
"type": "test_instance",
"name": "test",
"provider_name": "registry.terraform.io/hashicorp/test",
"change": {
"actions": [
"create"
],
"before": null,
"after": {
"ami": "baz"
},
"after_unknown": {
"id": true
},
"before_sensitive": false,
"after_sensitive": {}
}
},
{
"address": "module.child.test_instance.test",
"module_address": "module.child",
"mode": "managed",
"type": "test_instance",
"name": "test",
"provider_name": "registry.terraform.io/hashicorp/test",
"change": {
"actions": [
"create"
],
"before": null,
"after": {
"ami": "bar"
},
"after_unknown": {
"id": true
},
"before_sensitive": false,
"after_sensitive": {}
}
},
{
"address": "test_instance.test",
"mode": "managed",
"type": "test_instance",
"name": "test",
"provider_name": "registry.terraform.io/hashicorp/test",
"change": {
"actions": [
"create"
],
"before": null,
"after": {
"ami": "foo"
},
"after_unknown": {
"id": true
},
"before_sensitive": false,
"after_sensitive": {}
}
}
],
"configuration": {
"provider_config": {
"test": {
"name": "test",
"full_name": "registry.terraform.io/hashicorp/test",
"expressions": {
"region": {
"constant_value": "somewhere"
}
}
},
"test.backup": {
"name": "test",
"full_name": "registry.terraform.io/hashicorp/test",
"alias": "backup",
"expressions": {
"region": {
"constant_value": "elsewhere"
}
}
}
},
"root_module": {
"resources": [
{
"address": "test_instance.test",
"mode": "managed",
"type": "test_instance",
"name": "test",
"provider_config_key": "test",
"expressions": {
"ami": {
"constant_value": "foo"
}
},
"schema_version": 0
}
],
"module_calls": {
"child": {
"source": "./child",
"module": {
"resources": [
{
"address": "test_instance.test",
"mode": "managed",
"type": "test_instance",
"name": "test",
"provider_config_key": "test.backup",
"expressions": {
"ami": {
"constant_value": "bar"
}
},
"schema_version": 0
}
],
"module_calls": {
"no_requirements": {
"source": "./nested-no-requirements",
"module": {
"resources": [
{
"address": "test_instance.test",
"mode": "managed",
"type": "test_instance",
"name": "test",
"provider_config_key": "test.backup",
"expressions": {
"ami": {
"constant_value": "qux"
}
},
"schema_version": 0
}
]
}
},
"with_requirement": {
"source": "./nested",
"depends_on": ["module.no_requirements"],
"module": {
"resources": [
{
"address": "test_instance.test",
"mode": "managed",
"type": "test_instance",
"name": "test",
"provider_config_key": "test.backup",
"expressions": {
"ami": {
"constant_value": "baz"
}
},
"schema_version": 0
}
]
}
}
}
}
}
}
}
}
}

6
internal/command/testdata/show-json/requires-replace/output.json vendored
View File

@ -70,6 +70,12 @@
}
},
"configuration": {
"provider_config": {
"test": {
"name": "test",
"full_name": "registry.terraform.io/hashicorp/test"
}
},
"root_module": {
"resources": [
{

6
internal/command/testdata/show-json/sensitive-values/output.json vendored
View File

@ -81,6 +81,12 @@
}
},
"configuration": {
"provider_config": {
"test": {
"name": "test",
"full_name": "registry.terraform.io/hashicorp/test"
}
},
"root_module": {
"outputs": {
"test": {