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     declare -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     iteration="$(default_iteration "$pkgname" "$version" "$pkgtype")"
 225
 226     if [[ "$arch" == "" ]]; then
 227       rpm_architecture="x86_64"
 228       deb_architecture="amd64"
 229
 230       if [[ "$pkgtype" =~ ^(python|python3)$ ]]; then
 231         rpm_architecture="noarch"
 232         deb_architecture="all"
 233       fi
 234
 235       if [[ "$pkgtype" =~ ^(src)$ ]]; then
 236         rpm_architecture="noarch"
 237         deb_architecture="all"
 238       fi
 239
 240       # These python packages have binary components
 241       if [[ "$pkgname" =~ (ruamel|ciso|pycrypto|pyyaml) ]]; then
 242         rpm_architecture="x86_64"
 243         deb_architecture="amd64"
 244       fi
 245     else
 246       rpm_architecture=$arch
 247       deb_architecture=$arch
 248     fi
 249
 250     if [[ "$FORMAT" == "deb" ]]; then
 251         local complete_pkgname="${pkgname}_$version${iteration:+-$iteration}_$deb_architecture.deb"
 252     else
 253         # rpm packages get iteration 1 if we don't supply one
 254         iteration=${iteration:-1}
 255         local complete_pkgname="$pkgname-$version-${iteration}.$rpm_architecture.rpm"
 256     fi
 257
 258     # See if we can skip building the package, only if it already exists in the
 259     # processed/ directory. If so, move it back to the packages directory to make
 260     # sure it gets picked up by the test and/or upload steps.
 261     if [[ -e "processed/$complete_pkgname" ]]; then
 262       echo "Package $complete_pkgname exists, not rebuilding!"
 263       mv processed/$complete_pkgname .
 264       return 1
 265     else
 266       echo "Package $complete_pkgname not found, building"
 267       return 0
 268     fi
 269 }
 270
 271 handle_rails_package() {
 272     local pkgname="$1"; shift
 273
 274     if [[ -n "$ONLY_BUILD" ]] && [[ "$pkgname" != "$ONLY_BUILD" ]] ; then
 275         return 0
 276     fi
 277     local srcdir="$1"; shift
 278     local license_path="$1"; shift
 279     local version="$(version_from_git)"
 280     local scripts_dir="$(mktemp --tmpdir -d "$pkgname-XXXXXXXX.scripts")" && \
 281     (
 282         set -e
 283         _build_rails_package_scripts "$pkgname" "$scripts_dir"
 284         cd "$srcdir"
 285         mkdir -p tmp
 286         git rev-parse HEAD >git-commit.version
 287         bundle package --all
 288     )
 289     if [[ 0 != "$?" ]] || ! cd "$WORKSPACE/packages/$TARGET"; then
 290         echo "ERROR: $pkgname package prep failed" >&2
 291         rm -rf "$scripts_dir"
 292         EXITCODE=1
 293         return 1
 294     fi
 295     local railsdir="/var/www/${pkgname%-server}/current"
 296     local -a pos_args=("$srcdir/=$railsdir" "$pkgname" "Curoverse, Inc." dir "$version")
 297     local license_arg="$license_path=$railsdir/$(basename "$license_path")"
 298     local -a switches=(--after-install "$scripts_dir/postinst"
 299                        --before-remove "$scripts_dir/prerm"
 300                        --after-remove "$scripts_dir/postrm")
 301     if [[ -z "$ARVADOS_BUILDING_VERSION" ]]; then
 302         switches+=(--iteration=$RAILS_PACKAGE_ITERATION)
 303     fi
 304     # For some reason fpm excludes need to not start with /.
 305     local exclude_root="${railsdir#/}"
 306     # .git and packages are for the SSO server, which is built from its
 307     # repository root.
 308     local -a exclude_list=(.git packages tmp log coverage Capfile\* \
 309                            config/deploy\* config/application.yml)
 310     # for arvados-workbench, we need to have the (dummy) config/database.yml in the package
 311     if  [[ "$pkgname" != "arvados-workbench" ]]; then
 312       exclude_list+=('config/database.yml')
 313     fi
 314     for exclude in ${exclude_list[@]}; do
 315         switches+=(-x "$exclude_root/$exclude")
 316     done
 317     fpm_build "${pos_args[@]}" "${switches[@]}" \
 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
 349   case "$PACKAGE_TYPE" in
 350       python)
 351           # All Arvados Python2 packages depend on Python 2.7.
 352           # Make sure we build with that for consistency.
 353           set -- "$@" --python-bin python2.7 \
 354               --python-easyinstall "$EASY_INSTALL2" \
 355               --python-package-name-prefix "$PYTHON2_PKG_PREFIX" \
 356               --prefix "$PYTHON2_PREFIX" \
 357               --python-install-lib "$PYTHON2_INSTALL_LIB" \
 358               --python-install-data . \
 359               --exclude "${PYTHON2_INSTALL_LIB#/}/tests" \
 360               --depends "$PYTHON2_PACKAGE"
 361           ;;
 362       python3)
 363           # fpm does not actually support a python3 package type.  Instead
 364           # we recognize it as a convenience shortcut to add several
 365           # necessary arguments to fpm's command line later, after we're
 366           # done handling positional arguments.
 367           PACKAGE_TYPE=python
 368           set -- "$@" --python-bin python3 \
 369               --python-easyinstall "$EASY_INSTALL3" \
 370               --python-package-name-prefix "$PYTHON3_PKG_PREFIX" \
 371               --prefix "$PYTHON3_PREFIX" \
 372               --python-install-lib "$PYTHON3_INSTALL_LIB" \
 373               --python-install-data . \
 374               --exclude "${PYTHON3_INSTALL_LIB#/}/tests" \
 375               --depends "$PYTHON3_PACKAGE"
 376           ;;
 377   esac
 378
 379   declare -a COMMAND_ARR=("fpm" "--maintainer=Ward Vandewege <ward@curoverse.com>" "-s" "$PACKAGE_TYPE" "-t" "$FORMAT")
 380   if [ python = "$PACKAGE_TYPE" ] && [ deb = "$FORMAT" ]; then
 381       # Dependencies are built from setup.py.  Since setup.py will never
 382       # refer to Debian package iterations, it doesn't make sense to
 383       # enforce those in the .deb dependencies.
 384       COMMAND_ARR+=(--deb-ignore-iteration-in-dependencies)
 385   fi
 386
 387   # 12271 - As FPM-generated packages don't include scripts by default, the
 388   # packages cleanup on upgrade depends on files being listed on the %files
 389   # section in the generated SPEC files. To remove DIRECTORIES, they need to
 390   # be listed in that sectiontoo, so we need to add this parameter to properly
 391   # remove lingering dirs.
 392   if [[ rpm = "$FORMAT" ]]; then
 393     COMMAND_ARR+=('--rpm-auto-add-directories')
 394   fi
 395
 396   if [[ "${DEBUG:-0}" != "0" ]]; then
 397     COMMAND_ARR+=('--verbose' '--log' 'info')
 398   fi
 399
 400   if [[ -n "$PACKAGE_NAME" ]]; then
 401     COMMAND_ARR+=('-n' "$PACKAGE_NAME")
 402   fi
 403
 404   if [[ "$VENDOR" != "" ]]; then
 405     COMMAND_ARR+=('--vendor' "$VENDOR")
 406   fi
 407
 408   if [[ "$VERSION" != "" ]]; then
 409     COMMAND_ARR+=('-v' "$VERSION")
 410   fi
 411   if [[ -n "$default_iteration_value" ]]; then
 412       # We can always add an --iteration here.  If another one is specified in $@,
 413       # that will take precedence, as desired.
 414       COMMAND_ARR+=(--iteration "$default_iteration_value")
 415   fi
 416
 417   if [[ python = "$PACKAGE_TYPE" ]] && [[ -e "${PACKAGE}/${PACKAGE_NAME}.service" ]]
 418   then
 419       COMMAND_ARR+=(
 420           --after-install "${WORKSPACE}/build/go-python-package-scripts/postinst"
 421           --before-remove "${WORKSPACE}/build/go-python-package-scripts/prerm"
 422       )
 423   fi
 424
 425   # Append --depends X and other arguments specified by fpm-info.sh in
 426   # the package source dir. These are added last so they can override
 427   # the arguments added by this script.
 428   declare -a fpm_args=()
 429   declare -a build_depends=()
 430   declare -a fpm_depends=()
 431   declare -a fpm_exclude=()
 432   declare -a fpm_dirs=(
 433       # source dir part of 'dir' package ("/source=/dest" => "/source"):
 434       "${PACKAGE%%=/*}"
 435       # backports ("llfuse>=1.0" => "backports/python-llfuse")
 436       "${WORKSPACE}/backports/${PACKAGE_TYPE}-${PACKAGE%%[<=>]*}")
 437   if [[ -n "$PACKAGE_NAME" ]]; then
 438       fpm_dirs+=("${WORKSPACE}/backports/${PACKAGE_NAME}")
 439   fi
 440   for pkgdir in "${fpm_dirs[@]}"; do
 441       fpminfo="$pkgdir/fpm-info.sh"
 442       if [[ -e "$fpminfo" ]]; then
 443           debug_echo "Loading fpm overrides from $fpminfo"
 444           source "$fpminfo"
 445           break
 446       fi
 447   done
 448   for pkg in "${build_depends[@]}"; do
 449       if [[ $TARGET =~ debian|ubuntu ]]; then
 450           pkg_deb=$(ls "$WORKSPACE/packages/$TARGET/$pkg_"*.deb | sort -rg | awk 'NR==1')
 451           if [[ -e $pkg_deb ]]; then
 452               echo "Installing build_dep $pkg from $pkg_deb"
 453               dpkg -i "$pkg_deb"
 454           else
 455               echo "Attemping to install build_dep $pkg using apt-get"
 456               apt-get install -y "$pkg"
 457           fi
 458           apt-get -y -f install
 459       else
 460           pkg_rpm=$(ls "$WORKSPACE/packages/$TARGET/$pkg"-[0-9]*.rpm | sort -rg | awk 'NR==1')
 461           if [[ -e $pkg_rpm ]]; then
 462               echo "Installing build_dep $pkg from $pkg_rpm"
 463               rpm -i "$pkg_rpm"
 464           else
 465               echo "Attemping to install build_dep $pkg"
 466               rpm -i "$pkg"
 467           fi
 468       fi
 469   done
 470   for i in "${fpm_depends[@]}"; do
 471     COMMAND_ARR+=('--depends' "$i")
 472   done
 473   for i in "${fpm_exclude[@]}"; do
 474     COMMAND_ARR+=('--exclude' "$i")
 475   done
 476
 477   # Append remaining function arguments directly to fpm's command line.
 478   for i; do
 479     COMMAND_ARR+=("$i")
 480   done
 481
 482   COMMAND_ARR+=("${fpm_args[@]}")
 483
 484   COMMAND_ARR+=("$PACKAGE")
 485
 486   debug_echo -e "\n${COMMAND_ARR[@]}\n"
 487
 488   FPM_RESULTS=$("${COMMAND_ARR[@]}")
 489   FPM_EXIT_CODE=$?
 490
 491   fpm_verify $FPM_EXIT_CODE $FPM_RESULTS
 492
 493   # if something went wrong and debug is off, print out the fpm command that errored
 494   if [[ 0 -ne $? ]] && [[ "$STDOUT_IF_DEBUG" == "/dev/null" ]]; then
 495     echo -e "\n${COMMAND_ARR[@]}\n"
 496   fi
 497 }
 498
 499 # verify build results
 500 fpm_verify () {
 501   FPM_EXIT_CODE=$1
 502   shift
 503   FPM_RESULTS=$@
 504
 505   FPM_PACKAGE_NAME=''
 506   if [[ $FPM_RESULTS =~ ([A-Za-z0-9_\.-]*\.)(deb|rpm) ]]; then
 507     FPM_PACKAGE_NAME=${BASH_REMATCH[1]}${BASH_REMATCH[2]}
 508   fi
 509
 510   if [[ "$FPM_PACKAGE_NAME" == "" ]]; then
 511     EXITCODE=1
 512     echo
 513     echo "Error: $PACKAGE: Unable to figure out package name from fpm results:"
 514     echo
 515     echo $FPM_RESULTS
 516     echo
 517     return 1
 518   elif [[ "$FPM_RESULTS" =~ "File already exists" ]]; then
 519     echo "Package $FPM_PACKAGE_NAME exists, not rebuilding"
 520     return 0
 521   elif [[ 0 -ne "$FPM_EXIT_CODE" ]]; then
 522     EXITCODE=1
 523     echo "Error building package for $1:\n $FPM_RESULTS"
 524     return 1
 525   fi
 526 }
 527
 528 install_package() {
 529   PACKAGES=$@
 530   if [[ "$FORMAT" == "deb" ]]; then
 531     $SUDO apt-get install $PACKAGES --yes
 532   elif [[ "$FORMAT" == "rpm" ]]; then
 533     $SUDO yum -q -y install $PACKAGES
 534   fi
 535 }
 536
 537 title () {
 538     txt="********** $1 **********"
 539     printf "\n%*s%s\n\n" $((($COLUMNS-${#txt})/2)) "" "$txt"
 540 }
 541
 542 checkexit() {
 543     if [[ "$1" != "0" ]]; then
 544         title "!!!!!! $2 FAILED !!!!!!"
 545         failures+=("$2 (`timer`)")
 546     else
 547         successes+=("$2 (`timer`)")
 548     fi
 549 }
 550
 551 timer_reset() {
 552     t0=$SECONDS
 553 }
 554
 555 timer() {
 556     echo -n "$(($SECONDS - $t0))s"
 557 }
 558
 559 report_outcomes() {
 560     for x in "${successes[@]}"
 561     do
 562         echo "Pass: $x"
 563     done
 564
 565     if [[ ${#failures[@]} == 0 ]]
 566     then
 567         echo "All test suites passed."
 568     else
 569         echo "Failures (${#failures[@]}):"
 570         for x in "${failures[@]}"
 571         do
 572             echo "Fail: $x"
 573         done
 574     fi
 575 }