path: root/lkft/lava-job-definitions/submit_for_testing-v2.sh

#!/bin/bash -ex

echo "For Test purpose check 1: LKFT_WORK_DIR=${LKFT_WORK_DIR}"
export LKFT_WORK_DIR=${LKFT_WORK_DIR:-"/home/buildslave/srv/${BUILD_DIR}/workspace"}
echo "For Test purpose check 2: LKFT_WORK_DIR=${LKFT_WORK_DIR}"
cd ${LKFT_WORK_DIR}

F_ABS_PATH=$(readlink -e $0)
OPT_DRY_RUN=""
if [ -n "${ENV_DRY_RUN}" ]; then
    OPT_DRY_RUN="--dry-run"
fi

function exit_with_msg(){
    echo "$@"
    exit
}

function check_environments(){
    # environments must be defined in build config
    # following environments no need to be exported as they only used for here.
    [ -z "${TEST_DEVICE_TYPE}" ] && exit_with_msg "TEST_DEVICE_TYPE is required to be defined."
    [ -z "${TEST_LAVA_SERVER}" ] && exit_with_msg "TEST_LAVA_SERVER is required to be defined."
    [ -z "${TEST_QA_SERVER}" ] && exit_with_msg "TEST_QA_SERVER is required to be defined."
    [ -z "${TEST_QA_SERVER_PROJECT}" ] && exit_with_msg "TEST_QA_SERVER_PROJECT is required to be defined."

    # following environments must be exported as they will be used in the job templates.
    [ -z "${ANDROID_VERSION}" ] && exit_with_msg "ANDROID_VERSION is required to be defined."
    [ -z "${KERNEL_BRANCH}" ] && exit_with_msg "KERNEL_BRANCH is required to be defined."
    [ -z "${KERNEL_REPO}" ] && exit_with_msg "KERNEL_REPO is required to be defined."
    [ -z "${TEST_METADATA_TOOLCHAIN}" ] && exit_with_msg "TEST_METADATA_TOOLCHAIN is required to be defined."
    [ -z "${TEST_VTS_URL}" ] && exit_with_msg "TEST_VTS_URL is required to be defined."
    [ -z "${TEST_CTS_URL}" ] && exit_with_msg "TEST_CTS_URL is required to be defined."
    [ -z "${REFERENCE_BUILD_URL}" ] && exit_with_msg "REFERENCE_BUILD_URL is required to be defined."

    [ -z "${PUBLISH_FILES}" ] && exit_with_msg "PUBLISH_FILES is required to be defined."

    return 0
}

function get_value_from_config_file(){
    local key=$1 && shift
    local f_config=$1 && shift

    local key_line=$(grep "^${key}=" "${LKFT_WORK_DIR}/android-build-configs/lkft/${f_config}"|tail -n1|tr -d '"')
    if [ -z "${key_line}" ]; then
        return
    fi
    local value=$(echo "${key_line}"|cut -d= -f2-)
    if [ -z "${value}" ]; then
        return
    else
        echo "${value}"
    fi
}

function submit_build_result(){
    local qareport_url="${1}"
    if ! grep "#${qareport_url}#" ${f_qareport_urls}; then
        curl --header "Auth-Token: ${QA_REPORTS_TOKEN}" --form tests='{"build_process/build": "pass"}' ${qareport_url}
        echo "#${qareport_url}#" >> ${f_qareport_urls}
    fi
}

function update_device_template(){
    local f_device_template="${1}" && shift
    local f_img_name="${1}" && shift
    local build_config="${1}" && shift
    local referece_build_url="${1}" && shift

    if [ "X${f_img_name}X" = "Xprm_ptable.imgX" ]; then
        ## special case for hikey960 prm_ptable.img,
        ## as for the aosp master, we need to use new prm_ptable to support the super image
        local default_hikey960_prm_table_url="https://images.validation.linaro.org/snapshots.linaro.org/96boards/reference-platform/components/uefi-staging/85/hikey960/release/prm_ptable.img"
        sed -i "s|${default_hikey960_prm_table_url}|{{DOWNLOAD_URL}}/${f_img_name}|" "${f_device_template}"
    fi

    if [ "X${f_img_name}X" = "Xgpt_both0.binX" ]; then
        ## special case for db845c gpt_both0.bin
        ## as for the aosp master, we need to use the proper gpt_both0.bin for the correct partitions
        local default_db845c_aosp_gpu_url="https://images.validation.linaro.org/snapshots.linaro.org/96boards/dragonboard845c/linaro/rescue/69/dragonboard-845c-bootloader-ufs-aosp-69/gpt_both0.bin"
        sed -i "s|${default_db845c_aosp_gpu_url}|{{DOWNLOAD_URL}}/${f_img_name}|" "${f_device_template}"
    fi

    # DOWNLOAD_URL is where the generated files stored
    # replace REFERENCE_BUILD_URL with DOWNLOAD_URL
    sed -i "s|{{REFERENCE_BUILD_URL}}/${f_img_name}|{{DOWNLOAD_URL}}/${f_img_name}|" "${f_device_template}"
    # replace file name in job template with new file name generated
    sed -i "s|{{DOWNLOAD_URL}}/${f_img_name}|{{DOWNLOAD_URL}}/${build_config}-${f_img_name}|" "${f_device_template}"
    # replace the file name in the deploy action that use "downloads://" url
    local f_no_xz=$(echo ${f_img_name}|sed "s|.xz$||")
    sed -i "s|downloads://${f_no_xz}|downloads://${build_config}-${f_no_xz}|" "${f_device_template}"

    # special case for android 8.1 version, which does not support vendor partition yet
    if ! echo "${f_img_name}" | grep vendor; then
        # only need to check for the case that when no vendor.img generated
        # and not vendor.img with the REFERENCE_BUILD
        if curl --output /dev/null --silent --head --fail "${referece_build_url}/vendor.img.xz"; then
            echo "This reference build comes with a vendor partition"
        else
            echo "No vendor partition for the reference build, so flashing cache partition from the job instead"
            sed -i "s|vendor.img.xz|cache.img.xz|g" "${f_device_template}"
        fi
    fi
}

function download_fingerprint(){
    local fingerprint_url="${1}"
    local fingerprint_name="${2}"
    if ! wget "${fingerprint_url}" -O "${fingerprint_name}"; then
        rm -f "${fingerprint_name}"
        touch "${fingerprint_name}"
    fi
}

function submit_jobs_for_config(){
    local build_config=$1 && shift

    local f_qareport_urls="qareport_url.txt"
    [ -z "${DEFAULT_TEST_LAVA_JOB_PRIORITY}" ] && DEFAULT_TEST_LAVA_JOB_PRIORITY="medium"

    # clean environments
    unset TEST_DEVICE_TYPE TEST_LAVA_SERVER TEST_QA_SERVER TEST_QA_SERVER_TEAM TEST_QA_SERVER_PROJECT TEST_QA_SERVER_ENVIRONMENT
    unset ANDROID_VERSION KERNEL_BRANCH KERNEL_REPO TEST_METADATA_TOOLCHAIN TEST_VTS_URL TEST_CTS_URL REFERENCE_BUILD_URL ANDROID_VENDOR_FINGERPRINT
    unset PUBLISH_FILES TEST_OTHER_PLANS TEST_TEMPLATES_TYPE TEST_LAVA_JOB_GROUP TEST_LAVA_JOB_PRIORITY
    unset IMAGE_SUPPORTED_CACHE IMAGE_SUPPORTED_VENDOR_BOOT
    unset HIKEY960_SUPPORT_SUPER

    # the config file should be in the directory of android-build-configs/lkft
    # or copied to there by the linaro-lkft.sh build
    source ${LKFT_WORK_DIR}/android-build-configs/lkft/${build_config}

    if [ -z "${TEST_METADATA_TOOLCHAIN}" ]; then
        source ${LKFT_WORK_DIR}/out/${build_config}/misc_info.txt
        if [ -n "${GKI_KERNEL_CLANG_VER}" ]; then
            TEST_METADATA_TOOLCHAIN=${GKI_KERNEL_CLANG_VER}
        elif [ -n "${VENDOR_KERNEL_CLANG_VER}" ]; then
            TEST_METADATA_TOOLCHAIN=${VENDOR_KERNEL_CLANG_VER}
        fi
    fi
    check_environments
    [ -z "${TEST_LAVA_JOB_GROUP}" ] && TEST_LAVA_JOB_GROUP=lkft
    [ -n "${TEST_LAVA_JOB_PRIORITY}" ] && DEFAULT_TEST_LAVA_JOB_PRIORITY="${TEST_LAVA_JOB_PRIORITY}"
    [ -z "${TEST_LAVA_JOB_PRIORITY}" ] && TEST_LAVA_JOB_PRIORITY="${DEFAULT_TEST_LAVA_JOB_PRIORITY}"
    [ -n "${HIKEY960_SUPPORT_SUPER}" ] && export HIKEY960_SUPPORT_SUPER
    export TEST_LAVA_JOB_GROUP TEST_LAVA_JOB_PRIORITY
    export ANDROID_VERSION KERNEL_BRANCH KERNEL_REPO TEST_METADATA_TOOLCHAIN TEST_VTS_URL TEST_CTS_URL REFERENCE_BUILD_URL
    TEST_VTS_VERSION=$(echo "${TEST_VTS_URL}" | tr -s '/' | sed 's|/$||' | awk -F"/" '{print$(NF)}')
    TEST_CTS_VERSION=$(echo "${TEST_CTS_URL}" | tr -s '/' | sed 's|/$||' | awk -F"/" '{print$(NF)}')

    if echo "${TEST_VTS_URL}"|grep '/aosp-master-throttled/'; then
        # for aosp master cts/vts packages
        build_number_vts=$(echo "${TEST_VTS_URL}" | tr -s '/' | sed 's|/$||' | awk -F"/" '{print$(NF-1)}')
        TEST_VTS_VERSION="aosp-master-throttled#${build_number_vts}"
    elif echo "${TEST_VTS_URL}"|grep '/protected/'; then
        # for EAP cts/vts packages
        f_fingerprint_vts="build_fingerprint_vts.txt"
        download_fingerprint "${TEST_VTS_URL}/build_fingerprint.txt" "${f_fingerprint_vts}"
        fingerprint_vts=$(cut -d: -f2 "${f_fingerprint_vts}")
        if [ -n "${f_fingerprint_vts}" ]; then
            TEST_VTS_VERSION="EAP-Android12#${fingerprint_vts}"
        fi
    fi

    if echo "${TEST_CTS_URL}"|grep '/aosp-master-throttled/'; then
        build_number_cts=$(echo "${TEST_CTS_URL}" | tr -s '/' | sed 's|/$||' | awk -F"/" '{print$(NF-1)}')
        TEST_CTS_VERSION="aosp-master-throttled#${build_number_cts}"
    elif echo "${TEST_CTS_URL}"|grep '/protected/'; then
        f_fingerprint_cts="build_fingerprint_cts.txt"
        download_fingerprint "${TEST_CTS_URL}/build_fingerprint.txt" "${f_fingerprint_cts}"
        fingerprint_cts=$(cut -d: -f2 "${f_fingerprint_cts}")
        if [ -n "${f_fingerprint_cts}" ]; then
            TEST_CTS_VERSION="EAP-Android12#${fingerprint_cts}"
        fi
    fi

    export TEST_VTS_VERSION TEST_CTS_VERSION

    f_fingerprint_ref="build_fingerprint_ref.txt"
    download_fingerprint "${REFERENCE_BUILD_URL}/build_fingerprint.txt" "${f_fingerprint_ref}"
    fingerprint_ref=$(cut -d: -f2 "${f_fingerprint_ref}")
    if [ -n "${f_fingerprint_ref}" ]; then
        ANDROID_VENDOR_FINGERPRINT="${fingerprint_ref}"
    else
        ANDROID_VENDOR_FINGERPRINT=""
    fi
    export ANDROID_VENDOR_FINGERPRINT

    if [ -n "${REFERENCE_BUILD_URL_SYSTEM_IMG_XZ}" ]; then
        f_fingerprint_gsi="build_fingerprint_gsi.txt"
        gsi_base_url=$(dirname "${REFERENCE_BUILD_URL_SYSTEM_IMG_XZ}")
        download_fingerprint "${gsi_base_url}/build_fingerprint.txt" "${f_fingerprint_gsi}"
        fingerprint_gsi=$(cut -d: -f2 "${f_fingerprint_gsi}")
        if [ -n "${fingerprint_gsi}" ]; then
            ANDROID_GSI_FINGERPRINT="${fingerprint_gsi}"
        else
            ANDROID_GSI_FINGERPRINT=""
        fi
        ANDROID_GSI_URL="${REFERENCE_BUILD_URL_SYSTEM_IMG_XZ}"
    else
        ANDROID_GSI_FINGERPRINT=""
        ANDROID_GSI_URL=""
    fi
    export ANDROID_GSI_FINGERPRINT ANDROID_GSI_URL

    # works when cache partition part is guarded with IMAGE_SUPPORTED_CACHE
    # default is to support cache partition with cache.img
    if [ -n "${IMAGE_SUPPORTED_CACHE}" ] && echo "X${IMAGE_SUPPORTED_CACHE}" | grep -i "Xfalse"; then
        # unset IMAGE_SUPPORTED_CACHE only when IMAGE_SUPPORTED_CACHE is specified as false explicitly
        unset IMAGE_SUPPORTED_CACHE
    else
        # cache paritition will be flashed with the cache.img
        export IMAGE_SUPPORTED_CACHE=true
    fi

    if [ -n "${IMAGE_SUPPORTED_VENDOR_BOOT}" ] && echo "X${IMAGE_SUPPORTED_VENDOR_BOOT}" | grep -i "Xtrue"; then
        # vendor_boot paritition will be flashed with the vendor_boot.img only when IMAGE_SUPPORTED_VENDOR_BOOT as true
        export IMAGE_SUPPORTED_VENDOR_BOOT=true
    else
        # unset IMAGE_SUPPORTED_VENDOR_BOOT when IMAGE_SUPPORTED_VENDOR_BOOT is not specified or specified as false explicitly
        unset IMAGE_SUPPORTED_VENDOR_BOOT
    fi

    ## clean up the old changes for last build
    ## so that the url could be updated as expected
    cd  ${DIR_CONFIGS_ROOT}/ && \
        git reset --hard && \
        cd -

    rm -f ${f_qareport_urls} && touch ${f_qareport_urls}

    # set OPT_ENVIRONMENT to empty by default, to make openembedded-lkft/submit_for_testing.py
    # use the device type as the qa-report server environment
    # and use the value of TEST_QA_SERVER_ENVIRONMENT as the qa-report server environment
    # if it is sepecified explicitly
    OPT_ENVIRONMENT=""
    if [ -n "${TEST_QA_SERVER_ENVIRONMENT}" ] && echo "X${TEST_QA_SERVER_ENVIRONMENT_ENABLED}" | grep -i "Xtrue"; then
        OPT_ENVIRONMENT="--environment ${TEST_QA_SERVER_ENVIRONMENT}"
    fi
    if [ -z "${TEST_QA_SERVER_TEAM}" ]; then
        TEST_QA_SERVER_TEAM="android-lkft"
    fi

    # Do not submit the default lkft test jobs when TEST_PLANS_NO_DEFAULT_LKFT is set true
    if [ -z "${TEST_PLANS_NO_DEFAULT_LKFT}" ] || [ "X${TEST_PLANS_NO_DEFAULT_LKFT}" != "Xtrue" ]; then
        local default_plans="template-boot.yaml template-vts-kernel-arm64-v8a.yaml template-vts-kernel-armeabi-v7a.yaml template-cts-lkft.yaml"
        if [ "X${TEST_DEVICE_TYPE}" = "Xx15" ]; then
            default_plans="template-boot.yaml template-vts-kernel-armeabi-v7a.yaml template-cts-lkft.yaml"
        fi

        local default_templates_type="${TEST_TEMPLATES_TYPE:-common}"
        local f_device_template="${DIR_CONFIGS_ROOT}/lkft/lava-job-definitions/${default_templates_type}/devices/${TEST_DEVICE_TYPE}"
        for f in ${PUBLISH_FILES}; do
            update_device_template "${f_device_template}" "${f}" "${build_config}" "${REFERENCE_BUILD_URL}"
        done

        python ${DIR_CONFIGS_ROOT}/openembedded-lkft/submit_for_testing.py \
            --device-type ${TEST_DEVICE_TYPE} \
            --build-number ${BUILD_NUMBER} \
            --lava-server ${TEST_LAVA_SERVER} \
            --qa-server ${TEST_QA_SERVER} \
            --qa-server-team ${TEST_QA_SERVER_TEAM} \
            ${OPT_ENVIRONMENT} \
            --qa-server-project ${TEST_QA_SERVER_PROJECT} \
            --git-commit ${QA_BUILD_VERSION} \
            --testplan-path "${DIR_CONFIGS_ROOT}/lkft/lava-job-definitions/${default_templates_type}" \
            --test-plan ${default_plans} \
            ${OPT_DRY_RUN} \
            --quiet

        if [ -z "${ENV_DRY_RUN}" ]; then
            qareport_url="${TEST_QA_SERVER}/api/submit/${TEST_QA_SERVER_TEAM}/${TEST_QA_SERVER_PROJECT}/${QA_BUILD_VERSION}/${TEST_DEVICE_TYPE}"
            submit_build_result "${qareport_url}"
        fi
    fi

    # so that we could override the test plans in config by settings from ci build dynamically
    if [ -n "${TEST_OTHER_PLANS_OVERRIDE}" ]; then
        TEST_OTHER_PLANS="${TEST_OTHER_PLANS_OVERRIDE}"
    fi

    if [ -n "${TEST_OTHER_PLANS}" ]; then
        for plan in ${TEST_OTHER_PLANS}; do
            templates=$(get_value_from_config_file "TEST_TEMPLATES_${plan}" "${build_config}")
            if [ -z "${templates}" ]; then
                echo "No templates specified for plan ${plan} with variable of TEST_TEMPLATES_${plan}"
                continue
            fi
            templates_type=$(get_value_from_config_file "TEST_TEMPLATES_TYPE_${plan}" "${build_config}")
            if [ -z "${templates_type}" ]; then
                templates_type="common"
            fi
            lava_server=$(get_value_from_config_file "TEST_LAVA_SERVER_${plan}" "${build_config}")
            if [ -z "${lava_server}" ]; then
                lava_server="${TEST_LAVA_SERVER}"
            fi
            qa_server=$(get_value_from_config_file "TEST_QA_SERVER_${plan}" "${build_config}")
            if [ -z "${qa_server}" ]; then
                qa_server="${TEST_QA_SERVER}"
            fi
            qa_server_team=$(get_value_from_config_file "TEST_QA_SERVER_TEAM_${plan}" "${build_config}")
            if [ -z "${qa_server_team}" ]; then
                qa_server_team="${TEST_QA_SERVER_TEAM}"
            fi
            qa_server_project=$(get_value_from_config_file "TEST_QA_SERVER_PROJECT_${plan}" "${build_config}")
            if [ -z "${qa_server_project}" ]; then
                qa_server_project="${TEST_QA_SERVER_PROJECT}"
            fi

            lava_job_priority=$(get_value_from_config_file "TEST_LAVA_JOB_PRIORITY_${plan}" "${build_config}")
            if [ -n "${lava_job_priority}" ]; then
                TEST_LAVA_JOB_PRIORITY="${lava_job_priority}"
            else
                TEST_LAVA_JOB_PRIORITY="${DEFAULT_TEST_LAVA_JOB_PRIORITY}"
            fi
            export TEST_LAVA_JOB_PRIORITY

            f_device_template="${DIR_CONFIGS_ROOT}/lkft/lava-job-definitions/${templates_type}/devices/${TEST_DEVICE_TYPE}"
            for f in ${PUBLISH_FILES}; do
                update_device_template "${f_device_template}" "${f}" "${build_config}" "${REFERENCE_BUILD_URL}"
            done

            python ${DIR_CONFIGS_ROOT}/openembedded-lkft/submit_for_testing.py \
                --device-type ${TEST_DEVICE_TYPE} \
                --build-number ${BUILD_NUMBER} \
                --lava-server ${lava_server} \
                --qa-server ${qa_server} \
                --qa-server-team ${qa_server_team} \
                ${OPT_ENVIRONMENT} \
                --qa-server-project ${qa_server_project} \
                --git-commit ${QA_BUILD_VERSION} \
                --testplan-path ${DIR_CONFIGS_ROOT}/lkft/lava-job-definitions/${templates_type} \
                --test-plan ${templates} \
                ${OPT_DRY_RUN} \
                --quiet

            if [ -z "${ENV_DRY_RUN}" ]; then
                qareport_url="${qa_server}/api/submit/${qa_server_team}/${qa_server_project}/${QA_BUILD_VERSION}/${TEST_DEVICE_TYPE}"
                submit_build_result ${qareport_url}
            fi
        done
    fi

    rm -f "${f_qareport_urls}"
}

function submit_jobs(){
    local f_temp_path=${F_ABS_PATH}
    local NEED_CLONE_CONFIGS=true
    DIR_CONFIGS_ROOT=""
    while true; do
        parent=$(dirname ${f_temp_path})
        if [ -d ${parent}/.git ]; then
            NEED_CLONE_CONFIGS=false
            DIR_CONFIGS_ROOT=${parent}
            break
        elif [ "X${parent}" = "X/" ]; then
            break
        fi
        f_temp_path=${parent}
    done

    if ${NEED_CLONE_CONFIGS}; then
        rm -rf configs && git clone --depth 1 http://git.linaro.org/ci/job/configs.git && DIR_CONFIGS_ROOT=configs
    fi

    #environments exported by jenkins
    #export BUILD_NUMBER JOB_NAME BUILD_URL
    PUB_DEST="android/lkft/${JOB_NAME}/${BUILD_NUMBER}"
    if [ -n "${SNAPAHOT_SITE_ROOT}" ]; then
        PUB_DEST="${SNAPAHOT_SITE_ROOT}/${JOB_NAME}/${BUILD_NUMBER}"
    fi
    export DOWNLOAD_URL=http://snapshots.linaro.org/${PUB_DEST}

    # environments set by the upstream trigger job
    KERNEL_COMMIT=${SRCREV_kernel}
    if [ -n "${MAKE_KERNELVERSION}" ] && echo "X${USE_KERNELVERSION_FOR_QA_BUILD_VERSION}" | grep -i "Xtrue"; then
        QA_BUILD_VERSION=${MAKE_KERNELVERSION}-${KERNEL_COMMIT:0:12}
    elif [ -n "${KERNEL_DESCRIBE}" ]; then
        QA_BUILD_VERSION=${KERNEL_DESCRIBE}
    else
        QA_BUILD_VERSION=${KERNEL_COMMIT:0:12}
    fi
    export KERNEL_DESCRIBE KERNEL_COMMIT
    export QA_BUILD_VERSION DIR_CONFIGS_ROOT

    for build_config in ${ANDROID_BUILD_CONFIG}; do
        submit_jobs_for_config ${build_config}
    done
}

submit_jobs "$@"