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
27# Trace bash processing. Set -e so when a step fails, we fail the build
28set -uo pipefail
29
30# Default variables
31BRANCH=${BRANCH:-"master"}
32OBMC_BUILD_SCRIPTS="openbmc-build-scripts"
33UNIT_TEST_PY_DIR="scripts"
34CONFIG_DIR="config"
35UNIT_TEST_PY="unit-test.py"
36FORMAT_CODE_SH="format-code.sh"
37SPELLINGS_TXT="openbmc-spelling.txt"
38ESLINT_CONFIG="eslint-global-config.json"
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}"
44NO_FORMAT_CODE="${NO_FORMAT_CODE:-}"
45
46# Timestamp for job
47echo "Unit test build started, $(date)"
48
49# Check workspace, build scripts, and package to be unit tested exists
50if [ ! -d "${WORKSPACE}" ]; then
51    echo "Workspace(${WORKSPACE}) doesn't exist, exiting..."
52    exit 1
53fi
54if [ ! -d "${WORKSPACE}/${OBMC_BUILD_SCRIPTS}" ]; then
55    echo "Package(${OBMC_BUILD_SCRIPTS}) not found in ${WORKSPACE}, exiting..."
56    exit 1
57fi
58# shellcheck disable=SC2153 # UNIT_TEST_PKG is not misspelled.
59if [ ! -d "${WORKSPACE}/${UNIT_TEST_PKG}" ]; then
60    echo "Package(${UNIT_TEST_PKG}) not found in ${WORKSPACE}, exiting..."
61    exit 1
62fi
63
64# Copy unit test script into workspace
65cp "${WORKSPACE}"/${OBMC_BUILD_SCRIPTS}/${UNIT_TEST_PY_DIR}/${UNIT_TEST_PY} \
66"${WORKSPACE}"/${UNIT_TEST_PY}
67chmod a+x "${WORKSPACE}"/${UNIT_TEST_PY}
68
69# Copy dbus unit test script into workspace
70cp "${WORKSPACE}"/${OBMC_BUILD_SCRIPTS}/${UNIT_TEST_PY_DIR}/${DBUS_UNIT_TEST_PY} \
71"${WORKSPACE}"/${DBUS_UNIT_TEST_PY}
72chmod a+x "${WORKSPACE}"/${DBUS_UNIT_TEST_PY}
73
74# Copy format code script into workspace
75cp "${WORKSPACE}"/${OBMC_BUILD_SCRIPTS}/${UNIT_TEST_PY_DIR}/${FORMAT_CODE_SH} \
76"${WORKSPACE}"/${FORMAT_CODE_SH}
77chmod a+x "${WORKSPACE}"/${FORMAT_CODE_SH}
78
79# Copy spellings.txt file into workspace
80cp "${WORKSPACE}"/${OBMC_BUILD_SCRIPTS}/${CONFIG_DIR}/${SPELLINGS_TXT} \
81"${WORKSPACE}"/${SPELLINGS_TXT}
82
83# Copy the eslintconfig file into workspce
84cp "${WORKSPACE}"/${OBMC_BUILD_SCRIPTS}/${CONFIG_DIR}/${ESLINT_CONFIG} \
85"${WORKSPACE}"/${ESLINT_CONFIG}
86
87# Configure docker build
88cd "${WORKSPACE}"/${OBMC_BUILD_SCRIPTS}
89echo "Building docker image with build-unit-test-docker"
90# Export input env variables
91export BRANCH
92DOCKER_IMG_NAME=$(./scripts/build-unit-test-docker)
93export DOCKER_IMG_NAME
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}
123rm "${WORKSPACE}"/${ESLINT_CONFIG}
124
125