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