(fix) : Fix check to verify OCP label versions when it is =v4.x (openshift#148)

Upstream-repository: api
Upstream-commit: e4b9266c693b1443c33fff99aabd49c07232e6ba

Author: camilamacedo86

staging/api/pkg/validation/internal/community.go

@@ -239,75 +239,71 @@ func validateImageFile(checks CommunityOperatorChecks, deprecatedAPImsg string)
 				}
 
 				value := strings.Split(line[i], "=")
-				indexRange := value[1]
-				doubleCote := "\""
-				singleCote := "'"
-				indexRange = strings.ReplaceAll(indexRange, singleCote, "")
-				indexRange = strings.ReplaceAll(indexRange, doubleCote, "")
+				// It means that the OCP label is =OCP version
+				if len(value) > 2 && len(value[2]) > 0 {
+					version := cleanStringToGetTheVersionToParse(value[2])
+					verParsed, err := semver.ParseTolerant(version)
+					if err != nil {
+						checks.errs = append(checks.errs, fmt.Errorf("unable to parse the value (%s) on (%s)",
+							version, ocpLabelindex))
+						return checks
+					}
+
+					if verParsed.GE(semVerOCPV1beta1Unsupported) {
+						checks.errs = append(checks.errs, fmt.Errorf("this bundle is using APIs which were "+
+							"deprecated and removed in v1.22. "+
+							"More info: https://kubernetes.io/docs/reference/using-api/deprecation-guide/#v1-22. "+
+							"Migrate the API(s) for "+
+							"%s or provide compatible version(s) by using the %s annotation in "+
+							"`metadata/annotations.yaml` to ensure that the index image will be geneared "+
+							"with its label. (e.g. LABEL %s='4.6-4.8')",
+							deprecatedAPImsg,
+							ocpLabelindex,
+							ocpLabelindex))
+						return checks
+					}
+					return checks
+				}
+				indexRange := cleanStringToGetTheVersionToParse(value[1])
 				if len(indexRange) > 1 {
 					// if has the = then, the value needs to be < 4.9
-					if strings.Contains(indexRange, "=") {
-						version := strings.Split(indexRange, "=")[1]
-						verParsed, err := semver.ParseTolerant(version)
-						if err != nil {
-							checks.errs = append(checks.errs, fmt.Errorf("unable to parse the value (%s) on (%s)",
-								version, ocpLabelindex))
-							return checks
-						}
-
-						if verParsed.GE(semVerOCPV1beta1Unsupported) {
-							checks.errs = append(checks.errs, fmt.Errorf("this bundle is using APIs which were "+
-								"deprecated and removed in v1.22. "+
-								"More info: https://kubernetes.io/docs/reference/using-api/deprecation-guide/#v1-22. "+
-								"Migrate the API(s) for "+
-								"%s or provide compatible version(s) by using the %s annotation in "+
-								"`metadata/annotations.yaml` to ensure that the index image will be geneared "+
-								"with its label. (e.g. LABEL %s='4.6-4.8')",
-								deprecatedAPImsg,
-								ocpLabelindex,
-								ocpLabelindex))
-							return checks
-						}
-					} else {
-						// if not has not the = then the value needs contains - value less < 4.9
-						if !strings.Contains(indexRange, "-") {
-							checks.errs = append(checks.errs, fmt.Errorf("this bundle is using APIs which were "+
-								"deprecated and removed in v1.22. "+
-								"More info: https://kubernetes.io/docs/reference/using-api/deprecation-guide/#v1-22 "+
-								"The %s allows to distribute it on >= %s. Migrate the API(s) for "+
-								"%s or provide compatible version(s) by using the %s annotation in "+
-								"`metadata/annotations.yaml` to ensure that the index image will be generated "+
-								"with its label. (e.g. LABEL %s='4.6-4.8')",
-								indexRange,
-								ocpVerV1beta1Unsupported,
-								deprecatedAPImsg,
-								ocpLabelindex,
-								ocpLabelindex))
-							return checks
-						}
-
-						version := strings.Split(indexRange, "-")[1]
-						verParsed, err := semver.ParseTolerant(version)
-						if err != nil {
-							checks.errs = append(checks.errs, fmt.Errorf("unable to parse the value (%s) on (%s)",
-								version, ocpLabelindex))
-							return checks
-						}
-
-						if verParsed.GE(semVerOCPV1beta1Unsupported) {
-							checks.errs = append(checks.errs, fmt.Errorf("this bundle is using APIs which were "+
-								"deprecated and removed in v1.22. "+
-								"More info: https://kubernetes.io/docs/reference/using-api/deprecation-guide/#v1-22. "+
-								"Upgrade the APIs from "+
-								"for %s or provide compatible distribution version(s) by using the %s "+
-								"annotation in `metadata/annotations.yaml` to ensure that the index image will "+
-								"be generated with its label. (e.g. LABEL %s='4.6-4.8')",
-								deprecatedAPImsg,
-								ocpLabelindex,
-								ocpLabelindex))
-							return checks
-						}
+					// if not has not the = then the value needs contains - value less < 4.9
+					if !strings.Contains(indexRange, "-") {
+						checks.errs = append(checks.errs, fmt.Errorf("this bundle is using APIs which were "+
+							"deprecated and removed in v1.22. "+
+							"More info: https://kubernetes.io/docs/reference/using-api/deprecation-guide/#v1-22 "+
+							"The %s allows to distribute it on >= %s. Migrate the API(s) for "+
+							"%s or provide compatible version(s) by using the %s annotation in "+
+							"`metadata/annotations.yaml` to ensure that the index image will be generated "+
+							"with its label. (e.g. LABEL %s='4.6-4.8')",
+							indexRange,
+							ocpVerV1beta1Unsupported,
+							deprecatedAPImsg,
+							ocpLabelindex,
+							ocpLabelindex))
+						return checks
+					}
+
+					version := strings.Split(indexRange, "-")[1]
+					verParsed, err := semver.ParseTolerant(version)
+					if err != nil {
+						checks.errs = append(checks.errs, fmt.Errorf("unable to parse the value (%s) on (%s)",
+							version, ocpLabelindex))
+						return checks
+					}
 
+					if verParsed.GE(semVerOCPV1beta1Unsupported) {
+						checks.errs = append(checks.errs, fmt.Errorf("this bundle is using APIs which were "+
+							"deprecated and removed in v1.22. "+
+							"More info: https://kubernetes.io/docs/reference/using-api/deprecation-guide/#v1-22. "+
+							"Upgrade the APIs from "+
+							"for %s or provide compatible distribution version(s) by using the %s "+
+							"annotation in `metadata/annotations.yaml` to ensure that the index image will "+
+							"be generated with its label. (e.g. LABEL %s='4.6-4.8')",
+							deprecatedAPImsg,
+							ocpLabelindex,
+							ocpLabelindex))
+						return checks
 					}
 				} else {
 					checks.errs = append(checks.errs, fmt.Errorf("unable to get the range informed on %s",
@@ -328,3 +324,14 @@ func validateImageFile(checks CommunityOperatorChecks, deprecatedAPImsg string)
 	}
 	return checks
 }
+
+// cleanStringToGetTheVersionToParse will remove the expected characters for
+// we are able to parse the version informed.
+func cleanStringToGetTheVersionToParse(value string) string {
+	doubleQuote := "\""
+	singleQuote := "'"
+	value = strings.ReplaceAll(value, singleQuote, "")
+	value = strings.ReplaceAll(value, doubleQuote, "")
+	value = strings.ReplaceAll(value, "v", "")
+	return value
+}

staging/api/pkg/validation/internal/community_test.go

@@ -129,6 +129,18 @@ func Test_communityValidator(t *testing.T) {
 				},
 			},
 		},
+		{
+			name: "should pass when the olm annotation and index label are set with a " +
+				"value =v4.8 and has deprecated apis",
+			wantError: false,
+			args: args{
+				bundleDir:      "./testdata/valid_bundle_v1beta1",
+				imageIndexPath: "./testdata/dockerfile/valid_bundle_4_8.Dockerfile",
+				annotations: map[string]string{
+					"olm.properties": fmt.Sprintf(`[{"type": "olm.maxOpenShiftVersion", "value": "4.8"}]`),
+				},
+			},
+		},
 	}
 
 	for _, tt := range tests {

staging/api/pkg/validation/internal/operatorhub_test.go

@@ -397,8 +397,8 @@ func TestValidateHubDeprecatedAPIS(t *testing.T) {
 				minKubeVersion: "",
 				directory:      "./testdata/valid_bundle_v1beta1",
 			},
-			wantError:   true,
-			errStrings:  []string{"this bundle is using APIs which were deprecated and removed in v1.22. " +
+			wantError: true,
+			errStrings: []string{"this bundle is using APIs which were deprecated and removed in v1.22. " +
 				"More info: https://kubernetes.io/docs/reference/using-api/deprecation-guide/#v1-22. " +
 				"Migrate the API(s) for CRD: ([\"etcdbackups.etcd.database.coreos.com\"" +
 				" \"etcdclusters.etcd.database.coreos.com\" \"etcdrestores.etcd.database.coreos.com\"])"},
@@ -423,7 +423,7 @@ func TestValidateHubDeprecatedAPIS(t *testing.T) {
 			},
 			wantError:   true,
 			wantWarning: true,
-			errStrings:  []string{"unable to use csv.Spec.MinKubeVersion to verify the CRD/Webhook apis because it " +
+			errStrings: []string{"unable to use csv.Spec.MinKubeVersion to verify the CRD/Webhook apis because it " +
 				"has an invalid value: invalid"},
 			warnStrings: []string{"this bundle is using APIs which were deprecated and removed in v1.22. " +
 				"More info: https://kubernetes.io/docs/reference/using-api/deprecation-guide/#v1-22. " +

staging/api/pkg/validation/internal/testdata/dockerfile/valid_bundle_4_8.Dockerfile

@@ -0,0 +1,18 @@
+FROM scratch
+
+# Core bundle labels.
+LABEL operators.operatorframework.io.bundle.mediatype.v1=registry+v1
+LABEL operators.operatorframework.io.bundle.manifests.v1=manifests/
+LABEL operators.operatorframework.io.bundle.metadata.v1=metadata/
+LABEL operators.operatorframework.io.bundle.package.v1=memcached-operator
+LABEL operators.operatorframework.io.bundle.channels.v1=alpha
+LABEL com.redhat.openshift.versions="=v4.8"
+
+# Labels for testing.
+LABEL operators.operatorframework.io.test.mediatype.v1=scorecard+v1
+LABEL operators.operatorframework.io.test.config.v1=tests/scorecard/
+
+# Copy files to locations specified by labels.
+COPY bundle/manifests /manifests/
+COPY bundle/metadata /metadata/
+COPY bundle/tests/scorecard /tests/scorecard/