[ISV-5073] Support OCP v4.17 (#691)

mporrato · web-flow · commit c36d76182441 · 2024-07-18T14:26:39.000+01:00
* [ISV-5073] Support OCP v4.17

- Add ocp to k8s version mapping for 4.17
- Avoid failures from `check_osdk_bundle_validate_*()` checks when the
  ocp version is missing from the mapping
- Avoid failures from check_api_version_constraints() check when the ocp version is missing from the mapping

---------

Signed-off-by: Maurizio Porrato &lt;mporrato@redhat.com&gt;
diff --git a/operator-pipeline-images/operatorcert/static_tests/community/bundle.py b/operator-pipeline-images/operatorcert/static_tests/community/bundle.py
@@ -6,6 +6,7 @@
     (either Fail or Warn) to describe the issues found in the given Bundle.
 """
 
+from bisect import bisect
 import json
 import logging
 import re
@@ -33,9 +34,24 @@
 
 LOGGER = logging.getLogger("operator-cert")
 
+
+def _parse_semver(version: str) -> Version:
+    return Version.parse(version.strip(), optional_minor_and_patch=True).replace(
+        prerelease=None, build=None
+    )
+
+
+def _parse_ocp_version(version: str) -> Version:
+    return _parse_semver(version.strip().removeprefix("v")).replace(patch=0)
+
+
 # convert table for OCP <-> k8s versions
 # for now these are hardcoded pairs -> if new version of OCP:k8s is released,
 # this table should be updated
+# This is documented at https://access.redhat.com/solutions/4870701
+# When adding an upcoming release the document above won't include the new
+# version: to find the corresponding k8s version look at
+# https://github.com/openshift/kubernetes/blob/release-4.YY/CHANGELOG/README.md
 OCP_TO_K8S = {
     "4.1": "1.13",
     "4.2": "1.14",
@@ -53,29 +69,47 @@
     "4.14": "1.27",
     "4.15": "1.28",
     "4.16": "1.29",
+    "4.17": "1.30",
 }
 
+OCP_TO_K8S_SEMVER = {
+    _parse_ocp_version(ocp_ver): _parse_semver(k8s_ver)
+    for ocp_ver, k8s_ver in OCP_TO_K8S.items()
+}
 
-class GraphLoopException(Exception):
+
+def find_closest_ocp_version(ocp_ver: Version) -> Version:
     """
-    Exception raised when a loop is detected in the update graph
+    Find the closest openshift version between all known versions
     """
+    all_ocp_versions = sorted(OCP_TO_K8S_SEMVER.keys())
+    pos = bisect(all_ocp_versions, ocp_ver)
+    if pos == 0:
+        return all_ocp_versions[0]
+    return all_ocp_versions[pos - 1]
 
 
-def _parse_semver(version: str) -> Version:
-    return Version.parse(version.strip(), optional_minor_and_patch=True).replace(
-        prerelease=None, build=None
-    )
-
-
-def _parse_ocp_version(version: str) -> Version:
-    return _parse_semver(version.strip().removeprefix("v")).replace(patch=0)
+def ocp_to_k8s_ver(ocp_ver: str) -> str:
+    """
+    Lookup the corresponding k8s version for an openshift version
+    """
+    try:
+        return OCP_TO_K8S[ocp_ver]
+    except KeyError:
+        closest_ocp = find_closest_ocp_version(_parse_ocp_version(ocp_ver))
+        LOGGER.warning(
+            "Using openshift version %s in place of unknown openshift version %s",
+            closest_ocp,
+            ocp_ver,
+        )
+        k8s = OCP_TO_K8S_SEMVER[closest_ocp]
+        return f"{k8s.major}.{k8s.minor}"
 
 
-OCP_TO_K8S_SEMVER = {
-    _parse_ocp_version(ocp_ver): _parse_semver(k8s_ver)
-    for ocp_ver, k8s_ver in OCP_TO_K8S.items()
-}
+class GraphLoopException(Exception):
+    """
+    Exception raised when a loop is detected in the update graph
+    """
 
 
 def run_operator_sdk_bundle_validate(
@@ -87,40 +121,34 @@ def run_operator_sdk_bundle_validate(
     ocp_versions = utils.get_ocp_supported_versions(
         "community-operators", ocp_annotation
     )
-    ocp_latest_version = ocp_versions[0] if ocp_versions else None
-
-    kube_version_for_deprecation_test = OCP_TO_K8S.get(ocp_latest_version)
-
-    if kube_version_for_deprecation_test is None:
-        LOGGER.info(
-            "There was no OCP version specified. API deprecation test for the testing "
-            "suite - %s - was run with 'None' value.",
+    if ocp_versions:
+        ocp_latest_version = ocp_versions[0]
+
+        kube_version_for_deprecation_test = ocp_to_k8s_ver(ocp_latest_version)
+
+        cmd = [
+            "operator-sdk",
+            "bundle",
+            "validate",
+            "-o",
+            "json-alpha1",
+            bundle.root,
+            "--select-optional",
             test_suite_selector,
+            f"--optional-values=k8s-version={kube_version_for_deprecation_test}",
+        ]
+        sdk_result = json.loads(
+            subprocess.run(
+                cmd, stdout=subprocess.PIPE, stderr=subprocess.DEVNULL, check=False
+            ).stdout
         )
-
-    cmd = [
-        "operator-sdk",
-        "bundle",
-        "validate",
-        "-o",
-        "json-alpha1",
-        bundle.root,
-        "--select-optional",
-        test_suite_selector,
-        f"--optional-values=k8s-version={kube_version_for_deprecation_test}",
-    ]
-    sdk_result = json.loads(
-        subprocess.run(
-            cmd, stdout=subprocess.PIPE, stderr=subprocess.DEVNULL, check=False
-        ).stdout
-    )
-    for output in sdk_result.get("outputs") or []:
-        output_type = output.get("type")
-        output_message = output.get("message", "")
-        if output_type == "error":
-            yield Fail(output_message)
-        else:
-            yield Warn(output_message)
+        for output in sdk_result.get("outputs") or []:
+            output_type = output.get("type")
+            output_message = output.get("message", "")
+            if output_type == "error":
+                yield Fail(output_message)
+            else:
+                yield Warn(output_message)
 
 
 def check_osdk_bundle_validate_operatorhub(bundle: Bundle) -> Iterator[CheckResult]:
@@ -260,14 +288,9 @@ def check_api_version_constraints(bundle: Bundle) -> Iterator[CheckResult]:
                 # com.redhat.openshift.versions contains a single version
                 if selector.startswith("="):
                     # Select a specific version
-                    version = _parse_ocp_version(selector.removeprefix("="))
-                    if version not in OCP_TO_K8S_SEMVER:
-                        yield Fail(
-                            "Unknown OCP version in "
-                            "com.redhat.openshift.versions: "
-                            f"{version.major}.{version.minor}"
-                        )
-                        return
+                    version = find_closest_ocp_version(
+                        _parse_ocp_version(selector.removeprefix("="))
+                    )
                     ocp_versions = {version}
                 else:
                     # Any version >= the specified value
diff --git a/operator-pipeline-images/tests/static_tests/community/test_bundle.py b/operator-pipeline-images/tests/static_tests/community/test_bundle.py
@@ -15,50 +15,94 @@
     check_api_version_constraints,
     check_replaces_availability,
     check_upgrade_graph_loop,
+    ocp_to_k8s_ver,
 )
+from semver import Version
 from tests.utils import bundle_files, create_files, merge
 
 
-@pytest.mark.parametrize("version", ["4.8-4.9", ["4.9", "4.8"], None])
 @pytest.mark.parametrize(
-    "osdk_output, expected",
+    "osdk_output, ocp_versions, expected",
     [
         (
             '{"passed": false, "outputs":'
             '[{"type": "error", "message": "foo"}, {"type": "warning", "message": "bar"}]}',
+            ["4.9", "4.8"],
             {Fail("foo"), Warn("bar")},
         ),
+        (
+            '{"passed": false, "outputs":'
+            '[{"type": "error", "message": "foo"}, {"type": "warning", "message": "bar"}]}',
+            None,
+            set(),
+        ),
         (
             '{"passed": true, "outputs": null}',
+            ["4.9", "4.8"],
             set(),
         ),
     ],
     indirect=False,
     ids=[
-        "A warning and an error",
-        "No warnings or errors",
+        "A warning and an error from operator-sdk",
+        "No matching ocp versions",
+        "No warnings or errors from operator-sdk",
     ],
 )
 @patch("operatorcert.static_tests.community.bundle.utils.get_ocp_supported_versions")
 @patch("subprocess.run")
 def test_run_operator_sdk_bundle_validate(
     mock_run: MagicMock,
     mock_version: MagicMock,
-    version: Any,
     osdk_output: str,
+    ocp_versions: Optional[list[str]],
     expected: set[CheckResult],
     tmp_path: Path,
 ) -> None:
     create_files(tmp_path, bundle_files("test-operator", "0.0.1"))
     repo = Repo(tmp_path)
     bundle = repo.operator("test-operator").bundle("0.0.1")
-    mock_version.return_value = version
+    mock_version.return_value = ocp_versions
     process_mock = MagicMock()
     process_mock.stdout = osdk_output
     mock_run.return_value = process_mock
     assert set(run_operator_sdk_bundle_validate(bundle, "")) == expected
 
 
+@pytest.mark.parametrize(
+    "ocp_ver, expected",
+    [
+        pytest.param("4.2", "1.14", id="Known ocp_ver"),
+        pytest.param("4.0", "1.13", id="Old ocp_ver"),
+        pytest.param("4.4", "1.16", id="New ocp_ver"),
+    ],
+)
+def test_ocp_to_k8s_ver(
+    monkeypatch: pytest.MonkeyPatch, ocp_ver: str, expected: str
+) -> None:
+    # prevent the test from breaking when the OCP_TO_K8S mapping
+    # is updated
+    test_ver_map = {
+        "4.1": "1.13",
+        "4.2": "1.14",
+        "4.3": "1.16",
+    }
+    test_ver_map_semver = {
+        Version.parse(k, optional_minor_and_patch=True): Version.parse(
+            v, optional_minor_and_patch=True
+        )
+        for k, v in test_ver_map.items()
+    }
+    monkeypatch.setattr(
+        "operatorcert.static_tests.community.bundle.OCP_TO_K8S", test_ver_map
+    )
+    monkeypatch.setattr(
+        "operatorcert.static_tests.community.bundle.OCP_TO_K8S_SEMVER",
+        test_ver_map_semver,
+    )
+    assert ocp_to_k8s_ver(ocp_ver) == expected
+
+
 @patch("operatorcert.static_tests.community.bundle.run_operator_sdk_bundle_validate")
 def test_check_osdk_bundle_validate_operator_framework(mock_sdk: MagicMock) -> None:
     bundle = MagicMock()
@@ -381,7 +425,7 @@ def test_check_dangling_bundles(tmp_path: Path) -> None:
         pytest.param(
             {"spec": {"minKubeVersion": "1.0.0"}},
             {"com.redhat.openshift.versions": "=v3.1"},
-            {Fail("Unknown OCP version in com.redhat.openshift.versions: 3.1")},
+            set(),
             id='Valid minKubeVersion, unknown com.redhat.openshift.versions ("=")',
         ),
         pytest.param(
