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