Merge branch '18862-replay-job-log-task'
[arvados.git] / build / run-build-packages-one-target.sh
1 #!/bin/bash
2 # Copyright (C) The Arvados Authors. All rights reserved.
3 #
4 # SPDX-License-Identifier: AGPL-3.0
5
6 read -rd "\000" helpmessage <<EOF
7 $(basename $0): Orchestrate run-build-packages.sh for one target
8
9 Syntax:
10         WORKSPACE=/path/to/arvados $(basename $0) [options]
11
12 --target <target>
13     Distribution to build packages for (default: debian10)
14 --command
15     Build command to execute (default: use built-in Docker image command)
16 --test-packages
17     Run package install test script "test-packages-[target].sh"
18 --debug
19     Output debug information (default: false)
20 --only-build <package>
21     Build only a specific package
22 --only-test <package>
23     Test only a specific package
24 --arch <arch>
25     Build a specific architecture (amd64 or arm64, defaults to native architecture)
26 --force-build
27     Build even if the package exists upstream or if it has already been
28     built locally
29 --force-test
30     Test even if there is no new untested package
31 --build-version <string>
32     Version to build (default:
33     \$ARVADOS_BUILDING_VERSION-\$ARVADOS_BUILDING_ITERATION or
34     0.1.timestamp.commithash)
35 --skip-docker-build
36     Don't try to build Docker images
37
38 WORKSPACE=path         Path to the Arvados source tree to build packages from
39
40 EOF
41
42 set -e
43
44 if ! [[ -n "$WORKSPACE" ]]; then
45   echo >&2 "$helpmessage"
46   echo >&2
47   echo >&2 "Error: WORKSPACE environment variable not set"
48   echo >&2
49   exit 1
50 fi
51
52 if ! [[ -d "$WORKSPACE" ]]; then
53   echo >&2 "$helpmessage"
54   echo >&2
55   echo >&2 "Error: $WORKSPACE is not a directory"
56   echo >&2
57   exit 1
58 fi
59
60 PARSEDOPTS=$(getopt --name "$0" --longoptions \
61     help,debug,test-packages,target:,command:,only-test:,force-test,only-build:,force-build,arch:,build-version:,skip-docker-build \
62     -- "" "$@")
63 if [ $? -ne 0 ]; then
64     exit 1
65 fi
66
67 TARGET=debian10
68 FORCE_BUILD=0
69 COMMAND=
70 DEBUG=
71
72 eval set -- "$PARSEDOPTS"
73 while [ $# -gt 0 ]; do
74     case "$1" in
75         --help)
76             echo >&2 "$helpmessage"
77             echo >&2
78             exit 1
79             ;;
80         --target)
81             TARGET="$2"; shift
82             ;;
83         --only-test)
84             test_packages=1
85             testing_one_package=1
86             packages="$2"; shift
87             ;;
88         --force-test)
89             FORCE_TEST=true
90             ;;
91         --force-build)
92             FORCE_BUILD=1
93             ;;
94         --only-build)
95             ONLY_BUILD="$2"; shift
96             ;;
97         --arch)
98             ARCH="$2"; shift
99             ;;
100         --debug)
101             DEBUG=" --debug"
102             ARVADOS_DEBUG="1"
103             ;;
104         --command)
105             COMMAND="$2"; shift
106             ;;
107         --test-packages)
108             test_packages=1
109             ;;
110         --build-version)
111             if [[ -z "$2" ]]; then
112                 :
113             elif ! [[ "$2" =~ (.*)-(.*) ]]; then
114                 echo >&2 "FATAL: --build-version '$2' does not include an iteration. Try '${2}-1'?"
115                 exit 1
116             elif ! [[ "$2" =~ ^[0-9]+\.[0-9]+\.[0-9]+(\.[0-9]+|)(~rc[0-9]+|~dev[0-9]+|)-[0-9]+$ ]]; then
117                 echo >&2 "FATAL: --build-version '$2' is invalid, must match pattern ^[0-9]+\.[0-9]+\.[0-9]+(\.[0-9]+|)(~rc[0-9]+|~dev[0-9]+|)-[0-9]+$"
118                 exit 1
119             else
120                 [[ "$2" =~ (.*)-(.*) ]]
121                 ARVADOS_BUILDING_VERSION="${BASH_REMATCH[1]}"
122                 ARVADOS_BUILDING_ITERATION="${BASH_REMATCH[2]}"
123             fi
124             shift
125             ;;
126         --skip-docker-build)
127             SKIP_DOCKER_BUILD=1
128             ;;
129         --)
130             if [ $# -gt 1 ]; then
131                 echo >&2 "$0: unrecognized argument '$2'. Try: $0 --help"
132                 exit 1
133             fi
134             ;;
135     esac
136     shift
137 done
138
139 set -e
140
141 if [[ -n "$ARVADOS_BUILDING_VERSION" ]]; then
142     echo "build version='$ARVADOS_BUILDING_VERSION', package iteration='$ARVADOS_BUILDING_ITERATION'"
143 fi
144
145 if [[ -n "$test_packages" ]]; then
146   if [[ -n "$(find $WORKSPACE/packages/$TARGET -name '*.rpm')" ]] ; then
147     CREATEREPO="$(command -v createrepo createrepo_c | tail -n1)"
148     if [[ -z "$CREATEREPO" ]]; then
149       echo >&2
150       echo >&2 "Error: please install createrepo. E.g. sudo apt install createrepo-c"
151       echo >&2
152       exit 1
153     fi
154     "$CREATEREPO" $WORKSPACE/packages/$TARGET
155   fi
156
157   if [[ -n "$(find $WORKSPACE/packages/$TARGET -name '*.deb')" ]] ; then
158     set +e
159     /usr/bin/which dpkg-scanpackages >/dev/null
160     if [[ "$?" != "0" ]]; then
161       echo >&2
162       echo >&2 "Error: please install dpkg-dev. E.g. sudo apt-get install dpkg-dev"
163       echo >&2
164       exit 1
165     fi
166     /usr/bin/which apt-ftparchive >/dev/null
167     if [[ "$?" != "0" ]]; then
168       echo >&2
169       echo >&2 "Error: please install apt-utils. E.g. sudo apt-get install apt-utils"
170       echo >&2
171       exit 1
172     fi
173     set -e
174     (cd $WORKSPACE/packages/$TARGET
175       dpkg-scanpackages --multiversion .  2> >(grep -v 'warning' 1>&2) | tee Packages | gzip -c > Packages.gz
176       apt-ftparchive -o APT::FTPArchive::Release::Origin=Arvados release . > Release
177     )
178   fi
179
180   COMMAND="/jenkins/package-testing/test-packages-$TARGET.sh"
181   IMAGE="arvados/package-test:$TARGET"
182 else
183   IMAGE="arvados/build:$TARGET"
184   if [[ "$COMMAND" != "" ]]; then
185     COMMAND="/usr/local/rvm/bin/rvm-exec default bash /jenkins/$COMMAND --target $TARGET$DEBUG"
186   fi
187 fi
188
189 JENKINS_DIR=$(dirname "$(readlink -e "$0")")
190
191 if [[ "$SKIP_DOCKER_BUILD" != 1 ]] ; then
192     if [[ -n "$test_packages" ]]; then
193         pushd "$JENKINS_DIR/package-test-dockerfiles"
194         make "$TARGET/generated"
195     else
196         pushd "$JENKINS_DIR/package-build-dockerfiles"
197         make "$TARGET/generated"
198     fi
199
200     GOVERSION=$(grep 'const goversion =' $WORKSPACE/lib/install/deps.go |awk -F'"' '{print $2}')
201
202     echo $TARGET
203     cd $TARGET
204     time docker build --tag "$IMAGE" \
205          --build-arg HOSTTYPE=$HOSTTYPE \
206          --build-arg BRANCH=$(git rev-parse --abbrev-ref HEAD) \
207          --build-arg GOVERSION=$GOVERSION --no-cache .
208     popd
209 fi
210
211 if test -z "$packages" ; then
212     packages="arvados-api-server
213         arvados-client
214         arvados-controller
215         arvados-dispatch-cloud
216         arvados-dispatch-lsf
217         arvados-docker-cleaner
218         arvados-git-httpd
219         arvados-health
220         arvados-server
221         arvados-src
222         arvados-sync-groups
223         arvados-sync-users
224         arvados-workbench2
225         arvados-ws
226         crunch-dispatch-local
227         crunch-dispatch-slurm
228         crunch-run
229         keepproxy
230         keepstore
231         keep-balance
232         keep-block-check
233         keep-rsync
234         keep-exercise
235         keep-rsync
236         keep-block-check
237         keep-web
238         libpam-arvados-go
239         python3-cwltest
240         python3-arvados-fuse
241         python3-arvados-python-client
242         python3-arvados-cwl-runner
243         python3-crunchstat-summary
244         python3-arvados-user-activity"
245 fi
246
247 FINAL_EXITCODE=0
248
249 package_fails=""
250
251 mkdir -p "$WORKSPACE/services/api/vendor/cache-$TARGET"
252
253 docker_volume_args=(
254     -v "$JENKINS_DIR:/jenkins"
255     -v "$WORKSPACE:/arvados"
256     -v /arvados/services/api/vendor/bundle
257     -v "$WORKSPACE/services/api/vendor/cache-$TARGET:/arvados/services/api/vendor/cache"
258 )
259
260 if [[ -n "$test_packages" ]]; then
261     for p in $packages ; do
262         if [[ -n "$ONLY_BUILD" ]] && [[ "$p" != "$ONLY_BUILD" ]]; then
263             continue
264         fi
265         if [[ -e "${WORKSPACE}/packages/.last_test_${TARGET}" ]] && [[ -z "$FORCE_TEST" ]]; then
266           MATCH=`find ${WORKSPACE}/packages/ -newer ${WORKSPACE}/packages/.last_test_${TARGET} -regex .*${TARGET}/$p.*`
267           if [[ "$MATCH" == "" ]]; then
268             # No new package has been built that needs testing
269             echo "Skipping $p test because no new package was built since the last test."
270             continue
271           fi
272         fi
273         # If we're testing all packages, we should not error out on packages that don't exist.
274         # If we are testing one specific package only (i.e. --only-test was given), we should
275         # error out if that package does not exist.
276         if [[ -z "$testing_one_package" ]]; then
277           MATCH=`find ${WORKSPACE}/packages/ -regextype posix-extended -regex .*${TARGET}/$p.*\\(deb\\|rpm\\)`
278           if [[ "$MATCH" == "" ]]; then
279             # No new package has been built that needs testing
280             echo "Skipping $p test because no package file is available to test."
281             continue
282           fi
283         fi
284         echo
285         echo "START: $p test on $IMAGE" >&2
286         if docker run \
287             --rm \
288             "${docker_volume_args[@]}" \
289             --env ARVADOS_DEBUG=$ARVADOS_DEBUG \
290             --env "TARGET=$TARGET" \
291             --env "WORKSPACE=/arvados" \
292             "$IMAGE" $COMMAND $p
293         then
294             echo "OK: $p test on $IMAGE succeeded" >&2
295         else
296             FINAL_EXITCODE=$?
297             package_fails="$package_fails $p"
298             echo "ERROR: $p test on $IMAGE failed with exit status $FINAL_EXITCODE" >&2
299         fi
300     done
301
302     if [[ "$FINAL_EXITCODE" == "0" ]]; then
303       touch ${WORKSPACE}/packages/.last_test_${TARGET}
304     fi
305 else
306     echo
307     echo "START: build packages on $IMAGE" >&2
308     # Move existing packages and other files into the processed/ subdirectory
309     if [[ ! -e "${WORKSPACE}/packages/${TARGET}/processed" ]]; then
310       mkdir -p "${WORKSPACE}/packages/${TARGET}/processed"
311     fi
312     set +e
313     mv -f ${WORKSPACE}/packages/${TARGET}/* ${WORKSPACE}/packages/${TARGET}/processed/ 2>/dev/null
314     set -e
315     # give bundle (almost) all the cores. See also the MAKE env var that is passed into the
316     # docker run command below.
317     # Cf. https://build.betterup.com/one-weird-trick-that-will-speed-up-your-bundle-install/
318     tmpfile=$(mktemp /tmp/run-build-packages-one-target.XXXXXX)
319     cores=$(let a=$(grep -c processor /proc/cpuinfo )-1; echo $a)
320     printf -- "---\nBUNDLE_JOBS: \"$cores\"" > $tmpfile
321     # Build packages.
322     if docker run \
323         --rm \
324         "${docker_volume_args[@]}" \
325         -v $tmpfile:/root/.bundle/config \
326         --env ARVADOS_BUILDING_VERSION="$ARVADOS_BUILDING_VERSION" \
327         --env ARVADOS_BUILDING_ITERATION="$ARVADOS_BUILDING_ITERATION" \
328         --env ARVADOS_DEBUG=$ARVADOS_DEBUG \
329         --env "ONLY_BUILD=$ONLY_BUILD" \
330         --env "FORCE_BUILD=$FORCE_BUILD" \
331         --env "ARCH=$ARCH" \
332         --env "MAKE=make --jobs $cores" \
333         "$IMAGE" $COMMAND
334     then
335         echo
336         echo "OK: build packages on $IMAGE succeeded" >&2
337     else
338         FINAL_EXITCODE=$?
339         echo "ERROR: build packages on $IMAGE failed with exit status $FINAL_EXITCODE" >&2
340     fi
341     # Clean up the bundle config file
342     rm -f $tmpfile
343 fi
344
345 if test -n "$package_fails" ; then
346     echo "Failed package tests:$package_fails" >&2
347 fi
348
349 exit $FINAL_EXITCODE