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