build/run-library.sh

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