radosgw-agent.py: refactor, enable overrides

Refactored the radosgw-agent.py code so that it
is structured more like existing teuthology
tasks.
Additionally, added code to enable:
using the override field in YAML files,
specifying which radosgw-agent github branch
to use checkout and for the YAML file to
specify one of the following: a full sync,
an incremental sync and the starting of the
test radosgw-agent server (previously the
server was always started by this task).

Signed-off-by: Joe Buck <jbbuck@gmail.com>
Reviewed-by: Josh Durgin <josh.durgin@inktank.com>

diff --git a/teuthology/task/radosgw-agent.py b/teuthology/task/radosgw-agent.py
index e2c6df9c1f7a479ce928f89a6a137be26d344eb6..7e5ca1c14c6080cef0c4937c5cc28514df2d9045 100644 (file)
--- a/teuthology/task/radosgw-agent.py
+++ b/teuthology/task/radosgw-agent.py
@@ -8,70 +8,108 @@ import teuthology.task_util.rgw as rgw_utils
 
 log = logging.getLogger(__name__)
 
-def run_radosgw_agent(ctx, client, config):
+def run_radosgw_agent(ctx, config):
     """
     Run a single radosgw-agent. See task() for config format.
     """
-    src_client = config['src']
-    dest_client = config['dest']
-
-    src_zone = rgw_utils.zone_for_client(ctx, src_client)
-    dest_zone = rgw_utils.zone_for_client(ctx, dest_client)
-
-    log.info("source is %s", src_zone)
-    log.info("dest is %s", dest_zone)
-
-    testdir = teuthology.get_testdir(ctx)
-    (remote,) = ctx.cluster.only(client).remotes.keys()
-    remote.run(
-        args=[
-            'cd', testdir, run.Raw('&&'),
-            'git', 'clone', 'https://github.com/ceph/radosgw-agent.git',
-            'radosgw-agent.{client}'.format(client=client),
-            run.Raw('&&'),
-            'cd', 'radosgw-agent.{client}'.format(client=client),
-            run.Raw('&&'),
-            './bootstrap',
-            ]
-        )
-
-    src_host, src_port = rgw_utils.get_zone_host_and_port(ctx, src_client,
-                                                          src_zone)
-    dest_host, dest_port = rgw_utils.get_zone_host_and_port(ctx, dest_client,
-                                                            dest_zone)
-    src_access, src_secret = rgw_utils.get_zone_system_keys(ctx, src_client,
-                                                            src_zone)
-    dest_access, dest_secret = rgw_utils.get_zone_system_keys(ctx, dest_client,
-                                                              dest_zone)
-    port = config.get('port', 8000)
-    daemon_name = '{host}.{port}.syncdaemon'.format(host=remote.name, port=port)
-
-    return remote.run(
-        args=[
-            '{tdir}/daemon-helper'.format(tdir=testdir), 'kill',
-            '{tdir}/radosgw-agent.{client}/radosgw-agent'.format(tdir=testdir,
-                                                                 client=client),
-            '-v',
-            '--src-access-key', src_access,
-            '--src-secret-key', src_secret,
-            '--src-host', src_host,
-            '--src-port', str(src_port),
-            '--src-zone', src_zone,
-            '--dest-access-key', dest_access,
-            '--dest-secret-key', dest_secret,
-            '--dest-host', dest_host,
-            '--dest-port', str(dest_port),
-            '--dest-zone', dest_zone,
-            '--daemon-id', daemon_name,
-            '--test-server-host', '0.0.0.0', '--test-server-port', str(port),
-            '--log-file', '{tdir}/archive/rgw_sync_agent.{client}.log'.format(
-                tdir=testdir,
-                client=client),
-            ],
-        wait=False,
-        stdin=run.PIPE,
-        logger=log.getChild(daemon_name)
-        )
+    return_list = list()
+    for (client, cconf) in config.items():
+        # don't process entries that are not clients
+        if not client.startswith('client.'):
+            log.debug('key {data} does not start with \'client.\', moving on'.format(
+                      data=client))
+            continue
+
+        src_client = cconf['src']
+        dest_client = cconf['dest']
+
+        src_zone = rgw_utils.zone_for_client(ctx, src_client)
+        dest_zone = rgw_utils.zone_for_client(ctx, dest_client)
+
+        log.info("source is %s", src_zone)
+        log.info("dest is %s", dest_zone)
+
+        testdir = teuthology.get_testdir(ctx)
+        (remote,) = ctx.cluster.only(client).remotes.keys()
+        # figure out which branch to pull from
+        branch = cconf.get('force-branch', None)
+        if not branch:
+            branch = cconf.get('branch', 'master')
+        sha1 = cconf.get('sha1')
+        remote.run(
+            args=[
+                'cd', testdir, run.Raw('&&'),
+                'git', 'clone', 
+                '-b', branch,
+                'https://github.com/ceph/radosgw-agent.git',
+                'radosgw-agent.{client}'.format(client=client),
+                ]
+            )
+        if sha1 is not None:
+            remote.run(
+                args=[
+                    'cd', testdir, run.Raw('&&'),
+                    run.Raw('&&'),
+                    'git', 'reset', '--hard', sha1,
+                ]
+            )
+        remote.run(
+            args=[
+                'cd', testdir, run.Raw('&&'),
+                'cd', 'radosgw-agent.{client}'.format(client=client),
+                run.Raw('&&'),
+                './bootstrap',
+                ]
+            )
+
+        src_host, src_port = rgw_utils.get_zone_host_and_port(ctx, src_client,
+                                                              src_zone)
+        dest_host, dest_port = rgw_utils.get_zone_host_and_port(ctx, dest_client,
+                                                                 dest_zone)
+        src_access, src_secret = rgw_utils.get_zone_system_keys(ctx, src_client,
+                                                               src_zone)
+        dest_access, dest_secret = rgw_utils.get_zone_system_keys(ctx, dest_client,
+                                                                 dest_zone)
+        sync_scope = cconf.get('sync-scope', None)
+        port = cconf.get('port', 8000)
+        daemon_name = '{host}.{port}.syncdaemon'.format(host=remote.name, port=port)
+        in_args=[
+                       '{tdir}/daemon-helper'.format(tdir=testdir), 'kill',
+                       '{tdir}/radosgw-agent.{client}/radosgw-agent'.format(tdir=testdir,
+                                                                            client=client),
+                       '-v',
+                       '--src-access-key', src_access,
+                       '--src-secret-key', src_secret,
+                       '--src-host', src_host,
+                       '--src-port', str(src_port),
+                       '--src-zone', src_zone,
+                       '--dest-access-key', dest_access,
+                       '--dest-secret-key', dest_secret,
+                       '--dest-host', dest_host,
+                       '--dest-port', str(dest_port),
+                       '--dest-zone', dest_zone,
+                       '--daemon-id', daemon_name,
+                       '--log-file', '{tdir}/archive/rgw_sync_agent.{client}.log'.format(
+                           tdir=testdir,
+                           client=client),
+                       ]
+        # the test server and full/incremental flags are mutually exclusive
+        if sync_scope is None:
+            in_args.append('--test-server-host')
+            in_args.append('0.0.0.0') 
+            in_args.append('--test-server-port')
+            in_args.append(str(port))
+        else:
+            in_args.append('--sync-scope')
+            in_args.append(sync_scope)
+
+        return_list.append((client, remote.run(
+            args=in_args,
+                       wait=False,
+                       stdin=run.PIPE,
+                       logger=log.getChild(daemon_name),
+                       )))
+    return return_list
 
 
 @contextlib.contextmanager
@@ -84,7 +122,16 @@ def task(ctx, config):
     to 0.0.0.0. Port defaults to 8000. This must be run on clients
     that have the correct zone root pools and rgw zone set in
     ceph.conf, or the task cannot read the region information from the
-    cluster. An example::
+    cluster. 
+
+    By default, this task will start an HTTP server that will trigger full
+    or incremental syncs based on requests made to it. 
+    Alternatively, a single full sync can be triggered by
+    specifying 'sync-scope: full' or a loop of incremental syncs can be triggered
+    by specifying 'sync-scope: incremental' (the loop will sleep
+    '--incremental-sync-delay' seconds between each sync, default is 20 seconds).
+    
+    An example::
 
       tasks:
       - ceph:
@@ -98,8 +145,10 @@ def task(ctx, config):
       - rgw: # region configuration omitted for brevity
       - radosgw-agent:
           client.0:
+            branch: wip-next-feature-branch
             src: client.0
             dest: client.1
+            sync-scope: full
             # port: 8000 (default)
           client.1:
             src: client.1
@@ -109,12 +158,17 @@ def task(ctx, config):
     assert isinstance(config, dict), 'rgw_sync_agent requires a dictionary config'
     log.debug("config is %s", config)
 
+    overrides = ctx.config.get('overrides', {})
+    # merge each client section, but only if it exists in config since there isn't
+    # a sensible default action for this task
+    for client in config.iterkeys():
+        if config[client]:
+            log.debug('config[{client}]: {data}'.format(client=client, data=config[client]))
+            teuthology.deep_merge(config[client], overrides.get('radosgw-agent', {}))
 
     ctx.radosgw_agent = argparse.Namespace()
-    ctx.radosgw_agent.config = config
 
-    procs = [(client, run_radosgw_agent(ctx, client, c_config)) for
-             client, c_config in config.iteritems()]
+    procs = run_radosgw_agent(ctx, config)
 
     ctx.radosgw_agent.procs = procs