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