21123: Add container_status to discovery doc.
[arvados.git] / build / run-library.sh
1 #!/bin/bash -xe
2 # Copyright (C) The Arvados Authors. All rights reserved.
3 #
4 # SPDX-License-Identifier: AGPL-3.0
5
6 # A library of functions shared by the various scripts in this directory.
7
8 # This is the timestamp about when we merged changed to include licenses
9 # with Arvados packages.  We use it as a heuristic to add revisions for
10 # older packages.
11 LICENSE_PACKAGE_TS=20151208015500
12
13 if [[ -z "$ARVADOS_BUILDING_VERSION" ]]; then
14     RAILS_PACKAGE_ITERATION=1
15 else
16     RAILS_PACKAGE_ITERATION="$ARVADOS_BUILDING_ITERATION"
17 fi
18
19 debug_echo () {
20     echo "$@" >"$STDOUT_IF_DEBUG"
21 }
22
23 find_python_program() {
24     prog="$1"
25     shift
26     for prog in "$@"; do
27         if "$prog" --version >/dev/null 2>&1; then
28             echo "$prog"
29             return 0
30         fi
31     done
32     cat >&2 <<EOF
33 $helpmessage
34
35 Error: $prog (from Python setuptools module) not found
36
37 EOF
38     exit 1
39 }
40
41 format_last_commit_here() {
42     local format="$1"; shift
43     local dir="${1:-.}"; shift
44     TZ=UTC git log -n1 --first-parent "--format=format:$format" "$dir"
45 }
46
47 version_from_git() {
48     # Output the version being built, or if we're building a
49     # dev/prerelease, output a version number based on the git log for
50     # the given $subdir.
51     local subdir="$1"; shift
52     if [[ -n "$ARVADOS_BUILDING_VERSION" ]]; then
53         echo "$ARVADOS_BUILDING_VERSION"
54         return
55     fi
56
57     local git_ts git_hash
58     declare $(format_last_commit_here "git_ts=%ct git_hash=%h" "$subdir")
59     ARVADOS_BUILDING_VERSION="$($WORKSPACE/build/version-at-commit.sh $git_hash)"
60     echo "$ARVADOS_BUILDING_VERSION"
61 }
62
63 nohash_version_from_git() {
64     local subdir="$1"; shift
65     if [[ -n "$ARVADOS_BUILDING_VERSION" ]]; then
66         echo "$ARVADOS_BUILDING_VERSION"
67         return
68     fi
69     version_from_git $subdir | cut -d. -f1-4
70 }
71
72 timestamp_from_git() {
73     local subdir="$1"; shift
74     format_last_commit_here "%ct" "$subdir"
75 }
76
77 calculate_python_sdk_cwl_package_versions() {
78   python_sdk_version=$(cd sdk/python && python3 arvados_version.py)
79   cwl_runner_version=$(cd sdk/cwl && python3 arvados_version.py)
80 }
81
82 # Usage: get_native_arch
83 get_native_arch() {
84   # Only amd64 and aarch64 are supported at the moment
85   local native_arch=""
86   case "$HOSTTYPE" in
87     x86_64)
88       native_arch="amd64"
89       ;;
90     aarch64)
91       native_arch="arm64"
92       ;;
93     *)
94       echo "Error: architecture not supported"
95       exit 1
96       ;;
97   esac
98   echo $native_arch
99 }
100
101 handle_ruby_gem() {
102     local gem_name="$1"; shift
103     local gem_version="$(nohash_version_from_git)"
104     local gem_src_dir="$(pwd)"
105
106     if [[ -n "$ONLY_BUILD" ]] && [[ "$gem_name" != "$ONLY_BUILD" ]] ; then
107         return 0
108     fi
109
110     if ! [[ -e "${gem_name}-${gem_version}.gem" ]]; then
111         find -maxdepth 1 -name "${gem_name}-*.gem" -delete
112
113         # -q appears to be broken in gem version 2.2.2
114         $GEM build "$gem_name.gemspec" $DASHQ_UNLESS_DEBUG >"$STDOUT_IF_DEBUG" 2>"$STDERR_IF_DEBUG"
115     fi
116 }
117
118 # Usage: package_workbench2
119 package_workbench2() {
120     local pkgname=arvados-workbench2
121     local src=services/workbench2
122     local dst=/var/www/arvados-workbench2/workbench2
123     local description="Arvados Workbench 2"
124     local version="$(version_from_git)"
125     cd "$WORKSPACE/$src"
126     rm -rf ./build
127     NODE_ENV=production yarn install
128     VERSION="$version" BUILD_NUMBER="$(default_iteration "$pkgname" "$version" yarn)" GIT_COMMIT="$(git rev-parse HEAD | head -c9)" yarn build
129     cd "$WORKSPACE/packages/$TARGET"
130     fpm_build "${WORKSPACE}/$src" "${WORKSPACE}/$src/build/=$dst" "$pkgname" dir "$version" \
131               --license="GNU Affero General Public License, version 3.0" \
132               --description="${description}" \
133               --config-files="/etc/arvados/$pkgname/workbench2.example.json" \
134               "$WORKSPACE/services/workbench2/etc/arvados/workbench2/workbench2.example.json=/etc/arvados/$pkgname/workbench2.example.json"
135 }
136
137 calculate_go_package_version() {
138   # $__returnvar has the nameref attribute set, which means it is a reference
139   # to another variable that is passed in as the first argument to this function.
140   # see https://www.gnu.org/software/bash/manual/html_node/Shell-Parameters.html
141   local -n __returnvar="$1"; shift
142   local oldpwd="$PWD"
143
144   cd "$WORKSPACE"
145   go mod download
146
147   # Update the version number and build a new package if the vendor
148   # bundle has changed, or the command imports anything from the
149   # Arvados SDK and the SDK has changed.
150   declare -a checkdirs=(go.mod go.sum)
151   while [ -n "$1" ]; do
152       checkdirs+=("$1")
153       shift
154   done
155   # Even our rails packages (version calculation happens here!) depend on a go component (arvados-server)
156   # Everything depends on the build directory.
157   checkdirs+=(sdk/go lib build)
158   local timestamp=0
159   for dir in ${checkdirs[@]}; do
160       cd "$WORKSPACE"
161       ts="$(timestamp_from_git "$dir")"
162       if [[ "$ts" -gt "$timestamp" ]]; then
163           version=$(version_from_git "$dir")
164           timestamp="$ts"
165       fi
166   done
167   cd "$oldpwd"
168   __returnvar="$version"
169 }
170
171 # Usage: package_go_binary services/foo arvados-foo [deb|rpm] [amd64|arm64] "Compute foo to arbitrary precision" [apache-2.0.txt]
172 package_go_binary() {
173   local src_path="$1"; shift
174   local prog="$1"; shift
175   local package_format="$1"; shift
176   local target_arch="$1"; shift
177   local description="$1"; shift
178   local license_file="${1:-agpl-3.0.txt}"; shift
179
180   if [[ -n "$ONLY_BUILD" ]] && [[ "$prog" != "$ONLY_BUILD" ]]; then
181       debug_echo -e "Skipping build of $prog package."
182       return 0
183   fi
184
185   native_arch=$(get_native_arch)
186
187   if [[ "$native_arch" != "amd64" ]] && [[ -n "$target_arch" ]] && [[ "$native_arch" != "$target_arch" ]]; then
188     echo "Error: no cross compilation support for Go on $native_arch, can not build $prog for $target_arch"
189     return 1
190   fi
191
192   case "$package_format-$TARGET" in
193     # Ubuntu 20.04 does not support cross compilation because the
194     # libfuse package does not support multiarch. See
195     # <https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=983477>.
196     # Red Hat-based distributions do not support native cross compilation at
197     # all (they use a qemu-based solution we haven't implemented yet).
198     deb-ubuntu2004|rpm-*)
199       cross_compilation=0
200       if [[ "$native_arch" == "amd64" ]] && [[ -n "$target_arch" ]] && [[ "$native_arch" != "$target_arch" ]]; then
201         echo "Error: no cross compilation support for Go on $native_arch for $TARGET, can not build $prog for $target_arch"
202         return 1
203       fi
204       ;;
205     *)
206       cross_compilation=1
207       ;;
208   esac
209
210   if [[ -n "$target_arch" ]]; then
211     archs=($target_arch)
212   else
213     # No target architecture specified, default to native target. When on amd64
214     # also crosscompile arm64 (when supported).
215     archs=($native_arch)
216     if [[ $cross_compilation -ne 0 ]]; then
217       archs+=("arm64")
218     fi
219   fi
220
221   for ta in ${archs[@]}; do
222     package_go_binary_worker "$src_path" "$prog" "$package_format" "$description" "$native_arch" "$ta" "$license_file"
223     retval=$?
224     if [[ $retval -ne 0 ]]; then
225       return $retval
226     fi
227   done
228 }
229
230 # Usage: package_go_binary services/foo arvados-foo deb "Compute foo to arbitrary precision" [amd64/arm64] [amd64/arm64] [apache-2.0.txt]
231 package_go_binary_worker() {
232     local src_path="$1"; shift
233     local prog="$1"; shift
234     local package_format="$1"; shift
235     local description="$1"; shift
236     local native_arch="${1:-amd64}"; shift
237     local target_arch="${1:-amd64}"; shift
238     local license_file="${1:-agpl-3.0.txt}"; shift
239
240     debug_echo "package_go_binary $src_path as $prog (native arch: $native_arch, target arch: $target_arch)"
241     local basename="${src_path##*/}"
242     calculate_go_package_version go_package_version $src_path
243
244     cd $WORKSPACE/packages/$TARGET
245     test_package_presence "$prog" "$go_package_version" "go" "" "$target_arch"
246     if [[ $? -ne 0 ]]; then
247       return 0
248     fi
249
250     echo "Building $package_format ($target_arch) package for $prog from $src_path"
251     if [[ "$native_arch" == "amd64" ]] && [[ "$target_arch" == "arm64" ]]; then
252       CGO_ENABLED=1 CC=aarch64-linux-gnu-gcc GOARCH=${target_arch} go install -ldflags "-X git.arvados.org/arvados.git/lib/cmd.version=${go_package_version} -X main.version=${go_package_version}" "git.arvados.org/arvados.git/$src_path"
253     else
254       GOARCH=${arch} go install -ldflags "-X git.arvados.org/arvados.git/lib/cmd.version=${go_package_version} -X main.version=${go_package_version}" "git.arvados.org/arvados.git/$src_path"
255     fi
256
257     local -a switches=()
258
259     binpath=$GOPATH/bin/${basename}
260     if [[ "${target_arch}" != "${native_arch}" ]]; then
261       switches+=("-a${target_arch}")
262       binpath="$GOPATH/bin/linux_${target_arch}/${basename}"
263     fi
264
265     systemd_unit="$WORKSPACE/${src_path}/${prog}.service"
266     if [[ -e "${systemd_unit}" ]]; then
267         switches+=(
268             --after-install "${WORKSPACE}/build/go-python-package-scripts/postinst"
269             --before-remove "${WORKSPACE}/build/go-python-package-scripts/prerm"
270             "${systemd_unit}=/lib/systemd/system/${prog}.service")
271     fi
272     switches+=("$WORKSPACE/${license_file}=/usr/share/doc/$prog/${license_file}")
273
274     fpm_build "${WORKSPACE}/${src_path}" "$binpath=/usr/bin/${prog}" "${prog}" dir "${go_package_version}" "--url=https://arvados.org" "--license=GNU Affero General Public License, version 3.0" "--description=${description}" "${switches[@]}"
275 }
276
277 # Usage: package_go_so lib/foo arvados_foo.so arvados-foo deb amd64 "Arvados foo library"
278 package_go_so() {
279     local src_path="$1"; shift
280     local sofile="$1"; shift
281     local pkg="$1"; shift
282     local package_format="$1"; shift
283     local target_arch="$1"; shift # supported: amd64, arm64
284     local description="$1"; shift
285
286     if [[ -n "$ONLY_BUILD" ]] && [[ "$pkg" != "$ONLY_BUILD" ]]; then
287       debug_echo -e "Skipping build of $pkg package."
288       return 0
289     fi
290
291     debug_echo "package_go_so $src_path as $pkg"
292
293     calculate_go_package_version go_package_version $src_path
294     cd $WORKSPACE/packages/$TARGET
295     test_package_presence $pkg $go_package_version go || return 1
296     cd $WORKSPACE/$src_path
297     go build -buildmode=c-shared -o ${GOPATH}/bin/${sofile}
298     cd $WORKSPACE/packages/$TARGET
299     local -a fpmargs=(
300         "--url=https://arvados.org"
301         "--license=Apache License, Version 2.0"
302         "--description=${description}"
303         "$WORKSPACE/apache-2.0.txt=/usr/share/doc/$pkg/apache-2.0.txt"
304     )
305     if [[ -e "$WORKSPACE/$src_path/pam-configs-arvados" ]]; then
306         fpmargs+=("$WORKSPACE/$src_path/pam-configs-arvados=/usr/share/doc/$pkg/pam-configs-arvados-go")
307     fi
308     if [[ -e "$WORKSPACE/$src_path/README" ]]; then
309         fpmargs+=("$WORKSPACE/$src_path/README=/usr/share/doc/$pkg/README")
310     fi
311     fpm_build "${WORKSPACE}/${src_path}" "$GOPATH/bin/${sofile}=/usr/lib/${sofile}" "${pkg}" dir "${go_package_version}" "${fpmargs[@]}"
312 }
313
314 default_iteration() {
315     if [[ -n "$ARVADOS_BUILDING_VERSION" ]]; then
316         echo "$ARVADOS_BUILDING_ITERATION"
317         return
318     fi
319     local package_name="$1"; shift
320     local package_version="$1"; shift
321     local package_type="$1"; shift
322     local iteration=1
323     if [[ $package_version =~ ^0\.1\.([0-9]{14})(\.|$) ]] && \
324            [[ ${BASH_REMATCH[1]} -le $LICENSE_PACKAGE_TS ]]; then
325         iteration=2
326     fi
327     echo $iteration
328 }
329
330 _build_rails_package_scripts() {
331     local pkgname="$1"; shift
332     local destdir="$1"; shift
333     local srcdir="$RUN_BUILD_PACKAGES_PATH/rails-package-scripts"
334     for scriptname in postinst prerm postrm; do
335         cat "$srcdir/$pkgname.sh" "$srcdir/step2.sh" "$srcdir/$scriptname.sh" \
336             >"$destdir/$scriptname" || return $?
337     done
338 }
339
340 rails_package_version() {
341     local pkgname="$1"; shift
342     local srcdir="$1"; shift
343     if [[ -n "$ARVADOS_BUILDING_VERSION" ]]; then
344         echo "$ARVADOS_BUILDING_VERSION"
345         return
346     fi
347     local version="$(version_from_git)"
348     if [ $pkgname = "arvados-api-server" ] ; then
349         calculate_go_package_version version cmd/arvados-server "$srcdir"
350     fi
351     echo $version
352 }
353
354 test_rails_package_presence() {
355   local pkgname="$1"; shift
356   local srcdir="$1"; shift
357
358   if [[ -n "$ONLY_BUILD" ]] && [[ "$pkgname" != "$ONLY_BUILD" ]] ; then
359     return 1
360   fi
361
362   tmppwd=`pwd`
363
364   cd $srcdir
365
366   local version="$(rails_package_version "$pkgname" "$srcdir")"
367
368   cd $tmppwd
369
370   test_package_presence $pkgname $version rails "$RAILS_PACKAGE_ITERATION"
371 }
372
373 get_complete_package_name() {
374   # if the errexit flag is set, unset it until this function returns
375   # otherwise, the shift calls below will abort the program if optional arguments are not supplied
376   if [ -o errexit ]; then
377     set +e
378     trap 'set -e' RETURN
379   fi
380   # $__returnvar has the nameref attribute set, which means it is a reference
381   # to another variable that is passed in as the first argument to this function.
382   # see https://www.gnu.org/software/bash/manual/html_node/Shell-Parameters.html
383   local -n __returnvar="$1"; shift
384   local pkgname="$1"; shift
385   local version="$1"; shift
386   local pkgtype="$1"; shift
387   local iteration="$1"; shift
388   local arch="$1"; shift
389   if [[ "$iteration" == "" ]]; then
390       iteration="$(default_iteration "$pkgname" "$version" "$pkgtype")"
391   fi
392
393   if [[ "$arch" == "" ]]; then
394     native_arch=$(get_native_arch)
395     rpm_native_arch="x86_64"
396     if [[ "$HOSTTYPE" == "aarch64" ]]; then
397       rpm_native_arch="arm64"
398     fi
399     rpm_architecture="$rpm_native_arch"
400     deb_architecture="$native_arch"
401
402     if [[ "$pkgtype" =~ ^(src)$ ]]; then
403       rpm_architecture="noarch"
404       deb_architecture="all"
405     fi
406   else
407     rpm_architecture=$arch
408     deb_architecture=$arch
409   fi
410
411   local complete_pkgname="${pkgname}_$version${iteration:+-$iteration}_$deb_architecture.deb"
412   if [[ "$FORMAT" == "rpm" ]]; then
413       # rpm packages get iteration 1 if we don't supply one
414       iteration=${iteration:-1}
415       complete_pkgname="$pkgname-$version-${iteration}.$rpm_architecture.rpm"
416   fi
417   __returnvar=${complete_pkgname}
418 }
419
420 # Test if the package already exists, if not return 0, if it does return 1
421 test_package_presence() {
422     local pkgname="$1"; shift
423     local version="$1"; shift
424     local pkgtype="$1"; shift
425     local iteration="$1"; shift
426     local arch="$1"; shift
427     if [[ -n "$ONLY_BUILD" ]] && [[ "$pkgname" != "$ONLY_BUILD" ]] ; then
428         return 1
429     fi
430
431     local full_pkgname
432     get_complete_package_name full_pkgname "$pkgname" "$version" "$pkgtype" "$iteration" "$arch"
433
434     # See if we can skip building the package, only if it already exists in the
435     # processed/ directory. If so, move it back to the packages directory to make
436     # sure it gets picked up by the test and/or upload steps.
437     # Get the list of packages from the repos
438
439     if [[ "$FORCE_BUILD" == "1" ]]; then
440       echo "Package $full_pkgname build forced with --force-build, building"
441     elif [[ "$FORMAT" == "deb" ]]; then
442       declare -A dd
443       dd[debian11]=bullseye
444       dd[debian12]=bookworm
445       dd[ubuntu2004]=focal
446       dd[ubuntu2204]=jammy
447       D=${dd[$TARGET]}
448       if [ ${pkgname:0:3} = "lib" ]; then
449         repo_subdir=${pkgname:0:4}
450       else
451         repo_subdir=${pkgname:0:1}
452       fi
453
454       repo_pkg_list=$(curl -s -o - http://apt.arvados.org/${D}/pool/main/${repo_subdir}/${pkgname}/)
455       echo "${repo_pkg_list}" |grep -q ${full_pkgname}
456       if [ $? -eq 0 ] ; then
457         echo "Package $full_pkgname exists upstream, not rebuilding, downloading instead!"
458         curl -s -o "$WORKSPACE/packages/$TARGET/${full_pkgname}" http://apt.arvados.org/${D}/pool/main/${repo_subdir}/${pkgname}/${full_pkgname}
459         return 1
460       elif test -f "$WORKSPACE/packages/$TARGET/processed/${full_pkgname}" ; then
461         echo "Package $full_pkgname exists, not rebuilding!"
462         return 1
463       else
464         echo "Package $full_pkgname not found, building"
465         return 0
466       fi
467     else
468       local rpm_root
469       case "$TARGET" in
470         rocky8) rpm_root="CentOS/8/dev" ;;
471         *)
472           echo "FIXME: Don't know RPM URL path for $TARGET, building"
473           return 0
474           ;;
475       esac
476       local rpm_url="http://rpm.arvados.org/$rpm_root/$arch/$full_pkgname"
477
478       if curl -fs -o "$WORKSPACE/packages/$TARGET/$full_pkgname" "$rpm_url"; then
479         echo "Package $full_pkgname exists upstream, not rebuilding, downloading instead!"
480         return 1
481       elif [[ -f "$WORKSPACE/packages/$TARGET/processed/$full_pkgname" ]]; then
482         echo "Package $full_pkgname exists, not rebuilding!"
483         return 1
484       else
485         echo "Package $full_pkgname not found, building"
486         return 0
487       fi
488     fi
489 }
490
491 handle_rails_package() {
492     local pkgname="$1"; shift
493
494     if [[ -n "$ONLY_BUILD" ]] && [[ "$pkgname" != "$ONLY_BUILD" ]] ; then
495         return 0
496     fi
497     local srcdir="$1"; shift
498     cd "$srcdir"
499     local license_path="$1"; shift
500     local version="$(rails_package_version "$pkgname" "$srcdir")"
501     echo "$version" >package-build.version
502     local scripts_dir="$(mktemp --tmpdir -d "$pkgname-XXXXXXXX.scripts")" && \
503     (
504         set -e
505         _build_rails_package_scripts "$pkgname" "$scripts_dir"
506         cd "$srcdir"
507         mkdir -p tmp
508         git rev-parse HEAD >git-commit.version
509         bundle config set cache_all true
510         bundle package
511     )
512     if [[ 0 != "$?" ]] || ! cd "$WORKSPACE/packages/$TARGET"; then
513         echo "ERROR: $pkgname package prep failed" >&2
514         rm -rf "$scripts_dir"
515         EXITCODE=1
516         return 1
517     fi
518     local railsdir="/var/www/${pkgname%-server}/current"
519     local -a pos_args=("$srcdir/=$railsdir" "$pkgname" dir "$version")
520     local license_arg="$license_path=$railsdir/$(basename "$license_path")"
521     local -a switches=(--after-install "$scripts_dir/postinst"
522                        --before-remove "$scripts_dir/prerm"
523                        --after-remove "$scripts_dir/postrm")
524     if [[ -z "$ARVADOS_BUILDING_VERSION" ]]; then
525         switches+=(--iteration $RAILS_PACKAGE_ITERATION)
526     fi
527     # For some reason fpm excludes need to not start with /.
528     local exclude_root="${railsdir#/}"
529     for exclude in tmp log coverage Capfile\* \
530                        config/deploy\* \
531                        config/application.yml \
532                        config/database.yml; do
533         switches+=(-x "$exclude_root/$exclude")
534     done
535     fpm_build "${srcdir}" "${pos_args[@]}" "${switches[@]}" \
536               -x "$exclude_root/vendor/cache-*" \
537               -x "$exclude_root/vendor/bundle" "$@" "$license_arg"
538     rm -rf "$scripts_dir"
539 }
540
541 # Usage: handle_api_server [amd64|arm64]
542 handle_api_server () {
543   local target_arch="${1:-amd64}"; shift
544
545   if [[ -n "$ONLY_BUILD" ]] && [[ "$ONLY_BUILD" != "arvados-api-server" ]] ; then
546     debug_echo -e "Skipping build of arvados-api-server package."
547     return 0
548   fi
549
550   native_arch=$(get_native_arch)
551   if [[ "$target_arch" != "$native_arch" ]]; then
552     echo "Error: no cross compilation support for Rails yet, can not build arvados-api-server for $ARCH"
553     echo
554     exit 1
555   fi
556
557   # Build the API server package
558   test_rails_package_presence arvados-api-server "$WORKSPACE/services/api"
559   if [[ "$?" == "0" ]]; then
560     calculate_go_package_version arvados_server_version cmd/arvados-server
561     arvados_server_iteration=$(default_iteration "arvados-server" "$arvados_server_version" "go")
562     handle_rails_package arvados-api-server "$WORKSPACE/services/api" \
563         "$WORKSPACE/agpl-3.0.txt" --url="https://arvados.org" \
564         --description="Arvados API server - Arvados is a free and open source platform for big data science." \
565         --license="GNU Affero General Public License, version 3.0" --depends "arvados-server = ${arvados_server_version}-${arvados_server_iteration}"
566   fi
567 }
568
569 # Usage: handle_cwltest [deb|rpm] [amd64|arm64]
570 handle_cwltest () {
571   local package_format="$1"; shift
572   local target_arch="${1:-amd64}"; shift
573
574   if [[ -n "$ONLY_BUILD" ]] && [[ "$ONLY_BUILD" != "python3-cwltest" ]] ; then
575     debug_echo -e "Skipping build of cwltest package."
576     return 0
577   fi
578   cd "$WORKSPACE"
579   if [[ -e "$WORKSPACE/cwltest" ]]; then
580     rm -rf "$WORKSPACE/cwltest"
581   fi
582   git clone https://github.com/common-workflow-language/cwltest.git
583
584   # The subsequent release of cwltest confirms that files exist on disk, since
585   # our files are in Keep, all the tests fail.
586   # We should add [optional] Arvados support to cwltest so it can access
587   # Keep but for the time being just package the last working version.
588   (cd cwltest && git checkout 2.3.20230108193615)
589
590   # signal to our build script that we want a cwltest executable installed in /usr/bin/
591   mkdir cwltest/bin && touch cwltest/bin/cwltest
592   fpm_build_virtualenv "cwltest" "cwltest" "$package_format" "$target_arch"
593   cd "$WORKSPACE"
594   rm -rf "$WORKSPACE/cwltest"
595 }
596
597 # Usage: handle_arvados_src
598 handle_arvados_src () {
599   if [[ -n "$ONLY_BUILD" ]] && [[ "$ONLY_BUILD" != "arvados-src" ]] ; then
600     debug_echo -e "Skipping build of arvados-src package."
601     return 0
602   fi
603   # arvados-src
604   (
605       cd "$WORKSPACE"
606       COMMIT_HASH=$(format_last_commit_here "%H")
607       arvados_src_version="$(version_from_git)"
608
609       cd $WORKSPACE/packages/$TARGET
610       test_package_presence arvados-src "$arvados_src_version" src ""
611
612       if [[ "$?" == "0" ]]; then
613         cd "$WORKSPACE"
614         SRC_BUILD_DIR=$(mktemp -d)
615         # mktemp creates the directory with 0700 permissions by default
616         chmod 755 $SRC_BUILD_DIR
617         git clone $DASHQ_UNLESS_DEBUG "$WORKSPACE/.git" "$SRC_BUILD_DIR"
618         cd "$SRC_BUILD_DIR"
619
620         # go into detached-head state
621         git checkout $DASHQ_UNLESS_DEBUG "$COMMIT_HASH"
622         echo "$COMMIT_HASH" >git-commit.version
623
624         cd $WORKSPACE/packages/$TARGET
625         fpm_build "$WORKSPACE" $SRC_BUILD_DIR/=/usr/local/arvados/src arvados-src 'dir' "$arvados_src_version" "--exclude=usr/local/arvados/src/.git" "--url=https://arvados.org" "--license=GNU Affero General Public License, version 3.0" "--description=The Arvados source code" "--architecture=all"
626
627         rm -rf "$SRC_BUILD_DIR"
628       fi
629   )
630 }
631
632 # Build python packages with a virtualenv built-in
633 # Usage: fpm_build_virtualenv arvados-python-client sdk/python [deb|rpm] [amd64|arm64]
634 fpm_build_virtualenv () {
635   local pkg=$1; shift
636   local pkg_dir=$1; shift
637   local package_format="$1"; shift
638   local target_arch="${1:-amd64}"; shift
639
640   native_arch=$(get_native_arch)
641
642   if [[ "$pkg" != "arvados-docker-cleaner" ]]; then
643     PYTHON_PKG=$PYTHON3_PKG_PREFIX-$pkg
644   else
645     # Exception to our package naming convention
646     PYTHON_PKG=$pkg
647   fi
648
649   if [[ -n "$ONLY_BUILD" ]] && [[ "$PYTHON_PKG" != "$ONLY_BUILD" ]]; then
650     # arvados-python-client sdist should always be built if we are building a
651     # python package.
652     if [[ "$ONLY_BUILD" != "python3-arvados-cwl-runner" ]] &&
653        [[ "$ONLY_BUILD" != "python3-arvados-fuse" ]] &&
654        [[ "$ONLY_BUILD" != "python3-crunchstat-summary" ]] &&
655        [[ "$ONLY_BUILD" != "arvados-docker-cleaner" ]] &&
656        [[ "$ONLY_BUILD" != "python3-arvados-user-activity" ]]; then
657       debug_echo -e "Skipping build of $pkg package."
658       return 0
659     fi
660   fi
661
662   if [[ -n "$target_arch" ]] && [[ "$native_arch" == "$target_arch" ]]; then
663       fpm_build_virtualenv_worker "$pkg" "$pkg_dir" "$package_format" "$native_arch" "$target_arch"
664   elif [[ -z "$target_arch" ]]; then
665     fpm_build_virtualenv_worker "$pkg" "$pkg_dir" "$package_format" "$native_arch" "$native_arch"
666   else
667     echo "Error: no cross compilation support for Python yet, can not build $pkg for $target_arch"
668     return 1
669   fi
670 }
671
672 # Build python packages with a virtualenv built-in
673 # Usage: fpm_build_virtualenv_worker arvados-python-client sdk/python python3 [deb|rpm] [amd64|arm64] [amd64|arm64]
674 fpm_build_virtualenv_worker () {
675   PKG=$1; shift
676   PKG_DIR=$1; shift
677   local package_format="$1"; shift
678   local native_arch="${1:-amd64}"; shift
679   local target_arch=${1:-amd64}; shift
680
681   # Set up
682   STDOUT_IF_DEBUG=/dev/null
683   STDERR_IF_DEBUG=/dev/null
684   DASHQ_UNLESS_DEBUG=-q
685   if [[ "$DEBUG" != "0" ]]; then
686       STDOUT_IF_DEBUG=/dev/stdout
687       STDERR_IF_DEBUG=/dev/stderr
688       DASHQ_UNLESS_DEBUG=
689   fi
690   if [[ "$ARVADOS_BUILDING_ITERATION" == "" ]]; then
691     ARVADOS_BUILDING_ITERATION=1
692   fi
693
694   PACKAGE_PREFIX=$PYTHON3_PKG_PREFIX
695   if [[ "$PKG" != "arvados-docker-cleaner" ]]; then
696     PYTHON_PKG=$PACKAGE_PREFIX-$PKG
697   else
698     # Exception to our package naming convention
699     PYTHON_PKG=$PKG
700   fi
701
702   cd $WORKSPACE/$PKG_DIR
703
704   rm -rf dist/*
705   local venv_dir="dist/build/usr/lib/$PYTHON_PKG"
706   echo "Creating virtualenv..."
707   if ! "$PYTHON3_EXECUTABLE" -m venv "$venv_dir"; then
708     printf "Error, unable to run\n  %s -m venv %s\n" "$PYTHON3_EXECUTABLE" "$venv_dir"
709     exit 1
710   fi
711
712   local venv_py="$venv_dir/bin/python$PYTHON3_VERSION"
713   if ! "$venv_py" -m pip install --upgrade $DASHQ_UNLESS_DEBUG $CACHE_FLAG pip setuptools wheel; then
714     printf "Error, unable to upgrade pip, setuptools, and wheel with
715   %s -m pip install --upgrade $DASHQ_UNLESS_DEBUG $CACHE_FLAG pip setuptools wheel
716 " "$venv_py"
717     exit 1
718   fi
719
720   # filter a useless warning (when building the cwltest package) from the stderr output
721   if ! "$venv_py" setup.py $DASHQ_UNLESS_DEBUG sdist 2> >(grep -v 'warning: no previously-included files matching'); then
722     echo "Error, unable to run $venv_py setup.py sdist for $PKG"
723     exit 1
724   fi
725
726   if [[ "arvados-python-client" == "$PKG" ]]; then
727     PYSDK_PATH="-f $(pwd)/dist/"
728   fi
729
730   if [[ -n "$ONLY_BUILD" ]] && [[ "$PYTHON_PKG" != "$ONLY_BUILD" ]] && [[ "$PKG" != "$ONLY_BUILD" ]]; then
731     return 0
732   fi
733
734   # Determine the package version from the generated sdist archive
735   if [[ -n "$ARVADOS_BUILDING_VERSION" ]] ; then
736       UNFILTERED_PYTHON_VERSION=$ARVADOS_BUILDING_VERSION
737       PYTHON_VERSION=$(echo -n $ARVADOS_BUILDING_VERSION | sed s/~dev/.dev/g | sed s/~rc/rc/g)
738   else
739       PYTHON_VERSION=$(awk '($1 == "Version:"){print $2}' *.egg-info/PKG-INFO)
740       UNFILTERED_PYTHON_VERSION=$(echo -n $PYTHON_VERSION | sed s/\.dev/~dev/g |sed 's/\([0-9]\)rc/\1~rc/g')
741   fi
742
743   # See if we actually need to build this package; does it exist already?
744   # We can't do this earlier than here, because we need PYTHON_VERSION.
745   if ! test_package_presence "$PYTHON_PKG" "$UNFILTERED_PYTHON_VERSION" python3 "$ARVADOS_BUILDING_ITERATION" "$target_arch"; then
746     return 0
747   fi
748
749   echo "Building $package_format ($target_arch) package for $PKG from $PKG_DIR"
750
751   local sdist_path="$(ls dist/*.tar.gz)"
752   if ! "$venv_py" -m pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG $PYSDK_PATH "$sdist_path"; then
753     printf "Error, unable to run
754   %s -m pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG %s %s
755 " "$venv_py" "$PYSDK_PATH" "$sdist_path"
756     exit 1
757   fi
758
759   pushd "$venv_dir" >$STDOUT_IF_DEBUG
760
761   # Replace the shebang lines in all python scripts, and handle the activate
762   # scripts too. This is a functional replacement of the 237 line
763   # virtualenv_tools.py script that doesn't work in python3 without serious
764   # patching, minus the parts we don't need (modifying pyc files, etc).
765   local sys_venv_dir="${venv_dir#dist/build/}"
766   local sys_venv_py="$sys_venv_dir/bin/python$PYTHON3_VERSION"
767   for binfile in `ls bin/`; do
768     if file --mime "bin/$binfile" | grep -q binary; then
769       :  # Nothing to do for binary files
770     elif [[ "$binfile" =~ ^activate(.csh|.fish|)$ ]]; then
771       sed -ri "s@VIRTUAL_ENV(=| )\".*\"@VIRTUAL_ENV\\1\"/$sys_venv_dir\"@" "bin/$binfile"
772     else
773       # Replace shebang line
774       sed -ri "1 s@^#\![^[:space:]]+/bin/python[0-9.]*@#\!/$sys_venv_py@" "bin/$binfile"
775     fi
776   done
777
778   popd >$STDOUT_IF_DEBUG
779   cd dist
780
781   find build -iname '*.py[co]' -delete
782
783   # Finally, generate the package
784   echo "Creating package..."
785
786   declare -a COMMAND_ARR=("fpm" "-s" "dir" "-t" "$package_format")
787
788   if [[ -n "$target_arch" ]] && [[ "$target_arch" != "amd64" ]]; then
789     COMMAND_ARR+=("-a$target_arch")
790   fi
791
792   if [[ "$MAINTAINER" != "" ]]; then
793     COMMAND_ARR+=('--maintainer' "$MAINTAINER")
794   fi
795
796   if [[ "$VENDOR" != "" ]]; then
797     COMMAND_ARR+=('--vendor' "$VENDOR")
798   fi
799
800   COMMAND_ARR+=('--url' 'https://arvados.org')
801
802   # Get description
803   DESCRIPTION=`grep '\sdescription' $WORKSPACE/$PKG_DIR/setup.py|cut -f2 -d=|sed -e "s/[',\\"]//g"`
804   COMMAND_ARR+=('--description' "$DESCRIPTION")
805
806   # Get license string
807   LICENSE_STRING=`grep license $WORKSPACE/$PKG_DIR/setup.py|cut -f2 -d=|sed -e "s/[',\\"]//g"`
808   COMMAND_ARR+=('--license' "$LICENSE_STRING")
809
810   if [[ "$DEBUG" != "0" ]]; then
811     COMMAND_ARR+=('--verbose' '--log' 'info')
812   fi
813
814   COMMAND_ARR+=('-v' $(echo -n "$PYTHON_VERSION" | sed s/.dev/~dev/g | sed s/rc/~rc/g))
815   COMMAND_ARR+=('--iteration' "$ARVADOS_BUILDING_ITERATION")
816   COMMAND_ARR+=('-n' "$PYTHON_PKG")
817   COMMAND_ARR+=('-C' "build")
818
819   systemd_unit="$WORKSPACE/$PKG_DIR/$PKG.service"
820   if [[ -e "${systemd_unit}" ]]; then
821     COMMAND_ARR+=('--after-install' "${WORKSPACE}/build/go-python-package-scripts/postinst")
822     COMMAND_ARR+=('--before-remove' "${WORKSPACE}/build/go-python-package-scripts/prerm")
823   fi
824
825   COMMAND_ARR+=('--depends' "$PYTHON3_PACKAGE")
826   case "$package_format" in
827       deb)
828           COMMAND_ARR+=(
829               # Avoid warning
830               --deb-no-default-config-files
831           ) ;;
832       rpm)
833           COMMAND_ARR+=(
834               # Conflict with older packages we used to publish
835               --conflicts "rh-python36-python-$PKG"
836               # Do not generate /usr/lib/.build-id links on RH8+
837               # (otherwise our packages conflict with platform-python)
838               --rpm-rpmbuild-define "_build_id_links none"
839           ) ;;
840   esac
841
842   # Append --depends X and other arguments specified by fpm-info.sh in
843   # the package source dir. These are added last so they can override
844   # the arguments added by this script.
845   declare -a fpm_args=()
846   declare -a fpm_depends=()
847
848   fpminfo="$WORKSPACE/$PKG_DIR/fpm-info.sh"
849   if [[ -e "$fpminfo" ]]; then
850     echo "Loading fpm overrides from $fpminfo"
851     if ! source "$fpminfo"; then
852       echo "Error, unable to source $WORKSPACE/$PKG_DIR/fpm-info.sh for $PKG"
853       exit 1
854     fi
855   fi
856
857   for i in "${fpm_depends[@]}"; do
858     COMMAND_ARR+=('--depends' "$i")
859   done
860
861   for i in "${fpm_depends[@]}"; do
862     COMMAND_ARR+=('--replaces' "python-$PKG")
863   done
864
865   # make sure the systemd service file ends up in the right place
866   # used by arvados-docker-cleaner
867   if [[ -e "${systemd_unit}" ]]; then
868     COMMAND_ARR+=("$sys_venv_dir/share/doc/$PKG/$PKG.service=/lib/systemd/system/$PKG.service")
869   fi
870
871   COMMAND_ARR+=("${fpm_args[@]}")
872
873   # Make sure to install all our package binaries in /usr/bin. We have to
874   # walk $WORKSPACE/$PKG_DIR/bin rather than $venv_dir/bin to get the list
875   # because the latter also includes scripts installed by all the
876   # dependencies in the virtualenv, which may conflict with other
877   # packages. We have to take the copies of our binaries from the latter
878   # directory, though, because those are the ones we rewrote the shebang
879   # line of, above.
880   if [[ -e "$WORKSPACE/$PKG_DIR/bin" ]]; then
881     for binary in `ls $WORKSPACE/$PKG_DIR/bin`; do
882       COMMAND_ARR+=("$sys_venv_dir/bin/$binary=/usr/bin/")
883     done
884   fi
885
886   # the python3-arvados-cwl-runner package comes with cwltool, expose that version
887   if [[ -e "$WORKSPACE/$PKG_DIR/$venv_dir/bin/cwltool" ]]; then
888     COMMAND_ARR+=("$sys_venv_dir/bin/cwltool=/usr/bin/")
889   fi
890
891   COMMAND_ARR+=(".")
892
893   debug_echo -e "\n${COMMAND_ARR[@]}\n"
894
895   FPM_RESULTS=$("${COMMAND_ARR[@]}")
896   FPM_EXIT_CODE=$?
897
898   # if something went wrong and debug is off, print out the fpm command that errored
899   if ! fpm_verify $FPM_EXIT_CODE $FPM_RESULTS && [[ "$STDOUT_IF_DEBUG" == "/dev/null" ]]; then
900     echo "fpm returned an error executing the command:"
901     echo
902     echo -e "\n${COMMAND_ARR[@]}\n"
903   else
904     echo `ls *$package_format`
905     mv $WORKSPACE/$PKG_DIR/dist/*$package_format $WORKSPACE/packages/$TARGET/
906   fi
907   echo
908 }
909
910 # Build packages for everything
911 fpm_build() {
912   # Source dir where fpm-info.sh (if any) will be found.
913   SRC_DIR=$1
914   shift
915   # The package source.  Depending on the source type, this can be a
916   # path, or the name of the package in an upstream repository (e.g.,
917   # pip).
918   PACKAGE=$1
919   shift
920   # The name of the package to build.
921   PACKAGE_NAME=$1
922   shift
923   # The type of source package.  Passed to fpm -s.  Default "dir".
924   PACKAGE_TYPE=${1:-dir}
925   shift
926   # Optional: the package version number.  Passed to fpm -v.
927   VERSION=$1
928   shift
929
930   if [[ -n "$ONLY_BUILD" ]] && [[ "$PACKAGE_NAME" != "$ONLY_BUILD" ]] && [[ "$PACKAGE" != "$ONLY_BUILD" ]] ; then
931       return 0
932   fi
933
934   local default_iteration_value="$(default_iteration "$PACKAGE" "$VERSION" "$PACKAGE_TYPE")"
935
936   declare -a COMMAND_ARR=("fpm" "-s" "$PACKAGE_TYPE" "-t" "$FORMAT")
937   if [ python = "$PACKAGE_TYPE" ] && [ deb = "$FORMAT" ]; then
938       # Dependencies are built from setup.py.  Since setup.py will never
939       # refer to Debian package iterations, it doesn't make sense to
940       # enforce those in the .deb dependencies.
941       COMMAND_ARR+=(--deb-ignore-iteration-in-dependencies)
942   fi
943
944   if [[ "$DEBUG" != "0" ]]; then
945     COMMAND_ARR+=('--verbose' '--log' 'info')
946   fi
947
948   if [[ -n "$PACKAGE_NAME" ]]; then
949     COMMAND_ARR+=('-n' "$PACKAGE_NAME")
950   fi
951
952   if [[ "$MAINTAINER" != "" ]]; then
953     COMMAND_ARR+=('--maintainer' "$MAINTAINER")
954   fi
955
956   if [[ "$VENDOR" != "" ]]; then
957     COMMAND_ARR+=('--vendor' "$VENDOR")
958   fi
959
960   if [[ "$VERSION" != "" ]]; then
961     COMMAND_ARR+=('-v' "$VERSION")
962   fi
963   if [[ -n "$default_iteration_value" ]]; then
964       # We can always add an --iteration here.  If another one is specified in $@,
965       # that will take precedence, as desired.
966       COMMAND_ARR+=(--iteration "$default_iteration_value")
967   fi
968
969   # Append --depends X and other arguments specified by fpm-info.sh in
970   # the package source dir. These are added last so they can override
971   # the arguments added by this script.
972   declare -a fpm_args=()
973   declare -a build_depends=()
974   declare -a fpm_depends=()
975   declare -a fpm_conflicts=()
976   declare -a fpm_exclude=()
977   if [[ ! -d "$SRC_DIR" ]]; then
978       echo >&2 "BUG: looking in wrong dir for fpm-info.sh: $pkgdir"
979       exit 1
980   fi
981   fpminfo="${SRC_DIR}/fpm-info.sh"
982   if [[ -e "$fpminfo" ]]; then
983       debug_echo "Loading fpm overrides from $fpminfo"
984       source "$fpminfo"
985   fi
986   for pkg in "${build_depends[@]}"; do
987       if [[ $TARGET =~ debian|ubuntu ]]; then
988           pkg_deb=$(ls "$WORKSPACE/packages/$TARGET/$pkg_"*.deb | sort -rg | awk 'NR==1')
989           if [[ -e $pkg_deb ]]; then
990               echo "Installing build_dep $pkg from $pkg_deb"
991               dpkg -i "$pkg_deb"
992           else
993               echo "Attemping to install build_dep $pkg using apt-get"
994               apt-get install -y "$pkg"
995           fi
996           apt-get -y -f install
997       else
998           pkg_rpm=$(ls "$WORKSPACE/packages/$TARGET/$pkg"-[0-9]*.rpm | sort -rg | awk 'NR==1')
999           if [[ -e $pkg_rpm ]]; then
1000               echo "Installing build_dep $pkg from $pkg_rpm"
1001               rpm -i "$pkg_rpm"
1002           else
1003               echo "Attemping to install build_dep $pkg"
1004               rpm -i "$pkg"
1005           fi
1006       fi
1007   done
1008   for i in "${fpm_depends[@]}"; do
1009     COMMAND_ARR+=('--depends' "$i")
1010   done
1011   for i in "${fpm_conflicts[@]}"; do
1012     COMMAND_ARR+=('--conflicts' "$i")
1013   done
1014   for i in "${fpm_exclude[@]}"; do
1015     COMMAND_ARR+=('--exclude' "$i")
1016   done
1017
1018   COMMAND_ARR+=("${fpm_args[@]}")
1019
1020   # Append remaining function arguments directly to fpm's command line.
1021   for i; do
1022     COMMAND_ARR+=("$i")
1023   done
1024
1025   COMMAND_ARR+=("$PACKAGE")
1026
1027   debug_echo -e "\n${COMMAND_ARR[@]}\n"
1028
1029   FPM_RESULTS=$("${COMMAND_ARR[@]}")
1030   FPM_EXIT_CODE=$?
1031   echo "fpm: exit code $FPM_EXIT_CODE" >>$STDOUT_IF_DEBUG
1032   echo "$FPM_RESULTS" >>$STDOUT_IF_DEBUG
1033
1034   fpm_verify $FPM_EXIT_CODE $FPM_RESULTS
1035
1036   # if something went wrong and debug is off, print out the fpm command that errored
1037   if [[ 0 -ne $? ]] && [[ "$STDOUT_IF_DEBUG" == "/dev/null" ]]; then
1038     echo -e "\n${COMMAND_ARR[@]}\n"
1039   fi
1040 }
1041
1042 # verify build results
1043 fpm_verify () {
1044   FPM_EXIT_CODE=$1
1045   shift
1046   FPM_RESULTS=$@
1047
1048   FPM_PACKAGE_NAME=''
1049   if [[ $FPM_RESULTS =~ ([A-Za-z0-9_\.~-]*\.)(deb|rpm) ]]; then
1050     FPM_PACKAGE_NAME=${BASH_REMATCH[1]}${BASH_REMATCH[2]}
1051   fi
1052
1053   if [[ "$FPM_PACKAGE_NAME" == "" ]]; then
1054     EXITCODE=1
1055     echo
1056     echo "Error: $PACKAGE: Unable to figure out package name from fpm results:"
1057     echo
1058     echo $FPM_RESULTS
1059     echo
1060     return 1
1061   elif [[ "$FPM_RESULTS" =~ "File already exists" ]]; then
1062     echo "Package $FPM_PACKAGE_NAME exists, not rebuilding"
1063     return 0
1064   elif [[ 0 -ne "$FPM_EXIT_CODE" ]]; then
1065     EXITCODE=1
1066     echo "Error building package for $1:\n $FPM_RESULTS"
1067     return 1
1068   fi
1069 }
1070
1071 install_package() {
1072   PACKAGES=$@
1073   if [[ "$FORMAT" == "deb" ]]; then
1074     $SUDO apt-get install $PACKAGES --yes
1075   elif [[ "$FORMAT" == "rpm" ]]; then
1076     $SUDO yum -q -y install $PACKAGES
1077   fi
1078 }
1079
1080 title() {
1081     printf '%s %s\n' "=======" "$1"
1082 }
1083
1084 checkexit() {
1085     if [[ "$1" != "0" ]]; then
1086         title "$2 -- FAILED"
1087         failures+=("$2 (`timer`)")
1088     else
1089         successes+=("$2 (`timer`)")
1090     fi
1091 }
1092
1093 timer_reset() {
1094     t0=$SECONDS
1095 }
1096
1097 timer() {
1098     if [[ -n "$t0" ]]; then
1099         echo -n "$(($SECONDS - $t0))s"
1100     fi
1101 }
1102
1103 report_outcomes() {
1104     for x in "${successes[@]}"
1105     do
1106         echo "Pass: $x"
1107     done
1108
1109     if [[ ${#failures[@]} == 0 ]]
1110     then
1111         if [[ ${#successes[@]} != 0 ]]; then
1112            echo "All test suites passed."
1113         fi
1114     else
1115         echo "Failures (${#failures[@]}):"
1116         for x in "${failures[@]}"
1117         do
1118             echo "Fail: $x"
1119         done
1120     fi
1121 }