CLOUDP-249012: Fix project retrieval when project prefixes overlap (#3720)

# Summary

This patch fixes an error when the project look-up throws an error when
an in-exact project name match was found, as illustrated in the modified
E2E test:
- Previously, if trying to create `projectA` and `projectABC` already
exists, the project lookup would raise an error because the API would
return `projectABC` and when looping over the response, no exact match
for `projectA` would be found and instead of returning an empty project
to be created, the operator would raise an error and `projectA` would
fail to be created.

## Documentation changes

* [x] Add an entry to [release notes](.../RELEASE_NOTES.md).
* [ ] When needed, make sure you create a new [DOCSP
ticket](https://jira.mongodb.org/projects/DOCSP) that documents your
change.

## Changes to CRDs

* [ ] Add `slaskawi`(Sebastian) and `@giohan` (George) as reviewers.
* [ ] Make sure any changes are reflected on `/public/samples`
directory.

Author: mircea-cosbuc

RELEASE_NOTES.md

@@ -36,8 +36,12 @@
       to any other value than 1.
 * **MongoDB**, **AppDB**, **MongoDBMulti**: make sure to use external domains in the connectionString created if configured.  
 
-* **MongoDB**: remove panic when configuring shorter horizon config compared to number of members. Instead return a
-descriptive error.
+* **MongoDB**: Removed panic response when configuring shorter horizon config compared to number of members. The operator now signals a
+descriptive error in the status of the **MongoDB** resource.
+
+* **MongoDB**: Fixed a bug where creating a resource in a new project named as a prefix of another project would fail, preventing the `MongoDB` resource to be created.
+
+
 
 <!-- Past Releases -->
 # MongoDB Enterprise Kubernetes Operator 1.26.0

controllers/operator/project/project.go

@@ -145,41 +145,46 @@ func findProject(projectName string, organization *om.Organization, conn om.Conn
 	return nil, nil
 }
 
+// findProjectInsideOrganization looks up a project by name inside an organization and returns the project if it was the only one found by that name.
+// If no project was found, the function returns a nil project to indicate that no such project exists.
+// In all other cases, a non nil error is returned.
 func findProjectInsideOrganization(conn om.Connection, projectName string, organization *om.Organization, log *zap.SugaredLogger) (*om.Project, error) {
-	// 1. Trying to find the project by name
 	projects, err := conn.ReadProjectsInOrganizationByName(organization.ID, projectName)
 	if err != nil {
 		if v, ok := err.(*apierror.Error); ok {
+			// If the project was not found, return an empty project and no error.
 			if v.ErrorCode == apierror.ProjectNotFound {
 				// ProjectNotFound is an expected condition.
+
 				return nil, nil
 			}
 		}
-		log.Error(err)
+		// Return an empty project and the OM api error in case there is a different API error.
+		return nil, xerrors.Errorf("error looking up project %s in organization %s: %w", projectName, organization.ID, err)
 	}
 
-	if err == nil {
-		// there is no error so we need to check if the project found has this name
-		// (the project found could be just the page of one single project if the OM is old and "name"
-		// parameter is not supported)
-		var projectsFound []*om.Project
-		for _, project := range projects {
-			if project.Name == projectName {
-				projectsFound = append(projectsFound, project)
-			}
+	// There is no API error. We check if the project found has the exact name.
+	// The API endpoint returns a list of projects and in case of no exact match, it would return the first item that matches the search term as a prefix.
+	var projectsFound []*om.Project
+	for _, project := range projects {
+		if project.Name == projectName {
+			projectsFound = append(projectsFound, project)
 		}
+	}
 
-		if len(projectsFound) == 1 {
-			return projectsFound[0], nil
-		} else if len(projectsFound) > 0 {
-			projectsList := util.Transform(projectsFound, func(project *om.Project) string {
-				return fmt.Sprintf("%s (%s)", project.Name, project.ID)
-			})
-			return nil, xerrors.Errorf("found more than one project with name %s in organization %s (%s): %v", projectName, organization.ID, organization.Name, strings.Join(projectsList, ", "))
-		}
+	if len(projectsFound) == 1 {
+		// If there is just one project returned, and it matches the name, return it.
+		return projectsFound[0], nil
+	} else if len(projectsFound) > 0 {
+		projectsList := util.Transform(projectsFound, func(project *om.Project) string {
+			return fmt.Sprintf("%s (%s)", project.Name, project.ID)
+		})
+		// This should not happen, but older versions of OM supported the same name for a project in an org. We cannot proceed here so we return an error.
+		return nil, xerrors.Errorf("found more than one project with name %s in organization %s (%s): %v", projectName, organization.ID, organization.Name, strings.Join(projectsList, ", "))
 	}
 
-	return nil, xerrors.Errorf("could not find project %s in organization %s", projectName, organization.ID)
+	// If there is no error from the API and no match in the response, return an empty project and no error.
+	return nil, nil
 }
 
 func findOrganizationByName(conn om.Connection, name string, log *zap.SugaredLogger) (string, error) {

docker/mongodb-enterprise-tests/tests/replicaset/replica_set_agent_flags.py

@@ -1,6 +1,12 @@
 from typing import Optional
 
-from kubetester import create_or_update, find_fixture
+from kubetester import (
+    create_or_update,
+    create_or_update_configmap,
+    find_fixture,
+    random_k8s_name,
+    read_configmap,
+)
 from kubetester.kubetester import KubernetesTester
 from kubetester.mongodb import MongoDB, Phase
 from pytest import fixture, mark
@@ -16,10 +22,56 @@
 
 
 @fixture(scope="module")
-def replica_set(namespace: str, custom_mdb_version: str) -> MongoDB:
-    resource = MongoDB.from_yaml(find_fixture("replica-set-basic.yaml"), namespace=namespace)
+def project_name_prefix() -> str:
+    return random_k8s_name("project-prefix-")
+
+
+@fixture(scope="module")
+def first_project(namespace: str, project_name_prefix: str) -> str:
+    cm = read_configmap(namespace=namespace, name="my-project")
+    project_name = f"{project_name_prefix}-first"
+    return create_or_update_configmap(
+        namespace=namespace,
+        name=project_name,
+        data={
+            "baseUrl": cm["baseUrl"],
+            "projectName": project_name,
+            "orgId": cm["orgId"],
+        },
+    )
+
 
+@fixture(scope="module")
+def second_project(namespace: str, project_name_prefix: str) -> str:
+    cm = read_configmap(namespace=namespace, name="my-project")
+    project_name = project_name_prefix
+    return create_or_update_configmap(
+        namespace=namespace,
+        name=project_name,
+        data={
+            "baseUrl": cm["baseUrl"],
+            "projectName": project_name,
+            "orgId": cm["orgId"],
+        },
+    )
+
+
+@fixture(scope="module")
+def replica_set(namespace: str, first_project: str, custom_mdb_version: str) -> MongoDB:
+    resource = MongoDB.from_yaml(find_fixture("replica-set-basic.yaml"), namespace=namespace, name="replica-set")
     resource.set_version(ensure_ent_version(custom_mdb_version))
+    resource["spec"]["opsManager"]["configMapRef"]["name"] = first_project
+
+    create_or_update(resource)
+    return resource
+
+
+@fixture(scope="module")
+def second_replica_set(namespace: str, second_project: str, custom_mdb_version: str) -> MongoDB:
+    resource = MongoDB.from_yaml(find_fixture("replica-set-basic.yaml"), namespace=namespace, name="replica-set-2")
+    resource.set_version(ensure_ent_version(custom_mdb_version))
+    resource["spec"]["opsManager"]["configMapRef"]["name"] = second_project
+
     create_or_update(resource)
     return resource
 
@@ -29,6 +81,11 @@ def test_replica_set(replica_set: MongoDB):
     replica_set.assert_reaches_phase(Phase.Running, timeout=400)
 
 
+@mark.e2e_replica_set_agent_flags_and_readinessProbe
+def test_second_replica_set(second_replica_set: MongoDB):
+    second_replica_set.assert_reaches_phase(Phase.Running, timeout=400)
+
+
 @mark.e2e_replica_set_agent_flags_and_readinessProbe
 def test_log_types_with_default_automation_log_file(replica_set: MongoDB):
     assert_pod_log_types(replica_set, get_all_default_log_types())
@@ -40,6 +97,10 @@ def test_set_custom_log_file(replica_set: MongoDB):
     replica_set["spec"]["agent"] = {
         "startupOptions": {
             "logFile": custom_agent_log_path,
+            "maxLogFileSize": "10485760",
+            "maxLogFiles": "5",
+            "maxLogFileDurationHrs": "16",
+            "logFile": "/var/log/mongodb-mms-automation/customLogFile",
         }
     }
     replica_set["spec"]["agent"].setdefault("readinessProbe", {})
@@ -101,7 +162,7 @@ def test_enable_audit_log(replica_set: MongoDB):
     replica_set["spec"]["additionalMongodConfig"] = additional_mongod_config
     create_or_update(replica_set)
 
-    replica_set.assert_reaches_phase(Phase.Running, timeout=400)
+    replica_set.assert_reaches_phase(Phase.Running, timeout=600)
 
 
 @mark.e2e_replica_set_agent_flags_and_readinessProbe