#!/bin/bash
-EXITCODE=0
+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.)
+apiserver_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
+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
+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
-ARVADOS_API_HOST=qr1hi.arvadosapi.com
-
-title () {
- printf "\n%*s\n\n" $(((${#title}+$COLUMNS)/2)) "********** $1 **********"
-}
-
-source /etc/profile.d/rvm.sh
-echo $WORKSPACE
-
-export GOPATH=$(mktemp -d)
-mkdir -p "$GOPATH/src/git.curoverse.com"
-ln -sfn "$WORKSPACE" "$GOPATH/src/git.curoverse.com/arvados.git"
-
-VENVDIR=$(mktemp -d)
-virtualenv --setuptools "$VENVDIR"
-PATH="$VENVDIR/bin:$PATH"
-
-# DOCS
-title "Starting DOC build"
-cd "$WORKSPACE"
-cd doc
-bundle install --deployment
-rm -rf .site
-# Make sure python-epydoc is installed or the next line won't do much good!
-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
-
-checkexit() {
- ECODE=$?
-
- if [[ "$ECODE" != "0" ]]; then
- title "!!!!!! $1 FAILED !!!!!!"
- EXITCODE=$(($EXITCODE + $ECODE))
+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
}
-goget() {
- go get -t "git.curoverse.com/arvados.git/$1"
- checkexit "$1 install"
+fatal() {
+ clear_temp
+ echo >&2 "Fatal: $* in ${FUNCNAME[1]} at ${BASH_SOURCE[1]} line ${BASH_LINENO[0]}"
+ exit 1
}
-gotest() {
- title "Starting $1 tests"
- cd "$WORKSPACE"
-
- go test "git.curoverse.com/arvados.git/$1"
-
- checkexit "$1 tests"
- title "$1 tests complete"
+report_outcomes() {
+ for x in "${successes[@]}"
+ do
+ echo "Pass: $x"
+ done
+
+ if [[ ${#failures[@]} == 0 ]]
+ then
+ echo "All test suites passed."
+ else
+ echo "Failures (${#failures[@]}):"
+ for x in "${failures[@]}"
+ do
+ echo "Fail: $x"
+ done
+ fi
}
+declare -a failures
+declare -A skip
+declare -A testargs
-checkexit "Doc build"
-title "DOC build complete"
+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
+ ;;
+ --skip-install)
+ skip_install=1
+ ;;
+ --leave-temp)
+ leave_temp[VENVDIR]=1
+ leave_temp[GOPATH]=1
+ leave_temp[GEMHOME]=1
+ ;;
+ *_test=*)
+ suite="${arg%%_test=*}"
+ args="${arg#*=}"
+ testargs["$suite"]="$args"
+ ;;
+ *=*)
+ eval export $(echo $arg | cut -d= -f1)=\"$(echo $arg | cut -d= -f2-)\"
+ ;;
+ *)
+ echo >&2 "$0: Unrecognized option: '$arg'. Try: $0 --help"
+ exit 1
+ ;;
+ esac
+done
-# DOC linkchecker
-title "Starting DOC linkchecker"
-cd "$WORKSPACE"
-cd doc
-bundle exec rake linkchecker baseurl=file://$WORKSPACE/doc/.site/
+# Sanity check
+if ! [[ -n "$WORKSPACE" ]]; then
+ echo >&2 "$helpmessage"
+ echo >&2
+ echo >&2 "Error: WORKSPACE environment variable not set"
+ echo >&2
+ exit 1
+fi
-checkexit "Doc linkchecker"
-title "DOC linkchecker complete"
+echo "WORKSPACE=$WORKSPACE"
-# API SERVER
-title "Starting API server tests"
-cd "$WORKSPACE"
-cd services/api
-bundle install --deployment
-
-rm -f config/database.yml
-rm -f config/environments/test.rb
-cp config/environments/test.rb.example config/environments/test.rb
-
-# Get test database config
-cp $HOME/arvados-api-server/database.yml config/
-# Get test application.yml file
-cp $HOME/arvados-api-server/application.yml config/
-
-# Fill in a random secret_token and blob_signing_key for testing
-SECRET_TOKEN=`echo 'puts rand(2**512).to_s(36)' |ruby`
-BLOB_SIGNING_KEY=`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
-rm -rf $GITDIR
-mkdir $GITDIR
-sed -i'' -e "s:/var/cache/git:$GITDIR:" config/application.default.yml
-
-rm -rf $GITDIR
-mkdir -p $GITDIR/test
-cd $GITDIR/test
-/usr/bin/git init
-/usr/bin/git config user.email "jenkins@ci.curoverse.com"
-/usr/bin/git config user.name "Jenkins, CI"
-touch tmp
-/usr/bin/git add tmp
-/usr/bin/git commit -m 'initial commit'
+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"
-cd services/api
-
-bundle exec rake db:drop
-bundle exec rake db:create
-bundle exec rake db:setup
-bundle exec rake test
-
-checkexit "API server tests"
-title "API server tests complete"
-
-# Install CLI gem's dependencies.
+find -name '*.pyc' -delete
-cd "$WORKSPACE/sdk/cli"
-bundle install --deployment
-
-cd "$WORKSPACE"
-gostuff="services/keepstore services/keepproxy sdk/go/arvadosclient sdk/go/keepclient sdk/go/streamer"
-for dir in $gostuff
+# Set up temporary install dirs (unless existing dirs were supplied)
+for tmpdir in VENVDIR GOPATH GEMHOME
do
- goget "$dir"
+ if [[ -n "${!tmpdir}" ]]; then
+ leave_temp[$tmpdir]=1
+ else
+ eval $tmpdir=$(mktemp -d)
+ fi
done
-# 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).
-
-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
-
-checkexit "Python SDK install"
-
-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
+# 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. If rvm is in use (or something else has set
+# GEM_HOME) we assume "bundle install" already does something
+# reasonable.
+
+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 "PATH=$PATH"
+echo "Will install dependencies to $GEM_HOME"
+echo "Will install arvados gems to $tmpdir_gem_home"
+echo "Gem search path is GEM_PATH=$GEM_PATH"
+
+if ! which bundler >/dev/null
+then
+ gem install --user-install bundler || fatal 'Could not install bundler'
+fi
+
+export GOPATH
+mkdir -p "$GOPATH/src/git.curoverse.com"
+ln -sfn "$WORKSPACE" "$GOPATH/src/git.curoverse.com/arvados.git" \
+ || fatal "symlink failed"
-checkexit "FUSE install"
+virtualenv --setuptools "$VENVDIR" || fatal "virtualenv $VENVDIR failed"
+. "$VENVDIR/bin/activate"
-# 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.
+# Needed for run_test_server.py which is used by certain (non-Python) tests.
+pip install PyYAML
-title "Starting Python SDK tests"
-cd "$WORKSPACE/sdk/python"
+checkexit() {
+ if [[ "$?" != "0" ]]; then
+ title "!!!!!! $1 FAILED !!!!!!"
+ failures+=("$1 (`timer`)")
+ else
+ successes+=("$1 (`timer`)")
+ fi
+}
-python setup.py test
-checkexit "Python SDK tests"
-easy_install *.egg
+timer_reset() {
+ t0=$SECONDS
+}
-title "Python tests complete"
+timer() {
+ echo -n "$(($SECONDS - $t0))s"
+}
-# FUSE driver
+do_test() {
+ if [[ -z "${skip[$1]}" ]] && ( [[ -z "$only" ]] || [[ "$only" == "$1" ]] )
+ then
+ title "Running $1 tests"
+ timer_reset
+ if [[ "$2" == "go" ]]
+ then
+ go test "git.curoverse.com/arvados.git/$1"
+ elif [[ "$2" == "pip" ]]
+ then
+ # Other test suites can depend on tests_require
+ # dependencies of this package. For example, keepproxy runs
+ # run_test_server.py, which depends on the yaml package,
+ # which is in sdk/python's 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/$1" \
+ && python setup.py test ${testargs[$1]} \
+ && (easy_install *.egg || true)
+ else
+ "test_$1"
+ fi
+ checkexit "$1 tests"
+ title "End of $1 tests (`timer`)"
+ else
+ title "Skipping $1 tests"
+ fi
+}
-title "Starting FUSE tests"
-cd "$WORKSPACE/services/fuse"
+do_install() {
+ if [[ -z "$skip_install" ]]
+ then
+ title "Running $1 install"
+ timer_reset
+ if [[ "$2" == "go" ]]
+ then
+ 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
+ else
+ "install_$1"
+ fi
+ checkexit "$1 install"
+ title "End of $1 install (`timer`)"
+ else
+ title "Skipping $1 install"
+ fi
+}
-python setup.py test
-checkexit "FUSE tests"
-easy_install *.egg
+title () {
+ txt="********** $1 **********"
+ printf "\n%*s%s\n\n" $((($COLUMNS-${#txt})/2)) "" "$txt"
+}
-title "FUSE tests complete"
+install_docs() {
+ 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_install docs
+install_ruby_sdk() {
+ cd "$WORKSPACE/sdk/ruby" \
+ && bundle install --no-deployment \
+ && gem build arvados.gemspec \
+ && GEM_HOME="$tmpdir_gem_home" gem install --user-install --no-ri --no-rdoc `ls -t arvados-*.gem|head -n1`
+}
+do_install ruby_sdk
-# Go SDK packages
+install_cli() {
+ cd "$WORKSPACE/sdk/cli" \
+ && bundle install --no-deployment \
+ && gem build arvados-cli.gemspec \
+ && GEM_HOME="$tmpdir_gem_home" gem install --user-install --no-ri --no-rdoc `ls -t arvados-cli-*.gem|head -n1`
+}
+do_install cli
-for dir in $gostuff
+# 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
- gotest "$dir"
+ do_install "$p" pip
done
-# Workbench
-title "Starting workbench tests"
-cd "$WORKSPACE"
-cd apps/workbench
-bundle install --deployment
+install_apiserver() {
+ cd "$WORKSPACE/services/api"
+ export RAILS_ENV=test
+ bundle install --no-deployment
-echo $PATH
+ rm -f config/environments/test.rb
+ cp config/environments/test.rb.example config/environments/test.rb
-bundle exec rake test
+ if [ -n "$CONFIGSRC" ]
+ then
+ for f in database.yml application.yml
+ do
+ cp "$CONFIGSRC/$f" config/ || fatal "$f"
+ done
+ fi
-checkexit "Workbench tests"
-title "Workbench tests complete"
+ # Fill in a random secret_token and blob_signing_key for testing
+ SECRET_TOKEN=`echo 'puts rand(2**512).to_s(36)' |ruby`
+ BLOB_SIGNING_KEY=`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
+
+ # Set up empty git repo (for git tests)
+ GITDIR=$(mktemp -d)
+ sed -i'' -e "s:/var/cache/git:$GITDIR:" config/application.default.yml
+
+ rm -rf $GITDIR
+ mkdir -p $GITDIR/test
+ cd $GITDIR/test \
+ && git init \
+ && git config user.email "jenkins@ci.curoverse.com" \
+ && git config user.name "Jenkins, CI" \
+ && touch tmp \
+ && git add tmp \
+ && git commit -m 'initial commit'
+
+ # Clear out any lingering postgresql connections to arvados_test, so that we can drop it
+ # This assumes the current user is a postgresql superuser
+ 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
+
+declare -a gostuff
+gostuff=(
+ services/crunchstat
+ services/keepstore
+ services/keepproxy
+ sdk/go/arvadosclient
+ sdk/go/keepclient
+ sdk/go/streamer
+ )
+for g in "${gostuff[@]}"
+do
+ do_install "$g" go
+done
-# Clean up temporary virtualenv and GOPATH
-rm -rf "$VENVDIR"
-rm -rf "$GOPATH"
+test_doclinkchecker() {
+ cd "$WORKSPACE/doc"
+ bundle exec rake linkchecker baseurl=file://$WORKSPACE/doc/.site/
+}
+do_test doclinkchecker
-# The CLI SDK tests require a working API server, so let's skip those for now.
-exit $EXITCODE
+test_ruby_sdk() {
+ cd "$WORKSPACE/sdk/ruby" \
+ && bundle install --no-deployment \
+ && bundle exec rake test ${testargs[sdk/ruby]}
+}
+do_test ruby_sdk
+
+test_cli() {
+ title "Starting SDK CLI tests"
+ 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 cli
-########################################################################
+test_apiserver() {
+ cd "$WORKSPACE/services/api"
+ bundle exec rake test ${testargs[apiserver]}
+}
+do_test apiserver
-# CLI SDK
-title "Starting SDK CLI tests"
-cd "$WORKSPACE"
-cd sdk/cli
-bundle install --deployment
+# We must test sdk/python before testing services/keepproxy, because
+# keepproxy depends on sdk/python's test dependencies.
+for p in "${pythonstuff[@]}"
+do
+ do_test "$p" pip
+done
-# Set up Python SDK and dependencies
-cd ../python
-rm -rf $HOME/lib/python
-mkdir $HOME/lib/python
-PYTHONPATH="$HOME/lib/python" easy_install --install-dir=$HOME/lib/python --upgrade google-api-python-client
-PYTHONPATH="$HOME/lib/python" python setup.py install --home=$HOME
+for g in "${gostuff[@]}"
+do
+ do_test "$g" go
+done
-cd ../cli
-mkdir -p /tmp/keep
-export KEEP_LOCAL_STORE=/tmp/keep
-PYTHONPATH="$HOME/lib/python" bundle exec rake test
+test_workbench() {
+ cd "$WORKSPACE/apps/workbench" \
+ && bundle install --no-deployment \
+ && bundle exec rake test ${testargs[workbench]}
+}
+do_test workbench
-checkexit "SDK CLI tests"
-title "SDK CLI tests complete"
+report_outcomes
+clear_temp
-exit $EXITCODE
+exit ${#failures}