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   # signal to our build script that we want a cwltest executable installed in /usr/bin/
 660   mkdir cwltest/bin && touch cwltest/bin/cwltest
 661   fpm_build_virtualenv "cwltest" "cwltest" "$package_format" "$target_arch"
 662   # The python->python3 metapackage
 663   build_metapackage "cwltest" "cwltest"
 664   cd "$WORKSPACE"
 665   rm -rf "$WORKSPACE/cwltest"
 666 }
 667
 668 # Usage: handle_arvados_src
 669 handle_arvados_src () {
 670   if [[ -n "$ONLY_BUILD" ]] && [[ "$ONLY_BUILD" != "arvados-src" ]] ; then
 671     debug_echo -e "Skipping build of arvados-src package."
 672     return 0
 673   fi
 674   # arvados-src
 675   (
 676       cd "$WORKSPACE"
 677       COMMIT_HASH=$(format_last_commit_here "%H")
 678       arvados_src_version="$(version_from_git)"
 679
 680       cd $WORKSPACE/packages/$TARGET
 681       test_package_presence arvados-src "$arvados_src_version" src ""
 682
 683       if [[ "$?" == "0" ]]; then
 684         cd "$WORKSPACE"
 685         SRC_BUILD_DIR=$(mktemp -d)
 686         # mktemp creates the directory with 0700 permissions by default
 687         chmod 755 $SRC_BUILD_DIR
 688         git clone $DASHQ_UNLESS_DEBUG "$WORKSPACE/.git" "$SRC_BUILD_DIR"
 689         cd "$SRC_BUILD_DIR"
 690
 691         # go into detached-head state
 692         git checkout $DASHQ_UNLESS_DEBUG "$COMMIT_HASH"
 693         echo "$COMMIT_HASH" >git-commit.version
 694
 695         cd $WORKSPACE/packages/$TARGET
 696         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"
 697
 698         rm -rf "$SRC_BUILD_DIR"
 699       fi
 700   )
 701 }
 702
 703 # Build python packages with a virtualenv built-in
 704 # Usage: fpm_build_virtualenv arvados-python-client sdk/python [deb|rpm] [amd64|arm64]
 705 fpm_build_virtualenv () {
 706   local pkg=$1; shift
 707   local pkg_dir=$1; shift
 708   local package_format="$1"; shift
 709   local target_arch="${1:-amd64}"; shift
 710
 711   native_arch=$(get_native_arch)
 712
 713   if [[ "$pkg" != "arvados-docker-cleaner" ]]; then
 714     PYTHON_PKG=$PYTHON3_PKG_PREFIX-$pkg
 715   else
 716     # Exception to our package naming convention
 717     PYTHON_PKG=$pkg
 718   fi
 719
 720   if [[ -n "$ONLY_BUILD" ]] && [[ "$PYTHON_PKG" != "$ONLY_BUILD" ]]; then
 721     # arvados-python-client sdist should always be built if we are building a
 722     # python package.
 723     if [[ "$ONLY_BUILD" != "python3-arvados-cwl-runner" ]] &&
 724        [[ "$ONLY_BUILD" != "python3-arvados-fuse" ]] &&
 725        [[ "$ONLY_BUILD" != "python3-crunchstat-summary" ]] &&
 726        [[ "$ONLY_BUILD" != "arvados-docker-cleaner" ]] &&
 727        [[ "$ONLY_BUILD" != "python3-arvados-user-activity" ]]; then
 728       debug_echo -e "Skipping build of $pkg package."
 729       return 0
 730     fi
 731   fi
 732
 733   if [[ -n "$target_arch" ]] && [[ "$native_arch" == "$target_arch" ]]; then
 734       fpm_build_virtualenv_worker "$pkg" "$pkg_dir" "$package_format" "$native_arch" "$target_arch"
 735   elif [[ -z "$target_arch" ]]; then
 736     fpm_build_virtualenv_worker "$pkg" "$pkg_dir" "$package_format" "$native_arch" "$native_arch"
 737   else
 738     echo "Error: no cross compilation support for Python yet, can not build $pkg for $target_arch"
 739     return 1
 740   fi
 741 }
 742
 743 # Build python packages with a virtualenv built-in
 744 # Usage: fpm_build_virtualenv_worker arvados-python-client sdk/python python3 [deb|rpm] [amd64|arm64] [amd64|arm64]
 745 fpm_build_virtualenv_worker () {
 746   PKG=$1; shift
 747   PKG_DIR=$1; shift
 748   local package_format="$1"; shift
 749   local native_arch="${1:-amd64}"; shift
 750   local target_arch=${1:-amd64}; shift
 751
 752   # Set up
 753   STDOUT_IF_DEBUG=/dev/null
 754   STDERR_IF_DEBUG=/dev/null
 755   DASHQ_UNLESS_DEBUG=-q
 756   if [[ "$DEBUG" != "0" ]]; then
 757       STDOUT_IF_DEBUG=/dev/stdout
 758       STDERR_IF_DEBUG=/dev/stderr
 759       DASHQ_UNLESS_DEBUG=
 760   fi
 761   if [[ "$ARVADOS_BUILDING_ITERATION" == "" ]]; then
 762     ARVADOS_BUILDING_ITERATION=1
 763   fi
 764
 765   local python=$PYTHON3_EXECUTABLE
 766   pip=pip3
 767   PACKAGE_PREFIX=$PYTHON3_PKG_PREFIX
 768
 769   if [[ "$PKG" != "arvados-docker-cleaner" ]]; then
 770     PYTHON_PKG=$PACKAGE_PREFIX-$PKG
 771   else
 772     # Exception to our package naming convention
 773     PYTHON_PKG=$PKG
 774   fi
 775
 776   cd $WORKSPACE/$PKG_DIR
 777
 778   rm -rf dist/*
 779
 780   # Get the latest setuptools
 781   if ! $pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG -U 'setuptools<45'; then
 782     echo "Error, unable to upgrade setuptools with"
 783     echo "  $pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG -U 'setuptools<45'"
 784     exit 1
 785   fi
 786   # filter a useless warning (when building the cwltest package) from the stderr output
 787   if ! $python setup.py $DASHQ_UNLESS_DEBUG sdist 2> >(grep -v 'warning: no previously-included files matching'); then
 788     echo "Error, unable to run $python setup.py sdist for $PKG"
 789     exit 1
 790   fi
 791
 792   PACKAGE_PATH=`(cd dist; ls *tar.gz)`
 793
 794   if [[ "arvados-python-client" == "$PKG" ]]; then
 795     PYSDK_PATH=`pwd`/dist/
 796   fi
 797
 798   if [[ -n "$ONLY_BUILD" ]] && [[ "$PYTHON_PKG" != "$ONLY_BUILD" ]] && [[ "$PKG" != "$ONLY_BUILD" ]]; then
 799     return 0
 800   fi
 801
 802   # Determine the package version from the generated sdist archive
 803   if [[ -n "$ARVADOS_BUILDING_VERSION" ]] ; then
 804       UNFILTERED_PYTHON_VERSION=$ARVADOS_BUILDING_VERSION
 805       PYTHON_VERSION=$(echo -n $ARVADOS_BUILDING_VERSION | sed s/~dev/.dev/g | sed s/~rc/rc/g)
 806   else
 807       PYTHON_VERSION=$(awk '($1 == "Version:"){print $2}' *.egg-info/PKG-INFO)
 808       UNFILTERED_PYTHON_VERSION=$(echo -n $PYTHON_VERSION | sed s/\.dev/~dev/g |sed 's/\([0-9]\)rc/\1~rc/g')
 809   fi
 810
 811   # See if we actually need to build this package; does it exist already?
 812   # We can't do this earlier than here, because we need PYTHON_VERSION...
 813   # This isn't so bad; the sdist call above is pretty quick compared to
 814   # the invocation of virtualenv and fpm, below.
 815   if ! test_package_presence "$PYTHON_PKG" "$UNFILTERED_PYTHON_VERSION" "$python" "$ARVADOS_BUILDING_ITERATION" "$target_arch"; then
 816     return 0
 817   fi
 818
 819   echo "Building $package_format ($target_arch) package for $PKG from $PKG_DIR"
 820
 821   # Package the sdist in a virtualenv
 822   echo "Creating virtualenv..."
 823
 824   cd dist
 825
 826   rm -rf build
 827   rm -f $PYTHON_PKG*deb
 828   echo "virtualenv version: `virtualenv --version`"
 829   virtualenv_command="virtualenv --python `which $python` $DASHQ_UNLESS_DEBUG build/usr/share/$python/dist/$PYTHON_PKG"
 830
 831   if ! $virtualenv_command; then
 832     echo "Error, unable to run"
 833     echo "  $virtualenv_command"
 834     exit 1
 835   fi
 836
 837   if ! build/usr/share/$python/dist/$PYTHON_PKG/bin/$pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG -U pip; then
 838     echo "Error, unable to upgrade pip with"
 839     echo "  build/usr/share/$python/dist/$PYTHON_PKG/bin/$pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG -U pip"
 840     exit 1
 841   fi
 842   echo "pip version:        `build/usr/share/$python/dist/$PYTHON_PKG/bin/$pip --version`"
 843
 844   if ! build/usr/share/$python/dist/$PYTHON_PKG/bin/$pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG -U 'setuptools<45'; then
 845     echo "Error, unable to upgrade setuptools with"
 846     echo "  build/usr/share/$python/dist/$PYTHON_PKG/bin/$pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG -U 'setuptools<45'"
 847     exit 1
 848   fi
 849   echo "setuptools version: `build/usr/share/$python/dist/$PYTHON_PKG/bin/$python -c 'import setuptools; print(setuptools.__version__)'`"
 850
 851   if ! build/usr/share/$python/dist/$PYTHON_PKG/bin/$pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG -U wheel; then
 852     echo "Error, unable to upgrade wheel with"
 853     echo "  build/usr/share/$python/dist/$PYTHON_PKG/bin/$pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG -U wheel"
 854     exit 1
 855   fi
 856   echo "wheel version:      `build/usr/share/$python/dist/$PYTHON_PKG/bin/wheel version`"
 857
 858   if [[ "$TARGET" != "centos7" ]] || [[ "$PYTHON_PKG" != "python-arvados-fuse" ]]; then
 859     build/usr/share/$python/dist/$PYTHON_PKG/bin/$pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG -f $PYSDK_PATH $PACKAGE_PATH
 860   else
 861     # centos7 needs these special tweaks to install python-arvados-fuse
 862     build/usr/share/$python/dist/$PYTHON_PKG/bin/$pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG docutils
 863     PYCURL_SSL_LIBRARY=nss build/usr/share/$python/dist/$PYTHON_PKG/bin/$pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG -f $PYSDK_PATH $PACKAGE_PATH
 864   fi
 865
 866   if [[ "$?" != "0" ]]; then
 867     echo "Error, unable to run"
 868     echo "  build/usr/share/$python/dist/$PYTHON_PKG/bin/$pip install $DASHQ_UNLESS_DEBUG $CACHE_FLAG -f $PYSDK_PATH $PACKAGE_PATH"
 869     exit 1
 870   fi
 871
 872   cd build/usr/share/$python/dist/$PYTHON_PKG/
 873
 874   # Replace the shebang lines in all python scripts, and handle the activate
 875   # scripts too. This is a functional replacement of the 237 line
 876   # virtualenv_tools.py script that doesn't work in python3 without serious
 877   # patching, minus the parts we don't need (modifying pyc files, etc).
 878   for binfile in `ls bin/`; do
 879     if ! file --mime bin/$binfile |grep -q binary; then
 880       # Not a binary file
 881       if [[ "$binfile" =~ ^activate(.csh|.fish|)$ ]]; then
 882         # these 'activate' scripts need special treatment
 883         sed -i "s/VIRTUAL_ENV=\".*\"/VIRTUAL_ENV=\"\/usr\/share\/$python\/dist\/$PYTHON_PKG\"/" bin/$binfile
 884         sed -i "s/VIRTUAL_ENV \".*\"/VIRTUAL_ENV \"\/usr\/share\/$python\/dist\/$PYTHON_PKG\"/" bin/$binfile
 885       else
 886         if grep -q -E '^#!.*/bin/python\d?' bin/$binfile; then
 887           # Replace shebang line
 888           sed -i "1 s/^.*$/#!\/usr\/share\/$python\/dist\/$PYTHON_PKG\/bin\/python/" bin/$binfile
 889         fi
 890       fi
 891     fi
 892   done
 893
 894   cd - >$STDOUT_IF_DEBUG
 895
 896   find build -iname '*.pyc' -exec rm {} \;
 897   find build -iname '*.pyo' -exec rm {} \;
 898
 899   # Finally, generate the package
 900   echo "Creating package..."
 901
 902   declare -a COMMAND_ARR=("fpm" "-s" "dir" "-t" "$package_format")
 903
 904   if [[ -n "$target_arch" ]] && [[ "$target_arch" != "amd64" ]]; then
 905     COMMAND_ARR+=("-a$target_arch")
 906   fi
 907
 908   if [[ "$MAINTAINER" != "" ]]; then
 909     COMMAND_ARR+=('--maintainer' "$MAINTAINER")
 910   fi
 911
 912   if [[ "$VENDOR" != "" ]]; then
 913     COMMAND_ARR+=('--vendor' "$VENDOR")
 914   fi
 915
 916   COMMAND_ARR+=('--url' 'https://arvados.org')
 917
 918   # Get description
 919   DESCRIPTION=`grep '\sdescription' $WORKSPACE/$PKG_DIR/setup.py|cut -f2 -d=|sed -e "s/[',\\"]//g"`
 920   COMMAND_ARR+=('--description' "$DESCRIPTION")
 921
 922   # Get license string
 923   LICENSE_STRING=`grep license $WORKSPACE/$PKG_DIR/setup.py|cut -f2 -d=|sed -e "s/[',\\"]//g"`
 924   COMMAND_ARR+=('--license' "$LICENSE_STRING")
 925
 926   if [[ "$DEBUG" != "0" ]]; then
 927     COMMAND_ARR+=('--verbose' '--log' 'info')
 928   fi
 929
 930   COMMAND_ARR+=('-v' $(echo -n "$PYTHON_VERSION" | sed s/.dev/~dev/g | sed s/rc/~rc/g))
 931   COMMAND_ARR+=('--iteration' "$ARVADOS_BUILDING_ITERATION")
 932   COMMAND_ARR+=('-n' "$PYTHON_PKG")
 933   COMMAND_ARR+=('-C' "build")
 934
 935   systemd_unit="$WORKSPACE/$PKG_DIR/$PKG.service"
 936   if [[ -e "${systemd_unit}" ]]; then
 937     COMMAND_ARR+=('--after-install' "${WORKSPACE}/build/go-python-package-scripts/postinst")
 938     COMMAND_ARR+=('--before-remove' "${WORKSPACE}/build/go-python-package-scripts/prerm")
 939   fi
 940
 941   COMMAND_ARR+=('--depends' "$PYTHON3_PACKAGE")
 942   case "$package_format" in
 943       deb)
 944           COMMAND_ARR+=(
 945               # Avoid warning
 946               --deb-no-default-config-files
 947           ) ;;
 948       rpm)
 949           COMMAND_ARR+=(
 950               # Conflict with older packages we used to publish
 951               --conflicts "rh-python36-python-$PKG"
 952               # Do not generate /usr/lib/.build-id links on RH8+
 953               # (otherwise our packages conflict with platform-python)
 954               --rpm-rpmbuild-define "_build_id_links none"
 955           ) ;;
 956   esac
 957
 958   # Append --depends X and other arguments specified by fpm-info.sh in
 959   # the package source dir. These are added last so they can override
 960   # the arguments added by this script.
 961   declare -a fpm_args=()
 962   declare -a fpm_depends=()
 963
 964   fpminfo="$WORKSPACE/$PKG_DIR/fpm-info.sh"
 965   if [[ -e "$fpminfo" ]]; then
 966     echo "Loading fpm overrides from $fpminfo"
 967     if ! source "$fpminfo"; then
 968       echo "Error, unable to source $WORKSPACE/$PKG_DIR/fpm-info.sh for $PKG"
 969       exit 1
 970     fi
 971   fi
 972
 973   for i in "${fpm_depends[@]}"; do
 974     COMMAND_ARR+=('--depends' "$i")
 975   done
 976
 977   for i in "${fpm_depends[@]}"; do
 978     COMMAND_ARR+=('--replaces' "python-$PKG")
 979   done
 980
 981   # make sure the systemd service file ends up in the right place
 982   # used by arvados-docker-cleaner
 983   if [[ -e "${systemd_unit}" ]]; then
 984     COMMAND_ARR+=("usr/share/$python/dist/$PKG/share/doc/$PKG/$PKG.service=/lib/systemd/system/$PKG.service")
 985   fi
 986
 987   COMMAND_ARR+=("${fpm_args[@]}")
 988
 989   # Make sure to install all our package binaries in /usr/bin.
 990   # We have to walk $WORKSPACE/$PKG_DIR/bin rather than
 991   # $WORKSPACE/build/usr/share/$python/dist/$PYTHON_PKG/bin/ to get the list
 992   # because the latter also includes all the python binaries for the virtualenv.
 993   # We have to take the copies of our binaries from the latter directory, though,
 994   # because those are the ones we rewrote the shebang line of, above.
 995   if [[ -e "$WORKSPACE/$PKG_DIR/bin" ]]; then
 996     for binary in `ls $WORKSPACE/$PKG_DIR/bin`; do
 997       COMMAND_ARR+=("usr/share/$python/dist/$PYTHON_PKG/bin/$binary=/usr/bin/")
 998     done
 999   fi
1000
1001   # the python3-arvados-cwl-runner package comes with cwltool, expose that version
1002   if [[ -e "$WORKSPACE/$PKG_DIR/dist/build/usr/share/$python/dist/$PYTHON_PKG/bin/cwltool" ]]; then
1003     COMMAND_ARR+=("usr/share/$python/dist/$PYTHON_PKG/bin/cwltool=/usr/bin/")
1004   fi
1005
1006   COMMAND_ARR+=(".")
1007
1008   debug_echo -e "\n${COMMAND_ARR[@]}\n"
1009
1010   FPM_RESULTS=$("${COMMAND_ARR[@]}")
1011   FPM_EXIT_CODE=$?
1012
1013   # if something went wrong and debug is off, print out the fpm command that errored
1014   if ! fpm_verify $FPM_EXIT_CODE $FPM_RESULTS && [[ "$STDOUT_IF_DEBUG" == "/dev/null" ]]; then
1015     echo "fpm returned an error executing the command:"
1016     echo
1017     echo -e "\n${COMMAND_ARR[@]}\n"
1018   else
1019     echo `ls *$package_format`
1020     mv $WORKSPACE/$PKG_DIR/dist/*$package_format $WORKSPACE/packages/$TARGET/
1021   fi
1022   echo
1023 }
1024
1025 # build_metapackage builds meta packages that help with the python to python 3 package migration
1026 build_metapackage() {
1027   # base package name (e.g. arvados-python-client)
1028   BASE_NAME=$1
1029   shift
1030   PKG_DIR=$1
1031   shift
1032
1033   if [[ -n "$ONLY_BUILD" ]] && [[ "python-$BASE_NAME" != "$ONLY_BUILD" ]]; then
1034     return 0
1035   fi
1036
1037   if [[ "$ARVADOS_BUILDING_ITERATION" == "" ]]; then
1038     ARVADOS_BUILDING_ITERATION=1
1039   fi
1040
1041   if [[ -z "$ARVADOS_BUILDING_VERSION" ]]; then
1042     cd $WORKSPACE/$PKG_DIR
1043     pwd
1044     rm -rf dist/*
1045
1046     # Get the latest setuptools
1047     if ! pip3 install $DASHQ_UNLESS_DEBUG $CACHE_FLAG -U 'setuptools<45'; then
1048       echo "Error, unable to upgrade setuptools with XY"
1049       echo "  pip3 install $DASHQ_UNLESS_DEBUG $CACHE_FLAG -U 'setuptools<45'"
1050       exit 1
1051     fi
1052     # filter a useless warning (when building the cwltest package) from the stderr output
1053     if ! python3 setup.py $DASHQ_UNLESS_DEBUG sdist 2> >(grep -v 'warning: no previously-included files matching'); then
1054       echo "Error, unable to run python3 setup.py sdist for $PKG"
1055       exit 1
1056     fi
1057
1058     PYTHON_VERSION=$(awk '($1 == "Version:"){print $2}' *.egg-info/PKG-INFO)
1059     UNFILTERED_PYTHON_VERSION=$(echo -n $PYTHON_VERSION | sed s/\.dev/~dev/g |sed 's/\([0-9]\)rc/\1~rc/g')
1060
1061   else
1062     UNFILTERED_PYTHON_VERSION=$ARVADOS_BUILDING_VERSION
1063     PYTHON_VERSION=$(echo -n $ARVADOS_BUILDING_VERSION | sed s/~dev/.dev/g | sed s/~rc/rc/g)
1064   fi
1065
1066   cd - >$STDOUT_IF_DEBUG
1067   if [[ -d "$BASE_NAME" ]]; then
1068     rm -rf $BASE_NAME
1069   fi
1070   mkdir $BASE_NAME
1071   cd $BASE_NAME
1072
1073   if [[ "$FORMAT" == "deb" ]]; then
1074     cat >ns-control <<EOF
1075 Section: misc
1076 Priority: optional
1077 Standards-Version: 3.9.2
1078
1079 Package: python-${BASE_NAME}
1080 Version: ${PYTHON_VERSION}-${ARVADOS_BUILDING_ITERATION}
1081 Maintainer: Arvados Package Maintainers <packaging@arvados.org>
1082 Depends: python3-${BASE_NAME}
1083 Description: metapackage to ease the upgrade to the Pyhon 3 version of ${BASE_NAME}
1084  This package is a metapackage that will automatically install the new version of
1085  ${BASE_NAME} which is Python 3 based and has a different name.
1086 EOF
1087
1088     /usr/bin/equivs-build ns-control
1089     if [[ $? -ne 0 ]]; then
1090       echo "Error running 'equivs-build ns-control', is the 'equivs' package installed?"
1091       return 1
1092     fi
1093   elif [[ "$FORMAT" == "rpm" ]]; then
1094     cat >meta.spec <<EOF
1095 Summary: metapackage to ease the upgrade to the Python 3 version of ${BASE_NAME}
1096 Name: python-${BASE_NAME}
1097 Version: ${PYTHON_VERSION}
1098 Release: ${ARVADOS_BUILDING_ITERATION}
1099 License: distributable
1100
1101 Requires: python3-${BASE_NAME}
1102
1103 %description
1104 This package is a metapackage that will automatically install the new version of
1105 python-${BASE_NAME} which is Python 3 based and has a different name.
1106
1107 %prep
1108
1109 %build
1110
1111 %clean
1112
1113 %install
1114
1115 %post
1116
1117 %files
1118
1119
1120 %changelog
1121 * Mon Apr 12 2021 Arvados Package Maintainers <packaging@arvados.org>
1122 - initial release
1123 EOF
1124
1125     /usr/bin/rpmbuild -ba meta.spec
1126     if [[ $? -ne 0 ]]; then
1127       echo "Error running 'rpmbuild -ba meta.spec', is the 'rpm-build' package installed?"
1128       return 1
1129     else
1130       mv /root/rpmbuild/RPMS/x86_64/python-${BASE_NAME}*.${FORMAT} .
1131       if [[ $? -ne 0 ]]; then
1132         echo "Error finding rpm file output of 'rpmbuild -ba meta.spec'"
1133         return 1
1134       fi
1135     fi
1136   else
1137     echo "Unknown format"
1138     return 1
1139   fi
1140
1141   if [[ $EXITCODE -ne 0 ]]; then
1142     return 1
1143   else
1144     echo `ls *$FORMAT`
1145     mv *$FORMAT $WORKSPACE/packages/$TARGET/
1146   fi
1147
1148   # clean up
1149   cd - >$STDOUT_IF_DEBUG
1150   if [[ -d "$BASE_NAME" ]]; then
1151     rm -rf $BASE_NAME
1152   fi
1153 }
1154
1155 # Build packages for everything
1156 fpm_build () {
1157   # Source dir where fpm-info.sh (if any) will be found.
1158   SRC_DIR=$1
1159   shift
1160   # The package source.  Depending on the source type, this can be a
1161   # path, or the name of the package in an upstream repository (e.g.,
1162   # pip).
1163   PACKAGE=$1
1164   shift
1165   # The name of the package to build.
1166   PACKAGE_NAME=$1
1167   shift
1168   # The type of source package.  Passed to fpm -s.  Default "dir".
1169   PACKAGE_TYPE=${1:-dir}
1170   shift
1171   # Optional: the package version number.  Passed to fpm -v.
1172   VERSION=$1
1173   shift
1174
1175   if [[ -n "$ONLY_BUILD" ]] && [[ "$PACKAGE_NAME" != "$ONLY_BUILD" ]] && [[ "$PACKAGE" != "$ONLY_BUILD" ]] ; then
1176     # arvados-workbench depends on arvados-server at build time, so even when
1177     # only arvados-workbench is being built, we need to build arvados-server too
1178     if [[ "$PACKAGE_NAME" != "arvados-server" ]] || [[ "$ONLY_BUILD" != "arvados-workbench" ]]; then
1179       return 0
1180     fi
1181   fi
1182
1183   local default_iteration_value="$(default_iteration "$PACKAGE" "$VERSION" "$PACKAGE_TYPE")"
1184
1185   declare -a COMMAND_ARR=("fpm" "-s" "$PACKAGE_TYPE" "-t" "$FORMAT")
1186   if [ python = "$PACKAGE_TYPE" ] && [ deb = "$FORMAT" ]; then
1187       # Dependencies are built from setup.py.  Since setup.py will never
1188       # refer to Debian package iterations, it doesn't make sense to
1189       # enforce those in the .deb dependencies.
1190       COMMAND_ARR+=(--deb-ignore-iteration-in-dependencies)
1191   fi
1192
1193   if [[ "$DEBUG" != "0" ]]; then
1194     COMMAND_ARR+=('--verbose' '--log' 'info')
1195   fi
1196
1197   if [[ -n "$PACKAGE_NAME" ]]; then
1198     COMMAND_ARR+=('-n' "$PACKAGE_NAME")
1199   fi
1200
1201   if [[ "$MAINTAINER" != "" ]]; then
1202     COMMAND_ARR+=('--maintainer' "$MAINTAINER")
1203   fi
1204
1205   if [[ "$VENDOR" != "" ]]; then
1206     COMMAND_ARR+=('--vendor' "$VENDOR")
1207   fi
1208
1209   if [[ "$VERSION" != "" ]]; then
1210     COMMAND_ARR+=('-v' "$VERSION")
1211   fi
1212   if [[ -n "$default_iteration_value" ]]; then
1213       # We can always add an --iteration here.  If another one is specified in $@,
1214       # that will take precedence, as desired.
1215       COMMAND_ARR+=(--iteration "$default_iteration_value")
1216   fi
1217
1218   # Append --depends X and other arguments specified by fpm-info.sh in
1219   # the package source dir. These are added last so they can override
1220   # the arguments added by this script.
1221   declare -a fpm_args=()
1222   declare -a build_depends=()
1223   declare -a fpm_depends=()
1224   declare -a fpm_conflicts=()
1225   declare -a fpm_exclude=()
1226   if [[ ! -d "$SRC_DIR" ]]; then
1227       echo >&2 "BUG: looking in wrong dir for fpm-info.sh: $pkgdir"
1228       exit 1
1229   fi
1230   fpminfo="${SRC_DIR}/fpm-info.sh"
1231   if [[ -e "$fpminfo" ]]; then
1232       debug_echo "Loading fpm overrides from $fpminfo"
1233       source "$fpminfo"
1234   fi
1235   for pkg in "${build_depends[@]}"; do
1236       if [[ $TARGET =~ debian|ubuntu ]]; then
1237           pkg_deb=$(ls "$WORKSPACE/packages/$TARGET/$pkg_"*.deb | sort -rg | awk 'NR==1')
1238           if [[ -e $pkg_deb ]]; then
1239               echo "Installing build_dep $pkg from $pkg_deb"
1240               dpkg -i "$pkg_deb"
1241           else
1242               echo "Attemping to install build_dep $pkg using apt-get"
1243               apt-get install -y "$pkg"
1244           fi
1245           apt-get -y -f install
1246       else
1247           pkg_rpm=$(ls "$WORKSPACE/packages/$TARGET/$pkg"-[0-9]*.rpm | sort -rg | awk 'NR==1')
1248           if [[ -e $pkg_rpm ]]; then
1249               echo "Installing build_dep $pkg from $pkg_rpm"
1250               rpm -i "$pkg_rpm"
1251           else
1252               echo "Attemping to install build_dep $pkg"
1253               rpm -i "$pkg"
1254           fi
1255       fi
1256   done
1257   for i in "${fpm_depends[@]}"; do
1258     COMMAND_ARR+=('--depends' "$i")
1259   done
1260   for i in "${fpm_conflicts[@]}"; do
1261     COMMAND_ARR+=('--conflicts' "$i")
1262   done
1263   for i in "${fpm_exclude[@]}"; do
1264     COMMAND_ARR+=('--exclude' "$i")
1265   done
1266
1267   COMMAND_ARR+=("${fpm_args[@]}")
1268
1269   # Append remaining function arguments directly to fpm's command line.
1270   for i; do
1271     COMMAND_ARR+=("$i")
1272   done
1273
1274   COMMAND_ARR+=("$PACKAGE")
1275
1276   debug_echo -e "\n${COMMAND_ARR[@]}\n"
1277
1278   FPM_RESULTS=$("${COMMAND_ARR[@]}")
1279   FPM_EXIT_CODE=$?
1280
1281   fpm_verify $FPM_EXIT_CODE $FPM_RESULTS
1282
1283   # if something went wrong and debug is off, print out the fpm command that errored
1284   if [[ 0 -ne $? ]] && [[ "$STDOUT_IF_DEBUG" == "/dev/null" ]]; then
1285     echo -e "\n${COMMAND_ARR[@]}\n"
1286   fi
1287 }
1288
1289 # verify build results
1290 fpm_verify () {
1291   FPM_EXIT_CODE=$1
1292   shift
1293   FPM_RESULTS=$@
1294
1295   FPM_PACKAGE_NAME=''
1296   if [[ $FPM_RESULTS =~ ([A-Za-z0-9_\.-]*\.)(deb|rpm) ]]; then
1297     FPM_PACKAGE_NAME=${BASH_REMATCH[1]}${BASH_REMATCH[2]}
1298   fi
1299
1300   if [[ "$FPM_PACKAGE_NAME" == "" ]]; then
1301     EXITCODE=1
1302     echo
1303     echo "Error: $PACKAGE: Unable to figure out package name from fpm results:"
1304     echo
1305     echo $FPM_RESULTS
1306     echo
1307     return 1
1308   elif [[ "$FPM_RESULTS" =~ "File already exists" ]]; then
1309     echo "Package $FPM_PACKAGE_NAME exists, not rebuilding"
1310     return 0
1311   elif [[ 0 -ne "$FPM_EXIT_CODE" ]]; then
1312     EXITCODE=1
1313     echo "Error building package for $1:\n $FPM_RESULTS"
1314     return 1
1315   fi
1316 }
1317
1318 install_package() {
1319   PACKAGES=$@
1320   if [[ "$FORMAT" == "deb" ]]; then
1321     $SUDO apt-get install $PACKAGES --yes
1322   elif [[ "$FORMAT" == "rpm" ]]; then
1323     $SUDO yum -q -y install $PACKAGES
1324   fi
1325 }
1326
1327 title() {
1328     printf '%s %s\n' "=======" "$1"
1329 }
1330
1331 checkexit() {
1332     if [[ "$1" != "0" ]]; then
1333         title "$2 -- FAILED"
1334         failures+=("$2 (`timer`)")
1335     else
1336         successes+=("$2 (`timer`)")
1337     fi
1338 }
1339
1340 timer_reset() {
1341     t0=$SECONDS
1342 }
1343
1344 timer() {
1345     if [[ -n "$t0" ]]; then
1346         echo -n "$(($SECONDS - $t0))s"
1347     fi
1348 }
1349
1350 report_outcomes() {
1351     for x in "${successes[@]}"
1352     do
1353         echo "Pass: $x"
1354     done
1355
1356     if [[ ${#failures[@]} == 0 ]]
1357     then
1358         if [[ ${#successes[@]} != 0 ]]; then
1359            echo "All test suites passed."
1360         fi
1361     else
1362         echo "Failures (${#failures[@]}):"
1363         for x in "${failures[@]}"
1364         do
1365             echo "Fail: $x"
1366         done
1367     fi
1368 }