[SRVKP-7207] verify olmskiprange path

Author: manthinasai

pkg/oc/oc.go

@@ -4,6 +4,7 @@ import (
 	"encoding/json"
 	"fmt"
 	"log"
+	"os"
 	"slices"
 	"strings"
 	"time"
@@ -170,3 +171,101 @@ func CopySecret(secretName string, sourceNamespace string, destNamespace string)
 	cmd.MustSucceed("bash", "-c", fmt.Sprintf(`echo '%s' | kubectl apply -n %s -f -`, cmdOutput, destNamespace))
 	log.Printf("Successfully copied secret %s from %s to %s", secretName, sourceNamespace, destNamespace)
 }
+
+func FetchOlmSkipRange() (string, error) {
+	olmManifestJson := cmd.MustSucceed("oc", "get", "packagemanifests", "openshift-pipelines-operator-rh", "-n", "openshift-marketplace", "-o", "json").Stdout()
+	SkipRange := cmd.MustSucceed("bash", "-c", fmt.Sprintf(`echo '%s' | jq -r '.status.channels[].currentCSVDesc.annotations["olm.skipRange"]'`, olmManifestJson)).Stdout()
+	if SkipRange == "" {
+		return "", fmt.Errorf("OLM Skip Range is empty")
+	}
+	return SkipRange, nil
+}
+
+func GetOlmSkipRange(upgradeType, fieldName, fileName string) {
+	SkipRange, err := FetchOlmSkipRange()
+	if err != nil {
+		log.Printf("Error fetching OLM Skip Range: %v", err)
+		return
+	}
+	file, err := os.OpenFile(resource.Path(fileName), os.O_RDWR, 0644)
+	if err != nil {
+		log.Printf("Error opening file %s: %v", fileName, err)
+		return
+	}
+	defer file.Close()
+	var existingData map[string]string
+	if err := json.NewDecoder(file).Decode(&existingData); err != nil {
+		log.Printf("Error decoding existing data from file %s: %v", fileName, err)
+		return
+	}
+	if upgradeType == "pre-upgrade" {
+		existingData["pre-upgrade-olm-skip-range"] = SkipRange
+		log.Printf("Pre-upgrade OLM Skip Range is stored as: %s", SkipRange)
+	} else if upgradeType == "post-upgrade" {
+		existingData["post-upgrade-olm-skip-range"] = SkipRange
+		log.Printf("Post-upgrade OLM Skip Range is stored as: %s", SkipRange)
+	}
+	if _, err := file.Seek(0, 0); err != nil {
+		log.Printf("Error seeking file %s: %v", fileName, err)
+		return
+	}
+	encoder := json.NewEncoder(file)
+	encoder.SetIndent("", "  ") // Pretty-print the JSON output
+	if err := encoder.Encode(existingData); err != nil {
+		log.Printf("Error writing updated data to file %s: %v", fileName, err)
+		return
+	}
+	log.Printf("OLM Skip Range for '%s' has been saved to file %s", fieldName, fileName)
+}
+
+func ValidateOlmSkipRange() {
+	SkipRange, err := FetchOlmSkipRange()
+	if err != nil {
+		log.Printf("Error fetching OLM Skip Range: %v", err)
+		return
+	}
+	lines := strings.Split(SkipRange, "\n")
+	if len(lines) == 0 {
+		log.Printf("Error: No lines found in OLM Skip Range")
+		return
+	}
+	firstLine := lines[0]
+	pipelineVersion := os.Getenv("OPERATOR_VERSION")
+	if strings.Contains(firstLine, pipelineVersion) {
+		log.Printf("Success: OPERATOR_VERSION '%s' matches the first line of OLM Skip Range: '%s'", pipelineVersion, firstLine)
+	} else {
+		testsuit.T.Fail(fmt.Errorf("Error: OPERATOR_VERSION '%s' does not match the first line of OLM Skip Range: '%s'", pipelineVersion, firstLine))
+	}
+}
+
+func ValidateOlmSkipRangeDiff(fileName string, preUpgradeSkipRange string, postUpgradeSkipRange string) {
+	file, err := os.Open(resource.Path(fileName))
+	if err != nil {
+		log.Printf("Error opening file %s: %v", fileName, err)
+		testsuit.T.Fail(fmt.Errorf("Error opening file %s: %v", fileName, err))
+		return
+	}
+	defer file.Close()
+	var skipRangeData map[string]string
+	decoder := json.NewDecoder(file)
+	if err := decoder.Decode(&skipRangeData); err != nil {
+		log.Printf("Error decoding JSON from file %s: %v", fileName, err)
+		testsuit.T.Fail(fmt.Errorf("Error decoding JSON from file %s: %v", fileName, err))
+		return
+	}
+	preUpgradeSkipRange, preExists := skipRangeData[preUpgradeSkipRange]
+	postUpgradeSkipRange, postExists := skipRangeData[postUpgradeSkipRange]
+	if !preExists || !postExists || preUpgradeSkipRange == "" || postUpgradeSkipRange == "" {
+		log.Printf("Error: One of the skip ranges is missing or empty. Pre-Upgrade: %v, Post-Upgrade: %v", preUpgradeSkipRange, postUpgradeSkipRange)
+		testsuit.T.Fail(fmt.Errorf("One of the skip ranges is missing or empty. Pre-Upgrade: %v, Post-Upgrade: %v", preUpgradeSkipRange, postUpgradeSkipRange))
+		return
+	}
+	log.Printf("Pre-Upgrade Skip Range: %v", preUpgradeSkipRange)
+	log.Printf("Post-Upgrade Skip Range: %v", postUpgradeSkipRange)
+	if preUpgradeSkipRange == postUpgradeSkipRange {
+		log.Printf("OLM Skip Range before and after upgrade are the same. Pre-Upgrade: %s, Post-Upgrade: %s", preUpgradeSkipRange, postUpgradeSkipRange)
+	} else {
+		log.Printf("OLM Skip Range mismatch detected! Pre-Upgrade: '%s', Post-Upgrade: '%s'", preUpgradeSkipRange, postUpgradeSkipRange)
+		testsuit.T.Fail(fmt.Errorf("OLM Skip Range mismatch detected! Pre-Upgrade: '%s', Post-Upgrade: '%s'", preUpgradeSkipRange, postUpgradeSkipRange))
+	}
+}

specs/olm.spec

@@ -46,6 +46,7 @@ Steps:
   * Validate manual approval gate deployment
   * Validate tektoninstallersets status
   * Validate tektoninstallersets names
+  * Validate OperatorVersion in OlmSkipRange
 
 ## Upgrade openshift-pipelines operator: PIPELINES-09-TC02
 Tags: upgrade, admin

specs/operator/post-upgrade.spec

@@ -83,4 +83,15 @@ Importance: Critical
 Steps:
   * Switch to project "releasetest-upgrade-s2i"
   * Get tags of the imagestream "golang" from namespace "openshift" and store to variable "golang-tags"
-  * Start and verify pipeline "s2i-go-pipeline" with param "VERSION" with values stored in variable "golang-tags" with workspace "name=source,claimName=shared-pvc"
+  * Start and verify pipeline "s2i-go-pipeline" with param "VERSION" with values stored in variable "golang-tags" with workspace "name=source,claimName=shared-pvc"
+
+## Validate olm skiprange post upgrade: PIPELINES-19-TC06
+Tags: post-upgrade, olm-skip-range
+Component: Pipelines
+Level: Integration
+Type: Functional
+Importance: Critical
+
+Steps:
+ * Get olm-skip-range "post-upgrade" and save to field "post-upgrade-olm-skip-range" in file "testdata/olm/skiprange.json"
+ * Validate the fields "pre-upgrade-olm-skip-range" and "post-upgrade-olm-skip-range" are same in file "testdata/olm/skiprange.json"

specs/operator/pre-upgrade.spec

@@ -126,4 +126,14 @@ Steps:
       |S.NO|resource_dir                                          |
       |----|------------------------------------------------------|
       |1   |testdata/ecosystem/pipelines/s2i-go.yaml|
-      |2   |testdata/pvc/pvc.yaml                                 |
+      |2   |testdata/pvc/pvc.yaml                                 |
+
+## Validate olm skiprange pre upgrade: PIPELINES-18-TC06
+Tags: pre-upgrade, olm-skip-range
+Component: Pipelines
+Level: Integration
+Type: Functional
+Importance: Critical
+
+Steps:
+ * Get olm-skip-range "pre-upgrade" and save to field "pre-upgrade-olm-skip-range" in file "testdata/olm/skiprange.json"

steps/olm/operator.go

@@ -194,3 +194,15 @@ var _ = gauge.Step("Store Cosign public key in file", func() {
 var _ = gauge.Step("Verify <binary> version from the pipelinerun logs", func(binary string) {
 	pipelines.CheckLogVersion(store.Clients(), binary, store.Namespace())
 })
+
+var _ = gauge.Step("Get olm-skip-range <upgradeType> and save to field <fieldName> in file <fileName>", func(upgradeType string, fieldName string, filename string) {
+	oc.GetOlmSkipRange(upgradeType, fieldName, filename)
+})
+
+var _ = gauge.Step("Validate the fields <preUpgradeSkipRange> and <postUpgradeSkipRange> are same in file <fileName>", func(preUpgradeSkipRange string, postUpgradeSkipRange string, fileName string) {
+	oc.ValidateOlmSkipRangeDiff(fileName, preUpgradeSkipRange, postUpgradeSkipRange)
+})
+
+var _ = gauge.Step("Validate OperatorVersion in OlmSkipRange", func() {
+	oc.ValidateOlmSkipRange()
+})

testdata/olm/skiprange.json

@@ -0,0 +1,4 @@
+{
+  "pre-upgrade-olm-skip-range": "",
+  "post-upgrade-olm-skip-range": ""
+}