Autorecover from duplicate project in tests (#1053)

Signed-off-by: Jose Vazquez <[email protected]>

Author: josvazg

test/e2e/actions/deploy/deploy_operator.go

@@ -14,7 +14,9 @@ import (
 
 	"github.com/mongodb/mongodb-atlas-kubernetes/pkg/api/v1/status"
 	"github.com/mongodb/mongodb-atlas-kubernetes/test/e2e/actions/kube"
+	"github.com/mongodb/mongodb-atlas-kubernetes/test/e2e/api/atlas"
 	"github.com/mongodb/mongodb-atlas-kubernetes/test/e2e/config"
+	"github.com/mongodb/mongodb-atlas-kubernetes/test/e2e/fixtest"
 	"github.com/mongodb/mongodb-atlas-kubernetes/test/e2e/k8s"
 	"github.com/mongodb/mongodb-atlas-kubernetes/test/e2e/model"
 	"github.com/mongodb/mongodb-atlas-kubernetes/test/e2e/utils"
@@ -50,9 +52,16 @@ func CreateProject(testData *model.TestDataProvider) {
 		testData.Project.Namespace = testData.Resources.Namespace
 	}
 	By(fmt.Sprintf("Deploy Project %s", testData.Project.GetName()), func() {
+		aClient := atlas.GetClientOrFail()
 		err := testData.K8SClient.Create(testData.Context, testData.Project)
 		Expect(err).ShouldNot(HaveOccurred(), "Project %s was not created", testData.Project.GetName())
 		Eventually(func(g Gomega) {
+			// We reported Atlas creating duplicates of a project with the same name
+			// See https://jira.mongodb.org/browse/CLOUDP-187749
+			// this fix in our tests allows them to automatically fix this issue
+			// and thus avoid a flaky failure when this duplicates happens
+			g.Expect(fixtest.EnsureNoDuplicates(aClient.Client, fixtest.ZapLoggerFrom(GinkgoWriter), testData.Project.Spec.Name)).ToNot(HaveOccurred())
+
 			condition, _ := k8s.GetProjectStatusCondition(
 				testData.Context,
 				testData.K8SClient,

test/e2e/fixtest/remove_duplicates.go

@@ -0,0 +1,77 @@
+package fixtest
+
+import (
+	"context"
+	"io"
+	"sort"
+
+	"go.mongodb.org/atlas/mongodbatlas"
+	"go.uber.org/zap"
+	"go.uber.org/zap/zapcore"
+)
+
+// ZapLoggerFrom builds a zap.SugaredLogger from an IO Writer
+func ZapLoggerFrom(w io.Writer) *zap.SugaredLogger {
+	zcore := zapcore.NewCore(
+		zapcore.NewJSONEncoder(zap.NewDevelopmentEncoderConfig()),
+		zapcore.Lock(zapcore.AddSync(w)),
+		zap.NewAtomicLevel(),
+	)
+	return zap.New(zcore).Sugar()
+}
+
+// EnsureNoDuplicates removes projects with same name but different ID.
+// Atlas sometimes creates duplicate projects, we need our tests to defend
+// against that to avoid flaky tests
+func EnsureNoDuplicates(client *mongodbatlas.Client, logger *zap.SugaredLogger, projectName string) error {
+	found, err := listProjectsByName(client, projectName)
+	if err != nil || len(found) <= 1 {
+		return err
+	}
+	logger.Warnf("Found more than one project with name %q", projectName)
+	keep, rest := selectProject(found)
+	logger.Warnf("Will keep project ID %s as %s and remove the rest %v", keep.ID, projectName, ids(rest))
+	return removeProjects(client, rest)
+}
+
+func listProjectsByName(client *mongodbatlas.Client, projectName string) ([]*mongodbatlas.Project, error) {
+	projects, _, err := client.Projects.GetAllProjects(
+		context.Background(),
+		&mongodbatlas.ListOptions{},
+	)
+	found := []*mongodbatlas.Project{}
+	if err != nil {
+		return found, err
+	}
+	for _, project := range projects.Results {
+		if project.Name == projectName {
+			found = append(found, project)
+		}
+	}
+	return found, nil
+}
+
+func selectProject(projects []*mongodbatlas.Project) (*mongodbatlas.Project, []*mongodbatlas.Project) {
+	sort.Slice(projects, func(i, j int) bool {
+		return projects[i].ID < projects[j].ID
+	})
+	return projects[0], projects[1:]
+}
+
+func removeProjects(client *mongodbatlas.Client, projects []*mongodbatlas.Project) error {
+	for _, project := range projects {
+		_, err := client.Projects.Delete(context.Background(), project.ID)
+		if err != nil {
+			return err
+		}
+	}
+	return nil
+}
+
+func ids(projects []*mongodbatlas.Project) []string {
+	ids := []string{}
+	for _, prj := range projects {
+		ids = append(ids, prj.ID)
+	}
+	return ids
+}