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