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 28# Trace bash processing. Set -e so when a step fails, we fail the build 29set -uo pipefail 30 31# Default variables 32DOCKER_IMG_NAME=${DOCKER_IMG_NAME:-"openbmc/ubuntu-unit-test-${BRANCH:-master}"} 33DISTRO=${DISTRO:-ubuntu:bionic} 34OBMC_BUILD_SCRIPTS="openbmc-build-scripts" 35UNIT_TEST_PY_DIR="scripts" 36UNIT_TEST_PY="unit-test.py" 37FORMAT_CODE_SH="format-code.sh" 38DBUS_UNIT_TEST_PY="dbus-unit-test.py" 39DBUS_SYS_CONFIG_FILE=${dbus_sys_config_file:-"/usr/share/dbus-1/system.conf"} 40MAKEFLAGS="${MAKEFLAGS:-""}" 41DOCKER_WORKDIR="${DOCKER_WORKDIR:-$WORKSPACE}" 42 43# Timestamp for job 44echo "Unit test build started, $(date)" 45 46if [[ "${DISTRO}" == "fedora" ]]; then 47 echo "Distro (${DISTRO}) not supported, running as ubuntu" 48 DISTRO="ubuntu:latest" 49fi 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 60if [ ! -d "${WORKSPACE}/${UNIT_TEST_PKG}" ]; then 61 echo "Package(${UNIT_TEST_PKG}) not found in ${WORKSPACE}, exiting..." 62 exit 1 63fi 64 65# Copy unit test script into workspace 66cp ${WORKSPACE}/${OBMC_BUILD_SCRIPTS}/${UNIT_TEST_PY_DIR}/${UNIT_TEST_PY} \ 67${WORKSPACE}/${UNIT_TEST_PY} 68chmod a+x ${WORKSPACE}/${UNIT_TEST_PY} 69 70# Copy dbus unit test script into workspace 71cp ${WORKSPACE}/${OBMC_BUILD_SCRIPTS}/${UNIT_TEST_PY_DIR}/${DBUS_UNIT_TEST_PY} \ 72${WORKSPACE}/${DBUS_UNIT_TEST_PY} 73chmod a+x ${WORKSPACE}/${DBUS_UNIT_TEST_PY} 74 75# Copy format code script into workspace 76cp ${WORKSPACE}/${OBMC_BUILD_SCRIPTS}/${UNIT_TEST_PY_DIR}/${FORMAT_CODE_SH} \ 77${WORKSPACE}/${FORMAT_CODE_SH} 78chmod a+x ${WORKSPACE}/${FORMAT_CODE_SH} 79 80# Configure docker build 81cd ${WORKSPACE}/${OBMC_BUILD_SCRIPTS} 82echo "Building docker image with build-unit-test-docker.sh" 83# Export input env variables 84export DOCKER_IMG_NAME 85export DISTRO 86export BRANCH 87./build-unit-test-docker.sh 88 89# Unit test and parameters 90UNIT_TEST="${DOCKER_WORKDIR}/${UNIT_TEST_PY},-w,${DOCKER_WORKDIR},-p,${UNIT_TEST_PKG},-v" 91 92# Run the docker unit test container with the unit test execution script 93echo "Executing docker image" 94docker run --cap-add=sys_admin --rm=true \ 95 --network host \ 96 --privileged=true \ 97 -u "$USER" \ 98 -w "${DOCKER_WORKDIR}" -v "${WORKSPACE}":"${DOCKER_WORKDIR}" \ 99 -e "MAKEFLAGS=${MAKEFLAGS}" \ 100 -t ${DOCKER_IMG_NAME} \ 101 "${DOCKER_WORKDIR}"/${DBUS_UNIT_TEST_PY} -u ${UNIT_TEST} \ 102 -f ${DBUS_SYS_CONFIG_FILE} 103 104# Timestamp for build 105echo "Unit test build completed, $(date)" 106