build/run-tests.sh

   1 #!/bin/bash
   2 # Copyright (C) The Arvados Authors. All rights reserved.
   3 #
   4 # SPDX-License-Identifier: AGPL-3.0
   5
   6 . `dirname "$(readlink -f "$0")"`/libcloud-pin.sh
   7
   8 COLUMNS=80
   9 . `dirname "$(readlink -f "$0")"`/run-library.sh
  10
  11 read -rd "\000" helpmessage <<EOF
  12 $(basename $0): Install and test Arvados components.
  13
  14 Exit non-zero if any tests fail.
  15
  16 Syntax:
  17         $(basename $0) WORKSPACE=/path/to/arvados [options]
  18
  19 Options:
  20
  21 --skip FOO     Do not test the FOO component.
  22 --only FOO     Do not test anything except the FOO component.
  23 --temp DIR     Install components and dependencies under DIR instead of
  24                making a new temporary directory. Implies --leave-temp.
  25 --leave-temp   Do not remove GOPATH, virtualenv, and other temp dirs at exit.
  26                Instead, show the path to give as --temp to reuse them in
  27                subsequent invocations.
  28 --repeat N     Repeat each install/test step until it succeeds N times.
  29 --retry        Prompt to retry if an install or test suite fails.
  30 --skip-install Do not run any install steps. Just run tests.
  31                You should provide GOPATH, GEMHOME, and VENVDIR options
  32                from a previous invocation if you use this option.
  33 --only-install Run specific install step
  34 --short        Skip (or scale down) some slow tests.
  35 WORKSPACE=path Arvados source tree to test.
  36 CONFIGSRC=path Dir with api server config files to copy into source tree.
  37                (If none given, leave config files alone in source tree.)
  38 services/api_test="TEST=test/functional/arvados/v1/collections_controller_test.rb"
  39                Restrict apiserver tests to the given file
  40 sdk/python_test="--test-suite tests.test_keep_locator"
  41                Restrict Python SDK tests to the given class
  42 apps/workbench_test="TEST=test/integration/pipeline_instances_test.rb"
  43                Restrict Workbench tests to the given file
  44 services/arv-git-httpd_test="-check.vv"
  45                Show all log messages, even when tests pass (also works
  46                with services/keepstore_test etc.)
  47 ARVADOS_DEBUG=1
  48                Print more debug messages
  49 envvar=value   Set \$envvar to value. Primarily useful for WORKSPACE,
  50                *_test, and other examples shown above.
  51
  52 Assuming --skip-install is not given, all components are installed
  53 into \$GOPATH, \$VENDIR, and \$GEMHOME before running any tests. Many
  54 test suites depend on other components being installed, and installing
  55 everything tends to be quicker than debugging dependencies.
  56
  57 As a special concession to the current CI server config, CONFIGSRC
  58 defaults to $HOME/arvados-api-server if that directory exists.
  59
  60 More information and background:
  61
  62 https://arvados.org/projects/arvados/wiki/Running_tests
  63
  64 Available tests:
  65
  66 apps/workbench (*)
  67 apps/workbench_units (*)
  68 apps/workbench_functionals (*)
  69 apps/workbench_integration (*)
  70 apps/workbench_benchmark
  71 apps/workbench_profile
  72 cmd/arvados-client
  73 cmd/arvados-server
  74 doc
  75 lib/cli
  76 lib/cmd
  77 lib/controller
  78 lib/crunchstat
  79 lib/dispatchcloud
  80 services/api
  81 services/arv-git-httpd
  82 services/crunchstat
  83 services/dockercleaner
  84 services/fuse
  85 services/health
  86 services/keep-web
  87 services/keepproxy
  88 services/keepstore
  89 services/keep-balance
  90 services/login-sync
  91 services/nodemanager
  92 services/nodemanager_integration
  93 services/crunch-run
  94 services/crunch-dispatch-local
  95 services/crunch-dispatch-slurm
  96 services/ws
  97 sdk/cli
  98 sdk/pam
  99 sdk/python
 100 sdk/python:py3
 101 sdk/ruby
 102 sdk/go/arvados
 103 sdk/go/arvadosclient
 104 sdk/go/auth
 105 sdk/go/dispatch
 106 sdk/go/keepclient
 107 sdk/go/health
 108 sdk/go/httpserver
 109 sdk/go/manifest
 110 sdk/go/blockdigest
 111 sdk/go/asyncbuf
 112 sdk/go/stats
 113 sdk/go/crunchrunner
 114 sdk/cwl
 115 sdk/R
 116 tools/sync-groups
 117 tools/crunchstat-summary
 118 tools/keep-exercise
 119 tools/keep-rsync
 120 tools/keep-block-check
 121
 122 (*) apps/workbench is shorthand for apps/workbench_units +
 123     apps/workbench_functionals + apps/workbench_integration
 124
 125 EOF
 126
 127 # First make sure to remove any ARVADOS_ variables from the calling
 128 # environment that could interfere with the tests.
 129 unset $(env | cut -d= -f1 | grep \^ARVADOS_)
 130
 131 # Reset other variables that could affect our [tests'] behavior by
 132 # accident.
 133 GITDIR=
 134 GOPATH=
 135 VENVDIR=
 136 VENV3DIR=
 137 PYTHONPATH=
 138 GEMHOME=
 139 PERLINSTALLBASE=
 140 R_LIBS=
 141
 142 short=
 143 only_install=
 144 temp=
 145 temp_preserve=
 146
 147 clear_temp() {
 148     if [[ -z "$temp" ]]; then
 149         # we didn't even get as far as making a temp dir
 150         :
 151     elif [[ -z "$temp_preserve" ]]; then
 152         rm -rf "$temp"
 153     else
 154         echo "Leaving behind temp dirs in $temp"
 155     fi
 156 }
 157
 158 fatal() {
 159     clear_temp
 160     echo >&2 "Fatal: $* (encountered in ${FUNCNAME[1]} at ${BASH_SOURCE[1]} line ${BASH_LINENO[0]})"
 161     exit 1
 162 }
 163
 164 exit_cleanly() {
 165     trap - INT
 166     create-plot-data-from-log.sh $BUILD_NUMBER "$WORKSPACE/apps/workbench/log/test.log" "$WORKSPACE/apps/workbench/log/"
 167     rotate_logfile "$WORKSPACE/apps/workbench/log/" "test.log"
 168     stop_services
 169     rotate_logfile "$WORKSPACE/services/api/log/" "test.log"
 170     report_outcomes
 171     clear_temp
 172     exit ${#failures}
 173 }
 174
 175 sanity_checks() {
 176     ( [[ -n "$WORKSPACE" ]] && [[ -d "$WORKSPACE/services" ]] ) \
 177         || fatal "WORKSPACE environment variable not set to a source directory (see: $0 --help)"
 178     echo Checking dependencies:
 179     echo -n 'virtualenv: '
 180     virtualenv --version \
 181         || fatal "No virtualenv. Try: apt-get install virtualenv (on ubuntu: python-virtualenv)"
 182     echo -n 'ruby: '
 183     ruby -v \
 184         || fatal "No ruby. Install >=2.1.9 (using rbenv, rvm, or source)"
 185     echo -n 'go: '
 186     go version \
 187         || fatal "No go binary. See http://golang.org/doc/install"
 188     [[ $(go version) =~ go1.([0-9]+) ]] && [[ ${BASH_REMATCH[1]} -ge 10 ]] \
 189         || fatal "Go >= 1.10 required. See http://golang.org/doc/install"
 190     echo -n 'gcc: '
 191     gcc --version | egrep ^gcc \
 192         || fatal "No gcc. Try: apt-get install build-essential"
 193     echo -n 'fuse.h: '
 194     find /usr/include -path '*fuse/fuse.h' | egrep --max-count=1 . \
 195         || fatal "No fuse/fuse.h. Try: apt-get install libfuse-dev"
 196     echo -n 'gnutls.h: '
 197     find /usr/include -path '*gnutls/gnutls.h' | egrep --max-count=1 . \
 198         || fatal "No gnutls/gnutls.h. Try: apt-get install libgnutls28-dev"
 199     echo -n 'Python2 pyconfig.h: '
 200     find /usr/include -path '*/python2*/pyconfig.h' | egrep --max-count=1 . \
 201         || fatal "No Python2 pyconfig.h. Try: apt-get install python2.7-dev"
 202     echo -n 'Python3 pyconfig.h: '
 203     find /usr/include -path '*/python3*/pyconfig.h' | egrep --max-count=1 . \
 204         || fatal "No Python3 pyconfig.h. Try: apt-get install python3-dev"
 205     echo -n 'nginx: '
 206     PATH="$PATH:/sbin:/usr/sbin:/usr/local/sbin" nginx -v \
 207         || fatal "No nginx. Try: apt-get install nginx"
 208     echo -n 'perl: '
 209     perl -v | grep version \
 210         || fatal "No perl. Try: apt-get install perl"
 211     for mod in ExtUtils::MakeMaker JSON LWP Net::SSL; do
 212         echo -n "perl $mod: "
 213         perl -e "use $mod; print \"\$$mod::VERSION\\n\"" \
 214             || fatal "No $mod. Try: apt-get install perl-modules libcrypt-ssleay-perl libjson-perl libwww-perl"
 215     done
 216     echo -n 'gitolite: '
 217     which gitolite \
 218         || fatal "No gitolite. Try: apt-get install gitolite3"
 219     echo -n 'npm: '
 220     npm --version \
 221         || fatal "No npm. Try: wget -O- https://nodejs.org/dist/v6.11.2/node-v6.11.2-linux-x64.tar.xz | sudo tar -C /usr/local -xJf - && sudo ln -s ../node-v6.11.2-linux-x64/bin/{node,npm} /usr/local/bin/"
 222     echo -n 'cadaver: '
 223     cadaver --version | grep -w cadaver \
 224           || fatal "No cadaver. Try: apt-get install cadaver"
 225     echo -n 'libattr1 xattr.h: '
 226     find /usr/include -path '*/attr/xattr.h' | egrep --max-count=1 . \
 227         || fatal "No libattr1 xattr.h. Try: apt-get install libattr1-dev"
 228     echo -n 'libcurl curl.h: '
 229     find /usr/include -path '*/curl/curl.h' | egrep --max-count=1 . \
 230         || fatal "No libcurl curl.h. Try: apt-get install libcurl4-gnutls-dev"
 231     echo -n 'libpq libpq-fe.h: '
 232     find /usr/include -path '*/postgresql/libpq-fe.h' | egrep --max-count=1 . \
 233         || fatal "No libpq libpq-fe.h. Try: apt-get install libpq-dev"
 234     echo -n 'services/api/config/database.yml: '
 235     if [[ ! -f "$WORKSPACE/services/api/config/database.yml" ]]; then
 236             fatal "Please provide a database.yml file for the test suite"
 237     else
 238             echo "OK"
 239     fi
 240     echo -n 'postgresql: '
 241     psql --version || fatal "No postgresql. Try: apt-get install postgresql postgresql-client-common"
 242     echo -n 'phantomjs: '
 243     phantomjs --version || fatal "No phantomjs. Try: apt-get install phantomjs"
 244     echo -n 'xvfb: '
 245     which Xvfb || fatal "No xvfb. Try: apt-get install xvfb"
 246     echo -n 'graphviz: '
 247     dot -V || fatal "No graphviz. Try: apt-get install graphviz"
 248     echo -n 'geckodriver: '
 249     geckodriver --version | grep ^geckodriver || echo "No geckodriver. Try: wget -O- https://github.com/mozilla/geckodriver/releases/download/v0.23.0/geckodriver-v0.23.0-linux64.tar.gz | sudo tar -C /usr/local/bin -xzf - geckodriver"
 250
 251     if [[ "$NEED_SDK_R" = true ]]; then
 252       # R SDK stuff
 253       echo -n 'R: '
 254       which Rscript || fatal "No Rscript. Try: apt-get install r-base"
 255       echo -n 'testthat: '
 256       Rscript -e "library('testthat')" || fatal "No testthat. Try: apt-get install r-cran-testthat"
 257       # needed for roxygen2, needed for devtools, needed for R sdk
 258       pkg-config --exists libxml-2.0 || fatal "No libxml2. Try: apt-get install libxml2-dev"
 259       # needed for pkgdown, builds R SDK doc pages
 260       which pandoc || fatal "No pandoc. Try: apt-get install pandoc"
 261     fi
 262 }
 263
 264 rotate_logfile() {
 265   # i.e.  rotate_logfile "$WORKSPACE/apps/workbench/log/" "test.log"
 266   # $BUILD_NUMBER is set by Jenkins if this script is being called as part of a Jenkins run
 267   if [[ -f "$1/$2" ]]; then
 268     THEDATE=`date +%Y%m%d%H%M%S`
 269     mv "$1/$2" "$1/$THEDATE-$BUILD_NUMBER-$2"
 270     gzip "$1/$THEDATE-$BUILD_NUMBER-$2"
 271   fi
 272 }
 273
 274 declare -a failures
 275 declare -A skip
 276 declare -A only
 277 declare -A testargs
 278 skip[apps/workbench_profile]=1
 279 # nodemanager_integration tests are not reliable, see #12061.
 280 skip[services/nodemanager_integration]=1
 281
 282 while [[ -n "$1" ]]
 283 do
 284     arg="$1"; shift
 285     case "$arg" in
 286         --help)
 287             echo >&2 "$helpmessage"
 288             echo >&2
 289             exit 1
 290             ;;
 291         --skip)
 292             skip[$1]=1; shift
 293             ;;
 294         --only)
 295             only[$1]=1; skip[$1]=""; shift
 296             ;;
 297         --short)
 298             short=1
 299             ;;
 300         --skip-install)
 301             only_install=nothing
 302             ;;
 303         --only-install)
 304             only_install="$1"; shift
 305             ;;
 306         --temp)
 307             temp="$1"; shift
 308             temp_preserve=1
 309             ;;
 310         --leave-temp)
 311             temp_preserve=1
 312             ;;
 313         --repeat)
 314             repeat=$((${1}+0)); shift
 315             ;;
 316         --retry)
 317             retry=1
 318             ;;
 319         *_test=*)
 320             suite="${arg%%_test=*}"
 321             args="${arg#*=}"
 322             testargs["$suite"]="$args"
 323             ;;
 324         *=*)
 325             eval export $(echo $arg | cut -d= -f1)=\"$(echo $arg | cut -d= -f2-)\"
 326             ;;
 327         *)
 328             echo >&2 "$0: Unrecognized option: '$arg'. Try: $0 --help"
 329             exit 1
 330             ;;
 331     esac
 332 done
 333
 334 # R SDK installation is very slow (~360s in a clean environment) and only
 335 # required when testing it. Skip that step if it is not needed.
 336 NEED_SDK_R=true
 337
 338 if [[ ${#only[@]} -ne 0 ]] &&
 339    [[ -z "${only['sdk/R']}" && -z "${only['doc']}" ]]; then
 340   NEED_SDK_R=false
 341 fi
 342
 343 if [[ ${skip["sdk/R"]} == 1 && ${skip["doc"]} == 1 ]]; then
 344   NEED_SDK_R=false
 345 fi
 346
 347 if [[ $NEED_SDK_R == false ]]; then
 348         echo "R SDK not needed, it will not be installed."
 349 fi
 350
 351 start_services() {
 352     echo 'Starting API, keepproxy, keep-web, ws, arv-git-httpd, and nginx ssl proxy...'
 353     if [[ ! -d "$WORKSPACE/services/api/log" ]]; then
 354         mkdir -p "$WORKSPACE/services/api/log"
 355     fi
 356     # Remove empty api.pid file if it exists
 357     if [[ -f "$WORKSPACE/tmp/api.pid" && ! -s "$WORKSPACE/tmp/api.pid" ]]; then
 358         rm -f "$WORKSPACE/tmp/api.pid"
 359     fi
 360     cd "$WORKSPACE" \
 361         && eval $(python sdk/python/tests/run_test_server.py start --auth admin || echo fail=1) \
 362         && export ARVADOS_TEST_API_HOST="$ARVADOS_API_HOST" \
 363         && export ARVADOS_TEST_API_INSTALLED="$$" \
 364         && python sdk/python/tests/run_test_server.py start_controller \
 365         && python sdk/python/tests/run_test_server.py start_keep_proxy \
 366         && python sdk/python/tests/run_test_server.py start_keep-web \
 367         && python sdk/python/tests/run_test_server.py start_arv-git-httpd \
 368         && python sdk/python/tests/run_test_server.py start_ws \
 369         && eval $(python sdk/python/tests/run_test_server.py start_nginx || echo fail=1) \
 370         && (env | egrep ^ARVADOS)
 371     if [[ -n "$fail" ]]; then
 372        return 1
 373     fi
 374 }
 375
 376 stop_services() {
 377     if [[ -z "$ARVADOS_TEST_API_HOST" ]]; then
 378         return
 379     fi
 380     unset ARVADOS_TEST_API_HOST
 381     cd "$WORKSPACE" \
 382         && python sdk/python/tests/run_test_server.py stop_nginx \
 383         && python sdk/python/tests/run_test_server.py stop_arv-git-httpd \
 384         && python sdk/python/tests/run_test_server.py stop_ws \
 385         && python sdk/python/tests/run_test_server.py stop_keep-web \
 386         && python sdk/python/tests/run_test_server.py stop_keep_proxy \
 387         && python sdk/python/tests/run_test_server.py stop_controller \
 388         && python sdk/python/tests/run_test_server.py stop
 389 }
 390
 391 interrupt() {
 392     failures+=("($(basename $0) interrupted)")
 393     exit_cleanly
 394 }
 395 trap interrupt INT
 396
 397 sanity_checks
 398
 399 echo "WORKSPACE=$WORKSPACE"
 400
 401 if [[ -z "$CONFIGSRC" ]] && [[ -d "$HOME/arvados-api-server" ]]; then
 402     # Jenkins expects us to use this by default.
 403     CONFIGSRC="$HOME/arvados-api-server"
 404 fi
 405
 406 # Clean up .pyc files that may exist in the workspace
 407 cd "$WORKSPACE"
 408 find -name '*.pyc' -delete
 409
 410 if [[ -z "$temp" ]]; then
 411     temp="$(mktemp -d)"
 412 fi
 413
 414 # Set up temporary install dirs (unless existing dirs were supplied)
 415 for tmpdir in VENVDIR VENV3DIR GOPATH GEMHOME PERLINSTALLBASE R_LIBS
 416 do
 417     if [[ -z "${!tmpdir}" ]]; then
 418         eval "$tmpdir"="$temp/$tmpdir"
 419     fi
 420     if ! [[ -d "${!tmpdir}" ]]; then
 421         mkdir "${!tmpdir}" || fatal "can't create ${!tmpdir} (does $temp exist?)"
 422     fi
 423 done
 424
 425 rm -vf "${WORKSPACE}/tmp/*.log"
 426
 427 setup_ruby_environment() {
 428     if [[ -s "$HOME/.rvm/scripts/rvm" ]] ; then
 429         source "$HOME/.rvm/scripts/rvm"
 430         using_rvm=true
 431     elif [[ -s "/usr/local/rvm/scripts/rvm" ]] ; then
 432         source "/usr/local/rvm/scripts/rvm"
 433         using_rvm=true
 434     else
 435         using_rvm=false
 436     fi
 437
 438     if [[ "$using_rvm" == true ]]; then
 439         # If rvm is in use, we can't just put separate "dependencies"
 440         # and "gems-under-test" paths to GEM_PATH: passenger resets
 441         # the environment to the "current gemset", which would lose
 442         # our GEM_PATH and prevent our test suites from running ruby
 443         # programs (for example, the Workbench test suite could not
 444         # boot an API server or run arv). Instead, we have to make an
 445         # rvm gemset and use it for everything.
 446
 447         [[ `type rvm | head -n1` == "rvm is a function" ]] \
 448             || fatal 'rvm check'
 449
 450         # Put rvm's favorite path back in first place (overriding
 451         # virtualenv, which just put itself there). Ignore rvm's
 452         # complaint about not being in first place already.
 453         rvm use @default 2>/dev/null
 454
 455         # Create (if needed) and switch to an @arvados-tests-* gemset,
 456         # salting the gemset name so it doesn't interfere with
 457         # concurrent builds in other workspaces. Leave the choice of
 458         # ruby to the caller.
 459         gemset="arvados-tests-$(echo -n "${WORKSPACE}" | md5sum | head -c16)"
 460         rvm use "@${gemset}" --create \
 461             || fatal 'rvm gemset setup'
 462
 463         rvm env
 464     else
 465         # When our "bundle install"s need to install new gems to
 466         # satisfy dependencies, we want them to go where "gem install
 467         # --user-install" would put them. (However, if the caller has
 468         # already set GEM_HOME, we assume that's where dependencies
 469         # should be installed, and we should leave it alone.)
 470
 471         if [ -z "$GEM_HOME" ]; then
 472             user_gempath="$(gem env gempath)"
 473             export GEM_HOME="${user_gempath%%:*}"
 474         fi
 475         PATH="$(gem env gemdir)/bin:$PATH"
 476
 477         # When we build and install our own gems, we install them in our
 478         # $GEMHOME tmpdir, and we want them to be at the front of GEM_PATH and
 479         # PATH so integration tests prefer them over other versions that
 480         # happen to be installed in $user_gempath, system dirs, etc.
 481
 482         tmpdir_gem_home="$(env - PATH="$PATH" HOME="$GEMHOME" gem env gempath | cut -f1 -d:)"
 483         PATH="$tmpdir_gem_home/bin:$PATH"
 484         export GEM_PATH="$tmpdir_gem_home"
 485
 486         echo "Will install dependencies to $(gem env gemdir)"
 487         echo "Will install arvados gems to $tmpdir_gem_home"
 488         echo "Gem search path is GEM_PATH=$GEM_PATH"
 489     fi
 490     bundle config || gem install bundler \
 491         || fatal 'install bundler'
 492 }
 493
 494 with_test_gemset() {
 495     if [[ "$using_rvm" == true ]]; then
 496         "$@"
 497     else
 498         GEM_HOME="$tmpdir_gem_home" GEM_PATH="$tmpdir_gem_home" "$@"
 499     fi
 500 }
 501
 502 gem_uninstall_if_exists() {
 503     if gem list "$1\$" | egrep '^\w'; then
 504         gem uninstall --force --all --executables "$1"
 505     fi
 506 }
 507
 508 setup_virtualenv() {
 509     local venvdest="$1"; shift
 510     if ! [[ -e "$venvdest/bin/activate" ]] || ! [[ -e "$venvdest/bin/pip" ]]; then
 511         virtualenv --setuptools "$@" "$venvdest" || fatal "virtualenv $venvdest failed"
 512     elif [[ -n "$short" ]]; then
 513         return
 514     fi
 515     if [[ $("$venvdest/bin/python" --version 2>&1) =~ \ 3\.[012]\. ]]; then
 516         # pip 8.0.0 dropped support for python 3.2, e.g., debian wheezy
 517         "$venvdest/bin/pip" install --no-cache-dir 'setuptools>=18.5' 'pip>=7,<8'
 518     else
 519         "$venvdest/bin/pip" install --no-cache-dir 'setuptools>=18.5' 'pip>=7'
 520     fi
 521     # ubuntu1404 can't seem to install mock via tests_require, but it can do this.
 522     "$venvdest/bin/pip" install --no-cache-dir 'mock>=1.0' 'pbr<1.7.0'
 523 }
 524
 525 export PERLINSTALLBASE
 526 export PERLLIB="$PERLINSTALLBASE/lib/perl5:${PERLLIB:+$PERLLIB}"
 527
 528 export R_LIBS
 529
 530 export GOPATH
 531 (
 532     set -e
 533     mkdir -p "$GOPATH/src/git.curoverse.com"
 534     rmdir -v --parents --ignore-fail-on-non-empty "${temp}/GOPATH"
 535     if [[ ! -h "$GOPATH/src/git.curoverse.com/arvados.git" ]]; then
 536         for d in \
 537             "$GOPATH/src/git.curoverse.com/arvados.git/tmp/GOPATH" \
 538                 "$GOPATH/src/git.curoverse.com/arvados.git/tmp" \
 539                 "$GOPATH/src/git.curoverse.com/arvados.git"; do
 540             [[ -d "$d" ]] && rmdir "$d"
 541         done
 542     fi
 543     for d in \
 544         "$GOPATH/src/git.curoverse.com/arvados.git/arvados" \
 545         "$GOPATH/src/git.curoverse.com/arvados.git"; do
 546         [[ -h "$d" ]] && rm "$d"
 547     done
 548     ln -vsfT "$WORKSPACE" "$GOPATH/src/git.curoverse.com/arvados.git"
 549     go get -v github.com/kardianos/govendor
 550     cd "$GOPATH/src/git.curoverse.com/arvados.git"
 551     if [[ -n "$short" ]]; then
 552         go get -v -d ...
 553         "$GOPATH/bin/govendor" sync
 554     else
 555         # Remove cached source dirs in workdir. Otherwise, they will
 556         # not qualify as +missing or +external below, and we won't be
 557         # able to detect that they're missing from vendor/vendor.json.
 558         rm -rf vendor/*/
 559         go get -v -d ...
 560         "$GOPATH/bin/govendor" sync
 561         [[ -z $("$GOPATH/bin/govendor" list +unused +missing +external | tee /dev/stderr) ]] \
 562             || fatal "vendor/vendor.json has unused or missing dependencies -- try:
 563
 564 (export GOPATH=\"${GOPATH}\"; cd \$GOPATH/src/git.curoverse.com/arvados.git && \$GOPATH/bin/govendor add +missing +external && \$GOPATH/bin/govendor remove +unused)
 565
 566 ";
 567     fi
 568 ) || fatal "Go setup failed"
 569
 570 setup_virtualenv "$VENVDIR" --python python2.7
 571 . "$VENVDIR/bin/activate"
 572
 573 # Needed for run_test_server.py which is used by certain (non-Python) tests.
 574 pip install --no-cache-dir PyYAML \
 575     || fatal "pip install PyYAML failed"
 576
 577 # Preinstall libcloud if using a fork; otherwise nodemanager "pip
 578 # install" won't pick it up by default.
 579 if [[ -n "$LIBCLOUD_PIN_SRC" ]]; then
 580     pip freeze 2>/dev/null | egrep ^apache-libcloud==$LIBCLOUD_PIN \
 581         || pip install --pre --ignore-installed --no-cache-dir "$LIBCLOUD_PIN_SRC" >/dev/null \
 582         || fatal "pip install apache-libcloud failed"
 583 fi
 584
 585 # Deactivate Python 2 virtualenv
 586 deactivate
 587
 588 declare -a pythonstuff
 589 pythonstuff=(
 590     sdk/pam
 591     sdk/python
 592     sdk/python:py3
 593     sdk/cwl
 594     services/dockercleaner:py3
 595     services/fuse
 596     services/nodemanager
 597     tools/crunchstat-summary
 598     )
 599
 600 # If Python 3 is available, set up its virtualenv in $VENV3DIR.
 601 # Otherwise, skip dependent tests.
 602 PYTHON3=$(which python3)
 603 if [[ ${?} = 0 ]]; then
 604     setup_virtualenv "$VENV3DIR" --python python3
 605 else
 606     PYTHON3=
 607     cat >&2 <<EOF
 608
 609 Warning: python3 could not be found. Python 3 tests will be skipped.
 610
 611 EOF
 612 fi
 613
 614 # Reactivate Python 2 virtualenv
 615 . "$VENVDIR/bin/activate"
 616
 617 # Note: this must be the last time we change PATH, otherwise rvm will
 618 # whine a lot.
 619 setup_ruby_environment
 620
 621 echo "PATH is $PATH"
 622
 623 if ! which bundler >/dev/null
 624 then
 625     gem install --user-install bundler || fatal 'Could not install bundler'
 626 fi
 627
 628 # Jenkins config requires that glob tmp/*.log match something. Ensure
 629 # that happens even if we don't end up running services that set up
 630 # logging.
 631 mkdir -p "${WORKSPACE}/tmp/" || fatal "could not mkdir ${WORKSPACE}/tmp"
 632 touch "${WORKSPACE}/tmp/controller.log" || fatal "could not touch ${WORKSPACE}/tmp/controller.log"
 633
 634 retry() {
 635     remain="${repeat}"
 636     while :
 637     do
 638         if ${@}; then
 639             if [[ "$remain" -gt 1 ]]; then
 640                 remain=$((${remain}-1))
 641                 title "Repeating ${remain} more times"
 642             else
 643                 break
 644             fi
 645         elif [[ "$retry" == 1 ]]; then
 646             read -p 'Try again? [Y/n] ' x
 647             if [[ "$x" != "y" ]] && [[ "$x" != "" ]]
 648             then
 649                 break
 650             fi
 651         else
 652             break
 653         fi
 654     done
 655 }
 656
 657 do_test() {
 658     case "${1}" in
 659         apps/workbench_units | apps/workbench_functionals | apps/workbench_integration)
 660             suite=apps/workbench
 661             ;;
 662         services/nodemanager | services/nodemanager_integration)
 663             suite=services/nodemanager_suite
 664             ;;
 665         *)
 666             suite="${1}"
 667             ;;
 668     esac
 669     if [[ -z "${skip[$suite]}" && -z "${skip[$1]}" && \
 670               (${#only[@]} -eq 0 || ${only[$suite]} -eq 1 || \
 671                    ${only[$1]} -eq 1) ||
 672                   ${only[$2]} -eq 1 ]]; then
 673         retry do_test_once ${@}
 674     else
 675         title "Skipping ${1} tests"
 676     fi
 677 }
 678
 679 do_test_once() {
 680     unset result
 681
 682     title "Running $1 tests"
 683     timer_reset
 684     if [[ "$2" == "go" ]]
 685     then
 686         covername="coverage-$(echo "$1" | sed -e 's/\//_/g')"
 687         coverflags=("-covermode=count" "-coverprofile=$WORKSPACE/tmp/.$covername.tmp")
 688         # We do "go get -t" here to catch compilation errors
 689         # before trying "go test". Otherwise, coverage-reporting
 690         # mode makes Go show the wrong line numbers when reporting
 691         # compilation errors.
 692         go get -ldflags "-X main.version=${ARVADOS_VERSION:-$(git log -n1 --format=%H)-dev}" -t "git.curoverse.com/arvados.git/$1" && \
 693             cd "$GOPATH/src/git.curoverse.com/arvados.git/$1" && \
 694             [[ -z "$(gofmt -e -d . | tee /dev/stderr)" ]] && \
 695             if [[ -n "${testargs[$1]}" ]]
 696         then
 697             # "go test -check.vv giturl" doesn't work, but this
 698             # does:
 699             go test ${short:+-short} ${testargs[$1]}
 700         else
 701             # The above form gets verbose even when testargs is
 702             # empty, so use this form in such cases:
 703             go test ${short:+-short} ${coverflags[@]} "git.curoverse.com/arvados.git/$1"
 704         fi
 705         result=${result:-$?}
 706         if [[ -f "$WORKSPACE/tmp/.$covername.tmp" ]]
 707         then
 708             go tool cover -html="$WORKSPACE/tmp/.$covername.tmp" -o "$WORKSPACE/tmp/$covername.html"
 709             rm "$WORKSPACE/tmp/.$covername.tmp"
 710         fi
 711     elif [[ "$2" == "pip" ]]
 712     then
 713         tries=0
 714         cd "$WORKSPACE/$1" && while :
 715         do
 716             tries=$((${tries}+1))
 717             # $3 can name a path directory for us to use, including trailing
 718             # slash; e.g., the bin/ subdirectory of a virtualenv.
 719             "${3}python" setup.py ${short:+--short-tests-only} test ${testargs[$1]}
 720             result=$?
 721             if [[ ${tries} < 3 && ${result} == 137 ]]
 722             then
 723                 printf '\n*****\n%s tests killed -- retrying\n*****\n\n' "$1"
 724                 continue
 725             else
 726                 break
 727             fi
 728         done
 729     elif [[ "$2" != "" ]]
 730     then
 731         "test_$2"
 732     else
 733         "test_$1"
 734     fi
 735     result=${result:-$?}
 736     checkexit $result "$1 tests"
 737     title "End of $1 tests (`timer`)"
 738     return $result
 739 }
 740
 741 do_install() {
 742   skipit=false
 743
 744   if [[ -z "${only_install}" || "${only_install}" == "${1}" || "${only_install}" == "${2}" ]]; then
 745       retry do_install_once ${@}
 746   else
 747       skipit=true
 748   fi
 749
 750   if [[ "$skipit" = true ]]; then
 751     title "Skipping $1 install"
 752   fi
 753 }
 754
 755 do_install_once() {
 756     title "Running $1 install"
 757     timer_reset
 758     if [[ "$2" == "go" ]]
 759     then
 760         go get -ldflags "-X main.version=${ARVADOS_VERSION:-$(git log -n1 --format=%H)-dev}" -t "git.curoverse.com/arvados.git/$1"
 761     elif [[ "$2" == "pip" ]]
 762     then
 763         # $3 can name a path directory for us to use, including trailing
 764         # slash; e.g., the bin/ subdirectory of a virtualenv.
 765
 766         # Need to change to a different directory after creating
 767         # the source dist package to avoid a pip bug.
 768         # see https://arvados.org/issues/5766 for details.
 769
 770         # Also need to install twice, because if it believes the package is
 771         # already installed, pip it won't install it.  So the first "pip
 772         # install" ensures that the dependencies are met, the second "pip
 773         # install" ensures that we've actually installed the local package
 774         # we just built.
 775         cd "$WORKSPACE/$1" \
 776             && "${3}python" setup.py sdist rotate --keep=1 --match .tar.gz \
 777             && cd "$WORKSPACE" \
 778             && "${3}pip" install --no-cache-dir --quiet "$WORKSPACE/$1/dist"/*.tar.gz \
 779             && "${3}pip" install --no-cache-dir --quiet --no-deps --ignore-installed "$WORKSPACE/$1/dist"/*.tar.gz
 780     elif [[ "$2" != "" ]]
 781     then
 782         "install_$2"
 783     else
 784         "install_$1"
 785     fi
 786     result=$?
 787     checkexit $result "$1 install"
 788     title "End of $1 install (`timer`)"
 789     return $result
 790 }
 791
 792 bundle_install_trylocal() {
 793     (
 794         set -e
 795         echo "(Running bundle install --local. 'could not find package' messages are OK.)"
 796         if ! bundle install --local --no-deployment; then
 797             echo "(Running bundle install again, without --local.)"
 798             bundle install --no-deployment
 799         fi
 800         bundle package --all
 801     )
 802 }
 803
 804 install_doc() {
 805     cd "$WORKSPACE/doc" \
 806         && bundle_install_trylocal \
 807         && rm -rf .site
 808 }
 809 do_install doc
 810
 811 install_gem() {
 812     gemname=$1
 813     srcpath=$2
 814     with_test_gemset gem_uninstall_if_exists "$gemname" \
 815         && cd "$WORKSPACE/$srcpath" \
 816         && bundle_install_trylocal \
 817         && gem build "$gemname.gemspec" \
 818         && with_test_gemset gem install --no-ri --no-rdoc $(ls -t "$gemname"-*.gem|head -n1)
 819 }
 820
 821 install_ruby_sdk() {
 822     install_gem arvados sdk/ruby
 823 }
 824 do_install sdk/ruby ruby_sdk
 825
 826 install_R_sdk() {
 827   if [[ "$NEED_SDK_R" = true ]]; then
 828     cd "$WORKSPACE/sdk/R" \
 829        && Rscript --vanilla install_deps.R
 830   fi
 831 }
 832 do_install sdk/R R_sdk
 833
 834 install_perl_sdk() {
 835     cd "$WORKSPACE/sdk/perl" \
 836         && perl Makefile.PL INSTALL_BASE="$PERLINSTALLBASE" \
 837         && make install INSTALLDIRS=perl
 838 }
 839 do_install sdk/perl perl_sdk
 840
 841 install_cli() {
 842     install_gem arvados-cli sdk/cli
 843 }
 844 do_install sdk/cli cli
 845
 846 install_login-sync() {
 847     install_gem arvados-login-sync services/login-sync
 848 }
 849 do_install services/login-sync login-sync
 850
 851 # Install the Python SDK early. Various other test suites (like
 852 # keepproxy) bring up run_test_server.py, which imports the arvados
 853 # module. We can't actually *test* the Python SDK yet though, because
 854 # its own test suite brings up some of those other programs (like
 855 # keepproxy).
 856 for p in "${pythonstuff[@]}"
 857 do
 858     dir=${p%:py3}
 859     if [[ ${dir} = ${p} ]]; then
 860         if [[ -z ${skip[python2]} ]]; then
 861             do_install ${dir} pip
 862         fi
 863     elif [[ -n ${PYTHON3} ]]; then
 864         if [[ -z ${skip[python3]} ]]; then
 865             do_install ${dir} pip "$VENV3DIR/bin/"
 866         fi
 867     fi
 868 done
 869
 870 install_apiserver() {
 871     cd "$WORKSPACE/services/api" \
 872         && RAILS_ENV=test bundle_install_trylocal
 873
 874     rm -f config/environments/test.rb
 875     cp config/environments/test.rb.example config/environments/test.rb
 876
 877     if [ -n "$CONFIGSRC" ]
 878     then
 879         for f in database.yml
 880         do
 881             cp "$CONFIGSRC/$f" config/ || fatal "$f"
 882         done
 883     fi
 884
 885     # Clear out any lingering postgresql connections to the test
 886     # database, so that we can drop it. This assumes the current user
 887     # is a postgresql superuser.
 888     cd "$WORKSPACE/services/api" \
 889         && test_database=$(python -c "import yaml; print yaml.load(file('config/database.yml'))['test']['database']") \
 890         && psql "$test_database" -c "SELECT pg_terminate_backend (pg_stat_activity.pid::int) FROM pg_stat_activity WHERE pg_stat_activity.datname = '$test_database';" 2>/dev/null
 891
 892     mkdir -p "$WORKSPACE/services/api/tmp/pids"
 893
 894     cert="$WORKSPACE/services/api/tmp/self-signed"
 895     if [[ ! -e "$cert.pem" || "$(date -r "$cert.pem" +%s)" -lt 1512659226 ]]; then
 896         (
 897             dir="$WORKSPACE/services/api/tmp"
 898             set -ex
 899             openssl req -newkey rsa:2048 -nodes -subj '/C=US/ST=State/L=City/CN=localhost' -out "$cert.csr" -keyout "$cert.key" </dev/null
 900             openssl x509 -req -in "$cert.csr" -signkey "$cert.key" -out "$cert.pem" -days 3650 -extfile <(printf 'subjectAltName=DNS:localhost,DNS:::1,DNS:0.0.0.0,DNS:127.0.0.1,IP:::1,IP:0.0.0.0,IP:127.0.0.1')
 901         ) || return 1
 902     fi
 903
 904     cd "$WORKSPACE/services/api" \
 905         && rm -rf tmp/git \
 906         && mkdir -p tmp/git \
 907         && cd tmp/git \
 908         && tar xf ../../test/test.git.tar \
 909         && mkdir -p internal.git \
 910         && git --git-dir internal.git init \
 911             || return 1
 912
 913     cd "$WORKSPACE/services/api" \
 914         && RAILS_ENV=test bundle exec rake db:drop \
 915         && RAILS_ENV=test bundle exec rake db:setup \
 916         && RAILS_ENV=test bundle exec rake db:fixtures:load
 917 }
 918 do_install services/api apiserver
 919
 920 declare -a gostuff
 921 gostuff=(
 922     cmd/arvados-client
 923     cmd/arvados-server
 924     lib/cli
 925     lib/cmd
 926     lib/controller
 927     lib/crunchstat
 928     lib/dispatchcloud
 929     sdk/go/arvados
 930     sdk/go/arvadosclient
 931     sdk/go/auth
 932     sdk/go/blockdigest
 933     sdk/go/dispatch
 934     sdk/go/health
 935     sdk/go/httpserver
 936     sdk/go/manifest
 937     sdk/go/asyncbuf
 938     sdk/go/crunchrunner
 939     sdk/go/stats
 940     services/arv-git-httpd
 941     services/crunchstat
 942     services/health
 943     services/keep-web
 944     services/keepstore
 945     sdk/go/keepclient
 946     services/keep-balance
 947     services/keepproxy
 948     services/crunch-dispatch-local
 949     services/crunch-dispatch-slurm
 950     services/crunch-run
 951     services/ws
 952     tools/keep-block-check
 953     tools/keep-exercise
 954     tools/keep-rsync
 955     tools/sync-groups
 956 )
 957 for g in "${gostuff[@]}"
 958 do
 959     do_install "$g" go
 960 done
 961
 962 install_workbench() {
 963     cd "$WORKSPACE/apps/workbench" \
 964         && mkdir -p tmp/cache \
 965         && RAILS_ENV=test bundle_install_trylocal \
 966         && RAILS_ENV=test RAILS_GROUPS=assets bundle exec rake npm:install
 967 }
 968 do_install apps/workbench workbench
 969
 970 unset http_proxy https_proxy no_proxy
 971
 972 test_doclinkchecker() {
 973     (
 974         set -e
 975         cd "$WORKSPACE/doc"
 976         ARVADOS_API_HOST=qr1hi.arvadosapi.com
 977         # Make sure python-epydoc is installed or the next line won't
 978         # do much good!
 979         PYTHONPATH=$WORKSPACE/sdk/python/ bundle exec rake linkchecker baseurl=file://$WORKSPACE/doc/.site/ arvados_workbench_host=https://workbench.$ARVADOS_API_HOST arvados_api_host=$ARVADOS_API_HOST
 980     )
 981 }
 982 do_test doc doclinkchecker
 983
 984 stop_services
 985
 986 test_apiserver() {
 987     rm -f "$WORKSPACE/services/api/git-commit.version"
 988     cd "$WORKSPACE/services/api" \
 989         && env RAILS_ENV=test ${short:+RAILS_TEST_SHORT=1} bundle exec rake test TESTOPTS=-v ${testargs[services/api]}
 990 }
 991 do_test services/api apiserver
 992
 993 # Shortcut for when we're only running apiserver tests. This saves a bit of time,
 994 # because we don't need to start up the api server for subsequent tests.
 995 if [ ! -z "$only" ] && [ "$only" == "services/api" ]; then
 996   rotate_logfile "$WORKSPACE/services/api/log/" "test.log"
 997   exit_cleanly
 998 fi
 999
1000 start_services || { stop_services; fatal "start_services"; }
1001
1002 test_ruby_sdk() {
1003     cd "$WORKSPACE/sdk/ruby" \
1004         && bundle exec rake test TESTOPTS=-v ${testargs[sdk/ruby]}
1005 }
1006 do_test sdk/ruby ruby_sdk
1007
1008 test_R_sdk() {
1009   if [[ "$NEED_SDK_R" = true ]]; then
1010     cd "$WORKSPACE/sdk/R" \
1011         && Rscript --vanilla run_test.R
1012   fi
1013 }
1014
1015 do_test sdk/R R_sdk
1016
1017 test_cli() {
1018     cd "$WORKSPACE/sdk/cli" \
1019         && mkdir -p /tmp/keep \
1020         && KEEP_LOCAL_STORE=/tmp/keep bundle exec rake test TESTOPTS=-v ${testargs[sdk/cli]}
1021 }
1022 do_test sdk/cli cli
1023
1024 test_login-sync() {
1025     cd "$WORKSPACE/services/login-sync" \
1026         && bundle exec rake test TESTOPTS=-v ${testargs[services/login-sync]}
1027 }
1028 do_test services/login-sync login-sync
1029
1030 test_nodemanager_integration() {
1031     cd "$WORKSPACE/services/nodemanager" \
1032         && tests/integration_test.py ${testargs[services/nodemanager_integration]}
1033 }
1034 do_test services/nodemanager_integration nodemanager_integration
1035
1036 for p in "${pythonstuff[@]}"
1037 do
1038     dir=${p%:py3}
1039     if [[ ${dir} = ${p} ]]; then
1040         if [[ -z ${skip[python2]} ]]; then
1041             do_test ${dir} pip
1042         fi
1043     elif [[ -n ${PYTHON3} ]]; then
1044         if [[ -z ${skip[python3]} ]]; then
1045             do_test ${dir} pip "$VENV3DIR/bin/"
1046         fi
1047     fi
1048 done
1049
1050 for g in "${gostuff[@]}"
1051 do
1052     do_test "$g" go
1053 done
1054
1055 test_workbench_units() {
1056     cd "$WORKSPACE/apps/workbench" \
1057         && env RAILS_ENV=test ${short:+RAILS_TEST_SHORT=1} bundle exec rake test:units TESTOPTS=-v ${testargs[apps/workbench]}
1058 }
1059 do_test apps/workbench_units workbench_units
1060
1061 test_workbench_functionals() {
1062     cd "$WORKSPACE/apps/workbench" \
1063         && env RAILS_ENV=test ${short:+RAILS_TEST_SHORT=1} bundle exec rake test:functionals TESTOPTS=-v ${testargs[apps/workbench]}
1064 }
1065 do_test apps/workbench_functionals workbench_functionals
1066
1067 test_workbench_integration() {
1068     cd "$WORKSPACE/apps/workbench" \
1069         && env RAILS_ENV=test ${short:+RAILS_TEST_SHORT=1} bundle exec rake test:integration TESTOPTS=-v ${testargs[apps/workbench]}
1070 }
1071 do_test apps/workbench_integration workbench_integration
1072
1073
1074 test_workbench_benchmark() {
1075     cd "$WORKSPACE/apps/workbench" \
1076         && env RAILS_ENV=test ${short:+RAILS_TEST_SHORT=1} bundle exec rake test:benchmark ${testargs[apps/workbench_benchmark]}
1077 }
1078 do_test apps/workbench_benchmark workbench_benchmark
1079
1080 test_workbench_profile() {
1081     cd "$WORKSPACE/apps/workbench" \
1082         && env RAILS_ENV=test ${short:+RAILS_TEST_SHORT=1} bundle exec rake test:profile ${testargs[apps/workbench_profile]}
1083 }
1084 do_test apps/workbench_profile workbench_profile
1085
1086 exit_cleanly