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