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