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