chore: Adjust tests creating free tier cluster to have dedicated project (#3596)

* adjust tests creating free tier cluster to have dedicated project

* adding comment

* refactor ProjectIDExecutionWithCluster to contemplate restriction of free tier clusters

* separate function to avoid making ProjectIDExecutionWithCluster more complex

Author: AgustinBettati

internal/service/advancedcluster/resource_advanced_cluster_test.go

@@ -122,9 +122,8 @@ func TestGetReplicationSpecAttributesFromOldAPI(t *testing.T) {
 	}
 }
 
-func testAccAdvancedClusterFlexUpgrade(t *testing.T, instanceSize string, includeDedicated bool) resource.TestCase {
+func testAccAdvancedClusterFlexUpgrade(t *testing.T, projectID, clusterName, instanceSize string, includeDedicated bool) resource.TestCase {
 	t.Helper()
-	projectID, clusterName := acc.ProjectIDExecutionWithCluster(t, 1)
 	defaultZoneName := "Zone 1" // Uses backend default as in existing tests
 
 	// avoid checking plural data source to reduce risk of being impacted from failure in other test using same project, allows running in parallel
@@ -154,15 +153,17 @@ func testAccAdvancedClusterFlexUpgrade(t *testing.T, instanceSize string, includ
 }
 
 func TestAccAdvancedCluster_basicTenant_flexUpgrade_dedicatedUpgrade(t *testing.T) {
-	resource.ParallelTest(t, testAccAdvancedClusterFlexUpgrade(t, freeInstanceSize, true))
+	projectID, clusterName := acc.ProjectIDExecutionWithFreeCluster(t, 3, 1)
+	resource.ParallelTest(t, testAccAdvancedClusterFlexUpgrade(t, projectID, clusterName, freeInstanceSize, true))
 }
 
 func TestAccAdvancedCluster_sharedTier_flexUpgrade(t *testing.T) {
-	resource.ParallelTest(t, testAccAdvancedClusterFlexUpgrade(t, sharedInstanceSize, false))
+	projectID, clusterName := acc.ProjectIDExecutionWithCluster(t, 1)
+	resource.ParallelTest(t, testAccAdvancedClusterFlexUpgrade(t, projectID, clusterName, sharedInstanceSize, false))
 }
 func TestAccMockableAdvancedCluster_tenantUpgrade(t *testing.T) {
 	var (
-		projectID, clusterName = acc.ProjectIDExecutionWithCluster(t, 1)
+		projectID, clusterName = acc.ProjectIDExecutionWithFreeCluster(t, 3, 1)
 		defaultZoneName        = "Zone 1" // Uses backend default to avoid non-empty plan, see CLOUDP-294339
 	)
 	unit.CaptureOrMockTestCaseAndRun(t, mockConfig, &resource.TestCase{

internal/testutil/acc/atlas.go

@@ -104,22 +104,6 @@ func createStreamInstance(tb testing.TB, projectID, name string) {
 	require.NoError(tb, err, "Stream instance creation failed: %s, err: %s", name, err)
 }
 
-// ProjectID returns the id for a project name.
-// When `MONGODB_ATLAS_PROJECT_ID` is defined, it is used instead of creating a project. This is useful for local execution but not intended for CI executions.
-func ProjectID(tb testing.TB, name string) string {
-	tb.Helper()
-	SkipInUnitTest(tb)
-
-	if id := projectIDLocal(); id != "" {
-		return id
-	}
-
-	resp, _, _ := ConnV2().ProjectsApi.GetProjectByName(tb.Context(), name).Execute()
-	id := resp.GetId()
-	require.NotEmpty(tb, id, "Project name not found: %s", name)
-	return id
-}
-
 func projectIDLocal() string {
 	return os.Getenv("MONGODB_ATLAS_PROJECT_ID")
 }

internal/testutil/acc/shared_resource.go

@@ -15,6 +15,7 @@ import (
 
 const (
 	MaxClusterNodesPerProject = 30 // Choose to be conservative, 40 clusters per project is the limit before `CROSS_REGION_NETWORK_PERMISSIONS_LIMIT_EXCEEDED` error, see https://www.mongodb.com/docs/atlas/reference/atlas-limits/
+	MaxFreeTierClusterCount   = 1  // Project can have at most 1 free tier cluster
 )
 
 // SetupSharedResources must be called from TestMain test package in order to use ProjectIDExecution.
@@ -79,23 +80,29 @@ func ProjectIDExecution(tb testing.TB) string {
 	return sharedInfo.projectID
 }
 
-// ProjectIDExecutionWithCluster creates a project and reuses it for  `MaxClusterNodesPerProject ` nodes. The clusterName is always unique.
-// TotalNodeCount = sum(specs.node_count) * num_shards (1 if new schema)
-// This avoids the `CROSS_REGION_NETWORK_PERMISSIONS_LIMIT_EXCEEDED` error when creating too many clusters within the same project.
-// 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) {
+// ProjectIDExecutionWithFreeCluster is identical to ProjectIDExecutionWithCluster but also contemplates the restriction of `MaxFreeTierClusterCount`
+func ProjectIDExecutionWithFreeCluster(tb testing.TB, totalNodeCount, freeTierClusterCount int) (projectID, clusterName string) {
 	tb.Helper()
 	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 NextProjectIDClusterName(totalNodeCount, freeTierClusterCount, func(projectName string) string {
 		return createProject(tb, projectName)
 	})
 }
 
+// ProjectIDExecutionWithCluster creates a project and reuses it with other tests respecting `MaxClusterNodesPerProject` restrictions. The clusterName is always unique.
+// TotalNodeCount = sum(specs.node_count) * num_shards (1 if new schema)
+// This avoids `CROSS_REGION_NETWORK_PERMISSIONS_LIMIT_EXCEEDED` and `project has reached the limit for the number of free clusters` errors when creating too many clusters within the same project.
+// 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()
+	return ProjectIDExecutionWithFreeCluster(tb, totalNodeCount, 0)
+}
+
 // ClusterNameExecution returns the name of a created cluster for the execution of the tests in the resource package.
 // This function relies on using an execution project and returns its id.
 // When `MONGODB_ATLAS_CLUSTER_NAME` and `MONGODB_ATLAS_PROJECT_ID` are defined it will be used instead of creating resources. This is useful for local execution but not intended for CI executions.
@@ -171,9 +178,10 @@ func SerialSleep(tb testing.TB) {
 }
 
 type projectInfo struct {
-	id        string
-	name      string
-	nodeCount int
+	id                   string
+	name                 string
+	nodeCount            int
+	freeTierClusterCount int
 }
 
 var sharedInfo = struct {
@@ -189,12 +197,14 @@ var sharedInfo = struct {
 	projects: []projectInfo{},
 }
 
-// NextProjectIDClusterName is an internal method used when we want to reuse a projectID `MaxClustersPerProject` times
-func NextProjectIDClusterName(totalNodeCount int, projectCreator func(string) string) (projectID, clusterName string) {
+// NextProjectIDClusterName is an internal method used when we want to reuse a projectID respecting `MaxClustersNodesPerProject` and `MaxFreeTierClusterCount`
+func NextProjectIDClusterName(totalNodeCount, freeTierClusterCount int, projectCreator func(string) string) (projectID, clusterName string) {
 	sharedInfo.mu.Lock()
 	defer sharedInfo.mu.Unlock()
 	var project projectInfo
-	if len(sharedInfo.projects) == 0 || sharedInfo.projects[len(sharedInfo.projects)-1].nodeCount+totalNodeCount > MaxClusterNodesPerProject {
+	if len(sharedInfo.projects) == 0 ||
+		sharedInfo.projects[len(sharedInfo.projects)-1].nodeCount+totalNodeCount > MaxClusterNodesPerProject ||
+		sharedInfo.projects[len(sharedInfo.projects)-1].freeTierClusterCount+freeTierClusterCount > MaxFreeTierClusterCount {
 		project = projectInfo{
 			name:      RandomProjectName(),
 			nodeCount: totalNodeCount,
@@ -204,6 +214,7 @@ func NextProjectIDClusterName(totalNodeCount int, projectCreator func(string) st
 	} else {
 		project = sharedInfo.projects[len(sharedInfo.projects)-1]
 		sharedInfo.projects[len(sharedInfo.projects)-1].nodeCount += totalNodeCount
+		sharedInfo.projects[len(sharedInfo.projects)-1].freeTierClusterCount += freeTierClusterCount
 	}
 	return project.id, RandomClusterName()
 }

internal/testutil/acc/shared_resource_test.go

@@ -15,20 +15,29 @@ func Test_NextProjectIDClusterName(t *testing.T) {
 	projectIDs := map[string]int{}
 	clusterNames := map[string]int{}
 
-	addProjectIDClusterName := func(nodeCount int) {
-		projectID, clusterName := acc.NextProjectIDClusterName(nodeCount, projectIDReturner)
+	addProjectIDClusterName := func(nodeCount int, freeTierClusterCount int) {
+		projectID, clusterName := acc.NextProjectIDClusterName(nodeCount, freeTierClusterCount, projectIDReturner)
 		projectIDs[projectID]++
 		clusterNames[clusterName]++
 	}
 	for range acc.MaxClusterNodesPerProject {
-		addProjectIDClusterName(1)
+		addProjectIDClusterName(1, 0)
 	}
 	assert.Len(t, projectIDs, 1)
 	assert.Len(t, clusterNames, acc.MaxClusterNodesPerProject)
-	addProjectIDClusterName(1)
+	addProjectIDClusterName(1, 0)
 	assert.Len(t, projectIDs, 2)
 	assert.Len(t, clusterNames, acc.MaxClusterNodesPerProject+1)
-	addProjectIDClusterName(acc.MaxClusterNodesPerProject)
+	addProjectIDClusterName(acc.MaxClusterNodesPerProject, 0)
 	assert.Len(t, projectIDs, 3)
 	assert.Len(t, clusterNames, acc.MaxClusterNodesPerProject+2)
+	addProjectIDClusterName(1, 0)
+	assert.Len(t, projectIDs, 4)
+	assert.Len(t, clusterNames, acc.MaxClusterNodesPerProject+3)
+	addProjectIDClusterName(0, 1) // adds free tier, shares existing project
+	assert.Len(t, projectIDs, 4)
+	assert.Len(t, clusterNames, acc.MaxClusterNodesPerProject+4)
+	addProjectIDClusterName(0, 1) // second free tier cluster creates a new project
+	assert.Len(t, projectIDs, 5)
+	assert.Len(t, clusterNames, acc.MaxClusterNodesPerProject+5)
 }