helper/resource: compatibility refresh after config mode test step

helper/resource/compatibility.go

@@ -0,0 +1,13 @@
+// Copyright (c) HashiCorp, Inc.
+// SPDX-License-Identifier: MPL-2.0
+
+package resource
+
+// Deprecated. This is an undocumented compatibility flag. When
+// `RefreshAfterApply` is set to non-empty, a `Config`-mode test step will
+// invoke a refresh before successful completion. This is intended as a
+// compatibility measure for test cases that have different -- but
+// semantically-equal -- state representations in their test steps. When
+// comparing two states, the testing framework is not aware of semantic
+// equality or set equality, as that would rely on provider logic.
+var RefreshAfterApply string

helper/resource/plugin.go

@@ -114,6 +114,15 @@ type providerFactories struct {
 	protov6 protov6ProviderFactories
 }
 
+func runProviderCommandApplyRefreshOnly(ctx context.Context, t testing.T, wd *plugintest.WorkingDir, factories *providerFactories) error {
+	t.Helper()
+
+	fn := func() error {
+		return wd.Apply(ctx, tfexec.Refresh(true), tfexec.RefreshOnly(true))
+	}
+	return runProviderCommand(ctx, t, wd, factories, fn)
+}
+
 func runProviderCommandCreatePlan(ctx context.Context, t testing.T, wd *plugintest.WorkingDir, factories *providerFactories) error {
 	t.Helper()
 

helper/resource/testing_new_config.go

@@ -442,5 +442,20 @@ func testStepNewConfig(ctx context.Context, t testing.T, c TestCase, wd *plugint
 		}
 	}
 
+	// I'm sorry, I'm afraid I can't do that. With one exception.
+	if RefreshAfterApply == "unlocked" && !step.Destroy && !step.PlanOnly {
+		if len(c.Steps) > stepIndex+1 {
+			// If the next step is a refresh, then we have no need to refresh here
+			if !c.Steps[stepIndex+1].RefreshState {
+				// Echo a searchable message to easily determine when this is no longer being used
+				fmt.Println("RefreshAfterApply: running apply -refresh-only -refresh=true")
+				err := runProviderCommandApplyRefreshOnly(ctx, t, wd, providers)
+				if err != nil {
+					return fmt.Errorf("Error running apply refresh-only: %w", err)
+				}
+			}
+		}
+	}
+
 	return nil
 }