3 . `dirname "$(readlink -f "$0")"`/libcloud-pin
5 read -rd "\000" helpmessage <<EOF
6 $(basename $0): Install and test Arvados components.
8 Exit non-zero if any tests fail.
11 $(basename $0) WORKSPACE=/path/to/arvados [options]
15 --skip FOO Do not test the FOO component.
16 --only FOO Do not test anything except the FOO component.
17 --temp DIR Install components and dependencies under DIR instead of
18 making a new temporary directory. Implies --leave-temp.
19 --leave-temp Do not remove GOPATH, virtualenv, and other temp dirs at exit.
20 Instead, show the path to give as --temp to reuse them in
21 subsequent invocations.
22 --skip-install Do not run any install steps. Just run tests.
23 You should provide GOPATH, GEMHOME, and VENVDIR options
24 from a previous invocation if you use this option.
25 --only-install Run specific install step
26 WORKSPACE=path Arvados source tree to test.
27 CONFIGSRC=path Dir with api server config files to copy into source tree.
28 (If none given, leave config files alone in source tree.)
29 services/api_test="TEST=test/functional/arvados/v1/collections_controller_test.rb"
30 Restrict apiserver tests to the given file
31 sdk/python_test="--test-suite test.test_keep_locator"
32 Restrict Python SDK tests to the given class
33 apps/workbench_test="TEST=test/integration/pipeline_instances_test.rb"
34 Restrict Workbench tests to the given file
35 services/arv-git-httpd_test="-check.vv"
36 Show all log messages, even when tests pass (also works
37 with services/keepstore_test etc.)
39 Print more debug messages
40 envvar=value Set \$envvar to value. Primarily useful for WORKSPACE,
41 *_test, and other examples shown above.
43 Assuming --skip-install is not given, all components are installed
44 into \$GOPATH, \$VENDIR, and \$GEMHOME before running any tests. Many
45 test suites depend on other components being installed, and installing
46 everything tends to be quicker than debugging dependencies.
48 As a special concession to the current CI server config, CONFIGSRC
49 defaults to $HOME/arvados-api-server if that directory exists.
51 More information and background:
53 https://arvados.org/projects/arvados/wiki/Running_tests
58 apps/workbench_benchmark
59 apps/workbench_profile
62 services/arv-git-httpd
64 services/dockercleaner
85 # First make sure to remove any ARVADOS_ variables from the calling
86 # environment that could interfere with the tests.
87 unset $(env | cut -d= -f1 | grep \^ARVADOS_)
89 # Reset other variables that could affect our [tests'] behavior by
106 if [[ -z "$temp" ]]; then
107 # we didn't even get as far as making a temp dir
109 elif [[ -z "$temp_preserve" ]]; then
112 echo "Leaving behind temp dirs in $temp"
118 echo >&2 "Fatal: $* (encountered in ${FUNCNAME[1]} at ${BASH_SOURCE[1]} line ${BASH_LINENO[0]})"
123 for x in "${successes[@]}"
128 if [[ ${#failures[@]} == 0 ]]
130 echo "All test suites passed."
132 echo "Failures (${#failures[@]}):"
133 for x in "${failures[@]}"
142 create-plot-data-from-log.sh $BUILD_NUMBER "$WORKSPACE/apps/workbench/log/test.log" "$WORKSPACE/apps/workbench/log/"
143 rotate_logfile "$WORKSPACE/apps/workbench/log/" "test.log"
145 rotate_logfile "$WORKSPACE/services/api/log/" "test.log"
152 ( [[ -n "$WORKSPACE" ]] && [[ -d "$WORKSPACE/services" ]] ) \
153 || fatal "WORKSPACE environment variable not set to a source directory (see: $0 --help)"
154 echo Checking dependencies:
155 echo -n 'virtualenv: '
156 virtualenv --version \
157 || fatal "No virtualenv. Try: apt-get install virtualenv (on ubuntu: python-virtualenv)"
160 || fatal "No go binary. See http://golang.org/doc/install"
162 gcc --version | egrep ^gcc \
163 || fatal "No gcc. Try: apt-get install build-essential"
165 find /usr/include -wholename '*fuse/fuse.h' \
166 || fatal "No fuse/fuse.h. Try: apt-get install libfuse-dev"
167 echo -n 'pyconfig.h: '
168 find /usr/include -name pyconfig.h | egrep --max-count=1 . \
169 || fatal "No pyconfig.h. Try: apt-get install python-dev"
171 PATH="$PATH:/sbin:/usr/sbin:/usr/local/sbin" nginx -v \
172 || fatal "No nginx. Try: apt-get install nginx"
174 perl -v | grep version \
175 || fatal "No perl. Try: apt-get install perl"
176 for mod in ExtUtils::MakeMaker JSON LWP Net::SSL; do
177 echo -n "perl $mod: "
178 perl -e "use $mod; print \"\$$mod::VERSION\\n\"" \
179 || fatal "No $mod. Try: apt-get install perl-modules libcrypt-ssleay-perl libjson-perl libwww-perl"
183 || fatal "No gitolite. Try: apt-get install gitolite3"
187 # i.e. rotate_logfile "$WORKSPACE/apps/workbench/log/" "test.log"
188 # $BUILD_NUMBER is set by Jenkins if this script is being called as part of a Jenkins run
189 if [[ -f "$1/$2" ]]; then
190 THEDATE=`date +%Y%m%d%H%M%S`
191 mv "$1/$2" "$1/$THEDATE-$BUILD_NUMBER-$2"
192 gzip "$1/$THEDATE-$BUILD_NUMBER-$2"
199 skip[apps/workbench_profile]=1
206 echo >&2 "$helpmessage"
215 only="$1"; skip[$1]=""; shift
222 only_install="$1"; shift
235 suite="${arg%%_test=*}"
237 testargs["$suite"]="$args"
240 eval export $(echo $arg | cut -d= -f1)=\"$(echo $arg | cut -d= -f2-)\"
243 echo >&2 "$0: Unrecognized option: '$arg'. Try: $0 --help"
250 echo 'Starting API server...'
252 && eval $(python sdk/python/tests/run_test_server.py start --auth admin) \
253 && export ARVADOS_TEST_API_HOST="$ARVADOS_API_HOST" \
254 && export ARVADOS_TEST_API_INSTALLED="$$" \
255 && (env | egrep ^ARVADOS)
258 start_nginx_proxy_services() {
259 echo 'Starting keepproxy, keep-web, arv-git-httpd, and nginx ssl proxy...'
261 && python sdk/python/tests/run_test_server.py start_keep_proxy \
262 && python sdk/python/tests/run_test_server.py start_keep-web \
263 && python sdk/python/tests/run_test_server.py start_arv-git-httpd \
264 && python sdk/python/tests/run_test_server.py start_nginx \
265 && export ARVADOS_TEST_PROXY_SERVICES=1
269 if [[ -n "$ARVADOS_TEST_PROXY_SERVICES" ]]; then
270 unset ARVADOS_TEST_PROXY_SERVICES
272 && python sdk/python/tests/run_test_server.py stop_nginx \
273 && python sdk/python/tests/run_test_server.py stop_arv-git-httpd \
274 && python sdk/python/tests/run_test_server.py stop_keep-web \
275 && python sdk/python/tests/run_test_server.py stop_keep_proxy
277 if [[ -n "$ARVADOS_TEST_API_HOST" ]]; then
278 unset ARVADOS_TEST_API_HOST
280 && python sdk/python/tests/run_test_server.py stop
285 failures+=("($(basename $0) interrupted)")
292 echo "WORKSPACE=$WORKSPACE"
294 if [[ -z "$CONFIGSRC" ]] && [[ -d "$HOME/arvados-api-server" ]]; then
295 # Jenkins expects us to use this by default.
296 CONFIGSRC="$HOME/arvados-api-server"
299 # Clean up .pyc files that may exist in the workspace
301 find -name '*.pyc' -delete
303 if [[ -z "$temp" ]]; then
307 # Set up temporary install dirs (unless existing dirs were supplied)
308 for tmpdir in VENVDIR VENV3DIR GOPATH GEMHOME PERLINSTALLBASE
310 if [[ -z "${!tmpdir}" ]]; then
311 eval "$tmpdir"="$temp/$tmpdir"
313 if ! [[ -d "${!tmpdir}" ]]; then
314 mkdir "${!tmpdir}" || fatal "can't create ${!tmpdir} (does $temp exist?)"
318 setup_ruby_environment() {
319 if [[ -s "$HOME/.rvm/scripts/rvm" ]] ; then
320 source "$HOME/.rvm/scripts/rvm"
322 elif [[ -s "/usr/local/rvm/scripts/rvm" ]] ; then
323 source "/usr/local/rvm/scripts/rvm"
329 if [[ "$using_rvm" == true ]]; then
330 # If rvm is in use, we can't just put separate "dependencies"
331 # and "gems-under-test" paths to GEM_PATH: passenger resets
332 # the environment to the "current gemset", which would lose
333 # our GEM_PATH and prevent our test suites from running ruby
334 # programs (for example, the Workbench test suite could not
335 # boot an API server or run arv). Instead, we have to make an
336 # rvm gemset and use it for everything.
338 [[ `type rvm | head -n1` == "rvm is a function" ]] \
341 # Put rvm's favorite path back in first place (overriding
342 # virtualenv, which just put itself there). Ignore rvm's
343 # complaint about not being in first place already.
344 rvm use @default 2>/dev/null
346 # Create (if needed) and switch to an @arvados-tests
347 # gemset. (Leave the choice of ruby to the caller.)
348 rvm use @arvados-tests --create \
349 || fatal 'rvm gemset setup'
353 # When our "bundle install"s need to install new gems to
354 # satisfy dependencies, we want them to go where "gem install
355 # --user-install" would put them. (However, if the caller has
356 # already set GEM_HOME, we assume that's where dependencies
357 # should be installed, and we should leave it alone.)
359 if [ -z "$GEM_HOME" ]; then
360 user_gempath="$(gem env gempath)"
361 export GEM_HOME="${user_gempath%%:*}"
363 PATH="$(gem env gemdir)/bin:$PATH"
365 # When we build and install our own gems, we install them in our
366 # $GEMHOME tmpdir, and we want them to be at the front of GEM_PATH and
367 # PATH so integration tests prefer them over other versions that
368 # happen to be installed in $user_gempath, system dirs, etc.
370 tmpdir_gem_home="$(env - PATH="$PATH" HOME="$GEMHOME" gem env gempath | cut -f1 -d:)"
371 PATH="$tmpdir_gem_home/bin:$PATH"
372 export GEM_PATH="$tmpdir_gem_home:$(gem env gempath)"
374 echo "Will install dependencies to $(gem env gemdir)"
375 echo "Will install arvados gems to $tmpdir_gem_home"
376 echo "Gem search path is GEM_PATH=$GEM_PATH"
381 if [[ "$using_rvm" == true ]]; then
384 GEM_HOME="$tmpdir_gem_home" GEM_PATH="$tmpdir_gem_home" "$@"
388 gem_uninstall_if_exists() {
389 if gem list "$1\$" | egrep '^\w'; then
390 gem uninstall --force --all --executables "$1"
395 local venvdest=$1; shift
396 if ! [[ -e "$venvdest/bin/activate" ]] || ! [[ -e "$venvdest/bin/pip" ]]; then
397 virtualenv --setuptools "$@" "$venvdest" || fatal "virtualenv $venvdest failed"
399 "$venvdest/bin/pip" install 'setuptools>=18' 'pip>=7'
400 # ubuntu1404 can't seem to install mock via tests_require, but it can do this.
401 "$venvdest/bin/pip" install 'mock>=1.0' 'pbr<1.7.0'
404 export PERLINSTALLBASE
405 export PERLLIB="$PERLINSTALLBASE/lib/perl5:${PERLLIB:+$PERLLIB}"
408 mkdir -p "$GOPATH/src/git.curoverse.com"
409 ln -sfn "$WORKSPACE" "$GOPATH/src/git.curoverse.com/arvados.git" \
410 || fatal "symlink failed"
412 setup_virtualenv "$VENVDIR" --python python2.7
413 . "$VENVDIR/bin/activate"
415 # Needed for run_test_server.py which is used by certain (non-Python) tests.
416 pip freeze 2>/dev/null | egrep ^PyYAML= \
417 || pip install PyYAML >/dev/null \
418 || fatal "pip install PyYAML failed"
420 # Preinstall forked version of libcloud, because nodemanager "pip install"
421 # won't pick it up by default.
422 pip freeze 2>/dev/null | egrep ^apache-libcloud==$LIBCLOUD_PIN \
423 || pip install --pre --ignore-installed https://github.com/curoverse/libcloud/archive/apache-libcloud-$LIBCLOUD_PIN.zip >/dev/null \
424 || fatal "pip install apache-libcloud failed"
426 # Deactivate Python 2 virtualenv
429 # If Python 3 is available, set up its virtualenv in $VENV3DIR.
430 # Otherwise, skip dependent tests.
431 PYTHON3=$(which python3)
432 if [ "0" = "$?" ]; then
433 setup_virtualenv "$VENV3DIR" --python python3
436 skip[services/dockercleaner]=1
439 Warning: python3 could not be found
440 services/dockercleaner install and tests will be skipped
445 # Reactivate Python 2 virtualenv
446 . "$VENVDIR/bin/activate"
448 # Note: this must be the last time we change PATH, otherwise rvm will
450 setup_ruby_environment
454 if ! which bundler >/dev/null
456 gem install --user-install bundler || fatal 'Could not install bundler'
460 if [[ "$1" != "0" ]]; then
461 title "!!!!!! $2 FAILED !!!!!!"
462 failures+=("$2 (`timer`)")
464 successes+=("$2 (`timer`)")
473 echo -n "$(($SECONDS - $t0))s"
477 while ! do_test_once ${@} && [[ "$retry" == 1 ]]
479 read -p 'Try again? [Y/n] ' x
480 if [[ "$x" != "y" ]] && [[ "$x" != "" ]]
489 if [[ -z "${skip[$1]}" ]] && ( [[ -z "$only" ]] || [[ "$only" == "$1" ]] )
491 title "Running $1 tests"
493 if [[ "$2" == "go" ]]
495 covername="coverage-$(echo "$1" | sed -e 's/\//_/g')"
496 coverflags=("-covermode=count" "-coverprofile=$WORKSPACE/tmp/.$covername.tmp")
497 # We do "go get -t" here to catch compilation errors
498 # before trying "go test". Otherwise, coverage-reporting
499 # mode makes Go show the wrong line numbers when reporting
500 # compilation errors.
501 if [[ -n "${testargs[$1]}" ]]
503 # "go test -check.vv giturl" doesn't work, but this
505 cd "$WORKSPACE/$1" && \
506 go get -t "git.curoverse.com/arvados.git/$1" && \
507 go test ${coverflags[@]} ${testargs[$1]}
509 # The above form gets verbose even when testargs is
510 # empty, so use this form in such cases:
511 go get -t "git.curoverse.com/arvados.git/$1" && \
512 go test ${coverflags[@]} "git.curoverse.com/arvados.git/$1"
515 go tool cover -html="$WORKSPACE/tmp/.$covername.tmp" -o "$WORKSPACE/tmp/$covername.html"
516 rm "$WORKSPACE/tmp/.$covername.tmp"
517 elif [[ "$2" == "pip" ]]
519 # $3 can name a path directory for us to use, including trailing
520 # slash; e.g., the bin/ subdirectory of a virtualenv.
522 && "${3}python" setup.py test ${testargs[$1]}
523 elif [[ "$2" != "" ]]
530 checkexit $result "$1 tests"
531 title "End of $1 tests (`timer`)"
534 title "Skipping $1 tests"
539 if [[ -z "$skip_install" || (-n "$only_install" && "$only_install" == "$1") ]]
541 title "Running $1 install"
543 if [[ "$2" == "go" ]]
545 go get -t "git.curoverse.com/arvados.git/$1"
546 elif [[ "$2" == "pip" ]]
548 # $3 can name a path directory for us to use, including trailing
549 # slash; e.g., the bin/ subdirectory of a virtualenv.
551 # Need to change to a different directory after creating
552 # the source dist package to avoid a pip bug.
553 # see https://arvados.org/issues/5766 for details.
555 # Also need to install twice, because if it believes the package is
556 # already installed, pip it won't install it. So the first "pip
557 # install" ensures that the dependencies are met, the second "pip
558 # install" ensures that we've actually installed the local package
561 && "${3}python" setup.py sdist rotate --keep=1 --match .tar.gz \
563 && "${3}pip" install --quiet "$WORKSPACE/$1/dist"/*.tar.gz \
564 && "${3}pip" install --quiet --no-deps --ignore-installed "$WORKSPACE/$1/dist"/*.tar.gz
565 elif [[ "$2" != "" ]]
571 checkexit $? "$1 install"
572 title "End of $1 install (`timer`)"
574 title "Skipping $1 install"
579 txt="********** $1 **********"
580 printf "\n%*s%s\n\n" $((($COLUMNS-${#txt})/2)) "" "$txt"
583 bundle_install_trylocal() {
586 echo "(Running bundle install --local. 'could not find package' messages are OK.)"
587 if ! bundle install --local --no-deployment; then
588 echo "(Running bundle install again, without --local.)"
589 bundle install --no-deployment
596 cd "$WORKSPACE/doc" \
597 && bundle_install_trylocal \
605 with_test_gemset gem_uninstall_if_exists "$gemname" \
606 && cd "$WORKSPACE/$srcpath" \
607 && bundle_install_trylocal \
608 && gem build "$gemname.gemspec" \
609 && with_test_gemset gem install --no-ri --no-rdoc $(ls -t "$gemname"-*.gem|head -n1)
613 install_gem arvados sdk/ruby
615 do_install sdk/ruby ruby_sdk
618 cd "$WORKSPACE/sdk/perl" \
619 && perl Makefile.PL INSTALL_BASE="$PERLINSTALLBASE" \
620 && make install INSTALLDIRS=perl
622 do_install sdk/perl perl_sdk
625 install_gem arvados-cli sdk/cli
627 do_install sdk/cli cli
629 install_login-sync() {
630 install_gem arvados-login-sync services/login-sync
632 do_install services/login-sync login-sync
634 # Install the Python SDK early. Various other test suites (like
635 # keepproxy) bring up run_test_server.py, which imports the arvados
636 # module. We can't actually *test* the Python SDK yet though, because
637 # its own test suite brings up some of those other programs (like
639 declare -a pythonstuff
646 for p in "${pythonstuff[@]}"
650 if [ -n "$PYTHON3" ]; then
651 do_install services/dockercleaner pip "$VENV3DIR/bin/"
654 install_apiserver() {
655 cd "$WORKSPACE/services/api" \
656 && RAILS_ENV=test bundle_install_trylocal
658 rm -f config/environments/test.rb
659 cp config/environments/test.rb.example config/environments/test.rb
661 if [ -n "$CONFIGSRC" ]
663 for f in database.yml application.yml
665 cp "$CONFIGSRC/$f" config/ || fatal "$f"
669 # Fill in a random secret_token and blob_signing_key for testing
670 SECRET_TOKEN=`echo 'puts rand(2**512).to_s(36)' |ruby`
671 BLOB_SIGNING_KEY=`echo 'puts rand(2**512).to_s(36)' |ruby`
673 sed -i'' -e "s:SECRET_TOKEN:$SECRET_TOKEN:" config/application.yml
674 sed -i'' -e "s:BLOB_SIGNING_KEY:$BLOB_SIGNING_KEY:" config/application.yml
676 # Set up empty git repo (for git tests)
678 sed -i'' -e "s:/var/cache/git:$GITDIR:" config/application.default.yml
681 mkdir -p $GITDIR/test
684 && git config user.email "jenkins@ci.curoverse.com" \
685 && git config user.name "Jenkins, CI" \
688 && git commit -m 'initial commit'
690 # Clear out any lingering postgresql connections to the test
691 # database, so that we can drop it. This assumes the current user
692 # is a postgresql superuser.
693 cd "$WORKSPACE/services/api" \
694 && test_database=$(python -c "import yaml; print yaml.load(file('config/database.yml'))['test']['database']") \
695 && psql "$test_database" -c "SELECT pg_terminate_backend (pg_stat_activity.procpid::int) FROM pg_stat_activity WHERE pg_stat_activity.datname = '$test_database';" 2>/dev/null
697 cd "$WORKSPACE/services/api" \
698 && RAILS_ENV=test bundle exec rake db:drop \
699 && RAILS_ENV=test bundle exec rake db:setup \
700 && RAILS_ENV=test bundle exec rake db:fixtures:load
702 do_install services/api apiserver
711 services/arv-git-httpd
717 services/datamanager/summary
718 services/datamanager/collection
719 services/datamanager/keep
723 for g in "${gostuff[@]}"
728 install_workbench() {
729 cd "$WORKSPACE/apps/workbench" \
730 && mkdir -p tmp/cache \
731 && RAILS_ENV=test bundle_install_trylocal
733 do_install apps/workbench workbench
735 test_doclinkchecker() {
739 ARVADOS_API_HOST=qr1hi.arvadosapi.com
740 # Make sure python-epydoc is installed or the next line won't
742 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
745 do_test doc doclinkchecker
750 cd "$WORKSPACE/services/api" \
751 && RAILS_ENV=test bundle exec rake test TESTOPTS=-v ${testargs[services/api]}
753 do_test services/api apiserver
755 # Shortcut for when we're only running apiserver tests. This saves a bit of time,
756 # because we don't need to start up the api server for subsequent tests.
757 if [ ! -z "$only" ] && [ "$only" == "services/api" ]; then
758 rotate_logfile "$WORKSPACE/services/api/log/" "test.log"
765 cd "$WORKSPACE/sdk/ruby" \
766 && bundle exec rake test TESTOPTS=-v ${testargs[sdk/ruby]}
768 do_test sdk/ruby ruby_sdk
771 cd "$WORKSPACE/sdk/cli" \
772 && mkdir -p /tmp/keep \
773 && KEEP_LOCAL_STORE=/tmp/keep bundle exec rake test TESTOPTS=-v ${testargs[sdk/cli]}
778 cd "$WORKSPACE/services/login-sync" \
779 && bundle exec rake test TESTOPTS=-v ${testargs[services/login-sync]}
781 do_test services/login-sync login-sync
783 for p in "${pythonstuff[@]}"
787 do_test services/dockercleaner pip "$VENV3DIR/bin/"
789 for g in "${gostuff[@]}"
795 start_nginx_proxy_services \
796 && cd "$WORKSPACE/apps/workbench" \
797 && RAILS_ENV=test bundle exec rake test TESTOPTS=-v ${testargs[apps/workbench]}
799 do_test apps/workbench workbench
801 test_workbench_benchmark() {
802 start_nginx_proxy_services \
803 && cd "$WORKSPACE/apps/workbench" \
804 && RAILS_ENV=test bundle exec rake test:benchmark ${testargs[apps/workbench_benchmark]}
806 do_test apps/workbench_benchmark workbench_benchmark
808 test_workbench_profile() {
809 start_nginx_proxy_services \
810 && cd "$WORKSPACE/apps/workbench" \
811 && RAILS_ENV=test bundle exec rake test:profile ${testargs[apps/workbench_profile]}
813 do_test apps/workbench_profile workbench_profile