Merge pull request #40919 from hashicorp/td-fw-resource-annotation-re…

…quire-name Tech debt: Require `name=` value for `@EphemeralResource` and `@FrameworkResource` annotations
hashicorp · Jan 14, 2025 · e57d523 · e57d523
2 parents f3a5a72 + 6f51657
commit e57d523
Show file tree

Hide file tree

Showing 17 changed files with 28 additions and 10 deletions.
diff --git a/internal/generate/servicepackage/main.go b/internal/generate/servicepackage/main.go
@@ -249,6 +249,10 @@ func (v *visitor) processFuncDecl(funcDecl *ast.FuncDecl) {
 				} else {
 					v.ephemeralResources = append(v.ephemeralResources, d)
 				}
+
+				if d.Name == "" {
+					v.g.Errorf("%s missing name: %s.%s", annotationName, v.packageName, v.functionName)
+				}
 			case "FrameworkDataSource":
 				if slices.ContainsFunc(v.frameworkDataSources, func(d ResourceDatum) bool { return d.FactoryName == v.functionName }) {
 					v.errs = append(v.errs, fmt.Errorf("duplicate Framework Data Source: %s", fmt.Sprintf("%s.%s", v.packageName, v.functionName)))
@@ -261,6 +265,10 @@ func (v *visitor) processFuncDecl(funcDecl *ast.FuncDecl) {
 				} else {
 					v.frameworkResources = append(v.frameworkResources, d)
 				}
+
+				if d.Name == "" {
+					v.g.Errorf("%s missing name: %s.%s", annotationName, v.packageName, v.functionName)
+				}
 			case "SDKDataSource":
 				if len(args.Positional) == 0 {
 					v.errs = append(v.errs, fmt.Errorf("no type name: %s", fmt.Sprintf("%s.%s", v.packageName, v.functionName)))

diff --git a/internal/service/apigateway/account.go b/internal/service/apigateway/account.go
@@ -28,7 +28,7 @@ import (
 	"github.com/hashicorp/terraform-provider-aws/names"
 )
 
-// @FrameworkResource("aws_api_gateway_account")
+// @FrameworkResource("aws_api_gateway_account", name="Account")
 func newResourceAccount(context.Context) (resource.ResourceWithConfigure, error) {
 	r := &resourceAccount{}
 

diff --git a/internal/service/apigateway/service_package_gen.go b/internal/service/apigateway/service_package_gen.go
diff --git a/internal/service/auditmanager/account_registration.go b/internal/service/auditmanager/account_registration.go
@@ -18,7 +18,7 @@ import (
 	"github.com/hashicorp/terraform-provider-aws/names"
 )
 
-// @FrameworkResource
+// @FrameworkResource("aws_auditmanager_account_registration", name="Account Registration")
 func newResourceAccountRegistration(_ context.Context) (resource.ResourceWithConfigure, error) {
 	return &resourceAccountRegistration{}, nil
 }

diff --git a/internal/service/auditmanager/assessment_delegation.go b/internal/service/auditmanager/assessment_delegation.go
@@ -27,7 +27,7 @@ import (
 	"github.com/hashicorp/terraform-provider-aws/names"
 )
 
-// @FrameworkResource
+// @FrameworkResource("aws_auditmanager_assessment_delegation", name="Assessment Delegation")
 func newResourceAssessmentDelegation(_ context.Context) (resource.ResourceWithConfigure, error) {
 	return &resourceAssessmentDelegation{}, nil
 }

diff --git a/internal/service/auditmanager/assessment_report.go b/internal/service/auditmanager/assessment_report.go
@@ -28,7 +28,7 @@ import (
 
 const reportCompletionTimeout = 5 * time.Minute
 
-// @FrameworkResource
+// @FrameworkResource("aws_auditmanager_assessment_report", name="Assessment Report")
 func newResourceAssessmentReport(_ context.Context) (resource.ResourceWithConfigure, error) {
 	return &resourceAssessmentReport{}, nil
 }

diff --git a/internal/service/auditmanager/framework_share.go b/internal/service/auditmanager/framework_share.go
@@ -25,7 +25,7 @@ import (
 	"github.com/hashicorp/terraform-provider-aws/names"
 )
 
-// @FrameworkResource
+// @FrameworkResource("aws_auditmanager_framework_share", name="Framework Share")
 func newResourceFrameworkShare(_ context.Context) (resource.ResourceWithConfigure, error) {
 	return &resourceFrameworkShare{}, nil
 }

diff --git a/internal/service/auditmanager/organization_admin_account_registration.go b/internal/service/auditmanager/organization_admin_account_registration.go
@@ -19,7 +19,7 @@ import (
 	"github.com/hashicorp/terraform-provider-aws/names"
 )
 
-// @FrameworkResource
+// @FrameworkResource("aws_auditmanager_organization_admin_account_registration", name="Organization Admin Account Registration")
 func newResourceOrganizationAdminAccountRegistration(_ context.Context) (resource.ResourceWithConfigure, error) {
 	return &resourceOrganizationAdminAccountRegistration{}, nil
 }

diff --git a/internal/service/auditmanager/service_package_gen.go b/internal/service/auditmanager/service_package_gen.go
diff --git a/internal/service/elasticache/reserved_cache_node.go b/internal/service/elasticache/reserved_cache_node.go
@@ -31,7 +31,7 @@ import (
 	"github.com/hashicorp/terraform-provider-aws/names"
 )
 
-// @FrameworkResource("aws_elasticache_reserved_cache_node")
+// @FrameworkResource("aws_elasticache_reserved_cache_node", name="Reserved Cache Node")
 // @Tags(identifierAttribute="arn")
 // @Testing(tagsTests=false)
 func newResourceReservedCacheNode(context.Context) (resource.ResourceWithConfigure, error) {

diff --git a/internal/service/elasticache/service_package_gen.go b/internal/service/elasticache/service_package_gen.go
diff --git a/internal/service/medialive/multiplex_program.go b/internal/service/medialive/multiplex_program.go
@@ -33,7 +33,7 @@ import (
 	"github.com/hashicorp/terraform-provider-aws/names"
 )
 
-// @FrameworkResource("aws_medialive_multiplex_program")
+// @FrameworkResource("aws_medialive_multiplex_program", name="Multiplex Program")
 func newResourceMultiplexProgram(_ context.Context) (resource.ResourceWithConfigure, error) {
 	return &multiplexProgram{}, nil
 }

diff --git a/internal/service/medialive/service_package_gen.go b/internal/service/medialive/service_package_gen.go
diff --git a/internal/service/rds/export_task.go b/internal/service/rds/export_task.go
@@ -29,7 +29,7 @@ import (
 	"github.com/hashicorp/terraform-provider-aws/names"
 )
 
-// @FrameworkResource("aws_rds_export_task")
+// @FrameworkResource("aws_rds_export_task", name="Export Task")
 func newResourceExportTask(_ context.Context) (resource.ResourceWithConfigure, error) {
 	r := &resourceExportTask{}
 	r.SetDefaultCreateTimeout(60 * time.Minute)

diff --git a/internal/service/rds/service_package_gen.go b/internal/service/rds/service_package_gen.go
diff --git a/internal/service/simpledb/domain.go b/internal/service/simpledb/domain.go
@@ -24,7 +24,7 @@ import (
 	"github.com/hashicorp/terraform-provider-aws/names"
 )
 
-// @FrameworkResource
+// @FrameworkResource("aws_simpledb_domain", name="Domain")
 func newDomainResource(context.Context) (resource.ResourceWithConfigure, error) {
 	r := &domainResource{}
 

diff --git a/internal/service/simpledb/service_package_gen.go b/internal/service/simpledb/service_package_gen.go