1#!/bin/bash -xe 2 3# This build script is for running the Jenkins unit test builds using docker. 4# 5# This script will build a docker container which will then be used to build 6# and test the input UNIT_TEST_PKG. The docker container will be pre-populated 7# with the most used OpenBMC repositories (phosphor-dbus-interfaces, sdbusplus, 8# phosphor-logging, ...). This allows the use of docker caching 9# capabilities so the dependent repositories are only built once per update 10# to their corresponding repository. If a BRANCH parameter is input then the 11# docker container will be pre-populated with the latest code from that input 12# branch. If the branch does not exist in the repository, then master will be 13# used. 14# 15# UNIT_TEST_PKG: Required, repository which has been extracted and is to 16# be tested 17# WORKSPACE: Required, location of unit test scripts and repository 18# code to test 19# BRANCH: Optional, branch to build from each of the 20# openbmc repositories. default is master, which will be 21# used if input branch not provided or not found 22# dbus_sys_config_file: Optional, with the default being 23# `/usr/share/dbus-1/system.conf` 24# NO_FORMAT_CODE: Optional, do not run format-code.sh 25# EXTRA_UNIT_TEST_ARGS: Optional, pass arguments to unit-test.py 26# INTERACTIVE: Optional, run a bash shell instead of unit-test.py 27 28# Trace bash processing. Set -e so when a step fails, we fail the build 29set -uo pipefail 30 31# Default variables 32BRANCH=${BRANCH:-"master"} 33OBMC_BUILD_SCRIPTS="openbmc-build-scripts" 34UNIT_TEST_PY_DIR="scripts" 35CONFIG_DIR="config" 36UNIT_TEST_PY="unit-test.py" 37FORMAT_CODE_SH="format-code.sh" 38SPELLINGS_TXT="openbmc-spelling.txt" 39ESLINT_CONFIG="eslint-global-config.json" 40DBUS_UNIT_TEST_PY="dbus-unit-test.py" 41TEST_ONLY="${TEST_ONLY:-}" 42DBUS_SYS_CONFIG_FILE=${dbus_sys_config_file:-"/usr/share/dbus-1/system.conf"} 43MAKEFLAGS="${MAKEFLAGS:-""}" 44DOCKER_WORKDIR="${DOCKER_WORKDIR:-$WORKSPACE}" 45NO_FORMAT_CODE="${NO_FORMAT_CODE:-}" 46INTERACTIVE="${INTERACTIVE:-}" 47 48# Timestamp for job 49echo "Unit test build started, $(date)" 50 51# Check workspace, build scripts, and package to be unit tested exists 52if [ ! -d "${WORKSPACE}" ]; then 53 echo "Workspace(${WORKSPACE}) doesn't exist, exiting..." 54 exit 1 55fi 56if [ ! -d "${WORKSPACE}/${OBMC_BUILD_SCRIPTS}" ]; then 57 echo "Package(${OBMC_BUILD_SCRIPTS}) not found in ${WORKSPACE}, exiting..." 58 exit 1 59fi 60# shellcheck disable=SC2153 # UNIT_TEST_PKG is not misspelled. 61if [ ! -d "${WORKSPACE}/${UNIT_TEST_PKG}" ]; then 62 echo "Package(${UNIT_TEST_PKG}) not found in ${WORKSPACE}, exiting..." 63 exit 1 64fi 65 66# Copy unit test script into workspace 67cp "${WORKSPACE}"/${OBMC_BUILD_SCRIPTS}/${UNIT_TEST_PY_DIR}/${UNIT_TEST_PY} \ 68"${WORKSPACE}"/${UNIT_TEST_PY} 69chmod a+x "${WORKSPACE}"/${UNIT_TEST_PY} 70 71# Copy dbus unit test script into workspace 72cp "${WORKSPACE}"/${OBMC_BUILD_SCRIPTS}/${UNIT_TEST_PY_DIR}/${DBUS_UNIT_TEST_PY} \ 73"${WORKSPACE}"/${DBUS_UNIT_TEST_PY} 74chmod a+x "${WORKSPACE}"/${DBUS_UNIT_TEST_PY} 75 76# Copy format code script into workspace 77cp "${WORKSPACE}"/${OBMC_BUILD_SCRIPTS}/${UNIT_TEST_PY_DIR}/${FORMAT_CODE_SH} \ 78"${WORKSPACE}"/${FORMAT_CODE_SH} 79chmod a+x "${WORKSPACE}"/${FORMAT_CODE_SH} 80 81# Copy spellings.txt file into workspace 82cp "${WORKSPACE}"/${OBMC_BUILD_SCRIPTS}/${CONFIG_DIR}/${SPELLINGS_TXT} \ 83"${WORKSPACE}"/${SPELLINGS_TXT} 84 85# Copy the eslintconfig file into workspce 86cp "${WORKSPACE}"/${OBMC_BUILD_SCRIPTS}/${CONFIG_DIR}/${ESLINT_CONFIG} \ 87"${WORKSPACE}"/${ESLINT_CONFIG} 88 89# Configure docker build 90cd "${WORKSPACE}"/${OBMC_BUILD_SCRIPTS} 91echo "Building docker image with build-unit-test-docker" 92# Export input env variables 93export BRANCH 94DOCKER_IMG_NAME=$(./scripts/build-unit-test-docker) 95export DOCKER_IMG_NAME 96 97# Allow the user to pass options through to unit-test.py: 98# EXTRA_UNIT_TEST_ARGS="-r 100" ... 99EXTRA_UNIT_TEST_ARGS="${EXTRA_UNIT_TEST_ARGS:+,${EXTRA_UNIT_TEST_ARGS/ /,}}" 100 101# Unit test and parameters 102if [ "${INTERACTIVE}" ]; then 103 UNIT_TEST="/bin/bash" 104else 105 UNIT_TEST="${DOCKER_WORKDIR}/${UNIT_TEST_PY},-w,${DOCKER_WORKDIR},\ 106-p,${UNIT_TEST_PKG},-b,$BRANCH,-v${TEST_ONLY:+,-t}${NO_FORMAT_CODE:+,-n}\ 107${EXTRA_UNIT_TEST_ARGS}" 108fi 109 110# Run the docker unit test container with the unit test execution script 111echo "Executing docker image" 112docker run --cap-add=sys_admin --rm=true \ 113 --privileged=true \ 114 -u "$USER" \ 115 -w "${DOCKER_WORKDIR}" -v "${WORKSPACE}":"${DOCKER_WORKDIR}" \ 116 -e "MAKEFLAGS=${MAKEFLAGS}" \ 117 -${INTERACTIVE:+i}t "${DOCKER_IMG_NAME}" \ 118 "${DOCKER_WORKDIR}"/${DBUS_UNIT_TEST_PY} -u "${UNIT_TEST}" \ 119 -f "${DBUS_SYS_CONFIG_FILE}" 120 121# Timestamp for build 122echo "Unit test build completed, $(date)" 123 124# Clean up copied scripts. 125rm "${WORKSPACE}"/${UNIT_TEST_PY} 126rm "${WORKSPACE}"/${DBUS_UNIT_TEST_PY} 127rm "${WORKSPACE}"/${FORMAT_CODE_SH} 128rm "${WORKSPACE}"/${ESLINT_CONFIG} 129 130