buildntest.sh

#!/bin/bash
# =============================================================================
#  @@-COPYRIGHT-START-@@
#
#  Copyright (c) 2020, Qualcomm Innovation Center, Inc. All rights reserved.
#
#  Redistribution and use in source and binary forms, with or without
#  modification, are permitted provided that the following conditions are met:
#
#  1. Redistributions of source code must retain the above copyright notice,
#     this list of conditions and the following disclaimer.
#
#  2. Redistributions in binary form must reproduce the above copyright notice,
#     this list of conditions and the following disclaimer in the documentation
#     and/or other materials provided with the distribution.
#
#  3. Neither the name of the copyright holder nor the names of its contributors
#     may be used to endorse or promote products derived from this software
#     without specific prior written permission.
#
#  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
#  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
#  IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
#  ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
#  LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
#  CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
#  SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
#  INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
#  CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
#  ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
#  POSSIBILITY OF SUCH DAMAGE.
#
#  SPDX-License-Identifier: BSD-3-Clause
#
#  @@-COPYRIGHT-END-@@
# =============================================================================

###############################################################################
## This is a script to build and run tests on AIMET code.
## This script must be run from within the AIMET top-level folder.
## For help and usage information: buildntest.sh -h
###############################################################################

# enable exit on error.
set -e

workspaceFolder=`pwd`
workspaceFolder=`readlink -f ${workspaceFolder}`
outputRootFolder=$workspaceFolder
scriptPath=`readlink -f $(dirname "$0")`
entrypoint="${scriptPath}/dobuildntest.sh"
options_string=""
EXIT_CODE=0


interactive_mode=0
dry_run=0
loading_symbol="..."

usage() {
  echo -e "\nThis is a script to build and run tests on AIMET code."
  echo -e "This script must be executed from within the AIMET repo's top-level folder."
  echo -e "NOTE: This script will build and start a docker container.\n"

  echo "${0} [-o <output_folder>]"
  echo "    -b --> build the code"
  echo "    -p --> generate pip packages"
  echo "    -u --> run unit tests"
  echo "    -v --> run code violation checks (using pylint tool)"
  echo "    -g --> run code coverage checks (using pycov tool)"
  echo "    -s --> run static analysis (using clang-tidy tool)"
  echo "    -a --> run acceptance tests (Warning: This will take a long time to complete!)"
  echo "    -o --> optional output folder. Default is current directory"
  echo "    -i --> just build and start the docker in interactive mode (shell prompt)"
  echo "    -m --> mount the volumes (For multiple environment variables, use the same option"
  echo "            multiple times ex. -m <path1> -m <path2> ...)"
  echo "    -e --> set existing env var from current environment (For multiple environment "
  echo "            variables, use the same option multiple times ex. -e <var1> -e <var2> ...)"
  echo "    -y --> set any custom script/command as entrypoint for docker (default is dobuildntest.sh)"
  echo "    -n --> dry run mode (just display the docker command)"
  echo "    -l --> skip docker image build and pull from code linaro instead"
}


while getopts "o:abce:ilm:npghsuvy:" opt;
   do
      case $opt in
         a)
             options_string+=" -a"
             ;;
         b)
             options_string+=" -b"
             ;;
         e)
             USER_ENV_VARS+=("$OPTARG")
             ;;
         g)
             options_string+=" -g"
             ;;
         p)
             options_string+=" -p"
             ;;
         u)
             options_string+=" -u"
             ;;
         v)
             options_string+=" -v"
             ;;
         s)
             options_string+=" -s"
             ;;
         h)
             usage
             exit 0
             ;;
         i)
             interactive_mode=1
             ;;
         m)
             USER_MOUNT_DIRS+=("$OPTARG")
             ;;
         l)
             USE_LINARO=1
             ;;
         n)
             dry_run=1
             loading_symbol=":"
             ;;
         o)
             outputRootFolder=$OPTARG
             ;;
         y)
             entrypoint=$OPTARG
             ;;
         :)
             echo "Option -$OPTARG requires an argument" >&2
             exit 1;;
         ?)
             echo "Unknown arg $opt"
             usage
             exit 1
             ;;
      esac
done

if [ ${dry_run} -eq 0 ]; then
	set -x
fi

timestamp=$(date +%Y-%m-%d_%H-%M-%S)

if [ ! -d "../aimet" ] && [ ! -d "../aimet-main" ]; then
   echo -e "ERROR: Not in the correct directory!"
   exit 3
fi

# Set the docker file path
# This is the default value (for python 3.10 docker files)
dockerfile_path=${scriptPath}/Jenkins
if [ -n "$PYTHON_VER" ]; then
    # If the python version variable was set, then switch the path
    if [ "${PYTHON_VER}" != "3.10" ]; then
        # We only support python 3.10 version.
        echo "ERROR: Invalid PYTHON_VER (${PYTHON_VER}). Must be either 3.10!"
        exit 3
    fi
fi


# Set the root URL that hosts the pre-built development docker image
if [ -n "$PREBUILT_DOCKER_IMAGE_URL" ]; then
    prebuilt_docker_image_url=${PREBUILT_DOCKER_IMAGE_URL}
elif [[ "$CHANGE_TARGET" =~ "release-aimet" ]]; then
    prebuilt_docker_image_url=${AIMET_PREBUILT_DOCKER_IMAGE_URL}"-release"
elif [ -n "$AIMET_PREBUILT_DOCKER_IMAGE_URL" ]; then
    # Use a custom source if one is provided
    prebuilt_docker_image_url=${AIMET_PREBUILT_DOCKER_IMAGE_URL}
else
    # Use the default docker images from Code Linaro
    prebuilt_docker_image_url="artifacts.codelinaro.org/codelinaro-aimet"
fi

# Select the docker file based on the build variant
if [ -n "$AIMET_VARIANT" ]; then
    docker_file="Dockerfile.${AIMET_VARIANT}"
    docker_image_name="aimet-dev-docker:${AIMET_VARIANT}"
    prebuilt_docker_image_name="${prebuilt_docker_image_url}/aimet-dev:latest.${AIMET_VARIANT}"
else
    docker_file="Dockerfile"
    docker_image_name="aimet-dev-docker:latest"
    prebuilt_docker_image_name="${prebuilt_docker_image_url}/aimet:latest"
fi

if [[ -z "${BUILD_NUMBER}" ]]; then
    # If invoked from command line by user, use a timestamp suffix
    results_path=${outputRootFolder}/buildntest_results/$timestamp
    docker_container_name=aimet-dev_${USER}_${timestamp}
    # If this is a variant, then append the variant string as suffix
    if [ -n "$AIMET_VARIANT" ]; then
        docker_container_name="${docker_container_name}_${AIMET_VARIANT}"
        results_path=${results_path}_${AIMET_VARIANT}
    fi
else
    # If invoked from jenkins, add username, build num, and timestamp
    results_path=${outputRootFolder}/buildntest_results
    docker_container_name=aimet-dev_${USER}_${BUILD_NUMBER}_${timestamp}
fi

# Add desired output folder to the options string
options_string+=" -o ${results_path}"

rm -rf {results_path} | true
mkdir -p ${results_path}

# Kill any previous running containers by the same name
if [[ -z "${BUILD_NUMBER}" ]]; then
    # If invoked from command line by user, kill any previous running containers by the same name
    docker ps | grep ${docker_container_name} && docker kill ${docker_container_name} || true
else
    # If invoked from jenkins, kill anly previous running containers starting with "aimet-dev_"
    containers=($(docker ps | awk '/aimet-dev_/ {print $NF}'))
    for container_name in "${containers[@]}"; do
        docker kill "$container_name" || true;
    done
fi

# Either use code linaro docker image or build it from scratch
if [ -n "$USE_LINARO" ]; then
    docker_image_name=$prebuilt_docker_image_name
    echo -e "*** Using pre-built docker image: $docker_image_name ***\n"
    docker pull $docker_image_name
else
    echo -e "*** Building docker image${loading_symbol} ***\n"
    pushd ${dockerfile_path}
    DOCKER_BUILD_CMD="docker build -t ${docker_image_name} -f ${docker_file} ."
    if [[ ${ALTERNATIVE_DOCKER_REGISTRY} ]];
    then
        DOCKER_BUILD_CMD+=" --build-arg REGISTRY=${ALTERNATIVE_DOCKER_REGISTRY}"
    fi
    if [ $interactive_mode -eq 1 ] && [ $dry_run -eq 1 ]; then
        echo ${DOCKER_BUILD_CMD}
        echo
    else
        eval ${DOCKER_BUILD_CMD}
    fi
    popd
fi

# Add data dependency path as additional volume mount if it exists
if [ -n "${DEPENDENCY_DATA_PATH}" ]; then
   docker_add_vol_mount+=${DEPENDENCY_DATA_PATH}
   USER_ENV_VARS+=("DEPENDENCY_DATA_PATH")
else
   # If it does not exist, then just add the path of the current script since we cannot leave it
   # empty
   docker_add_vol_mount+=${scriptPath}
fi

# Add patchelf mirror url to the environment
if [ -n "${PATCHELF_INTERNAL_URL}" ]; then
   USER_ENV_VARS+=("PATCHELF_INTERNAL_URL")
fi

# Check if and which version of nvidia docker is present
set +e
DOCKER_RUN_PREFIX="docker run"
dpkg -s nvidia-container-toolkit > /dev/null 2>&1
NVIDIA_CONTAINER_TOOKIT_RC=$?
dpkg -s nvidia-docker > /dev/null 2>&1
NVIDIA_DOCKER_RC=$?
dpkg -s nvidia-docker2 > /dev/null 2>&1
NVIDIA_DOCKER_RC2=$?
set -e

if [ -n "$AIMET_VARIANT" ] && [[ "$AIMET_VARIANT" == *"cpu"* ]]; then
    echo "Running docker in CPU mode..."
    DOCKER_RUN_PREFIX="docker run"
elif [ $NVIDIA_DOCKER_RC -eq 0 ] || [ $NVIDIA_DOCKER_RC2 -eq 0 ]; then
    echo "Running docker in GPU mode using nvidia-docker..."
    DOCKER_RUN_PREFIX="nvidia-docker run"
elif [ $NVIDIA_CONTAINER_TOOKIT_RC -eq 0 ]; then
    echo "Running docker in GPU mode using nvidia-container-toolkit..."
    DOCKER_RUN_PREFIX="docker run --gpus all"
else
    echo "ERROR: You requested GPU mode, but no nvidia support was detected!"
    exit 3
fi

# Mirror URL prefix for github repos (if one exists)
additional_opts="-v /etc/passwd:/etc/passwd:ro "
if [ -n "${GITHUB_MIRROR_URL}" ]; then
   USER_ENV_VARS+=("GITHUB_MIRROR_URL")
   echo "git-user:x:$(id -u):$(id -g):Git User:/tmp:/bin/bash" > /tmp/fake_passwd
   additional_opts=" -w /tmp -v /usr2/${USER}/.ssh:/tmp/.ssh -v /tmp/fake_passwd:/etc/passwd:ro "
fi

echo -e "Starting docker container${loading_symbol} \n"
DOCKER_RUN_CMD="${DOCKER_RUN_PREFIX} --rm --name=$docker_container_name -e DISPLAY=:0 \
				-u $(id -u ${USER}):$(id -g ${USER}) \
				${additional_opts} \
				-v /etc/group:/etc/group:ro \
				-v /tmp/.X11-unix:/tmp/.X11-unix \
				-v ${workspaceFolder}:${workspaceFolder} \
				-v ${outputRootFolder}:${outputRootFolder} \
				-v ${docker_add_vol_mount}:${docker_add_vol_mount} \
				-v /etc/localtime:/etc/localtime:ro \
				-v /etc/timezone:/etc/timezone:ro --network=host --ulimit core=-1 \
				-w ${workspaceFolder} \
				--ipc=host --shm-size=8G"

# Check if HOME variable is set
if [[ -v HOME ]]; then
	DOCKER_RUN_CMD="${DOCKER_RUN_CMD} -v ${HOME}:${HOME}"
fi

# Set env variables if requested
for user_env_var in "${USER_ENV_VARS[@]}"; do
    DOCKER_RUN_CMD="${DOCKER_RUN_CMD} -e ${user_env_var}=\$${user_env_var}"
done

# Mount directories if requested
for user_dir in "${USER_MOUNT_DIRS[@]}"; do
	DOCKER_RUN_CMD="${DOCKER_RUN_CMD} -v ${user_dir}:${user_dir}"
done

if [ $interactive_mode -eq 1 ]; then
	DOCKER_RUN_CMD="${DOCKER_RUN_CMD} -it --hostname aimet-dev ${docker_image_name}"
	if [ $dry_run -eq 1 ]; then
		echo ${DOCKER_RUN_CMD}
		echo
	else
		eval ${DOCKER_RUN_CMD}
	fi
else
	DOCKER_RUN_CMD="${DOCKER_RUN_CMD} --entrypoint=${entrypoint} \
	${docker_image_name} ${options_string} -w ${workspaceFolder} \
	-o ${results_path} | tee ${results_path}/full_log.txt"
	eval ${DOCKER_RUN_CMD}

	# Capture the status of the docker command prior to the tee pipe
	EXIT_CODE=${PIPESTATUS[0]}

	if [ ${EXIT_CODE} -ne 0 ]; then
	    echo -e "Docker execution of stage failed!"
	elif [ ! -f "${results_path}/summary.txt" ]; then
	    echo -e "Failed to launch any build or test stages!"
	    EXIT_CODE=3
	elif grep -q FAIL "${results_path}/summary.txt"; then
	    echo -e "One or more stages failed!"
	    EXIT_CODE=3
	fi

	exit $EXIT_CODE
fi