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