Merge pull request #78 from galletti94/master

Adding categories check

Author: kevinrizza

operatorcourier/validate.py

@@ -409,6 +409,23 @@ def get_alm_kinds(alm_examples):
         def is_mediatype(mediatype):
             return mediatype in ["image/gif", "image/jpeg", "image/png", "image/svg+xml"]
 
+        def is_category(category):
+            valid_categories = [
+                "AI/Machine Learning",
+                "Big Data",
+                "Cloud Provider",
+                "Database",
+                "Integration & Delivery",
+                "Logging & Tracing",
+                "Monitoring",
+                "Networking",
+                "OpenShift Optional",
+                "Security",
+                "Storage",
+                "Streaming & Messaging"
+            ]
+            return category in valid_categories
+
         valid = True
 
         spec = csv["spec"]
@@ -518,4 +535,15 @@ def is_mediatype(mediatype):
                 self._log_error("spec.icon should be a list")
                 valid = False
 
+        # categories check
+        if "categories" in annotations:
+            categories = annotations["categories"].split(',')
+            for category in categories:
+                if not is_category(category.lstrip()):
+                    self._log_error(
+                        "category %s is not a valid category",
+                        category.lstrip()
+                    )
+                    valid = False
+
         return valid

tests/test_files/bundles/verification/multiplepkgs.invalid.bundle.yaml

@@ -42,7 +42,6 @@ data:
                 }
 
             ]
-          categories: openshift required
           certified: 'true'
           containerImage: quay.io/openshift/origin-operator-marketplace:latest
           createdAt: 2019/11/15

tests/test_files/bundles/verification/nocrd.valid.bundle.yaml

@@ -9,7 +9,7 @@ data:
         name: svcat.v0.1.34
         namespace: placeholder
         annotations:
-          categories: "openshift optional, service catalog, osb, osbapi, broker, svcat"
+          categories: "OpenShift Optional"
           certified: "false"
           description: Service Catalog lets you provision cloud services directly from the comfort of native Kubernetes tooling. This project is in incubation to bring integration with service brokers to the Kubernetes ecosystem via the Open Service Broker API.
           containerImage: quay.io/openshift/origin-service-catalog

tests/test_files/bundles/verification/noicon.valid.bundle.yaml

@@ -39,7 +39,6 @@ data:
                 }
               
             ]
-          categories: openshift required
           certified: 'true'
           containerImage: quay.io/openshift/origin-operator-marketplace:latest
           createdAt: 2019/11/15

tests/test_files/bundles/verification/nopkg.invalid.bundle.yaml

@@ -5,7 +5,6 @@ data:
       metadata:
         annotations:
           alm-examples: '[{"apiVersion":"etcd.database.coreos.com/v1beta2","kind":"EtcdCluster","metadata":{"name":"example","namespace":"default"},"spec":{"size":3,"version":"3.2.13"}},{"apiVersion":"etcd.database.coreos.com/v1beta2","kind":"EtcdRestore","metadata":{"name":"example-etcd-cluster"},"spec":{"etcdCluster":{"name":"example-etcd-cluster"},"backupStorageType":"S3","s3":{"path":"<full-s3-path>","awsSecret":"<aws-secret>"}}},{"apiVersion":"etcd.database.coreos.com/v1beta2","kind":"EtcdBackup","metadata":{"name":"example-etcd-cluster-backup"},"spec":{"etcdEndpoints":["<etcd-cluster-endpoints>"],"storageType":"S3","s3":{"path":"<full-s3-path>","awsSecret":"<aws-secret>"}}}]'
-          categories: openshift required
           certified: 'true'
           containerImage: quay.io/openshift/origin-operator-marketplace:latest
           createdAt: 2019/11/15

tests/test_files/bundles/verification/ui.invalid.bundle.yaml

@@ -39,12 +39,12 @@ data:
                 }
               
             ]
-          categories: openshift required
+          categories: invalid
           certified: 'true'
           containerImage: quay.io/openshift/origin-operator-marketplace:latest
           createdAt: 2019/11/15
           description: An operator to run the OpenShift marketplace
-          capabilities: Basic Install
+          capabilities: invalid
           repository: https://github.com/operator-framework/operator-marketplace
           support: Red Hat
         name: marketplace-operator.v0.0.1

tests/test_files/bundles/verification/valid.bundle.yaml

@@ -39,7 +39,7 @@ data:
                 }
               
             ]
-          categories: openshift required
+          categories: "Storage, Integration & Delivery"
           certified: 'true'
           containerImage: quay.io/openshift/origin-operator-marketplace:latest
           createdAt: 2019/11/15

tests/test_validate.py

@@ -7,10 +7,13 @@
 
 @pytest.mark.parametrize('bundle,expected_validation_results_dict', [
     ("tests/test_files/bundles/verification/noicon.valid.bundle.yaml",
-        {'errors': [], 'warnings': ['csv spec.icon not defined']}),
+        {'errors': [], 'warnings': [
+            'csv metadata.annotations.categories not defined',
+            'csv spec.icon not defined']}),
     ("tests/test_files/bundles/verification/nocrd.valid.bundle.yaml",
-        {'errors': [], 'warnings': ['csv spec.icon not defined',
-         'csv spec.maturity not defined']}),
+        {'errors': [], 'warnings': [
+            'csv spec.icon not defined',
+            'csv spec.maturity not defined']}),
 ])
 def test_valid_bundles(bundle, expected_validation_results_dict):
     valid, validation_results_dict = get_validation_results(bundle)
@@ -21,7 +24,9 @@ def test_valid_bundles(bundle, expected_validation_results_dict):
 @pytest.mark.parametrize('bundle,expected_validation_results_dict', [
     ("tests/test_files/bundles/verification/nopkg.invalid.bundle.yaml",
         {'errors': ['Bundle does not contain any packages.'],
-            'warnings': ['csv spec.icon not defined']}),
+            'warnings': [
+                'csv metadata.annotations.categories not defined',
+                'csv spec.icon not defined']}),
     ("tests/test_files/bundles/verification/no-data-key.bundle.yaml",
         {'errors': ['Bundle does not contain any clusterServiceVersions.',
                     'Bundle does not contain any packages.'], 'warnings': []}),
@@ -47,9 +52,12 @@ def test_ui_valid_bundle_io(bundle, expected_validation_results_dict):
                 "csv.spec.links must be a list of name & url pairs.",
                 "spec.version invalid is not a valid version "
                 "(example of a valid version is: v1.0.12)",
+                "metadata.annotations.capabilities invalid "
+                "is not a valid capabilities level",
                 "spec.icon[0].mediatype image/invalid is not "
                 "a valid mediatype. It must be one of \"image/gif\", "
                 "\"image/jpeg\", \"image/png\", \"image/svg+xml\"",
+                "category invalid is not a valid category",
                 "UI validation failed to verify that required fields "
                 "for operatorhub.io are properly formatted."
                 ],