[ISV-2659] operator_name check in hosted pipeline (#401)

added a check for whether the project has a different name already reserved for given association

Author: mantomas

ansible/roles/operator-pipeline/templates/openshift/tasks/reserve-operator-name.yml

@@ -7,7 +7,7 @@ spec:
   params:
     - name: pipeline_image
     - name: association
-      description: The assocation that the operator belongs in, usually the isv_pid.
+      description: The association that the operator belongs in, usually the isv_pid.
     - name: operator_name
       description: The operator name to be reserved.
     - name: source
@@ -46,7 +46,7 @@ spec:
         #! /usr/bin/env bash
         set -xe
 
-        echo "Attempting to reserve operator name for assocation $ASSOCIATION"
+        echo "Attempting to reserve operator name for association $ASSOCIATION"
 
         reserve-operator-name \
           --association $ASSOCIATION \

operator-pipeline-images/operatorcert/entrypoints/reserve_operator_name.py

@@ -1,6 +1,7 @@
 import argparse
 import logging
 import sys
+from typing import Any
 from urllib.parse import urljoin
 
 from operatorcert import pyxis
@@ -32,7 +33,49 @@ def setup_argparser() -> argparse.ArgumentParser:  # pragma: no cover
     return parser
 
 
-def check_operator_name(args) -> None:
+def check_operator_name_registered_for_association(args: Any) -> None:
+    """
+    Check if for given association/isv_pid operatorPackage already exist
+    and validates that the package name match operator name requested.
+    """
+    rsp = pyxis.get(
+        urljoin(
+            args.pyxis_url,
+            f"v1/operators/packages?filter=association=={args.association}",
+        )
+    )
+
+    rsp.raise_for_status()
+
+    packages = rsp.json().get("data")
+
+    if packages:
+        # there should only be 1 package for given association/isv_pid
+        package = packages[0]
+        if package["package_name"] != args.operator_name:
+            LOGGER.error(
+                f"Requested operator name {args.operator_name} "
+                f"does not match operator name {package['package_name']} "
+                f"already reserved for certification project."
+            )
+            sys.exit(1)
+        else:
+            LOGGER.info(
+                f"Requested operator name {args.operator_name} match "
+                f"with operator name already reserved."
+            )
+    else:
+        LOGGER.info(
+            f"There isn't any operator name registered for project "
+            f"with association/isv_pid {args.association}."
+        )
+
+
+def check_operator_name(args: Any) -> None:
+    """
+    Check if operator name already exist and if yes,
+    validates if it match with the operator name requested.
+    """
     rsp = pyxis.get(
         urljoin(
             args.pyxis_url,
@@ -63,7 +106,11 @@ def check_operator_name(args) -> None:
         LOGGER.info(f"Operator name {args.operator_name} is available.")
 
 
-def reserve_operator_name(args) -> None:
+def reserve_operator_name(args: Any) -> None:
+    """
+    Reserve operator name for given combination
+    of association and operator name
+    """
     post_data = {
         "association": args.association,
         "package_name": args.operator_name,
@@ -80,7 +127,7 @@ def reserve_operator_name(args) -> None:
     )
 
 
-def main() -> None:  # pragma: no cover
+def main() -> None:
     parser = setup_argparser()
     args = parser.parse_args()
 
@@ -89,6 +136,7 @@ def main() -> None:  # pragma: no cover
         log_level = "DEBUG"
     setup_logger(level=log_level)
 
+    check_operator_name_registered_for_association(args)
     check_operator_name(args)
     reserve_operator_name(args)
 

operator-pipeline-images/tests/entrypoints/test_reserve_operator_name.py

@@ -6,15 +6,90 @@
 
 @patch("operatorcert.entrypoints.reserve_operator_name.setup_argparser")
 @patch("operatorcert.entrypoints.reserve_operator_name.reserve_operator_name")
+@patch(
+    "operatorcert.entrypoints.reserve_operator_name.check_operator_name_registered_for_association"
+)
 @patch("operatorcert.entrypoints.reserve_operator_name.check_operator_name")
 def test_main(
-    mock_check: MagicMock, mock_reserve: MagicMock, mock_arg_parser: MagicMock
+    mock_check: MagicMock,
+    mock_check_association: MagicMock,
+    mock_reserve: MagicMock,
+    mock_arg_parser: MagicMock,
 ) -> None:
     reserve_operator_name.main()
+    mock_check_association.assert_called_once()
     mock_check.assert_called_once()
     mock_reserve.assert_called_once()
 
 
+@patch("sys.exit")
+@patch("operatorcert.entrypoints.reserve_operator_name.pyxis.get")
+def test_check_operator_name_registered_for_association_same_name(
+    mock_get: MagicMock, mock_exit: MagicMock
+) -> None:
+    args = MagicMock()
+    args.pyxis_url = "http://foo.com/"
+    args.key_path = "key.path"
+    args.association = "ospid-123"
+    args.operator_name = "operator-equal"
+
+    mock_get.status_code = 200
+    mock_get.return_value.json.return_value = {
+        "data": [
+            {
+                "association": "ospid-123",
+                "package_name": "operator-equal",
+            }
+        ]
+    }
+
+    reserve_operator_name.check_operator_name_registered_for_association(args)
+    mock_exit.assert_not_called()
+
+
+@patch("sys.exit")
+@patch("operatorcert.entrypoints.reserve_operator_name.pyxis.get")
+def test_check_operator_name_registered_for_association_name_different(
+    mock_get: MagicMock, mock_exit: MagicMock
+) -> None:
+    args = MagicMock()
+    args.pyxis_url = "http://foo.com/"
+    args.key_path = "key.path"
+    args.association = "ospid-123"
+    args.operator_name = "operator-x"
+
+    mock_get.status_code = 200
+    mock_get.return_value.json.return_value = {
+        "data": [
+            {
+                "association": "ospid-123",
+                "package_name": "operator-y",
+            }
+        ]
+    }
+
+    reserve_operator_name.check_operator_name_registered_for_association(args)
+    mock_exit.assert_called_once_with(1)
+
+
+@patch("sys.exit")
+@patch("operatorcert.entrypoints.reserve_operator_name.pyxis.get")
+def test_check_operator_name_registered_for_association_not_registered(
+    mock_get: MagicMock, mock_exit: MagicMock
+) -> None:
+    args = MagicMock()
+    args.pyxis_url = "http://foo.com/"
+    args.key_path = "key.path"
+    args.association = "ospid-123"
+    args.operator_name = "operator-available"
+
+    mock_get.return_value.status_code = 404
+    mock_get.return_value.json.return_value = {}
+
+    reserve_operator_name.check_operator_name_registered_for_association(args)
+    mock_exit.assert_not_called()
+
+
 @patch("sys.exit")
 @patch("operatorcert.entrypoints.reserve_operator_name.pyxis.get")
 def test_check_operator_name_taken(mock_get: MagicMock, mock_exit: MagicMock) -> None: