[ISV-1280] Add developer flag to enable/disable the query-publishing-checklist task (#190)

* [ISV-1280] Add developer flag to enable/disable the query-publishing-checklist task

* Update the flag name and add test case

* Update the flag name and add test case

* Update the flag name and add test case

* Update the flag name and add test case

* Fix up the yaml format

* Add the description in README file

* Add the description in README file

* Add the description in README file

* Add the description in README file

* Remove unused code

Co-authored-by: haripate <>

Author: haripate

README.md

@@ -127,7 +127,13 @@ tkn pipeline start operator-hosted-pipeline \
   --showlog
 ```
 
-> :warning: Only quay-based registries are supported by the hosted pipeline.
+To ignore the results of the publishing checklist, pass the following argument:
+
+```bash
+  --param ignore_publishing_checklist=true
+```
+
+:warning: Only quay-based registries are supported by the hosted pipeline.
 There are some quay specific tasks for configuring the repositories where
 the bundle and index images are pushed.
 

ansible/roles/operator-pipeline/templates/openshift/pipelines/operator-hosted-pipeline.yml

@@ -41,6 +41,9 @@ spec:
       default: quay-oauth-token
     - name: quay_oauth_secret_key
       default: token
+    - name: ignore_publishing_checklist
+      default: "false"
+      description: Ignore the results of the publishing checklist
   workspaces:
     - name: repository
     - name: results
@@ -766,6 +769,8 @@ spec:
           value: "$(tasks.certification-project-check.results.certification_project_id)"
         - name: connect_url
           value: "$(tasks.set-env.results.connect_url)"
+        - name: ignore_publishing_checklist
+          value: "$(params.ignore_publishing_checklist)"
       workspaces:
         - name: hydra-credentials
           workspace: hydra-credentials

ansible/roles/operator-pipeline/templates/openshift/tasks/query-publishing-checklist.yml

@@ -10,6 +10,9 @@ spec:
       description: ID of the bundle Certification Project
     - name: connect_url
       description: URL to Red Hat Connect
+    - name: ignore_publishing_checklist
+      default: "false"
+      description: Ignore the results of the publishing checklist
   workspaces:
     - name: hydra-credentials
   steps:
@@ -32,4 +35,5 @@ spec:
 
         hydra-checklist \
           --cert-project-id "$(params.cert_project_id)" \
-          --hydra-url $HYDRA_URL
+          --hydra-url $HYDRA_URL \
+          --ignore-publishing-checklist "$(params.ignore_publishing_checklist)"

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

@@ -25,11 +25,18 @@ def setup_argparser() -> Any:  # pragma: no cover
         default="https://connect.redhat.com/hydra/prm",
         help="URL to the Hydra API",
     )
+    parser.add_argument(
+        "--ignore-publishing-checklist",
+        default="false",
+        help="Ignore the results of the publishing checklist",
+    )
     parser.add_argument("--verbose", action="store_true", help="Verbose output")
     return parser
 
 
-def check_hydra_checklist_status(cert_project_id: str, hydra_url: str) -> Any:
+def check_hydra_checklist_status(
+    cert_project_id: str, hydra_url: str, ignore_publishing_checklist: bool
+) -> Any:
     # query hydra checklist API
     # Not using urljoin because for some reason it will eat up the prm at the end if
     # url doesn't end with a /
@@ -59,6 +66,8 @@ def check_hydra_checklist_status(cert_project_id: str, hydra_url: str) -> Any:
             f"Pre-certification checklist is not completed for cert project with id "
             f"{cert_project_id}."
         )
+        if ignore_publishing_checklist:
+            return
         sys.exit(1)
 
 
@@ -74,7 +83,9 @@ def main() -> None:
         log_level = "DEBUG"
     logging.basicConfig(level=log_level)
 
-    check_hydra_checklist_status(args.cert_project_id, args.hydra_url)
+    check_hydra_checklist_status(
+        args.cert_project_id, args.hydra_url, args.ignore_publishing_checklist == "true"
+    )
 
 
 if __name__ == "__main__":  # pragma: no cover

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

@@ -13,7 +13,7 @@ def test_main(mock_check: MagicMock, mock_arg_parser: MagicMock) -> None:
 @patch("operatorcert.entrypoints.hydra_checklist.hydra.get")
 def test_check_hydra_checklist_status_overall_completed(mock_get: MagicMock) -> None:
     mock_get.return_value = {"completed": True}
-    hydra_checklist.check_hydra_checklist_status("foo", "fake-hydra.url")
+    hydra_checklist.check_hydra_checklist_status("foo", "fake-hydra.url", False)
 
 
 @patch("operatorcert.entrypoints.hydra_checklist.hydra.get")
@@ -26,7 +26,7 @@ def test_check_hydra_checklist_status_items_completed(mock_get: MagicMock) -> No
         ],
         "completed": False,
     }
-    hydra_checklist.check_hydra_checklist_status("foo", "fake-hydra.url")
+    hydra_checklist.check_hydra_checklist_status("foo", "fake-hydra.url", False)
 
 
 @patch("sys.exit")
@@ -42,5 +42,16 @@ def test_check_hydra_checklist_status_incomplete(
         ],
         "completed": False,
     }
-    hydra_checklist.check_hydra_checklist_status("foo", "fake-hydra.url")
+    hydra_checklist.check_hydra_checklist_status("foo", "fake-hydra.url", False)
     mock_exit.assert_called_once_with(1)
+
+    # If the developer flag is on
+    mock_get.return_value = {
+        "checklistItems": [
+            {"title": "Test1", "completed": False},
+            {"title": "Test2", "completed": True},
+            {"title": "Test3", "completed": False},
+        ],
+        "completed": False,
+    }
+    hydra_checklist.check_hydra_checklist_status("foo", "fake-hydra.url", True)