Merge pull request #33074 from hashicorp/b-kms-tag-propagation

Add `id` logging field for transparent tagging update operations

Author: gdavison

.teamcity/scripts/provider_tests/acceptance_tests.sh

@@ -44,6 +44,7 @@ TF_ACC=1 go test \
     ./internal/flex/... \
     ./internal/framework/... \
     ./internal/generate/... \
+    ./internal/logging/... \
     ./internal/maps/... \
     ./internal/provider/... \
     ./internal/sdktypes/... \

.teamcity/scripts/provider_tests/unit_tests.sh

@@ -16,6 +16,7 @@ go test \
     ./internal/flex/... \
     ./internal/framework/... \
     ./internal/generate/... \
+    ./internal/logging/... \
     ./internal/maps/... \
     ./internal/provider/... \
     ./internal/sdktypes/... \

internal/generate/tags/main.go

@@ -208,10 +208,12 @@ type TemplateData struct {
 	FmtPkg           bool
 	HelperSchemaPkg  bool
 	InternalTypesPkg bool
+	LoggingPkg       bool
 	NamesPkg         bool
 	SkipAWSImp       bool
 	SkipServiceImp   bool
 	SkipTypesImp     bool
+	TfLogPkg         bool
 	TfResourcePkg    bool
 	TimePkg          bool
 
@@ -298,10 +300,12 @@ func main() {
 		FmtPkg:           *updateTags,
 		HelperSchemaPkg:  awsPkg == "autoscaling",
 		InternalTypesPkg: (*listTags && *listTagsFunc == defaultListTagsFunc) || *serviceTagsMap || *serviceTagsSlice,
+		LoggingPkg:       *updateTags,
 		NamesPkg:         *updateTags && !*skipNamesImp,
 		SkipAWSImp:       *skipAWSImp,
 		SkipServiceImp:   *skipServiceImp,
 		SkipTypesImp:     *skipTypesImp,
+		TfLogPkg:         *updateTags,
 		TfResourcePkg:    (*getTag || *waitForPropagation),
 		TimePkg:          *waitForPropagation,
 

internal/generate/tags/templates/v1/header_body.tmpl

@@ -31,10 +31,16 @@ import (
 	{{- if .ParentNotFoundErrCode }}
 	"github.com/hashicorp/aws-sdk-go-base/v2/awsv1shim/v2/tfawserr"
 	"github.com/hashicorp/terraform-plugin-sdk/v2/helper/retry"
+	{{- end }}
+	{{- if .TfLogPkg }}
+    "github.com/hashicorp/terraform-plugin-log/tflog"
 	{{- end }}
 	{{- if .ConnsPkg }}
 	"github.com/hashicorp/terraform-provider-aws/internal/conns"
 	{{- end }}
+	{{- if .LoggingPkg }}
+	"github.com/hashicorp/terraform-provider-aws/internal/logging"
+	{{- end }}
 	{{- if .TfResourcePkg }}
     "github.com/hashicorp/terraform-provider-aws/internal/tfresource"
 	{{- end }}

internal/generate/tags/templates/v1/update_tags_body.tmpl

@@ -10,7 +10,11 @@ func {{ .UpdateTagsFunc }}(ctx context.Context, conn {{ .ClientType }}, identifi
 	oldTags := tftags.New(ctx, oldTagsMap)
 	newTags := tftags.New(ctx, newTagsMap)
 {{- end }}
+
+	ctx = tflog.SetField(ctx, logging.KeyResourceId, identifier)
+
 	{{- if eq (.TagOp) (.UntagOp) }}
+
 	removedTags := oldTags.Removed(newTags)
 	{{- if .UpdateTagsIgnoreSystem }}
 	removedTags = removedTags.IgnoreSystem(names.{{ .ProviderNameUpper }})

internal/generate/tags/templates/v1/wait_tags_propagated_body.tmpl

@@ -2,6 +2,10 @@
 // The identifier is typically the Amazon Resource Name (ARN), although
 // it may also be a different identifier depending on the service.
 func {{ .WaitTagsPropagatedFunc }}(ctx context.Context, conn {{ .ClientType }}, id string, tags tftags.KeyValueTags) error {
+	tflog.Debug(ctx, "Waiting for tag propagation", map[string]any{
+		"tags": tags,
+	})
+
 	checkFunc := func() (bool, error) {
 		output, err := listTags(ctx, conn, id)
 

internal/generate/tags/templates/v2/header_body.tmpl

@@ -28,10 +28,16 @@ import (
 	{{- if .ParentNotFoundErrCode }}
 	"github.com/hashicorp/aws-sdk-go-base/v2/awsv1shim/v2/tfawserr"
 	"github.com/hashicorp/terraform-plugin-testing/helper/resource"
+	{{- end }}
+	{{- if .TfLogPkg }}
+    "github.com/hashicorp/terraform-plugin-log/tflog"
 	{{- end }}
 	{{- if .ConnsPkg }}
 	"github.com/hashicorp/terraform-provider-aws/internal/conns"
 	{{- end }}
+	{{- if .LoggingPkg }}
+	"github.com/hashicorp/terraform-provider-aws/internal/logging"
+	{{- end }}
 	{{- if .TfResourcePkg }}
     "github.com/hashicorp/terraform-provider-aws/internal/tfresource"
 	{{- end }}

internal/generate/tags/templates/v2/update_tags_body.tmpl

@@ -10,7 +10,11 @@ func {{ .UpdateTagsFunc }}(ctx context.Context, conn {{ .ClientType }}, identifi
 	oldTags := tftags.New(ctx, oldTagsMap)
 	newTags := tftags.New(ctx, newTagsMap)
 {{- end }}
+
+	ctx = tflog.SetField(ctx, logging.KeyResourceId, identifier)
+
 	{{- if eq (.TagOp) (.UntagOp) }}
+
 	removedTags := oldTags.Removed(newTags)
 	{{- if .UpdateTagsIgnoreSystem }}
 	removedTags = removedTags.IgnoreSystem(names.{{ .ProviderNameUpper }})

internal/generate/tags/templates/v2/wait_tags_propagated_body.tmpl

@@ -2,6 +2,10 @@
 // The identifier is typically the Amazon Resource Name (ARN), although
 // it may also be a different identifier depending on the service.
 func {{ .WaitTagsPropagatedFunc }}(ctx context.Context, conn {{ .ClientType }}, id string, tags tftags.KeyValueTags) error {
+	tflog.Debug(ctx, "Waiting for tag propagation", map[string]any{
+		"tags": tags,
+	})
+
 	checkFunc := func() (bool, error) {
 		output, err := listTags(ctx, conn, id)
 

internal/logging/keys.go

@@ -0,0 +1,8 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package logging
+
+const (
+	KeyResourceId = "id"
+)