17495: Merge branch 'master' into 17495-document-dedup-report
[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 handle_ruby_gem() {
83     local gem_name="$1"; shift
84     local gem_version="$(nohash_version_from_git)"
85     local gem_src_dir="$(pwd)"
86
87     if [[ -n "$ONLY_BUILD" ]] && [[ "$gem_name" != "$ONLY_BUILD" ]] ; then
88         return 0
89     fi
90
91     if ! [[ -e "${gem_name}-${gem_version}.gem" ]]; then
92         find -maxdepth 1 -name "${gem_name}-*.gem" -delete
93
94         # -q appears to be broken in gem version 2.2.2
95         $GEM build "$gem_name.gemspec" $DASHQ_UNLESS_DEBUG >"$STDOUT_IF_DEBUG" 2>"$STDERR_IF_DEBUG"
96     fi
97 }
98
99 calculate_go_package_version() {
100   # $__returnvar has the nameref attribute set, which means it is a reference
101   # to another variable that is passed in as the first argument to this function.
102   # see https://www.gnu.org/software/bash/manual/html_node/Shell-Parameters.html
103   local -n __returnvar="$1"; shift
104   local oldpwd="$PWD"
105
106   cd "$WORKSPACE"
107   go mod download
108
109   # Update the version number and build a new package if the vendor
110   # bundle has changed, or the command imports anything from the
111   # Arvados SDK and the SDK has changed.
112   declare -a checkdirs=(go.mod go.sum)
113   while [ -n "$1" ]; do
114       checkdirs+=("$1")
115       shift
116   done
117   # Even our rails packages (version calculation happens here!) depend on a go component (arvados-server)
118   # Everything depends on the build directory.
119   checkdirs+=(sdk/go lib build)
120   local timestamp=0
121   for dir in ${checkdirs[@]}; do
122       cd "$WORKSPACE"
123       ts="$(timestamp_from_git "$dir")"
124       if [[ "$ts" -gt "$timestamp" ]]; then
125           version=$(version_from_git "$dir")
126           timestamp="$ts"
127       fi
128   done
129   cd "$oldpwd"
130   __returnvar="$version"
131 }
132
133 # Usage: package_go_binary services/foo arvados-foo "Compute foo to arbitrary precision" [apache-2.0.txt]
134 package_go_binary() {
135     local src_path="$1"; shift
136     local prog="$1"; shift
137     local description="$1"; shift
138     local license_file="${1:-agpl-3.0.txt}"; shift
139
140     if [[ -n "$ONLY_BUILD" ]] && [[ "$prog" != "$ONLY_BUILD" ]]; then
141       # arvados-workbench depends on arvados-server at build time, so even when
142       # only arvados-workbench is being built, we need to build arvados-server too
143       if [[ "$prog" != "arvados-server" ]] || [[ "$ONLY_BUILD" != "arvados-workbench" ]]; then
144         return 0
145       fi
146     fi
147
148     debug_echo "package_go_binary $src_path as $prog"
149
150     local basename="${src_path##*/}"
151     calculate_go_package_version go_package_version $src_path
152
153     cd $WORKSPACE/packages/$TARGET
154     test_package_presence $prog $go_package_version go
155
156     if [[ "$?" != "0" ]]; then
157       return 1
158     fi
159
160     go get -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"
161
162     local -a switches=()
163     systemd_unit="$WORKSPACE/${src_path}/${prog}.service"
164     if [[ -e "${systemd_unit}" ]]; then
165         switches+=(
166             --after-install "${WORKSPACE}/build/go-python-package-scripts/postinst"
167             --before-remove "${WORKSPACE}/build/go-python-package-scripts/prerm"
168             "${systemd_unit}=/lib/systemd/system/${prog}.service")
169     fi
170     switches+=("$WORKSPACE/${license_file}=/usr/share/doc/$prog/${license_file}")
171
172     fpm_build "${WORKSPACE}/${src_path}" "$GOPATH/bin/${basename}=/usr/bin/${prog}" "${prog}" dir "${go_package_version}" "--url=https://arvados.org" "--license=GNU Affero General Public License, version 3.0" "--description=${description}" "${switches[@]}"
173 }
174
175 # Usage: package_go_so lib/foo arvados_foo.so arvados-foo "Arvados foo library"
176 package_go_so() {
177     local src_path="$1"; shift
178     local sofile="$1"; shift
179     local pkg="$1"; shift
180     local description="$1"; shift
181
182     debug_echo "package_go_so $src_path as $pkg"
183
184     calculate_go_package_version go_package_version $src_path
185     cd $WORKSPACE/packages/$TARGET
186     test_package_presence $pkg $go_package_version go || return 1
187     cd $WORKSPACE/$src_path
188     go build -buildmode=c-shared -o ${GOPATH}/bin/${sofile}
189     cd $WORKSPACE/packages/$TARGET
190     local -a fpmargs=(
191         "--url=https://arvados.org"
192         "--license=Apache License, Version 2.0"
193         "--description=${description}"
194         "$WORKSPACE/apache-2.0.txt=/usr/share/doc/$pkg/apache-2.0.txt"
195     )
196     if [[ -e "$WORKSPACE/$src_path/pam-configs-arvados" ]]; then
197         fpmargs+=("$WORKSPACE/$src_path/pam-configs-arvados=/usr/share/doc/$pkg/pam-configs-arvados-go")
198     fi
199     if [[ -e "$WORKSPACE/$src_path/README" ]]; then
200         fpmargs+=("$WORKSPACE/$src_path/README=/usr/share/doc/$pkg/README")
201     fi
202     fpm_build "${WORKSPACE}/${src_path}" "$GOPATH/bin/${sofile}=/usr/lib/${sofile}" "${pkg}" dir "${go_package_version}" "${fpmargs[@]}"
203 }
204
205 default_iteration() {
206     if [[ -n "$ARVADOS_BUILDING_VERSION" ]]; then
207         echo "$ARVADOS_BUILDING_ITERATION"
208         return
209     fi
210     local package_name="$1"; shift
211     local package_version="$1"; shift
212     local package_type="$1"; shift
213     local iteration=1
214     if [[ $package_version =~ ^0\.1\.([0-9]{14})(\.|$) ]] && \
215            [[ ${BASH_REMATCH[1]} -le $LICENSE_PACKAGE_TS ]]; then
216         iteration=2
217     fi
218     echo $iteration
219 }
220
221 _build_rails_package_scripts() {
222     local pkgname="$1"; shift
223     local destdir="$1"; shift
224     local srcdir="$RUN_BUILD_PACKAGES_PATH/rails-package-scripts"
225     for scriptname in postinst prerm postrm; do
226         cat "$srcdir/$pkgname.sh" "$srcdir/step2.sh" "$srcdir/$scriptname.sh" \
227             >"$destdir/$scriptname" || return $?
228     done
229 }
230
231 rails_package_version() {
232     local pkgname="$1"; shift
233     local srcdir="$1"; shift
234     if [[ -n "$ARVADOS_BUILDING_VERSION" ]]; then
235         echo "$ARVADOS_BUILDING_VERSION"
236         return
237     fi
238     local version="$(version_from_git)"
239     if [ $pkgname = "arvados-api-server" -o $pkgname = "arvados-workbench" ] ; then
240         calculate_go_package_version version cmd/arvados-server "$srcdir"
241     fi
242     echo $version
243 }
244
245 test_rails_package_presence() {
246   local pkgname="$1"; shift
247   local srcdir="$1"; shift
248
249   if [[ -n "$ONLY_BUILD" ]] && [[ "$pkgname" != "$ONLY_BUILD" ]] ; then
250     return 1
251   fi
252
253   tmppwd=`pwd`
254
255   cd $srcdir
256
257   local version="$(rails_package_version "$pkgname" "$srcdir")"
258
259   cd $tmppwd
260
261   test_package_presence $pkgname $version rails "$RAILS_PACKAGE_ITERATION"
262 }
263
264 get_complete_package_name() {
265   # if the errexit flag is set, unset it until this function returns
266   # otherwise, the shift calls below will abort the program if optional arguments are not supplied
267   if [ -o errexit ]; then
268     set +e
269     trap 'set -e' RETURN
270   fi
271   # $__returnvar has the nameref attribute set, which means it is a reference
272   # to another variable that is passed in as the first argument to this function.
273   # see https://www.gnu.org/software/bash/manual/html_node/Shell-Parameters.html
274   local -n __returnvar="$1"; shift
275   local pkgname="$1"; shift
276   local version="$1"; shift
277   local pkgtype="$1"; shift
278   local iteration="$1"; shift
279   local arch="$1"; shift
280   if [[ "$iteration" == "" ]]; then
281       iteration="$(default_iteration "$pkgname" "$version" "$pkgtype")"
282   fi
283
284   if [[ "$arch" == "" ]]; then
285     rpm_architecture="x86_64"
286     deb_architecture="amd64"
287
288     if [[ "$pkgtype" =~ ^(src)$ ]]; then
289       rpm_architecture="noarch"
290       deb_architecture="all"
291     fi
292
293     # These python packages have binary components
294     if [[ "$pkgname" =~ (ruamel|ciso|pycrypto|pyyaml) ]]; then
295       rpm_architecture="x86_64"
296       deb_architecture="amd64"
297     fi
298   else
299     rpm_architecture=$arch
300     deb_architecture=$arch
301   fi
302
303   local complete_pkgname="${pkgname}_$version${iteration:+-$iteration}_$deb_architecture.deb"
304   if [[ "$FORMAT" == "rpm" ]]; then
305       # rpm packages get iteration 1 if we don't supply one
306       iteration=${iteration:-1}
307       complete_pkgname="$pkgname-$version-${iteration}.$rpm_architecture.rpm"
308   fi
309   __returnvar=${complete_pkgname}
310 }
311
312 # Test if the package already exists, if not return 0, if it does return 1
313 test_package_presence() {
314     local pkgname="$1"; shift
315     local version="$1"; shift
316     local pkgtype="$1"; shift
317     local iteration="$1"; shift
318     local arch="$1"; shift
319     if [[ -n "$ONLY_BUILD" ]] && [[ "$pkgname" != "$ONLY_BUILD" ]] ; then
320       # arvados-workbench depends on arvados-server at build time, so even when
321       # only arvados-workbench is being built, we need to build arvados-server too
322       if [[ "$pkgname" != "arvados-server" ]] || [[ "$ONLY_BUILD" != "arvados-workbench" ]]; then
323         return 1
324       fi
325     fi
326
327     local full_pkgname
328     get_complete_package_name full_pkgname $pkgname $version $pkgtype $iteration $arch
329
330     # See if we can skip building the package, only if it already exists in the
331     # processed/ directory. If so, move it back to the packages directory to make
332     # sure it gets picked up by the test and/or upload steps.
333     # Get the list of packages from the repos
334
335     if [[ "$FORCE_BUILD" == "1" ]]; then
336       echo "Package $full_pkgname build forced with --force-build, building"
337     elif [[ "$FORMAT" == "deb" ]]; then
338       declare -A dd
339       dd[debian10]=buster
340       dd[ubuntu1604]=xenial
341       dd[ubuntu1804]=bionic
342       dd[ubuntu2004]=focal
343       D=${dd[$TARGET]}
344       if [ ${pkgname:0:3} = "lib" ]; then
345         repo_subdir=${pkgname:0:4}
346       else
347         repo_subdir=${pkgname:0:1}
348       fi
349
350       repo_pkg_list=$(curl -s -o - http://apt.arvados.org/${D}/pool/main/${repo_subdir}/${pkgname}/)
351       echo "${repo_pkg_list}" |grep -q ${full_pkgname}
352       if [ $? -eq 0 ] ; then
353         echo "Package $full_pkgname exists upstream, not rebuilding, downloading instead!"
354         curl -s -o "$WORKSPACE/packages/$TARGET/${full_pkgname}" http://apt.arvados.org/${D}/pool/main/${repo_subdir}/${pkgname}/${full_pkgname}
355         return 1
356       elif test -f "$WORKSPACE/packages/$TARGET/processed/${full_pkgname}" ; then
357         echo "Package $full_pkgname exists, not rebuilding!"
358         return 1
359       else
360         echo "Package $full_pkgname not found, building"
361         return 0
362       fi
363     else
364       centos_repo="http://rpm.arvados.org/CentOS/7/dev/x86_64/"
365
366       repo_pkg_list=$(curl -s -o - ${centos_repo})
367       echo ${repo_pkg_list} |grep -q ${full_pkgname}
368       if [ $? -eq 0 ]; then
369         echo "Package $full_pkgname exists upstream, not rebuilding, downloading instead!"
370         curl -s -o "$WORKSPACE/packages/$TARGET/${full_pkgname}" ${centos_repo}${full_pkgname}
371         return 1
372       elif test -f "$WORKSPACE/packages/$TARGET/processed/${full_pkgname}" ; then
373         echo "Package $full_pkgname exists, not rebuilding!"
374         return 1
375       else
376         echo "Package $full_pkgname not found, building"
377         return 0
378       fi
379     fi
380 }
381
382 handle_rails_package() {
383     local pkgname="$1"; shift
384
385     if [[ -n "$ONLY_BUILD" ]] && [[ "$pkgname" != "$ONLY_BUILD" ]] ; then
386         return 0
387     fi
388     local srcdir="$1"; shift
389     cd "$srcdir"
390     local license_path="$1"; shift
391     local version="$(rails_package_version "$pkgname" "$srcdir")"
392     echo "$version" >package-build.version
393     local scripts_dir="$(mktemp --tmpdir -d "$pkgname-XXXXXXXX.scripts")" && \
394     (
395         set -e
396         _build_rails_package_scripts "$pkgname" "$scripts_dir"
397         cd "$srcdir"
398         mkdir -p tmp
399         git rev-parse HEAD >git-commit.version
400         bundle package --all
401     )
402     if [[ 0 != "$?" ]] || ! cd "$WORKSPACE/packages/$TARGET"; then
403         echo "ERROR: $pkgname package prep failed" >&2
404         rm -rf "$scripts_dir"
405         EXITCODE=1
406         return 1
407     fi
408     local railsdir="/var/www/${pkgname%-server}/current"
409     local -a pos_args=("$srcdir/=$railsdir" "$pkgname" dir "$version")
410     local license_arg="$license_path=$railsdir/$(basename "$license_path")"
411     local -a switches=(--after-install "$scripts_dir/postinst"
412                        --before-remove "$scripts_dir/prerm"
413                        --after-remove "$scripts_dir/postrm")
414     if [[ -z "$ARVADOS_BUILDING_VERSION" ]]; then
415         switches+=(--iteration $RAILS_PACKAGE_ITERATION)
416     fi
417     # For some reason fpm excludes need to not start with /.
418     local exclude_root="${railsdir#/}"
419     local -a exclude_list=(tmp log coverage Capfile\* \
420                            config/deploy\* config/application.yml)
421     # for arvados-workbench, we need to have the (dummy) config/database.yml in the package
422     if  [[ "$pkgname" != "arvados-workbench" ]]; then
423       exclude_list+=('config/database.yml')
424     fi
425     for exclude in ${exclude_list[@]}; do
426         switches+=(-x "$exclude_root/$exclude")
427     done
428     fpm_build "${srcdir}" "${pos_args[@]}" "${switches[@]}" \
429               -x "$exclude_root/vendor/cache-*" \
430               -x "$exclude_root/vendor/bundle" "$@" "$license_arg"
431     rm -rf "$scripts_dir"
432 }
433
434 # Build python packages with a virtualenv built-in
435 fpm_build_virtualenv () {
436   PKG=$1
437   shift
438   PKG_DIR=$1
439   shift
440   PACKAGE_TYPE=${1:-python}
441   shift
442
443   # Set up
444   STDOUT_IF_DEBUG=/dev/null
445   STDERR_IF_DEBUG=/dev/null
446   DASHQ_UNLESS_DEBUG=-q
447   if [[ "$DEBUG" != "0" ]]; then
448       STDOUT_IF_DEBUG=/dev/stdout
449       STDERR_IF_DEBUG=/dev/stderr
450       DASHQ_UNLESS_DEBUG=
451   fi
452   if [[ "$ARVADOS_BUILDING_ITERATION" == "" ]]; then
453     ARVADOS_BUILDING_ITERATION=1
454   fi
455
456   local python=""
457   case "$PACKAGE_TYPE" in
458     python3)
459         python=python3
460         pip=pip3
461         PACKAGE_PREFIX=$PYTHON3_PKG_PREFIX
462         ;;
463   esac
464
465   if [[ "$PKG" != "arvados-docker-cleaner" ]]; then
466     PYTHON_PKG=$PACKAGE_PREFIX-$PKG
467   else
468     # Exception to our package naming convention
469     PYTHON_PKG=$PKG
470   fi
471
472   # arvados-python-client sdist should always be built, to be available
473   # for other dependent packages.
474   if [[ -n "$ONLY_BUILD" ]] && [[ "arvados-python-client" != "$PKG" ]] && [[ "$PYTHON_PKG" != "$ONLY_BUILD" ]] && [[ "$PKG" != "$ONLY_BUILD" ]]; then
475     return 0
476   fi
477
478   cd $WORKSPACE/$PKG_DIR
479
480   rm -rf dist/*
481
482   # Get the latest setuptools
483   if ! $pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG -U 'setuptools<45'; then
484     echo "Error, unable to upgrade setuptools with"
485     echo "  $pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG -U 'setuptools<45'"
486     exit 1
487   fi
488   # filter a useless warning (when building the cwltest package) from the stderr output
489   if ! $python setup.py $DASHQ_UNLESS_DEBUG sdist 2> >(grep -v 'warning: no previously-included files matching'); then
490     echo "Error, unable to run $python setup.py sdist for $PKG"
491     exit 1
492   fi
493
494   PACKAGE_PATH=`(cd dist; ls *tar.gz)`
495
496   if [[ "arvados-python-client" == "$PKG" ]]; then
497     PYSDK_PATH=`pwd`/dist/
498   fi
499
500   if [[ -n "$ONLY_BUILD" ]] && [[ "$PYTHON_PKG" != "$ONLY_BUILD" ]] && [[ "$PKG" != "$ONLY_BUILD" ]]; then
501     return 0
502   fi
503
504   # Determine the package version from the generated sdist archive
505   if [[ -n "$ARVADOS_BUILDING_VERSION" ]] ; then
506       UNFILTERED_PYTHON_VERSION=$ARVADOS_BUILDING_VERSION
507       PYTHON_VERSION=$(echo -n $ARVADOS_BUILDING_VERSION | sed s/~dev/.dev/g | sed s/~rc/rc/g)
508   else
509       PYTHON_VERSION=$(awk '($1 == "Version:"){print $2}' *.egg-info/PKG-INFO)
510       UNFILTERED_PYTHON_VERSION=$(echo -n $PYTHON_VERSION | sed s/\.dev/~dev/g |sed 's/\([0-9]\)rc/\1~rc/g')
511   fi
512
513   # See if we actually need to build this package; does it exist already?
514   # We can't do this earlier than here, because we need PYTHON_VERSION...
515   # This isn't so bad; the sdist call above is pretty quick compared to
516   # the invocation of virtualenv and fpm, below.
517   if ! test_package_presence "$PYTHON_PKG" $UNFILTERED_PYTHON_VERSION $PACKAGE_TYPE $ARVADOS_BUILDING_ITERATION; then
518     return 0
519   fi
520
521   echo "Building $FORMAT package for $PKG from $PKG_DIR"
522
523   # Package the sdist in a virtualenv
524   echo "Creating virtualenv..."
525
526   cd dist
527
528   rm -rf build
529   rm -f $PYTHON_PKG*deb
530   echo "virtualenv version: `virtualenv --version`"
531   virtualenv_command="virtualenv --python `which $python` $DASHQ_UNLESS_DEBUG build/usr/share/$python/dist/$PYTHON_PKG"
532
533   if ! $virtualenv_command; then
534     echo "Error, unable to run"
535     echo "  $virtualenv_command"
536     exit 1
537   fi
538
539   if ! build/usr/share/$python/dist/$PYTHON_PKG/bin/$pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG -U pip; then
540     echo "Error, unable to upgrade pip with"
541     echo "  build/usr/share/$python/dist/$PYTHON_PKG/bin/$pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG -U pip"
542     exit 1
543   fi
544   echo "pip version:        `build/usr/share/$python/dist/$PYTHON_PKG/bin/$pip --version`"
545
546   if ! build/usr/share/$python/dist/$PYTHON_PKG/bin/$pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG -U 'setuptools<45'; then
547     echo "Error, unable to upgrade setuptools with"
548     echo "  build/usr/share/$python/dist/$PYTHON_PKG/bin/$pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG -U 'setuptools<45'"
549     exit 1
550   fi
551   echo "setuptools version: `build/usr/share/$python/dist/$PYTHON_PKG/bin/$python -c 'import setuptools; print(setuptools.__version__)'`"
552
553   if ! build/usr/share/$python/dist/$PYTHON_PKG/bin/$pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG -U wheel; then
554     echo "Error, unable to upgrade wheel with"
555     echo "  build/usr/share/$python/dist/$PYTHON_PKG/bin/$pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG -U wheel"
556     exit 1
557   fi
558   echo "wheel version:      `build/usr/share/$python/dist/$PYTHON_PKG/bin/wheel version`"
559
560   if [[ "$TARGET" != "centos7" ]] || [[ "$PYTHON_PKG" != "python-arvados-fuse" ]]; then
561     build/usr/share/$python/dist/$PYTHON_PKG/bin/$pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG -f $PYSDK_PATH $PACKAGE_PATH
562   else
563     # centos7 needs these special tweaks to install python-arvados-fuse
564     build/usr/share/$python/dist/$PYTHON_PKG/bin/$pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG docutils
565     PYCURL_SSL_LIBRARY=nss build/usr/share/$python/dist/$PYTHON_PKG/bin/$pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG -f $PYSDK_PATH $PACKAGE_PATH
566   fi
567
568   if [[ "$?" != "0" ]]; then
569     echo "Error, unable to run"
570     echo "  build/usr/share/$python/dist/$PYTHON_PKG/bin/$pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG -f $PYSDK_PATH $PACKAGE_PATH"
571     exit 1
572   fi
573
574   cd build/usr/share/$python/dist/$PYTHON_PKG/
575
576   # Replace the shebang lines in all python scripts, and handle the activate
577   # scripts too. This is a functional replacement of the 237 line
578   # virtualenv_tools.py script that doesn't work in python3 without serious
579   # patching, minus the parts we don't need (modifying pyc files, etc).
580   for binfile in `ls bin/`; do
581     if ! file --mime bin/$binfile |grep -q binary; then
582       # Not a binary file
583       if [[ "$binfile" =~ ^activate(.csh|.fish|)$ ]]; then
584         # these 'activate' scripts need special treatment
585         sed -i "s/VIRTUAL_ENV=\".*\"/VIRTUAL_ENV=\"\/usr\/share\/$python\/dist\/$PYTHON_PKG\"/" bin/$binfile
586         sed -i "s/VIRTUAL_ENV \".*\"/VIRTUAL_ENV \"\/usr\/share\/$python\/dist\/$PYTHON_PKG\"/" bin/$binfile
587       else
588         if grep -q -E '^#!.*/bin/python\d?' bin/$binfile; then
589           # Replace shebang line
590           sed -i "1 s/^.*$/#!\/usr\/share\/$python\/dist\/$PYTHON_PKG\/bin\/python/" bin/$binfile
591         fi
592       fi
593     fi
594   done
595
596   cd - >$STDOUT_IF_DEBUG
597
598   find build -iname '*.pyc' -exec rm {} \;
599   find build -iname '*.pyo' -exec rm {} \;
600
601   # Finally, generate the package
602   echo "Creating package..."
603
604   declare -a COMMAND_ARR=("fpm" "-s" "dir" "-t" "$FORMAT")
605
606   if [[ "$MAINTAINER" != "" ]]; then
607     COMMAND_ARR+=('--maintainer' "$MAINTAINER")
608   fi
609
610   if [[ "$VENDOR" != "" ]]; then
611     COMMAND_ARR+=('--vendor' "$VENDOR")
612   fi
613
614   COMMAND_ARR+=('--url' 'https://arvados.org')
615
616   # Get description
617   DESCRIPTION=`grep '\sdescription' $WORKSPACE/$PKG_DIR/setup.py|cut -f2 -d=|sed -e "s/[',\\"]//g"`
618   COMMAND_ARR+=('--description' "$DESCRIPTION")
619
620   # Get license string
621   LICENSE_STRING=`grep license $WORKSPACE/$PKG_DIR/setup.py|cut -f2 -d=|sed -e "s/[',\\"]//g"`
622   COMMAND_ARR+=('--license' "$LICENSE_STRING")
623
624   if [[ "$FORMAT" != "rpm" ]]; then
625     COMMAND_ARR+=('--conflicts' "python-$PKG")
626   fi
627
628   if [[ "$DEBUG" != "0" ]]; then
629     COMMAND_ARR+=('--verbose' '--log' 'info')
630   fi
631
632   COMMAND_ARR+=('-v' $(echo -n "$PYTHON_VERSION" | sed s/.dev/~dev/g | sed s/rc/~rc/g))
633   COMMAND_ARR+=('--iteration' "$ARVADOS_BUILDING_ITERATION")
634   COMMAND_ARR+=('-n' "$PYTHON_PKG")
635   COMMAND_ARR+=('-C' "build")
636
637   systemd_unit="$WORKSPACE/$PKG_DIR/$PKG.service"
638   if [[ -e "${systemd_unit}" ]]; then
639     COMMAND_ARR+=('--after-install' "${WORKSPACE}/build/go-python-package-scripts/postinst")
640     COMMAND_ARR+=('--before-remove' "${WORKSPACE}/build/go-python-package-scripts/prerm")
641   fi
642
643   COMMAND_ARR+=('--depends' "$PYTHON3_PACKAGE")
644
645   # avoid warning
646   COMMAND_ARR+=('--deb-no-default-config-files')
647
648   # Append --depends X and other arguments specified by fpm-info.sh in
649   # the package source dir. These are added last so they can override
650   # the arguments added by this script.
651   declare -a fpm_args=()
652   declare -a fpm_depends=()
653
654   fpminfo="$WORKSPACE/$PKG_DIR/fpm-info.sh"
655   if [[ -e "$fpminfo" ]]; then
656     echo "Loading fpm overrides from $fpminfo"
657     if ! source "$fpminfo"; then
658       echo "Error, unable to source $WORKSPACE/$PKG_DIR/fpm-info.sh for $PKG"
659       exit 1
660     fi
661   fi
662
663   for i in "${fpm_depends[@]}"; do
664     COMMAND_ARR+=('--depends' "$i")
665   done
666
667   # make sure the systemd service file ends up in the right place
668   # used by arvados-docker-cleaner
669   if [[ -e "${systemd_unit}" ]]; then
670     COMMAND_ARR+=("usr/share/$python/dist/$PKG/share/doc/$PKG/$PKG.service=/lib/systemd/system/$PKG.service")
671   fi
672
673   COMMAND_ARR+=("${fpm_args[@]}")
674
675   # Make sure to install all our package binaries in /usr/bin.
676   # We have to walk $WORKSPACE/$PKG_DIR/bin rather than
677   # $WORKSPACE/build/usr/share/$python/dist/$PYTHON_PKG/bin/ to get the list
678   # because the latter also includes all the python binaries for the virtualenv.
679   # We have to take the copies of our binaries from the latter directory, though,
680   # because those are the ones we rewrote the shebang line of, above.
681   if [[ -e "$WORKSPACE/$PKG_DIR/bin" ]]; then
682     for binary in `ls $WORKSPACE/$PKG_DIR/bin`; do
683       COMMAND_ARR+=("usr/share/$python/dist/$PYTHON_PKG/bin/$binary=/usr/bin/")
684     done
685   fi
686
687   # the python3-arvados-cwl-runner package comes with cwltool, expose that version
688   if [[ -e "$WORKSPACE/$PKG_DIR/dist/build/usr/share/$python/dist/python-arvados-cwl-runner/bin/cwltool" ]]; then
689     COMMAND_ARR+=("usr/share/$python/dist/python-arvados-cwl-runner/bin/cwltool=/usr/bin/")
690   fi
691
692   COMMAND_ARR+=(".")
693
694   debug_echo -e "\n${COMMAND_ARR[@]}\n"
695
696   FPM_RESULTS=$("${COMMAND_ARR[@]}")
697   FPM_EXIT_CODE=$?
698
699   # if something went wrong and debug is off, print out the fpm command that errored
700   if ! fpm_verify $FPM_EXIT_CODE $FPM_RESULTS && [[ "$STDOUT_IF_DEBUG" == "/dev/null" ]]; then
701     echo "fpm returned an error executing the command:"
702     echo
703     echo -e "\n${COMMAND_ARR[@]}\n"
704   else
705     echo `ls *$FORMAT`
706     mv $WORKSPACE/$PKG_DIR/dist/*$FORMAT $WORKSPACE/packages/$TARGET/
707   fi
708   echo
709 }
710
711 # Build packages for everything
712 fpm_build () {
713   # Source dir where fpm-info.sh (if any) will be found.
714   SRC_DIR=$1
715   shift
716   # The package source.  Depending on the source type, this can be a
717   # path, or the name of the package in an upstream repository (e.g.,
718   # pip).
719   PACKAGE=$1
720   shift
721   # The name of the package to build.
722   PACKAGE_NAME=$1
723   shift
724   # The type of source package.  Passed to fpm -s.  Default "dir".
725   PACKAGE_TYPE=${1:-dir}
726   shift
727   # Optional: the package version number.  Passed to fpm -v.
728   VERSION=$1
729   shift
730
731   if [[ -n "$ONLY_BUILD" ]] && [[ "$PACKAGE_NAME" != "$ONLY_BUILD" ]] && [[ "$PACKAGE" != "$ONLY_BUILD" ]] ; then
732     # arvados-workbench depends on arvados-server at build time, so even when
733     # only arvados-workbench is being built, we need to build arvados-server too
734     if [[ "$PACKAGE_NAME" != "arvados-server" ]] || [[ "$ONLY_BUILD" != "arvados-workbench" ]]; then
735       return 0
736     fi
737   fi
738
739   local default_iteration_value="$(default_iteration "$PACKAGE" "$VERSION" "$PACKAGE_TYPE")"
740
741   declare -a COMMAND_ARR=("fpm" "-s" "$PACKAGE_TYPE" "-t" "$FORMAT")
742   if [ python = "$PACKAGE_TYPE" ] && [ deb = "$FORMAT" ]; then
743       # Dependencies are built from setup.py.  Since setup.py will never
744       # refer to Debian package iterations, it doesn't make sense to
745       # enforce those in the .deb dependencies.
746       COMMAND_ARR+=(--deb-ignore-iteration-in-dependencies)
747   fi
748
749   if [[ "$DEBUG" != "0" ]]; then
750     COMMAND_ARR+=('--verbose' '--log' 'info')
751   fi
752
753   if [[ -n "$PACKAGE_NAME" ]]; then
754     COMMAND_ARR+=('-n' "$PACKAGE_NAME")
755   fi
756
757   if [[ "$MAINTAINER" != "" ]]; then
758     COMMAND_ARR+=('--maintainer' "$MAINTAINER")
759   fi
760
761   if [[ "$VENDOR" != "" ]]; then
762     COMMAND_ARR+=('--vendor' "$VENDOR")
763   fi
764
765   if [[ "$VERSION" != "" ]]; then
766     COMMAND_ARR+=('-v' "$VERSION")
767   fi
768   if [[ -n "$default_iteration_value" ]]; then
769       # We can always add an --iteration here.  If another one is specified in $@,
770       # that will take precedence, as desired.
771       COMMAND_ARR+=(--iteration "$default_iteration_value")
772   fi
773
774   # Append --depends X and other arguments specified by fpm-info.sh in
775   # the package source dir. These are added last so they can override
776   # the arguments added by this script.
777   declare -a fpm_args=()
778   declare -a build_depends=()
779   declare -a fpm_depends=()
780   declare -a fpm_exclude=()
781   if [[ ! -d "$SRC_DIR" ]]; then
782       echo >&2 "BUG: looking in wrong dir for fpm-info.sh: $pkgdir"
783       exit 1
784   fi
785   fpminfo="${SRC_DIR}/fpm-info.sh"
786   if [[ -e "$fpminfo" ]]; then
787       debug_echo "Loading fpm overrides from $fpminfo"
788       source "$fpminfo"
789   fi
790   for pkg in "${build_depends[@]}"; do
791       if [[ $TARGET =~ debian|ubuntu ]]; then
792           pkg_deb=$(ls "$WORKSPACE/packages/$TARGET/$pkg_"*.deb | sort -rg | awk 'NR==1')
793           if [[ -e $pkg_deb ]]; then
794               echo "Installing build_dep $pkg from $pkg_deb"
795               dpkg -i "$pkg_deb"
796           else
797               echo "Attemping to install build_dep $pkg using apt-get"
798               apt-get install -y "$pkg"
799           fi
800           apt-get -y -f install
801       else
802           pkg_rpm=$(ls "$WORKSPACE/packages/$TARGET/$pkg"-[0-9]*.rpm | sort -rg | awk 'NR==1')
803           if [[ -e $pkg_rpm ]]; then
804               echo "Installing build_dep $pkg from $pkg_rpm"
805               rpm -i "$pkg_rpm"
806           else
807               echo "Attemping to install build_dep $pkg"
808               rpm -i "$pkg"
809           fi
810       fi
811   done
812   for i in "${fpm_depends[@]}"; do
813     COMMAND_ARR+=('--depends' "$i")
814   done
815   for i in "${fpm_exclude[@]}"; do
816     COMMAND_ARR+=('--exclude' "$i")
817   done
818
819   COMMAND_ARR+=("${fpm_args[@]}")
820
821   # Append remaining function arguments directly to fpm's command line.
822   for i; do
823     COMMAND_ARR+=("$i")
824   done
825
826   COMMAND_ARR+=("$PACKAGE")
827
828   debug_echo -e "\n${COMMAND_ARR[@]}\n"
829
830   FPM_RESULTS=$("${COMMAND_ARR[@]}")
831   FPM_EXIT_CODE=$?
832
833   fpm_verify $FPM_EXIT_CODE $FPM_RESULTS
834
835   # if something went wrong and debug is off, print out the fpm command that errored
836   if [[ 0 -ne $? ]] && [[ "$STDOUT_IF_DEBUG" == "/dev/null" ]]; then
837     echo -e "\n${COMMAND_ARR[@]}\n"
838   fi
839 }
840
841 # verify build results
842 fpm_verify () {
843   FPM_EXIT_CODE=$1
844   shift
845   FPM_RESULTS=$@
846
847   FPM_PACKAGE_NAME=''
848   if [[ $FPM_RESULTS =~ ([A-Za-z0-9_\.-]*\.)(deb|rpm) ]]; then
849     FPM_PACKAGE_NAME=${BASH_REMATCH[1]}${BASH_REMATCH[2]}
850   fi
851
852   if [[ "$FPM_PACKAGE_NAME" == "" ]]; then
853     EXITCODE=1
854     echo
855     echo "Error: $PACKAGE: Unable to figure out package name from fpm results:"
856     echo
857     echo $FPM_RESULTS
858     echo
859     return 1
860   elif [[ "$FPM_RESULTS" =~ "File already exists" ]]; then
861     echo "Package $FPM_PACKAGE_NAME exists, not rebuilding"
862     return 0
863   elif [[ 0 -ne "$FPM_EXIT_CODE" ]]; then
864     EXITCODE=1
865     echo "Error building package for $1:\n $FPM_RESULTS"
866     return 1
867   fi
868 }
869
870 install_package() {
871   PACKAGES=$@
872   if [[ "$FORMAT" == "deb" ]]; then
873     $SUDO apt-get install $PACKAGES --yes
874   elif [[ "$FORMAT" == "rpm" ]]; then
875     $SUDO yum -q -y install $PACKAGES
876   fi
877 }
878
879 title() {
880     printf '%s %s\n' "=======" "$1"
881 }
882
883 checkexit() {
884     if [[ "$1" != "0" ]]; then
885         title "$2 -- FAILED"
886         failures+=("$2 (`timer`)")
887     else
888         successes+=("$2 (`timer`)")
889     fi
890 }
891
892 timer_reset() {
893     t0=$SECONDS
894 }
895
896 timer() {
897     if [[ -n "$t0" ]]; then
898         echo -n "$(($SECONDS - $t0))s"
899     fi
900 }
901
902 report_outcomes() {
903     for x in "${successes[@]}"
904     do
905         echo "Pass: $x"
906     done
907
908     if [[ ${#failures[@]} == 0 ]]
909     then
910         if [[ ${#successes[@]} != 0 ]]; then
911            echo "All test suites passed."
912         fi
913     else
914         echo "Failures (${#failures[@]}):"
915         for x in "${failures[@]}"
916         do
917             echo "Fail: $x"
918         done
919     fi
920 }