X-Git-Url: https://git.arvados.org/arvados.git/blobdiff_plain/76319efd911f8b8536868831a49faa82f797ecc4..b23bcfdc041fa9459d2beb423eea35e3ad34e64a:/sdk/python/tests/run_test_server.py diff --git a/sdk/python/tests/run_test_server.py b/sdk/python/tests/run_test_server.py index 92497020ac..ca0584413c 100644 --- a/sdk/python/tests/run_test_server.py +++ b/sdk/python/tests/run_test_server.py @@ -8,6 +8,7 @@ import subprocess import sys import tempfile import time +import unittest import yaml MY_DIRNAME = os.path.dirname(os.path.realpath(__file__)) @@ -28,7 +29,10 @@ if 'GOPATH' in os.environ: gobins = [os.path.join(path, 'bin') for path in gopaths] os.environ['PATH'] = ':'.join(gobins) + ':' + os.environ['PATH'] -logfile = None +if os.path.isdir('tests'): + TEST_TMPDIR = 'tests/tmp' +else: + TEST_TMPDIR = 'tmp' def find_server_pid(PID_PATH, wait=10): now = time.time() @@ -143,29 +147,29 @@ def _start_keep(n, keep_args): keep_cmd = ["keepstore", "-volumes={}".format(keep0), "-listen=:{}".format(25107+n), - "-pid={}".format("tmp/keep{}.pid".format(n))] + "-pid={}".format("{}/keep{}.pid".format(TEST_TMPDIR, n))] for arg, val in keep_args.iteritems(): keep_cmd.append("{}={}".format(arg, val)) - kp0 = subprocess.Popen(keep_cmd, stderr=log_stream()) - with open("tmp/keep{}.pid".format(n), 'w') as f: + kp0 = subprocess.Popen(keep_cmd) + with open("{}/keep{}.pid".format(TEST_TMPDIR, n), 'w') as f: f.write(str(kp0.pid)) - with open("tmp/keep{}.volume".format(n), 'w') as f: + with open("{}/keep{}.volume".format(TEST_TMPDIR, n), 'w') as f: f.write(keep0) def run_keep(blob_signing_key=None, enforce_permissions=False): stop_keep() - if not os.path.exists("tmp"): - os.mkdir("tmp") + if not os.path.exists(TEST_TMPDIR): + os.mkdir(TEST_TMPDIR) keep_args = {} if blob_signing_key: - with open("tmp/keep.blob_signing_key", "w") as f: + with open(os.path.join(TEST_TMPDIR, "keep.blob_signing_key"), "w") as f: + keep_args['--permission-key-file'] = f.name f.write(blob_signing_key) - keep_args['--permission-key-file'] = 'tmp/keep.blob_signing_key' if enforce_permissions: keep_args['--enforce-permissions'] = 'true' @@ -188,13 +192,13 @@ def run_keep(blob_signing_key=None, enforce_permissions=False): api.keep_disks().create(body={"keep_disk": {"keep_service_uuid": s2["uuid"] } }).execute() def _stop_keep(n): - kill_server_pid("tmp/keep{}.pid".format(n), 0) - if os.path.exists("tmp/keep{}.volume".format(n)): - with open("tmp/keep{}.volume".format(n), 'r') as r: + kill_server_pid("{}/keep{}.pid".format(TEST_TMPDIR, n), 0) + if os.path.exists("{}/keep{}.volume".format(TEST_TMPDIR, n)): + with open("{}/keep{}.volume".format(TEST_TMPDIR, n), 'r') as r: shutil.rmtree(r.read(), True) - os.unlink("tmp/keep{}.volume".format(n)) - if os.path.exists("tmp/keep.blob_signing_key"): - os.remove("tmp/keep.blob_signing_key") + os.unlink("{}/keep{}.volume".format(TEST_TMPDIR, n)) + if os.path.exists(os.path.join(TEST_TMPDIR, "keep.blob_signing_key")): + os.remove(os.path.join(TEST_TMPDIR, "keep.blob_signing_key")) def stop_keep(): _stop_keep(0) @@ -203,35 +207,25 @@ def stop_keep(): def run_keep_proxy(auth): stop_keep_proxy() - if not os.path.exists("tmp"): - os.mkdir("tmp") + if not os.path.exists(TEST_TMPDIR): + os.mkdir(TEST_TMPDIR) os.environ["ARVADOS_API_HOST"] = "127.0.0.1:3001" os.environ["ARVADOS_API_HOST_INSECURE"] = "true" os.environ["ARVADOS_API_TOKEN"] = fixture("api_client_authorizations")[auth]["api_token"] kp0 = subprocess.Popen(["keepproxy", - "-pid=tmp/keepproxy.pid", "-listen=:{}".format(25101)], - stderr=log_stream()) + "-pid={}/keepproxy.pid".format(TEST_TMPDIR), + "-listen=:{}".format(25101)]) authorize_with("admin") api = arvados.api('v1', cache=False) api.keep_services().create(body={"keep_service": {"service_host": "localhost", "service_port": 25101, "service_type": "proxy"} }).execute() - arvados.config.settings()["ARVADOS_KEEP_PROXY"] = "http://localhost:25101" + os.environ["ARVADOS_KEEP_PROXY"] = "http://localhost:25101" def stop_keep_proxy(): - kill_server_pid("tmp/keepproxy.pid", 0) - -def log_stream(): - global logfile - if not os.path.exists("tmp"): - os.mkdir("tmp") - if not logfile: - logpath = os.path.join(os.getcwd(), 'tmp', 'run_test_server.log') - logfile = open(logpath, 'a') - print >>sys.stderr, "Saving Keep server log messages to %s" % (logpath,) - return logfile + kill_server_pid(os.path.join(TEST_TMPDIR, "keepproxy.pid"), 0) def fixture(fix): '''load a fixture yaml file''' @@ -245,6 +239,65 @@ def authorize_with(token): arvados.config.settings()["ARVADOS_API_HOST"] = os.environ.get("ARVADOS_API_HOST") arvados.config.settings()["ARVADOS_API_HOST_INSECURE"] = "true" +class TestCaseWithServers(unittest.TestCase): + """TestCase to start and stop supporting Arvados servers. + + Define any of MAIN_SERVER, KEEP_SERVER, and/or KEEP_PROXY_SERVER + class variables as a dictionary of keyword arguments. If you do, + setUpClass will start the corresponding servers by passing these + keyword arguments to the run, run_keep, and/or run_keep_server + functions, respectively. It will also set Arvados environment + variables to point to these servers appropriately. If you don't + run a Keep or Keep proxy server, setUpClass will set up a + temporary directory for Keep local storage, and set it as + KEEP_LOCAL_STORE. + + tearDownClass will stop any servers started, and restore the + original environment. + """ + MAIN_SERVER = None + KEEP_SERVER = None + KEEP_PROXY_SERVER = None + + @staticmethod + def _restore_dict(src, dest): + for key in dest.keys(): + if key not in src: + del dest[key] + dest.update(src) + + @classmethod + def setUpClass(cls): + cls._orig_environ = os.environ.copy() + cls._orig_config = arvados.config.settings().copy() + cls._cleanup_funcs = [] + for server_kwargs, start_func, stop_func in ( + (cls.MAIN_SERVER, run, stop), + (cls.KEEP_SERVER, run_keep, stop_keep), + (cls.KEEP_PROXY_SERVER, run_keep_proxy, stop_keep_proxy)): + if server_kwargs is not None: + start_func(**server_kwargs) + cls._cleanup_funcs.append(stop_func) + os.environ.pop('ARVADOS_EXTERNAL_CLIENT', None) + if cls.KEEP_PROXY_SERVER is None: + os.environ.pop('ARVADOS_KEEP_PROXY', None) + if (cls.KEEP_SERVER is None) and (cls.KEEP_PROXY_SERVER is None): + cls.local_store = tempfile.mkdtemp() + os.environ['KEEP_LOCAL_STORE'] = cls.local_store + cls._cleanup_funcs.append( + lambda: shutil.rmtree(cls.local_store, ignore_errors=True)) + else: + os.environ.pop('KEEP_LOCAL_STORE', None) + arvados.config.initialize() + + @classmethod + def tearDownClass(cls): + for clean_func in cls._cleanup_funcs: + clean_func() + cls._restore_dict(cls._orig_environ, os.environ) + cls._restore_dict(cls._orig_config, arvados.config.settings()) + + if __name__ == "__main__": parser = argparse.ArgumentParser() parser.add_argument('action', type=str, help='''one of "start", "stop", "start_keep", "stop_keep"''')