run_tests.sh

#!/bin/bash
# Copyright 2019 Google LLC
#
# 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.

# `-e` enables the script to automatically fail when a command fails
# `-o pipefail` sets the exit code to the rightmost comment to exit with a non-zero
set -eo pipefail
# Enables `**` to include files nested inside sub-folders
shopt -s globstar

# If on kokoro, add btlr to the path
if [ -n "$KOKORO_GFILE_DIR" ]; then
  bltr_dir="$KOKORO_GFILE_DIR/v0.0.3/"
  chmod +x "${bltr_dir}"btlr
  export PATH="$PATH:$bltr_dir"
fi

DIFF_FROM=""

# `--only-diff-main` will only run tests on project changes on the
# last common commit from the main branch.
if [[ $* == *--only-diff-main* ]]; then
    set +e
    git diff --quiet "origin/main..." .kokoro/tests .kokoro/docker \
	.kokoro/trampoline_v2.sh
    CHANGED=$?
    set -e
    if [[ "${CHANGED}" -eq 0 ]]; then
	DIFF_FROM="origin/main..."
    else
	echo "Changes to test driver files detected. Running full tests."
    fi
fi

# `--only-diff-head` will only run tests on project changes from the
# previous commit.
if [[ $* == *--only-diff-head* ]]; then
    set +e
    git diff --quiet "HEAD~.." .kokoro/tests .kokoro/docker \
	.kokoro/trampoline_v2.sh
    CHANGED=$?
    set -e
    if [[ "${CHANGED}" -eq 0 ]]; then
	DIFF_FROM="HEAD~.."
    else
	echo "Changes to test driver files detected. Running full tests."
    fi
fi

# Because Kokoro runs presubmit builds simalteneously, we often see
# quota related errors. I think we can avoid this by changing the
# order of tests to execute (e.g. reverse order for py-3.8
# build). Currently there's no easy way to do that with btlr, so we
# temporarily wait few minutes to avoid quota issue for some
# presubmit builds.
if [[ "${KOKORO_JOB_NAME}" == *presubmit ]] \
       && [[ -z "${DIFF_FROM:-}" ]]; then
    if [[ "${RUN_TESTS_SESSION}" == "py-3.7" ]]; then
	echo -n "Detected py-3.7 presubmit full build,"
	echo "Wait 5 minutes to avoid quota issues."
	sleep 5m
    fi
    if [[ "${RUN_TESTS_SESSION}" == "py-3.8" ]]; then
	echo -n "Detected py-3.8 presubmit full build,"
	echo "Wait 10 minutes to avoid quota issues."
	sleep 10m
    fi
fi

if [[ -z "${PROJECT_ROOT:-}" ]]; then
    PROJECT_ROOT="github/python-docs-samples"
fi

cd "${PROJECT_ROOT}"

# add user's pip binary path to PATH
export PATH="${HOME}/.local/bin:${PATH}"

# upgrade pip when needed
pip install --upgrade pip

# Install virtualenv in version 20.21, since version 20.22 no longer supports Python 2.7
if [[ "${RUN_TESTS_SESSION}" == "py-2.7" ]]; then
  pip install --user -q virtualenv==20.21
fi

# install nox for testing
pip install --user -q nox

# Use secrets acessor service account to get secrets
if [[ -f "${KOKORO_GFILE_DIR}/secrets_viewer_service_account.json" ]]; then
    gcloud auth activate-service-account \
	   --key-file="${KOKORO_GFILE_DIR}/secrets_viewer_service_account.json" \
	   --project="cloud-devrel-kokoro-resources"
fi

# On kokoro, we should be able to use the default service account. We
# need to somehow bootstrap the secrets on other CI systems.
if [[ "${TRAMPOLINE_CI}" == "kokoro" ]]; then
    # This script will create 5 files:
    # - testing/test-env.sh
    # - testing/service-account.json
    # - testing/client-secrets.json
    # - testing/cloudai-samples-secrets.sh
    # - testing/cloudsql-samples-secrets.sh
    ./scripts/decrypt-secrets.sh
fi

source ./testing/test-env.sh
source ./testing/cloudai-samples-secrets.sh
source ./testing/cloudsql-samples-secrets.sh
export GOOGLE_APPLICATION_CREDENTIALS=$(pwd)/testing/service-account.json

# For cloud-run session, we activate the service account for gcloud sdk.
gcloud auth activate-service-account \
       --key-file "${GOOGLE_APPLICATION_CREDENTIALS}"

export GOOGLE_CLIENT_SECRETS=$(pwd)/testing/client-secrets.json

# For Datalabeling samples to hit the testing endpoint
export DATALABELING_ENDPOINT="test-datalabeling.sandbox.googleapis.com:443"

# Run Cloud SQL proxy (background process exit when script does)
wget --quiet https://dl.google.com/cloudsql/cloud_sql_proxy.linux.amd64 \
     -O ${HOME}/cloud_sql_proxy && chmod +x ${HOME}/cloud_sql_proxy
${HOME}/cloud_sql_proxy -instances="${MYSQL_INSTANCE}"=tcp:3306,"${MYSQL_INSTANCE}" -dir "${HOME}" &>> \
       ${HOME}/cloud_sql_proxy.log &
echo -e "\Cloud SQL proxy started for MySQL."
${HOME}/cloud_sql_proxy -instances="${POSTGRES_INSTANCE}"=tcp:5432,"${POSTGRES_INSTANCE}" -dir "${HOME}" &>> \
       ${HOME}/cloud_sql_proxy-postgres.log &
echo -e "\Cloud SQL proxy started for Postgres."
${HOME}/cloud_sql_proxy -instances="${SQLSERVER_INSTANCE}"=tcp:1433 &>> \
       ${HOME}/cloud_sql_proxy-sqlserver.log &
echo -e "\Cloud SQL proxy started for SQL Server."

echo -e "\n******************** TESTING PROJECTS ********************"
# Switch to 'fail at end' to allow all tests to complete before exiting.
set +e
# Use RTN to return a non-zero value if the test fails.
RTN=0
ROOT=$(pwd)

# Setup DRIFT region tag injector
# (only run on *some* builds)
if [[ "${INJECT_REGION_TAGS:-}" == "true" ]]; then
    echo "=== Setting up DRIFT region tag injector ==="
    # install PyYaml (used by the DRIFT region tag parsing system)
    echo "--- Installing pip packages ---"
    python3 -m pip install --user pyyaml frozendict recordclass

    # Use ${HOME} because trampoline will automatically clean up this
    # directory.
    export REGION_TAG_PARSER_DIR="${HOME}/region-tag-parser"
    export POLYGLOT_PARSER_PATH="${REGION_TAG_PARSER_DIR}/xunit-autolabeler-v2/cli_bootstrap.py"
    export PYTHON_PARSER_PATH="${REGION_TAG_PARSER_DIR}/xunit-autolabeler-v2/ast_parser/python_bootstrap.py"

    if [[ ! -f $POLYGLOT_PARSER_PATH ]]; then
        echo "--- Fetching injection script from HEAD (via GitHub) ---"
        git clone https://github.com/GoogleCloudPlatform/repo-automation-playground "$REGION_TAG_PARSER_DIR" --single-branch

        chmod +x $PYTHON_PARSER_PATH
        chmod +x $POLYGLOT_PARSER_PATH
    fi
    echo "=== Region tag injector setup complete ==="
fi

test_prog="${PROJECT_ROOT}/.kokoro/tests/run_single_test.sh"

btlr_args=(
    "run"
    "--max-cmd-duration=60m"
    "**/requirements.txt"
)

if [[ -n "${NUM_TEST_WORKERS:-}" ]]; then
    btlr_args+=(
	"--max-concurrency"
	"${NUM_TEST_WORKERS}"
    )
fi

if [[ -n "${DIFF_FROM:-}"  ]]; then
    btlr_args+=(
	"--git-diff"
	"${DIFF_FROM} ."
    )
fi

btlr_args+=(
    "--"
    "${test_prog}"
)

echo "btlr" "${btlr_args[@]}"

btlr "${btlr_args[@]}"

RTN=$?
cd "$ROOT"

# Remove secrets if we used decrypt-secrets.sh.
if [[ -f "${KOKORO_GFILE_DIR}/secrets_viewer_service_account.json" ]]; then
    rm testing/{test-env.sh,client-secrets.json,service-account.json,cloudai-samples-secrets.sh,cloudsql-samples-secrets.sh}
fi

exit "$RTN"