#!/bin/bash
-# Install and test Arvados components.
-#
-# Exit non-zero if any tests fail.
-#
-# Arguments:
-# --skip FOO Do not test the FOO component.
-# --only FOO Do not test anything except the FOO component.
-# envvar=value Set $envvar to value
-#
-# Regardless of which components are tested, install all components in
-# the usual sequence. (Many test suites depend on other components
-# being installed.)
-#
-# To run a specific Ruby test, set $workbench_test, $apiserver_test or
-# $cli_test on the command line:
-#
-# $ run-tests.sh --only workbench workbench_test=TEST=test/integration/pipeline_instances_test.rb
-#
-#
-# To run a specific Python test set $python_sdk_test or $fuse_test.
-#
-# $ run-tests.sh --only python_sdk python_sdk_test="--test-suite tests.test_keep_locator"
-#
-#
-# You can also pass "export ARVADOS_DEBUG=1" to enable additional debugging output:
-#
-# $ run-tests.sh "export ARVADOS_DEBUG=1"
-#
-#
-# Finally, you can skip the installation steps on subsequent runs this way:
-#
-## First run
-# $ run-tests.sh --leave-temp
-#
-## Subsequent runs: record the values of VENVDIR and GOPATH from the first run, and
-# provide them on the command line in subsequent runs:
-#
-# $ run-tests.sh --skip-install VENVDIR="/tmp/tmp.y3tsTmigio" GOPATH="/tmp/tmp.3r4sSA9F3l"
-
-
-# First make sure to remove any ARVADOS_ variables from the calling environment
-# that could interfer with the tests.
+read -rd "\000" helpmessage <<EOF
+$(basename $0): Install and test Arvados components.
+
+Exit non-zero if any tests fail.
+
+Syntax:
+ $(basename $0) WORKSPACE=/path/to/arvados [options]
+
+Options:
+
+--skip FOO Do not test the FOO component.
+--only FOO Do not test anything except the FOO component.
+--leave-temp Do not remove GOPATH, virtualenv, and other temp dirs at exit.
+ Instead, show which directories were used this time so they
+ can be reused in subsequent invocations.
+--skip-install Do not run any install steps. Just run tests.
+ You should provide GOPATH, GEMHOME, and VENVDIR options
+ from a previous invocation if you use this option.
+WORKSPACE=path Arvados source tree to test.
+CONFIGSRC=path Dir with api server config files to copy into source tree.
+ (If none given, leave config files alone in source tree.)
+services/api_test="TEST=test/functional/arvados/v1/collections_controller_test.rb"
+ Restrict apiserver tests to the given file
+sdk/python_test="--test-suite test.test_keep_locator"
+ Restrict Python SDK tests to the given class
+apps/workbench_test="TEST=test/integration/pipeline_instances_test.rb"
+ Restrict Workbench tests to the given file
+ARVADOS_DEBUG=1
+ Print more debug messages
+envvar=value Set \$envvar to value. Primarily useful for WORKSPACE,
+ *_test, and other examples shown above.
+
+Assuming --skip-install is not given, all components are installed
+into \$GOPATH, \$VENDIR, and \$GEMHOME before running any tests. Many
+test suites depend on other components being installed, and installing
+everything tends to be quicker than debugging dependencies.
+
+As a special concession to the current CI server config, CONFIGSRC
+defaults to $HOME/arvados-api-server if that directory exists.
+
+More information and background:
+
+https://arvados.org/projects/arvados/wiki/Running_tests
+
+Available tests:
+
+apps/workbench
+apps/workbench_benchmark
+apps/workbench_profile
+doc
+services/api
+services/crunchstat
+services/fuse
+services/keepproxy
+services/keepstore
+services/nodemanager
+sdk/cli
+sdk/python
+sdk/ruby
+sdk/go/arvadosclient
+sdk/go/keepclient
+sdk/go/streamer
+
+EOF
+
+# First make sure to remove any ARVADOS_ variables from the calling
+# environment that could interfere with the tests.
unset $(env | cut -d= -f1 | grep \^ARVADOS_)
+# Reset other variables that could affect our [tests'] behavior by
+# accident.
+GITDIR=
+GOPATH=
+VENVDIR=
+PYTHONPATH=
+GEMHOME=
+
COLUMNS=80
-export GOPATH=$(mktemp -d)
-VENVDIR=$(mktemp -d)
-cli_test=
-workbench_test=
-apiserver_test=
-python_sdk_test=
-ruby_sdk_test=
-fuse_test=
leave_temp=
skip_install=
-if [[ -f /etc/profile.d/rvm.sh ]]
-then
- source /etc/profile.d/rvm.sh
-fi
+declare -A leave_temp
+clear_temp() {
+ leaving=""
+ for var in VENVDIR GOPATH GITDIR GEMHOME
+ do
+ if [[ -z "${leave_temp[$var]}" ]]
+ then
+ if [[ -n "${!var}" ]]
+ then
+ rm -rf "${!var}"
+ fi
+ else
+ leaving+=" $var=\"${!var}\""
+ fi
+ done
+ if [[ -n "$leaving" ]]; then
+ echo "Leaving behind temp dirs: $leaving"
+ fi
+}
fatal() {
clear_temp
exit 1
}
-# Sanity check
-echo "WORKSPACE=$WORKSPACE"
-[[ -n "$WORKSPACE" ]] || fatal "WORKSPACE not set"
+report_outcomes() {
+ for x in "${successes[@]}"
+ do
+ echo "Pass: $x"
+ done
-# Set up temporary install dirs
-mkdir -p "$GOPATH/src/git.curoverse.com"
-ln -sfn "$WORKSPACE" "$GOPATH/src/git.curoverse.com/arvados.git" \
- || fatal "symlink failed"
+ if [[ ${#failures[@]} == 0 ]]
+ then
+ echo "All test suites passed."
+ else
+ echo "Failures (${#failures[@]}):"
+ for x in "${failures[@]}"
+ do
+ echo "Fail: $x"
+ done
+ fi
+}
-virtualenv --setuptools "$VENVDIR" || fatal "virtualenv $VENVDIR failed"
-PATH="$VENVDIR/bin:$PATH"
+sanity_checks() {
+ # Make sure WORKSPACE is set
+ if ! [[ -n "$WORKSPACE" ]]; then
+ echo >&2 "$helpmessage"
+ echo >&2
+ echo >&2 "Error: WORKSPACE environment variable not set"
+ echo >&2
+ exit 1
+ fi
+
+ # Make sure virtualenv is installed
+ `virtualenv --help >/dev/null 2>&1`
+
+ if [[ "$?" != "0" ]]; then
+ echo >&2
+ echo >&2 "Error: virtualenv could not be found"
+ echo >&2
+ exit 1
+ fi
+
+ # Make sure go is installed
+ `go env >/dev/null 2>&1`
+
+ if [[ "$?" != "0" ]]; then
+ echo >&2
+ echo >&2 "Error: go could not be found"
+ echo >&2
+ exit 1
+ fi
+
+ # Make sure gcc is installed
+ `gcc --help >/dev/null 2>&1`
+
+ if [[ "$?" != "0" ]]; then
+ echo >&2
+ echo >&2 "Error: gcc could not be found"
+ echo >&2
+ exit 1
+ fi
+
+}
declare -a failures
declare -A skip
-
-# Always skip CLI tests. They don't know how to use run_test_server.py.
-skip[cli]=1
+declare -A testargs
+skip[apps/workbench_profile]=1
while [[ -n "$1" ]]
do
arg="$1"; shift
case "$arg" in
+ --help)
+ echo >&2 "$helpmessage"
+ echo >&2
+ exit 1
+ ;;
--skip)
skipwhat="$1"; shift
skip[$skipwhat]=1
;;
--only)
- only="$1"; shift
+ only="$1"; skip[$1]=""; shift
;;
--skip-install)
skip_install=1
;;
--leave-temp)
- leave_temp=1
+ leave_temp[VENVDIR]=1
+ leave_temp[GOPATH]=1
+ leave_temp[GEMHOME]=1
+ ;;
+ *_test=*)
+ suite="${arg%%_test=*}"
+ args="${arg#*=}"
+ testargs["$suite"]="$args"
;;
*=*)
- eval $(echo $arg | cut -d= -f1)=\"$(echo $arg | cut -d= -f2-)\"
+ eval export $(echo $arg | cut -d= -f1)=\"$(echo $arg | cut -d= -f2-)\"
;;
*)
- echo >&2 "$0: Unrecognized option: '$arg'"
+ echo >&2 "$0: Unrecognized option: '$arg'. Try: $0 --help"
exit 1
;;
esac
done
+sanity_checks
+
+echo "WORKSPACE=$WORKSPACE"
+
+if [[ -z "$CONFIGSRC" ]] && [[ -d "$HOME/arvados-api-server" ]]; then
+ # Jenkins expects us to use this by default.
+ CONFIGSRC="$HOME/arvados-api-server"
+fi
+
+# Clean up .pyc files that may exist in the workspace
+cd "$WORKSPACE"
+find -name '*.pyc' -delete
+
+# Set up temporary install dirs (unless existing dirs were supplied)
+for tmpdir in VENVDIR GOPATH GEMHOME
+do
+ if [[ -n "${!tmpdir}" ]]; then
+ leave_temp[$tmpdir]=1
+ else
+ eval $tmpdir=$(mktemp -d)
+ fi
+done
+
+setup_ruby_environment() {
+ if [[ -s "$HOME/.rvm/scripts/rvm" ]] ; then
+ source "$HOME/.rvm/scripts/rvm"
+ using_rvm=true
+ elif [[ -s "/usr/local/rvm/scripts/rvm" ]] ; then
+ source "/usr/local/rvm/scripts/rvm"
+ using_rvm=true
+ else
+ using_rvm=false
+ fi
+
+ if [[ "$using_rvm" == true ]]; then
+ # If rvm is in use, we can't just put separate "dependencies"
+ # and "gems-under-test" paths to GEM_PATH: passenger resets
+ # the environment to the "current gemset", which would lose
+ # our GEM_PATH and prevent our test suites from running ruby
+ # programs (for example, the Workbench test suite could not
+ # boot an API server or run arv). Instead, we have to make an
+ # rvm gemset and use it for everything.
+
+ [[ `type rvm | head -n1` == "rvm is a function" ]] \
+ || fatal 'rvm check'
+
+ # Put rvm's favorite path back in first place (overriding
+ # virtualenv, which just put itself there). Ignore rvm's
+ # complaint about not being in first place already.
+ rvm use @default 2>/dev/null
+
+ # Create (if needed) and switch to an @arvados-tests
+ # gemset. (Leave the choice of ruby to the caller.)
+ rvm use @arvados-tests --create \
+ || fatal 'rvm gemset setup'
+
+ rvm env
+ else
+ # When our "bundle install"s need to install new gems to
+ # satisfy dependencies, we want them to go where "gem install
+ # --user-install" would put them. (However, if the caller has
+ # already set GEM_HOME, we assume that's where dependencies
+ # should be installed, and we should leave it alone.)
+
+ if [ -z "$GEM_HOME" ]; then
+ user_gempath="$(gem env gempath)"
+ export GEM_HOME="${user_gempath%%:*}"
+ fi
+ PATH="$(gem env gemdir)/bin:$PATH"
+
+ # When we build and install our own gems, we install them in our
+ # $GEMHOME tmpdir, and we want them to be at the front of GEM_PATH and
+ # PATH so integration tests prefer them over other versions that
+ # happen to be installed in $user_gempath, system dirs, etc.
+
+ tmpdir_gem_home="$(env - PATH="$PATH" HOME="$GEMHOME" gem env gempath | cut -f1 -d:)"
+ PATH="$tmpdir_gem_home/bin:$PATH"
+ export GEM_PATH="$tmpdir_gem_home:$(gem env gempath)"
+
+ echo "Will install dependencies to $(gem env gemdir)"
+ echo "Will install arvados gems to $tmpdir_gem_home"
+ echo "Gem search path is GEM_PATH=$GEM_PATH"
+ fi
+}
+
+with_test_gemset() {
+ if [[ "$using_rvm" == true ]]; then
+ "$@"
+ else
+ GEM_HOME="$tmpdir_gem_home" "$@"
+ fi
+}
+
+export GOPATH
+mkdir -p "$GOPATH/src/git.curoverse.com"
+ln -sfn "$WORKSPACE" "$GOPATH/src/git.curoverse.com/arvados.git" \
+ || fatal "symlink failed"
+
+virtualenv --setuptools "$VENVDIR" || fatal "virtualenv $VENVDIR failed"
+. "$VENVDIR/bin/activate"
+
+# Note: this must be the last time we change PATH, otherwise rvm will
+# whine a lot.
+setup_ruby_environment
+
+echo "PATH is $PATH"
+
+if ! which bundler >/dev/null
+then
+ gem install --user-install bundler || fatal 'Could not install bundler'
+fi
+
+# Needed for run_test_server.py which is used by certain (non-Python) tests.
+pip install PyYAML || fatal "pip install PyYAML failed"
+
checkexit() {
if [[ "$?" != "0" ]]; then
title "!!!!!! $1 FAILED !!!!!!"
timer_reset
if [[ "$2" == "go" ]]
then
- go test -timeout 20s "git.curoverse.com/arvados.git/$1"
+ go test ${testargs[$1]} "git.curoverse.com/arvados.git/$1"
+ elif [[ "$2" == "pip" ]]
+ then
+ cd "$WORKSPACE/$1" \
+ && python setup.py test ${testargs[$1]}
+ elif [[ "$2" != "" ]]
+ then
+ "test_$2"
else
"test_$1"
fi
timer_reset
if [[ "$2" == "go" ]]
then
- pip install pyyaml
go get -t "git.curoverse.com/arvados.git/$1"
+ elif [[ "$2" == "pip" ]]
+ then
+ cd "$WORKSPACE/$1" \
+ && python setup.py sdist rotate --keep=1 --match .tar.gz \
+ && pip install --upgrade dist/*.tar.gz
+ elif [[ "$2" != "" ]]
+ then
+ "install_$2"
else
"install_$1"
fi
printf "\n%*s%s\n\n" $((($COLUMNS-${#txt})/2)) "" "$txt"
}
-clear_temp() {
- if [[ -z "$leave_temp" ]]
- then
- for t in "$VENVDIR" "$GOPATH"
- do
- if [[ -n "$t" ]]
- then
- rm -rf "$t"
- fi
- done
- else
- echo "Leaving VENVDIR=\"$VENVDIR\""
- echo "Leaving GOPATH=\"$GOPATH\""
- fi
-}
-
-test_docs() {
+install_doc() {
cd "$WORKSPACE/doc"
bundle install --no-deployment
rm -rf .site
- # Make sure python-epydoc is installed or the next line won't do much good!
- ARVADOS_API_HOST=qr1hi.arvadosapi.com
- PYTHONPATH=$WORKSPACE/sdk/python/ bundle exec rake generate baseurl=file://$WORKSPACE/doc/.site/ arvados_workbench_host=workbench.$ARVADOS_API_HOST arvados_api_host=$ARVADOS_API_HOST
- unset ARVADOS_API_HOST
-}
-do_test docs
-
-test_doclinkchecker() {
- cd "$WORKSPACE/doc"
- bundle exec rake linkchecker baseurl=file://$WORKSPACE/doc/.site/
}
-do_test doclinkchecker
-
-test_ruby_sdk() {
- cd "$WORKSPACE/sdk/ruby" \
- && bundle install --no-deployment \
- && bundle exec rake test
-}
-do_test ruby_sdk
+do_install doc
install_ruby_sdk() {
- cd "$WORKSPACE/sdk/ruby" \
+ with_test_gemset gem uninstall --force --all --executables arvados \
+ && cd "$WORKSPACE/sdk/ruby" \
+ && bundle install --no-deployment \
&& gem build arvados.gemspec \
- && gem install --no-ri --no-rdoc `ls -t arvados-*.gem|head -n1`
+ && with_test_gemset gem install --no-ri --no-rdoc `ls -t arvados-*.gem|head -n1`
}
-do_install ruby_sdk
+do_install sdk/ruby ruby_sdk
install_cli() {
- cd "$WORKSPACE/sdk/cli" \
- && gem build arvados-cli.gemspec \
- && gem install --no-ri --no-rdoc `ls -t arvados-cli-*.gem|head -n1`
-}
-do_install cli
-
-test_cli() {
- title "Starting SDK CLI tests"
- cd "$WORKSPACE/sdk/cli" \
+ with_test_gemset gem uninstall --force --all --executables arvados-cli \
+ && cd "$WORKSPACE/sdk/cli" \
&& bundle install --no-deployment \
- && mkdir -p /tmp/keep \
- && KEEP_LOCAL_STORE=/tmp/keep bundle exec rake test $cli_test
+ && gem build arvados-cli.gemspec \
+ && with_test_gemset gem install --no-ri --no-rdoc `ls -t arvados-cli-*.gem|head -n1`
}
-do_test cli
+do_install sdk/cli cli
+
+# Install the Python SDK early. Various other test suites (like
+# keepproxy) bring up run_test_server.py, which imports the arvados
+# module. We can't actually *test* the Python SDK yet though, because
+# its own test suite brings up some of those other programs (like
+# keepproxy).
+declare -a pythonstuff
+pythonstuff=(
+ sdk/python
+ services/fuse
+ services/nodemanager
+ )
+for p in "${pythonstuff[@]}"
+do
+ do_install "$p" pip
+done
install_apiserver() {
cd "$WORKSPACE/services/api"
- bundle install --no-deployment
+ RAILS_ENV=test bundle install --no-deployment
rm -f config/environments/test.rb
cp config/environments/test.rb.example config/environments/test.rb
- cp $HOME/arvados-api-server/database.yml config/ || fatal "database.yml"
- cp $HOME/arvados-api-server/application.yml config/ || fatal "application.yml"
+ if [ -n "$CONFIGSRC" ]
+ then
+ for f in database.yml application.yml
+ do
+ cp "$CONFIGSRC/$f" config/ || fatal "$f"
+ done
+ fi
# Fill in a random secret_token and blob_signing_key for testing
SECRET_TOKEN=`echo 'puts rand(2**512).to_s(36)' |ruby`
sed -i'' -e "s:SECRET_TOKEN:$SECRET_TOKEN:" config/application.yml
sed -i'' -e "s:BLOB_SIGNING_KEY:$BLOB_SIGNING_KEY:" config/application.yml
- export RAILS_ENV=test
-
# Set up empty git repo (for git tests)
- GITDIR="$WORKSPACE/tmpgit"
+ GITDIR=$(mktemp -d)
sed -i'' -e "s:/var/cache/git:$GITDIR:" config/application.default.yml
rm -rf $GITDIR
psql arvados_test -c "SELECT pg_terminate_backend (pg_stat_activity.procpid::int) FROM pg_stat_activity WHERE pg_stat_activity.datname = 'arvados_test';" 2>/dev/null
cd "$WORKSPACE/services/api" \
- && bundle exec rake db:drop \
- && bundle exec rake db:create \
- && bundle exec rake db:setup
-}
-do_install apiserver
-
-test_apiserver() {
- cd "$WORKSPACE/services/api"
- bundle exec rake test $apiserver_test
+ && RAILS_ENV=test bundle exec rake db:drop \
+ && RAILS_ENV=test bundle exec rake db:setup \
+ && RAILS_ENV=test bundle exec rake db:fixtures:load
}
-do_test apiserver
+do_install services/api apiserver
declare -a gostuff
gostuff=(
+ services/crunchstat
services/keepstore
services/keepproxy
sdk/go/arvadosclient
do_install "$g" go
done
-install_python_sdk() {
- # Install the Python SDK early. Various other test suites (like
- # keepproxy) bring up run_test_server.py, which imports the arvados
- # module. We can't actually *test* the Python SDK yet though, because
- # its own test suite brings up some of those other programs (like
- # keepproxy).
+install_workbench() {
+ cd "$WORKSPACE/apps/workbench" \
+ && RAILS_ENV=test bundle install --no-deployment
+}
+do_install apps/workbench workbench
- cd "$WORKSPACE/sdk/python" \
- && python setup.py egg_info -b ".$(git log --format=format:%ct.%h -n1 .)" sdist rotate --keep=1 --match .tar.gz \
- && pip install dist/arvados-python-client-0.1.*.tar.gz
+test_doclinkchecker() {
+ cd "$WORKSPACE/doc"
+ # Make sure python-epydoc is installed or the next line won't do much good!
+ ARVADOS_API_HOST=qr1hi.arvadosapi.com
+ PYTHONPATH=$WORKSPACE/sdk/python/ bundle exec rake linkchecker baseurl=file://$WORKSPACE/doc/.site/ arvados_workbench_host=workbench.$ARVADOS_API_HOST arvados_api_host=$ARVADOS_API_HOST
+ unset ARVADOS_API_HOST
}
-do_install python_sdk
+do_test doc doclinkchecker
-install_fuse() {
- cd "$WORKSPACE/services/fuse" \
- && python setup.py egg_info -b ".$(git log --format=format:%ct.%h -n1 .)" sdist rotate --keep=1 --match .tar.gz \
- && pip install dist/arvados_fuse-0.1.*.tar.gz
+test_ruby_sdk() {
+ cd "$WORKSPACE/sdk/ruby" \
+ && bundle install --no-deployment \
+ && bundle exec rake test ${testargs[sdk/ruby]}
}
-do_install fuse
-
-test_python_sdk() {
- # Python SDK. We test this before testing keepproxy: keepproxy runs
- # run_test_server.py, which depends on the yaml package, which is in
- # tests_require but not install_requires, and therefore does not get
- # installed by setuptools until we run "setup.py test" *and* install
- # the .egg files that setup.py downloads.
-
- cd "$WORKSPACE/sdk/python" \
- && python setup.py test $python_sdk_test
- r=$?
- easy_install *.egg
- return $r
+do_test sdk/ruby ruby_sdk
+
+test_cli() {
+ cd "$WORKSPACE/sdk/cli" \
+ && bundle install --no-deployment \
+ && mkdir -p /tmp/keep \
+ && KEEP_LOCAL_STORE=/tmp/keep bundle exec rake test ${testargs[sdk/cli]}
}
-do_test python_sdk
-
-test_fuse() {
- # Install test dependencies here too, in case run_test_server needs them.
- cd "$WORKSPACE/services/fuse" \
- && python setup.py test $fuse_test
- r=$?
- easy_install *.egg
- return $r
+do_test sdk/cli cli
+
+test_apiserver() {
+ cd "$WORKSPACE/services/api"
+ RAILS_ENV=test bundle exec rake test ${testargs[services/api]}
}
-do_test fuse
+do_test services/api apiserver
+
+for p in "${pythonstuff[@]}"
+do
+ do_test "$p" pip
+done
for g in "${gostuff[@]}"
do
test_workbench() {
cd "$WORKSPACE/apps/workbench" \
- && bundle install --no-deployment \
- && bundle exec rake test $workbench_test
+ && RAILS_ENV=test bundle exec rake test ${testargs[apps/workbench]}
}
-do_test workbench
+do_test apps/workbench workbench
-clear_temp
+test_workbench_benchmark() {
+ cd "$WORKSPACE/apps/workbench" \
+ && RAILS_ENV=test bundle exec rake test:benchmark ${testargs[apps/workbench_benchmark]}
+}
+do_test apps/workbench_benchmark workbench_benchmark
-for x in "${successes[@]}"
-do
- echo "Pass: $x"
-done
+test_workbench_profile() {
+ cd "$WORKSPACE/apps/workbench" \
+ && RAILS_ENV=test bundle exec rake test:profile ${testargs[apps/workbench_profile]}
+}
+do_test apps/workbench_profile workbench_profile
+
+report_outcomes
+clear_temp
-if [[ ${#failures[@]} == 0 ]]
-then
- echo "All test suites passed."
-else
- echo "Failures (${#failures[@]}):"
- for x in "${failures[@]}"
- do
- echo "Fail: $x"
- done
-fi
exit ${#failures}