Merge pull request #95 from gallettilance/operatorhub-icon-fix

gallettilance · web-flow · commit f8c87b647539 · 2021-01-28T16:13:14.000-05:00
fix error on missing icon
diff --git a/pkg/validation/errors/error.go b/pkg/validation/errors/error.go
@@ -243,7 +243,3 @@ func invalidObject(lvl Level, detail string, value interface{}) Error {
 func WarnInvalidObject(detail string, value interface{}) Error {
 	return failedValidation(LevelWarn, detail, value)
 }
-
-func WarnMissingIcon(detail string) Error {
-	return failedValidation(LevelWarn, detail, "")
-}
diff --git a/pkg/validation/internal/operatorhub.go b/pkg/validation/internal/operatorhub.go
@@ -74,16 +74,19 @@ func validateBundleOperatorHub(bundle *manifests.Bundle) errors.ManifestResult {
 		return result
 	}
 
-	errs := validateHubCSVSpec(*bundle.CSV)
+	errs, warns := validateHubCSVSpec(*bundle.CSV)
 	for _, err := range errs {
 		result.Add(errors.ErrInvalidCSV(err.Error(), bundle.CSV.GetName()))
 	}
-
+	for _, warn := range warns {
+		result.Add(errors.WarnInvalidCSV(warn.Error(), bundle.CSV.GetName()))
+	}
 	return result
 }
 
-func validateHubCSVSpec(csv v1alpha1.ClusterServiceVersion) []error {
+func validateHubCSVSpec(csv v1alpha1.ClusterServiceVersion) ([]error, []error) {
 	var errs []error
+	var warns []error
 
 	if csv.Spec.Provider.Name == "" {
 		errs = append(errs, fmt.Errorf("csv.Spec.Provider.Name not specified"))
@@ -146,7 +149,7 @@ func validateHubCSVSpec(csv v1alpha1.ClusterServiceVersion) []error {
 			}
 		}
 	} else {
-		errs = append(errs, errors.WarnMissingIcon("csv.Spec.Icon not specified"))
+		warns = append(warns, fmt.Errorf("csv.Spec.Icon not specified"))
 	}
 
 	if categories, ok := csv.ObjectMeta.Annotations["categories"]; ok {
@@ -158,7 +161,7 @@ func validateHubCSVSpec(csv v1alpha1.ClusterServiceVersion) []error {
 			customCategories, err := extractCategories(customCategoriesPath)
 			if err != nil {
 				errs = append(errs, fmt.Errorf("could not extract custom categories from categories %#v: %s", customCategories, err))
-				return errs
+				return errs, warns
 			}
 			for _, category := range categorySlice {
 				if _, ok := customCategories[strings.TrimSpace(category)]; !ok {
@@ -175,7 +178,7 @@ func validateHubCSVSpec(csv v1alpha1.ClusterServiceVersion) []error {
 		}
 	}
 
-	return errs
+	return errs, warns
 }
 
 type categories struct {
diff --git a/pkg/validation/internal/operatorhub_test.go b/pkg/validation/internal/operatorhub_test.go
@@ -128,3 +128,47 @@ func TestExtractCategories(t *testing.T) {
 		}
 	}
 }
+
+func TestWarnNoIcon(t *testing.T) {
+	var table = []struct {
+		description string
+		directory   string
+		hasError    bool
+		errStrings  []string
+		warnStrings []string
+	}{
+		{
+			description: "valid bundle no icon",
+			directory:   "./testdata/valid_bundle_no_icon",
+			hasError:    false,
+			errStrings:  []string{},
+			warnStrings: []string{"Warning: Value : (etcdoperator.v0.9.4) csv.Spec.Icon not specified"},
+		},
+	}
+
+	for _, tt := range table {
+		// Validate the bundle object
+		bundle, err := manifests.GetBundleFromDir(tt.directory)
+		require.NoError(t, err)
+
+		results := OperatorHubValidator.Validate(bundle)
+
+		if len(results) > 0 {
+			require.Equal(t, tt.hasError, results[0].HasError())
+			if results[0].HasError() {
+				require.Equal(t, len(tt.errStrings), len(results[0].Errors))
+				for _, err := range results[0].Errors {
+					errString := err.Error()
+					require.Contains(t, tt.errStrings, errString)
+				}
+			}
+			if results[0].HasWarn() {
+				require.Equal(t, len(tt.warnStrings), len(results[0].Warnings))
+				for _, warn := range results[0].Warnings {
+					warnString := warn.Error()
+					require.Contains(t, tt.warnStrings, warnString)
+				}
+			}
+		}
+	}
+}
diff --git a/pkg/validation/internal/testdata/valid_bundle_no_icon/etcdbackups.etcd.database.coreos.com.crd.yaml b/pkg/validation/internal/testdata/valid_bundle_no_icon/etcdbackups.etcd.database.coreos.com.crd.yaml
@@ -0,0 +1,13 @@
+apiVersion: apiextensions.k8s.io/v1beta1
+kind: CustomResourceDefinition
+metadata:
+  name: etcdbackups.etcd.database.coreos.com
+spec:
+  group: etcd.database.coreos.com
+  names:
+    kind: EtcdBackup
+    listKind: EtcdBackupList
+    plural: etcdbackups
+    singular: etcdbackup
+  scope: Namespaced
+  version: v1beta2
diff --git a/pkg/validation/internal/testdata/valid_bundle_no_icon/etcdclusters.etcd.database.coreos.com.crd.yaml b/pkg/validation/internal/testdata/valid_bundle_no_icon/etcdclusters.etcd.database.coreos.com.crd.yaml
@@ -0,0 +1,16 @@
+apiVersion: apiextensions.k8s.io/v1beta1
+kind: CustomResourceDefinition
+metadata:
+  name: etcdclusters.etcd.database.coreos.com
+spec:
+  group: etcd.database.coreos.com
+  names:
+    kind: EtcdCluster
+    listKind: EtcdClusterList
+    plural: etcdclusters
+    shortNames:
+    - etcdclus
+    - etcd
+    singular: etcdcluster
+  scope: Namespaced
+  version: v1beta2
diff --git a/pkg/validation/internal/testdata/valid_bundle_no_icon/etcdoperator.v0.9.4.clusterserviceversion.yaml b/pkg/validation/internal/testdata/valid_bundle_no_icon/etcdoperator.v0.9.4.clusterserviceversion.yaml
diff --git a/pkg/validation/internal/testdata/valid_bundle_no_icon/etcdrestores.etcd.database.coreos.com.crd.yaml b/pkg/validation/internal/testdata/valid_bundle_no_icon/etcdrestores.etcd.database.coreos.com.crd.yaml

Original file line number	Diff line number	Diff line change
`@@ -243,7 +243,3 @@ func invalidObject(lvl Level, detail string, value interface{}) Error {`
`243`	`243`	`func WarnInvalidObject(detail string, value interface{}) Error {`
`244`	`244`	`return failedValidation(LevelWarn, detail, value)`
`245`	`245`	`}`
`246`		`-`
`247`		`-func WarnMissingIcon(detail string) Error {`
`248`		`- return failedValidation(LevelWarn, detail, "")`
`249`		`-}`
Original file line number	Diff line number	Diff line change
`@@ -74,16 +74,19 @@ func validateBundleOperatorHub(bundle *manifests.Bundle) errors.ManifestResult {`
`74`	`74`	`return result`
`75`	`75`	`}`
`76`	`76`
`77`		`- errs := validateHubCSVSpec(*bundle.CSV)`
	`77`	`+ errs, warns := validateHubCSVSpec(*bundle.CSV)`
`78`	`78`	`for _, err := range errs {`
`79`	`79`	`result.Add(errors.ErrInvalidCSV(err.Error(), bundle.CSV.GetName()))`
`80`	`80`	`}`
`81`		`-`
	`81`	`+ for _, warn := range warns {`
	`82`	`+ result.Add(errors.WarnInvalidCSV(warn.Error(), bundle.CSV.GetName()))`
	`83`	`+ }`
`82`	`84`	`return result`
`83`	`85`	`}`
`84`	`86`
`85`		`-func validateHubCSVSpec(csv v1alpha1.ClusterServiceVersion) []error {`
	`87`	`+func validateHubCSVSpec(csv v1alpha1.ClusterServiceVersion) ([]error, []error) {`
`86`	`88`	`var errs []error`
	`89`	`+ var warns []error`
`87`	`90`
`88`	`91`	`if csv.Spec.Provider.Name == "" {`
`89`	`92`	`errs = append(errs, fmt.Errorf("csv.Spec.Provider.Name not specified"))`
`@@ -146,7 +149,7 @@ func validateHubCSVSpec(csv v1alpha1.ClusterServiceVersion) []error {`
`146`	`149`	`}`
`147`	`150`	`}`
`148`	`151`	`} else {`
`149`		`- errs = append(errs, errors.WarnMissingIcon("csv.Spec.Icon not specified"))`
	`152`	`+ warns = append(warns, fmt.Errorf("csv.Spec.Icon not specified"))`
`150`	`153`	`}`
`151`	`154`
`152`	`155`	`if categories, ok := csv.ObjectMeta.Annotations["categories"]; ok {`
`@@ -158,7 +161,7 @@ func validateHubCSVSpec(csv v1alpha1.ClusterServiceVersion) []error {`
`158`	`161`	`customCategories, err := extractCategories(customCategoriesPath)`
`159`	`162`	`if err != nil {`
`160`	`163`	`errs = append(errs, fmt.Errorf("could not extract custom categories from categories %#v: %s", customCategories, err))`
`161`		`- return errs`
	`164`	`+ return errs, warns`
`162`	`165`	`}`
`163`	`166`	`for _, category := range categorySlice {`
`164`	`167`	`if _, ok := customCategories[strings.TrimSpace(category)]; !ok {`
`@@ -175,7 +178,7 @@ func validateHubCSVSpec(csv v1alpha1.ClusterServiceVersion) []error {`
`175`	`178`	`}`
`176`	`179`	`}`
`177`	`180`
`178`		`- return errs`
	`181`	`+ return errs, warns`
`179`	`182`	`}`
`180`	`183`
`181`	`184`	`type categories struct {`