CLOUDP-297952 - automatically determine minimum operator version for agent matrix builds (#4107)

# Summary

This PR automates calculating the last 3 supported operator versions
that are used for agent matrix builds. Previously this had to be updated
manually during every release.

Additionally fixed possible issue with python `sorted` method. It does
not sort properly version strings as it is using lexicographical order
i.e. version `1.300.0` would be lower than `1.31.0`.

## Proof of Work

Added new test file that is passing
[scripts/evergreen/release/agent_matrix_test.py](https://github.com/10gen/ops-manager-kubernetes/blob/58f8f08ad26e55561b0af37c372bedd208962518/scripts/evergreen/release/agent_matrix_test.py)

## Tasks after merge

- [ ] Update release guide and remove manual step for bumping supported
agent version in code

## Checklist
- [x] Have you linked a jira ticket and/or is the ticket in the title?
- [x] Have you checked whether your jira ticket required DOCSP changes?
- [x] Have you checked for release_note changes?

## Reminder (Please remove this when merging)
- Please try to Approve or Reject Changes the PR, keep PRs in review as
short as possible
- Our Short Guide for PRs:
[Link](REDACTED)
- Remember the following Communication Standards - use comment prefixes
for clarity:
  * **blocking**: Must be addressed before approval.
  * **follow-up**: Can be addressed in a later PR or ticket.
  * **q**: Clarifying question.
  * **nit**: Non-blocking suggestions.
  * **note**: Side-note, non-actionable. Example: Praise
  * --> no prefix is considered a question

Author: MaciejKaras

Makefile

@@ -259,6 +259,7 @@ sbom-tests:
 python-tests:
 	@ scripts/evergreen/run_python.sh -m pytest pipeline_test.py
 	@ scripts/evergreen/run_python.sh -m pytest lib/sonar
+	@ scripts/evergreen/run_python.sh -m pytest scripts/evergreen/release/agent_matrix_test.py
 	@ scripts/evergreen/run_python.sh -m pytest docker/mongodb-enterprise-tests/kubeobject
 
 generate-ssdlc-report:

generate_ssdlc_report.py

@@ -27,6 +27,7 @@
 
 from lib.base_logger import logger
 from scripts.evergreen.release.agent_matrix import (
+    LATEST_OPERATOR_VERSION,
     get_supported_version_for_image_matrix_handling,
 )
 
@@ -92,7 +93,7 @@ def get_supported_images(release: Dict) -> dict[str, SupportedImage]:
     supported_images = filter_out_unsupported_images(supported_images)
     supported_images = convert_to_image_names(supported_images)
     supported_images["mongodb-agent-ubi"] = SupportedImage(
-        get_supported_version_for_image_matrix_handling("mongodb-agent", latest_operator_only=True),
+        get_supported_version_for_image_matrix_handling("mongodb-agent", LATEST_OPERATOR_VERSION),
         "mongodb-agent-ubi",
         "quay.io/mongodb/mongodb-agent-ubi",
         release["supportedImages"]["mongodb-agent"]["ssdlc_name"],

scripts/evergreen/release/agent_matrix.py

@@ -1,6 +1,9 @@
 import json
 from typing import Dict, List
 
+DEFAULT_SUPPORTED_OPERATOR_VERSIONS = 3
+LATEST_OPERATOR_VERSION = 1
+
 
 def get_release() -> Dict[str, str]:
     return json.load(open("release.json"))
@@ -17,14 +20,15 @@ def build_agent_gather_versions(release: Dict[str, str]):
     return agent_versions_to_be_build
 
 
-def get_supported_version_for_image_matrix_handling(image: str, latest_operator_only: bool = False) -> List[str]:
+def get_supported_version_for_image_matrix_handling(
+    image: str, supported_versions: int = DEFAULT_SUPPORTED_OPERATOR_VERSIONS
+) -> List[str]:
     # if we are a certifying mongodb-agent, we will need to also certify the
     # static container images which are a matrix of <agent_version>_<operator_version>
     if image == "mongodb-agent":
         # officially, we start the support with 1.25.0, but we only support the last three versions
-        last_supported_operator_versions = get_supported_operator_versions()
-        if latest_operator_only:
-            last_supported_operator_versions = [last_supported_operator_versions[-1]]
+        last_supported_operator_versions = get_supported_operator_versions(supported_versions)
+
         agent_version_with_static_support_without_operator_suffix = build_agent_gather_versions(get_release())
         agent_version_with_static_support_with_operator_suffix = list()
         for agent in agent_version_with_static_support_without_operator_suffix:
@@ -45,12 +49,11 @@ def get_supported_version_for_image_matrix_handling(image: str, latest_operator_
     return sorted(get_release()["supportedImages"][image]["versions"])
 
 
-def get_supported_operator_versions():
-    min_supported_version_operator_for_static = "1.29.0"
-    last_supported_operator_versions = [
-        v
-        for v in get_release()["supportedImages"]["operator"]["versions"]
-        if v >= min_supported_version_operator_for_static
-    ]
+def get_supported_operator_versions(supported_versions: int = DEFAULT_SUPPORTED_OPERATOR_VERSIONS):
+    operator_versions = list(get_release()["supportedImages"]["operator"]["versions"])
+    operator_versions.sort(key=lambda s: list(map(int, s.split("."))))
+
+    if len(operator_versions) <= supported_versions:
+        return operator_versions
 
-    return sorted(last_supported_operator_versions)
+    return operator_versions[-supported_versions:]

scripts/evergreen/release/agent_matrix_test.py

@@ -0,0 +1,58 @@
+from unittest import mock
+
+from scripts.evergreen.release.agent_matrix import get_supported_operator_versions
+
+empty_release = {"supportedImages": {"operator": {"versions": []}}}
+
+
+@mock.patch("scripts.evergreen.release.agent_matrix.get_release", return_value=empty_release)
+def test_get_supported_operator_versions_empty(_):
+    supported_versions = get_supported_operator_versions()
+    assert len(supported_versions) == 0
+
+
+single_release = {"supportedImages": {"operator": {"versions": ["1.30.0"]}}}
+
+
+@mock.patch("scripts.evergreen.release.agent_matrix.get_release", return_value=single_release)
+def test_get_supported_operator_versions_single_release(_):
+    supported_versions = get_supported_operator_versions()
+    assert len(supported_versions) == 1
+    assert supported_versions[0] == "1.30.0"
+
+
+three_releases_not_ordered = {"supportedImages": {"operator": {"versions": ["1.30.0", "1.28.0", "2.0.2"]}}}
+
+
+@mock.patch("scripts.evergreen.release.agent_matrix.get_release", return_value=three_releases_not_ordered)
+def test_get_supported_operator_versions_three_releases_not_ordered(_):
+    supported_versions = get_supported_operator_versions()
+    assert len(supported_versions) == 3
+    assert supported_versions == ["1.28.0", "1.30.0", "2.0.2"]
+
+
+many_releases_not_ordered = {
+    "supportedImages": {
+        "operator": {
+            "versions": [
+                "1.32.0",
+                "1.25.0",
+                "1.26.0",
+                "1.27.1",
+                "1.27.0",
+                "1.30.0",
+                "1.300.0",
+                "1.28.123",
+                "0.0.1",
+                "2.0.2",
+            ]
+        }
+    }
+}
+
+
+@mock.patch("scripts.evergreen.release.agent_matrix.get_release", return_value=many_releases_not_ordered)
+def test_get_supported_operator_versions_many_releases_not_ordered(_):
+    supported_versions = get_supported_operator_versions()
+    assert len(supported_versions) == 3
+    assert supported_versions == ["1.32.0", "1.300.0", "2.0.2"]

scripts/update_supported_dockerfiles.py

@@ -41,15 +41,15 @@ def get_release() -> Dict[str, str]:
     return json.load(open("release.json"))
 
 
-def get_supported_variants_for_image(image: str) -> List[Dict[str, str]]:
+def get_supported_variants_for_image(image: str) -> List[str]:
     splitted_image_name = image.split("mongodb-enterprise-", 1)
     if len(splitted_image_name) == 2:
         image = splitted_image_name[1]
 
     return get_release()["supportedImages"][image]["variants"]
 
 
-def get_supported_version_for_image(image: str) -> List[Dict[str, str]]:
+def get_supported_version_for_image(image: str) -> List[str]:
     splitted_image_name = image.split("mongodb-enterprise-", 1)
     if len(splitted_image_name) == 2:
         image = splitted_image_name[1]