Merge pull request #1662 from romayalon/romy-upgrade-tests

CI | Upgrade Tests

Author: romayalon

.github/workflows/manual-upgrade-tests.yaml

@@ -0,0 +1,18 @@
+name: Full Upgrade Test
+on:
+  workflow_dispatch:
+    inputs:
+      source_version:
+        description: "Version to upgrade From"
+        required: false
+      target_version:
+        description: "Version to upgrade to"
+        required: false
+
+jobs:
+  nightly-upgrade-tests:
+    uses: ./.github/workflows/upgrade-tests-workflow.yaml
+    secrets: inherit
+    with:
+      source_version: ${{ github.event.inputs.source_version }}
+      target_version: ${{ github.event.inputs.target_version }}

.github/workflows/nightly-upgrade-tests.yaml

@@ -0,0 +1,9 @@
+name: Nightly Upgrade Tests
+on:
+  schedule:
+    - cron: '0 4 * * *'
+      
+jobs:
+  nightly-upgrade-tests:
+    uses: ./.github/workflows/upgrade-tests-workflow.yaml
+    secrets: inherit

.github/workflows/upgrade-tests-workflow.yaml

@@ -0,0 +1,41 @@
+name: Upgrade Tests Workflow
+on: 
+  workflow_call:
+    inputs:
+      source_version:
+        type: string
+        description: "Version to upgrade From"
+        required: false
+      target_version:
+        type: string
+        description: "Version to upgrade to"
+        required: false
+    
+jobs:
+  upgrade-tests-workflow:
+    runs-on: ubuntu-latest
+    timeout-minutes: 90
+    concurrency:
+      group: ${{ github.workflow }}-${{ github.ref }}
+      cancel-in-progress: true
+    steps:
+      - name: checkout
+        uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: "1.23"
+
+      - name: Set environment variables
+        run: |
+          echo PATH=$PATH:$HOME/go/bin  >> $GITHUB_ENV
+
+      - name: Deploy Dependencies
+        run: |
+          set -x
+          bash .travis/install-5nodes-kind-cluster.sh
+          go get -v github.com/onsi/ginkgo/v2
+          go install -v github.com/onsi/ginkgo/v2/ginkgo
+          ginkgo version
+
+      - name: Run Upgrade test
+        run: UPGRADE_TEST_OPERATOR_SOURCE_VERSION=${{ inputs.source_version }} UPGRADE_TEST_OPERATOR_TARGET_VERSION=${{ inputs.target_version }} make test-upgrade

Makefile

@@ -305,6 +305,11 @@ test-validations:
 	@echo "✅ test-validations"
 .PHONY: test-validations
 
+test-upgrade: vendor
+	ginkgo -v test/upgrade
+	@echo "✅ test-upgrade"
+.PHONY: test-upgrade
+
 # find or download controller-gen if necessary
 controller-gen:
 ifneq ($(CONTROLLER_GEN_VERSION), $(shell controller-gen --version | awk -F ":" '{print $2}'))

doc/CI&Tests/UpgradeTests.md

@@ -0,0 +1,51 @@
+# NooBaa Operator - CI & Tests
+
+1. [Introduction](#introduction)
+2. [Upgrade Tests](#upgrade-tests)
+
+## Introduction
+
+NooBaa employs a Continuous Integration (CI) process to ensure the reliability and quality of its software. 
+NooBaa Tests cover various aspects of functionality and integration. 
+This proactive approach to testing enables NooBaa to deliver stable and efficient solutions for its users.
+
+## Upgrade Tests
+
+The NooBaa operator upgrade tests are part of the continuous integration (CI) pipeline and are designed to verify the stability and reliability of the system during version transitions.
+
+The upgrade test process includes the following steps:
+
+1. **Initial Deployment**: The latest release of the NooBaa operator is deployed on a Kubernetes cluster by default, see - [NooBaa Latest Release](https://api.github.com/repos/noobaa/noobaa-operator/releases/latest).
+2. **System Initialization**: A fully functional NooBaa system is created, including resources such as buckets, objects, backing stores, and endpoints.
+3. **Upgrade Execution**: The operator is upgraded to the target version using the noobaa CLI, the default target version is the latest noobaa-operator nightly build that could be found in [quay.io/noobaa/noobaa-operator](https://quay.io/repository/noobaa/noobaa-operator?tab=tags).
+4. **Post-Upgrade Validation**: The health and functionality of the NooBaa system are verified after the upgrade. This includes checking the readiness of control plane components, data accessibility, and the integrity of configurations and runtime state.
+
+These tests simulate upgrade scenarios and are continuously executed in the CI pipeline to detect upgrade-related issues early and ensure smooth operator version transitions.
+
+### Run upgrade tests locally
+
+In order to run upgrade tests locally with the default source and target versions, run the following command - 
+```bash
+make test-upgrade
+```
+
+In order to run upgrade tests locally with custom source and target versions, run the following command - 
+```bash
+UPGRADE_TEST_OPERATOR_SOURCE_VERSION=<upgrade-operator-source-version> UPGRADE_TEST_OPERATOR_TARGET_VERSION=<upgrade-operator-target-version> make test-upgrade
+```
+
+For instance - 
+```bash
+UPGRADE_TEST_OPERATOR_SOURCE_VERSION=5.17.0 UPGRADE_TEST_OPERATOR_TARGET_VERSION=5.18.6 make test-upgrade
+```
+
+### Manual Upgrade Tests Action 
+
+The following action is a dispatchable GitHub Action for running the upgrade tests manually.  
+It was implemented as part of the continuous integration (CI) process to allow on-demand execution of upgrade scenarios outside the scheduled or automated test pipeline.
+See - [Manual Upgrade Tests Action](../../.github/workflows/manual-upgrade-tests.yaml).
+
+### Nightly Upgrade Tests Action 
+
+A nightly Upgrade tests github actions runs every night at 4AM UTC.
+See - [Nightly Upgrade Tests Action](../../.github/workflows/nightly-upgrade-tests.yaml).

test/upgrade/upgrade_suit_test.go

@@ -0,0 +1,13 @@
+package upgrade_test
+
+import (
+	"testing"
+
+	. "github.com/onsi/ginkgo/v2"
+	. "github.com/onsi/gomega"
+)
+
+func TestUpgrade(t *testing.T) {
+	RegisterFailHandler(Fail)
+	RunSpecs(t, "Upgrade Suite")
+}