Merge branch 'main' into feat/RHIDP-8270

Author: polasudo

.cursor/rules/ci-e2e-testing.mdc

@@ -48,6 +48,36 @@ e2e-tests/
 └── playwright-report/        # Playwright reports
 ```
 
+#### Test File Requirements
+
+**Component Assignment**: Every test file (`*.spec.ts`) in the `e2e-tests` folder must have a component assigned in the `test.beforeAll` hook using the following syntax:
+
+```typescript
+test.beforeAll(async ({ }, testInfo) => {
+  testInfo.annotations.push({
+    type: "component",
+    description: "your_value",
+  });
+});
+```
+
+**Purpose**: This component annotation is used for test categorization, reporting, and CI/CD pipeline organization. It helps identify which component or feature area each test file is validating.
+
+**Examples of Component Values**:
+- `"authentication"` - for authentication provider tests
+- `"rbac"` - for role-based access control tests
+- `"plugins"` - for plugin functionality tests
+- `"configuration"` - for configuration validation tests
+- `"audit-log"` - for audit logging tests
+- `"core"` - for core functionality tests
+- `"navigation"` - for navigation and routing tests
+- `"api"` - for API endpoint and integration tests
+- `"integration"` - for external service integration tests
+- `"monitoring"` - for monitoring and observability tests
+- `"data-management"` - for data handling and management tests
+
+**Note**: The component description should be descriptive and consistent across related test files to ensure proper test organization and reporting.
+
 #### Key Test Categories
 
 1. **Smoke Tests** (`smoke-test.spec.ts`)
@@ -332,6 +362,21 @@ npx playwright test --project showcase-auth-providers --workers 1
 
 ## Key Dependencies and Common Issues
 
+### System Dependencies
+
+#### macOS Requirements
+**Important**: macOS users need to use GNU `grep` and GNU `sed` instead of the built-in BSD versions to avoid compatibility issues with scripts and CI/CD pipelines.
+
+Install using Homebrew:
+```bash
+brew install grep
+brew install gnu-sed
+```
+
+**Important**: Make sure to set the GNU versions as default to ensure they are used instead of the built-in macOS versions.
+
+**Note**: The built-in macOS versions of these tools may cause issues when running scripts or tests that expect GNU-compatible behavior.
+
 ### External Services
 
 #### Required Services

.gitignore

@@ -66,3 +66,8 @@ dynamic-plugins-root/*
 
 # Local Cursor rules context
 .cursor/rules/*.local.mdc
+
+# CI/Pipeline local overrides
+.ibm/pipelines/shared_dir/*
+.ibm/pipelines/artifact_dir/*
+.ibm/pipelines/env_override.local.sh

.ibm/pipelines/cleanup.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+
+cleanup() {
+  if [[ $? -ne 0 ]]; then
+
+    echo "Exited with an error, setting OVERALL_RESULT to 1"
+    save_overall_result 1
+  fi
+  echo "Cleaning up before exiting"
+  if [[ "${OPENSHIFT_CI}" == "true" ]]; then
+    case "$JOB_NAME" in
+      *gke*)
+        echo "Calling cleanup_gke"
+        cleanup_gke
+        ;;
+    esac
+  fi
+  rm -rf ~/tmpbin
+}

.ibm/pipelines/env_variables.sh

@@ -2,6 +2,29 @@
 # shellcheck disable=SC2034
 set -a  # Automatically export all variables
 
+# Define log file names and directories.
+LOGFILE="test-log"
+
+# Populated by OpenShift CI or the initial CI scripts
+# Addition to JOB_NAME, TAG_NAME, SHARED_DIR, ARTIFACT_DIR
+# This prevents nounset errors when running locally
+# https://docs.ci.openshift.org/docs/architecture/step-registry/#available-environment-variables
+# https://docs.prow.k8s.io/docs/jobs/#job-environment-variables
+JOB_NAME="${JOB_NAME:-unknown-job}"
+TAG_NAME="${TAG_NAME:-}"
+OPENSHIFT_CI="${OPENSHIFT_CI:-false}"
+REPO_OWNER="${REPO_OWNER:-redhat-developer}"
+REPO_NAME="${REPO_NAME:-rhdh}"
+PULL_NUMBER="${PULL_NUMBER:-}"
+BUILD_ID="${BUILD_ID:-unknown-build}"
+RELEASE_BRANCH_NAME="${RELEASE_BRANCH_NAME:-main}"
+K8S_CLUSTER_TOKEN="${K8S_CLUSTER_TOKEN:-}"
+K8S_CLUSTER_URL="${K8S_CLUSTER_URL:-}"
+SHARED_DIR="${SHARED_DIR:-$DIR/shared_dir}"
+ARTIFACT_DIR="${ARTIFACT_DIR:-$DIR/artifact_dir}"
+mkdir -p "${SHARED_DIR}"
+mkdir -p "${ARTIFACT_DIR}"
+
 #ENVS and Vault Secrets
 HELM_CHART_VALUE_FILE_NAME="values_showcase.yaml"
 HELM_CHART_RBAC_VALUE_FILE_NAME="values_showcase-rbac.yaml"
@@ -162,6 +185,8 @@ KEYCLOAK_AUTH_REALM=$(cat /tmp/secrets/KEYCLOAK_AUTH_REALM)
 REGISTRY_REDHAT_IO_SERVICE_ACCOUNT_DOCKERCONFIGJSON=$(cat /tmp/secrets/REGISTRY_REDHAT_IO_SERVICE_ACCOUNT_DOCKERCONFIGJSON)
 
 IS_OPENSHIFT=""
+CONTAINER_PLATFORM=""
+CONTAINER_PLATFORM_VERSION=""
 
 GITHUB_OAUTH_APP_ID=$(cat /tmp/secrets/GITHUB_OAUTH_APP_ID)
 GITHUB_OAUTH_APP_SECRET=$(cat /tmp/secrets/GITHUB_OAUTH_APP_SECRET)

.ibm/pipelines/jobs/ocp-nightly.sh

@@ -35,7 +35,7 @@ run_runtime_config_change_tests() {
 }
 
 run_sanity_plugins_check() {
-  initiate_sanity_plugin_checks_deployment "${RELEASE_NAME}" "${NAME_SPACE_SANITY_PLUGINS_CHECK}"
   local sanity_plugins_url="https://${RELEASE_NAME}-developer-hub-${NAME_SPACE_SANITY_PLUGINS_CHECK}.${K8S_CLUSTER_ROUTER_BASE}"
+  initiate_sanity_plugin_checks_deployment "${RELEASE_NAME}" "${NAME_SPACE_SANITY_PLUGINS_CHECK}" "${sanity_plugins_url}"
   check_and_test "${RELEASE_NAME}" "${NAME_SPACE_SANITY_PLUGINS_CHECK}" "${sanity_plugins_url}"
 }

.ibm/pipelines/openshift-ci-tests.sh

@@ -1,114 +1,126 @@
 #!/bin/bash
 
-set -e
+set -o errexit
+set -o errtrace
+set -o nounset
 export PS4='[$(date "+%Y-%m-%d %H:%M:%S")] ' # logs timestamp for every cmd.
 
-# Define log file names and directories.
-LOGFILE="test-log"
-export DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
-export CURRENT_DEPLOYMENT=0 # Counter for current deployment.
-export STATUS_DEPLOYMENT_NAMESPACE # Array that holds the namespaces of deployments.
-export STATUS_FAILED_TO_DEPLOY # Array that indicates if deployment failed. false = success, true = failure
-export STATUS_TEST_FAILED # Array that indicates if test run failed. false = success, true = failure
+DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
+export DIR
+
+export OPENSHIFT_CI="${OPENSHIFT_CI:-false}"
+if [[ -z "${OPENSHIFT_CI}" || "${OPENSHIFT_CI}" == "false" ]]; then
+  # NOTE: Use this file to override the environment variables for the local testing.
+  echo "Sourcing env_override.local.sh"
+  # shellcheck source=.ibm/pipelines/env_override.local.sh
+  source "${DIR}/env_override.local.sh"
+fi
+
+echo "Sourcing env_variables.sh"
+# shellcheck source=.ibm/pipelines/env_variables.sh
+source "${DIR}/env_variables.sh"
 
 echo "Sourcing reporting.sh"
 # shellcheck source=.ibm/pipelines/reporting.sh
 source "${DIR}/reporting.sh"
 save_overall_result 0 # Initialize overall result to 0 (success).
-export OVERALL_RESULT
 
 # Define a cleanup function to be executed upon script exit.
-# shellcheck disable=SC2317
-cleanup() {
-  if [[ $? -ne 0 ]]; then
-
-    echo "Exited with an error, setting OVERALL_RESULT to 1"
-    save_overall_result 1
-  fi
-  echo "Cleaning up before exiting"
-  if [[ "${OPENSHIFT_CI}" == "true" ]]; then
-    case "$JOB_NAME" in
-      *gke*)
-        echo "Calling cleanup_gke"
-        cleanup_gke
-        ;;
-    esac
-  fi
-  rm -rf ~/tmpbin
-}
-
+source "${DIR}/cleanup.sh"
 trap cleanup EXIT INT ERR
 
-SCRIPTS=(
-  "utils.sh"
-  "env_variables.sh"
-  "clear-database.sh"
-)
-
-# Source explicitly specified scripts
-for SCRIPT in "${SCRIPTS[@]}"; do
-  source "${DIR}/${SCRIPT}"
-  echo "Loaded ${SCRIPT}"
-done
+echo "Sourcing utils.sh"
+# shellcheck source=.ibm/pipelines/utils.sh
+source "${DIR}/utils.sh"
 
-# Source all scripts in jobs directory
-for SCRIPT in "${DIR}"/jobs/*.sh; do
-  if [ -f "$SCRIPT" ]; then
-    source "$SCRIPT"
-    echo "Loaded ${SCRIPT}"
-  fi
-done
+echo "Sourcing clear-database.sh"
+# shellcheck source=.ibm/pipelines/clear-database.sh
+source "${DIR}/clear-database.sh"
 
 main() {
   echo "Log file: ${LOGFILE}"
   echo "JOB_NAME : $JOB_NAME"
 
   CHART_VERSION=$(get_chart_version "$CHART_MAJOR_VERSION")
   export CHART_VERSION
-  detect_ocp_and_set_env_var
+  detect_ocp
+  detect_container_platform
 
   case "$JOB_NAME" in
     *aks-helm*)
+      echo "Sourcing aks-helm.sh"
+      # shellcheck source=.ibm/pipelines/jobs/aks-helm.sh
+      source "${DIR}/jobs/aks-helm.sh"
       echo "Calling handle_aks_helm"
       handle_aks_helm
       ;;
     *aks-operator*)
-      echo "Calling handle_aks_helm"
+      echo "Sourcing aks-operator.sh"
+      # shellcheck source=.ibm/pipelines/jobs/aks-operator.sh
+      source "${DIR}/jobs/aks-operator.sh"
+      echo "Calling handle_aks_operator"
       handle_aks_operator
       ;;
     *eks-helm*)
+      echo "Sourcing eks-helm.sh"
+      # shellcheck source=.ibm/pipelines/jobs/eks-helm.sh
+      source "${DIR}/jobs/eks-helm.sh"
       echo "Calling handle_eks_helm"
       handle_eks_helm
       ;;
     *eks-operator*)
+      echo "Sourcing eks-operator.sh"
+      # shellcheck source=.ibm/pipelines/jobs/eks-operator.sh
+      source "${DIR}/jobs/eks-operator.sh"
       echo "Calling handle_eks_operator"
       handle_eks_operator
       ;;
     *e2e-tests-auth-providers-nightly)
+      echo "Sourcing auth-providers.sh"
+      # shellcheck source=.ibm/pipelines/jobs/auth-providers.sh
+      source "${DIR}/jobs/auth-providers.sh"
       echo "Calling handle_auth_providers"
       handle_auth_providers
       ;;
     *gke-helm*)
+      echo "Sourcing gke-helm.sh"
+      # shellcheck source=.ibm/pipelines/jobs/gke-helm.sh
+      source "${DIR}/jobs/gke-helm.sh"
       echo "Calling handle_gke_helm"
       handle_gke_helm
       ;;
     *gke-operator*)
+      echo "Sourcing gke-operator.sh"
+      # shellcheck source=.ibm/pipelines/jobs/gke-operator.sh
+      source "${DIR}/jobs/gke-operator.sh"
       echo "Calling handle_gke_operator"
       handle_gke_operator
       ;;
     *operator*)
+      echo "Sourcing ocp-operator.sh"
+      # shellcheck source=.ibm/pipelines/jobs/ocp-operator.sh
+      source "${DIR}/jobs/ocp-operator.sh"
       echo "Calling handle_ocp_operator"
       handle_ocp_operator
       ;;
     *upgrade*)
+      echo "Sourcing upgrade.sh"
+      # shellcheck source=.ibm/pipelines/jobs/upgrade.sh
+      source "${DIR}/jobs/upgrade.sh"
       echo "Calling helm upgrade"
       handle_ocp_helm_upgrade
       ;;
     *nightly*)
+      echo "Sourcing ocp-nightly.sh"
+      # shellcheck source=.ibm/pipelines/jobs/ocp-nightly.sh
+      source "${DIR}/jobs/ocp-nightly.sh"
       echo "Calling handle_ocp_nightly"
       handle_ocp_nightly
       ;;
     *pull*)
+      echo "Sourcing ocp-pull.sh"
+      # shellcheck source=.ibm/pipelines/jobs/ocp-pull.sh
+      source "${DIR}/jobs/ocp-pull.sh"
       echo "Calling handle_ocp_pull"
       handle_ocp_pull
       ;;
@@ -121,7 +133,6 @@ main() {
 
   echo "Main script completed with result: ${OVERALL_RESULT}"
   exit "${OVERALL_RESULT}"
-
 }
 
 main