PoC: Super simple Plugin Framework data source self-registration

internal/conns/awsclient.go

@@ -0,0 +1,26 @@
+package conns
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/hashicorp/terraform-provider-aws/internal/intf"
+)
+
+// PartitionHostname returns a hostname with the provider domain suffix for the partition
+// e.g. PREFIX.amazonaws.com
+// The prefix should not contain a trailing period.
+func (client *AWSClient) PartitionHostname(prefix string) string {
+	return fmt.Sprintf("%s.%s", prefix, client.DNSSuffix)
+}
+
+// RegionalHostname returns a hostname with the provider domain suffix for the region and partition
+// e.g. PREFIX.us-west-2.amazonaws.com
+// The prefix should not contain a trailing period.
+func (client *AWSClient) RegionalHostname(prefix string) string {
+	return fmt.Sprintf("%s.%s.%s", prefix, client.Region, client.DNSSuffix)
+}
+
+func (client *AWSClient) Services(_ context.Context) map[string]intf.ServiceData {
+	return client.ServiceMap
+}

internal/conns/config.go

@@ -84,8 +84,8 @@ type Config struct {
 	UseFIPSEndpoint                bool
 }
 
-// Client configures and returns a fully initialized AWSClient
-func (c *Config) Client(ctx context.Context) (interface{}, diag.Diagnostics) {
+// ConfigureProvider configures the provided provider Meta (instance data).
+func (c *Config) ConfigureProvider(ctx context.Context, client *AWSClient) (*AWSClient, diag.Diagnostics) {
 	awsbaseConfig := awsbase.Config{
 		AccessKey:                     c.AccessKey,
 		APNInfo:                       StdUserAgentProducts(c.TerraformVersion),
@@ -185,7 +185,7 @@ func (c *Config) Client(ctx context.Context) (interface{}, diag.Diagnostics) {
 		DNSSuffix = p.DNSSuffix()
 	}
 
-	client := c.clientConns(sess)
+	c.clientConns(client, sess)
 
 	client.AccountID = accountID
 	client.DefaultTagsConfig = c.DefaultTagsConfig

internal/fwtypes/README.md

@@ -0,0 +1,3 @@
+# Terraform Plugin Framework Provider-Defined Types
+
+This package contains Terraform Plugin Framework [provider-defined types](https://www.terraform.io/plugin/framework/types#create-provider-defined-types-and-values) (and values).

internal/service/meta/arn.go → internal/fwtypes/arn.go

@@ -1,5 +1,4 @@
-// TODO: Move this to a shared 'types' package.
-package meta
+package fwtypes
 
 import (
 	"context"

internal/service/meta/arn_test.go → internal/fwtypes/arn_test.go

@@ -1,5 +1,4 @@
-// TODO: Move this to a shared 'types' package.
-package meta_test
+package fwtypes_test
 
 import (
 	"context"
@@ -10,7 +9,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/attr"
 	"github.com/hashicorp/terraform-plugin-framework/path"
 	"github.com/hashicorp/terraform-plugin-go/tftypes"
-	"github.com/hashicorp/terraform-provider-aws/internal/service/meta"
+	"github.com/hashicorp/terraform-provider-aws/internal/fwtypes"
 )
 
 func TestARNTypeValueFromTerraform(t *testing.T) {
@@ -23,15 +22,15 @@ func TestARNTypeValueFromTerraform(t *testing.T) {
 	}{
 		"null value": {
 			val:      tftypes.NewValue(tftypes.String, nil),
-			expected: meta.ARN{Null: true},
+			expected: fwtypes.ARN{Null: true},
 		},
 		"unknown value": {
 			val:      tftypes.NewValue(tftypes.String, tftypes.UnknownValue),
-			expected: meta.ARN{Unknown: true},
+			expected: fwtypes.ARN{Unknown: true},
 		},
 		"valid ARN": {
 			val: tftypes.NewValue(tftypes.String, "arn:aws:rds:us-east-1:123456789012:db:test"), // lintignore:AWSAT003,AWSAT005
-			expected: meta.ARN{Value: arn.ARN{
+			expected: fwtypes.ARN{Value: arn.ARN{
 				Partition: "aws",
 				Service:   "rds",
 				Region:    "us-east-1", // lintignore:AWSAT003
@@ -49,7 +48,7 @@ func TestARNTypeValueFromTerraform(t *testing.T) {
 		name, test := name, test
 		t.Run(name, func(t *testing.T) {
 			ctx := context.Background()
-			val, err := meta.ARNType.ValueFromTerraform(ctx, test.val)
+			val, err := fwtypes.ARNType.ValueFromTerraform(ctx, test.val)
 
 			if err == nil && test.expectError {
 				t.Fatal("expected error, got no error")
@@ -97,7 +96,7 @@ func TestARNTypeValidate(t *testing.T) {
 		t.Run(name, func(t *testing.T) {
 			ctx := context.Background()
 
-			diags := meta.ARNType.Validate(ctx, test.val, path.Root("test"))
+			diags := fwtypes.ARNType.Validate(ctx, test.val, path.Root("test"))
 
 			if !diags.HasError() && test.expectError {
 				t.Fatal("expected error, got no error")

internal/provider/fwprovider/duration.go → internal/fwtypes/duration.go

@@ -1,5 +1,4 @@
-// TODO: Move this to a shared 'types' package.
-package fwprovider
+package fwtypes
 
 import (
 	"context"

internal/provider/fwprovider/duration_test.go → internal/fwtypes/duration_test.go

@@ -1,5 +1,4 @@
-// TODO: Move this to a shared 'types' package.
-package fwprovider_test
+package fwtypes_test
 
 import (
 	"context"
@@ -10,7 +9,7 @@ import (
 	"github.com/hashicorp/terraform-plugin-framework/attr"
 	"github.com/hashicorp/terraform-plugin-framework/path"
 	"github.com/hashicorp/terraform-plugin-go/tftypes"
-	"github.com/hashicorp/terraform-provider-aws/internal/provider/fwprovider"
+	"github.com/hashicorp/terraform-provider-aws/internal/fwtypes"
 )
 
 func TestDurationTypeValueFromTerraform(t *testing.T) {
@@ -23,15 +22,15 @@ func TestDurationTypeValueFromTerraform(t *testing.T) {
 	}{
 		"null value": {
 			val:      tftypes.NewValue(tftypes.String, nil),
-			expected: fwprovider.Duration{Null: true},
+			expected: fwtypes.Duration{Null: true},
 		},
 		"unknown value": {
 			val:      tftypes.NewValue(tftypes.String, tftypes.UnknownValue),
-			expected: fwprovider.Duration{Unknown: true},
+			expected: fwtypes.Duration{Unknown: true},
 		},
 		"valid duration": {
 			val:      tftypes.NewValue(tftypes.String, "2h"),
-			expected: fwprovider.Duration{Value: 2 * time.Hour},
+			expected: fwtypes.Duration{Value: 2 * time.Hour},
 		},
 		"invalid duration": {
 			val:         tftypes.NewValue(tftypes.String, "not ok"),
@@ -43,7 +42,7 @@ func TestDurationTypeValueFromTerraform(t *testing.T) {
 		name, test := name, test
 		t.Run(name, func(t *testing.T) {
 			ctx := context.Background()
-			val, err := fwprovider.DurationType.ValueFromTerraform(ctx, test.val)
+			val, err := fwtypes.DurationType.ValueFromTerraform(ctx, test.val)
 
 			if err == nil && test.expectError {
 				t.Fatal("expected error, got no error")
@@ -91,7 +90,7 @@ func TestDurationTypeValidate(t *testing.T) {
 		t.Run(name, func(t *testing.T) {
 			ctx := context.Background()
 
-			diags := fwprovider.DurationType.Validate(ctx, test.val, path.Root("test"))
+			diags := fwtypes.DurationType.Validate(ctx, test.val, path.Root("test"))
 
 			if !diags.HasError() && test.expectError {
 				t.Fatal("expected error, got no error")

internal/generate/awsclient/file.tmpl

@@ -0,0 +1,31 @@
+// Code generated by internal/generate/awsclient/main.go; DO NOT EDIT.
+package conns
+
+import (
+{{ range .Services }}
+	"github.com/aws/aws-sdk-go{{ if eq .SDKVersion "2" }}-v2{{ end }}/service/{{ .GoPackage }}"
+{{- end }}
+	"github.com/aws/aws-sdk-go/aws/session"
+	"github.com/hashicorp/terraform-provider-aws/internal/intf"
+	tftags "github.com/hashicorp/terraform-provider-aws/internal/tags"
+)
+
+type AWSClient struct {
+	AccountID                 string
+	DefaultTagsConfig         *tftags.DefaultConfig
+	DNSSuffix                 string
+	IgnoreTagsConfig          *tftags.IgnoreConfig
+	MediaConvertAccountConn   *mediaconvert.MediaConvert
+	Partition                 string
+	Region                    string
+	ReverseDNSPrefix          string
+	S3ConnURICleaningDisabled *s3.S3
+	ServiceMap                map[string]intf.ServiceData
+	Session                   *session.Session
+	SupportedPlatforms        []string
+	TerraformVersion          string
+
+	{{ range .Services }}
+	{{ .ProviderNameUpper }}Conn *{{ .GoPackage }}.{{ .ClientTypeName }}
+	{{- end }}
+}

internal/generate/awsclient/main.go

@@ -5,6 +5,7 @@ package main
 
 import (
 	"bytes"
+	_ "embed"
 	"encoding/csv"
 	"fmt"
 	"go/format"
@@ -120,51 +121,5 @@ func writeTemplate(body string, templateName string, td TemplateData) {
 	}
 }
 
-var tmpl = `
-// Code generated by internal/generate/awsclient/main.go; DO NOT EDIT.
-package conns
-
-import (
-	"fmt"
-
-
-{{ range .Services }}
-	"github.com/aws/aws-sdk-go{{ if eq .SDKVersion "2" }}-v2{{ end }}/service/{{ .GoPackage }}"
-{{- end }}
-	"github.com/aws/aws-sdk-go/aws/session"
-	tftags "github.com/hashicorp/terraform-provider-aws/internal/tags"
-)
-
-type AWSClient struct {
-	AccountID                 string
-	DefaultTagsConfig         *tftags.DefaultConfig
-	DNSSuffix                 string
-	IgnoreTagsConfig          *tftags.IgnoreConfig
-	MediaConvertAccountConn   *mediaconvert.MediaConvert
-	Partition                 string
-	Region                    string
-	ReverseDNSPrefix          string
-	S3ConnURICleaningDisabled *s3.S3
-	Session                   *session.Session
-	SupportedPlatforms        []string
-	TerraformVersion          string
-
-	{{ range .Services }}
-	{{ .ProviderNameUpper }}Conn *{{ .GoPackage }}.{{ .ClientTypeName }}
-	{{- end }}
-}
-
-// PartitionHostname returns a hostname with the provider domain suffix for the partition
-// e.g. PREFIX.amazonaws.com
-// The prefix should not contain a trailing period.
-func (client *AWSClient) PartitionHostname(prefix string) string {
-	return fmt.Sprintf("%s.%s", prefix, client.DNSSuffix)
-}
-
-// RegionalHostname returns a hostname with the provider domain suffix for the region and partition
-// e.g. PREFIX.us-west-2.amazonaws.com
-// The prefix should not contain a trailing period.
-func (client *AWSClient) RegionalHostname(prefix string) string {
-	return fmt.Sprintf("%s.%s.%s", prefix, client.Region, client.DNSSuffix)
-}
-`
+//go:embed file.tmpl
+var tmpl string

internal/generate/clientconfig/file.tmpl

@@ -0,0 +1,17 @@
+// Code generated by internal/generate/clientconfig/main.go; DO NOT EDIT.
+package conns
+
+import (
+	"github.com/aws/aws-sdk-go/aws"
+	"github.com/aws/aws-sdk-go/aws/session"
+{{- range .Services }}
+	"github.com/aws/aws-sdk-go{{ if eq .SDKVersion "2" }}-v2{{ end }}/service/{{ .GoPackage }}"
+{{- end }}
+	"github.com/hashicorp/terraform-provider-aws/names"
+)
+
+func (c *Config) clientConns(client *AWSClient, sess *session.Session) {
+	{{- range .Services }}
+	client.{{ .ProviderNameUpper }}Conn = {{ .GoPackage }}.New(sess.Copy(&aws.Config{Endpoint: aws.String(c.Endpoints[names.{{ .ProviderNameUpper }}])}))
+	{{- end }}
+}

internal/generate/clientconfig/main.go

@@ -5,6 +5,7 @@ package main
 
 import (
 	"bytes"
+	_ "embed"
 	"encoding/csv"
 	"fmt"
 	"go/format"
@@ -117,24 +118,5 @@ func writeTemplate(body string, templateName string, td TemplateData) {
 	}
 }
 
-var tmpl = `
-// Code generated by internal/generate/clientconfig/main.go; DO NOT EDIT.
-package conns
-
-import (
-	"github.com/aws/aws-sdk-go/aws"
-	"github.com/aws/aws-sdk-go/aws/session"
-{{- range .Services }}
-	"github.com/aws/aws-sdk-go{{ if eq .SDKVersion "2" }}-v2{{ end }}/service/{{ .GoPackage }}"
-{{- end }}
-	"github.com/hashicorp/terraform-provider-aws/names"
-)
-
-func (c *Config) clientConns(sess *session.Session) *AWSClient {
-	return &AWSClient{
-		{{- range .Services }}
-		{{ .ProviderNameUpper }}Conn: {{ .GoPackage }}.New(sess.Copy(&aws.Config{Endpoint: aws.String(c.Endpoints[names.{{ .ProviderNameUpper }}])})),
-		{{- end }}
-	}
-}
-`
+//go:embed file.tmpl
+var tmpl string

internal/intf/provider.go

@@ -0,0 +1,9 @@
+package intf
+
+import (
+	"context"
+)
+
+type ProviderData interface {
+	Services(context.Context) map[string]ServiceData
+}

internal/intf/service.go

@@ -0,0 +1,13 @@
+package intf
+
+import (
+	"context"
+
+	"github.com/hashicorp/terraform-plugin-framework/provider"
+)
+
+// ServiceData is data about a service.
+type ServiceData interface {
+	Configure(context.Context, ProviderData) error
+	DataSources(context.Context) (map[string]provider.DataSourceType, error)
+}