[ISV-4497] validate catalog format (#639)

* [ISV-4497] validate catalog format

Signed-off-by: Tomáš Man <[email protected]>


---------

Signed-off-by: Tomáš Man <[email protected]>

Author: mantomas

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

@@ -383,14 +383,38 @@ spec:
           workspace: repository
           subPath: src
 
+    - name: validate-catalog-format
+      taskRef:
+        name: validate-catalog-format
+        kind: Task
+      runAfter:
+        # This is just a temporary location until we have a proper
+        # FCB branch based on config
+        - read-config
+      when:
+        - input: "$(tasks.detect-changes.results.affected_catalogs)"
+          operator: notin
+          values: [""]
+      params:
+        - name: pipeline_image
+          value: "$(params.pipeline_image)"
+        - name: affected_catalogs
+          value: "$(tasks.detect-changes.results.affected_catalogs)"
+        - name: operator_path
+          value: "$(tasks.detect-changes.results.operator_path)"
+      workspaces:
+        - name: source
+          workspace: repository
+          subPath: src
+
     - name: build-fragment-images
       taskRef:
         name: build-fragment-images
         kind: Task
       runAfter:
         # This is just a temporary location until we have a proper
         # FCB branch based on config
-        - read-config
+        - validate-catalog-format
       when:
         - input: "$(tasks.detect-changes.results.affected_catalogs)"
           operator: notin

ansible/roles/operator-pipeline/templates/openshift/tasks/validate-catalog-format.yml

@@ -0,0 +1,29 @@
+---
+apiVersion: tekton.dev/v1
+kind: Task
+metadata:
+  name: validate-catalog-format
+spec:
+  params:
+    - name: pipeline_image
+
+    - name: affected_catalogs
+      description: Comma separated list of updated catalogs.
+
+    - name: operator_path
+      description: Path to the operator.
+
+  workspaces:
+    - name: source
+  steps:
+    - name: validate-catalog-format
+      image: "$(params.pipeline_image)"
+      workingDir: $(workspaces.source.path)
+      script: |
+        #! /usr/bin/env bash
+        set -xe
+
+        validate-catalog-format \
+          --repo-path "$(workspaces.source.path)" \
+          --catalog-names "$(params.affected_catalogs)" \
+          --verbose

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

@@ -0,0 +1,84 @@
+"""Validate catalog format for all given catalogs."""
+
+import argparse
+import logging
+from subprocess import CalledProcessError
+import sys
+
+from operatorcert.logger import setup_logger
+from operatorcert.utils import SplitArgs, run_command
+
+LOGGER = logging.getLogger("operator-cert")
+
+
+def setup_argparser() -> argparse.ArgumentParser:
+    """
+    Setup argument parser
+
+    Returns:
+        argparse.ArgumentParser: Argument parser
+    """
+    parser = argparse.ArgumentParser(
+        description="Validate catalog format for all given catalogs."
+    )
+    parser.add_argument(
+        "--repo-path",
+        default=".",
+        help="Path to the root of the local clone of the repo",
+        required=True,
+    )
+    parser.add_argument(
+        "--catalog-names",
+        default=[],
+        action=SplitArgs,
+        help="List of catalog names to validate",
+    )
+    parser.add_argument("--verbose", action="store_true", help="Verbose output")
+
+    return parser
+
+
+def validate_catalog_format(catalog_path: str, catalog_name: str) -> None:
+    """
+    Run `opm validate` for a given catalog.
+    """
+    cmd = [
+        "opm",
+        "validate",
+        f"{catalog_path}/{catalog_name}",
+    ]
+    LOGGER.info("Validating catalog %s", catalog_name)
+    run_command(cmd)
+
+
+def main() -> None:
+    """
+    Main function of the script
+    """
+    # Args
+    parser = setup_argparser()
+    args = parser.parse_args()
+
+    # Logging
+    log_level = "INFO"
+    if args.verbose:
+        log_level = "DEBUG"
+    setup_logger(level=log_level)
+
+    invalid_catalogs = []
+
+    # For each catalog validate its format
+    for catalog_name in args.catalog_names:
+        catalog_path = f"{args.repo_path}/catalogs"
+        try:
+            validate_catalog_format(catalog_path, catalog_name)
+        except CalledProcessError:
+            LOGGER.error("Catalog %s format is invalid", catalog_name)
+            invalid_catalogs.append(catalog_name)
+
+    if invalid_catalogs:
+        sys.exit(1)
+
+
+if __name__ == "__main__":  # pragma: no cover
+    main()

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

@@ -0,0 +1,63 @@
+import pytest
+
+from unittest.mock import MagicMock, patch, call
+from subprocess import CalledProcessError
+
+import operatorcert.entrypoints.validate_catalog_format as validate_catalog_format
+
+
+@patch("operatorcert.entrypoints.validate_catalog_format.run_command")
+def test_validate_catalog_format(mock_run_command: MagicMock) -> None:
+
+    validate_catalog_format.validate_catalog_format("path/to/catalogs", "catalog1")
+
+    mock_run_command.assert_called_once_with(
+        ["opm", "validate", "path/to/catalogs/catalog1"]
+    )
+
+
+@patch("operatorcert.entrypoints.validate_catalog_format.validate_catalog_format")
+@patch("operatorcert.entrypoints.validate_catalog_format.setup_logger")
+@patch("operatorcert.entrypoints.validate_catalog_format.setup_argparser")
+def test_main(
+    mock_setup_argparser: MagicMock,
+    mock_setup_logger: MagicMock,
+    mock_validate_catalog_format: MagicMock,
+) -> None:
+    args = MagicMock()
+    args.catalog_names = ["catalog1", "catalog2"]
+    args.repo_path = "repo"
+    args.makefile_path = "path/to/repo/Makefile"
+
+    mock_setup_argparser.return_value.parse_args.return_value = args
+
+    validate_catalog_format.main()
+
+    catalogs_path = args.repo_path + "/catalogs"
+
+    mock_validate_catalog_format.assert_has_calls(
+        [call(catalogs_path, "catalog1"), call(catalogs_path, "catalog2")]
+    )
+
+
+@patch("operatorcert.entrypoints.validate_catalog_format.validate_catalog_format")
+@patch("operatorcert.entrypoints.validate_catalog_format.setup_logger")
+@patch("operatorcert.entrypoints.validate_catalog_format.setup_argparser")
+def test_main_invalid_catalog(
+    mock_setup_argparser: MagicMock,
+    mock_setup_logger: MagicMock,
+    mock_validate_catalog_format: MagicMock,
+) -> None:
+    args = MagicMock()
+    args.catalog_names = ["catalog1"]
+    mock_setup_argparser.return_value.parse_args.return_value = args
+
+    mock_validate_catalog_format.side_effect = CalledProcessError(1, "opm validate")
+
+    with pytest.raises(SystemExit) as invalid_catalog:
+        validate_catalog_format.main()
+        assert invalid_catalog.type == SystemExit
+
+
+def test_setup_argparser() -> None:
+    assert validate_catalog_format.setup_argparser() is not None

pyproject.toml

@@ -82,6 +82,7 @@ static-tests = "operatorcert.entrypoints.static_tests:main"
 update-cert-project-status = "operatorcert.entrypoints.update_cert_project_status:main"
 upload-artifacts = "operatorcert.entrypoints.upload_artifacts:main"
 upload-signature = "operatorcert.entrypoints.upload_signature:main"
+validate-catalog-format = "operatorcert.entrypoints.validate_catalog_format:main"
 verify-changed-dirs = "operatorcert.entrypoints.verify_changed_dirs:main"