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