xref: /openbmc/openbmc-build-scripts/run-unit-test-docker.sh (revision 7c1e562a152d0353d8de0d622b741482ecda4871) 
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#   TEST_ONLY:       Optional, do not run analysis tools
25#   NO_FORMAT_CODE:  Optional, do not run format-code.sh
26#   EXTRA_UNIT_TEST_ARGS:  Optional, pass arguments to unit-test.py
27#   INTERACTIVE: Optional, run a bash shell instead of unit-test.py
28#   http_proxy: Optional, run the container with proxy environment
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"}
35OBMC_BUILD_SCRIPTS="openbmc-build-scripts"
36UNIT_TEST_PY_DIR="scripts"
37CONFIG_DIR="config"
38UNIT_TEST_PY="unit-test.py"
39FORMAT_CODE_SH="format-code.sh"
40SPELLINGS_TXT="openbmc-spelling.txt openbmc-spelling-ignore.txt"
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:-}"
47INTERACTIVE="${INTERACTIVE:-}"
48http_proxy=${http_proxy:-}
49
50# Timestamp for job
51echo "Unit test build started, $(date)"
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
62# shellcheck disable=SC2153 # UNIT_TEST_PKG is not misspelled.
63if [ ! -d "${WORKSPACE}/${UNIT_TEST_PKG}" ]; then
64    echo "Package(${UNIT_TEST_PKG}) not found in ${WORKSPACE}, exiting..."
65    exit 1
66fi
67
68# Copy unit test script into workspace
69cp "${WORKSPACE}"/${OBMC_BUILD_SCRIPTS}/${UNIT_TEST_PY_DIR}/${UNIT_TEST_PY} \
70"${WORKSPACE}"/${UNIT_TEST_PY}
71chmod a+x "${WORKSPACE}"/${UNIT_TEST_PY}
72
73# Copy dbus unit test script into workspace
74cp "${WORKSPACE}"/${OBMC_BUILD_SCRIPTS}/${UNIT_TEST_PY_DIR}/${DBUS_UNIT_TEST_PY} \
75"${WORKSPACE}"/${DBUS_UNIT_TEST_PY}
76chmod a+x "${WORKSPACE}"/${DBUS_UNIT_TEST_PY}
77
78# Copy format code script into workspace
79cp "${WORKSPACE}"/${OBMC_BUILD_SCRIPTS}/${UNIT_TEST_PY_DIR}/${FORMAT_CODE_SH} \
80"${WORKSPACE}"/${FORMAT_CODE_SH}
81chmod a+x "${WORKSPACE}"/${FORMAT_CODE_SH}
82
83# Copy spellings.txt file into workspace
84for f in ${SPELLINGS_TXT}; do
85    cp "${WORKSPACE}/${OBMC_BUILD_SCRIPTS}/${CONFIG_DIR}/${f}" \
86        "${WORKSPACE}/${f}"
87done
88
89# Configure docker build
90cd "${WORKSPACE}"/${OBMC_BUILD_SCRIPTS}
91echo "Building docker image with build-unit-test-docker"
92# Export input env variables
93export BRANCH
94DOCKER_IMG_NAME=$(./scripts/build-unit-test-docker)
95export DOCKER_IMG_NAME
96
97# Allow the user to pass options through to unit-test.py:
98#   EXTRA_UNIT_TEST_ARGS="-r 100" ...
99EXTRA_UNIT_TEST_ARGS="${EXTRA_UNIT_TEST_ARGS:+,${EXTRA_UNIT_TEST_ARGS/ /,}}"
100
101# Unit test and parameters
102if [ "${INTERACTIVE}" ]; then
103    UNIT_TEST="/bin/bash"
104else
105    UNIT_TEST="${DOCKER_WORKDIR}/${UNIT_TEST_PY},-w,${DOCKER_WORKDIR},\
106-p,${UNIT_TEST_PKG},-b,$BRANCH,-v${TEST_ONLY:+,-t}${NO_FORMAT_CODE:+,-n}\
107${EXTRA_UNIT_TEST_ARGS}"
108fi
109
110# Run the docker unit test container with the unit test execution script
111echo "Executing docker image"
112
113PROXY_ENV=""
114# Set up proxies
115if [ -n "${http_proxy}" ]; then
116    PROXY_ENV=" \
117        --env HTTP_PROXY=${http_proxy} \
118        --env HTTPS_PROXY=${http_proxy} \
119        --env FTP_PROXY=${http_proxy} \
120        --env http_proxy=${http_proxy} \
121        --env https_proxy=${http_proxy} \
122        --env ftp_proxy=${http_proxy}"
123fi
124
125# shellcheck disable=SC2086 # ${PROXY_ENV} is meant to be splitted
126docker run --cap-add=sys_admin --rm=true \
127    --privileged=true \
128    ${PROXY_ENV} \
129    -u "$USER" \
130    -w "${DOCKER_WORKDIR}" -v "${WORKSPACE}":"${DOCKER_WORKDIR}" \
131    -e "MAKEFLAGS=${MAKEFLAGS}" \
132    -${INTERACTIVE:+i}t "${DOCKER_IMG_NAME}" \
133    "${DOCKER_WORKDIR}"/${DBUS_UNIT_TEST_PY} -u "${UNIT_TEST}" \
134    -f "${DBUS_SYS_CONFIG_FILE}"
135
136# Timestamp for build
137echo "Unit test build completed, $(date)"
138
139# Clean up copied scripts.
140rm "${WORKSPACE}"/${UNIT_TEST_PY}
141rm "${WORKSPACE}"/${DBUS_UNIT_TEST_PY}
142rm "${WORKSPACE}"/${FORMAT_CODE_SH}
143
144