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
63 services/dockercleaner
69 services/arv-git-httpd
81 # First make sure to remove any ARVADOS_ variables from the calling
82 # environment that could interfere with the tests.
83 unset $(env | cut -d= -f1 | grep \^ARVADOS_)
85 # Reset other variables that could affect our [tests'] behavior by
102 if [[ -z "$temp" ]]; then
103 # we didn't even get as far as making a temp dir
105 elif [[ -z "$temp_preserve" ]]; then
108 echo "Leaving behind temp dirs in $temp"
114 echo >&2 "Fatal: $* (encountered in ${FUNCNAME[1]} at ${BASH_SOURCE[1]} line ${BASH_LINENO[0]})"
119 for x in "${successes[@]}"
124 if [[ ${#failures[@]} == 0 ]]
126 echo "All test suites passed."
128 echo "Failures (${#failures[@]}):"
129 for x in "${failures[@]}"
138 create-plot-data-from-log.sh $BUILD_NUMBER "$WORKSPACE/apps/workbench/log/test.log" "$WORKSPACE/apps/workbench/log/"
139 rotate_logfile "$WORKSPACE/apps/workbench/log/" "test.log"
141 rotate_logfile "$WORKSPACE/services/api/log/" "test.log"
148 ( [[ -n "$WORKSPACE" ]] && [[ -d "$WORKSPACE/services" ]] ) \
149 || fatal "WORKSPACE environment variable not set to a source directory (see: $0 --help)"
150 echo Checking dependencies:
151 echo -n 'virtualenv: '
152 virtualenv --version \
153 || fatal "No virtualenv. Try: apt-get install virtualenv"
156 || fatal "No go binary. See http://golang.org/doc/install"
158 gcc --version | egrep ^gcc \
159 || fatal "No gcc. Try: apt-get install build-essential"
161 find /usr/include -wholename '*fuse/fuse.h' \
162 || fatal "No fuse/fuse.h. Try: apt-get install libfuse-dev"
163 echo -n 'pyconfig.h: '
164 find /usr/include -name pyconfig.h | egrep --max-count=1 . \
165 || fatal "No pyconfig.h. Try: apt-get install python-dev"
167 PATH="$PATH:/sbin:/usr/sbin:/usr/local/sbin" nginx -v \
168 || fatal "No nginx. Try: apt-get install nginx"
170 perl -v | grep version \
171 || fatal "No perl. Try: apt-get install perl"
172 for mod in ExtUtils::MakeMaker JSON LWP Net::SSL; do
173 echo -n "perl $mod: "
174 perl -e "use $mod; print \"\$$mod::VERSION\\n\"" \
175 || fatal "No $mod. Try: apt-get install perl-modules libcrypt-ssleay-perl libjson-perl"
179 || fatal "No gitolite. Try: apt-get install gitolite3"
183 # i.e. rotate_logfile "$WORKSPACE/apps/workbench/log/" "test.log"
184 # $BUILD_NUMBER is set by Jenkins if this script is being called as part of a Jenkins run
185 if [[ -f "$1/$2" ]]; then
186 THEDATE=`date +%Y%m%d%H%M%S`
187 mv "$1/$2" "$1/$THEDATE-$BUILD_NUMBER-$2"
188 gzip "$1/$THEDATE-$BUILD_NUMBER-$2"
195 skip[apps/workbench_profile]=1
202 echo >&2 "$helpmessage"
211 only="$1"; skip[$1]=""; shift
218 only_install="$1"; shift
231 suite="${arg%%_test=*}"
233 testargs["$suite"]="$args"
236 eval export $(echo $arg | cut -d= -f1)=\"$(echo $arg | cut -d= -f2-)\"
239 echo >&2 "$0: Unrecognized option: '$arg'. Try: $0 --help"
246 echo 'Starting API server...'
248 && eval $(python sdk/python/tests/run_test_server.py start --auth admin) \
249 && export ARVADOS_TEST_API_HOST="$ARVADOS_API_HOST" \
250 && export ARVADOS_TEST_API_INSTALLED="$$" \
251 && (env | egrep ^ARVADOS)
254 start_nginx_proxy_services() {
255 echo 'Starting keepproxy, arv-git-httpd, and nginx ssl proxy...'
257 && python sdk/python/tests/run_test_server.py start_keep_proxy \
258 && python sdk/python/tests/run_test_server.py start_arv-git-httpd \
259 && python sdk/python/tests/run_test_server.py start_nginx \
260 && export ARVADOS_TEST_PROXY_SERVICES=1
264 if [[ -n "$ARVADOS_TEST_PROXY_SERVICES" ]]; then
265 unset ARVADOS_TEST_PROXY_SERVICES
267 && python sdk/python/tests/run_test_server.py stop_nginx \
268 && python sdk/python/tests/run_test_server.py stop_arv-git-httpd \
269 && python sdk/python/tests/run_test_server.py stop_keep_proxy
271 if [[ -n "$ARVADOS_TEST_API_HOST" ]]; then
272 unset ARVADOS_TEST_API_HOST
274 && python sdk/python/tests/run_test_server.py stop
279 failures+=("($(basename $0) interrupted)")
286 echo "WORKSPACE=$WORKSPACE"
288 if [[ -z "$CONFIGSRC" ]] && [[ -d "$HOME/arvados-api-server" ]]; then
289 # Jenkins expects us to use this by default.
290 CONFIGSRC="$HOME/arvados-api-server"
293 # Clean up .pyc files that may exist in the workspace
295 find -name '*.pyc' -delete
297 if [[ -z "$temp" ]]; then
301 # Set up temporary install dirs (unless existing dirs were supplied)
302 for tmpdir in VENVDIR VENV3DIR GOPATH GEMHOME PERLINSTALLBASE
304 if [[ -z "${!tmpdir}" ]]; then
305 eval "$tmpdir"="$temp/$tmpdir"
307 if ! [[ -d "${!tmpdir}" ]]; then
308 mkdir "${!tmpdir}" || fatal "can't create ${!tmpdir} (does $temp exist?)"
312 setup_ruby_environment() {
313 if [[ -s "$HOME/.rvm/scripts/rvm" ]] ; then
314 source "$HOME/.rvm/scripts/rvm"
316 elif [[ -s "/usr/local/rvm/scripts/rvm" ]] ; then
317 source "/usr/local/rvm/scripts/rvm"
323 if [[ "$using_rvm" == true ]]; then
324 # If rvm is in use, we can't just put separate "dependencies"
325 # and "gems-under-test" paths to GEM_PATH: passenger resets
326 # the environment to the "current gemset", which would lose
327 # our GEM_PATH and prevent our test suites from running ruby
328 # programs (for example, the Workbench test suite could not
329 # boot an API server or run arv). Instead, we have to make an
330 # rvm gemset and use it for everything.
332 [[ `type rvm | head -n1` == "rvm is a function" ]] \
335 # Put rvm's favorite path back in first place (overriding
336 # virtualenv, which just put itself there). Ignore rvm's
337 # complaint about not being in first place already.
338 rvm use @default 2>/dev/null
340 # Create (if needed) and switch to an @arvados-tests
341 # gemset. (Leave the choice of ruby to the caller.)
342 rvm use @arvados-tests --create \
343 || fatal 'rvm gemset setup'
347 # When our "bundle install"s need to install new gems to
348 # satisfy dependencies, we want them to go where "gem install
349 # --user-install" would put them. (However, if the caller has
350 # already set GEM_HOME, we assume that's where dependencies
351 # should be installed, and we should leave it alone.)
353 if [ -z "$GEM_HOME" ]; then
354 user_gempath="$(gem env gempath)"
355 export GEM_HOME="${user_gempath%%:*}"
357 PATH="$(gem env gemdir)/bin:$PATH"
359 # When we build and install our own gems, we install them in our
360 # $GEMHOME tmpdir, and we want them to be at the front of GEM_PATH and
361 # PATH so integration tests prefer them over other versions that
362 # happen to be installed in $user_gempath, system dirs, etc.
364 tmpdir_gem_home="$(env - PATH="$PATH" HOME="$GEMHOME" gem env gempath | cut -f1 -d:)"
365 PATH="$tmpdir_gem_home/bin:$PATH"
366 export GEM_PATH="$tmpdir_gem_home:$(gem env gempath)"
368 echo "Will install dependencies to $(gem env gemdir)"
369 echo "Will install arvados gems to $tmpdir_gem_home"
370 echo "Gem search path is GEM_PATH=$GEM_PATH"
375 if [[ "$using_rvm" == true ]]; then
378 GEM_HOME="$tmpdir_gem_home" GEM_PATH="$tmpdir_gem_home" "$@"
382 gem_uninstall_if_exists() {
383 if gem list "$1\$" | egrep '^\w'; then
384 gem uninstall --force --all --executables "$1"
388 export PERLINSTALLBASE
389 export PERLLIB="$PERLINSTALLBASE/lib/perl5:${PERLLIB:+$PERLLIB}"
392 mkdir -p "$GOPATH/src/git.curoverse.com"
393 ln -sfn "$WORKSPACE" "$GOPATH/src/git.curoverse.com/arvados.git" \
394 || fatal "symlink failed"
396 if ! [[ -e "$VENVDIR/bin/activate" ]] || ! [[ -e "$VENVDIR/bin/pip" ]]; then
397 virtualenv --setuptools "$VENVDIR" || fatal "virtualenv $VENVDIR failed"
399 . "$VENVDIR/bin/activate"
401 if (pip install setuptools | grep setuptools-0) || [ "$($VENVDIR/bin/easy_install --version | cut -d\ -f2 | cut -d. -f1)" -lt 18 ]; then
402 pip install --upgrade setuptools pip
405 # Needed for run_test_server.py which is used by certain (non-Python) tests.
406 pip freeze 2>/dev/null | egrep ^PyYAML= \
407 || pip install PyYAML >/dev/null \
408 || fatal "pip install PyYAML failed"
410 # Preinstall forked version of libcloud, because nodemanager "pip install"
411 # won't pick it up by default.
412 pip freeze 2>/dev/null | egrep ^apache-libcloud==$LIBCLOUD_PIN \
413 || pip install --pre --ignore-installed https://github.com/curoverse/libcloud/archive/apache-libcloud-$LIBCLOUD_PIN.zip >/dev/null \
414 || fatal "pip install apache-libcloud failed"
416 # Deactivate Python 2 virtualenv
419 # If Python 3 is available, set up its virtualenv in $VENV3DIR.
420 # Otherwise, skip dependent tests.
421 PYTHON3=$(which python3)
422 if [ "0" = "$?" ]; then
423 virtualenv --python "$PYTHON3" --setuptools "$VENV3DIR" \
424 || fatal "python3 virtualenv $VENV3DIR failed"
426 . "$VENV3DIR/bin/activate"
428 if (pip install setuptools | grep setuptools-0) || [ "$($VENV3DIR/bin/easy_install --version | cut -d\ -f2 | cut -d. -f1)" -lt 18 ]; then
429 pip install --upgrade setuptools pip
432 # Deactivate Python 3 virtualenv
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 if [[ -n "${testargs[$1]}" ]]
499 # "go test -check.vv giturl" doesn't work, but this
501 cd "$WORKSPACE/$1" && go test ${coverflags[@]} ${testargs[$1]}
503 # The above form gets verbose even when testargs is
504 # empty, so use this form in such cases:
505 go test ${coverflags[@]} "git.curoverse.com/arvados.git/$1"
508 go tool cover -html="$WORKSPACE/tmp/.$covername.tmp" -o "$WORKSPACE/tmp/$covername.html"
509 rm "$WORKSPACE/tmp/.$covername.tmp"
510 elif [[ "$2" == "pip" ]]
512 # $3 can name a path directory for us to use, including trailing
513 # slash; e.g., the bin/ subdirectory of a virtualenv.
515 && "${3}python" setup.py test ${testargs[$1]}
516 elif [[ "$2" != "" ]]
523 checkexit $result "$1 tests"
524 title "End of $1 tests (`timer`)"
527 title "Skipping $1 tests"
532 if [[ -z "$skip_install" || (-n "$only_install" && "$only_install" == "$1") ]]
534 title "Running $1 install"
536 if [[ "$2" == "go" ]]
538 go get -t "git.curoverse.com/arvados.git/$1"
539 elif [[ "$2" == "pip" ]]
541 # $3 can name a path directory for us to use, including trailing
542 # slash; e.g., the bin/ subdirectory of a virtualenv.
544 # Need to change to a different directory after creating
545 # the source dist package to avoid a pip bug.
546 # see https://arvados.org/issues/5766 for details.
548 # Also need to install twice, because if it believes the package is
549 # already installed, pip it won't install it. So the first "pip
550 # install" ensures that the dependencies are met, the second "pip
551 # install" ensures that we've actually installed the local package
554 && "${3}python" setup.py sdist rotate --keep=1 --match .tar.gz \
556 && "${3}pip" install --quiet "$WORKSPACE/$1/dist"/*.tar.gz \
557 && "${3}pip" install --quiet --no-deps --ignore-installed "$WORKSPACE/$1/dist"/*.tar.gz
558 elif [[ "$2" != "" ]]
564 checkexit $? "$1 install"
565 title "End of $1 install (`timer`)"
567 title "Skipping $1 install"
572 txt="********** $1 **********"
573 printf "\n%*s%s\n\n" $((($COLUMNS-${#txt})/2)) "" "$txt"
576 bundle_install_trylocal() {
579 echo "(Running bundle install --local. 'could not find package' messages are OK.)"
580 if ! bundle install --local --no-deployment; then
581 echo "(Running bundle install again, without --local.)"
582 bundle install --no-deployment
589 cd "$WORKSPACE/doc" \
590 && bundle_install_trylocal \
598 with_test_gemset gem_uninstall_if_exists "$gemname" \
599 && cd "$WORKSPACE/$srcpath" \
600 && bundle_install_trylocal \
601 && gem build "$gemname.gemspec" \
602 && with_test_gemset gem install --no-ri --no-rdoc $(ls -t "$gemname"-*.gem|head -n1)
606 install_gem arvados sdk/ruby
608 do_install sdk/ruby ruby_sdk
611 cd "$WORKSPACE/sdk/perl" \
612 && perl Makefile.PL INSTALL_BASE="$PERLINSTALLBASE" \
613 && make install INSTALLDIRS=perl
615 do_install sdk/perl perl_sdk
618 install_gem arvados-cli sdk/cli
620 do_install sdk/cli cli
622 install_login-sync() {
623 install_gem arvados-login-sync services/login-sync
625 do_install services/login-sync login-sync
627 # Install the Python SDK early. Various other test suites (like
628 # keepproxy) bring up run_test_server.py, which imports the arvados
629 # module. We can't actually *test* the Python SDK yet though, because
630 # its own test suite brings up some of those other programs (like
632 declare -a pythonstuff
639 for p in "${pythonstuff[@]}"
643 if [ -n "$PYTHON3" ]; then
644 do_install services/dockercleaner pip "$VENV3DIR/bin/"
647 install_apiserver() {
648 cd "$WORKSPACE/services/api" \
649 && RAILS_ENV=test bundle_install_trylocal
651 rm -f config/environments/test.rb
652 cp config/environments/test.rb.example config/environments/test.rb
654 if [ -n "$CONFIGSRC" ]
656 for f in database.yml application.yml
658 cp "$CONFIGSRC/$f" config/ || fatal "$f"
662 # Fill in a random secret_token and blob_signing_key for testing
663 SECRET_TOKEN=`echo 'puts rand(2**512).to_s(36)' |ruby`
664 BLOB_SIGNING_KEY=`echo 'puts rand(2**512).to_s(36)' |ruby`
666 sed -i'' -e "s:SECRET_TOKEN:$SECRET_TOKEN:" config/application.yml
667 sed -i'' -e "s:BLOB_SIGNING_KEY:$BLOB_SIGNING_KEY:" config/application.yml
669 # Set up empty git repo (for git tests)
671 sed -i'' -e "s:/var/cache/git:$GITDIR:" config/application.default.yml
674 mkdir -p $GITDIR/test
677 && git config user.email "jenkins@ci.curoverse.com" \
678 && git config user.name "Jenkins, CI" \
681 && git commit -m 'initial commit'
683 # Clear out any lingering postgresql connections to the test
684 # database, so that we can drop it. This assumes the current user
685 # is a postgresql superuser.
686 cd "$WORKSPACE/services/api" \
687 && test_database=$(python -c "import yaml; print yaml.load(file('config/database.yml'))['test']['database']") \
688 && 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
690 cd "$WORKSPACE/services/api" \
691 && RAILS_ENV=test bundle exec rake db:drop \
692 && RAILS_ENV=test bundle exec rake db:setup \
693 && RAILS_ENV=test bundle exec rake db:fixtures:load
695 do_install services/api apiserver
701 services/arv-git-httpd
706 services/datamanager/summary
707 services/datamanager/collection
711 for g in "${gostuff[@]}"
716 install_workbench() {
717 cd "$WORKSPACE/apps/workbench" \
718 && mkdir -p tmp/cache \
719 && RAILS_ENV=test bundle_install_trylocal
721 do_install apps/workbench workbench
723 test_doclinkchecker() {
727 ARVADOS_API_HOST=qr1hi.arvadosapi.com
728 # Make sure python-epydoc is installed or the next line won't
730 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
733 do_test doc doclinkchecker
738 cd "$WORKSPACE/services/api" \
739 && RAILS_ENV=test bundle exec rake test TESTOPTS=-v ${testargs[services/api]}
741 do_test services/api apiserver
743 # Shortcut for when we're only running apiserver tests. This saves a bit of time,
744 # because we don't need to start up the api server for subsequent tests.
745 if [ ! -z "$only" ] && [ "$only" == "services/api" ]; then
746 rotate_logfile "$WORKSPACE/services/api/log/" "test.log"
753 cd "$WORKSPACE/sdk/ruby" \
754 && bundle exec rake test TESTOPTS=-v ${testargs[sdk/ruby]}
756 do_test sdk/ruby ruby_sdk
759 cd "$WORKSPACE/sdk/cli" \
760 && mkdir -p /tmp/keep \
761 && KEEP_LOCAL_STORE=/tmp/keep bundle exec rake test TESTOPTS=-v ${testargs[sdk/cli]}
766 cd "$WORKSPACE/services/login-sync" \
767 && bundle exec rake test TESTOPTS=-v ${testargs[services/login-sync]}
769 do_test services/login-sync login-sync
771 for p in "${pythonstuff[@]}"
775 do_test services/dockercleaner pip "$VENV3DIR/bin/"
777 for g in "${gostuff[@]}"
783 start_nginx_proxy_services \
784 && cd "$WORKSPACE/apps/workbench" \
785 && RAILS_ENV=test bundle exec rake test TESTOPTS=-v ${testargs[apps/workbench]}
787 do_test apps/workbench workbench
789 test_workbench_benchmark() {
790 start_nginx_proxy_services \
791 && cd "$WORKSPACE/apps/workbench" \
792 && RAILS_ENV=test bundle exec rake test:benchmark ${testargs[apps/workbench_benchmark]}
794 do_test apps/workbench_benchmark workbench_benchmark
796 test_workbench_profile() {
797 start_nginx_proxy_services \
798 && cd "$WORKSPACE/apps/workbench" \
799 && RAILS_ENV=test bundle exec rake test:profile ${testargs[apps/workbench_profile]}
801 do_test apps/workbench_profile workbench_profile