3 . `dirname "$(readlink -f "$0")"`/libcloud-pin
6 . `dirname "$(readlink -f "$0")"`/run-library.sh
8 read -rd "\000" helpmessage <<EOF
9 $(basename $0): Install and test Arvados components.
11 Exit non-zero if any tests fail.
14 $(basename $0) WORKSPACE=/path/to/arvados [options]
18 --skip FOO Do not test the FOO component.
19 --only FOO Do not test anything except the FOO component.
20 --temp DIR Install components and dependencies under DIR instead of
21 making a new temporary directory. Implies --leave-temp.
22 --leave-temp Do not remove GOPATH, virtualenv, and other temp dirs at exit.
23 Instead, show the path to give as --temp to reuse them in
24 subsequent invocations.
25 --skip-install Do not run any install steps. Just run tests.
26 You should provide GOPATH, GEMHOME, and VENVDIR options
27 from a previous invocation if you use this option.
28 --only-install Run specific install step
29 WORKSPACE=path Arvados source tree to test.
30 CONFIGSRC=path Dir with api server config files to copy into source tree.
31 (If none given, leave config files alone in source tree.)
32 services/api_test="TEST=test/functional/arvados/v1/collections_controller_test.rb"
33 Restrict apiserver tests to the given file
34 sdk/python_test="--test-suite test.test_keep_locator"
35 Restrict Python SDK tests to the given class
36 apps/workbench_test="TEST=test/integration/pipeline_instances_test.rb"
37 Restrict Workbench tests to the given file
38 services/arv-git-httpd_test="-check.vv"
39 Show all log messages, even when tests pass (also works
40 with services/keepstore_test etc.)
42 Print more debug messages
43 envvar=value Set \$envvar to value. Primarily useful for WORKSPACE,
44 *_test, and other examples shown above.
46 Assuming --skip-install is not given, all components are installed
47 into \$GOPATH, \$VENDIR, and \$GEMHOME before running any tests. Many
48 test suites depend on other components being installed, and installing
49 everything tends to be quicker than debugging dependencies.
51 As a special concession to the current CI server config, CONFIGSRC
52 defaults to $HOME/arvados-api-server if that directory exists.
54 More information and background:
56 https://arvados.org/projects/arvados/wiki/Running_tests
61 apps/workbench_benchmark
62 apps/workbench_profile
65 services/arv-git-httpd
67 services/dockercleaner
75 services/crunch-dispatch-local
76 services/crunch-dispatch-slurm
88 tools/crunchstat-summary
93 # First make sure to remove any ARVADOS_ variables from the calling
94 # environment that could interfere with the tests.
95 unset $(env | cut -d= -f1 | grep \^ARVADOS_)
97 # Reset other variables that could affect our [tests'] behavior by
112 if [[ -z "$temp" ]]; then
113 # we didn't even get as far as making a temp dir
115 elif [[ -z "$temp_preserve" ]]; then
118 echo "Leaving behind temp dirs in $temp"
124 echo >&2 "Fatal: $* (encountered in ${FUNCNAME[1]} at ${BASH_SOURCE[1]} line ${BASH_LINENO[0]})"
130 create-plot-data-from-log.sh $BUILD_NUMBER "$WORKSPACE/apps/workbench/log/test.log" "$WORKSPACE/apps/workbench/log/"
131 rotate_logfile "$WORKSPACE/apps/workbench/log/" "test.log"
133 rotate_logfile "$WORKSPACE/services/api/log/" "test.log"
140 ( [[ -n "$WORKSPACE" ]] && [[ -d "$WORKSPACE/services" ]] ) \
141 || fatal "WORKSPACE environment variable not set to a source directory (see: $0 --help)"
142 echo Checking dependencies:
143 echo -n 'virtualenv: '
144 virtualenv --version \
145 || fatal "No virtualenv. Try: apt-get install virtualenv (on ubuntu: python-virtualenv)"
148 || fatal "No go binary. See http://golang.org/doc/install"
150 gcc --version | egrep ^gcc \
151 || fatal "No gcc. Try: apt-get install build-essential"
153 find /usr/include -wholename '*fuse/fuse.h' \
154 || fatal "No fuse/fuse.h. Try: apt-get install libfuse-dev"
155 echo -n 'pyconfig.h: '
156 find /usr/include -name pyconfig.h | egrep --max-count=1 . \
157 || fatal "No pyconfig.h. Try: apt-get install python-dev"
159 PATH="$PATH:/sbin:/usr/sbin:/usr/local/sbin" nginx -v \
160 || fatal "No nginx. Try: apt-get install nginx"
162 perl -v | grep version \
163 || fatal "No perl. Try: apt-get install perl"
164 for mod in ExtUtils::MakeMaker JSON LWP Net::SSL; do
165 echo -n "perl $mod: "
166 perl -e "use $mod; print \"\$$mod::VERSION\\n\"" \
167 || fatal "No $mod. Try: apt-get install perl-modules libcrypt-ssleay-perl libjson-perl libwww-perl"
171 || fatal "No gitolite. Try: apt-get install gitolite3"
175 # i.e. rotate_logfile "$WORKSPACE/apps/workbench/log/" "test.log"
176 # $BUILD_NUMBER is set by Jenkins if this script is being called as part of a Jenkins run
177 if [[ -f "$1/$2" ]]; then
178 THEDATE=`date +%Y%m%d%H%M%S`
179 mv "$1/$2" "$1/$THEDATE-$BUILD_NUMBER-$2"
180 gzip "$1/$THEDATE-$BUILD_NUMBER-$2"
187 skip[apps/workbench_profile]=1
194 echo >&2 "$helpmessage"
203 only="$1"; skip[$1]=""; shift
210 only_install="$1"; shift
223 suite="${arg%%_test=*}"
225 testargs["$suite"]="$args"
228 eval export $(echo $arg | cut -d= -f1)=\"$(echo $arg | cut -d= -f2-)\"
231 echo >&2 "$0: Unrecognized option: '$arg'. Try: $0 --help"
238 echo 'Starting API server...'
240 && eval $(python sdk/python/tests/run_test_server.py start --auth admin) \
241 && export ARVADOS_TEST_API_HOST="$ARVADOS_API_HOST" \
242 && export ARVADOS_TEST_API_INSTALLED="$$" \
243 && (env | egrep ^ARVADOS)
246 start_nginx_proxy_services() {
247 echo 'Starting keepproxy, keep-web, arv-git-httpd, and nginx ssl proxy...'
249 && python sdk/python/tests/run_test_server.py start_keep_proxy \
250 && python sdk/python/tests/run_test_server.py start_keep-web \
251 && python sdk/python/tests/run_test_server.py start_arv-git-httpd \
252 && python sdk/python/tests/run_test_server.py start_nginx \
253 && export ARVADOS_TEST_PROXY_SERVICES=1
257 if [[ -n "$ARVADOS_TEST_PROXY_SERVICES" ]]; then
258 unset ARVADOS_TEST_PROXY_SERVICES
260 && python sdk/python/tests/run_test_server.py stop_nginx \
261 && python sdk/python/tests/run_test_server.py stop_arv-git-httpd \
262 && python sdk/python/tests/run_test_server.py stop_keep-web \
263 && python sdk/python/tests/run_test_server.py stop_keep_proxy
265 if [[ -n "$ARVADOS_TEST_API_HOST" ]]; then
266 unset ARVADOS_TEST_API_HOST
268 && python sdk/python/tests/run_test_server.py stop
273 failures+=("($(basename $0) interrupted)")
280 echo "WORKSPACE=$WORKSPACE"
282 if [[ -z "$CONFIGSRC" ]] && [[ -d "$HOME/arvados-api-server" ]]; then
283 # Jenkins expects us to use this by default.
284 CONFIGSRC="$HOME/arvados-api-server"
287 # Clean up .pyc files that may exist in the workspace
289 find -name '*.pyc' -delete
291 if [[ -z "$temp" ]]; then
295 # Set up temporary install dirs (unless existing dirs were supplied)
296 for tmpdir in VENVDIR VENV3DIR GOPATH GEMHOME PERLINSTALLBASE
298 if [[ -z "${!tmpdir}" ]]; then
299 eval "$tmpdir"="$temp/$tmpdir"
301 if ! [[ -d "${!tmpdir}" ]]; then
302 mkdir "${!tmpdir}" || fatal "can't create ${!tmpdir} (does $temp exist?)"
306 setup_ruby_environment() {
307 if [[ -s "$HOME/.rvm/scripts/rvm" ]] ; then
308 source "$HOME/.rvm/scripts/rvm"
310 elif [[ -s "/usr/local/rvm/scripts/rvm" ]] ; then
311 source "/usr/local/rvm/scripts/rvm"
317 if [[ "$using_rvm" == true ]]; then
318 # If rvm is in use, we can't just put separate "dependencies"
319 # and "gems-under-test" paths to GEM_PATH: passenger resets
320 # the environment to the "current gemset", which would lose
321 # our GEM_PATH and prevent our test suites from running ruby
322 # programs (for example, the Workbench test suite could not
323 # boot an API server or run arv). Instead, we have to make an
324 # rvm gemset and use it for everything.
326 [[ `type rvm | head -n1` == "rvm is a function" ]] \
329 # Put rvm's favorite path back in first place (overriding
330 # virtualenv, which just put itself there). Ignore rvm's
331 # complaint about not being in first place already.
332 rvm use @default 2>/dev/null
334 # Create (if needed) and switch to an @arvados-tests
335 # gemset. (Leave the choice of ruby to the caller.)
336 rvm use @arvados-tests --create \
337 || fatal 'rvm gemset setup'
341 # When our "bundle install"s need to install new gems to
342 # satisfy dependencies, we want them to go where "gem install
343 # --user-install" would put them. (However, if the caller has
344 # already set GEM_HOME, we assume that's where dependencies
345 # should be installed, and we should leave it alone.)
347 if [ -z "$GEM_HOME" ]; then
348 user_gempath="$(gem env gempath)"
349 export GEM_HOME="${user_gempath%%:*}"
351 PATH="$(gem env gemdir)/bin:$PATH"
353 # When we build and install our own gems, we install them in our
354 # $GEMHOME tmpdir, and we want them to be at the front of GEM_PATH and
355 # PATH so integration tests prefer them over other versions that
356 # happen to be installed in $user_gempath, system dirs, etc.
358 tmpdir_gem_home="$(env - PATH="$PATH" HOME="$GEMHOME" gem env gempath | cut -f1 -d:)"
359 PATH="$tmpdir_gem_home/bin:$PATH"
360 export GEM_PATH="$tmpdir_gem_home:$(gem env gempath)"
362 echo "Will install dependencies to $(gem env gemdir)"
363 echo "Will install arvados gems to $tmpdir_gem_home"
364 echo "Gem search path is GEM_PATH=$GEM_PATH"
369 if [[ "$using_rvm" == true ]]; then
372 GEM_HOME="$tmpdir_gem_home" GEM_PATH="$tmpdir_gem_home" "$@"
376 gem_uninstall_if_exists() {
377 if gem list "$1\$" | egrep '^\w'; then
378 gem uninstall --force --all --executables "$1"
383 local venvdest="$1"; shift
384 if ! [[ -e "$venvdest/bin/activate" ]] || ! [[ -e "$venvdest/bin/pip" ]]; then
385 virtualenv --setuptools "$@" "$venvdest" || fatal "virtualenv $venvdest failed"
387 if [[ $("$venvdest/bin/python" --version 2>&1) =~ \ 3\.[012]\. ]]; then
388 # pip 8.0.0 dropped support for python 3.2, e.g., debian wheezy
389 "$venvdest/bin/pip" install 'setuptools>=18' 'pip>=7,<8'
391 "$venvdest/bin/pip" install 'setuptools>=18' 'pip>=7'
393 # ubuntu1404 can't seem to install mock via tests_require, but it can do this.
394 "$venvdest/bin/pip" install 'mock>=1.0' 'pbr<1.7.0'
397 export PERLINSTALLBASE
398 export PERLLIB="$PERLINSTALLBASE/lib/perl5:${PERLLIB:+$PERLLIB}"
401 mkdir -p "$GOPATH/src/git.curoverse.com"
402 ln -sfn "$WORKSPACE" "$GOPATH/src/git.curoverse.com/arvados.git" \
403 || fatal "symlink failed"
405 setup_virtualenv "$VENVDIR" --python python2.7
406 . "$VENVDIR/bin/activate"
408 # Needed for run_test_server.py which is used by certain (non-Python) tests.
409 pip freeze 2>/dev/null | egrep ^PyYAML= \
410 || pip install PyYAML >/dev/null \
411 || fatal "pip install PyYAML failed"
413 # Preinstall forked version of libcloud, because nodemanager "pip install"
414 # won't pick it up by default.
415 pip freeze 2>/dev/null | egrep ^apache-libcloud==$LIBCLOUD_PIN \
416 || pip install --pre --ignore-installed https://github.com/curoverse/libcloud/archive/apache-libcloud-$LIBCLOUD_PIN.zip >/dev/null \
417 || fatal "pip install apache-libcloud failed"
419 # This will help people who reuse --temp dirs when we upgrade to llfuse 0.42
420 if egrep -q 'llfuse.*>= *0\.42' "$WORKSPACE/services/fuse/setup.py"; then
421 # Uninstall old llfuse, because services/fuse "pip install" won't
422 # upgrade it by default.
423 if pip freeze | egrep '^llfuse==0\.41\.'; then
424 yes | pip uninstall 'llfuse<0.42'
428 # Deactivate Python 2 virtualenv
431 # If Python 3 is available, set up its virtualenv in $VENV3DIR.
432 # Otherwise, skip dependent tests.
433 PYTHON3=$(which python3)
434 if [ "0" = "$?" ]; then
435 setup_virtualenv "$VENV3DIR" --python python3
438 skip[services/dockercleaner]=1
441 Warning: python3 could not be found
442 services/dockercleaner install and tests will be skipped
447 # Reactivate Python 2 virtualenv
448 . "$VENVDIR/bin/activate"
450 # Note: this must be the last time we change PATH, otherwise rvm will
452 setup_ruby_environment
456 if ! which bundler >/dev/null
458 gem install --user-install bundler || fatal 'Could not install bundler'
462 while ! ${@} && [[ "$retry" == 1 ]]
464 read -p 'Try again? [Y/n] ' x
465 if [[ "$x" != "y" ]] && [[ "$x" != "" ]]
473 retry do_test_once ${@}
478 if [[ -z "${skip[$1]}" ]] && ( [[ -z "$only" ]] || [[ "$only" == "$1" ]] )
480 title "Running $1 tests"
482 if [[ "$2" == "go" ]]
484 covername="coverage-$(echo "$1" | sed -e 's/\//_/g')"
485 coverflags=("-covermode=count" "-coverprofile=$WORKSPACE/tmp/.$covername.tmp")
486 # We do "go get -t" here to catch compilation errors
487 # before trying "go test". Otherwise, coverage-reporting
488 # mode makes Go show the wrong line numbers when reporting
489 # compilation errors.
490 if [[ -n "${testargs[$1]}" ]]
492 # "go test -check.vv giturl" doesn't work, but this
494 cd "$WORKSPACE/$1" && \
495 go get -t "git.curoverse.com/arvados.git/$1" && \
496 go test ${coverflags[@]} ${testargs[$1]}
498 # The above form gets verbose even when testargs is
499 # empty, so use this form in such cases:
500 go get -t "git.curoverse.com/arvados.git/$1" && \
501 go test ${coverflags[@]} "git.curoverse.com/arvados.git/$1"
504 go tool cover -html="$WORKSPACE/tmp/.$covername.tmp" -o "$WORKSPACE/tmp/$covername.html"
505 rm "$WORKSPACE/tmp/.$covername.tmp"
506 elif [[ "$2" == "pip" ]]
508 # $3 can name a path directory for us to use, including trailing
509 # slash; e.g., the bin/ subdirectory of a virtualenv.
511 && "${3}python" setup.py test ${testargs[$1]}
512 elif [[ "$2" != "" ]]
519 checkexit $result "$1 tests"
520 title "End of $1 tests (`timer`)"
523 title "Skipping $1 tests"
528 retry do_install_once ${@}
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" != "" ]]
565 checkexit $result "$1 install"
566 title "End of $1 install (`timer`)"
569 title "Skipping $1 install"
573 bundle_install_trylocal() {
576 echo "(Running bundle install --local. 'could not find package' messages are OK.)"
577 if ! bundle install --local --no-deployment; then
578 echo "(Running bundle install again, without --local.)"
579 bundle install --no-deployment
586 cd "$WORKSPACE/doc" \
587 && bundle_install_trylocal \
595 with_test_gemset gem_uninstall_if_exists "$gemname" \
596 && cd "$WORKSPACE/$srcpath" \
597 && bundle_install_trylocal \
598 && gem build "$gemname.gemspec" \
599 && with_test_gemset gem install --no-ri --no-rdoc $(ls -t "$gemname"-*.gem|head -n1)
603 install_gem arvados sdk/ruby
605 do_install sdk/ruby ruby_sdk
608 cd "$WORKSPACE/sdk/perl" \
609 && perl Makefile.PL INSTALL_BASE="$PERLINSTALLBASE" \
610 && make install INSTALLDIRS=perl
612 do_install sdk/perl perl_sdk
615 install_gem arvados-cli sdk/cli
617 do_install sdk/cli cli
619 install_login-sync() {
620 install_gem arvados-login-sync services/login-sync
622 do_install services/login-sync login-sync
624 # Install the Python SDK early. Various other test suites (like
625 # keepproxy) bring up run_test_server.py, which imports the arvados
626 # module. We can't actually *test* the Python SDK yet though, because
627 # its own test suite brings up some of those other programs (like
629 declare -a pythonstuff
636 tools/crunchstat-summary
638 for p in "${pythonstuff[@]}"
642 if [ -n "$PYTHON3" ]; then
643 do_install services/dockercleaner pip "$VENV3DIR/bin/"
646 install_apiserver() {
647 cd "$WORKSPACE/services/api" \
648 && RAILS_ENV=test bundle_install_trylocal
650 rm -f config/environments/test.rb
651 cp config/environments/test.rb.example config/environments/test.rb
653 if [ -n "$CONFIGSRC" ]
655 for f in database.yml application.yml
657 cp "$CONFIGSRC/$f" config/ || fatal "$f"
661 # Fill in a random secret_token and blob_signing_key for testing
662 SECRET_TOKEN=`echo 'puts rand(2**512).to_s(36)' |ruby`
663 BLOB_SIGNING_KEY=`echo 'puts rand(2**512).to_s(36)' |ruby`
665 sed -i'' -e "s:SECRET_TOKEN:$SECRET_TOKEN:" config/application.yml
666 sed -i'' -e "s:BLOB_SIGNING_KEY:$BLOB_SIGNING_KEY:" config/application.yml
668 # Set up empty git repo (for git tests)
670 sed -i'' -e "s:/var/cache/git:$GITDIR:" config/application.default.yml
673 mkdir -p $GITDIR/test
676 && git config user.email "jenkins@ci.curoverse.com" \
677 && git config user.name "Jenkins, CI" \
680 && git commit -m 'initial commit'
682 # Clear out any lingering postgresql connections to the test
683 # database, so that we can drop it. This assumes the current user
684 # is a postgresql superuser.
685 cd "$WORKSPACE/services/api" \
686 && test_database=$(python -c "import yaml; print yaml.load(file('config/database.yml'))['test']['database']") \
687 && 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
689 cd "$WORKSPACE/services/api" \
690 && RAILS_ENV=test bundle exec rake db:drop \
691 && RAILS_ENV=test bundle exec rake db:setup \
692 && RAILS_ENV=test bundle exec rake db:fixtures:load
694 do_install services/api apiserver
703 services/arv-git-httpd
709 services/datamanager/summary
710 services/datamanager/collection
711 services/datamanager/keep
713 services/crunch-dispatch-local
714 services/crunch-dispatch-slurm
718 for g in "${gostuff[@]}"
723 install_workbench() {
724 cd "$WORKSPACE/apps/workbench" \
725 && mkdir -p tmp/cache \
726 && RAILS_ENV=test bundle_install_trylocal
728 do_install apps/workbench workbench
730 test_doclinkchecker() {
734 ARVADOS_API_HOST=qr1hi.arvadosapi.com
735 # Make sure python-epydoc is installed or the next line won't
737 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
740 do_test doc doclinkchecker
745 rm -f "$WORKSPACE/services/api/git-commit.version"
746 cd "$WORKSPACE/services/api" \
747 && RAILS_ENV=test bundle exec rake test TESTOPTS=-v ${testargs[services/api]}
749 do_test services/api apiserver
751 # Shortcut for when we're only running apiserver tests. This saves a bit of time,
752 # because we don't need to start up the api server for subsequent tests.
753 if [ ! -z "$only" ] && [ "$only" == "services/api" ]; then
754 rotate_logfile "$WORKSPACE/services/api/log/" "test.log"
761 cd "$WORKSPACE/sdk/ruby" \
762 && bundle exec rake test TESTOPTS=-v ${testargs[sdk/ruby]}
764 do_test sdk/ruby ruby_sdk
767 cd "$WORKSPACE/sdk/cli" \
768 && mkdir -p /tmp/keep \
769 && KEEP_LOCAL_STORE=/tmp/keep bundle exec rake test TESTOPTS=-v ${testargs[sdk/cli]}
774 cd "$WORKSPACE/services/login-sync" \
775 && bundle exec rake test TESTOPTS=-v ${testargs[services/login-sync]}
777 do_test services/login-sync login-sync
779 for p in "${pythonstuff[@]}"
783 do_test services/dockercleaner pip "$VENV3DIR/bin/"
785 for g in "${gostuff[@]}"
791 start_nginx_proxy_services \
792 && cd "$WORKSPACE/apps/workbench" \
793 && RAILS_ENV=test bundle exec rake test TESTOPTS=-v ${testargs[apps/workbench]}
795 do_test apps/workbench workbench
797 test_workbench_benchmark() {
798 start_nginx_proxy_services \
799 && cd "$WORKSPACE/apps/workbench" \
800 && RAILS_ENV=test bundle exec rake test:benchmark ${testargs[apps/workbench_benchmark]}
802 do_test apps/workbench_benchmark workbench_benchmark
804 test_workbench_profile() {
805 start_nginx_proxy_services \
806 && cd "$WORKSPACE/apps/workbench" \
807 && RAILS_ENV=test bundle exec rake test:profile ${testargs[apps/workbench_profile]}
809 do_test apps/workbench_profile workbench_profile