build/run-library.sh

   1 #!/bin/bash -x
   2 # Copyright (C) The Arvados Authors. All rights reserved.
   3 #
   4 # SPDX-License-Identifier: AGPL-3.0
   5
   6 # A library of functions shared by the various scripts in this directory.
   7
   8 # This is the timestamp about when we merged changed to include licenses
   9 # with Arvados packages.  We use it as a heuristic to add revisions for
  10 # older packages.
  11 LICENSE_PACKAGE_TS=20151208015500
  12
  13 if [[ -z "$ARVADOS_BUILDING_VERSION" ]]; then
  14     RAILS_PACKAGE_ITERATION=8
  15 else
  16     RAILS_PACKAGE_ITERATION="$ARVADOS_BUILDING_ITERATION"
  17 fi
  18
  19 debug_echo () {
  20     echo "$@" >"$STDOUT_IF_DEBUG"
  21 }
  22
  23 find_easy_install() {
  24     for version_suffix in "$@"; do
  25         if "easy_install$version_suffix" --version >/dev/null 2>&1; then
  26             echo "easy_install$version_suffix"
  27             return 0
  28         fi
  29     done
  30     cat >&2 <<EOF
  31 $helpmessage
  32
  33 Error: easy_install$1 (from Python setuptools module) not found
  34
  35 EOF
  36     exit 1
  37 }
  38
  39 format_last_commit_here() {
  40     local format="$1"; shift
  41     TZ=UTC git log -n1 --first-parent "--format=format:$format" .
  42 }
  43
  44 version_from_git() {
  45     # Output the version being built, or if we're building a
  46     # dev/prerelease, output a version number based on the git log for
  47     # the current working directory.
  48     if [[ -n "$ARVADOS_BUILDING_VERSION" ]]; then
  49         echo "$ARVADOS_BUILDING_VERSION"
  50         return
  51     fi
  52
  53     local git_ts git_hash prefix
  54     if [[ -n "$1" ]] ; then
  55         prefix="$1"
  56     else
  57         prefix="0.1"
  58     fi
  59
  60     declare $(format_last_commit_here "git_ts=%ct git_hash=%h")
  61     ARVADOS_BUILDING_VERSION="$(git describe --abbrev=0).$(date -ud "@$git_ts" +%Y%m%d%H%M%S)"
  62     echo "$ARVADOS_BUILDING_VERSION"
  63 }
  64
  65 nohash_version_from_git() {
  66     if [[ -n "$ARVADOS_BUILDING_VERSION" ]]; then
  67         echo "$ARVADOS_BUILDING_VERSION"
  68         return
  69     fi
  70     version_from_git $1 | cut -d. -f1-4
  71 }
  72
  73 timestamp_from_git() {
  74     format_last_commit_here "%ct"
  75 }
  76
  77 handle_python_package () {
  78   # This function assumes the current working directory is the python package directory
  79   if [ -n "$(find dist -name "*-$(nohash_version_from_git).tar.gz" -print -quit)" ]; then
  80     # This package doesn't need rebuilding.
  81     return
  82   fi
  83   # Make sure only to use sdist - that's the only format pip can deal with (sigh)
  84   python setup.py $DASHQ_UNLESS_DEBUG sdist
  85 }
  86
  87 handle_ruby_gem() {
  88     local gem_name="$1"; shift
  89     local gem_version="$(nohash_version_from_git)"
  90     local gem_src_dir="$(pwd)"
  91
  92     if [[ -n "$ONLY_BUILD" ]] && [[ "$gem_name" != "$ONLY_BUILD" ]] ; then
  93         return 0
  94     fi
  95
  96     if ! [[ -e "${gem_name}-${gem_version}.gem" ]]; then
  97         find -maxdepth 1 -name "${gem_name}-*.gem" -delete
  98
  99         # -q appears to be broken in gem version 2.2.2
 100         $GEM build "$gem_name.gemspec" $DASHQ_UNLESS_DEBUG >"$STDOUT_IF_DEBUG" 2>"$STDERR_IF_DEBUG"
 101     fi
 102 }
 103
 104 # Usage: package_go_binary services/foo arvados-foo "Compute foo to arbitrary precision"
 105 package_go_binary() {
 106     local src_path="$1"; shift
 107     local prog="$1"; shift
 108     local description="$1"; shift
 109     local license_file="${1:-agpl-3.0.txt}"; shift
 110
 111     if [[ -n "$ONLY_BUILD" ]] && [[ "$prog" != "$ONLY_BUILD" ]] ; then
 112         return 0
 113     fi
 114
 115     debug_echo "package_go_binary $src_path as $prog"
 116
 117     local basename="${src_path##*/}"
 118
 119     mkdir -p "$GOPATH/src/git.curoverse.com"
 120     ln -sfn "$WORKSPACE" "$GOPATH/src/git.curoverse.com/arvados.git"
 121     (cd "$GOPATH/src/git.curoverse.com/arvados.git" && "$GOPATH/bin/govendor" sync -v)
 122
 123     cd "$GOPATH/src/git.curoverse.com/arvados.git/$src_path"
 124     local version="$(version_from_git)"
 125     local timestamp="$(timestamp_from_git)"
 126
 127     # Update the version number and build a new package if the vendor
 128     # bundle has changed, or the command imports anything from the
 129     # Arvados SDK and the SDK has changed.
 130     declare -a checkdirs=(vendor)
 131     if grep -qr git.curoverse.com/arvados .; then
 132         checkdirs+=(sdk/go)
 133         if [[ "$prog" -eq "crunch-dispatch-slurm" ]]; then
 134           checkdirs+=(lib/dispatchcloud)
 135         fi
 136     fi
 137     for dir in ${checkdirs[@]}; do
 138         cd "$GOPATH/src/git.curoverse.com/arvados.git/$dir"
 139         ts="$(timestamp_from_git)"
 140         if [[ "$ts" -gt "$timestamp" ]]; then
 141             version=$(version_from_git)
 142             timestamp="$ts"
 143         fi
 144     done
 145
 146     cd $WORKSPACE/packages/$TARGET
 147     test_package_presence $prog $version go
 148
 149     if [[ "$?" != "0" ]]; then
 150       return 1
 151     fi
 152
 153     go get -ldflags "-X main.version=${version}" "git.curoverse.com/arvados.git/$src_path"
 154
 155     local -a switches=()
 156     systemd_unit="$WORKSPACE/${src_path}/${prog}.service"
 157     if [[ -e "${systemd_unit}" ]]; then
 158         switches+=(
 159             --after-install "${WORKSPACE}/build/go-python-package-scripts/postinst"
 160             --before-remove "${WORKSPACE}/build/go-python-package-scripts/prerm"
 161             "${systemd_unit}=/lib/systemd/system/${prog}.service")
 162     fi
 163     switches+=("$WORKSPACE/${license_file}=/usr/share/doc/$prog/${license_file}")
 164
 165     fpm_build "$GOPATH/bin/${basename}=/usr/bin/${prog}" "${prog}" 'Curoverse, Inc.' dir "${version}" "--url=https://arvados.org" "--license=GNU Affero General Public License, version 3.0" "--description=${description}" "${switches[@]}"
 166 }
 167
 168 default_iteration() {
 169     if [[ -n "$ARVADOS_BUILDING_VERSION" ]]; then
 170         echo "$ARVADOS_BUILDING_ITERATION"
 171         return
 172     fi
 173     local package_name="$1"; shift
 174     local package_version="$1"; shift
 175     local package_type="$1"; shift
 176     local iteration=1
 177     if [[ $package_version =~ ^0\.1\.([0-9]{14})(\.|$) ]] && \
 178            [[ ${BASH_REMATCH[1]} -le $LICENSE_PACKAGE_TS ]]; then
 179         iteration=2
 180     fi
 181     if [[ $package_type =~ ^python ]]; then
 182       # Fix --iteration for #9242.
 183       iteration=2
 184     fi
 185     echo $iteration
 186 }
 187
 188 _build_rails_package_scripts() {
 189     local pkgname="$1"; shift
 190     local destdir="$1"; shift
 191     local srcdir="$RUN_BUILD_PACKAGES_PATH/rails-package-scripts"
 192     for scriptname in postinst prerm postrm; do
 193         cat "$srcdir/$pkgname.sh" "$srcdir/step2.sh" "$srcdir/$scriptname.sh" \
 194             >"$destdir/$scriptname" || return $?
 195     done
 196 }
 197
 198 test_rails_package_presence() {
 199   local pkgname="$1"; shift
 200   local srcdir="$1"; shift
 201
 202   if [[ -n "$ONLY_BUILD" ]] && [[ "$pkgname" != "$ONLY_BUILD" ]] ; then
 203     return 1
 204   fi
 205
 206   tmppwd=`pwd`
 207
 208   cd $srcdir
 209
 210   local version="$(version_from_git)"
 211
 212   cd $tmppwd
 213
 214   test_package_presence $pkgname $version rails "$RAILS_PACKAGE_ITERATION"
 215 }
 216
 217 test_package_presence() {
 218     local pkgname="$1"; shift
 219     local version="$1"; shift
 220     local pkgtype="$1"; shift
 221     local iteration="$1"; shift
 222     local arch="$1"; shift
 223
 224     if [[ -n "$ONLY_BUILD" ]] && [[ "$pkgname" != "$ONLY_BUILD" ]] ; then
 225         return 1
 226     fi
 227
 228     if [[ "$iteration" == "" ]]; then
 229         iteration="$(default_iteration "$pkgname" "$version" "$pkgtype")"
 230     fi
 231
 232     if [[ "$arch" == "" ]]; then
 233       rpm_architecture="x86_64"
 234       deb_architecture="amd64"
 235
 236       if [[ "$pkgtype" =~ ^(python|python3)$ ]]; then
 237         rpm_architecture="noarch"
 238         deb_architecture="all"
 239       fi
 240
 241       if [[ "$pkgtype" =~ ^(src)$ ]]; then
 242         rpm_architecture="noarch"
 243         deb_architecture="all"
 244       fi
 245
 246       # These python packages have binary components
 247       if [[ "$pkgname" =~ (ruamel|ciso|pycrypto|pyyaml) ]]; then
 248         rpm_architecture="x86_64"
 249         deb_architecture="amd64"
 250       fi
 251     else
 252       rpm_architecture=$arch
 253       deb_architecture=$arch
 254     fi
 255
 256     if [[ "$FORMAT" == "deb" ]]; then
 257         local complete_pkgname="${pkgname}_$version${iteration:+-$iteration}_$deb_architecture.deb"
 258     else
 259         # rpm packages get iteration 1 if we don't supply one
 260         iteration=${iteration:-1}
 261         local complete_pkgname="$pkgname-$version-${iteration}.$rpm_architecture.rpm"
 262     fi
 263
 264     # See if we can skip building the package, only if it already exists in the
 265     # processed/ directory. If so, move it back to the packages directory to make
 266     # sure it gets picked up by the test and/or upload steps.
 267     if [[ -e "processed/$complete_pkgname" ]]; then
 268       echo "Package $complete_pkgname exists, not rebuilding!"
 269       mv processed/$complete_pkgname .
 270       return 1
 271     else
 272       echo "Package $complete_pkgname not found, building"
 273       return 0
 274     fi
 275 }
 276
 277 handle_rails_package() {
 278     local pkgname="$1"; shift
 279
 280     if [[ -n "$ONLY_BUILD" ]] && [[ "$pkgname" != "$ONLY_BUILD" ]] ; then
 281         return 0
 282     fi
 283     local srcdir="$1"; shift
 284     cd "$srcdir"
 285     local license_path="$1"; shift
 286     local version="$(version_from_git)"
 287     local scripts_dir="$(mktemp --tmpdir -d "$pkgname-XXXXXXXX.scripts")" && \
 288     (
 289         set -e
 290         _build_rails_package_scripts "$pkgname" "$scripts_dir"
 291         cd "$srcdir"
 292         mkdir -p tmp
 293         git rev-parse HEAD >git-commit.version
 294         bundle package --all
 295     )
 296     if [[ 0 != "$?" ]] || ! cd "$WORKSPACE/packages/$TARGET"; then
 297         echo "ERROR: $pkgname package prep failed" >&2
 298         rm -rf "$scripts_dir"
 299         EXITCODE=1
 300         return 1
 301     fi
 302     local railsdir="/var/www/${pkgname%-server}/current"
 303     local -a pos_args=("$srcdir/=$railsdir" "$pkgname" "Curoverse, Inc." dir "$version")
 304     local license_arg="$license_path=$railsdir/$(basename "$license_path")"
 305     local -a switches=(--after-install "$scripts_dir/postinst"
 306                        --before-remove "$scripts_dir/prerm"
 307                        --after-remove "$scripts_dir/postrm")
 308     if [[ -z "$ARVADOS_BUILDING_VERSION" ]]; then
 309         switches+=(--iteration $RAILS_PACKAGE_ITERATION)
 310     fi
 311     # For some reason fpm excludes need to not start with /.
 312     local exclude_root="${railsdir#/}"
 313     # .git and packages are for the SSO server, which is built from its
 314     # repository root.
 315     local -a exclude_list=(.git packages tmp log coverage Capfile\* \
 316                            config/deploy\* config/application.yml)
 317     # for arvados-workbench, we need to have the (dummy) config/database.yml in the package
 318     if  [[ "$pkgname" != "arvados-workbench" ]]; then
 319       exclude_list+=('config/database.yml')
 320     fi
 321     for exclude in ${exclude_list[@]}; do
 322         switches+=(-x "$exclude_root/$exclude")
 323     done
 324     fpm_build "${pos_args[@]}" "${switches[@]}" \
 325               -x "$exclude_root/vendor/cache-*" \
 326               -x "$exclude_root/vendor/bundle" "$@" "$license_arg"
 327     rm -rf "$scripts_dir"
 328 }
 329
 330 # Build packages for everything
 331 fpm_build () {
 332   # The package source.  Depending on the source type, this can be a
 333   # path, or the name of the package in an upstream repository (e.g.,
 334   # pip).
 335   PACKAGE=$1
 336   shift
 337   # The name of the package to build.
 338   PACKAGE_NAME=$1
 339   shift
 340   # Optional: the vendor of the package.  Should be "Curoverse, Inc." for
 341   # packages of our own software.  Passed to fpm --vendor.
 342   VENDOR=$1
 343   shift
 344   # The type of source package.  Passed to fpm -s.  Default "python".
 345   PACKAGE_TYPE=${1:-python}
 346   shift
 347   # Optional: the package version number.  Passed to fpm -v.
 348   VERSION=$1
 349   shift
 350
 351   if [[ -n "$ONLY_BUILD" ]] && [[ "$PACKAGE_NAME" != "$ONLY_BUILD" ]] && [[ "$PACKAGE" != "$ONLY_BUILD" ]] ; then
 352       return 0
 353   fi
 354
 355   local default_iteration_value="$(default_iteration "$PACKAGE" "$VERSION" "$PACKAGE_TYPE")"
 356   local python=""
 357
 358   case "$PACKAGE_TYPE" in
 359       python)
 360           # All Arvados Python2 packages depend on Python 2.7.
 361           # Make sure we build with that for consistency.
 362           python=python2.7
 363           set -- "$@" --python-bin python2.7 \
 364               --python-easyinstall "$EASY_INSTALL2" \
 365               --python-package-name-prefix "$PYTHON2_PKG_PREFIX" \
 366               --prefix "$PYTHON2_PREFIX" \
 367               --python-install-lib "$PYTHON2_INSTALL_LIB" \
 368               --python-install-data . \
 369               --exclude "${PYTHON2_INSTALL_LIB#/}/tests" \
 370               --depends "$PYTHON2_PACKAGE"
 371           ;;
 372       python3)
 373           # fpm does not actually support a python3 package type.  Instead
 374           # we recognize it as a convenience shortcut to add several
 375           # necessary arguments to fpm's command line later, after we're
 376           # done handling positional arguments.
 377           PACKAGE_TYPE=python
 378           python=python3
 379           set -- "$@" --python-bin python3 \
 380               --python-easyinstall "$EASY_INSTALL3" \
 381               --python-package-name-prefix "$PYTHON3_PKG_PREFIX" \
 382               --prefix "$PYTHON3_PREFIX" \
 383               --python-install-lib "$PYTHON3_INSTALL_LIB" \
 384               --python-install-data . \
 385               --exclude "${PYTHON3_INSTALL_LIB#/}/tests" \
 386               --depends "$PYTHON3_PACKAGE"
 387           ;;
 388   esac
 389
 390   declare -a COMMAND_ARR=("fpm" "--maintainer=Ward Vandewege <ward@curoverse.com>" "-s" "$PACKAGE_TYPE" "-t" "$FORMAT")
 391   if [ python = "$PACKAGE_TYPE" ] && [ deb = "$FORMAT" ]; then
 392       # Dependencies are built from setup.py.  Since setup.py will never
 393       # refer to Debian package iterations, it doesn't make sense to
 394       # enforce those in the .deb dependencies.
 395       COMMAND_ARR+=(--deb-ignore-iteration-in-dependencies)
 396   fi
 397
 398   # 12271 - As FPM-generated packages don't include scripts by default, the
 399   # packages cleanup on upgrade depends on files being listed on the %files
 400   # section in the generated SPEC files. To remove DIRECTORIES, they need to
 401   # be listed in that sectiontoo, so we need to add this parameter to properly
 402   # remove lingering dirs. But this only works for python2: if used on
 403   # python33, it includes dirs like /opt/rh/python33 that belong to
 404   # other packages.
 405   if [[ "$FORMAT" = rpm ]] && [[ "$python" = python2.7 ]]; then
 406     COMMAND_ARR+=('--rpm-auto-add-directories')
 407   fi
 408
 409   if [[ "${DEBUG:-0}" != "0" ]]; then
 410     COMMAND_ARR+=('--verbose' '--log' 'info')
 411   fi
 412
 413   if [[ -n "$PACKAGE_NAME" ]]; then
 414     COMMAND_ARR+=('-n' "$PACKAGE_NAME")
 415   fi
 416
 417   if [[ "$VENDOR" != "" ]]; then
 418     COMMAND_ARR+=('--vendor' "$VENDOR")
 419   fi
 420
 421   if [[ "$VERSION" != "" ]]; then
 422     COMMAND_ARR+=('-v' "$VERSION")
 423   fi
 424   if [[ -n "$default_iteration_value" ]]; then
 425       # We can always add an --iteration here.  If another one is specified in $@,
 426       # that will take precedence, as desired.
 427       COMMAND_ARR+=(--iteration "$default_iteration_value")
 428   fi
 429
 430   if [[ python = "$PACKAGE_TYPE" ]] && [[ -e "${PACKAGE}/${PACKAGE_NAME}.service" ]]
 431   then
 432       COMMAND_ARR+=(
 433           --after-install "${WORKSPACE}/build/go-python-package-scripts/postinst"
 434           --before-remove "${WORKSPACE}/build/go-python-package-scripts/prerm"
 435       )
 436   fi
 437
 438   # Append --depends X and other arguments specified by fpm-info.sh in
 439   # the package source dir. These are added last so they can override
 440   # the arguments added by this script.
 441   declare -a fpm_args=()
 442   declare -a build_depends=()
 443   declare -a fpm_depends=()
 444   declare -a fpm_exclude=()
 445   declare -a fpm_dirs=(
 446       # source dir part of 'dir' package ("/source=/dest" => "/source"):
 447       "${PACKAGE%%=/*}"
 448       # backports ("llfuse>=1.0" => "backports/python-llfuse")
 449       "${WORKSPACE}/backports/${PACKAGE_TYPE}-${PACKAGE%%[<=>]*}")
 450   if [[ -n "$PACKAGE_NAME" ]]; then
 451       fpm_dirs+=("${WORKSPACE}/backports/${PACKAGE_NAME}")
 452   fi
 453   for pkgdir in "${fpm_dirs[@]}"; do
 454       fpminfo="$pkgdir/fpm-info.sh"
 455       if [[ -e "$fpminfo" ]]; then
 456           debug_echo "Loading fpm overrides from $fpminfo"
 457           source "$fpminfo"
 458           break
 459       fi
 460   done
 461   for pkg in "${build_depends[@]}"; do
 462       if [[ $TARGET =~ debian|ubuntu ]]; then
 463           pkg_deb=$(ls "$WORKSPACE/packages/$TARGET/$pkg_"*.deb | sort -rg | awk 'NR==1')
 464           if [[ -e $pkg_deb ]]; then
 465               echo "Installing build_dep $pkg from $pkg_deb"
 466               dpkg -i "$pkg_deb"
 467           else
 468               echo "Attemping to install build_dep $pkg using apt-get"
 469               apt-get install -y "$pkg"
 470           fi
 471           apt-get -y -f install
 472       else
 473           pkg_rpm=$(ls "$WORKSPACE/packages/$TARGET/$pkg"-[0-9]*.rpm | sort -rg | awk 'NR==1')
 474           if [[ -e $pkg_rpm ]]; then
 475               echo "Installing build_dep $pkg from $pkg_rpm"
 476               rpm -i "$pkg_rpm"
 477           else
 478               echo "Attemping to install build_dep $pkg"
 479               rpm -i "$pkg"
 480           fi
 481       fi
 482   done
 483   for i in "${fpm_depends[@]}"; do
 484     COMMAND_ARR+=('--depends' "$i")
 485   done
 486   for i in "${fpm_exclude[@]}"; do
 487     COMMAND_ARR+=('--exclude' "$i")
 488   done
 489
 490   # Append remaining function arguments directly to fpm's command line.
 491   for i; do
 492     COMMAND_ARR+=("$i")
 493   done
 494
 495   COMMAND_ARR+=("${fpm_args[@]}")
 496
 497   COMMAND_ARR+=("$PACKAGE")
 498
 499   debug_echo -e "\n${COMMAND_ARR[@]}\n"
 500
 501   FPM_RESULTS=$("${COMMAND_ARR[@]}")
 502   FPM_EXIT_CODE=$?
 503
 504   fpm_verify $FPM_EXIT_CODE $FPM_RESULTS
 505
 506   # if something went wrong and debug is off, print out the fpm command that errored
 507   if [[ 0 -ne $? ]] && [[ "$STDOUT_IF_DEBUG" == "/dev/null" ]]; then
 508     echo -e "\n${COMMAND_ARR[@]}\n"
 509   fi
 510 }
 511
 512 # verify build results
 513 fpm_verify () {
 514   FPM_EXIT_CODE=$1
 515   shift
 516   FPM_RESULTS=$@
 517
 518   FPM_PACKAGE_NAME=''
 519   if [[ $FPM_RESULTS =~ ([A-Za-z0-9_\.-]*\.)(deb|rpm) ]]; then
 520     FPM_PACKAGE_NAME=${BASH_REMATCH[1]}${BASH_REMATCH[2]}
 521   fi
 522
 523   if [[ "$FPM_PACKAGE_NAME" == "" ]]; then
 524     EXITCODE=1
 525     echo
 526     echo "Error: $PACKAGE: Unable to figure out package name from fpm results:"
 527     echo
 528     echo $FPM_RESULTS
 529     echo
 530     return 1
 531   elif [[ "$FPM_RESULTS" =~ "File already exists" ]]; then
 532     echo "Package $FPM_PACKAGE_NAME exists, not rebuilding"
 533     return 0
 534   elif [[ 0 -ne "$FPM_EXIT_CODE" ]]; then
 535     EXITCODE=1
 536     echo "Error building package for $1:\n $FPM_RESULTS"
 537     return 1
 538   fi
 539 }
 540
 541 install_package() {
 542   PACKAGES=$@
 543   if [[ "$FORMAT" == "deb" ]]; then
 544     $SUDO apt-get install $PACKAGES --yes
 545   elif [[ "$FORMAT" == "rpm" ]]; then
 546     $SUDO yum -q -y install $PACKAGES
 547   fi
 548 }
 549
 550 title () {
 551     txt="********** $1 **********"
 552     printf "\n%*s%s\n\n" $((($COLUMNS-${#txt})/2)) "" "$txt"
 553 }
 554
 555 checkexit() {
 556     if [[ "$1" != "0" ]]; then
 557         title "!!!!!! $2 FAILED !!!!!!"
 558         failures+=("$2 (`timer`)")
 559     else
 560         successes+=("$2 (`timer`)")
 561     fi
 562 }
 563
 564 timer_reset() {
 565     t0=$SECONDS
 566 }
 567
 568 timer() {
 569     echo -n "$(($SECONDS - $t0))s"
 570 }
 571
 572 report_outcomes() {
 573     for x in "${successes[@]}"
 574     do
 575         echo "Pass: $x"
 576     done
 577
 578     if [[ ${#failures[@]} == 0 ]]
 579     then
 580         echo "All test suites passed."
 581     else
 582         echo "Failures (${#failures[@]}):"
 583         for x in "${failures[@]}"
 584         do
 585             echo "Fail: $x"
 586         done
 587     fi
 588 }