acceptance.sh

#!/bin/bash -e
#
# Copyright The Helm Authors.
#
# 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.

# Turn on debug printouts if the user requested a debug level >= $1
set_shell_debug_level()
{
    set +x
    if [ $ROBOT_DEBUG_LEVEL -ge $1 ]; then
       set -x
    fi
}
export -f set_shell_debug_level

export ROBOT_DEBUG_LEVEL="${ROBOT_DEBUG_LEVEL:-0}"
if [ ${ROBOT_DEBUG_LEVEL} -lt 0 ] || [ ${ROBOT_DEBUG_LEVEL} -gt 3 ]; then
   echo "If set, ROBOT_DEBUG_LEVEL must be between 0 and 3."
   echo "0 - None, 1 - Low, 2 - Medium, 3 - High"
   echo "Currently ROBOT_DEBUG_LEVEL=${ROBOT_DEBUG_LEVEL}"
   exit 1
fi

set_shell_debug_level 2
REQUIRED_SYSTEM_COMMANDS=(
    "kubectl"
    "python3"
    "pip"
    "virtualenv"
)

if [ "$CLUSTER_PROVIDER" == kind ]; then
   REQUIRED_SYSTEM_COMMANDS+=(kind)
fi

set_shell_debug_level 3
for C in ${REQUIRED_SYSTEM_COMMANDS[@]}; do
    if [[ ! -x "$(command -v ${C})" ]]; then
        echo "System command missing: $C"
        exit 1
    fi
done

set_shell_debug_level 2
DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
cd $DIR/../

# Acceptance test configurables
ROBOT_PY_REQUIRES="${ROBOT_PY_REQUIRES:-robotframework==3.1.2}"
export ROBOT_OUTPUT_DIR="${ROBOT_OUTPUT_DIR:-${PWD}/.acceptance}"
ROBOT_VENV_DIR="${ROBOT_VENV_DIR:-${ROBOT_OUTPUT_DIR}/.venv}"

set_shell_debug_level 3
echo "=============================================================================="
echo "Available configuration variables:"
echo "ROBOT_DEBUG_LEVEL - Choose debug level (0 to 3)."
echo "                    Current: ${ROBOT_DEBUG_LEVEL}"
echo "ROBOT_HELM_PATH   - The directory where the helm to test can be found."
echo "                    Current: ${ROBOT_HELM_PATH:-Helm as found on \$PATH: $(dirname $(which helm))}/helm"
echo "ROBOT_RUN_TESTS   - Comma-separated list of *.robot files to execute."
echo "                    Current: ${ROBOT_RUN_TESTS:-unset (all)}"
echo "ROBOT_OUTPUT_DIR  - The output directory for robot to use."
echo "                    Current: ${ROBOT_OUTPUT_DIR}"
echo "ROBOT_VENV_DIR    - The directory to be used for virtualenv."
echo "                    Current: ${ROBOT_VENV_DIR}"
echo "ROBOT_PY_REQUIRES - Space-separated list of python packages to install (including the robot framework)."
echo "                    Current: ${ROBOT_PY_REQUIRES}"
echo "ROBOT_OPTS        - Additional robot cli parameters."
echo "                    Current: ${ROBOT_OPTS}"
echo "=============================================================================="
set_shell_debug_level 2

# Only use the -d flag for mktemp as many other flags don't
# work on every plateform
mkdir -p ${ROBOT_OUTPUT_DIR}
export TMP_DIR="$(mktemp -d ${ROBOT_OUTPUT_DIR}/helm-acceptance.XXXXXX)"
trap "rm -rf ${TMP_DIR}" EXIT

SUITES_TO_RUN=""
# Allow to specify which test suites to run in a space-separated or comma-separated list
for suite in ${ROBOT_RUN_TESTS/,/ }; do
   SUITES_TO_RUN+="testsuites/${suite} "
done
# If no suites was specified, default to all
SUITES_TO_RUN=${SUITES_TO_RUN:-testsuites}

# Setup acceptance test environment:
#
#   - fresh Helm Home at .acceptance/.helm/
#   - Python virtualenv at .acceptance/.venv/ (cached if already fetched)
#
if [ ! -z "${ROBOT_HELM_PATH}" ]; then
   export PATH="${ROBOT_HELM_PATH}:${PATH}"
fi
export PATH="${ROBOT_VENV_DIR}/bin:${PATH}:${PWD}/scripts/cluster_providers"

export XDG_CACHE_HOME=${TMP_DIR}/cache && mkdir -p ${XDG_CACHE_HOME}
export XDG_CONFIG_HOME=${TMP_DIR}/config && mkdir -p ${XDG_CONFIG_HOME}
export XDG_DATA_HOME=${TMP_DIR}/data && mkdir -p ${XDG_DATA_HOME}

# We fully support helm v3 and partially support helm v2 at this time.
# To figure out which version of helm is used, we run 'helm version'
# with the -c flag which is only supported in helm v2; if we get an
# error, it means we are running helm v3, if we don't get an error,
# it's helm v2. We want to use the -c flag because if
# we end up on helm v2 and we don't have that flag, it will try to
# contact the cluster, which may not be accessible, and the command
# will timeout.
set_shell_debug_level 3
if helm version -c --tls &> /dev/null; then
    echo "===================="
    echo "Running with Helm v2"
    echo "===================="
    unset ROBOT_HELM_V3
else
    echo "===================="
    echo "Running with Helm v3"
    echo "===================="
    export ROBOT_HELM_V3=1
fi

set_shell_debug_level 2
if [[ ! -d ${ROBOT_VENV_DIR} ]]; then
    virtualenv -p $(which python3) ${ROBOT_VENV_DIR}
    pip install ${ROBOT_PY_REQUIRES}
fi

# Run Robot Framework, output
robot --outputdir=${ROBOT_OUTPUT_DIR} ${ROBOT_OPTS} ${SUITES_TO_RUN}