build/run-library.sh

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