Revert defaultTags schema change

- Allow the provider to parse both the old and new schemas for compatability.
pulumi · Mar 8, 2024 · 1512b95 · 1512b95
1 parent 564817d
commit 1512b95
Show file tree

Hide file tree

Showing 19 changed files with 398 additions and 60 deletions.
diff --git a/examples/examples_py_test.go b/examples/examples_py_test.go
@@ -27,7 +27,9 @@ func TestDefaultTagsPython(t *testing.T) {
 			Dir: filepath.Join(getCwd(t), "default-tags-py"),
 			Config: map[string]string{
 				"aws-native:defaultTags": `{
-					"defaultTag": "defaultTagValue"
+						"tags": {
+							"defaultTag": "defaultTagValue"
+						}
 					}`,
 			},
 			ExtraRuntimeValidation: func(t *testing.T, stackInfo integration.RuntimeValidationStackInfo) {

diff --git a/provider/cmd/cf2pulumi/schema-full.json b/provider/cmd/cf2pulumi/schema-full.json
@@ -294,10 +294,7 @@
                 "description": "Configuration for retrieving temporary credentials from the STS service."
             },
             "defaultTags": {
-                "type": "object",
-                "additionalProperties": {
-                    "type": "string"
-                },
+                "$ref": "#/types/aws-native:config:DefaultTags",
                 "description": "Configuration block with resource tag settings to apply across all resources handled by this provider. This is designed to replace redundant per-resource `tags` configurations. Provider tags can be overridden with new values, but not excluded from specific resources. To override provider tag values, use the `tags` argument within a resource to configure new tag values for matching keys."
             },
             "endpoints": {
@@ -23250,6 +23247,24 @@
             },
             "type": "object"
         },
+        "aws-native:config:DefaultTags": {
+            "description": "The configuration with resource tag settings to apply across all resources handled by this provider. This is designed to replace redundant per-resource `tags` configurations. Provider tags can be overridden with new values, but not excluded from specific resources. To override provider tag values, use the `tags` argument within a resource to configure new tag values for matching keys.",
+            "properties": {
+                "tags": {
+                    "type": "object",
+                    "additionalProperties": {
+                        "type": "string"
+                    },
+                    "description": "A group of tags to set across all resources.",
+                    "language": {
+                        "python": {
+                            "mapCase": false
+                        }
+                    }
+                }
+            },
+            "type": "object"
+        },
         "aws-native:config:Endpoints": {
             "description": "The configuration for for customizing service endpoints.",
             "properties": {
@@ -56638,6 +56653,24 @@
             },
             "type": "object"
         },
+        "aws-native:index:ProviderDefaultTags": {
+            "description": "The configuration with resource tag settings to apply across all resources handled by this provider. This is designed to replace redundant per-resource `tags` configurations. Provider tags can be overridden with new values, but not excluded from specific resources. To override provider tag values, use the `tags` argument within a resource to configure new tag values for matching keys.",
+            "properties": {
+                "tags": {
+                    "type": "object",
+                    "additionalProperties": {
+                        "type": "string"
+                    },
+                    "description": "A group of tags to set across all resources.",
+                    "language": {
+                        "python": {
+                            "mapCase": false
+                        }
+                    }
+                }
+            },
+            "type": "object"
+        },
         "aws-native:index:ProviderEndpoint": {
             "description": "The configuration for for customizing service endpoints.",
             "properties": {
@@ -153770,10 +153803,7 @@
                 "description": "Configuration for retrieving temporary credentials from the STS service."
             },
             "defaultTags": {
-                "type": "object",
-                "additionalProperties": {
-                    "type": "string"
-                },
+                "$ref": "#/types/aws-native:index:ProviderDefaultTags",
                 "description": "Configuration block with resource tag settings to apply across all resources handled by this provider. This is designed to replace redundant per-resource `tags` configurations. Provider tags can be overridden with new values, but not excluded from specific resources. To override provider tag values, use the `tags` argument within a resource to configure new tag values for matching keys."
             },
             "endpoints": {
@@ -153862,10 +153892,7 @@
                 "description": "Configuration for retrieving temporary credentials from the STS service."
             },
             "defaultTags": {
-                "type": "object",
-                "additionalProperties": {
-                    "type": "string"
-                },
+                "$ref": "#/types/aws-native:index:ProviderDefaultTags",
                 "description": "Configuration block with resource tag settings to apply across all resources handled by this provider. This is designed to replace redundant per-resource `tags` configurations. Provider tags can be overridden with new values, but not excluded from specific resources. To override provider tag values, use the `tags` argument within a resource to configure new tag values for matching keys."
             },
             "endpoints": {

diff --git a/provider/cmd/pulumi-resource-aws-native/schema.json b/provider/cmd/pulumi-resource-aws-native/schema.json
@@ -265,10 +265,7 @@
                 "description": "Configuration for retrieving temporary credentials from the STS service."
             },
             "defaultTags": {
-                "type": "object",
-                "additionalProperties": {
-                    "type": "string"
-                },
+                "$ref": "#/types/aws-native:config:DefaultTags",
                 "description": "Configuration block with resource tag settings to apply across all resources handled by this provider. This is designed to replace redundant per-resource `tags` configurations. Provider tags can be overridden with new values, but not excluded from specific resources. To override provider tag values, use the `tags` argument within a resource to configure new tag values for matching keys."
             },
             "endpoints": {
@@ -18050,6 +18047,24 @@
             },
             "type": "object"
         },
+        "aws-native:config:DefaultTags": {
+            "description": "The configuration with resource tag settings to apply across all resources handled by this provider. This is designed to replace redundant per-resource `tags` configurations. Provider tags can be overridden with new values, but not excluded from specific resources. To override provider tag values, use the `tags` argument within a resource to configure new tag values for matching keys.",
+            "properties": {
+                "tags": {
+                    "type": "object",
+                    "additionalProperties": {
+                        "type": "string"
+                    },
+                    "description": "A group of tags to set across all resources.",
+                    "language": {
+                        "python": {
+                            "mapCase": false
+                        }
+                    }
+                }
+            },
+            "type": "object"
+        },
         "aws-native:config:Endpoints": {
             "description": "The configuration for for customizing service endpoints.",
             "properties": {
@@ -45093,6 +45108,24 @@
             },
             "type": "object"
         },
+        "aws-native:index:ProviderDefaultTags": {
+            "description": "The configuration with resource tag settings to apply across all resources handled by this provider. This is designed to replace redundant per-resource `tags` configurations. Provider tags can be overridden with new values, but not excluded from specific resources. To override provider tag values, use the `tags` argument within a resource to configure new tag values for matching keys.",
+            "properties": {
+                "tags": {
+                    "type": "object",
+                    "additionalProperties": {
+                        "type": "string"
+                    },
+                    "description": "A group of tags to set across all resources.",
+                    "language": {
+                        "python": {
+                            "mapCase": false
+                        }
+                    }
+                }
+            },
+            "type": "object"
+        },
         "aws-native:index:ProviderEndpoint": {
             "description": "The configuration for for customizing service endpoints.",
             "properties": {
@@ -132914,10 +132947,7 @@
                 "description": "Configuration for retrieving temporary credentials from the STS service."
             },
             "defaultTags": {
-                "type": "object",
-                "additionalProperties": {
-                    "type": "string"
-                },
+                "$ref": "#/types/aws-native:index:ProviderDefaultTags",
                 "description": "Configuration block with resource tag settings to apply across all resources handled by this provider. This is designed to replace redundant per-resource `tags` configurations. Provider tags can be overridden with new values, but not excluded from specific resources. To override provider tag values, use the `tags` argument within a resource to configure new tag values for matching keys."
             },
             "endpoints": {
@@ -133006,10 +133036,7 @@
                 "description": "Configuration for retrieving temporary credentials from the STS service."
             },
             "defaultTags": {
-                "type": "object",
-                "additionalProperties": {
-                    "type": "string"
-                },
+                "$ref": "#/types/aws-native:index:ProviderDefaultTags",
                 "description": "Configuration block with resource tag settings to apply across all resources handled by this provider. This is designed to replace redundant per-resource `tags` configurations. Provider tags can be overridden with new values, but not excluded from specific resources. To override provider tag values, use the `tags` argument within a resource to configure new tag values for matching keys."
             },
             "endpoints": {

diff --git a/provider/pkg/provider/provider.go b/provider/pkg/provider/provider.go
@@ -461,12 +461,21 @@ func (p *cfnProvider) Configure(ctx context.Context, req *pulumirpc.ConfigureReq
 	}
 
 	if defaultTagsJson, ok := vars["aws-native:config:defaultTags"]; ok {
-		var defaultTags map[string]string
+		type DefaultTags struct {
+			Tags map[string]string `json:"tags"`
+		}
+		var defaultTags DefaultTags
 		err := json.Unmarshal([]byte(defaultTagsJson), &defaultTags)
 		if err != nil {
-			return nil, fmt.Errorf("failed to unmarshal 'skipCredentialsValidation' config: %w", err)
+			p.defaultTags = defaultTags.Tags
+		} else {
+			// As a fallback, we also try to unmarshal the default tags as a simple map[string]string
+			// as this was originally supported when implementing defaultTags.
+			fallbackErr := json.Unmarshal([]byte(defaultTagsJson), &p.defaultTags)
+			if fallbackErr != nil {
+				return nil, fmt.Errorf("failed to unmarshal 'defaultTags' config: %w", err)
+			}
 		}
-		p.defaultTags = defaultTags
 	} else {
 		p.defaultTags = nil
 	}

diff --git a/provider/pkg/schema/config.go b/provider/pkg/schema/config.go
@@ -74,6 +74,21 @@ var assumeRole = pschema.ComplexTypeSpec{
 	},
 }
 
+var defaultTags = pschema.ComplexTypeSpec{
+	ObjectTypeSpec: pschema.ObjectTypeSpec{
+		Description: "The configuration with resource tag settings to apply across all resources handled by this provider. This is designed to replace redundant per-resource `tags` configurations. Provider tags can be overridden with new values, but not excluded from specific resources. To override provider tag values, use the `tags` argument within a resource to configure new tag values for matching keys.",
+		Properties: map[string]pschema.PropertySpec{
+			"tags": {
+				Description: "A group of tags to set across all resources.",
+				TypeSpec: pschema.TypeSpec{
+					Type:                 "object",
+					AdditionalProperties: &pschema.TypeSpec{Type: "string"}},
+			},
+		},
+		Type: "object",
+	},
+}
+
 var endpoints = pschema.ComplexTypeSpec{
 	ObjectTypeSpec: pschema.ObjectTypeSpec{
 		Description: "The configuration for for customizing service endpoints.",
@@ -156,11 +171,13 @@ var region = pschema.ComplexTypeSpec{
 
 // typeOverlays augment the types defined by the schema.
 var typeOverlays = map[string]pschema.ComplexTypeSpec{
-	"aws-native:config:AssumeRole":        assumeRole,
-	"aws-native:index:ProviderAssumeRole": configToProvider(assumeRole),
-	"aws-native:config:Endpoints":         endpoints,
-	"aws-native:index:ProviderEndpoint":   configToProvider(endpoints),
-	"aws-native:config:IgnoreTags":        ignoreTags,
-	"aws-native:index:ProviderIgnoreTags": configToProvider(ignoreTags),
-	"aws-native:index/Region:Region":      region,
+	"aws-native:config:AssumeRole":         assumeRole,
+	"aws-native:index:ProviderAssumeRole":  configToProvider(assumeRole),
+	"aws-native:config:DefaultTags":        defaultTags,
+	"aws-native:index:ProviderDefaultTags": configToProvider(defaultTags),
+	"aws-native:config:Endpoints":          endpoints,
+	"aws-native:index:ProviderEndpoint":    configToProvider(endpoints),
+	"aws-native:config:IgnoreTags":         ignoreTags,
+	"aws-native:index:ProviderIgnoreTags":  configToProvider(ignoreTags),
+	"aws-native:index/Region:Region":       region,
 }
diff --git a/provider/pkg/schema/gen.go b/provider/pkg/schema/gen.go
@@ -79,7 +79,7 @@ func GatherPackage(supportedResourceTypes []string, jsonSchemas []jsschema.Schem
 				},
 				"defaultTags": {
 					Description: "Configuration block with resource tag settings to apply across all resources handled by this provider. This is designed to replace redundant per-resource `tags` configurations. Provider tags can be overridden with new values, but not excluded from specific resources. To override provider tag values, use the `tags` argument within a resource to configure new tag values for matching keys.",
-					TypeSpec:    pschema.TypeSpec{Type: "object", AdditionalProperties: &pschema.TypeSpec{Type: "string"}},
+					TypeSpec:    pschema.TypeSpec{Ref: "#/types/aws-native:config:DefaultTags"},
 				},
 				"endpoints": {
 					Description: "Configuration block for customizing service endpoints.",
@@ -177,7 +177,7 @@ func GatherPackage(supportedResourceTypes []string, jsonSchemas []jsschema.Schem
 					},
 					"defaultTags": {
 						Description: "Configuration block with resource tag settings to apply across all resources handled by this provider. This is designed to replace redundant per-resource `tags` configurations. Provider tags can be overridden with new values, but not excluded from specific resources. To override provider tag values, use the `tags` argument within a resource to configure new tag values for matching keys.",
-						TypeSpec:    pschema.TypeSpec{Type: "object", AdditionalProperties: &pschema.TypeSpec{Type: "string"}},
+						TypeSpec:    pschema.TypeSpec{Ref: "#/types/aws-native:index:ProviderDefaultTags"},
 					},
 					"endpoints": {
 						Description: "Configuration block for customizing service endpoints.",
@@ -260,7 +260,7 @@ func GatherPackage(supportedResourceTypes []string, jsonSchemas []jsschema.Schem
 				},
 				"defaultTags": {
 					Description: "Configuration block with resource tag settings to apply across all resources handled by this provider. This is designed to replace redundant per-resource `tags` configurations. Provider tags can be overridden with new values, but not excluded from specific resources. To override provider tag values, use the `tags` argument within a resource to configure new tag values for matching keys.",
-					TypeSpec:    pschema.TypeSpec{Type: "object", AdditionalProperties: &pschema.TypeSpec{Type: "string"}},
+					TypeSpec:    pschema.TypeSpec{Ref: "#/types/aws-native:index:ProviderDefaultTags"},
 				},
 				"endpoints": {
 					Description: "Configuration block for customizing service endpoints.",

diff --git a/sdk/dotnet/Config/Config.cs b/sdk/dotnet/Config/Config.cs
diff --git a/sdk/dotnet/Inputs/ProviderDefaultTagsArgs.cs b/sdk/dotnet/Inputs/ProviderDefaultTagsArgs.cs