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