run_docker_with_component_tests.sh

#!/usr/bin/env bash
set -xe

thisScriptDir="$( dirname "${BASH_SOURCE[0]}" )"
thisScriptDir="$( realpath "${thisScriptDir}" )"

shouldStartExternalServices=false

function shouldPassEnvVarToDocker () {
    envVarNameToCheck="$1"

    # Pass all the environment variables whose names start with ELASTIC_APM_
    if [[ ${envVarNameToCheck} == "ELASTIC_APM_"* ]]; then
        echo "true"
        return
    fi

    local envVarNamesToPassToDocker=(GITHUB_RELEASES_URL PACKAGE TYPE VERSION)

    for envVarNameToPassToDocker in "${envVarNamesToPassToDocker[@]}"
    do
        if [ "${envVarNameToCheck}" == "${envVarNameToPassToDocker}" ] ; then
            echo "true"
            return
        fi
    done

    echo "false"
}

function buildDockerEnvVarsCommandLinePart () {
    # $1 should be the name of the environment variable to hold the result
    # local -n makes `result' reference to the variable named by $1
    local -n result=$1
    result=()
    # Iterate over environment variables
    # The code is copied from https://stackoverflow.com/questions/25765282/bash-loop-through-variables-containing-pattern-in-name
    while IFS='=' read -r envVarName envVarValue ; do
        shouldPass=$(shouldPassEnvVarToDocker "${envVarName}")
        if [ "${shouldPass}" == "false" ] ; then
            continue
        fi
        echo "envVarValue: ${envVarValue}"
        # shellcheck disable=SC2116
        envVarValue=$(echo "${envVarValue}")
        echo "envVarValue: ${envVarValue}"
        result=("${result[@]}" -e "${envVarName}=${envVarValue}")
    done < <(env)
}

function doesTestsGroupNeedExternalServices () {
    if [ -z "${ELASTIC_APM_PHP_TESTS_GROUP}" ] ; then
        echo "true"
        return
    fi

    case "${ELASTIC_APM_PHP_TESTS_GROUP}" in
        'does_not_require_external_services')
                echo "false"
                return
                ;;
        'requires_external_services')
                echo "true"
                return
                ;;
        'smoke')
                echo "true"
                return
                ;;
        *)
                echo "Unknown tests group name: \`${ELASTIC_APM_PHP_TESTS_GROUP}\'"
                exit 1
                ;;
    esac
}

function onScriptExit () {
    if [ "${shouldStartExternalServices}" == "true" ] ; then
        "${thisScriptDir}/stop_external_services_for_component_tests.sh"
    fi
}

function main () {
    local dockerToRunImageName=${1:?}

    if [ -z "${ELASTIC_APM_PHP_TESTS_MATRIX_ROW}" ] ; then
        echo "ELASTIC_APM_PHP_TESTS_MATRIX_ROW environment variable should be set before calling ${BASH_SOURCE[0]}"
        exit 1
    fi

    source "${thisScriptDir}/unpack_package_lifecycle_test_matrix_row.sh" "${ELASTIC_APM_PHP_TESTS_MATRIX_ROW}"

    trap onScriptExit EXIT

    shouldStartExternalServices=$(doesTestsGroupNeedExternalServices)
    if [ "${shouldStartExternalServices}" == "true" ] ; then
        source "${thisScriptDir}/env_vars_for_external_services_for_component_tests.sh"
        "${thisScriptDir}/start_external_services_for_component_tests.sh"
    fi

    repoRootDir="$( realpath "${thisScriptDir}/.." )"

    buildDockerEnvVarsCommandLinePart dockerRunCmdLineArgs

    # Let the tests know that are being run inside a container
    dockerRunCmdLineArgs=("${dockerRunCmdLineArgs[@]}" -e "ELASTIC_APM_PHP_TESTS_IS_IN_CONTAINER=true")

    # ELASTIC_APM_PHP_TESTS_THIS_CONTAINER_IMAGE_NAME is used by tests to find container ID
    dockerRunCmdLineArgs=("${dockerRunCmdLineArgs[@]}" -e "ELASTIC_APM_PHP_TESTS_THIS_CONTAINER_IMAGE_NAME=${dockerToRunImageName}")

    if [ "${shouldStartExternalServices}" == "true" ] ; then
        dockerRunCmdLineArgs=("${dockerRunCmdLineArgs[@]}" "--network=elastic-apm-php-external-services-for-component-tests-net")
    fi

    dockerRunCmdLineArgs=("${dockerRunCmdLineArgs[@]}" -v /var/run/docker.sock:/var/run/docker.sock)
    dockerRunCmdLineArgs=("${dockerRunCmdLineArgs[@]}" -v "${repoRootDir}:/app")
    dockerRunCmdLineArgs=("${dockerRunCmdLineArgs[@]}" -w /app)

    # shellcheck disable=SC2154 # dockerRunCmdLineArgs is assigned by buildDockerEnvVarsCommandLinePart
    docker run --rm -w /app "${dockerRunCmdLineArgs[@]}" "$@"
}

main "$@"