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