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