Update scenario.sh script to run gingko tests

Author: Kasturi Narra

scripts/fetch_tools.sh

@@ -5,6 +5,10 @@ IFS=$'\n\t'
 
 ARCH="$(uname -m)"
 
+# Set GitHub token for private repository access
+GITHUB_TOKEN="$(cat /tmp/token-git 2>/dev/null || echo '')"
+export GITHUB_TOKEN
+
 SCRIPT_DIR="$(readlink -f "$(dirname "${BASH_SOURCE[0]}")")"
 ROOT_DIR=$(realpath "${SCRIPT_DIR}/..")
 DEFAULT_DEST_DIR="${ROOT_DIR}/_output/bin"
@@ -233,6 +237,63 @@ gettool_tar-diff() {
     done
 }
 
+gettool_ginkgo() {
+    # shellcheck source=test/bin/common.sh
+    source "${SCRIPT_DIR}/../test/bin/common.sh"
+    # shellcheck source=test/bin/common_versions.sh
+    source "${SCRIPT_DIR}/../test/bin/common_versions.sh"
+
+    local -r repo_url="${GINKGO_TESTS_REPO_URL}"
+    local -r binary_path="${GINKGO_TEST_BINARY}"
+    local -r release_branch="release-4.${MINOR_VERSION}"
+
+    # Skip if binary already exists
+    [[ -f "${binary_path}" ]] && return 0
+
+    # Check if Go is available
+    if ! command -v go &> /dev/null; then
+        echo "Error: Go is required to build openshift-tests-private binary"
+        return 1
+    fi
+
+    echo "Building openshift-tests-private binary"
+    # Ensure binary directory exists
+    mkdir -p "$(dirname "${binary_path}")"
+
+    # Use global WORK_DIR for cloning
+    local clone_dir="${WORK_DIR}/openshift-tests-private"
+
+    # Clone repository with release branch preference
+    echo "Cloning openshift-tests-private repository to temporary directory..."
+    if ! git clone --depth 1 --branch "${release_branch}" "${repo_url}" "${clone_dir}" 2>/dev/null; then
+        echo "Branch ${release_branch} not found, cloning default branch..."
+        if ! git clone --depth 1 "${repo_url}" "${clone_dir}"; then
+            echo "Error: Failed to clone repository"
+            return 1
+        fi
+    else
+        echo "Successfully cloned ${release_branch} branch"
+    fi
+
+    # Build the binary
+    pushd "${clone_dir}" &>/dev/null
+
+    local test_binary="./bin/extended-platform-tests"
+    go build -o "${test_binary}" ./cmd/extended-platform-tests
+
+    # Copy binary to centralized location
+    if [[ -f "${test_binary}" ]]; then
+        cp "${test_binary}" "${binary_path}"
+        chmod +x "${binary_path}"
+        echo "Binary installed to ${binary_path}"
+        popd &>/dev/null
+    else
+        echo "Error: Test binary not found after build"
+        popd &>/dev/null
+        return 1
+    fi
+}
+
 tool_getters=$(declare -F | awk '$3 ~ /^gettool_/ {print $3}' | sed 's/^gettool_//g')
 
 usage() {

test/bin/ci_phase_boot_and_test.sh

@@ -63,7 +63,7 @@ BOOT_TEST_JOB_LOG="${IMAGEDIR}/boot_test_jobs.txt"
 cd "${TESTDIR}"
 
 if [ ! -d "${RF_VENV}" ]; then
-    "${ROOTDIR}/scripts/fetch_tools.sh" robotframework
+    "${ROOTDIR}/scripts/fetch_tools.sh" robotframework ginkgo
 fi
 
 # Tell scenario.sh to merge stderr into stdout

test/bin/common.sh

@@ -25,6 +25,14 @@ KICKSTART_TEMPLATE_DIR="${TESTDIR}/kickstart-templates"
 # The location the web server should serve.
 export IMAGEDIR="${OUTPUTDIR}/test-images"
 
+GITHUB_TOKEN="$(cat /tmp/token-git 2>/dev/null || echo '')"
+export GITHUB_TOKEN
+
+# Ginkgo test binary and repository paths
+export GINKGO_TESTS_REPO_URL="https://${GITHUB_TOKEN}@github.com/openshift/openshift-tests-private.git"
+export GINKGO_TESTS_REPO_DIR="${OUTPUTDIR}/tools/openshift-tests-private"
+export GINKGO_TEST_BINARY="${OUTPUTDIR}/bin/extended-platform-tests"
+
 # The storage pool base name for VMs.
 # The actual pool names will be '${VM_POOL_BASENAME}-${SCENARIO}'.
 VM_POOL_BASENAME="vm-storage"

test/bin/scenario.sh

@@ -939,23 +939,33 @@ stress_testing() {
     fi
 }
 
-# Run the tests for the current scenario
-run_tests() {
-    local vmname="${1}"
-    local full_vmname
-    full_vmname="$(full_vm_name "${vmname}")"
+# Apply RUN_HOST_OVERRIDE logic if needed
+apply_host_override() {
+    local -r original_vmname="$1"
+    local vmname="${original_vmname}"
+
     if [[ -n "${RUN_HOST_OVERRIDE}" ]]; then
-	vmname="${RUN_HOST_OVERRIDE}"
-	full_vmname="$(full_vm_name "${vmname}")"
+        vmname="${RUN_HOST_OVERRIDE}"
+        local full_vmname
+        local ip
+        full_vmname="$(full_vm_name "${vmname}")"
         ip=$(get_vm_ip "${full_vmname}")
-	set_vm_property "${vmname}" "ip" "${ip}"
+        set_vm_property "${vmname}" "ip" "${ip}"
         set_vm_property "${vmname}" "ssh_port" "22"
         set_vm_property "${vmname}" "api_port" "6443"
         set_vm_property "${vmname}" "lb_port" "5678"
     fi
 
-    shift
+    echo "${vmname}"
+}
+
+# Run the tests for the current scenario
+run_tests() {
+    local vmname="${1}"
+    # Handle RUN_HOST_OVERRIDE
+    vmname=$(apply_host_override "${vmname}")
 
+    shift
     echo "Running tests with $# args" "$@"
 
     if [ ! -d "${RF_VENV}" ]; then
@@ -1016,6 +1026,7 @@ run_tests() {
         local -r api_port=$(get_vm_property "${vmname}" "api_port")
         local -r lb_port=$(get_vm_property "${vmname}" "lb_port")
         local -r vm_ip=$(get_vm_property "${vmname}" "ip")
+        local -r full_vmname="$(full_vm_name "${vmname}")"
 
         local variable_file="${SCENARIO_INFO_DIR}/${SCENARIO}/variables.yaml"
         echo "Writing variables to ${variable_file}"
@@ -1069,6 +1080,76 @@ EOF
     fi
 }
 
+# Implementation of Gingko tests
+run_gingko_tests() {
+    local vmname="${1}"
+    shift
+
+    # Handle RUN_HOST_OVERRIDE
+    vmname=$(apply_host_override "${vmname}")
+
+    # Save current directory
+    pushd . &>/dev/null
+
+    # Check/install oc
+    "${ROOTDIR}/scripts/fetch_tools.sh" "oc" || {
+        record_junit "${vmname}" "oc_installed" "FAILED"
+        exit 1
+    }
+
+    # Check/get openshift-tests-binary
+    if ! "${ROOTDIR}/scripts/fetch_tools.sh" "ginkgo"; then
+        record_junit "${vmname}" "build_test_binary" "FAILED"
+        exit 1
+    fi
+    record_junit "${vmname}" "build_test_binary" "OK"
+
+    # Set up test environment variables
+    local -r KUBECONFIG="${SCENARIO_INFO_DIR}/${SCENARIO}/kubeconfig"
+    local -r test_results_dir="${SCENARIO_INFO_DIR}/${SCENARIO}/gingko-results"
+    mkdir -p "${test_results_dir}"
+
+    # Set up kubeconfig for tests
+    local -r vm_ip=$(get_vm_property "${vmname}" "ip")
+    local -r ssh_port=$(get_vm_property "${vmname}" "ssh_port")
+    local -r full_vmname="$(full_vm_name "${vmname}")"
+    local -r vm_hostname="${full_vmname/./-}"
+
+    # Debug: Find all kubeconfig files on VM
+    echo "Searching for kubeconfig files on VM..."
+    run_command_on_vm "${vmname}" "find . -name kubeconfig"
+    run_command_on_vm "${vmname}" "sudo find / -name kubeconfig"
+
+    # Copy kubeconfig to accessible location and then scp it
+    echo "Getting kubeconfig from VM..."
+    run_command_on_vm "${vmname}" "sudo cp /var/lib/microshift/resources/kubeadmin/${vm_ip}/kubeconfig /tmp/kubeconfig && sudo chown redhat:redhat /tmp/kubeconfig"
+    scp -P "${ssh_port}" "redhat@${vm_ip}:/tmp/kubeconfig" "${KUBECONFIG}"
+    run_command_on_vm "${vmname}" "rm -f /tmp/kubeconfig"  # cleanup
+    echo "Successfully got kubeconfig from VM"
+    export KUBECONFIG="${KUBECONFIG}"
+    record_junit "${vmname}" "setup_kubeconfig" "OK"
+
+    # Run the Gingko tests with MicroShift filter
+    echo "Running Gingko tests with MicroShift filter..."
+
+    # Run the tests and capture output
+    if ! "${GINKGO_TEST_BINARY}" run all --dry-run | grep "MicroShift" | "${GINKGO_TEST_BINARY}" run -f - --timeout 60m 2>&1 | tee "${test_results_dir}/test-output.log"; then
+        echo "Some Gingko tests may have failed. Check results for details."
+        record_junit "${vmname}" "run_gingko_tests" "FAILED"
+        return 1
+    fi
+
+    record_junit "${vmname}" "run_gingko_tests" "OK"
+    popd &>/dev/null
+
+    # Display results summary
+    echo "Gingko test execution completed"
+    echo "Results are available in: ${test_results_dir}"
+    if [[ -f "${test_results_dir}/test-output.log" ]]; then
+        echo "Test output log: ${test_results_dir}/test-output.log"
+    fi
+}
+
 load_global_settings() {
     local filename="${TESTDIR}/scenario_settings.sh"
     if [ ! -f "${filename}" ]; then
@@ -1224,11 +1305,10 @@ action_run() {
 
     if [ $# -eq 0 ]; then
         RUN_HOST_OVERRIDE=""
-	check_dependencies
+        check_dependencies
     else
         RUN_HOST_OVERRIDE="$1"
     fi
-
     scenario_run_tests
     record_junit "run" "scenario_run_tests" "OK"
 }

test/scenarios-bootc/releases/[email protected]

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+# Sourced from scenario.sh and uses functions defined there.
+
+scenario_create_vms() {
+    prepare_kickstart host1 kickstart-bootc.ks.template "rhel96-bootc-brew-${LATEST_RELEASE_TYPE}-with-optional"
+    launch_vm --boot_blueprint rhel96-bootc
+}
+
+scenario_remove_vms() {
+    remove_vm host1
+}
+
+scenario_run_tests() {
+    run_gingko_tests host1
+}

test/scenarios/releases/[email protected]

@@ -0,0 +1,16 @@
+#!/bin/bash
+
+# Sourced from scenario.sh and uses functions defined there.
+
+scenario_create_vms() {
+    prepare_kickstart host1 kickstart.ks.template "rhel-9.6-microshift-brew-optionals-4.${MINOR_VERSION}-${LATEST_RELEASE_TYPE}"
+    launch_vm
+}
+
+scenario_remove_vms() {
+    remove_vm host1
+}
+
+scenario_run_tests() {
+    run_gingko_tests host1
+}