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
72 services/crunch-dispatch-local
73 services/crunch-dispatch-slurm
85 tools/crunchstat-summary
90 # First make sure to remove any ARVADOS_ variables from the calling
91 # environment that could interfere with the tests.
92 unset $(env | cut -d= -f1 | grep \^ARVADOS_)
94 # Reset other variables that could affect our [tests'] behavior by
111 if [[ -z "$temp" ]]; then
112 # we didn't even get as far as making a temp dir
114 elif [[ -z "$temp_preserve" ]]; then
117 echo "Leaving behind temp dirs in $temp"
123 echo >&2 "Fatal: $* (encountered in ${FUNCNAME[1]} at ${BASH_SOURCE[1]} line ${BASH_LINENO[0]})"
128 for x in "${successes[@]}"
133 if [[ ${#failures[@]} == 0 ]]
135 echo "All test suites passed."
137 echo "Failures (${#failures[@]}):"
138 for x in "${failures[@]}"
147 create-plot-data-from-log.sh $BUILD_NUMBER "$WORKSPACE/apps/workbench/log/test.log" "$WORKSPACE/apps/workbench/log/"
148 rotate_logfile "$WORKSPACE/apps/workbench/log/" "test.log"
150 rotate_logfile "$WORKSPACE/services/api/log/" "test.log"
157 ( [[ -n "$WORKSPACE" ]] && [[ -d "$WORKSPACE/services" ]] ) \
158 || fatal "WORKSPACE environment variable not set to a source directory (see: $0 --help)"
159 echo Checking dependencies:
160 echo -n 'virtualenv: '
161 virtualenv --version \
162 || fatal "No virtualenv. Try: apt-get install virtualenv (on ubuntu: python-virtualenv)"
165 || fatal "No go binary. See http://golang.org/doc/install"
167 gcc --version | egrep ^gcc \
168 || fatal "No gcc. Try: apt-get install build-essential"
170 find /usr/include -wholename '*fuse/fuse.h' \
171 || fatal "No fuse/fuse.h. Try: apt-get install libfuse-dev"
172 echo -n 'pyconfig.h: '
173 find /usr/include -name pyconfig.h | egrep --max-count=1 . \
174 || fatal "No pyconfig.h. Try: apt-get install python-dev"
176 PATH="$PATH:/sbin:/usr/sbin:/usr/local/sbin" nginx -v \
177 || fatal "No nginx. Try: apt-get install nginx"
179 perl -v | grep version \
180 || fatal "No perl. Try: apt-get install perl"
181 for mod in ExtUtils::MakeMaker JSON LWP Net::SSL; do
182 echo -n "perl $mod: "
183 perl -e "use $mod; print \"\$$mod::VERSION\\n\"" \
184 || fatal "No $mod. Try: apt-get install perl-modules libcrypt-ssleay-perl libjson-perl libwww-perl"
188 || fatal "No gitolite. Try: apt-get install gitolite3"
192 # i.e. rotate_logfile "$WORKSPACE/apps/workbench/log/" "test.log"
193 # $BUILD_NUMBER is set by Jenkins if this script is being called as part of a Jenkins run
194 if [[ -f "$1/$2" ]]; then
195 THEDATE=`date +%Y%m%d%H%M%S`
196 mv "$1/$2" "$1/$THEDATE-$BUILD_NUMBER-$2"
197 gzip "$1/$THEDATE-$BUILD_NUMBER-$2"
204 skip[apps/workbench_profile]=1
211 echo >&2 "$helpmessage"
220 only="$1"; skip[$1]=""; shift
227 only_install="$1"; shift
240 suite="${arg%%_test=*}"
242 testargs["$suite"]="$args"
245 eval export $(echo $arg | cut -d= -f1)=\"$(echo $arg | cut -d= -f2-)\"
248 echo >&2 "$0: Unrecognized option: '$arg'. Try: $0 --help"
255 echo 'Starting API server...'
257 && eval $(python sdk/python/tests/run_test_server.py start --auth admin) \
258 && export ARVADOS_TEST_API_HOST="$ARVADOS_API_HOST" \
259 && export ARVADOS_TEST_API_INSTALLED="$$" \
260 && (env | egrep ^ARVADOS)
263 start_nginx_proxy_services() {
264 echo 'Starting keepproxy, keep-web, arv-git-httpd, and nginx ssl proxy...'
266 && python sdk/python/tests/run_test_server.py start_keep_proxy \
267 && python sdk/python/tests/run_test_server.py start_keep-web \
268 && python sdk/python/tests/run_test_server.py start_arv-git-httpd \
269 && python sdk/python/tests/run_test_server.py start_nginx \
270 && export ARVADOS_TEST_PROXY_SERVICES=1
274 if [[ -n "$ARVADOS_TEST_PROXY_SERVICES" ]]; then
275 unset ARVADOS_TEST_PROXY_SERVICES
277 && python sdk/python/tests/run_test_server.py stop_nginx \
278 && python sdk/python/tests/run_test_server.py stop_arv-git-httpd \
279 && python sdk/python/tests/run_test_server.py stop_keep-web \
280 && python sdk/python/tests/run_test_server.py stop_keep_proxy
282 if [[ -n "$ARVADOS_TEST_API_HOST" ]]; then
283 unset ARVADOS_TEST_API_HOST
285 && python sdk/python/tests/run_test_server.py stop
290 failures+=("($(basename $0) interrupted)")
297 echo "WORKSPACE=$WORKSPACE"
299 if [[ -z "$CONFIGSRC" ]] && [[ -d "$HOME/arvados-api-server" ]]; then
300 # Jenkins expects us to use this by default.
301 CONFIGSRC="$HOME/arvados-api-server"
304 # Clean up .pyc files that may exist in the workspace
306 find -name '*.pyc' -delete
308 if [[ -z "$temp" ]]; then
312 # Set up temporary install dirs (unless existing dirs were supplied)
313 for tmpdir in VENVDIR VENV3DIR GOPATH GEMHOME PERLINSTALLBASE
315 if [[ -z "${!tmpdir}" ]]; then
316 eval "$tmpdir"="$temp/$tmpdir"
318 if ! [[ -d "${!tmpdir}" ]]; then
319 mkdir "${!tmpdir}" || fatal "can't create ${!tmpdir} (does $temp exist?)"
323 setup_ruby_environment() {
324 if [[ -s "$HOME/.rvm/scripts/rvm" ]] ; then
325 source "$HOME/.rvm/scripts/rvm"
327 elif [[ -s "/usr/local/rvm/scripts/rvm" ]] ; then
328 source "/usr/local/rvm/scripts/rvm"
334 if [[ "$using_rvm" == true ]]; then
335 # If rvm is in use, we can't just put separate "dependencies"
336 # and "gems-under-test" paths to GEM_PATH: passenger resets
337 # the environment to the "current gemset", which would lose
338 # our GEM_PATH and prevent our test suites from running ruby
339 # programs (for example, the Workbench test suite could not
340 # boot an API server or run arv). Instead, we have to make an
341 # rvm gemset and use it for everything.
343 [[ `type rvm | head -n1` == "rvm is a function" ]] \
346 # Put rvm's favorite path back in first place (overriding
347 # virtualenv, which just put itself there). Ignore rvm's
348 # complaint about not being in first place already.
349 rvm use @default 2>/dev/null
351 # Create (if needed) and switch to an @arvados-tests
352 # gemset. (Leave the choice of ruby to the caller.)
353 rvm use @arvados-tests --create \
354 || fatal 'rvm gemset setup'
358 # When our "bundle install"s need to install new gems to
359 # satisfy dependencies, we want them to go where "gem install
360 # --user-install" would put them. (However, if the caller has
361 # already set GEM_HOME, we assume that's where dependencies
362 # should be installed, and we should leave it alone.)
364 if [ -z "$GEM_HOME" ]; then
365 user_gempath="$(gem env gempath)"
366 export GEM_HOME="${user_gempath%%:*}"
368 PATH="$(gem env gemdir)/bin:$PATH"
370 # When we build and install our own gems, we install them in our
371 # $GEMHOME tmpdir, and we want them to be at the front of GEM_PATH and
372 # PATH so integration tests prefer them over other versions that
373 # happen to be installed in $user_gempath, system dirs, etc.
375 tmpdir_gem_home="$(env - PATH="$PATH" HOME="$GEMHOME" gem env gempath | cut -f1 -d:)"
376 PATH="$tmpdir_gem_home/bin:$PATH"
377 export GEM_PATH="$tmpdir_gem_home:$(gem env gempath)"
379 echo "Will install dependencies to $(gem env gemdir)"
380 echo "Will install arvados gems to $tmpdir_gem_home"
381 echo "Gem search path is GEM_PATH=$GEM_PATH"
386 if [[ "$using_rvm" == true ]]; then
389 GEM_HOME="$tmpdir_gem_home" GEM_PATH="$tmpdir_gem_home" "$@"
393 gem_uninstall_if_exists() {
394 if gem list "$1\$" | egrep '^\w'; then
395 gem uninstall --force --all --executables "$1"
400 local venvdest="$1"; shift
401 if ! [[ -e "$venvdest/bin/activate" ]] || ! [[ -e "$venvdest/bin/pip" ]]; then
402 virtualenv --setuptools "$@" "$venvdest" || fatal "virtualenv $venvdest failed"
404 "$venvdest/bin/pip" install 'setuptools>=18' 'pip>=7'
405 # ubuntu1404 can't seem to install mock via tests_require, but it can do this.
406 "$venvdest/bin/pip" install 'mock>=1.0' 'pbr<1.7.0'
409 export PERLINSTALLBASE
410 export PERLLIB="$PERLINSTALLBASE/lib/perl5:${PERLLIB:+$PERLLIB}"
413 mkdir -p "$GOPATH/src/git.curoverse.com"
414 ln -sfn "$WORKSPACE" "$GOPATH/src/git.curoverse.com/arvados.git" \
415 || fatal "symlink failed"
417 setup_virtualenv "$VENVDIR" --python python2.7
418 . "$VENVDIR/bin/activate"
420 # Needed for run_test_server.py which is used by certain (non-Python) tests.
421 pip freeze 2>/dev/null | egrep ^PyYAML= \
422 || pip install PyYAML >/dev/null \
423 || fatal "pip install PyYAML failed"
425 # Preinstall forked version of libcloud, because nodemanager "pip install"
426 # won't pick it up by default.
427 pip freeze 2>/dev/null | egrep ^apache-libcloud==$LIBCLOUD_PIN \
428 || pip install --pre --ignore-installed https://github.com/curoverse/libcloud/archive/apache-libcloud-$LIBCLOUD_PIN.zip >/dev/null \
429 || fatal "pip install apache-libcloud failed"
431 # This will help people who reuse --temp dirs when we upgrade to llfuse 0.42
432 if egrep -q 'llfuse.*>= *0\.42' "$WORKSPACE/services/fuse/setup.py"; then
433 # Uninstall old llfuse, because services/fuse "pip install" won't
434 # upgrade it by default.
435 if pip freeze | egrep '^llfuse==0\.41\.'; then
436 yes | pip uninstall 'llfuse<0.42'
440 # Deactivate Python 2 virtualenv
443 # If Python 3 is available, set up its virtualenv in $VENV3DIR.
444 # Otherwise, skip dependent tests.
445 PYTHON3=$(which python3)
446 if [ "0" = "$?" ]; then
447 setup_virtualenv "$VENV3DIR" --python python3
450 skip[services/dockercleaner]=1
453 Warning: python3 could not be found
454 services/dockercleaner install and tests will be skipped
459 # Reactivate Python 2 virtualenv
460 . "$VENVDIR/bin/activate"
462 # Note: this must be the last time we change PATH, otherwise rvm will
464 setup_ruby_environment
468 if ! which bundler >/dev/null
470 gem install --user-install bundler || fatal 'Could not install bundler'
474 if [[ "$1" != "0" ]]; then
475 title "!!!!!! $2 FAILED !!!!!!"
476 failures+=("$2 (`timer`)")
478 successes+=("$2 (`timer`)")
487 echo -n "$(($SECONDS - $t0))s"
491 while ! ${@} && [[ "$retry" == 1 ]]
493 read -p 'Try again? [Y/n] ' x
494 if [[ "$x" != "y" ]] && [[ "$x" != "" ]]
502 retry do_test_once ${@}
507 if [[ -z "${skip[$1]}" ]] && ( [[ -z "$only" ]] || [[ "$only" == "$1" ]] )
509 title "Running $1 tests"
511 if [[ "$2" == "go" ]]
513 covername="coverage-$(echo "$1" | sed -e 's/\//_/g')"
514 coverflags=("-covermode=count" "-coverprofile=$WORKSPACE/tmp/.$covername.tmp")
515 # We do "go get -t" here to catch compilation errors
516 # before trying "go test". Otherwise, coverage-reporting
517 # mode makes Go show the wrong line numbers when reporting
518 # compilation errors.
519 if [[ -n "${testargs[$1]}" ]]
521 # "go test -check.vv giturl" doesn't work, but this
523 cd "$WORKSPACE/$1" && \
524 go get -t "git.curoverse.com/arvados.git/$1" && \
525 go test ${coverflags[@]} ${testargs[$1]}
527 # The above form gets verbose even when testargs is
528 # empty, so use this form in such cases:
529 go get -t "git.curoverse.com/arvados.git/$1" && \
530 go test ${coverflags[@]} "git.curoverse.com/arvados.git/$1"
533 go tool cover -html="$WORKSPACE/tmp/.$covername.tmp" -o "$WORKSPACE/tmp/$covername.html"
534 rm "$WORKSPACE/tmp/.$covername.tmp"
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 && "${3}python" setup.py test ${testargs[$1]}
541 elif [[ "$2" != "" ]]
548 checkexit $result "$1 tests"
549 title "End of $1 tests (`timer`)"
552 title "Skipping $1 tests"
557 retry do_install_once ${@}
561 if [[ -z "$skip_install" || (-n "$only_install" && "$only_install" == "$1") ]]
563 title "Running $1 install"
565 if [[ "$2" == "go" ]]
567 go get -t "git.curoverse.com/arvados.git/$1"
568 elif [[ "$2" == "pip" ]]
570 # $3 can name a path directory for us to use, including trailing
571 # slash; e.g., the bin/ subdirectory of a virtualenv.
573 # Need to change to a different directory after creating
574 # the source dist package to avoid a pip bug.
575 # see https://arvados.org/issues/5766 for details.
577 # Also need to install twice, because if it believes the package is
578 # already installed, pip it won't install it. So the first "pip
579 # install" ensures that the dependencies are met, the second "pip
580 # install" ensures that we've actually installed the local package
583 && "${3}python" setup.py sdist rotate --keep=1 --match .tar.gz \
585 && "${3}pip" install --quiet "$WORKSPACE/$1/dist"/*.tar.gz \
586 && "${3}pip" install --quiet --no-deps --ignore-installed "$WORKSPACE/$1/dist"/*.tar.gz
587 elif [[ "$2" != "" ]]
594 checkexit $result "$1 install"
595 title "End of $1 install (`timer`)"
598 title "Skipping $1 install"
603 txt="********** $1 **********"
604 printf "\n%*s%s\n\n" $((($COLUMNS-${#txt})/2)) "" "$txt"
607 bundle_install_trylocal() {
610 echo "(Running bundle install --local. 'could not find package' messages are OK.)"
611 if ! bundle install --local --no-deployment; then
612 echo "(Running bundle install again, without --local.)"
613 bundle install --no-deployment
620 cd "$WORKSPACE/doc" \
621 && bundle_install_trylocal \
629 with_test_gemset gem_uninstall_if_exists "$gemname" \
630 && cd "$WORKSPACE/$srcpath" \
631 && bundle_install_trylocal \
632 && gem build "$gemname.gemspec" \
633 && with_test_gemset gem install --no-ri --no-rdoc $(ls -t "$gemname"-*.gem|head -n1)
637 install_gem arvados sdk/ruby
639 do_install sdk/ruby ruby_sdk
642 cd "$WORKSPACE/sdk/perl" \
643 && perl Makefile.PL INSTALL_BASE="$PERLINSTALLBASE" \
644 && make install INSTALLDIRS=perl
646 do_install sdk/perl perl_sdk
649 install_gem arvados-cli sdk/cli
651 do_install sdk/cli cli
653 install_login-sync() {
654 install_gem arvados-login-sync services/login-sync
656 do_install services/login-sync login-sync
658 # Install the Python SDK early. Various other test suites (like
659 # keepproxy) bring up run_test_server.py, which imports the arvados
660 # module. We can't actually *test* the Python SDK yet though, because
661 # its own test suite brings up some of those other programs (like
663 declare -a pythonstuff
670 tools/crunchstat-summary
672 for p in "${pythonstuff[@]}"
676 if [ -n "$PYTHON3" ]; then
677 do_install services/dockercleaner pip "$VENV3DIR/bin/"
680 install_apiserver() {
681 cd "$WORKSPACE/services/api" \
682 && RAILS_ENV=test bundle_install_trylocal
684 rm -f config/environments/test.rb
685 cp config/environments/test.rb.example config/environments/test.rb
687 if [ -n "$CONFIGSRC" ]
689 for f in database.yml application.yml
691 cp "$CONFIGSRC/$f" config/ || fatal "$f"
695 # Fill in a random secret_token and blob_signing_key for testing
696 SECRET_TOKEN=`echo 'puts rand(2**512).to_s(36)' |ruby`
697 BLOB_SIGNING_KEY=`echo 'puts rand(2**512).to_s(36)' |ruby`
699 sed -i'' -e "s:SECRET_TOKEN:$SECRET_TOKEN:" config/application.yml
700 sed -i'' -e "s:BLOB_SIGNING_KEY:$BLOB_SIGNING_KEY:" config/application.yml
702 # Set up empty git repo (for git tests)
704 sed -i'' -e "s:/var/cache/git:$GITDIR:" config/application.default.yml
707 mkdir -p $GITDIR/test
710 && git config user.email "jenkins@ci.curoverse.com" \
711 && git config user.name "Jenkins, CI" \
714 && git commit -m 'initial commit'
716 # Clear out any lingering postgresql connections to the test
717 # database, so that we can drop it. This assumes the current user
718 # is a postgresql superuser.
719 cd "$WORKSPACE/services/api" \
720 && test_database=$(python -c "import yaml; print yaml.load(file('config/database.yml'))['test']['database']") \
721 && 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
723 cd "$WORKSPACE/services/api" \
724 && RAILS_ENV=test bundle exec rake db:drop \
725 && RAILS_ENV=test bundle exec rake db:setup \
726 && RAILS_ENV=test bundle exec rake db:fixtures:load
728 do_install services/api apiserver
737 services/arv-git-httpd
743 services/datamanager/summary
744 services/datamanager/collection
745 services/datamanager/keep
747 services/crunch-dispatch-local
748 services/crunch-dispatch-slurm
752 for g in "${gostuff[@]}"
757 install_workbench() {
758 cd "$WORKSPACE/apps/workbench" \
759 && mkdir -p tmp/cache \
760 && RAILS_ENV=test bundle_install_trylocal
762 do_install apps/workbench workbench
764 test_doclinkchecker() {
768 ARVADOS_API_HOST=qr1hi.arvadosapi.com
769 # Make sure python-epydoc is installed or the next line won't
771 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
774 do_test doc doclinkchecker
779 rm -f "$WORKSPACE/services/api/git-commit.version"
780 cd "$WORKSPACE/services/api" \
781 && RAILS_ENV=test bundle exec rake test TESTOPTS=-v ${testargs[services/api]}
783 do_test services/api apiserver
785 # Shortcut for when we're only running apiserver tests. This saves a bit of time,
786 # because we don't need to start up the api server for subsequent tests.
787 if [ ! -z "$only" ] && [ "$only" == "services/api" ]; then
788 rotate_logfile "$WORKSPACE/services/api/log/" "test.log"
795 cd "$WORKSPACE/sdk/ruby" \
796 && bundle exec rake test TESTOPTS=-v ${testargs[sdk/ruby]}
798 do_test sdk/ruby ruby_sdk
801 cd "$WORKSPACE/sdk/cli" \
802 && mkdir -p /tmp/keep \
803 && KEEP_LOCAL_STORE=/tmp/keep bundle exec rake test TESTOPTS=-v ${testargs[sdk/cli]}
808 cd "$WORKSPACE/services/login-sync" \
809 && bundle exec rake test TESTOPTS=-v ${testargs[services/login-sync]}
811 do_test services/login-sync login-sync
813 for p in "${pythonstuff[@]}"
817 do_test services/dockercleaner pip "$VENV3DIR/bin/"
819 for g in "${gostuff[@]}"
825 start_nginx_proxy_services \
826 && cd "$WORKSPACE/apps/workbench" \
827 && RAILS_ENV=test bundle exec rake test TESTOPTS=-v ${testargs[apps/workbench]}
829 do_test apps/workbench workbench
831 test_workbench_benchmark() {
832 start_nginx_proxy_services \
833 && cd "$WORKSPACE/apps/workbench" \
834 && RAILS_ENV=test bundle exec rake test:benchmark ${testargs[apps/workbench_benchmark]}
836 do_test apps/workbench_benchmark workbench_benchmark
838 test_workbench_profile() {
839 start_nginx_proxy_services \
840 && cd "$WORKSPACE/apps/workbench" \
841 && RAILS_ENV=test bundle exec rake test:profile ${testargs[apps/workbench_profile]}
843 do_test apps/workbench_profile workbench_profile