sdk/python/tests/run_test_server.py

   1 # Copyright (C) The Arvados Authors. All rights reserved.
   2 #
   3 # SPDX-License-Identifier: Apache-2.0
   4
   5 from __future__ import print_function
   6 from __future__ import division
   7 from builtins import str
   8 from builtins import range
   9 import argparse
  10 import atexit
  11 import errno
  12 import glob
  13 import httplib2
  14 import os
  15 import pipes
  16 import random
  17 import re
  18 import shutil
  19 import signal
  20 import socket
  21 import string
  22 import subprocess
  23 import sys
  24 import tempfile
  25 import time
  26 import unittest
  27 import yaml
  28
  29 MY_DIRNAME = os.path.dirname(os.path.realpath(__file__))
  30 if __name__ == '__main__' and os.path.exists(
  31       os.path.join(MY_DIRNAME, '..', 'arvados', '__init__.py')):
  32     # We're being launched to support another test suite.
  33     # Add the Python SDK source to the library path.
  34     sys.path.insert(1, os.path.dirname(MY_DIRNAME))
  35
  36 import arvados
  37 import arvados.config
  38
  39 ARVADOS_DIR = os.path.realpath(os.path.join(MY_DIRNAME, '../../..'))
  40 SERVICES_SRC_DIR = os.path.join(ARVADOS_DIR, 'services')
  41 if 'GOPATH' in os.environ:
  42     # Add all GOPATH bin dirs to PATH -- but insert them after the
  43     # ruby gems bin dir, to ensure "bundle" runs the Ruby bundler
  44     # command, not the golang.org/x/tools/cmd/bundle command.
  45     gopaths = os.environ['GOPATH'].split(':')
  46     addbins = [os.path.join(path, 'bin') for path in gopaths]
  47     newbins = []
  48     for path in os.environ['PATH'].split(':'):
  49         newbins.append(path)
  50         if os.path.exists(os.path.join(path, 'bundle')):
  51             newbins += addbins
  52             addbins = []
  53     newbins += addbins
  54     os.environ['PATH'] = ':'.join(newbins)
  55
  56 TEST_TMPDIR = os.path.join(ARVADOS_DIR, 'tmp')
  57 if not os.path.exists(TEST_TMPDIR):
  58     os.mkdir(TEST_TMPDIR)
  59
  60 my_api_host = None
  61 _cached_config = {}
  62 _cached_db_config = {}
  63
  64 def find_server_pid(PID_PATH, wait=10):
  65     now = time.time()
  66     timeout = now + wait
  67     good_pid = False
  68     while (not good_pid) and (now <= timeout):
  69         time.sleep(0.2)
  70         try:
  71             with open(PID_PATH, 'r') as f:
  72                 server_pid = int(f.read())
  73             good_pid = (os.kill(server_pid, 0) is None)
  74         except EnvironmentError:
  75             good_pid = False
  76         now = time.time()
  77
  78     if not good_pid:
  79         return None
  80
  81     return server_pid
  82
  83 def kill_server_pid(pidfile, wait=10, passenger_root=False):
  84     # Must re-import modules in order to work during atexit
  85     import os
  86     import signal
  87     import subprocess
  88     import time
  89
  90     now = time.time()
  91     startTERM = now
  92     deadline = now + wait
  93
  94     if passenger_root:
  95         # First try to shut down nicely
  96         restore_cwd = os.getcwd()
  97         os.chdir(passenger_root)
  98         subprocess.call([
  99             'bundle', 'exec', 'passenger', 'stop', '--pid-file', pidfile])
 100         os.chdir(restore_cwd)
 101         # Use up to half of the +wait+ period waiting for "passenger
 102         # stop" to work. If the process hasn't exited by then, start
 103         # sending TERM signals.
 104         startTERM += wait//2
 105
 106     server_pid = None
 107     while now <= deadline and server_pid is None:
 108         try:
 109             with open(pidfile, 'r') as f:
 110                 server_pid = int(f.read())
 111         except IOError:
 112             # No pidfile = nothing to kill.
 113             return
 114         except ValueError as error:
 115             # Pidfile exists, but we can't parse it. Perhaps the
 116             # server has created the file but hasn't written its PID
 117             # yet?
 118             print("Parse error reading pidfile {}: {}".format(pidfile, error),
 119                   file=sys.stderr)
 120             time.sleep(0.1)
 121             now = time.time()
 122
 123     while now <= deadline:
 124         try:
 125             exited, _ = os.waitpid(server_pid, os.WNOHANG)
 126             if exited > 0:
 127                 _remove_pidfile(pidfile)
 128                 return
 129         except OSError:
 130             # already exited, or isn't our child process
 131             pass
 132         try:
 133             if now >= startTERM:
 134                 os.kill(server_pid, signal.SIGTERM)
 135                 print("Sent SIGTERM to {} ({})".format(server_pid, pidfile),
 136                       file=sys.stderr)
 137         except OSError as error:
 138             if error.errno == errno.ESRCH:
 139                 # Thrown by os.getpgid() or os.kill() if the process
 140                 # does not exist, i.e., our work here is done.
 141                 _remove_pidfile(pidfile)
 142                 return
 143             raise
 144         time.sleep(0.1)
 145         now = time.time()
 146
 147     print("Server PID {} ({}) did not exit, giving up after {}s".
 148           format(server_pid, pidfile, wait),
 149           file=sys.stderr)
 150
 151 def _remove_pidfile(pidfile):
 152     try:
 153         os.unlink(pidfile)
 154     except:
 155         if os.path.lexists(pidfile):
 156             raise
 157
 158 def find_available_port():
 159     """Return an IPv4 port number that is not in use right now.
 160
 161     We assume whoever needs to use the returned port is able to reuse
 162     a recently used port without waiting for TIME_WAIT (see
 163     SO_REUSEADDR / SO_REUSEPORT).
 164
 165     Some opportunity for races here, but it's better than choosing
 166     something at random and not checking at all. If all of our servers
 167     (hey Passenger) knew that listening on port 0 was a thing, the OS
 168     would take care of the races, and this wouldn't be needed at all.
 169     """
 170
 171     sock = socket.socket()
 172     sock.bind(('0.0.0.0', 0))
 173     port = sock.getsockname()[1]
 174     sock.close()
 175     return port
 176
 177 def _wait_until_port_listens(port, timeout=10, warn=True):
 178     """Wait for a process to start listening on the given port.
 179
 180     If nothing listens on the port within the specified timeout (given
 181     in seconds), print a warning on stderr before returning.
 182     """
 183     try:
 184         subprocess.check_output(['which', 'lsof'])
 185     except subprocess.CalledProcessError:
 186         print("WARNING: No `lsof` -- cannot wait for port to listen. "+
 187               "Sleeping 0.5 and hoping for the best.",
 188               file=sys.stderr)
 189         time.sleep(0.5)
 190         return
 191     deadline = time.time() + timeout
 192     while time.time() < deadline:
 193         try:
 194             subprocess.check_output(
 195                 ['lsof', '-t', '-i', 'tcp:'+str(port)])
 196         except subprocess.CalledProcessError:
 197             time.sleep(0.1)
 198             continue
 199         return True
 200     if warn:
 201         print(
 202             "WARNING: Nothing is listening on port {} (waited {} seconds).".
 203             format(port, timeout),
 204             file=sys.stderr)
 205     return False
 206
 207 def _logfilename(label):
 208     """Set up a labelled log file, and return a path to write logs to.
 209
 210     Normally, the returned path is {tmpdir}/{label}.log.
 211
 212     In debug mode, logs are also written to stderr, with [label]
 213     prepended to each line. The returned path is a FIFO.
 214
 215     +label+ should contain only alphanumerics: it is also used as part
 216     of the FIFO filename.
 217
 218     """
 219     logfilename = os.path.join(TEST_TMPDIR, label+'.log')
 220     if not os.environ.get('ARVADOS_DEBUG', ''):
 221         return logfilename
 222     fifo = os.path.join(TEST_TMPDIR, label+'.fifo')
 223     try:
 224         os.remove(fifo)
 225     except OSError as error:
 226         if error.errno != errno.ENOENT:
 227             raise
 228     os.mkfifo(fifo, 0o700)
 229     stdbuf = ['stdbuf', '-i0', '-oL', '-eL']
 230     # open(fifo, 'r') would block waiting for someone to open the fifo
 231     # for writing, so we need a separate cat process to open it for
 232     # us.
 233     cat = subprocess.Popen(
 234         stdbuf+['cat', fifo],
 235         stdin=open('/dev/null'),
 236         stdout=subprocess.PIPE)
 237     tee = subprocess.Popen(
 238         stdbuf+['tee', '-a', logfilename],
 239         stdin=cat.stdout,
 240         stdout=subprocess.PIPE)
 241     subprocess.Popen(
 242         stdbuf+['sed', '-e', 's/^/['+label+'] /'],
 243         stdin=tee.stdout,
 244         stdout=sys.stderr)
 245     return fifo
 246
 247 def run(leave_running_atexit=False):
 248     """Ensure an API server is running, and ARVADOS_API_* env vars have
 249     admin credentials for it.
 250
 251     If ARVADOS_TEST_API_HOST is set, a parent process has started a
 252     test server for us to use: we just need to reset() it using the
 253     admin token fixture.
 254
 255     If a previous call to run() started a new server process, and it
 256     is still running, we just need to reset() it to fixture state and
 257     return.
 258
 259     If neither of those options work out, we'll really start a new
 260     server.
 261     """
 262     global my_api_host
 263
 264     # Delete cached discovery documents.
 265     #
 266     # This will clear cached docs that belong to other processes (like
 267     # concurrent test suites) even if they're still running. They should
 268     # be able to tolerate that.
 269     for fn in glob.glob(os.path.join(
 270             str(arvados.http_cache('discovery')),
 271             '*,arvados,v1,rest,*')):
 272         os.unlink(fn)
 273
 274     pid_file = _pidfile('api')
 275     pid_file_ok = find_server_pid(pid_file, 0)
 276
 277     existing_api_host = os.environ.get('ARVADOS_TEST_API_HOST', my_api_host)
 278     if existing_api_host and pid_file_ok:
 279         if existing_api_host == my_api_host:
 280             try:
 281                 return reset()
 282             except:
 283                 # Fall through to shutdown-and-start case.
 284                 pass
 285         else:
 286             # Server was provided by parent. Can't recover if it's
 287             # unresettable.
 288             return reset()
 289
 290     # Before trying to start up our own server, call stop() to avoid
 291     # "Phusion Passenger Standalone is already running on PID 12345".
 292     # (If we've gotten this far, ARVADOS_TEST_API_HOST isn't set, so
 293     # we know the server is ours to kill.)
 294     stop(force=True)
 295
 296     restore_cwd = os.getcwd()
 297     api_src_dir = os.path.join(SERVICES_SRC_DIR, 'api')
 298     os.chdir(api_src_dir)
 299
 300     # Either we haven't started a server of our own yet, or it has
 301     # died, or we have lost our credentials, or something else is
 302     # preventing us from calling reset(). Start a new one.
 303
 304     if not os.path.exists('tmp'):
 305         os.makedirs('tmp')
 306
 307     if not os.path.exists('tmp/api'):
 308         os.makedirs('tmp/api')
 309
 310     if not os.path.exists('tmp/logs'):
 311         os.makedirs('tmp/logs')
 312
 313     # Install the git repository fixtures.
 314     gitdir = os.path.join(SERVICES_SRC_DIR, 'api', 'tmp', 'git')
 315     gittarball = os.path.join(SERVICES_SRC_DIR, 'api', 'test', 'test.git.tar')
 316     if not os.path.isdir(gitdir):
 317         os.makedirs(gitdir)
 318     subprocess.check_output(['tar', '-xC', gitdir, '-f', gittarball])
 319
 320     # The nginx proxy isn't listening here yet, but we need to choose
 321     # the wss:// port now so we can write the API server config file.
 322     wss_port = find_available_port()
 323     _setport('wss', wss_port)
 324
 325     port = find_available_port()
 326     env = os.environ.copy()
 327     env['RAILS_ENV'] = 'test'
 328     env['ARVADOS_TEST_WSS_PORT'] = str(wss_port)
 329     env.pop('ARVADOS_WEBSOCKETS', None)
 330     env.pop('ARVADOS_TEST_API_HOST', None)
 331     env.pop('ARVADOS_API_HOST', None)
 332     env.pop('ARVADOS_API_HOST_INSECURE', None)
 333     env.pop('ARVADOS_API_TOKEN', None)
 334     start_msg = subprocess.check_output(
 335         ['bundle', 'exec',
 336          'passenger', 'start', '-d', '-p{}'.format(port),
 337          '--pid-file', pid_file,
 338          '--log-file', os.path.join(os.getcwd(), 'log/test.log'),
 339          '--ssl',
 340          '--ssl-certificate', 'tmp/self-signed.pem',
 341          '--ssl-certificate-key', 'tmp/self-signed.key'],
 342         env=env)
 343
 344     if not leave_running_atexit:
 345         atexit.register(kill_server_pid, pid_file, passenger_root=api_src_dir)
 346
 347     match = re.search(r'Accessible via: https://(.*?)/', start_msg)
 348     if not match:
 349         raise Exception(
 350             "Passenger did not report endpoint: {}".format(start_msg))
 351     my_api_host = match.group(1)
 352     os.environ['ARVADOS_API_HOST'] = my_api_host
 353
 354     # Make sure the server has written its pid file and started
 355     # listening on its TCP port
 356     find_server_pid(pid_file)
 357     _wait_until_port_listens(port)
 358
 359     reset()
 360     os.chdir(restore_cwd)
 361
 362 def reset():
 363     """Reset the test server to fixture state.
 364
 365     This resets the ARVADOS_TEST_API_HOST provided by a parent process
 366     if any, otherwise the server started by run().
 367
 368     It also resets ARVADOS_* environment vars to point to the test
 369     server with admin credentials.
 370     """
 371     existing_api_host = os.environ.get('ARVADOS_TEST_API_HOST', my_api_host)
 372     token = auth_token('admin')
 373     httpclient = httplib2.Http(ca_certs=os.path.join(
 374         SERVICES_SRC_DIR, 'api', 'tmp', 'self-signed.pem'))
 375     httpclient.request(
 376         'https://{}/database/reset'.format(existing_api_host),
 377         'POST',
 378         headers={'Authorization': 'OAuth2 {}'.format(token)})
 379     os.environ['ARVADOS_API_HOST_INSECURE'] = 'true'
 380     os.environ['ARVADOS_API_TOKEN'] = token
 381     if _wait_until_port_listens(_getport('controller-ssl'), timeout=0.5, warn=False):
 382         os.environ['ARVADOS_API_HOST'] = '0.0.0.0:'+str(_getport('controller-ssl'))
 383     else:
 384         os.environ['ARVADOS_API_HOST'] = existing_api_host
 385
 386 def stop(force=False):
 387     """Stop the API server, if one is running.
 388
 389     If force==False, kill it only if we started it ourselves. (This
 390     supports the use case where a Python test suite calls run(), but
 391     run() just uses the ARVADOS_TEST_API_HOST provided by the parent
 392     process, and the test suite cleans up after itself by calling
 393     stop(). In this case the test server provided by the parent
 394     process should be left alone.)
 395
 396     If force==True, kill it even if we didn't start it
 397     ourselves. (This supports the use case in __main__, where "run"
 398     and "stop" happen in different processes.)
 399     """
 400     global my_api_host
 401     if force or my_api_host is not None:
 402         kill_server_pid(_pidfile('api'))
 403         my_api_host = None
 404
 405 def run_controller():
 406     if 'ARVADOS_TEST_PROXY_SERVICES' in os.environ:
 407         return
 408     stop_controller()
 409     rails_api_port = int(string.split(os.environ.get('ARVADOS_TEST_API_HOST', my_api_host), ':')[-1])
 410     port = find_available_port()
 411     conf = os.path.join(TEST_TMPDIR, 'arvados.yml')
 412     with open(conf, 'w') as f:
 413         f.write("""
 414 Clusters:
 415   zzzzz:
 416     PostgreSQL:
 417       ConnectionPool: 32
 418       Connection:
 419         host: {}
 420         dbname: {}
 421         user: {}
 422         password: {}
 423     NodeProfiles:
 424       "*":
 425         "arvados-controller":
 426           Listen: ":{}"
 427         "arvados-api-server":
 428           Listen: ":{}"
 429           TLS: true
 430           Insecure: true
 431         """.format(
 432             _dbconfig('host'),
 433             _dbconfig('database'),
 434             _dbconfig('username'),
 435             _dbconfig('password'),
 436             port,
 437             rails_api_port,
 438         ))
 439     logf = open(_logfilename('controller'), 'a')
 440     controller = subprocess.Popen(
 441         ["arvados-server", "controller", "-config", conf],
 442         stdin=open('/dev/null'), stdout=logf, stderr=logf, close_fds=True)
 443     with open(_pidfile('controller'), 'w') as f:
 444         f.write(str(controller.pid))
 445     _wait_until_port_listens(port)
 446     _setport('controller', port)
 447     return port
 448
 449 def stop_controller():
 450     if 'ARVADOS_TEST_PROXY_SERVICES' in os.environ:
 451         return
 452     kill_server_pid(_pidfile('controller'))
 453
 454 def run_ws():
 455     if 'ARVADOS_TEST_PROXY_SERVICES' in os.environ:
 456         return
 457     stop_ws()
 458     port = find_available_port()
 459     conf = os.path.join(TEST_TMPDIR, 'ws.yml')
 460     with open(conf, 'w') as f:
 461         f.write("""
 462 Client:
 463   APIHost: {}
 464   Insecure: true
 465 Listen: :{}
 466 LogLevel: {}
 467 Postgres:
 468   host: {}
 469   dbname: {}
 470   user: {}
 471   password: {}
 472   sslmode: require
 473         """.format(os.environ['ARVADOS_API_HOST'],
 474                    port,
 475                    ('info' if os.environ.get('ARVADOS_DEBUG', '') in ['','0'] else 'debug'),
 476                    _dbconfig('host'),
 477                    _dbconfig('database'),
 478                    _dbconfig('username'),
 479                    _dbconfig('password')))
 480     logf = open(_logfilename('ws'), 'a')
 481     ws = subprocess.Popen(
 482         ["ws", "-config", conf],
 483         stdin=open('/dev/null'), stdout=logf, stderr=logf, close_fds=True)
 484     with open(_pidfile('ws'), 'w') as f:
 485         f.write(str(ws.pid))
 486     _wait_until_port_listens(port)
 487     _setport('ws', port)
 488     return port
 489
 490 def stop_ws():
 491     if 'ARVADOS_TEST_PROXY_SERVICES' in os.environ:
 492         return
 493     kill_server_pid(_pidfile('ws'))
 494
 495 def _start_keep(n, keep_args):
 496     keep0 = tempfile.mkdtemp()
 497     port = find_available_port()
 498     keep_cmd = ["keepstore",
 499                 "-volume={}".format(keep0),
 500                 "-listen=:{}".format(port),
 501                 "-pid="+_pidfile('keep{}'.format(n))]
 502
 503     for arg, val in keep_args.items():
 504         keep_cmd.append("{}={}".format(arg, val))
 505
 506     logf = open(_logfilename('keep{}'.format(n)), 'a')
 507     kp0 = subprocess.Popen(
 508         keep_cmd, stdin=open('/dev/null'), stdout=logf, stderr=logf, close_fds=True)
 509
 510     with open(_pidfile('keep{}'.format(n)), 'w') as f:
 511         f.write(str(kp0.pid))
 512
 513     with open("{}/keep{}.volume".format(TEST_TMPDIR, n), 'w') as f:
 514         f.write(keep0)
 515
 516     _wait_until_port_listens(port)
 517
 518     return port
 519
 520 def run_keep(blob_signing_key=None, enforce_permissions=False, num_servers=2):
 521     stop_keep(num_servers)
 522
 523     keep_args = {}
 524     if not blob_signing_key:
 525         blob_signing_key = 'zfhgfenhffzltr9dixws36j1yhksjoll2grmku38mi7yxd66h5j4q9w4jzanezacp8s6q0ro3hxakfye02152hncy6zml2ed0uc'
 526     with open(os.path.join(TEST_TMPDIR, "keep.blob_signing_key"), "w") as f:
 527         keep_args['-blob-signing-key-file'] = f.name
 528         f.write(blob_signing_key)
 529     keep_args['-enforce-permissions'] = str(enforce_permissions).lower()
 530     with open(os.path.join(TEST_TMPDIR, "keep.data-manager-token-file"), "w") as f:
 531         keep_args['-data-manager-token-file'] = f.name
 532         f.write(auth_token('data_manager'))
 533     keep_args['-never-delete'] = 'false'
 534
 535     api = arvados.api(
 536         version='v1',
 537         host=os.environ['ARVADOS_API_HOST'],
 538         token=os.environ['ARVADOS_API_TOKEN'],
 539         insecure=True)
 540
 541     for d in api.keep_services().list(filters=[['service_type','=','disk']]).execute()['items']:
 542         api.keep_services().delete(uuid=d['uuid']).execute()
 543     for d in api.keep_disks().list().execute()['items']:
 544         api.keep_disks().delete(uuid=d['uuid']).execute()
 545
 546     for d in range(0, num_servers):
 547         port = _start_keep(d, keep_args)
 548         svc = api.keep_services().create(body={'keep_service': {
 549             'uuid': 'zzzzz-bi6l4-keepdisk{:07d}'.format(d),
 550             'service_host': 'localhost',
 551             'service_port': port,
 552             'service_type': 'disk',
 553             'service_ssl_flag': False,
 554         }}).execute()
 555         api.keep_disks().create(body={
 556             'keep_disk': {'keep_service_uuid': svc['uuid'] }
 557         }).execute()
 558
 559     # If keepproxy and/or keep-web is running, send SIGHUP to make
 560     # them discover the new keepstore services.
 561     for svc in ('keepproxy', 'keep-web'):
 562         pidfile = _pidfile('keepproxy')
 563         if os.path.exists(pidfile):
 564             try:
 565                 os.kill(int(open(pidfile).read()), signal.SIGHUP)
 566             except OSError:
 567                 os.remove(pidfile)
 568
 569 def _stop_keep(n):
 570     kill_server_pid(_pidfile('keep{}'.format(n)))
 571     if os.path.exists("{}/keep{}.volume".format(TEST_TMPDIR, n)):
 572         with open("{}/keep{}.volume".format(TEST_TMPDIR, n), 'r') as r:
 573             shutil.rmtree(r.read(), True)
 574         os.unlink("{}/keep{}.volume".format(TEST_TMPDIR, n))
 575     if os.path.exists(os.path.join(TEST_TMPDIR, "keep.blob_signing_key")):
 576         os.remove(os.path.join(TEST_TMPDIR, "keep.blob_signing_key"))
 577
 578 def stop_keep(num_servers=2):
 579     for n in range(0, num_servers):
 580         _stop_keep(n)
 581
 582 def run_keep_proxy():
 583     if 'ARVADOS_TEST_PROXY_SERVICES' in os.environ:
 584         return
 585     stop_keep_proxy()
 586
 587     port = find_available_port()
 588     env = os.environ.copy()
 589     env['ARVADOS_API_TOKEN'] = auth_token('anonymous')
 590     logf = open(_logfilename('keepproxy'), 'a')
 591     kp = subprocess.Popen(
 592         ['keepproxy',
 593          '-pid='+_pidfile('keepproxy'),
 594          '-listen=:{}'.format(port)],
 595         env=env, stdin=open('/dev/null'), stdout=logf, stderr=logf, close_fds=True)
 596
 597     api = arvados.api(
 598         version='v1',
 599         host=os.environ['ARVADOS_API_HOST'],
 600         token=auth_token('admin'),
 601         insecure=True)
 602     for d in api.keep_services().list(
 603             filters=[['service_type','=','proxy']]).execute()['items']:
 604         api.keep_services().delete(uuid=d['uuid']).execute()
 605     api.keep_services().create(body={'keep_service': {
 606         'service_host': 'localhost',
 607         'service_port': port,
 608         'service_type': 'proxy',
 609         'service_ssl_flag': False,
 610     }}).execute()
 611     os.environ["ARVADOS_KEEP_SERVICES"] = "http://localhost:{}".format(port)
 612     _setport('keepproxy', port)
 613     _wait_until_port_listens(port)
 614
 615 def stop_keep_proxy():
 616     if 'ARVADOS_TEST_PROXY_SERVICES' in os.environ:
 617         return
 618     kill_server_pid(_pidfile('keepproxy'))
 619
 620 def run_arv_git_httpd():
 621     if 'ARVADOS_TEST_PROXY_SERVICES' in os.environ:
 622         return
 623     stop_arv_git_httpd()
 624
 625     gitdir = os.path.join(SERVICES_SRC_DIR, 'api', 'tmp', 'git')
 626     gitport = find_available_port()
 627     env = os.environ.copy()
 628     env.pop('ARVADOS_API_TOKEN', None)
 629     logf = open(_logfilename('arv-git-httpd'), 'a')
 630     agh = subprocess.Popen(
 631         ['arv-git-httpd',
 632          '-repo-root='+gitdir+'/test',
 633          '-address=:'+str(gitport)],
 634         env=env, stdin=open('/dev/null'), stdout=logf, stderr=logf)
 635     with open(_pidfile('arv-git-httpd'), 'w') as f:
 636         f.write(str(agh.pid))
 637     _setport('arv-git-httpd', gitport)
 638     _wait_until_port_listens(gitport)
 639
 640 def stop_arv_git_httpd():
 641     if 'ARVADOS_TEST_PROXY_SERVICES' in os.environ:
 642         return
 643     kill_server_pid(_pidfile('arv-git-httpd'))
 644
 645 def run_keep_web():
 646     if 'ARVADOS_TEST_PROXY_SERVICES' in os.environ:
 647         return
 648     stop_keep_web()
 649
 650     keepwebport = find_available_port()
 651     env = os.environ.copy()
 652     env['ARVADOS_API_TOKEN'] = auth_token('anonymous')
 653     logf = open(_logfilename('keep-web'), 'a')
 654     keepweb = subprocess.Popen(
 655         ['keep-web',
 656          '-allow-anonymous',
 657          '-attachment-only-host=download',
 658          '-listen=:'+str(keepwebport)],
 659         env=env, stdin=open('/dev/null'), stdout=logf, stderr=logf)
 660     with open(_pidfile('keep-web'), 'w') as f:
 661         f.write(str(keepweb.pid))
 662     _setport('keep-web', keepwebport)
 663     _wait_until_port_listens(keepwebport)
 664
 665 def stop_keep_web():
 666     if 'ARVADOS_TEST_PROXY_SERVICES' in os.environ:
 667         return
 668     kill_server_pid(_pidfile('keep-web'))
 669
 670 def run_nginx():
 671     if 'ARVADOS_TEST_PROXY_SERVICES' in os.environ:
 672         return
 673     stop_nginx()
 674     nginxconf = {}
 675     nginxconf['CONTROLLERPORT'] = _getport('controller')
 676     nginxconf['CONTROLLERSSLPORT'] = find_available_port()
 677     nginxconf['KEEPWEBPORT'] = _getport('keep-web')
 678     nginxconf['KEEPWEBDLSSLPORT'] = find_available_port()
 679     nginxconf['KEEPWEBSSLPORT'] = find_available_port()
 680     nginxconf['KEEPPROXYPORT'] = _getport('keepproxy')
 681     nginxconf['KEEPPROXYSSLPORT'] = find_available_port()
 682     nginxconf['GITPORT'] = _getport('arv-git-httpd')
 683     nginxconf['GITSSLPORT'] = find_available_port()
 684     nginxconf['WSPORT'] = _getport('ws')
 685     nginxconf['WSSPORT'] = _getport('wss')
 686     nginxconf['SSLCERT'] = os.path.join(SERVICES_SRC_DIR, 'api', 'tmp', 'self-signed.pem')
 687     nginxconf['SSLKEY'] = os.path.join(SERVICES_SRC_DIR, 'api', 'tmp', 'self-signed.key')
 688     nginxconf['ACCESSLOG'] = _logfilename('nginx_access')
 689     nginxconf['ERRORLOG'] = _logfilename('nginx_error')
 690     nginxconf['TMPDIR'] = TEST_TMPDIR
 691
 692     conftemplatefile = os.path.join(MY_DIRNAME, 'nginx.conf')
 693     conffile = os.path.join(TEST_TMPDIR, 'nginx.conf')
 694     with open(conffile, 'w') as f:
 695         f.write(re.sub(
 696             r'{{([A-Z]+)}}',
 697             lambda match: str(nginxconf.get(match.group(1))),
 698             open(conftemplatefile).read()))
 699
 700     env = os.environ.copy()
 701     env['PATH'] = env['PATH']+':/sbin:/usr/sbin:/usr/local/sbin'
 702
 703     nginx = subprocess.Popen(
 704         ['nginx',
 705          '-g', 'error_log stderr info;',
 706          '-g', 'pid '+_pidfile('nginx')+';',
 707          '-c', conffile],
 708         env=env, stdin=open('/dev/null'), stdout=sys.stderr)
 709     _setport('controller-ssl', nginxconf['CONTROLLERSSLPORT'])
 710     _setport('keep-web-dl-ssl', nginxconf['KEEPWEBDLSSLPORT'])
 711     _setport('keep-web-ssl', nginxconf['KEEPWEBSSLPORT'])
 712     _setport('keepproxy-ssl', nginxconf['KEEPPROXYSSLPORT'])
 713     _setport('arv-git-httpd-ssl', nginxconf['GITSSLPORT'])
 714
 715 def stop_nginx():
 716     if 'ARVADOS_TEST_PROXY_SERVICES' in os.environ:
 717         return
 718     kill_server_pid(_pidfile('nginx'))
 719
 720 def _pidfile(program):
 721     return os.path.join(TEST_TMPDIR, program + '.pid')
 722
 723 def _portfile(program):
 724     return os.path.join(TEST_TMPDIR, program + '.port')
 725
 726 def _setport(program, port):
 727     with open(_portfile(program), 'w') as f:
 728         f.write(str(port))
 729
 730 # Returns 9 if program is not up.
 731 def _getport(program):
 732     try:
 733         return int(open(_portfile(program)).read())
 734     except IOError:
 735         return 9
 736
 737 def _dbconfig(key):
 738     global _cached_db_config
 739     if not _cached_db_config:
 740         _cached_db_config = yaml.load(open(os.path.join(
 741             SERVICES_SRC_DIR, 'api', 'config', 'database.yml')))
 742     return _cached_db_config['test'][key]
 743
 744 def _apiconfig(key):
 745     global _cached_config
 746     if _cached_config:
 747         return _cached_config[key]
 748     def _load(f, required=True):
 749         fullpath = os.path.join(SERVICES_SRC_DIR, 'api', 'config', f)
 750         if not required and not os.path.exists(fullpath):
 751             return {}
 752         return yaml.load(fullpath)
 753     cdefault = _load('application.default.yml')
 754     csite = _load('application.yml', required=False)
 755     _cached_config = {}
 756     for section in [cdefault.get('common',{}), cdefault.get('test',{}),
 757                     csite.get('common',{}), csite.get('test',{})]:
 758         _cached_config.update(section)
 759     return _cached_config[key]
 760
 761 def fixture(fix):
 762     '''load a fixture yaml file'''
 763     with open(os.path.join(SERVICES_SRC_DIR, 'api', "test", "fixtures",
 764                            fix + ".yml")) as f:
 765         yaml_file = f.read()
 766         try:
 767           trim_index = yaml_file.index("# Test Helper trims the rest of the file")
 768           yaml_file = yaml_file[0:trim_index]
 769         except ValueError:
 770           pass
 771         return yaml.load(yaml_file)
 772
 773 def auth_token(token_name):
 774     return fixture("api_client_authorizations")[token_name]["api_token"]
 775
 776 def authorize_with(token_name):
 777     '''token_name is the symbolic name of the token from the api_client_authorizations fixture'''
 778     arvados.config.settings()["ARVADOS_API_TOKEN"] = auth_token(token_name)
 779     arvados.config.settings()["ARVADOS_API_HOST"] = os.environ.get("ARVADOS_API_HOST")
 780     arvados.config.settings()["ARVADOS_API_HOST_INSECURE"] = "true"
 781
 782 class TestCaseWithServers(unittest.TestCase):
 783     """TestCase to start and stop supporting Arvados servers.
 784
 785     Define any of MAIN_SERVER, KEEP_SERVER, and/or KEEP_PROXY_SERVER
 786     class variables as a dictionary of keyword arguments.  If you do,
 787     setUpClass will start the corresponding servers by passing these
 788     keyword arguments to the run, run_keep, and/or run_keep_server
 789     functions, respectively.  It will also set Arvados environment
 790     variables to point to these servers appropriately.  If you don't
 791     run a Keep or Keep proxy server, setUpClass will set up a
 792     temporary directory for Keep local storage, and set it as
 793     KEEP_LOCAL_STORE.
 794
 795     tearDownClass will stop any servers started, and restore the
 796     original environment.
 797     """
 798     MAIN_SERVER = None
 799     WS_SERVER = None
 800     KEEP_SERVER = None
 801     KEEP_PROXY_SERVER = None
 802     KEEP_WEB_SERVER = None
 803
 804     @staticmethod
 805     def _restore_dict(src, dest):
 806         for key in list(dest.keys()):
 807             if key not in src:
 808                 del dest[key]
 809         dest.update(src)
 810
 811     @classmethod
 812     def setUpClass(cls):
 813         cls._orig_environ = os.environ.copy()
 814         cls._orig_config = arvados.config.settings().copy()
 815         cls._cleanup_funcs = []
 816         os.environ.pop('ARVADOS_KEEP_SERVICES', None)
 817         os.environ.pop('ARVADOS_EXTERNAL_CLIENT', None)
 818         for server_kwargs, start_func, stop_func in (
 819                 (cls.MAIN_SERVER, run, reset),
 820                 (cls.WS_SERVER, run_ws, stop_ws),
 821                 (cls.KEEP_SERVER, run_keep, stop_keep),
 822                 (cls.KEEP_PROXY_SERVER, run_keep_proxy, stop_keep_proxy),
 823                 (cls.KEEP_WEB_SERVER, run_keep_web, stop_keep_web)):
 824             if server_kwargs is not None:
 825                 start_func(**server_kwargs)
 826                 cls._cleanup_funcs.append(stop_func)
 827         if (cls.KEEP_SERVER is None) and (cls.KEEP_PROXY_SERVER is None):
 828             cls.local_store = tempfile.mkdtemp()
 829             os.environ['KEEP_LOCAL_STORE'] = cls.local_store
 830             cls._cleanup_funcs.append(
 831                 lambda: shutil.rmtree(cls.local_store, ignore_errors=True))
 832         else:
 833             os.environ.pop('KEEP_LOCAL_STORE', None)
 834         arvados.config.initialize()
 835
 836     @classmethod
 837     def tearDownClass(cls):
 838         for clean_func in cls._cleanup_funcs:
 839             clean_func()
 840         cls._restore_dict(cls._orig_environ, os.environ)
 841         cls._restore_dict(cls._orig_config, arvados.config.settings())
 842
 843
 844 if __name__ == "__main__":
 845     actions = [
 846         'start', 'stop',
 847         'start_ws', 'stop_ws',
 848         'start_controller', 'stop_controller',
 849         'start_keep', 'stop_keep',
 850         'start_keep_proxy', 'stop_keep_proxy',
 851         'start_keep-web', 'stop_keep-web',
 852         'start_arv-git-httpd', 'stop_arv-git-httpd',
 853         'start_nginx', 'stop_nginx',
 854     ]
 855     parser = argparse.ArgumentParser()
 856     parser.add_argument('action', type=str, help="one of {}".format(actions))
 857     parser.add_argument('--auth', type=str, metavar='FIXTURE_NAME', help='Print authorization info for given api_client_authorizations fixture')
 858     parser.add_argument('--num-keep-servers', metavar='int', type=int, default=2, help="Number of keep servers desired")
 859     parser.add_argument('--keep-enforce-permissions', action="store_true", help="Enforce keep permissions")
 860
 861     args = parser.parse_args()
 862
 863     if args.action not in actions:
 864         print("Unrecognized action '{}'. Actions are: {}.".
 865               format(args.action, actions),
 866               file=sys.stderr)
 867         sys.exit(1)
 868     if args.action == 'start':
 869         stop(force=('ARVADOS_TEST_API_HOST' not in os.environ))
 870         run(leave_running_atexit=True)
 871         host = os.environ['ARVADOS_API_HOST']
 872         if args.auth is not None:
 873             token = auth_token(args.auth)
 874             print("export ARVADOS_API_TOKEN={}".format(pipes.quote(token)))
 875             print("export ARVADOS_API_HOST={}".format(pipes.quote(host)))
 876             print("export ARVADOS_API_HOST_INSECURE=true")
 877         else:
 878             print(host)
 879     elif args.action == 'stop':
 880         stop(force=('ARVADOS_TEST_API_HOST' not in os.environ))
 881     elif args.action == 'start_ws':
 882         run_ws()
 883     elif args.action == 'stop_ws':
 884         stop_ws()
 885     elif args.action == 'start_controller':
 886         run_controller()
 887     elif args.action == 'stop_controller':
 888         stop_controller()
 889     elif args.action == 'start_keep':
 890         run_keep(enforce_permissions=args.keep_enforce_permissions, num_servers=args.num_keep_servers)
 891     elif args.action == 'stop_keep':
 892         stop_keep(num_servers=args.num_keep_servers)
 893     elif args.action == 'start_keep_proxy':
 894         run_keep_proxy()
 895     elif args.action == 'stop_keep_proxy':
 896         stop_keep_proxy()
 897     elif args.action == 'start_arv-git-httpd':
 898         run_arv_git_httpd()
 899     elif args.action == 'stop_arv-git-httpd':
 900         stop_arv_git_httpd()
 901     elif args.action == 'start_keep-web':
 902         run_keep_web()
 903     elif args.action == 'stop_keep-web':
 904         stop_keep_web()
 905     elif args.action == 'start_nginx':
 906         run_nginx()
 907         print("export ARVADOS_API_HOST=0.0.0.0:{}".format(_getport('controller-ssl')))
 908     elif args.action == 'stop_nginx':
 909         stop_nginx()
 910     else:
 911         raise Exception("action recognized but not implemented!?")