test: Supports running MacT tests at unit test stage (#3191)

* test: Support testing PlanModifier

* fix broken unit test

* test: Supports running MacT tests at unit test stage

* Address PR comments

* docs: Update testing best practices to include MipT for testing PlanModifier logic

* update docs based on suggestions

* pr suggestions

* test: Remove test files after usage

* add comment about signature

* chore: increase timeout (believe the high default parallel  factor 50 might lead to longer test time)

* doc: Add docstrings and comments based on PR comments

Author: EspenAlbert

.github/workflows/acceptance-tests-runner.yml

@@ -403,13 +403,6 @@ jobs:
         with:
           terraform_version: ${{ inputs.terraform_version }}
           terraform_wrapper: false  
-      - name: Unit tests
-        run: go test -v ./internal/testutil/acc/advanced_cluster_preview_provider_v2_test.go
-      - name: Mocked Acceptance Tests
-        env:
-          ACCTEST_REGEX_RUN: '^TestAccMockable'
-          ACCTEST_PACKAGES: ./internal/service/advancedcluster
-        run: make testmact
       - name: Acceptance Tests
         env:
           MONGODB_ATLAS_LAST_VERSION: ${{ needs.get-provider-version.outputs.provider_version }}

Makefile

@@ -40,7 +40,11 @@ clean-atlas-org: ## Run a test to clean all projects and pending resources in an
 
 .PHONY: test
 test: fmtcheck ## Run unit tests
-	go test ./... -timeout=60s -parallel=$(PARALLEL_GO_TEST) -race
+	@$(eval export HTTP_MOCKER_REPLAY?=true)
+	@$(eval export MONGODB_ATLAS_ORG_ID?=111111111111111111111111)
+	@$(eval export MONGODB_ATLAS_PROJECT_ID?=111111111111111111111111)
+	@$(eval export MONGODB_ATLAS_CLUSTER_NAME?=mocked-cluster)
+	go test ./... -timeout=120s -parallel=$(PARALLEL_GO_TEST) -race
 
 .PHONY: testmact
 testmact: ## Run MacT tests (mocked acc tests)

internal/testutil/acc/shared_resource.go

@@ -74,12 +74,12 @@ func ProjectIDExecution(tb testing.TB) string {
 // When `MONGODB_ATLAS_PROJECT_ID` and `MONGODB_ATLAS_CLUSTER_NAME` are defined, they are used instead of creating a project and clusterName.
 func ProjectIDExecutionWithCluster(tb testing.TB, totalNodeCount int) (projectID, clusterName string) {
 	tb.Helper()
-	SkipInUnitTest(tb)
-	require.True(tb, sharedInfo.init, "SetupSharedResources must called from TestMain test package")
-
 	if ExistingClusterUsed() {
 		return existingProjectIDClusterName()
 	}
+	// Only skip after ExistingClusterUsed() to allow MacT (Mocked-Acceptance Tests) to return early instead of being skipped.
+	SkipInUnitTest(tb)
+	require.True(tb, sharedInfo.init, "SetupSharedResources must called from TestMain test package")
 	return NextProjectIDClusterName(totalNodeCount, func(projectName string) string {
 		return createProject(tb, projectName)
 	})

internal/testutil/unit/http_mock_configs.go

@@ -1,6 +1,7 @@
 package unit
 
 import (
+	"sync"
 	"time"
 
 	"github.com/mongodb/terraform-provider-mongodbatlas/internal/service/advancedclustertpf"
@@ -12,11 +13,15 @@ const (
 
 var (
 	MockConfigAdvancedClusterTPF = MockHTTPDataConfig{AllowMissingRequests: true, RunBeforeEach: shortenClusterTPFRetries, IsDiffMustSubstrings: []string{"/clusters"}, QueryVars: []string{"providerName"}}
+	onceShortenClusterTPFRetries sync.Once
 )
 
+// shortenClusterTPFRetries must meet the interface func() error as it is used in RunBeforeEach which runs as part of TestCase.PreCheck()
 func shortenClusterTPFRetries() error {
-	advancedclustertpf.RetryMinTimeout = shortRefresh
-	advancedclustertpf.RetryDelay = shortRefresh
-	advancedclustertpf.RetryPollInterval = shortRefresh
+	onceShortenClusterTPFRetries.Do(func() {
+		advancedclustertpf.RetryMinTimeout = shortRefresh
+		advancedclustertpf.RetryDelay = shortRefresh
+		advancedclustertpf.RetryPollInterval = shortRefresh
+	})
 	return nil
 }

internal/testutil/unit/http_mocker.go

@@ -23,14 +23,14 @@ const (
 )
 
 type MockHTTPDataConfig struct {
-	RunBeforeEach        func() error
-	RequestHandler       ManualRequestHandler
-	FilePathOverride     string
-	IsDiffSkipSuffixes   []string
-	IsDiffMustSubstrings []string
-	QueryVars            []string
-	AllowMissingRequests bool
-	AllowOutOfOrder      bool
+	RunBeforeEach        func() error         // Run by TestCase.PreCheck. Useful for reducing retry timeouts.
+	RequestHandler       ManualRequestHandler // Allow inspecting or overriding mocking behavior. Can be used to return 404 when a test has completed.
+	FilePathOverride     string               // Read mock data file from specific filepath, otherwise using the test name in `MockConfigFilePath` to find mocked responses.
+	IsDiffSkipSuffixes   []string             // Can be used when a PATCH/POST request is creating noise for diffs, for example :validate endpoints.
+	IsDiffMustSubstrings []string             // Only include diff request for specific substrings, for example /clusters (avoids project create requests)
+	QueryVars            []string             // Substitute this query vars. Useful when differentiating responses based on query args, for example ?providerName=AWS/AZURE returns different responses
+	AllowMissingRequests bool                 // When false will require all API calls to be made.
+	AllowOutOfOrder      bool                 // When true will allow a GET request returned after a POST to be returned before the POST.
 }
 
 func (c MockHTTPDataConfig) WithAllowOutOfOrder() MockHTTPDataConfig { //nolint: gocritic // Want each test run to have its own config (hugeParam: c is heavy (112 bytes); consider passing it by pointer)
@@ -151,10 +151,11 @@ func enableReplayForTestCase(t *testing.T, config *MockHTTPDataConfig, testCase
 	}
 	roundTripper, mockRoundTripper := NewMockRoundTripper(t, config, data)
 	httpClientModifier := mockClientModifier{config: config, mockRoundTripper: roundTripper}
+	testCase.IsUnitTest = true
 	testCase.ProtoV6ProviderFactories = TestAccProviderV6FactoriesWithMock(t, &httpClientModifier)
 	testCase.PreCheck = func() {
 		if config.RunBeforeEach != nil {
-			// Mock Configs can share SideEffect, using lock to avoid race conditions.
+			// Mock Configs can share RunBeforeEach, using lock to avoid race conditions.
 			accClientLock.Lock()
 			defer accClientLock.Unlock()
 			require.NoError(t, config.RunBeforeEach())