Provider is not configured as part of the Test or UnitTest

[MovieStoreGuy]

terraform-plugin-testing version

github.com/hashicorp/terraform-plugin-testing v1.13.2

Relevant provider source code

package main

import (
	"context"
	"sync/atomic"
	"testing"

	"github.com/hashicorp/terraform-plugin-framework/datasource"
	"github.com/hashicorp/terraform-plugin-framework/provider"
	"github.com/hashicorp/terraform-plugin-framework/providerserver"
	"github.com/hashicorp/terraform-plugin-framework/resource"
	"github.com/hashicorp/terraform-plugin-go/tfprotov5"
	testresource "github.com/hashicorp/terraform-plugin-testing/helper/resource"
	"github.com/stretchr/testify/assert"
)

type MockProvider struct {
	tb         testing.TB
	configured *atomic.Bool
}

var _ provider.Provider = (*MockProvider)(nil)

func (mp *MockProvider) Metadata(_ context.Context, _ provider.MetadataRequest, _ *provider.MetadataResponse) {
	// No-op for mock
	mp.tb.Log("Metadata requested")
}

func (mp *MockProvider) Schema(_ context.Context, _ provider.SchemaRequest, _ *provider.SchemaResponse) {
	mp.tb.Log("Schema requested")
}

func (mp *MockProvider) Configure(_ context.Context, _ provider.ConfigureRequest, _ *provider.ConfigureResponse) {
	mp.tb.Log("Provider configured")
	mp.configured.Store(true)
}

func (mp *MockProvider) DataSources(_ context.Context) []func() datasource.DataSource {
	mp.tb.Log("DataSources requested")
	return nil
}

func (mp *MockProvider) Resources(_ context.Context) []func() resource.Resource {
	mp.tb.Log("Resources requested")
	return nil
}

func TestProviderConfiguredExample(t *testing.T) {
	mock := &MockProvider{
		tb:         t,
		configured: &atomic.Bool{},
	}

	testresource.UnitTest(t, testresource.TestCase{
		Steps: []testresource.TestStep{
			{
				Config: `provider "mock" {}`,
				ProtoV5ProviderFactories: map[string]func() (tfprotov5.ProviderServer, error){
					"mock": providerserver.NewProtocol5WithError(mock),
				},
			},
		},
	})

	assert.True(t, mock.configured.Load(), "Provider should be configured")
}

Terraform Configuration Files

# insert config here
provider "mock" {}

Expected Behavior

What I expect here is the mock provider configuration is called so that it can apply the data fields so the components can be applied using their optional configure method with using the framework.

Actual Behavior

What actually happens is provider.Configure is never called and it is not clear that it shoudl

Steps to Reproduce

I've simplified my issue in the above PoC, it should just require copying it locally to see what I am observing.

References

[MovieStoreGuy]

I am depending on Configure to be called here so that resources are configured with a mock client within the unit tests, however, it looks like regardless if it is a Test or UnitTest the provider.Configure method is never called.

[SBGoods]

Hi @MovieStoreGuy 👋🏾,
I believe that Terraform will not call a provider's configure method unless there is a resource/datasource/etc of that provider being plan/applied in the configuration. Can you try defining a resource or datasource in the mock provider and declaring it in the teststep Terraform configuration?

[MovieStoreGuy]

So I missed a brief comment within the tutorial that says:

// Add a nil check when handling ProviderData because Terraform
// sets that data after it calls the ConfigureProvider RPC.

Source

The fix for me is add a check for nil in the Resource.Configure step.