Use acceptance tests to test handling of the credentials provider con…

…figuration argument, add new data source that surfaces configuration of SDK and plugin-framework providers to facilitate acctests (GoogleCloudPlatform#11599)

mmv1/third_party/terraform/acctest/vcr_utils.go

@@ -31,6 +31,8 @@ import (
 	"github.com/dnaeon/go-vcr/recorder"
 
 	"github.com/hashicorp/terraform-plugin-framework/attr"
+	"github.com/hashicorp/terraform-plugin-framework/datasource"
+
 	fwDiags "github.com/hashicorp/terraform-plugin-framework/diag"
 	"github.com/hashicorp/terraform-plugin-framework/provider"
 	"github.com/hashicorp/terraform-plugin-framework/types"
@@ -436,6 +438,14 @@ func (p *frameworkTestProvider) Configure(ctx context.Context, req provider.Conf
 	}
 }
 
+// DataSources overrides the provider's DataSources function so that we can append test-specific data sources to the list of data sources on the provider.
+// This makes the data source(s) usable only in the context of acctests, and isn't available to users
+func (p *frameworkTestProvider) DataSources(ctx context.Context) []func() datasource.DataSource {
+	ds := p.FrameworkProvider.DataSources(ctx)
+	ds = append(ds, fwprovider.NewGoogleProviderConfigPluginFrameworkDataSource) // google_provider_config_plugin_framework
+	return ds
+}
+
 func configureApiClient(ctx context.Context, p *fwprovider.FrameworkProvider, diags *fwDiags.Diagnostics) {
 	var data fwmodels.ProviderModel
 	var d fwDiags.Diagnostics
@@ -453,6 +463,11 @@ func configureApiClient(ctx context.Context, p *fwprovider.FrameworkProvider, di
 // GetSDKProvider gets the SDK provider with an overwritten configure function to be called by MuxedProviders
 func GetSDKProvider(testName string) *schema.Provider {
 	prov := tpgprovider.Provider()
+
+	// Append a test-specific data source to the list of data sources on the provider
+	// This makes the data source(s) usable only in the context of acctests, and isn't available to users
+	prov.DataSourcesMap["google_provider_config_sdk"] = tpgprovider.DataSourceGoogleProviderConfigSdk()
+
 	if IsVcrEnabled() {
 		old := prov.ConfigureContextFunc
 		prov.ConfigureContextFunc = func(ctx context.Context, d *schema.ResourceData) (interface{}, diag.Diagnostics) {

mmv1/third_party/terraform/fwprovider/data_source_provider_config_plugin_framework.go

@@ -0,0 +1,231 @@
+package fwprovider
+
+import (
+	"context"
+	"fmt"
+
+	"github.com/hashicorp/terraform-plugin-framework/datasource"
+	"github.com/hashicorp/terraform-plugin-framework/datasource/schema"
+	"github.com/hashicorp/terraform-plugin-framework/diag"
+	"github.com/hashicorp/terraform-plugin-framework/types"
+	"github.com/hashicorp/terraform-provider-google/google/fwmodels"
+	"github.com/hashicorp/terraform-provider-google/google/fwresource"
+	"github.com/hashicorp/terraform-provider-google/google/fwtransport"
+)
+
+// Ensure the data source satisfies the expected interfaces.
+var (
+	_ datasource.DataSource              = &GoogleProviderConfigPluginFrameworkDataSource{}
+	_ datasource.DataSourceWithConfigure = &GoogleProviderConfigPluginFrameworkDataSource{}
+	_ fwresource.LocationDescriber       = &GoogleProviderConfigPluginFrameworkModel{}
+)
+
+func NewGoogleProviderConfigPluginFrameworkDataSource() datasource.DataSource {
+	return &GoogleProviderConfigPluginFrameworkDataSource{}
+}
+
+type GoogleProviderConfigPluginFrameworkDataSource struct {
+	providerConfig *fwtransport.FrameworkProviderConfig
+}
+
+type GoogleProviderConfigPluginFrameworkModel struct {
+	// Currently this reflects the FrameworkProviderConfig struct and ProviderModel in google/fwmodels/provider_model.go
+	// which means it uses the plugin-framework type system where values can be explicitly Null or Unknown.
+	//
+	// As part of future muxing fixes/refactoring we'll change this struct to reflect structs used in the SDK code, and will move to
+	// using the SDK type system.
+	Credentials                        types.String `tfsdk:"credentials"`
+	AccessToken                        types.String `tfsdk:"access_token"`
+	ImpersonateServiceAccount          types.String `tfsdk:"impersonate_service_account"`
+	ImpersonateServiceAccountDelegates types.List   `tfsdk:"impersonate_service_account_delegates"`
+	Project                            types.String `tfsdk:"project"`
+	BillingProject                     types.String `tfsdk:"billing_project"`
+	Region                             types.String `tfsdk:"region"`
+	Zone                               types.String `tfsdk:"zone"`
+	Scopes                             types.List   `tfsdk:"scopes"`
+	//	omit Batching
+	UserProjectOverride                       types.Bool   `tfsdk:"user_project_override"`
+	RequestTimeout                            types.String `tfsdk:"request_timeout"`
+	RequestReason                             types.String `tfsdk:"request_reason"`
+	UniverseDomain                            types.String `tfsdk:"universe_domain"`
+	DefaultLabels                             types.Map    `tfsdk:"default_labels"`
+	AddTerraformAttributionLabel              types.Bool   `tfsdk:"add_terraform_attribution_label"`
+	TerraformAttributionLabelAdditionStrategy types.String `tfsdk:"terraform_attribution_label_addition_strategy"`
+}
+
+func (m *GoogleProviderConfigPluginFrameworkModel) GetLocationDescription(providerConfig *fwtransport.FrameworkProviderConfig) fwresource.LocationDescription {
+	return fwresource.LocationDescription{
+		RegionSchemaField: types.StringValue("region"),
+		ZoneSchemaField:   types.StringValue("zone"),
+		ProviderRegion:    providerConfig.Region,
+		ProviderZone:      providerConfig.Zone,
+	}
+}
+
+func (d *GoogleProviderConfigPluginFrameworkDataSource) Metadata(ctx context.Context, req datasource.MetadataRequest, resp *datasource.MetadataResponse) {
+	resp.TypeName = req.ProviderTypeName + "_provider_config_plugin_framework"
+}
+
+func (d *GoogleProviderConfigPluginFrameworkDataSource) Schema(ctx context.Context, req datasource.SchemaRequest, resp *datasource.SchemaResponse) {
+
+	resp.Schema = schema.Schema{
+
+		Description:         "Use this data source to access the configuration of the Google Cloud provider. This data source is implemented with the SDK.",
+		MarkdownDescription: "Use this data source to access the configuration of the Google Cloud provider. This data source is implemented with the SDK.",
+		Attributes: map[string]schema.Attribute{
+			// Start of user inputs
+			"access_token": schema.StringAttribute{
+				Description:         "The access_token argument used to configure the provider",
+				MarkdownDescription: "The access_token argument used to configure the provider",
+				Computed:            true,
+				Sensitive:           true,
+			},
+			"credentials": schema.StringAttribute{
+				Description:         "The credentials argument used to configure the provider",
+				MarkdownDescription: "The credentials argument used to configure the provider",
+				Computed:            true,
+				Sensitive:           true,
+			},
+			"impersonate_service_account": schema.StringAttribute{
+				Description:         "The impersonate_service_account argument used to configure the provider",
+				MarkdownDescription: "The impersonate_service_account argument used to configure the provider.",
+				Computed:            true,
+			},
+			"impersonate_service_account_delegates": schema.ListAttribute{
+				ElementType:         types.StringType,
+				Description:         "The impersonate_service_account_delegates argument used to configure the provider",
+				MarkdownDescription: "The impersonate_service_account_delegates argument used to configure the provider.",
+				Computed:            true,
+			},
+			"project": schema.StringAttribute{
+				Description:         "The project argument used to configure the provider",
+				MarkdownDescription: "The project argument used to configure the provider.",
+				Computed:            true,
+			},
+			"region": schema.StringAttribute{
+				Description:         "The region argument used to configure the provider.",
+				MarkdownDescription: "The region argument used to configure the provider.",
+				Computed:            true,
+			},
+			"billing_project": schema.StringAttribute{
+				Description:         "The billing_project argument used to configure the provider.",
+				MarkdownDescription: "The billing_project argument used to configure the provider.",
+				Computed:            true,
+			},
+			"zone": schema.StringAttribute{
+				Description:         "The zone argument used to configure the provider.",
+				MarkdownDescription: "The zone argument used to configure the provider.",
+				Computed:            true,
+			},
+			"universe_domain": schema.StringAttribute{
+				Description:         "The universe_domain argument used to configure the provider.",
+				MarkdownDescription: "The universe_domain argument used to configure the provider.",
+				Computed:            true,
+			},
+			"scopes": schema.ListAttribute{
+				ElementType:         types.StringType,
+				Description:         "The scopes argument used to configure the provider.",
+				MarkdownDescription: "The scopes argument used to configure the provider.",
+				Computed:            true,
+			},
+			"user_project_override": schema.BoolAttribute{
+				Description:         "The user_project_override argument used to configure the provider.",
+				MarkdownDescription: "The user_project_override argument used to configure the provider.",
+				Computed:            true,
+			},
+			"request_reason": schema.StringAttribute{
+				Description:         "The request_reason argument used to configure the provider.",
+				MarkdownDescription: "The request_reason argument used to configure the provider.",
+				Computed:            true,
+			},
+			"request_timeout": schema.StringAttribute{
+				Description:         "The request_timeout argument used to configure the provider.",
+				MarkdownDescription: "The request_timeout argument used to configure the provider.",
+				Computed:            true,
+			},
+			"default_labels": schema.MapAttribute{
+				ElementType:         types.StringType,
+				Description:         "The default_labels argument used to configure the provider.",
+				MarkdownDescription: "The default_labels argument used to configure the provider.",
+				Computed:            true,
+			},
+			"add_terraform_attribution_label": schema.BoolAttribute{
+				Description:         "The add_terraform_attribution_label argument used to configure the provider.",
+				MarkdownDescription: "The add_terraform_attribution_label argument used to configure the provider.",
+				Computed:            true,
+			},
+			"terraform_attribution_label_addition_strategy": schema.StringAttribute{
+				Description:         "The terraform_attribution_label_addition_strategy argument used to configure the provider.",
+				MarkdownDescription: "The terraform_attribution_label_addition_strategy argument used to configure the provider.",
+				Computed:            true,
+			},
+			// End of user inputs
+
+			// Note - this data source excludes the default and custom endpoints for individual services
+		},
+	}
+}
+
+func (d *GoogleProviderConfigPluginFrameworkDataSource) Configure(ctx context.Context, req datasource.ConfigureRequest, resp *datasource.ConfigureResponse) {
+	// Prevent panic if the provider has not been configured.
+	if req.ProviderData == nil {
+		return
+	}
+
+	p, ok := req.ProviderData.(*fwtransport.FrameworkProviderConfig)
+	if !ok {
+		resp.Diagnostics.AddError(
+			"Unexpected Data Source Configure Type",
+			fmt.Sprintf("Expected *fwtransport.FrameworkProviderConfig, got: %T. Please report this issue to the provider developers.", req.ProviderData),
+		)
+		return
+	}
+
+	// Required for accessing project, region, zone and tokenSource
+	d.providerConfig = p
+}
+
+func (d *GoogleProviderConfigPluginFrameworkDataSource) Read(ctx context.Context, req datasource.ReadRequest, resp *datasource.ReadResponse) {
+	var data GoogleProviderConfigPluginFrameworkModel
+	var metaData *fwmodels.ProviderMetaModel
+
+	// Read Provider meta into the meta model
+	resp.Diagnostics.Append(req.ProviderMeta.Get(ctx, &metaData)...)
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	// Read Terraform configuration data into the model
+	resp.Diagnostics.Append(req.Config.Get(ctx, &data)...)
+	if resp.Diagnostics.HasError() {
+		return
+	}
+
+	// Copy all values from the provider config into this data source
+
+	data.Credentials = d.providerConfig.Credentials
+	// TODO(SarahFrench) - access_token
+	// TODO(SarahFrench) - impersonate_service_account
+	// TODO(SarahFrench) - impersonate_service_account_delegates
+	data.Project = d.providerConfig.Project
+	data.Region = d.providerConfig.Region
+	data.BillingProject = d.providerConfig.BillingProject
+	data.Zone = d.providerConfig.Zone
+	data.UniverseDomain = d.providerConfig.UniverseDomain
+	data.Scopes = d.providerConfig.Scopes
+	data.UserProjectOverride = d.providerConfig.UserProjectOverride
+	// TODO(SarahFrench) - request_reason
+	// TODO(SarahFrench) - request_timeout
+	data.DefaultLabels = d.providerConfig.DefaultLabels
+	// TODO(SarahFrench) - add_terraform_attribution_label
+	// TODO(SarahFrench) - terraform_attribution_label_addition_strategy
+
+	// Warn users against using this data source
+	resp.Diagnostics.Append(diag.NewWarningDiagnostic(
+		"Data source google_provider_config_plugin_framework should not be used",
+		"Data source google_provider_config_plugin_framework is intended to be used only in acceptance tests for the provider. Instead, please use the google_client_config data source to access provider configuration details, or open a GitHub issue requesting new features in that datasource. Please go to: https://github.com/hashicorp/terraform-provider-google/issues/new/choose",
+	))
+
+	// Save data into Terraform state
+	resp.Diagnostics.Append(resp.State.Set(ctx, &data)...)
+}