Merge pull request #45215 from hashicorp/td-test-gen-vcr-ready

test generation: Updates Resource Identity tests to use VCR-ready random string generation

Author: gdavison

internal/generate/identitytests/main.go

@@ -1,7 +1,7 @@
 // Copyright (c) HashiCorp, Inc.
 // SPDX-License-Identifier: MPL-2.0
 
-//go:build generate
+//go:build ignore
 
 package main
 
@@ -526,7 +526,6 @@ func (v *visitor) processFuncDecl(funcDecl *ast.FuncDecl) {
 		IdentityVersions:      make(map[int64]*version.Version, 0),
 	}
 	skip := false
-	generatorSeen := false
 	tlsKey := false
 	var tlsKeyCN string
 
@@ -608,11 +607,6 @@ func (v *visitor) processFuncDecl(funcDecl *ast.FuncDecl) {
 					continue
 				}
 
-				// This needs better handling
-				if _, ok := args.Keyword["generator"]; ok {
-					generatorSeen = true
-				}
-
 				if attr, ok := args.Keyword["idAttrDuplicates"]; ok {
 					d.idAttrDuplicates = attr
 					d.GoImports = append(d.GoImports,
@@ -749,6 +743,10 @@ func (v *visitor) processFuncDecl(funcDecl *ast.FuncDecl) {
 
 	if d.HasResourceIdentity() {
 		if !skip {
+			if err := tests.Configure(&d.CommonArgs); err != nil {
+				v.errs = append(v.errs, fmt.Errorf("%s: %w", fmt.Sprintf("%s.%s", v.packageName, v.functionName), err))
+				return
+			}
 			if d.idAttrDuplicates != "" {
 				d.GoImports = append(d.GoImports,
 					common.GoImport{
@@ -759,29 +757,13 @@ func (v *visitor) processFuncDecl(funcDecl *ast.FuncDecl) {
 					},
 				)
 			}
-			if d.Name == "" {
-				v.errs = append(v.errs, fmt.Errorf("no name parameter set: %s", fmt.Sprintf("%s.%s", v.packageName, v.functionName)))
-				return
-			}
 			if d.HasV6_0NullValuesError {
 				d.PreIdentityVersion = v5_100_0
 			}
 			if !d.HasNoPreExistingResource && d.PreIdentityVersion == nil {
 				v.errs = append(v.errs, fmt.Errorf("preIdentityVersion is required when hasNoPreExistingResource is false: %s", fmt.Sprintf("%s.%s", v.packageName, v.functionName)))
 				return
 			}
-			if !generatorSeen {
-				d.Generator = "sdkacctest.RandomWithPrefix(acctest.ResourcePrefix)"
-				d.GoImports = append(d.GoImports,
-					common.GoImport{
-						Path:  "github.com/hashicorp/terraform-plugin-testing/helper/acctest",
-						Alias: "sdkacctest",
-					},
-					common.GoImport{
-						Path: "github.com/hashicorp/terraform-provider-aws/internal/acctest",
-					},
-				)
-			}
 			if d.IsARNIdentity() {
 				d.arnAttribute = d.IdentityAttributeName()
 			}
@@ -795,6 +777,7 @@ func (v *visitor) processFuncDecl(funcDecl *ast.FuncDecl) {
 			if d.IsSingletonIdentity() {
 				d.Serialize = true
 			}
+
 			v.identityResources = append(v.identityResources, d)
 		}
 	}

internal/generate/tagstests/main.go

@@ -1,7 +1,7 @@
 // Copyright (c) HashiCorp, Inc.
 // SPDX-License-Identifier: MPL-2.0
 
-//go:build generate
+//go:build ignore
 
 package main
 
@@ -516,7 +516,6 @@ func (v *visitor) processFuncDecl(funcDecl *ast.FuncDecl) {
 	}
 	tagged := false
 	skip := false
-	generatorSeen := false
 	tlsKey := false
 	var tlsKeyCN string
 	hasIdentifierAttribute := false
@@ -582,11 +581,6 @@ func (v *visitor) processFuncDecl(funcDecl *ast.FuncDecl) {
 					continue
 				}
 
-				// This needs better handling
-				if _, ok := args.Keyword["generator"]; ok {
-					generatorSeen = true
-				}
-
 				if attr, ok := args.Keyword["tagsIdentifierAttribute"]; ok {
 					d.overrideIdentifierAttribute = attr
 				}
@@ -695,22 +689,14 @@ func (v *visitor) processFuncDecl(funcDecl *ast.FuncDecl) {
 
 	if tagged {
 		if !skip {
-			if d.Name == "" {
-				v.errs = append(v.errs, fmt.Errorf("no name parameter set: %s", fmt.Sprintf("%s.%s", v.packageName, v.functionName)))
+			if err := tests.Configure(&d.CommonArgs); err != nil {
+				v.errs = append(v.errs, fmt.Errorf("%s: %w", fmt.Sprintf("%s.%s", v.packageName, v.functionName), err))
 				return
 			}
 			if !hasIdentifierAttribute && len(d.overrideIdentifierAttribute) == 0 {
 				v.errs = append(v.errs, fmt.Errorf("@Tags specification for %s does not use identifierAttribute. Missing @Testing(tagsIdentifierAttribute) and possibly tagsResourceType", fmt.Sprintf("%s.%s", v.packageName, v.functionName)))
 				return
 			}
-			if !generatorSeen {
-				d.Generator = "acctest.RandomWithPrefix(t, acctest.ResourcePrefix)"
-				d.GoImports = append(d.GoImports,
-					common.GoImport{
-						Path: "github.com/hashicorp/terraform-provider-aws/internal/acctest",
-					},
-				)
-			}
 			if d.HasInherentRegionIdentity() {
 				if d.Implementation == common.ImplementationFramework {
 					if !slices.Contains(d.IdentityDuplicateAttrNames, "id") {
@@ -721,6 +707,7 @@ func (v *visitor) processFuncDecl(funcDecl *ast.FuncDecl) {
 			if d.IsSingletonIdentity() {
 				d.Serialize = true
 			}
+
 			v.taggedResources = append(v.taggedResources, d)
 		}
 	}

internal/generate/tests/annotations.go

@@ -4,6 +4,7 @@
 package tests
 
 import (
+	"errors"
 	"fmt"
 	"strings"
 
@@ -51,7 +52,8 @@ type CommonArgs struct {
 	UseAlternateAccount     bool
 	AlternateRegionProvider bool
 
-	Generator string
+	Generator     string
+	generatorSeen bool
 
 	RequiredEnvVars []string
 
@@ -333,6 +335,7 @@ func ParseTestingAnnotations(args common.Args, stuff *CommonArgs) error {
 
 	// TF Variables
 	if attr, ok := args.Keyword["generator"]; ok {
+		stuff.generatorSeen = true
 		if attr != "false" {
 			if funcName, importSpec, err := common.ParseIdentifierSpec(attr); err != nil {
 				return fmt.Errorf("%s: %w", attr, err)
@@ -488,3 +491,20 @@ func endpointsConstOrQuote(region string) string {
 
 	return buf.String()
 }
+
+func Configure(d *CommonArgs) error {
+	if d.Name == "" {
+		return errors.New("no name parameter set")
+	}
+
+	if !d.generatorSeen {
+		d.Generator = "acctest.RandomWithPrefix(t, acctest.ResourcePrefix)"
+		d.GoImports = append(d.GoImports,
+			common.GoImport{
+				Path: "github.com/hashicorp/terraform-provider-aws/internal/acctest",
+			},
+		)
+	}
+
+	return nil
+}