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