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