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