run-tests.sh

#!/bin/bash
# Copyright 2021 Couchbase, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file  except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the  License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

set -eo pipefail

SCRIPT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" >/dev/null 2>&1 && pwd )"

export HELPERS_ROOT="${SCRIPT_DIR}"
export TEST_ROOT="${SCRIPT_DIR}/tests"
export HELPERS_ROOT="${SCRIPT_DIR}/helpers/"
export RESOURCES_ROOT="${SCRIPT_DIR}/resources/"

export BATS_FORMATTER=${BATS_FORMATTER:-tap}
export BATS_ROOT=${BATS_ROOT:-$SCRIPT_DIR/tools/bats}
export BATS_ARGS=${BATS_ARGS:---timing --verbose-run}
export BATS_JOBS_PARAMS=${BATS_JOBS_PARAMS:---jobs 8 --no-parallelize-within-files}

export BATS_FILE_ROOT=$BATS_ROOT/lib/bats-file
export BATS_SUPPORT_ROOT=$BATS_ROOT/lib/bats-support
export BATS_ASSERT_ROOT=$BATS_ROOT/lib/bats-assert
export BATS_DETIK_ROOT=$BATS_ROOT/lib/bats-detik

export FLUENTBIT_IMAGE_REPOSITORY=${FLUENTBIT_IMAGE_REPOSITORY:-ghcr.io/fluent/fluent-bit}
export FLUENTBIT_IMAGE_TAG=${FLUENTBIT_IMAGE_TAG:-latest}

export ELASTICSEARCH_IMAGE_REPOSITORY=${ELASTICSEARCH_IMAGE_REPOSITORY:-elasticsearch}
export ELASTICSEARCH_IMAGE_TAG=${ELASTICSEARCH_IMAGE_TAG:-7.17.3}

export OPENSEARCH_IMAGE_REPOSITORY=${OPENSEARCH_IMAGE_REPOSITORY:-opensearchproject/opensearch}
export OPENSEARCH_IMAGE_TAG=${OPENSEARCH_IMAGE_TAG:-1.3.0}

export HELM_VALUES_EXTRA_FILE=${HELM_VALUES_EXTRA_FILE:-"$TEST_ROOT/defaults/values.yaml.tpl"}
export HELM_IMAGE_PULL_POLICY=${HELM_IMAGE_PULL_POLICY:-Always}

export HOSTED_OPENSEARCH_HOST=${HOSTED_OPENSEARCH_HOST:-"localhost"}
export HOSTED_OPENSEARCH_PORT=${HOSTED_OPENSEARCH_PORT:-"443"}
export HOSTED_OPENSEARCH_USERNAME=${HOSTED_OPENSEARCH_USERNAME:-"admin"}
export HOSTED_OPENSEARCH_PASSWORD=${HOSTED_OPENSEARCH_PASSWORD:-"admin"}

# shellcheck disable=SC1091
source "$HELPERS_ROOT/test-helpers.bash"

# Helper function to run a set of tests based on our specific configuration
# This function will call `exit`, so any cleanup must be done inside it.
function run_tests() {
    local requested=$1
    local run="--verbose-run"

    if [[ "$requested" == "all" ]] || [ -z "$requested" ]; then
        # Empty => everything. Alternatively, explicitly ask for it.
        run="--recursive ${TEST_ROOT}/"
    elif [[ "$requested" =~ .*\.bats$ ]]; then
        # One individual test
        run="$requested"
    elif [ -d "${TEST_ROOT}/$requested" ]; then
        # Likely an individual integration suite
        run="--recursive ${TEST_ROOT}/$requested"
    fi

    echo
    echo
    echo "========================"
    echo "Starting tests."
    echo "========================"
    echo
    echo "Fluentbit repository: ${FLUENTBIT_IMAGE_REPOSITORY} - tag: ${FLUENTBIT_IMAGE_TAG}"
    echo
    echo

    # If TEST_NAMESPACE is not set (the default), we run jobs in parallel
    # otherwise, if it is set we can only run 1 job at a time and need to remove
    # all BATS_JOBS_PARAMS
    if [[ -n "${TEST_NAMESPACE:-}" ]]; then
        BATS_JOBS_PARAMS=""
    fi

    # We run BATS in a subshell to prevent it from inheriting our exit/err trap, which can mess up its internals
    # We set +exu because unbound variables can cause test failures with zero context
    set +xeu
    # shellcheck disable=SC2086
    (bats $BATS_JOBS_PARAMS --formatter "${BATS_FORMATTER}" $run $BATS_ARGS)
    local bats_retval=$?

    echo
    echo
    echo "========================"
    if [ "$bats_retval" -eq 0 ]; then
        echo "All tests passed!"
    else
        echo "Some tests failed. Please inspect the output above for details."
    fi
    echo "========================"
    echo
    echo
    exit $bats_retval
}

if [[ "${SKIP_BATS:-no}" != "yes" ]]; then
    # No point shell checking it as done separately anyway
    # shellcheck disable=SC1091
    /bin/bash "${SCRIPT_DIR}/tools/install-bats.sh"
fi

run_tests "$@"