build/run-tests.sh

   1 #!/bin/bash
   2 # Copyright (C) The Arvados Authors. All rights reserved.
   3 #
   4 # SPDX-License-Identifier: AGPL-3.0
   5
   6 COLUMNS=80
   7 . `dirname "$(readlink -f "$0")"`/run-library.sh
   8
   9 read -rd "\000" helpmessage <<EOF
  10 $(basename $0): Install and test Arvados components.
  11
  12 Exit non-zero if any tests fail.
  13
  14 Syntax:
  15         $(basename $0) WORKSPACE=/path/to/arvados [options]
  16
  17 Options:
  18
  19 --skip FOO     Do not test the FOO component.
  20 --skip sanity  Skip initial dev environment sanity checks.
  21 --skip install Do not run any install steps. Just run tests.
  22                You should provide GOPATH, GEMHOME, and VENVDIR options
  23                from a previous invocation if you use this option.
  24 --only FOO     Do not test anything except the FOO component.
  25 --temp DIR     Install components and dependencies under DIR instead of
  26                making a new temporary directory. Implies --leave-temp.
  27 --leave-temp   Do not remove GOPATH, virtualenv, and other temp dirs at exit.
  28                Instead, show the path to give as --temp to reuse them in
  29                subsequent invocations.
  30 --repeat N     Repeat each install/test step until it succeeds N times.
  31 --retry        Prompt to retry if an install or test suite fails.
  32 --only-install Run specific install step
  33 --short        Skip (or scale down) some slow tests.
  34 --interactive  Set up, then prompt for test/install steps to perform.
  35 WORKSPACE=path Arvados source tree to test.
  36 CONFIGSRC=path Dir with config.yml file containing PostgreSQL section for use by tests.
  37 services/api_test="TEST=test/functional/arvados/v1/collections_controller_test.rb"
  38                Restrict apiserver tests to the given file
  39 sdk/python_test="--test-suite tests.test_keep_locator"
  40                Restrict Python SDK tests to the given class
  41 services/githttpd_test="-check.vv"
  42                Show all log messages, even when tests pass (also works
  43                with services/keepstore_test etc.)
  44 ARVADOS_DEBUG=1
  45                Print more debug messages
  46 envvar=value   Set \$envvar to value. Primarily useful for WORKSPACE,
  47                *_test, and other examples shown above.
  48
  49 Assuming "--skip install" is not given, all components are installed
  50 into \$GOPATH, \$VENDIR, and \$GEMHOME before running any tests. Many
  51 test suites depend on other components being installed, and installing
  52 everything tends to be quicker than debugging dependencies.
  53
  54 As a special concession to the current CI server config, CONFIGSRC
  55 defaults to $HOME/arvados-api-server if that directory exists.
  56
  57 More information and background:
  58
  59 https://dev.arvados.org/projects/arvados/wiki/Running_tests
  60
  61 Available tests:
  62
  63 cmd/arvados-client
  64 cmd/arvados-package
  65 cmd/arvados-server
  66 doc
  67 lib/cli
  68 lib/cmd
  69 lib/controller
  70 lib/controller/federation
  71 lib/controller/railsproxy
  72 lib/controller/router
  73 lib/controller/rpc
  74 lib/crunchstat
  75 lib/crunch-run
  76 lib/cloud
  77 lib/cloud/azure
  78 lib/cloud/cloudtest
  79 lib/dispatchcloud
  80 lib/dispatchcloud/container
  81 lib/dispatchcloud/scheduler
  82 lib/dispatchcloud/sshexecutor
  83 lib/dispatchcloud/worker
  84 lib/mount
  85 lib/pam
  86 lib/service
  87 services/api
  88 services/githttpd
  89 services/dockercleaner
  90 services/fuse
  91 services/fuse:py3
  92 services/health
  93 services/keep-web
  94 services/keepproxy
  95 services/keepstore
  96 services/keep-balance
  97 services/login-sync
  98 services/crunch-dispatch-local
  99 services/crunch-dispatch-slurm
 100 services/workbench2_units
 101 services/workbench2_integration
 102 services/ws
 103 sdk/cli
 104 sdk/python
 105 sdk/python:py3
 106 sdk/ruby-google-api-client
 107 sdk/ruby
 108 sdk/go/arvados
 109 sdk/go/arvadosclient
 110 sdk/go/auth
 111 sdk/go/dispatch
 112 sdk/go/keepclient
 113 sdk/go/health
 114 sdk/go/httpserver
 115 sdk/go/manifest
 116 sdk/go/blockdigest
 117 sdk/go/asyncbuf
 118 sdk/go/stats
 119 sdk/go/crunchrunner
 120 sdk/cwl:py3
 121 sdk/R
 122 sdk/java-v2
 123 tools/sync-groups
 124 tools/crunchstat-summary
 125 tools/crunchstat-summary:py3
 126 tools/keep-exercise
 127 tools/keep-rsync
 128 tools/keep-block-check
 129
 130 EOF
 131
 132 # First make sure to remove any ARVADOS_ variables from the calling
 133 # environment that could interfere with the tests.
 134 unset $(env | cut -d= -f1 | grep \^ARVADOS_)
 135
 136 # Reset other variables that could affect our [tests'] behavior by
 137 # accident.
 138 GITDIR=
 139 GOPATH=
 140 VENVDIR=
 141 VENV3DIR=
 142 PYTHONPATH=
 143 GEMHOME=
 144 R_LIBS=
 145 export LANG=en_US.UTF-8
 146
 147 short=
 148 only_install=
 149 temp=
 150 temp_preserve=
 151
 152 ignore_sigint=
 153
 154 clear_temp() {
 155     if [[ -z "$temp" ]]; then
 156         # we did not even get as far as making a temp dir
 157         :
 158     elif [[ -z "$temp_preserve" ]]; then
 159         # Go creates readonly dirs in the module cache, which cause
 160         # "rm -rf" to fail unless we chmod first.
 161         chmod -R u+w "$temp"
 162         rm -rf "$temp"
 163     else
 164         echo "Leaving behind temp dirs in $temp"
 165     fi
 166 }
 167
 168 fatal() {
 169     clear_temp
 170     echo >&2 "Fatal: $* (encountered in ${FUNCNAME[1]} at ${BASH_SOURCE[1]} line ${BASH_LINENO[0]})"
 171     exit 1
 172 }
 173
 174 exit_cleanly() {
 175     trap - INT
 176     stop_services
 177     rotate_logfile "$WORKSPACE/services/api/log/" "test.log"
 178     report_outcomes
 179     clear_temp
 180     exit ${#failures}
 181 }
 182
 183 sanity_checks() {
 184     [[ -n "${skip[sanity]}" ]] && return 0
 185     ( [[ -n "$WORKSPACE" ]] && [[ -d "$WORKSPACE/services" ]] ) \
 186         || fatal "WORKSPACE environment variable not set to a source directory (see: $0 --help)"
 187     [[ -z "$CONFIGSRC" ]] || [[ -s "$CONFIGSRC/config.yml" ]] \
 188         || fatal "CONFIGSRC is $CONFIGSRC but '$CONFIGSRC/config.yml' is empty or not found (see: $0 --help)"
 189     echo Checking dependencies:
 190     echo "locale: ${LANG}"
 191     [[ "$(locale charmap)" = "UTF-8" ]] \
 192         || fatal "Locale '${LANG}' is broken/missing. Try: echo ${LANG} | sudo tee -a /etc/locale.gen && sudo locale-gen"
 193     echo -n 'ruby: '
 194     ruby -v \
 195         || fatal "No ruby. Install >=2.7 from package or source"
 196     echo -n 'go: '
 197     go version \
 198         || fatal "No go binary. See http://golang.org/doc/install"
 199     [[ $(go version) =~ go1.([0-9]+) ]] && [[ ${BASH_REMATCH[1]} -ge 12 ]] \
 200         || fatal "Go >= 1.12 required. See http://golang.org/doc/install"
 201     echo -n 'gcc: '
 202     gcc --version | egrep ^gcc \
 203         || fatal "No gcc. Try: apt-get install build-essential"
 204     echo -n 'fuse.h: '
 205     find /usr/include -path '*fuse/fuse.h' | egrep --max-count=1 . \
 206         || fatal "No fuse/fuse.h. Try: apt-get install libfuse-dev"
 207     echo -n 'gnutls.h: '
 208     find /usr/include -path '*gnutls/gnutls.h' | egrep --max-count=1 . \
 209         || fatal "No gnutls/gnutls.h. Try: apt-get install libgnutls28-dev"
 210     echo -n 'virtualenv: '
 211     python3 -m venv --help | grep -q '^usage: venv ' \
 212         && echo "venv module found" \
 213         || fatal "No virtualenv. Try: apt-get install python3-venv"
 214     echo -n 'Python3 pyconfig.h: '
 215     find /usr/include -path '*/python3*/pyconfig.h' | egrep --max-count=1 . \
 216         || fatal "No Python3 pyconfig.h. Try: apt-get install python3-dev"
 217     which netstat \
 218         || fatal "No netstat. Try: apt-get install net-tools"
 219     echo -n 'nginx: '
 220     PATH="$PATH:/sbin:/usr/sbin:/usr/local/sbin" nginx -v \
 221         || fatal "No nginx. Try: apt-get install nginx"
 222     echo -n 'gitolite: '
 223     which gitolite \
 224         || fatal "No gitolite. Try: apt-get install gitolite3"
 225     echo -n 'npm: '
 226     npm --version \
 227         || fatal "No npm. Try: wget -O- https://nodejs.org/dist/v12.22.12/node-v12.22.12-linux-x64.tar.xz | sudo tar -C /usr/local -xJf - && sudo ln -s ../node-v12.22.12-linux-x64/bin/{node,npm} /usr/local/bin/"
 228     echo -n 'cadaver: '
 229     cadaver --version | grep -w cadaver \
 230           || fatal "No cadaver. Try: apt-get install cadaver"
 231     echo -n 'libattr1 xattr.h: '
 232     find /usr/include -path '*/attr/xattr.h' | egrep --max-count=1 . \
 233         || fatal "No libattr1 xattr.h. Try: apt-get install libattr1-dev"
 234     echo -n 'libcurl curl.h: '
 235     find /usr/include -path '*/curl/curl.h' | egrep --max-count=1 . \
 236         || fatal "No libcurl curl.h. Try: apt-get install libcurl4-gnutls-dev"
 237     echo -n 'libpq libpq-fe.h: '
 238     find /usr/include -path '*/postgresql/libpq-fe.h' | egrep --max-count=1 . \
 239         || fatal "No libpq libpq-fe.h. Try: apt-get install libpq-dev"
 240     echo -n 'libpam pam_appl.h: '
 241     find /usr/include -path '*/security/pam_appl.h' | egrep --max-count=1 . \
 242         || fatal "No libpam pam_appl.h. Try: apt-get install libpam0g-dev"
 243     echo -n 'postgresql: '
 244     psql --version || fatal "No postgresql. Try: apt-get install postgresql postgresql-client-common"
 245     echo -n 'xvfb: '
 246     which Xvfb || fatal "No xvfb. Try: apt-get install xvfb"
 247     echo -n 'graphviz: '
 248     dot -V || fatal "No graphviz. Try: apt-get install graphviz"
 249     echo -n 'singularity: '
 250     singularity --version || fatal "No singularity. Try: arvados-server install"
 251     echo -n 'docker client: '
 252     docker --version || echo "No docker client. Try: arvados-server install"
 253     echo -n 'docker server: '
 254     docker info --format='{{.ServerVersion}}' || echo "No docker server. Try: arvados-server install"
 255
 256     if [[ "$NEED_SDK_R" = true ]]; then
 257       # R SDK stuff
 258       echo -n 'R: '
 259       which Rscript || fatal "No Rscript. Try: apt-get install r-base"
 260       echo -n 'testthat: '
 261       Rscript -e "library('testthat')" || fatal "No testthat. Try: apt-get install r-cran-testthat"
 262       # needed for roxygen2, needed for devtools, needed for R sdk
 263       pkg-config --exists libxml-2.0 || fatal "No libxml2. Try: apt-get install libxml2-dev"
 264       # needed for pkgdown, builds R SDK doc pages
 265       which pandoc || fatal "No pandoc. Try: apt-get install pandoc"
 266     fi
 267     echo 'procs with /dev/fuse open:'
 268     find /proc/*/fd -lname /dev/fuse 2>/dev/null | cut -d/ -f3 | xargs --no-run-if-empty ps -lywww
 269     echo 'grep fuse /proc/self/mountinfo:'
 270     grep fuse /proc/self/mountinfo
 271 }
 272
 273 rotate_logfile() {
 274   # i.e.  rotate_logfile "$WORKSPACE/services/api/log/" "test.log"
 275   # $BUILD_NUMBER is set by Jenkins if this script is being called as part of a Jenkins run
 276   if [[ -f "$1/$2" ]]; then
 277     THEDATE=`date +%Y%m%d%H%M%S`
 278     mv "$1/$2" "$1/$THEDATE-$BUILD_NUMBER-$2"
 279     gzip "$1/$THEDATE-$BUILD_NUMBER-$2"
 280   fi
 281 }
 282
 283 declare -a failures
 284 declare -A skip
 285 declare -A only
 286 declare -A testargs
 287
 288 while [[ -n "$1" ]]
 289 do
 290     arg="$1"; shift
 291     case "$arg" in
 292         --help)
 293             echo >&2 "$helpmessage"
 294             echo >&2
 295             exit 1
 296             ;;
 297         --skip)
 298             skip[$1]=1; shift
 299             ;;
 300         --only)
 301             only[$1]=1; skip[$1]=""; shift
 302             ;;
 303         --short)
 304             short=1
 305             ;;
 306         --interactive)
 307             interactive=1
 308             ;;
 309         --skip-install)
 310             skip[install]=1
 311             ;;
 312         --only-install)
 313             only_install="$1"; shift
 314             ;;
 315         --temp)
 316             temp="$1"; shift
 317             temp_preserve=1
 318             ;;
 319         --leave-temp)
 320             temp_preserve=1
 321             ;;
 322         --repeat)
 323             repeat=$((${1}+0)); shift
 324             ;;
 325         --retry)
 326             retry=1
 327             ;;
 328         *_test=*)
 329             suite="${arg%%_test=*}"
 330             args="${arg#*=}"
 331             testargs["$suite"]="$args"
 332             ;;
 333         *=*)
 334             eval export $(echo $arg | cut -d= -f1)=\"$(echo $arg | cut -d= -f2-)\"
 335             ;;
 336         *)
 337             echo >&2 "$0: Unrecognized option: '$arg'. Try: $0 --help"
 338             exit 1
 339             ;;
 340     esac
 341 done
 342
 343 # R SDK installation is very slow (~360s in a clean environment) and only
 344 # required when testing it. Skip that step if it is not needed.
 345 NEED_SDK_R=true
 346
 347 if [[ ${#only[@]} -ne 0 ]] &&
 348    [[ -z "${only['sdk/R']}" && -z "${only['doc']}" ]]; then
 349   NEED_SDK_R=false
 350 fi
 351
 352 if [[ ${skip["sdk/R"]} == 1 && ${skip["doc"]} == 1 ]]; then
 353   NEED_SDK_R=false
 354 fi
 355
 356 if [[ $NEED_SDK_R == false ]]; then
 357         echo "R SDK not needed, it will not be installed."
 358 fi
 359
 360 checkpidfile() {
 361     svc="$1"
 362     pid="$(cat "$WORKSPACE/tmp/${svc}.pid")"
 363     if [[ -z "$pid" ]] || ! kill -0 "$pid"; then
 364         tail $WORKSPACE/tmp/${1}*.log
 365         echo "${svc} pid ${pid} not running"
 366         return 1
 367     fi
 368     echo "${svc} pid ${pid} ok"
 369 }
 370
 371 checkhealth() {
 372     svc="$1"
 373     base=$("${VENV3DIR}/bin/python3" -c "import yaml; print(list(yaml.safe_load(open('$ARVADOS_CONFIG','r'))['Clusters']['zzzzz']['Services']['$1']['InternalURLs'].keys())[0])")
 374     url="$base/_health/ping"
 375     if ! curl -Ss -H "Authorization: Bearer e687950a23c3a9bceec28c6223a06c79" "${url}" | tee -a /dev/stderr | grep '"OK"'; then
 376         echo "${url} failed"
 377         return 1
 378     fi
 379 }
 380
 381 checkdiscoverydoc() {
 382     dd="https://${1}/discovery/v1/apis/arvados/v1/rest"
 383     if ! (set -o pipefail; curl -fsk "$dd" | grep -q ^{ ); then
 384         echo >&2 "ERROR: could not retrieve discovery doc from RailsAPI at $dd"
 385         tail -v $WORKSPACE/tmp/railsapi.log
 386         return 1
 387     fi
 388     echo "${dd} ok"
 389 }
 390
 391 start_services() {
 392     if [[ -n "$ARVADOS_TEST_API_HOST" ]]; then
 393         return 0
 394     fi
 395     . "$VENV3DIR/bin/activate"
 396     echo 'Starting API, controller, keepproxy, keep-web, githttpd, ws, and nginx ssl proxy...'
 397     if [[ ! -d "$WORKSPACE/services/api/log" ]]; then
 398         mkdir -p "$WORKSPACE/services/api/log"
 399     fi
 400     # Remove empty api.pid file if it exists
 401     if [[ -f "$WORKSPACE/tmp/api.pid" && ! -s "$WORKSPACE/tmp/api.pid" ]]; then
 402         rm -f "$WORKSPACE/tmp/api.pid"
 403     fi
 404     all_services_stopped=
 405     fail=1
 406
 407     cd "$WORKSPACE" \
 408         && eval $(python3 sdk/python/tests/run_test_server.py start --auth admin) \
 409         && export ARVADOS_TEST_API_HOST="$ARVADOS_API_HOST" \
 410         && export ARVADOS_TEST_API_INSTALLED="$$" \
 411         && checkpidfile api \
 412         && checkdiscoverydoc $ARVADOS_API_HOST \
 413         && eval $(python3 sdk/python/tests/run_test_server.py start_nginx) \
 414         && checkpidfile nginx \
 415         && python3 sdk/python/tests/run_test_server.py start_controller \
 416         && checkpidfile controller \
 417         && checkhealth Controller \
 418         && checkdiscoverydoc $ARVADOS_API_HOST \
 419         && python3 sdk/python/tests/run_test_server.py start_keep_proxy \
 420         && checkpidfile keepproxy \
 421         && python3 sdk/python/tests/run_test_server.py start_keep-web \
 422         && checkpidfile keep-web \
 423         && checkhealth WebDAV \
 424         && python3 sdk/python/tests/run_test_server.py start_githttpd \
 425         && checkpidfile githttpd \
 426         && checkhealth GitHTTP \
 427         && python3 sdk/python/tests/run_test_server.py start_ws \
 428         && checkpidfile ws \
 429         && export ARVADOS_TEST_PROXY_SERVICES=1 \
 430         && (env | egrep ^ARVADOS) \
 431         && fail=0
 432     deactivate
 433     if [[ $fail != 0 ]]; then
 434         unset ARVADOS_TEST_API_HOST
 435     fi
 436     return $fail
 437 }
 438
 439 stop_services() {
 440     if [[ -n "$all_services_stopped" ]]; then
 441         return
 442     fi
 443     unset ARVADOS_TEST_API_HOST ARVADOS_TEST_PROXY_SERVICES
 444     . "$VENV3DIR/bin/activate" || return
 445     cd "$WORKSPACE" \
 446         && python3 sdk/python/tests/run_test_server.py stop_nginx \
 447         && python3 sdk/python/tests/run_test_server.py stop_githttpd \
 448         && python3 sdk/python/tests/run_test_server.py stop_ws \
 449         && python3 sdk/python/tests/run_test_server.py stop_keep-web \
 450         && python3 sdk/python/tests/run_test_server.py stop_keep_proxy \
 451         && python3 sdk/python/tests/run_test_server.py stop_controller \
 452         && python3 sdk/python/tests/run_test_server.py stop \
 453         && all_services_stopped=1
 454     deactivate
 455     unset ARVADOS_CONFIG
 456 }
 457
 458 interrupt() {
 459     if [[ -n "$ignore_sigint" ]]; then
 460         echo >&2 "ignored SIGINT"
 461         return
 462     fi
 463     failures+=("($(basename $0) interrupted)")
 464     exit_cleanly
 465 }
 466 trap interrupt INT
 467
 468 setup_ruby_environment() {
 469     # When our "bundle install"s need to install new gems to
 470     # satisfy dependencies, we want them to go where "gem install
 471     # --user-install" would put them. (However, if the caller has
 472     # already set GEM_HOME, we assume that's where dependencies
 473     # should be installed, and we should leave it alone.)
 474
 475     if [ -z "$GEM_HOME" ]; then
 476         user_gempath="$(gem env gempath)"
 477         export GEM_HOME="${user_gempath%%:*}"
 478     fi
 479     PATH="$(gem env gemdir)/bin:$PATH"
 480
 481     # When we build and install our own gems, we install them in our
 482     # $GEMHOME tmpdir, and we want them to be at the front of GEM_PATH and
 483     # PATH so integration tests prefer them over other versions that
 484     # happen to be installed in $user_gempath, system dirs, etc.
 485
 486     tmpdir_gem_home="$(env - PATH="$PATH" HOME="$GEMHOME" gem env gempath | cut -f1 -d:)"
 487     PATH="$tmpdir_gem_home/bin:$PATH"
 488     export GEM_PATH="$tmpdir_gem_home:$(gem env gempath)"
 489
 490     echo "Will install dependencies to $(gem env gemdir)"
 491     echo "Will install bundler and arvados gems to $tmpdir_gem_home"
 492     echo "Gem search path is GEM_PATH=$GEM_PATH"
 493     gem install --user --no-document --conservative --version '~> 2.4.0' bundler \
 494         || fatal 'install bundler'
 495 }
 496
 497 with_test_gemset() {
 498     GEM_HOME="$tmpdir_gem_home" GEM_PATH="$tmpdir_gem_home" "$@"
 499 }
 500
 501 gem_uninstall_if_exists() {
 502     if gem list "$1\$" | egrep '^\w'; then
 503         gem uninstall --force --all --executables "$1"
 504     fi
 505 }
 506
 507 setup_virtualenv() {
 508     local venvdest="$1"; shift
 509     if ! [[ -e "$venvdest/bin/activate" ]] || ! [[ -e "$venvdest/bin/pip3" ]]; then
 510         python3 -m venv "$@" "$venvdest" || fatal "virtualenv $venvdest failed"
 511     elif [[ -n "$short" ]]; then
 512         return
 513     fi
 514     "$venvdest/bin/pip3" install --no-cache-dir 'setuptools>=68' 'pip>=20'
 515 }
 516
 517 initialize() {
 518     # If dependencies like ruby, go, etc. are installed in
 519     # /var/lib/arvados -- presumably by "arvados-server install" --
 520     # then we want to use those versions, instead of whatever happens
 521     # to be installed in /usr.
 522     PATH="/var/lib/arvados/bin:${PATH}"
 523     sanity_checks
 524
 525     echo "WORKSPACE=$WORKSPACE"
 526
 527     # Clean up .pyc files that may exist in the workspace
 528     cd "$WORKSPACE"
 529     find -name '*.pyc' -delete
 530
 531     if [[ -z "$temp" ]]; then
 532         temp="$(mktemp -d)"
 533     fi
 534
 535     # Set up temporary install dirs (unless existing dirs were supplied)
 536     for tmpdir in VENV3DIR GOPATH GEMHOME R_LIBS
 537     do
 538         if [[ -z "${!tmpdir}" ]]; then
 539             eval "$tmpdir"="$temp/$tmpdir"
 540         fi
 541         if ! [[ -d "${!tmpdir}" ]]; then
 542             mkdir "${!tmpdir}" || fatal "can't create ${!tmpdir} (does $temp exist?)"
 543         fi
 544     done
 545
 546     rm -vf "${WORKSPACE}/tmp/*.log"
 547
 548     export R_LIBS
 549
 550     export GOPATH
 551     # Make sure our compiled binaries under test override anything
 552     # else that might be in the environment.
 553     export PATH=$GOPATH/bin:$PATH
 554
 555     # Jenkins config requires that glob tmp/*.log match something. Ensure
 556     # that happens even if we don't end up running services that set up
 557     # logging.
 558     mkdir -p "${WORKSPACE}/tmp/" || fatal "could not mkdir ${WORKSPACE}/tmp"
 559     touch "${WORKSPACE}/tmp/controller.log" || fatal "could not touch ${WORKSPACE}/tmp/controller.log"
 560
 561     unset http_proxy https_proxy no_proxy
 562
 563     setup_ruby_environment
 564
 565     echo "PATH is $PATH"
 566 }
 567
 568 install_env() {
 569     go mod download || fatal "Go deps failed"
 570     which goimports >/dev/null || go install golang.org/x/tools/cmd/goimports@latest || fatal "Go setup failed"
 571
 572     setup_virtualenv "$VENV3DIR"
 573     . "$VENV3DIR/bin/activate"
 574
 575     # wheel modernizes the venv (as of early 2024) and makes it more closely
 576     # match our package build environment.
 577     # PyYAML is a test requirement used by run_test_server.py and needed for
 578     # other, non-Python tests.
 579     # pdoc is needed to build PySDK documentation.
 580     # We run `setup.py build` first to generate _version.py.
 581     pip install PyYAML pdoc wheel \
 582         && env -C "$WORKSPACE/sdk/python" python3 setup.py build \
 583         && pip install "$WORKSPACE/sdk/python" \
 584         || fatal "installing Python SDK and related dependencies failed"
 585 }
 586
 587 retry() {
 588     remain="${repeat}"
 589     while :
 590     do
 591         if ${@}; then
 592             if [[ "$remain" -gt 1 ]]; then
 593                 remain=$((${remain}-1))
 594                 title "(repeating ${remain} more times)"
 595             else
 596                 break
 597             fi
 598         elif [[ "$retry" == 1 ]]; then
 599             read -p 'Try again? [Y/n] ' x
 600             if [[ "$x" != "y" ]] && [[ "$x" != "" ]]
 601             then
 602                 break
 603             fi
 604         else
 605             break
 606         fi
 607     done
 608 }
 609
 610 do_test() {
 611     case "${1}" in
 612         services/workbench2_units | services/workbench2_integration)
 613             suite=services/workbench2
 614             ;;
 615         *)
 616             suite="${1}"
 617             ;;
 618     esac
 619     if [[ -n "${skip[$suite]}" || \
 620               -n "${skip[$1]}" || \
 621               (${#only[@]} -ne 0 && ${only[$suite]} -eq 0 && ${only[$1]} -eq 0) ]]; then
 622         return 0
 623     fi
 624     case "${1}" in
 625         services/api)
 626             stop_services
 627             check_arvados_config "$1"
 628             ;;
 629         gofmt \
 630             | arvados_version.py \
 631             | cmd/arvados-package \
 632             | doc \
 633             | lib/boot \
 634             | lib/cli \
 635             | lib/cloud/azure \
 636             | lib/cloud/cloudtest \
 637             | lib/cloud/ec2 \
 638             | lib/cmd \
 639             | lib/dispatchcloud/sshexecutor \
 640             | lib/dispatchcloud/worker \
 641             | lib/install \
 642             | services/workbench2_integration \
 643             | services/workbench2_units \
 644             )
 645             check_arvados_config "$1"
 646             # don't care whether services are running
 647             ;;
 648         *)
 649             check_arvados_config "$1"
 650             if ! start_services; then
 651                 checkexit 1 "$1 tests"
 652                 title "test $1 -- failed to start services"
 653                 return 1
 654             fi
 655             ;;
 656     esac
 657     retry do_test_once ${@}
 658 }
 659
 660 go_ldflags() {
 661     version=${ARVADOS_VERSION:-$(git log -n1 --format=%H)-dev}
 662     echo "-X git.arvados.org/arvados.git/lib/cmd.version=${version} -X main.version=${version} -s -w"
 663 }
 664
 665 do_test_once() {
 666     unset result
 667
 668     title "test $1"
 669     timer_reset
 670
 671     result=
 672     if which deactivate >/dev/null; then deactivate; fi
 673     if ! . "$VENV3DIR/bin/activate"
 674     then
 675         result=1
 676     elif [[ "$2" == "go" ]]
 677     then
 678         covername="coverage-$(echo "$1" | sed -e 's/\//_/g')"
 679         coverflags=("-covermode=count" "-coverprofile=$WORKSPACE/tmp/.$covername.tmp")
 680         testflags=()
 681         if [[ "$1" == "cmd/arvados-package" ]]; then
 682             testflags+=("-timeout" "20m")
 683         fi
 684         # We do "go install" here to catch compilation errors
 685         # before trying "go test". Otherwise, coverage-reporting
 686         # mode makes Go show the wrong line numbers when reporting
 687         # compilation errors.
 688         go install -ldflags "$(go_ldflags)" "$WORKSPACE/$1" && \
 689             cd "$WORKSPACE/$1" && \
 690             if [[ -n "${testargs[$1]}" ]]
 691         then
 692             # "go test -check.vv giturl" doesn't work, but this
 693             # does:
 694             go test ${short:+-short} ${testflags[@]} ${testargs[$1]}
 695         else
 696             # The above form gets verbose even when testargs is
 697             # empty, so use this form in such cases:
 698             go test ${short:+-short} ${testflags[@]} ${coverflags[@]} "git.arvados.org/arvados.git/$1"
 699         fi
 700         result=${result:-$?}
 701         if [[ -f "$WORKSPACE/tmp/.$covername.tmp" ]]
 702         then
 703             go tool cover -html="$WORKSPACE/tmp/.$covername.tmp" -o "$WORKSPACE/tmp/$covername.html"
 704             rm "$WORKSPACE/tmp/.$covername.tmp"
 705         fi
 706         [[ $result = 0 ]] && gofmt -e -d *.go
 707     elif [[ "$2" == "pip" ]]
 708     then
 709         tries=0
 710         cd "$WORKSPACE/$1" && while :
 711         do
 712             tries=$((${tries}+1))
 713             # $3 can name a path directory for us to use, including trailing
 714             # slash; e.g., the bin/ subdirectory of a virtualenv.
 715             if [[ -e "${3}activate" ]]; then
 716                 . "${3}activate"
 717             fi
 718             python setup.py ${short:+--short-tests-only} test ${testargs[$1]}
 719             result=$?
 720             if [[ ${tries} < 3 && ${result} == 137 ]]
 721             then
 722                 printf '\n*****\n%s tests killed -- retrying\n*****\n\n' "$1"
 723                 continue
 724             else
 725                 break
 726             fi
 727         done
 728     elif [[ "$2" != "" ]]
 729     then
 730         "test_$2"
 731     else
 732         "test_$1"
 733     fi
 734     result=${result:-$?}
 735     checkexit $result "$1 tests"
 736     title "test $1 -- `timer`"
 737     return $result
 738 }
 739
 740 check_arvados_config() {
 741     if [[ "$1" = "env" ]] ; then
 742         return
 743     fi
 744     if [[ -z "$ARVADOS_CONFIG" ]] ; then
 745         # Create config file.  The run_test_server script requires PyYAML,
 746         # so virtualenv needs to be active.  Downstream steps like
 747         # workbench install which require a valid config.yml.
 748         if [[ ! -s "$VENV3DIR/bin/activate" ]] ; then
 749             install_env
 750         fi
 751         . "$VENV3DIR/bin/activate"
 752         cd "$WORKSPACE"
 753         eval $(python3 sdk/python/tests/run_test_server.py setup_config)
 754         deactivate
 755     fi
 756 }
 757
 758 do_install() {
 759     if [[ -n "${skip[install]}" || ( -n "${only_install}" && "${only_install}" != "${1}" && "${only_install}" != "${2}" ) ]]; then
 760         return 0
 761     fi
 762     check_arvados_config "$1"
 763     retry do_install_once ${@}
 764 }
 765
 766 do_install_once() {
 767     title "install $1"
 768     timer_reset
 769
 770     result=
 771     if which deactivate >/dev/null; then deactivate; fi
 772     if [[ "$1" != "env" ]] && ! . "$VENV3DIR/bin/activate"; then
 773         result=1
 774     elif [[ "$2" == "go" ]]
 775     then
 776         go install -ldflags "$(go_ldflags)" "$WORKSPACE/$1"
 777     elif [[ "$2" == "pip" ]]
 778     then
 779         # $3 can name a path directory for us to use, including trailing
 780         # slash; e.g., the bin/ subdirectory of a virtualenv.
 781
 782         # Need to change to a different directory after creating
 783         # the source dist package to avoid a pip bug.
 784         # see https://arvados.org/issues/5766 for details.
 785
 786         # Also need to install twice, because if it believes the package is
 787         # already installed, pip it won't install it.  So the first "pip
 788         # install" ensures that the dependencies are met, the second "pip
 789         # install" ensures that we've actually installed the local package
 790         # we just built.
 791         cd "$WORKSPACE/$1" \
 792             && "${3}python3" setup.py sdist rotate --keep=1 --match .tar.gz \
 793             && cd "$WORKSPACE" \
 794             && "${3}pip3" install --no-cache-dir "$WORKSPACE/$1/dist"/*.tar.gz \
 795             && "${3}pip3" install --no-cache-dir --no-deps --ignore-installed "$WORKSPACE/$1/dist"/*.tar.gz
 796     elif [[ "$2" != "" ]]
 797     then
 798         "install_$2"
 799     else
 800         "install_$1"
 801     fi
 802     result=${result:-$?}
 803     checkexit $result "$1 install"
 804     title "install $1 -- `timer`"
 805     return $result
 806 }
 807
 808 bundle_install_trylocal() {
 809     (
 810         set -e
 811         echo "(Running bundle install --local. 'could not find package' messages are OK.)"
 812         if ! bundle install --local --no-deployment; then
 813             echo "(Running bundle install again, without --local.)"
 814             bundle install --no-deployment
 815         fi
 816         bundle package
 817     )
 818 }
 819
 820 install_doc() {
 821     cd "$WORKSPACE/doc" \
 822         && bundle_install_trylocal \
 823         && rm -rf .site
 824 }
 825
 826 install_gem() {
 827     gemname=$1
 828     srcpath=$2
 829     with_test_gemset gem_uninstall_if_exists "$gemname" \
 830         && cd "$WORKSPACE/$srcpath" \
 831         && bundle_install_trylocal \
 832         && gem build "$gemname.gemspec" \
 833         && with_test_gemset gem install --no-document $(ls -t "$gemname"-*.gem|head -n1)
 834 }
 835
 836 install_sdk/ruby() {
 837     install_gem arvados sdk/ruby
 838 }
 839
 840 install_sdk/ruby-google-api-client() {
 841     install_gem arvados-google-api-client sdk/ruby-google-api-client
 842 }
 843
 844 install_sdk/R() {
 845   if [[ "$NEED_SDK_R" = true ]]; then
 846     cd "$WORKSPACE/sdk/R" \
 847        && Rscript --vanilla install_deps.R
 848   fi
 849 }
 850
 851 install_sdk/cli() {
 852     install_gem arvados-cli sdk/cli
 853 }
 854
 855 install_services/login-sync() {
 856     install_gem arvados-google-api-client sdk/ruby-google-api-client
 857     install_gem arvados sdk/ruby
 858     install_gem arvados-login-sync services/login-sync
 859 }
 860
 861 install_services/api() {
 862     stop_services
 863     check_arvados_config "services/api"
 864     cd "$WORKSPACE/services/api" \
 865         && RAILS_ENV=test bundle_install_trylocal \
 866             || return 1
 867
 868     rm -f config/environments/test.rb
 869     cp config/environments/test.rb.example config/environments/test.rb
 870
 871     # Clear out any lingering postgresql connections to the test
 872     # database, so that we can drop it. This assumes the current user
 873     # is a postgresql superuser.
 874     cd "$WORKSPACE/services/api" \
 875         && test_database=$("${VENV3DIR}/bin/python3" -c "import yaml; print(yaml.safe_load(open('$ARVADOS_CONFIG','r'))['Clusters']['zzzzz']['PostgreSQL']['Connection']['dbname'])") \
 876         && psql "$test_database" -c "SELECT pg_terminate_backend (pg_stat_activity.pid::int) FROM pg_stat_activity WHERE pg_stat_activity.datname = '$test_database';" 2>/dev/null
 877
 878     mkdir -p "$WORKSPACE/services/api/tmp/pids"
 879
 880     cert="$WORKSPACE/services/api/tmp/self-signed"
 881     if [[ ! -e "$cert.pem" || "$(date -r "$cert.pem" +%s)" -lt 1512659226 ]]; then
 882         (
 883             dir="$WORKSPACE/services/api/tmp"
 884             set -e
 885             openssl req -newkey rsa:2048 -nodes -subj '/C=US/ST=State/L=City/CN=localhost' -out "$cert.csr" -keyout "$cert.key" </dev/null
 886             openssl x509 -req -in "$cert.csr" -signkey "$cert.key" -out "$cert.pem" -days 3650 -extfile <(printf 'subjectAltName=DNS:localhost,DNS:::1,DNS:0.0.0.0,DNS:127.0.0.1,IP:::1,IP:0.0.0.0,IP:127.0.0.1')
 887         ) || return 1
 888     fi
 889
 890     cd "$WORKSPACE/services/api" \
 891         && rm -rf tmp/git \
 892         && mkdir -p tmp/git \
 893         && cd tmp/git \
 894         && tar xf ../../test/test.git.tar \
 895         && mkdir -p internal.git \
 896         && git --git-dir internal.git init \
 897             || return 1
 898
 899     (
 900         set -ex
 901         cd "$WORKSPACE/services/api"
 902         export RAILS_ENV=test
 903         if bin/rails db:environment:set ; then
 904             bin/rake db:drop
 905         fi
 906         bin/rake db:setup
 907         bin/rake db:fixtures:load
 908     ) || return 1
 909 }
 910
 911 declare -a pythonstuff
 912 pythonstuff=(
 913     # The ordering of sdk/python, tools/crunchstat-summary, and
 914     # sdk/cwl here is significant. See
 915     # https://dev.arvados.org/issues/19744#note-26
 916     sdk/python:py3
 917     tools/crunchstat-summary:py3
 918     sdk/cwl:py3
 919     services/dockercleaner:py3
 920     services/fuse:py3
 921 )
 922
 923 declare -a gostuff
 924 gostuff=($(cd "$WORKSPACE" && git ls-files | grep '\.go$' | sed -e 's/\/[^\/]*$//' | sort -u))
 925
 926 install_services/workbench2() {
 927     cd "$WORKSPACE/services/workbench2" \
 928         && make yarn-install ARVADOS_DIRECTORY="${WORKSPACE}"
 929 }
 930
 931 test_doc() {
 932     local arvados_api_host=pirca.arvadosapi.com && \
 933         env -C "$WORKSPACE/doc" \
 934         bundle exec rake linkchecker \
 935         arvados_api_host="$arvados_api_host" \
 936         arvados_workbench_host="https://workbench.$arvados_api_host" \
 937         baseurl="file://$WORKSPACE/doc/.site/" \
 938         ${testargs[doc]}
 939 }
 940
 941 test_gofmt() {
 942     cd "$WORKSPACE" || return 1
 943     dirs=$(ls -d */ | egrep -v 'vendor|tmp')
 944     [[ -z "$(gofmt -e -d $dirs | tee -a /dev/stderr)" ]]
 945     go vet -composites=false ./...
 946 }
 947
 948 test_arvados_version.py() {
 949     local orig_fn=""
 950     local fail_count=0
 951     while read -d "" fn; do
 952         if [[ -z "$orig_fn" ]]; then
 953             orig_fn="$fn"
 954         elif ! cmp "$orig_fn" "$fn"; then
 955             fail_count=$(( $fail_count + 1 ))
 956             printf "FAIL: %s and %s are not identical\n" "$orig_fn" "$fn"
 957         fi
 958     done < <(git -C "$WORKSPACE" ls-files -z | grep -z '/arvados_version\.py$')
 959     case "$orig_fn" in
 960         "") return 66 ;;  # EX_NOINPUT
 961         *) return "$fail_count" ;;
 962     esac
 963 }
 964
 965 test_services/api() {
 966     rm -f "$WORKSPACE/services/api/git-commit.version"
 967     cd "$WORKSPACE/services/api" \
 968         && eval env RAILS_ENV=test ${short:+RAILS_TEST_SHORT=1} bundle exec rake test TESTOPTS=\'-v -d\' ${testargs[services/api]}
 969 }
 970
 971 test_sdk/ruby() {
 972     cd "$WORKSPACE/sdk/ruby" \
 973         && bundle exec rake test TESTOPTS=-v ${testargs[sdk/ruby]}
 974 }
 975
 976 test_sdk/ruby-google-api-client() {
 977     echo "*** note \`test sdk/ruby-google-api-client\` does not actually run any tests, see https://dev.arvados.org/issues/20993 ***"
 978     true
 979 }
 980
 981 test_sdk/R() {
 982   if [[ "$NEED_SDK_R" = true ]]; then
 983     cd "$WORKSPACE/sdk/R" \
 984         && Rscript --vanilla run_test.R
 985   fi
 986 }
 987
 988 test_sdk/cli() {
 989     cd "$WORKSPACE/sdk/cli" \
 990         && mkdir -p /tmp/keep \
 991         && KEEP_LOCAL_STORE=/tmp/keep bundle exec rake test TESTOPTS=-v ${testargs[sdk/cli]}
 992 }
 993
 994 test_sdk/java-v2() {
 995     cd "$WORKSPACE/sdk/java-v2" && gradle test ${testargs[sdk/java-v2]}
 996 }
 997
 998 test_services/login-sync() {
 999     cd "$WORKSPACE/services/login-sync" \
1000         && bundle exec rake test TESTOPTS=-v ${testargs[services/login-sync]}
1001 }
1002
1003 test_services/workbench2_units() {
1004     cd "$WORKSPACE/services/workbench2" && make unit-tests ARVADOS_DIRECTORY="${WORKSPACE}" WORKSPACE="$(pwd)" ${testargs[services/workbench2]}
1005 }
1006
1007 test_services/workbench2_integration() {
1008     cd "$WORKSPACE/services/workbench2" && make integration-tests ARVADOS_DIRECTORY="${WORKSPACE}" WORKSPACE="$(pwd)" ${testargs[services/workbench2]}
1009 }
1010
1011 install_deps() {
1012     # Install parts needed by test suites
1013     do_install env
1014     do_install cmd/arvados-server go
1015     do_install tools/crunchstat-summary pip "${VENV3DIR}/bin/"
1016     do_install sdk/ruby-google-api-client
1017     do_install sdk/ruby
1018     do_install sdk/cli
1019     do_install services/api
1020     # lib/controller integration tests depend on arv-mount to run
1021     # containers.
1022     do_install services/fuse pip "${VENV3DIR}/bin/"
1023     do_install services/keepproxy go
1024     do_install services/keep-web go
1025 }
1026
1027 install_all() {
1028     do_install env
1029     do_install doc
1030     do_install sdk/ruby-google-api-client
1031     do_install sdk/ruby
1032     do_install sdk/R
1033     do_install sdk/cli
1034     do_install services/login-sync
1035     for p in "${pythonstuff[@]}"
1036     do
1037        dir=${p%:py3}
1038        if [[ -z ${skip[python3]} ]]; then
1039            do_install ${dir} pip "$VENV3DIR/bin/"
1040        fi
1041     done
1042     for g in "${gostuff[@]}"
1043     do
1044         do_install "$g" go
1045     done
1046     do_install services/api
1047     do_install services/workbench2
1048 }
1049
1050 test_all() {
1051     stop_services
1052     do_test services/api
1053
1054     # Shortcut for when we're only running apiserver tests. This saves a bit of time,
1055     # because we don't need to start up the api server for subsequent tests.
1056     if [ ! -z "$only" ] && [ "$only" == "services/api" ]; then
1057         rotate_logfile "$WORKSPACE/services/api/log/" "test.log"
1058         exit_cleanly
1059     fi
1060
1061     do_test gofmt
1062     do_test arvados_version.py
1063     do_test doc
1064     do_test sdk/ruby-google-api-client
1065     do_test sdk/ruby
1066     do_test sdk/R
1067     do_test sdk/cli
1068     do_test services/login-sync
1069     do_test sdk/java-v2
1070     for p in "${pythonstuff[@]}"
1071     do
1072         dir=${p%:py3}
1073         if [[ -z ${skip[python3]} ]]; then
1074             do_test ${dir} pip "$VENV3DIR/bin/"
1075         fi
1076     done
1077
1078     for g in "${gostuff[@]}"
1079     do
1080         do_test "$g" go
1081     done
1082     do_test services/workbench2_units
1083     do_test services/workbench2_integration
1084 }
1085
1086 test_go() {
1087     do_test gofmt
1088     for g in "${gostuff[@]}"
1089     do
1090         do_test "$g" go
1091     done
1092 }
1093
1094 help_interactive() {
1095     echo "== Interactive commands:"
1096     echo "TARGET                 (short for 'test DIR')"
1097     echo "test TARGET"
1098     echo "10 test TARGET         (run test 10 times)"
1099     echo "test TARGET:py3        (test with python3)"
1100     echo "test TARGET -check.vv  (pass arguments to test)"
1101     echo "install TARGET"
1102     echo "install env            (go/python libs)"
1103     echo "install deps           (go/python libs + arvados components needed for integration tests)"
1104     echo "reset                  (...services used by integration tests)"
1105     echo "exit"
1106     echo "== Test targets:"
1107     echo "${!testfuncargs[@]}" | tr ' ' '\n' | sort | column
1108 }
1109
1110 initialize
1111
1112 declare -A testfuncargs=()
1113 for g in "${gostuff[@]}"; do
1114     testfuncargs[$g]="$g go"
1115 done
1116 for p in "${pythonstuff[@]}"; do
1117     dir=${p%:py3}
1118     testfuncargs[$dir:py3]="$dir pip $VENV3DIR/bin/"
1119 done
1120
1121 testfuncargs["sdk/cli"]="sdk/cli"
1122 testfuncargs["sdk/R"]="sdk/R"
1123 testfuncargs["sdk/java-v2"]="sdk/java-v2"
1124
1125 if [[ -z ${interactive} ]]; then
1126     install_all
1127     test_all
1128 else
1129     skip=()
1130     only=()
1131     only_install=()
1132     if [[ -e "$VENV3DIR/bin/activate" ]]; then stop_services; fi
1133     setnextcmd() {
1134         if [[ "$TERM" = dumb ]]; then
1135             # assume emacs, or something, is offering a history buffer
1136             # and pre-populating the command will only cause trouble
1137             nextcmd=
1138         elif [[ ! -e "$VENV3DIR/bin/activate" ]]; then
1139             nextcmd="install deps"
1140         else
1141             nextcmd=""
1142         fi
1143     }
1144     echo
1145     help_interactive
1146     nextcmd="install deps"
1147     setnextcmd
1148     HISTFILE="$WORKSPACE/tmp/.history"
1149     history -r
1150     ignore_sigint=1
1151     while read -p 'What next? ' -e -i "$nextcmd" nextcmd; do
1152         history -s "$nextcmd"
1153         history -w
1154         count=1
1155         if [[ "${nextcmd}" =~ ^[0-9] ]]; then
1156           read count nextcmd <<<"${nextcmd}"
1157         fi
1158         read verb target opts <<<"${nextcmd}"
1159         target="${target%/}"
1160         target="${target/\/:/:}"
1161         case "${verb}" in
1162             "exit" | "quit")
1163                 exit_cleanly
1164                 ;;
1165             "reset")
1166                 stop_services
1167                 ;;
1168             "test" | "install")
1169                 case "$target" in
1170                     "")
1171                         help_interactive
1172                         ;;
1173                     all | deps)
1174                         ${verb}_${target}
1175                         ;;
1176                     *)
1177                         argstarget=${target%:py3}
1178                         testargs["$argstarget"]="${opts}"
1179                         tt="${testfuncargs[${target}]}"
1180                         tt="${tt:-$target}"
1181                         while [ $count -gt 0 ]; do
1182                           do_$verb $tt
1183                           let "count=count-1"
1184                         done
1185                         ;;
1186                 esac
1187                 ;;
1188             "" | "help" | *)
1189                 help_interactive
1190                 ;;
1191         esac
1192         if [[ ${#successes[@]} -gt 0 || ${#failures[@]} -gt 0 ]]; then
1193             report_outcomes
1194             successes=()
1195             failures=()
1196         fi
1197         cd "$WORKSPACE"
1198         setnextcmd
1199     done
1200     echo
1201 fi
1202 exit_cleanly