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