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# DISTRO: Optional, docker base image (ubuntu or fedora) 20# BRANCH: Optional, branch to build from each of the 21# openbmc repositories. default is master, which will be 22# used if input branch not provided or not found 23# DOCKER_IMG_NAME: Optional, default is openbmc/ubuntu-unit-test-master with a 24# -$BRANCH replacing -master if $BRANCH provided 25# dbus_sys_config_file: Optional, with the default being 26# `/usr/share/dbus-1/system.conf` 27# NO_FORMAT_CODE: Optional, do not run format-code.sh 28# EXTRA_UNIT_TEST_ARGS: Optional, pass arguments to unit-test.py 29 30# Trace bash processing. Set -e so when a step fails, we fail the build 31set -uo pipefail 32 33# Default variables 34BRANCH=${BRANCH:-"master"} 35DOCKER_IMG_NAME=${DOCKER_IMG_NAME:-"openbmc/ubuntu-unit-test-${BRANCH}"} 36DISTRO=${DISTRO:-ubuntu:focal} 37OBMC_BUILD_SCRIPTS="openbmc-build-scripts" 38UNIT_TEST_PY_DIR="scripts" 39UNIT_TEST_PY="unit-test.py" 40FORMAT_CODE_SH="format-code.sh" 41DBUS_UNIT_TEST_PY="dbus-unit-test.py" 42TEST_ONLY="${TEST_ONLY:-}" 43DBUS_SYS_CONFIG_FILE=${dbus_sys_config_file:-"/usr/share/dbus-1/system.conf"} 44MAKEFLAGS="${MAKEFLAGS:-""}" 45DOCKER_WORKDIR="${DOCKER_WORKDIR:-$WORKSPACE}" 46NO_FORMAT_CODE="${NO_FORMAT_CODE:-}" 47 48# Timestamp for job 49echo "Unit test build started, $(date)" 50 51if [[ "${DISTRO}" == "fedora" ]]; then 52 echo "Distro (${DISTRO}) not supported, running as ubuntu" 53 DISTRO="ubuntu:latest" 54fi 55 56# Check workspace, build scripts, and package to be unit tested exists 57if [ ! -d "${WORKSPACE}" ]; then 58 echo "Workspace(${WORKSPACE}) doesn't exist, exiting..." 59 exit 1 60fi 61if [ ! -d "${WORKSPACE}/${OBMC_BUILD_SCRIPTS}" ]; then 62 echo "Package(${OBMC_BUILD_SCRIPTS}) not found in ${WORKSPACE}, exiting..." 63 exit 1 64fi 65# shellcheck disable=SC2153 # UNIT_TEST_PKG is not misspelled. 66if [ ! -d "${WORKSPACE}/${UNIT_TEST_PKG}" ]; then 67 echo "Package(${UNIT_TEST_PKG}) not found in ${WORKSPACE}, exiting..." 68 exit 1 69fi 70 71# Copy unit test script into workspace 72cp "${WORKSPACE}"/${OBMC_BUILD_SCRIPTS}/${UNIT_TEST_PY_DIR}/${UNIT_TEST_PY} \ 73"${WORKSPACE}"/${UNIT_TEST_PY} 74chmod a+x "${WORKSPACE}"/${UNIT_TEST_PY} 75 76# Copy dbus unit test script into workspace 77cp "${WORKSPACE}"/${OBMC_BUILD_SCRIPTS}/${UNIT_TEST_PY_DIR}/${DBUS_UNIT_TEST_PY} \ 78"${WORKSPACE}"/${DBUS_UNIT_TEST_PY} 79chmod a+x "${WORKSPACE}"/${DBUS_UNIT_TEST_PY} 80 81# Copy format code script into workspace 82cp "${WORKSPACE}"/${OBMC_BUILD_SCRIPTS}/${UNIT_TEST_PY_DIR}/${FORMAT_CODE_SH} \ 83"${WORKSPACE}"/${FORMAT_CODE_SH} 84chmod a+x "${WORKSPACE}"/${FORMAT_CODE_SH} 85 86# Configure docker build 87cd "${WORKSPACE}"/${OBMC_BUILD_SCRIPTS} 88echo "Building docker image with build-unit-test-docker" 89# Export input env variables 90export DOCKER_IMG_NAME 91export DISTRO 92export BRANCH 93./scripts/build-unit-test-docker 94 95# Allow the user to pass options through to unit-test.py: 96# EXTRA_UNIT_TEST_ARGS="-r 100" ... 97EXTRA_UNIT_TEST_ARGS="${EXTRA_UNIT_TEST_ARGS:+,${EXTRA_UNIT_TEST_ARGS/ /,}}" 98 99# Unit test and parameters 100UNIT_TEST="${DOCKER_WORKDIR}/${UNIT_TEST_PY},-w,${DOCKER_WORKDIR},\ 101-p,${UNIT_TEST_PKG},-b,$BRANCH,-v${TEST_ONLY:+,-t}${NO_FORMAT_CODE:+,-n}\ 102${EXTRA_UNIT_TEST_ARGS}" 103 104# Run the docker unit test container with the unit test execution script 105echo "Executing docker image" 106docker run --cap-add=sys_admin --rm=true \ 107 --network host \ 108 --privileged=true \ 109 -u "$USER" \ 110 -w "${DOCKER_WORKDIR}" -v "${WORKSPACE}":"${DOCKER_WORKDIR}" \ 111 -e "MAKEFLAGS=${MAKEFLAGS}" \ 112 -t "${DOCKER_IMG_NAME}" \ 113 "${DOCKER_WORKDIR}"/${DBUS_UNIT_TEST_PY} -u "${UNIT_TEST}" \ 114 -f "${DBUS_SYS_CONFIG_FILE}" 115 116# Timestamp for build 117echo "Unit test build completed, $(date)" 118 119# Clean up copied scripts. 120rm "${WORKSPACE}"/${UNIT_TEST_PY} 121rm "${WORKSPACE}"/${DBUS_UNIT_TEST_PY} 122rm "${WORKSPACE}"/${FORMAT_CODE_SH} 123 124