Mark openshift & xKS e2e tests

.github/workflows/kind-ci-automation.yaml

@@ -1,13 +1,17 @@
-name: Build, Deploy and Test on kind
+name: Build, Deploy and Test on KinD
 
 on:
   pull_request:
     branches:
       - "master"
       - "v*"
 
+permissions:
+  contents: read
+
 env:
   IMG: gitops-operator:test
+  LOG_DIR: /tmp/kind-ci-artifacts
 
 jobs:
   ci-build:
@@ -22,10 +26,14 @@ jobs:
         with:
           go-version-file: 'go.mod'
 
+      - name: Prepare log directory
+        run: mkdir -p "${{ env.LOG_DIR }}"
+
       - name: Create kind cluster
         uses: helm/kind-action@ef37e7f390d99f746eb8b610417061a60e82a6cc # v1
         with:
           cluster_name: gitops-test
+          config: test/kind-config.yaml
 
       # TODO: check if porting is required for non-OCP clusters
       - name: Disable webhook and conversion for non-OCP cluster
@@ -40,7 +48,8 @@ jobs:
 
       - name: Build manager image
         run: |
-          make docker-build IMG=${{ env.IMG }}
+          set -o pipefail
+          make docker-build IMG=${{ env.IMG }} 2>&1 | tee "${{ env.LOG_DIR }}/docker-build.log"
 
       - name: Load image into kind
         run: |
@@ -52,103 +61,36 @@ jobs:
 
       - name: Deploy operator
         run: |
-          echo "manifests: $(KUSTOMIZE) build config/default"
-          make deploy IMG=${{ env.IMG }} | tee /tmp/deploy.log
+          set -o pipefail
+          make deploy IMG=${{ env.IMG }} 2>&1 | tee "${{ env.LOG_DIR }}/deploy.log"
 
       - name: Verify Controller Manager deployment is available
         run: |
-          kubectl get deployment -n openshift-gitops-operator
-          kubectl describe deployment -n openshift-gitops-operator
-          kubectl wait --for=condition=available --timeout=300s \
-            deployment/openshift-gitops-operator-controller-manager \
-            -n openshift-gitops-operator
-
-      - name: Create ArgoCD instance
+          set -o pipefail
+          {
+            kubectl get deployment -n openshift-gitops-operator
+            kubectl describe deployment -n openshift-gitops-operator
+            kubectl wait --for=condition=available --timeout=300s \
+              deployment/openshift-gitops-operator-controller-manager \
+              -n openshift-gitops-operator
+          } 2>&1 | tee "${{ env.LOG_DIR }}/verify-deployment.log"
+
+      - name: Run E2E tests Sequential on xKS
         run: |
-          kubectl create ns test-argocd
-          kubectl apply -f - <<'EOF'
-          apiVersion: argoproj.io/v1beta1
-          kind: ArgoCD
-          metadata:
-            name: argocd
-            namespace: test-argocd
-          EOF
+          set -o pipefail
+          NON_OLM=true make e2e-xks-tests-sequential-ginkgo 2>&1 | tee "${{ env.LOG_DIR }}/e2e-sequential.log"
 
-      - name: Wait for ArgoCD component pods to exist
+      - name: Run E2E tests Parallel on xKS
         run: |
-          EXPECTED_LABELS=("argocd-application-controller" "argocd-redis" "argocd-repo-server" "argocd-server")
-          TIMEOUT=300
-          INTERVAL=10
-          ELAPSED=0
-
-          echo "Waiting for ArgoCD component pods to exist in test-argocd..."
-          while true; do
-            ALL_EXIST=true
-            for label in "${EXPECTED_LABELS[@]}"; do
-              if ! kubectl get pod -n test-argocd -l "app.kubernetes.io/name=${label}" --no-headers 2>/dev/null | grep -q .; then
-                ALL_EXIST=false
-                break
-              fi
-            done
-
-            if $ALL_EXIST; then
-              echo "All ArgoCD component pods exist after ${ELAPSED}s."
-              break
-            fi
-
-            if [ $ELAPSED -ge $TIMEOUT ]; then
-              echo "Timed out after ${TIMEOUT}s waiting for ArgoCD pods."
-              kubectl get pods -n test-argocd
-              kubectl get argocd -n test-argocd -o yaml
-              exit 1
-            fi
-
-            sleep $INTERVAL
-            ELAPSED=$((ELAPSED + INTERVAL))
-          done
+          set -o pipefail
+          NON_OLM=true make e2e-xks-tests-parallel-ginkgo 2>&1 | tee "${{ env.LOG_DIR }}/e2e-parallel.log"
 
-      - name: Verify ArgoCD components are ready
-        run: |
-          kubectl get pods -n test-argocd
-          kubectl wait --for=condition=Ready -n test-argocd pod --timeout=300s \
-            -l 'app.kubernetes.io/name in (argocd-application-controller,argocd-redis,argocd-repo-server,argocd-server)'
-          echo "All ArgoCD components are ready."
-          kubectl get pods -n test-argocd
-
-      - name: Collect operator debug info on failure
-        if: failure()
-        run: |
-          echo "=== Deployment status ==="
-          kubectl get deployment -n openshift-gitops-operator -o wide || true
-          echo ""
-          echo "=== Pod status ==="
-          kubectl get pods -n openshift-gitops-operator -o wide || true
-          echo ""
-          echo "=== Pod descriptions ==="
-          kubectl describe pods -n openshift-gitops-operator || true
-          echo ""
-          echo "=== Controller manager logs ==="
-          kubectl logs deployment/openshift-gitops-operator-controller-manager \
-            -n openshift-gitops-operator --all-containers=true --tail=200 || true
-          echo ""
-          echo "=== Events in operator namespace ==="
-          kubectl get events -n openshift-gitops-operator --sort-by='.lastTimestamp' || true
-          echo ""
-          echo "=== CRD conversion config ==="
-          kubectl get crd argocds.argoproj.io -o jsonpath='{.spec.conversion}' || true
-          echo ""
-
-      - name: Collect ArgoCD debug info on failure
-        if: failure()
-        run: |
-          echo "=== ArgoCD resources ==="
-          kubectl get argocds -n test-argocd -o yaml 2>/dev/null || true
-          echo ""
-          echo "=== Pods in test-argocd ==="
-          kubectl get pods -n test-argocd -o wide 2>/dev/null || true
-          echo ""
-          echo "=== Pod descriptions in test-argocd ==="
-          kubectl describe pods -n test-argocd 2>/dev/null || true
-          echo ""
-          echo "=== Events in test-argocd ==="
-          kubectl get events -n test-argocd --sort-by='.lastTimestamp' 2>/dev/null || true
+      - name: Upload CI artifacts
+        if: always()
+        uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: kind-ci-artifacts-${{ github.run_id }}
+          path: ${{ env.LOG_DIR }}/
+          if-no-files-found: ignore
+          retention-days: 7
+

Makefile

@@ -81,6 +81,15 @@ endif
 SHELL = /usr/bin/env bash -o pipefail
 .SHELLFLAGS = -ec
 
+# GINKGO_VERSION is the version of ginkgo to use.
+# Pick ginkgo version from go.mod file.
+# Update this command when ginkgo version is updated in go.mod file. 
+# example: go list -m -f '{{.Version}}' github.com/onsi/ginkgo/v3
+GINKGO_VERSION := $(shell go list -m -f '{{.Version}}' github.com/onsi/ginkgo/v2)
+
+# XKS_LABEL_FILTER is the label filter for XKS tests.
+XKS_LABEL_FILTER ?= "!openshift"
+
 .PHONY: all
 all: build
 
@@ -172,6 +181,16 @@ e2e-tests-sequential:
 e2e-tests-parallel:
 	CI=prow make e2e-tests-parallel-ginkgo
 
+.PHONY: e2e-xks-tests-sequential-ginkgo
+e2e-xks-tests-sequential-ginkgo: ginkgo ## Runs Ginkgo e2e sequential tests
+	@echo "Running GitOps Operator sequential Ginkgo E2E tests..."
+	$(GINKGO_CLI) -v --trace --label-filter=$(XKS_LABEL_FILTER) --timeout 240m -r ./test/openshift/e2e/ginkgo/sequential 
+
+.PHONY: e2e-xks-tests-parallel-ginkgo ## Runs Ginkgo e2e parallel tests, (Defaults to 5 runs at a time)
+e2e-xks-tests-parallel-ginkgo: ginkgo
+	@echo "Running GitOps Operator parallel Ginkgo E2E tests..."
+	$(GINKGO_CLI) -p -v -procs=5 --trace --label-filter=$(XKS_LABEL_FILTER) --timeout 60m -r ./test/openshift/e2e/ginkgo/parallel
+
 ##@ Build
 
 .PHONY: build
@@ -247,7 +266,7 @@ kustomize: ## Download kustomize locally if necessary.
 GINKGO_CLI = $(shell pwd)/bin/ginkgo
 .PHONY: ginkgo
 ginkgo: ## Download ginkgo locally if necessary.
-	$(call go-get-tool,$(GINKGO_CLI),github.com/onsi/ginkgo/v2/ginkgo@v2.29.0)
+	$(call go-get-tool,$(GINKGO_CLI),github.com/onsi/ginkgo/v2/ginkgo@$(GINKGO_VERSION))
 
 
 # go-get-tool will 'go install' any package $2 and install it to $1.

test/e2e/argocd_route_test.go

@@ -33,15 +33,15 @@ var _ = Describe("Argo CD ConsoleLink controller", func() {
 		route := &routev1.Route{}
 		consoleLink := &console.ConsoleLink{}
 
-		It("Argocd route is present", func() {
+		It("Argocd route is present", Label("openshift"), func() {
 			checkIfPresent(types.NamespacedName{Name: argoCDRouteName, Namespace: argoCDNamespace}, route)
 		})
 
-		It("ConsoleLink is created", func() {
+		It("ConsoleLink is created", Label("openshift"), func() {
 			checkIfPresent(types.NamespacedName{Name: consoleLinkName}, consoleLink)
 		})
 
-		It("ConsoleLink and argocd route should match", func() {
+		It("ConsoleLink and argocd route should match", Label("openshift"), func() {
 			Eventually(func() error {
 				err := k8sClient.Get(context.TODO(), types.NamespacedName{Name: consoleLinkName}, consoleLink)
 				if err != nil {

test/kind-config.yaml

@@ -0,0 +1,11 @@
+kind: Cluster
+apiVersion: kind.x-k8s.io/v1alpha4
+nodes:
+  - role: control-plane
+    kubeadmConfigPatches:
+      - |
+        kind: InitConfiguration
+        nodeRegistration:
+          taints: []
+  - role: worker
+  - role: worker

test/openshift/e2e/README.md

@@ -94,6 +94,50 @@ SKIP_HA_TESTS=true LOCAL_RUN=true  make e2e-tests-sequential-ginkgo
 
 
 
+## Test Labels
+
+Ginkgo [labels](https://onsi.github.io/ginkgo/#spec-labels) are used to categorize tests that are only supported on specific platforms or configurations. Labels allow the CI system to filter tests using `--label-filter` at runtime.
+
+**Important**: Labels should only be applied to tests that are restricted to a specific platform or configuration. Do NOT add labels to generic tests that can run on any Kubernetes cluster (OpenShift, KinD, EKS, etc.). If a test works everywhere, it should remain unlabelled.
+
+### Available labels
+
+| Label | Meaning | When to use |
+|-------|---------|-------------|
+| `openshfit` | Test requires OpenShift-specific features (Routes, ConsoleLinks, OLM Subscriptions, SCCs, etc.) and cannot run on vanilla Kubernetes (KinD, EKS, GKE, AKS). | Add when the test depends on OpenShift APIs or resources not available on non-OCP clusters. |
+| `HA` | Test requires a cluster with at least 3 worker nodes for HA (High Availability) validation. | Add when the test creates HA Redis StatefulSets or validates pod anti-affinity across nodes. |
+
+### How labels are used in CI
+
+- **OpenShift CI**: Runs all tests (no label filter), so all labelled and unlabelled tests execute.
+- **xKS/KinD CI** (`make e2e-xks-tests-sequential-ginkgo` / `make e2e-xks-tests-parallel-ginkgo`): Uses `--label-filter="!openshfit"` to exclude OpenShift-only tests. The `XKS_LABEL_FILTER` env var can further customize filtering (e.g., `XKS_LABEL_FILTER="!openshfit && !HA"`).
+
+### How to apply a label
+
+Add the `Label(...)` decorator to `It`, `Context`, or `Describe` nodes:
+
+```go
+// Single label — test requires OpenShift
+It("verifies ConsoleLink is created for ArgoCD route", Label("openshift"), func() {
+    // ...
+})
+
+// Label on Context — all specs inside inherit the label
+Context("1-120_repo_server_system_ca_trust", Label("openshift"), func() {
+    It("ensures that missing Secret aborts startup", func() {
+        // ...
+    })
+})
+```
+
+### Guidelines
+
+- If your test uses OpenShift-specific resources (Routes, ConsoleLinks, SCCs, Subscriptions, CSVs, monitoring via prometheus-operator CRDs that are only present on OCP, etc.), add `Label("openshift")`.
+- If your test requires 3+ nodes for HA validation, add `Label("HA")`.
+- If your test works on any conformant Kubernetes cluster, do NOT add any label.
+- When in doubt, leave the test unlabelled — it will run everywhere, which provides broader coverage.
+
+
 ## Test Code
 
 gitops-operator E2E tests are defined within `test/openshift/e2e/ginkgo`.