Protect against provider version data missing when using an un-reattached, un-builtin provider. Add test coverage.

Author: SarahFrench

internal/configs/state_store.go

@@ -5,13 +5,15 @@ package configs
 
 import (
 	"fmt"
+	"os"
 
 	version "github.com/hashicorp/go-version"
 	"github.com/hashicorp/hcl/v2"
 	"github.com/hashicorp/hcl/v2/hcldec"
 	tfaddr "github.com/hashicorp/terraform-registry-address"
 	"github.com/hashicorp/terraform/internal/addrs"
 	"github.com/hashicorp/terraform/internal/configs/configschema"
+	"github.com/hashicorp/terraform/internal/getproviders/reattach"
 	"github.com/hashicorp/terraform/internal/tfdiags"
 	"github.com/zclconf/go-cty/cty"
 )
@@ -206,10 +208,25 @@ func (b *StateStore) Hash(stateStoreSchema *configschema.Block, providerSchema *
 	}
 
 	var providerVersionString string
-	if stateStoreProviderVersion != nil {
-		providerVersionString = stateStoreProviderVersion.String()
+	if stateStoreProviderVersion == nil {
+		isReattached, err := reattach.IsProviderReattached(b.ProviderAddr, os.Getenv("TF_REATTACH_PROVIDERS"))
+		if err != nil {
+			return 0, diags.Append(fmt.Errorf("Unable to determine if state storage provider is reattached while hashing state store configuration. This is a bug in Terraform and should be reported: %w", err))
+		}
+
+		if (b.ProviderAddr.Hostname != tfaddr.BuiltInProviderHost) &&
+			!isReattached {
+			return 0, diags.Append(&hcl.Diagnostic{
+				Severity: hcl.DiagError,
+				Summary:  "Unable to calculate hash of state store configuration",
+				Detail:   "Provider version data was missing during hash generation. This is a bug in Terraform and should be reported.",
+			})
+		}
+
+		// Version information can be empty but only if the provider is builtin or unmanaged by Terraform
+		providerVersionString = ""
 	} else {
-		providerVersionString = "" // It's valid for no version to be present if the provider is builtin or reattached
+		providerVersionString = stateStoreProviderVersion.String()
 	}
 
 	toHash := cty.TupleVal([]cty.Value{

internal/configs/state_store_test.go

@@ -269,14 +269,17 @@ func TestStateStore_Hash_errorConditions(t *testing.T) {
 			},
 		},
 	}
+	exampleProviderVersion := version.Must(version.NewSemver("1.2.3"))
 
 	// Cases where an error would occur
 	cases := map[string]struct {
 		config           hcl.Body
 		stateStoreSchema *configschema.Block
+		providerVersion  *version.Version
 		wantErrorString  string
 	}{
 		"returns errors when the state_store config doesn't match the schema": {
+			providerVersion:  exampleProviderVersion,
 			stateStoreSchema: exampleStateStoreSchema,
 			config: configBodyForTest(t, `state_store "foobar_fs" {
 					provider "foobar" {
@@ -292,6 +295,7 @@ func TestStateStore_Hash_errorConditions(t *testing.T) {
 			wantErrorString: "Unsupported argument",
 		},
 		"returns errors when the provider config doesn't match the schema": {
+			providerVersion:  exampleProviderVersion,
 			stateStoreSchema: exampleStateStoreSchema,
 			config: configBodyForTest(t, `state_store "foobar_fs" {
 					provider "foobar" {
@@ -307,6 +311,7 @@ func TestStateStore_Hash_errorConditions(t *testing.T) {
 			wantErrorString: "Unsupported argument",
 		},
 		"returns an error if the state_store schema includes a provider block": {
+			providerVersion: exampleProviderVersion,
 			stateStoreSchema: &configschema.Block{
 				BlockTypes: map[string]*configschema.NestedBlock{
 					"provider": {
@@ -332,6 +337,7 @@ func TestStateStore_Hash_errorConditions(t *testing.T) {
 			wantErrorString: `Protected block name "provider" in state store schema`,
 		},
 		"returns an error if the state_store schema includes a provider attribute": {
+			providerVersion: exampleProviderVersion,
 			stateStoreSchema: &configschema.Block{
 				Attributes: map[string]*configschema.Attribute{
 					"provider": {
@@ -349,6 +355,18 @@ func TestStateStore_Hash_errorConditions(t *testing.T) {
 			}`),
 			wantErrorString: `Protected argument name "provider" in state store schema`,
 		},
+		"returns an error if the provider version is missing when using a non-builtin, non-reattached provider": {
+			providerVersion:  nil, // No value provided in this test case
+			stateStoreSchema: exampleStateStoreSchema,
+			config: configBodyForTest(t, `state_store "foobar_fs" {
+					provider "foobar" {
+					  foobar = "foobar"
+					}
+					path          = "mystate.tfstate"
+					workspace_dir = "foobar"
+			}`),
+			wantErrorString: `Provider version data was missing during hash generation`,
+		},
 	}
 
 	for tn, tc := range cases {
@@ -366,7 +384,7 @@ func TestStateStore_Hash_errorConditions(t *testing.T) {
 			s.ProviderAddr = tfaddr.NewProvider(tfaddr.DefaultProviderRegistryHost, "hashicorp", "foobar")
 
 			// Test Hash method.
-			_, diags := s.Hash(tc.stateStoreSchema, exampleProviderSchema, version.Must(version.NewSemver("1.2.3")))
+			_, diags := s.Hash(tc.stateStoreSchema, exampleProviderSchema, tc.providerVersion)
 			if !diags.HasErrors() {
 				t.Fatal("expected error but got none")
 			}