xref: /openbmc/openbmc-build-scripts/run-unit-test-docker.sh (revision 5a8aa48c0f4365a4622ddde9265711b501dfb921) 
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
32BRANCH=${BRANCH:-"master"}
33DOCKER_IMG_NAME=${DOCKER_IMG_NAME:-"openbmc/ubuntu-unit-test-${BRANCH}"}
34DISTRO=${DISTRO:-ubuntu:eoan}
35OBMC_BUILD_SCRIPTS="openbmc-build-scripts"
36UNIT_TEST_PY_DIR="scripts"
37UNIT_TEST_PY="unit-test.py"
38FORMAT_CODE_SH="format-code.sh"
39DBUS_UNIT_TEST_PY="dbus-unit-test.py"
40TEST_ONLY="${TEST_ONLY:-}"
41DBUS_SYS_CONFIG_FILE=${dbus_sys_config_file:-"/usr/share/dbus-1/system.conf"}
42MAKEFLAGS="${MAKEFLAGS:-""}"
43DOCKER_WORKDIR="${DOCKER_WORKDIR:-$WORKSPACE}"
44
45# Timestamp for job
46echo "Unit test build started, $(date)"
47
48if [[ "${DISTRO}" == "fedora" ]]; then
49    echo "Distro (${DISTRO}) not supported, running as ubuntu"
50    DISTRO="ubuntu:latest"
51fi
52
53# Check workspace, build scripts, and package to be unit tested exists
54if [ ! -d "${WORKSPACE}" ]; then
55    echo "Workspace(${WORKSPACE}) doesn't exist, exiting..."
56    exit 1
57fi
58if [ ! -d "${WORKSPACE}/${OBMC_BUILD_SCRIPTS}" ]; then
59    echo "Package(${OBMC_BUILD_SCRIPTS}) not found in ${WORKSPACE}, exiting..."
60    exit 1
61fi
62if [ ! -d "${WORKSPACE}/${UNIT_TEST_PKG}" ]; then
63    echo "Package(${UNIT_TEST_PKG}) not found in ${WORKSPACE}, exiting..."
64    exit 1
65fi
66
67# Copy unit test script into workspace
68cp ${WORKSPACE}/${OBMC_BUILD_SCRIPTS}/${UNIT_TEST_PY_DIR}/${UNIT_TEST_PY} \
69${WORKSPACE}/${UNIT_TEST_PY}
70chmod a+x ${WORKSPACE}/${UNIT_TEST_PY}
71
72# Copy dbus unit test script into workspace
73cp ${WORKSPACE}/${OBMC_BUILD_SCRIPTS}/${UNIT_TEST_PY_DIR}/${DBUS_UNIT_TEST_PY} \
74${WORKSPACE}/${DBUS_UNIT_TEST_PY}
75chmod a+x ${WORKSPACE}/${DBUS_UNIT_TEST_PY}
76
77# Copy format code script into workspace
78cp ${WORKSPACE}/${OBMC_BUILD_SCRIPTS}/${UNIT_TEST_PY_DIR}/${FORMAT_CODE_SH} \
79${WORKSPACE}/${FORMAT_CODE_SH}
80chmod a+x ${WORKSPACE}/${FORMAT_CODE_SH}
81
82# Configure docker build
83cd ${WORKSPACE}/${OBMC_BUILD_SCRIPTS}
84echo "Building docker image with build-unit-test-docker.sh"
85# Export input env variables
86export DOCKER_IMG_NAME
87export DISTRO
88export BRANCH
89./build-unit-test-docker.sh
90
91# Unit test and parameters
92UNIT_TEST="${DOCKER_WORKDIR}/${UNIT_TEST_PY},-w,${DOCKER_WORKDIR},\
93-p,${UNIT_TEST_PKG},-b,$BRANCH,-v${TEST_ONLY:+,-t}"
94
95# Run the docker unit test container with the unit test execution script
96echo "Executing docker image"
97docker run --cap-add=sys_admin --rm=true \
98    --network host \
99    --privileged=true \
100    -u "$USER" \
101    -w "${DOCKER_WORKDIR}" -v "${WORKSPACE}":"${DOCKER_WORKDIR}" \
102    -e "MAKEFLAGS=${MAKEFLAGS}" \
103    -t ${DOCKER_IMG_NAME} \
104    "${DOCKER_WORKDIR}"/${DBUS_UNIT_TEST_PY} -u ${UNIT_TEST} \
105    -f ${DBUS_SYS_CONFIG_FILE}
106
107# Timestamp for build
108echo "Unit test build completed, $(date)"
109