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
90 tools/keep-block-check
94 # First make sure to remove any ARVADOS_ variables from the calling
95 # environment that could interfere with the tests.
96 unset $(env | cut -d= -f1 | grep \^ARVADOS_)
98 # Reset other variables that could affect our [tests'] behavior by
113 if [[ -z "$temp" ]]; then
114 # we didn't even get as far as making a temp dir
116 elif [[ -z "$temp_preserve" ]]; then
119 echo "Leaving behind temp dirs in $temp"
125 echo >&2 "Fatal: $* (encountered in ${FUNCNAME[1]} at ${BASH_SOURCE[1]} line ${BASH_LINENO[0]})"
131 create-plot-data-from-log.sh $BUILD_NUMBER "$WORKSPACE/apps/workbench/log/test.log" "$WORKSPACE/apps/workbench/log/"
132 rotate_logfile "$WORKSPACE/apps/workbench/log/" "test.log"
134 rotate_logfile "$WORKSPACE/services/api/log/" "test.log"
141 ( [[ -n "$WORKSPACE" ]] && [[ -d "$WORKSPACE/services" ]] ) \
142 || fatal "WORKSPACE environment variable not set to a source directory (see: $0 --help)"
143 echo Checking dependencies:
144 echo -n 'virtualenv: '
145 virtualenv --version \
146 || fatal "No virtualenv. Try: apt-get install virtualenv (on ubuntu: python-virtualenv)"
149 || fatal "No go binary. See http://golang.org/doc/install"
151 gcc --version | egrep ^gcc \
152 || fatal "No gcc. Try: apt-get install build-essential"
154 find /usr/include -wholename '*fuse/fuse.h' \
155 || fatal "No fuse/fuse.h. Try: apt-get install libfuse-dev"
156 echo -n 'pyconfig.h: '
157 find /usr/include -name pyconfig.h | egrep --max-count=1 . \
158 || fatal "No pyconfig.h. Try: apt-get install python-dev"
160 PATH="$PATH:/sbin:/usr/sbin:/usr/local/sbin" nginx -v \
161 || fatal "No nginx. Try: apt-get install nginx"
163 perl -v | grep version \
164 || fatal "No perl. Try: apt-get install perl"
165 for mod in ExtUtils::MakeMaker JSON LWP Net::SSL; do
166 echo -n "perl $mod: "
167 perl -e "use $mod; print \"\$$mod::VERSION\\n\"" \
168 || fatal "No $mod. Try: apt-get install perl-modules libcrypt-ssleay-perl libjson-perl libwww-perl"
172 || fatal "No gitolite. Try: apt-get install gitolite3"
176 # i.e. rotate_logfile "$WORKSPACE/apps/workbench/log/" "test.log"
177 # $BUILD_NUMBER is set by Jenkins if this script is being called as part of a Jenkins run
178 if [[ -f "$1/$2" ]]; then
179 THEDATE=`date +%Y%m%d%H%M%S`
180 mv "$1/$2" "$1/$THEDATE-$BUILD_NUMBER-$2"
181 gzip "$1/$THEDATE-$BUILD_NUMBER-$2"
188 skip[apps/workbench_profile]=1
195 echo >&2 "$helpmessage"
204 only="$1"; skip[$1]=""; shift
211 only_install="$1"; shift
224 suite="${arg%%_test=*}"
226 testargs["$suite"]="$args"
229 eval export $(echo $arg | cut -d= -f1)=\"$(echo $arg | cut -d= -f2-)\"
232 echo >&2 "$0: Unrecognized option: '$arg'. Try: $0 --help"
239 echo 'Starting API server...'
241 && eval $(python sdk/python/tests/run_test_server.py start --auth admin) \
242 && export ARVADOS_TEST_API_HOST="$ARVADOS_API_HOST" \
243 && export ARVADOS_TEST_API_INSTALLED="$$" \
244 && (env | egrep ^ARVADOS)
247 start_nginx_proxy_services() {
248 echo 'Starting keepproxy, keep-web, arv-git-httpd, and nginx ssl proxy...'
250 && python sdk/python/tests/run_test_server.py start_keep_proxy \
251 && python sdk/python/tests/run_test_server.py start_keep-web \
252 && python sdk/python/tests/run_test_server.py start_arv-git-httpd \
253 && python sdk/python/tests/run_test_server.py start_nginx \
254 && export ARVADOS_TEST_PROXY_SERVICES=1
258 if [[ -n "$ARVADOS_TEST_PROXY_SERVICES" ]]; then
259 unset ARVADOS_TEST_PROXY_SERVICES
261 && python sdk/python/tests/run_test_server.py stop_nginx \
262 && python sdk/python/tests/run_test_server.py stop_arv-git-httpd \
263 && python sdk/python/tests/run_test_server.py stop_keep-web \
264 && python sdk/python/tests/run_test_server.py stop_keep_proxy
266 if [[ -n "$ARVADOS_TEST_API_HOST" ]]; then
267 unset ARVADOS_TEST_API_HOST
269 && python sdk/python/tests/run_test_server.py stop
274 failures+=("($(basename $0) interrupted)")
281 echo "WORKSPACE=$WORKSPACE"
283 if [[ -z "$CONFIGSRC" ]] && [[ -d "$HOME/arvados-api-server" ]]; then
284 # Jenkins expects us to use this by default.
285 CONFIGSRC="$HOME/arvados-api-server"
288 # Clean up .pyc files that may exist in the workspace
290 find -name '*.pyc' -delete
292 if [[ -z "$temp" ]]; then
296 # Set up temporary install dirs (unless existing dirs were supplied)
297 for tmpdir in VENVDIR VENV3DIR GOPATH GEMHOME PERLINSTALLBASE
299 if [[ -z "${!tmpdir}" ]]; then
300 eval "$tmpdir"="$temp/$tmpdir"
302 if ! [[ -d "${!tmpdir}" ]]; then
303 mkdir "${!tmpdir}" || fatal "can't create ${!tmpdir} (does $temp exist?)"
307 setup_ruby_environment() {
308 if [[ -s "$HOME/.rvm/scripts/rvm" ]] ; then
309 source "$HOME/.rvm/scripts/rvm"
311 elif [[ -s "/usr/local/rvm/scripts/rvm" ]] ; then
312 source "/usr/local/rvm/scripts/rvm"
318 if [[ "$using_rvm" == true ]]; then
319 # If rvm is in use, we can't just put separate "dependencies"
320 # and "gems-under-test" paths to GEM_PATH: passenger resets
321 # the environment to the "current gemset", which would lose
322 # our GEM_PATH and prevent our test suites from running ruby
323 # programs (for example, the Workbench test suite could not
324 # boot an API server or run arv). Instead, we have to make an
325 # rvm gemset and use it for everything.
327 [[ `type rvm | head -n1` == "rvm is a function" ]] \
330 # Put rvm's favorite path back in first place (overriding
331 # virtualenv, which just put itself there). Ignore rvm's
332 # complaint about not being in first place already.
333 rvm use @default 2>/dev/null
335 # Create (if needed) and switch to an @arvados-tests
336 # gemset. (Leave the choice of ruby to the caller.)
337 rvm use @arvados-tests --create \
338 || fatal 'rvm gemset setup'
342 # When our "bundle install"s need to install new gems to
343 # satisfy dependencies, we want them to go where "gem install
344 # --user-install" would put them. (However, if the caller has
345 # already set GEM_HOME, we assume that's where dependencies
346 # should be installed, and we should leave it alone.)
348 if [ -z "$GEM_HOME" ]; then
349 user_gempath="$(gem env gempath)"
350 export GEM_HOME="${user_gempath%%:*}"
352 PATH="$(gem env gemdir)/bin:$PATH"
354 # When we build and install our own gems, we install them in our
355 # $GEMHOME tmpdir, and we want them to be at the front of GEM_PATH and
356 # PATH so integration tests prefer them over other versions that
357 # happen to be installed in $user_gempath, system dirs, etc.
359 tmpdir_gem_home="$(env - PATH="$PATH" HOME="$GEMHOME" gem env gempath | cut -f1 -d:)"
360 PATH="$tmpdir_gem_home/bin:$PATH"
361 export GEM_PATH="$tmpdir_gem_home:$(gem env gempath)"
363 echo "Will install dependencies to $(gem env gemdir)"
364 echo "Will install arvados gems to $tmpdir_gem_home"
365 echo "Gem search path is GEM_PATH=$GEM_PATH"
370 if [[ "$using_rvm" == true ]]; then
373 GEM_HOME="$tmpdir_gem_home" GEM_PATH="$tmpdir_gem_home" "$@"
377 gem_uninstall_if_exists() {
378 if gem list "$1\$" | egrep '^\w'; then
379 gem uninstall --force --all --executables "$1"
384 local venvdest="$1"; shift
385 if ! [[ -e "$venvdest/bin/activate" ]] || ! [[ -e "$venvdest/bin/pip" ]]; then
386 virtualenv --setuptools "$@" "$venvdest" || fatal "virtualenv $venvdest failed"
388 "$venvdest/bin/pip" install 'setuptools>=18' 'pip>=7'
389 # ubuntu1404 can't seem to install mock via tests_require, but it can do this.
390 "$venvdest/bin/pip" install 'mock>=1.0' 'pbr<1.7.0'
393 export PERLINSTALLBASE
394 export PERLLIB="$PERLINSTALLBASE/lib/perl5:${PERLLIB:+$PERLLIB}"
397 mkdir -p "$GOPATH/src/git.curoverse.com"
398 ln -sfn "$WORKSPACE" "$GOPATH/src/git.curoverse.com/arvados.git" \
399 || fatal "symlink failed"
401 setup_virtualenv "$VENVDIR" --python python2.7
402 . "$VENVDIR/bin/activate"
404 # Needed for run_test_server.py which is used by certain (non-Python) tests.
405 pip freeze 2>/dev/null | egrep ^PyYAML= \
406 || pip install PyYAML >/dev/null \
407 || fatal "pip install PyYAML failed"
409 # Preinstall forked version of libcloud, because nodemanager "pip install"
410 # won't pick it up by default.
411 pip freeze 2>/dev/null | egrep ^apache-libcloud==$LIBCLOUD_PIN \
412 || pip install --pre --ignore-installed https://github.com/curoverse/libcloud/archive/apache-libcloud-$LIBCLOUD_PIN.zip >/dev/null \
413 || fatal "pip install apache-libcloud failed"
415 # This will help people who reuse --temp dirs when we upgrade to llfuse 0.42
416 if egrep -q 'llfuse.*>= *0\.42' "$WORKSPACE/services/fuse/setup.py"; then
417 # Uninstall old llfuse, because services/fuse "pip install" won't
418 # upgrade it by default.
419 if pip freeze | egrep '^llfuse==0\.41\.'; then
420 yes | pip uninstall 'llfuse<0.42'
424 # Deactivate Python 2 virtualenv
427 # If Python 3 is available, set up its virtualenv in $VENV3DIR.
428 # Otherwise, skip dependent tests.
429 PYTHON3=$(which python3)
430 if [ "0" = "$?" ]; then
431 setup_virtualenv "$VENV3DIR" --python python3
434 skip[services/dockercleaner]=1
437 Warning: python3 could not be found
438 services/dockercleaner install and tests will be skipped
443 # Reactivate Python 2 virtualenv
444 . "$VENVDIR/bin/activate"
446 # Note: this must be the last time we change PATH, otherwise rvm will
448 setup_ruby_environment
452 if ! which bundler >/dev/null
454 gem install --user-install bundler || fatal 'Could not install bundler'
458 while ! ${@} && [[ "$retry" == 1 ]]
460 read -p 'Try again? [Y/n] ' x
461 if [[ "$x" != "y" ]] && [[ "$x" != "" ]]
469 retry do_test_once ${@}
474 if [[ -z "${skip[$1]}" ]] && ( [[ -z "$only" ]] || [[ "$only" == "$1" ]] )
476 title "Running $1 tests"
478 if [[ "$2" == "go" ]]
480 covername="coverage-$(echo "$1" | sed -e 's/\//_/g')"
481 coverflags=("-covermode=count" "-coverprofile=$WORKSPACE/tmp/.$covername.tmp")
482 # We do "go get -t" here to catch compilation errors
483 # before trying "go test". Otherwise, coverage-reporting
484 # mode makes Go show the wrong line numbers when reporting
485 # compilation errors.
486 if [[ -n "${testargs[$1]}" ]]
488 # "go test -check.vv giturl" doesn't work, but this
490 cd "$WORKSPACE/$1" && \
491 go get -t "git.curoverse.com/arvados.git/$1" && \
492 go test ${coverflags[@]} ${testargs[$1]}
494 # The above form gets verbose even when testargs is
495 # empty, so use this form in such cases:
496 go get -t "git.curoverse.com/arvados.git/$1" && \
497 go test ${coverflags[@]} "git.curoverse.com/arvados.git/$1"
500 go tool cover -html="$WORKSPACE/tmp/.$covername.tmp" -o "$WORKSPACE/tmp/$covername.html"
501 rm "$WORKSPACE/tmp/.$covername.tmp"
502 elif [[ "$2" == "pip" ]]
504 # $3 can name a path directory for us to use, including trailing
505 # slash; e.g., the bin/ subdirectory of a virtualenv.
507 && "${3}python" setup.py test ${testargs[$1]}
508 elif [[ "$2" != "" ]]
515 checkexit $result "$1 tests"
516 title "End of $1 tests (`timer`)"
519 title "Skipping $1 tests"
524 retry do_install_once ${@}
528 if [[ -z "$skip_install" || (-n "$only_install" && "$only_install" == "$1") ]]
530 title "Running $1 install"
532 if [[ "$2" == "go" ]]
534 go get -t "git.curoverse.com/arvados.git/$1"
535 elif [[ "$2" == "pip" ]]
537 # $3 can name a path directory for us to use, including trailing
538 # slash; e.g., the bin/ subdirectory of a virtualenv.
540 # Need to change to a different directory after creating
541 # the source dist package to avoid a pip bug.
542 # see https://arvados.org/issues/5766 for details.
544 # Also need to install twice, because if it believes the package is
545 # already installed, pip it won't install it. So the first "pip
546 # install" ensures that the dependencies are met, the second "pip
547 # install" ensures that we've actually installed the local package
550 && "${3}python" setup.py sdist rotate --keep=1 --match .tar.gz \
552 && "${3}pip" install --quiet "$WORKSPACE/$1/dist"/*.tar.gz \
553 && "${3}pip" install --quiet --no-deps --ignore-installed "$WORKSPACE/$1/dist"/*.tar.gz
554 elif [[ "$2" != "" ]]
561 checkexit $result "$1 install"
562 title "End of $1 install (`timer`)"
565 title "Skipping $1 install"
569 bundle_install_trylocal() {
572 echo "(Running bundle install --local. 'could not find package' messages are OK.)"
573 if ! bundle install --local --no-deployment; then
574 echo "(Running bundle install again, without --local.)"
575 bundle install --no-deployment
582 cd "$WORKSPACE/doc" \
583 && bundle_install_trylocal \
591 with_test_gemset gem_uninstall_if_exists "$gemname" \
592 && cd "$WORKSPACE/$srcpath" \
593 && bundle_install_trylocal \
594 && gem build "$gemname.gemspec" \
595 && with_test_gemset gem install --no-ri --no-rdoc $(ls -t "$gemname"-*.gem|head -n1)
599 install_gem arvados sdk/ruby
601 do_install sdk/ruby ruby_sdk
604 cd "$WORKSPACE/sdk/perl" \
605 && perl Makefile.PL INSTALL_BASE="$PERLINSTALLBASE" \
606 && make install INSTALLDIRS=perl
608 do_install sdk/perl perl_sdk
611 install_gem arvados-cli sdk/cli
613 do_install sdk/cli cli
615 install_login-sync() {
616 install_gem arvados-login-sync services/login-sync
618 do_install services/login-sync login-sync
620 # Install the Python SDK early. Various other test suites (like
621 # keepproxy) bring up run_test_server.py, which imports the arvados
622 # module. We can't actually *test* the Python SDK yet though, because
623 # its own test suite brings up some of those other programs (like
625 declare -a pythonstuff
632 tools/crunchstat-summary
634 for p in "${pythonstuff[@]}"
638 if [ -n "$PYTHON3" ]; then
639 do_install services/dockercleaner pip "$VENV3DIR/bin/"
642 install_apiserver() {
643 cd "$WORKSPACE/services/api" \
644 && RAILS_ENV=test bundle_install_trylocal
646 rm -f config/environments/test.rb
647 cp config/environments/test.rb.example config/environments/test.rb
649 if [ -n "$CONFIGSRC" ]
651 for f in database.yml application.yml
653 cp "$CONFIGSRC/$f" config/ || fatal "$f"
657 # Fill in a random secret_token and blob_signing_key for testing
658 SECRET_TOKEN=`echo 'puts rand(2**512).to_s(36)' |ruby`
659 BLOB_SIGNING_KEY=`echo 'puts rand(2**512).to_s(36)' |ruby`
661 sed -i'' -e "s:SECRET_TOKEN:$SECRET_TOKEN:" config/application.yml
662 sed -i'' -e "s:BLOB_SIGNING_KEY:$BLOB_SIGNING_KEY:" config/application.yml
664 # Set up empty git repo (for git tests)
666 sed -i'' -e "s:/var/cache/git:$GITDIR:" config/application.default.yml
669 mkdir -p $GITDIR/test
672 && git config user.email "jenkins@ci.curoverse.com" \
673 && git config user.name "Jenkins, CI" \
676 && git commit -m 'initial commit'
678 # Clear out any lingering postgresql connections to the test
679 # database, so that we can drop it. This assumes the current user
680 # is a postgresql superuser.
681 cd "$WORKSPACE/services/api" \
682 && test_database=$(python -c "import yaml; print yaml.load(file('config/database.yml'))['test']['database']") \
683 && 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
685 cd "$WORKSPACE/services/api" \
686 && RAILS_ENV=test bundle exec rake db:drop \
687 && RAILS_ENV=test bundle exec rake db:setup \
688 && RAILS_ENV=test bundle exec rake db:fixtures:load
690 do_install services/api apiserver
699 services/arv-git-httpd
705 services/datamanager/summary
706 services/datamanager/collection
707 services/datamanager/keep
709 services/crunch-dispatch-local
710 services/crunch-dispatch-slurm
713 tools/keep-block-check
715 for g in "${gostuff[@]}"
720 install_workbench() {
721 cd "$WORKSPACE/apps/workbench" \
722 && mkdir -p tmp/cache \
723 && RAILS_ENV=test bundle_install_trylocal
725 do_install apps/workbench workbench
727 test_doclinkchecker() {
731 ARVADOS_API_HOST=qr1hi.arvadosapi.com
732 # Make sure python-epydoc is installed or the next line won't
734 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
737 do_test doc doclinkchecker
742 rm -f "$WORKSPACE/services/api/git-commit.version"
743 cd "$WORKSPACE/services/api" \
744 && RAILS_ENV=test bundle exec rake test TESTOPTS=-v ${testargs[services/api]}
746 do_test services/api apiserver
748 # Shortcut for when we're only running apiserver tests. This saves a bit of time,
749 # because we don't need to start up the api server for subsequent tests.
750 if [ ! -z "$only" ] && [ "$only" == "services/api" ]; then
751 rotate_logfile "$WORKSPACE/services/api/log/" "test.log"
758 cd "$WORKSPACE/sdk/ruby" \
759 && bundle exec rake test TESTOPTS=-v ${testargs[sdk/ruby]}
761 do_test sdk/ruby ruby_sdk
764 cd "$WORKSPACE/sdk/cli" \
765 && mkdir -p /tmp/keep \
766 && KEEP_LOCAL_STORE=/tmp/keep bundle exec rake test TESTOPTS=-v ${testargs[sdk/cli]}
771 cd "$WORKSPACE/services/login-sync" \
772 && bundle exec rake test TESTOPTS=-v ${testargs[services/login-sync]}
774 do_test services/login-sync login-sync
776 for p in "${pythonstuff[@]}"
780 do_test services/dockercleaner pip "$VENV3DIR/bin/"
782 for g in "${gostuff[@]}"
788 start_nginx_proxy_services \
789 && cd "$WORKSPACE/apps/workbench" \
790 && RAILS_ENV=test bundle exec rake test TESTOPTS=-v ${testargs[apps/workbench]}
792 do_test apps/workbench workbench
794 test_workbench_benchmark() {
795 start_nginx_proxy_services \
796 && cd "$WORKSPACE/apps/workbench" \
797 && RAILS_ENV=test bundle exec rake test:benchmark ${testargs[apps/workbench_benchmark]}
799 do_test apps/workbench_benchmark workbench_benchmark
801 test_workbench_profile() {
802 start_nginx_proxy_services \
803 && cd "$WORKSPACE/apps/workbench" \
804 && RAILS_ENV=test bundle exec rake test:profile ${testargs[apps/workbench_profile]}
806 do_test apps/workbench_profile workbench_profile