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