Add docstrings. Fix formatting issues for rgw.py

Fix s3tests calls for rgw-logsocket.py.

Fixes: 6540
Signed-off-by: Warren Usui <warren.usui@inktank.com>

diff --git a/teuthology/task/rgw-logsocket.py b/teuthology/task/rgw-logsocket.py
index d71c4200f32678665045724c7a68773c88619edb..6f49b00d8a420f39a3f9ef973be69057fcd877b2 100644 (file)
--- a/teuthology/task/rgw-logsocket.py
+++ b/teuthology/task/rgw-logsocket.py
@@ -1,3 +1,6 @@
+"""
+rgw s3tests logging wrappers
+"""
 from cStringIO import StringIO
 from configobj import ConfigObj
 import contextlib
@@ -12,28 +15,42 @@ log = logging.getLogger(__name__)
 
 @contextlib.contextmanager
 def download(ctx, config):
-    return s3tests.do_download(ctx, config)
+    """
+    Run s3tests download function
+    """
+    return s3tests.download(ctx, config)
 
 def _config_user(s3tests_conf, section, user):
+    """
+    Run s3tests user config function
+    """
     return s3tests._config_user(s3tests_conf, section, user)
 
 @contextlib.contextmanager
 def create_users(ctx, config):
-    return s3tests.do_create_users(ctx, config)
+    """
+    Run s3tests user create function
+    """
+    return s3tests.create_users(ctx, config)
 
 @contextlib.contextmanager
 def configure(ctx, config):
-    return s3tests.do_configure(ctx, config)
+    """
+    Run s3tests user configure function
+    """
+    return s3tests.configure(ctx, config)
 
 @contextlib.contextmanager
 def run_tests(ctx, config):
+    """
+    Run remote netcat tests
+    """
     assert isinstance(config, dict)
     testdir = teuthology.get_testdir(ctx)
     for client, client_config in config.iteritems():
         client_config['extra_args'] = [
-                                        's3tests.functional.test_s3:test_bucket_list_return_data',
-                                      ]
-
+            's3tests.functional.test_s3:test_bucket_list_return_data',
+        ]
 #        args = [
 #                'S3TEST_CONF={tdir}/archive/s3-tests.{client}.conf'.format(tdir=testdir, client=client),
 #                '{tdir}/s3-tests/virtualenv/bin/nosetests'.format(tdir=testdir),
@@ -49,7 +66,7 @@ def run_tests(ctx, config):
 #            args=args,
 #            )
 
-    s3tests.do_run_tests(ctx, config)
+    s3tests.run_tests(ctx, config)
 
     netcat_out = StringIO()
 

diff --git a/teuthology/task/rgw.py b/teuthology/task/rgw.py
index 50ec0300c6944b21dd75e0f4114011f75071babc..5d1c1097f470701fde93244dee0028de1f0eeb6e 100644 (file)
--- a/teuthology/task/rgw.py
+++ b/teuthology/task/rgw.py
@@ -1,3 +1,6 @@
+"""
+rgw routines
+"""
 import argparse
 import contextlib
 import json
@@ -16,6 +19,9 @@ log = logging.getLogger(__name__)
 
 @contextlib.contextmanager
 def create_dirs(ctx, config):
+    """
+    Remotely create apache directories.  Delete when finished.
+    """
     log.info('Creating apache directories...')
     testdir = teuthology.get_testdir(ctx)
     for client in config.iterkeys():
@@ -63,6 +69,9 @@ def create_dirs(ctx, config):
 
 @contextlib.contextmanager
 def ship_config(ctx, config, role_endpoints):
+    """
+    Ship apache config and rgw.fgci to all clients.  Clean up on termination
+    """
     assert isinstance(config, dict)
     assert isinstance(role_endpoints, dict)
     testdir = teuthology.get_testdir(ctx)
@@ -133,6 +142,9 @@ exec radosgw -f -n {client} -k /etc/ceph/ceph.{client}.keyring --rgw-socket-path
 
 @contextlib.contextmanager
 def start_rgw(ctx, config):
+    """
+    Start rgw on remote sites.
+    """
     log.info('Starting rgw...')
     testdir = teuthology.get_testdir(ctx)
     for client in config.iterkeys():
@@ -144,7 +156,7 @@ def start_rgw(ctx, config):
         log.info("rgw %s config is %s", client, client_config)
         id_ = client.split('.', 1)[1]
         log.info('client {client} is id {id}'.format(client=client, id=id_))
-        run_cmd=[
+        run_cmd = [
             'sudo',
             'adjust-ulimits',
             'ceph-coverage',
@@ -152,7 +164,7 @@ def start_rgw(ctx, config):
             'daemon-helper',
             'term',
             ]
-        run_cmd_tail=[
+        run_cmd_tail = [
             'radosgw',
             '-n', client,
             '-k', '/etc/ceph/ceph.{client}.keyring'.format(client=client),
@@ -212,6 +224,9 @@ def start_rgw(ctx, config):
 
 @contextlib.contextmanager
 def start_apache(ctx, config):
+    """
+    Start apache on remote sites.
+    """
     log.info('Starting apache...')
     testdir = teuthology.get_testdir(ctx)
     apaches = {}
@@ -249,6 +264,10 @@ def start_apache(ctx, config):
         run.wait(apaches.itervalues())
 
 def extract_user_info(client_config):
+    """
+    Extract user info from the client config specified.  Returns a dict
+    that includes system key information.
+    """
     # test if there isn't a system user or if there isn't a name for that user, return None
     if 'system user' not in client_config or 'name' not in client_config['system user']:
         return None
@@ -262,7 +281,12 @@ def extract_user_info(client_config):
     return user_info
 
 def extract_zone_info(ctx, client, client_config):
-
+    """
+    Get zone information.
+    :param client: dictionary of client information
+    :param client_config: dictionary of client configuration information
+    :returns: zone extracted from client and client_config information
+    """
     ceph_config = ctx.ceph.conf.get('global', {})
     ceph_config.update(ctx.ceph.conf.get('client', {}))
     ceph_config.update(ctx.ceph.conf.get(client, {}))
@@ -276,7 +300,7 @@ def extract_zone_info(ctx, client, client_config):
     for key in ['rgw control pool', 'rgw gc pool', 'rgw log pool', 'rgw intent log pool',
                 'rgw usage log pool', 'rgw user keys pool', 'rgw user email pool',
                 'rgw user swift pool', 'rgw user uid pool', 'rgw domain root']:
-        new_key = key.split(' ',1)[1]
+        new_key = key.split(' ', 1)[1]
         new_key = new_key.replace(' ', '_')
 
         if key in ceph_config:
@@ -303,6 +327,15 @@ def extract_zone_info(ctx, client, client_config):
     return region, zone, zone_info
 
 def extract_region_info(region, region_info):
+    """
+    Extract region information from the region_info parameter, using get
+    to set default values.
+
+    :param region: name of the region
+    :param region_info: region information (in dictionary form).
+    :returns: dictionary of region information set from region_info, using
+            default values for missing fields.
+    """
     assert isinstance(region_info['zones'], list) and region_info['zones'], \
            'zones must be a non-empty list'
     return dict(
@@ -317,6 +350,9 @@ def extract_region_info(region, region_info):
         )
 
 def assign_ports(ctx, config):
+    """
+    Assign port numberst starting with port 7280.
+    """
     port = 7280
     role_endpoints = {}
     for remote, roles_for_host in ctx.cluster.remotes.iteritems():
@@ -328,6 +364,13 @@ def assign_ports(ctx, config):
     return role_endpoints
 
 def fill_in_endpoints(region_info, role_zones, role_endpoints):
+    """
+    Iterate through the list of role_endpoints, filling in zone information
+
+    :param region_info: region data
+    :param role_zones: region and zone information.
+    :param role_endpoints: endpoints being used
+    """
     for role, (host, port) in role_endpoints.iteritems():
         region, zone, zone_info, _ = role_zones[role]
         host, port = role_endpoints[role]
@@ -337,7 +380,7 @@ def fill_in_endpoints(region_info, role_zones, role_endpoints):
         # If not, throw a reasonable error
         if region not in region_info:
             raise Exception('Region: {region} was specified but no corresponding' \
-                            ' entry was round under \'regions\''.format(region=region))
+                            ' entry was found under \'regions\''.format(region=region))
 
         region_conf = region_info[region]
         region_conf.setdefault('endpoints', [])
@@ -351,7 +394,7 @@ def fill_in_endpoints(region_info, role_zones, role_endpoints):
         # Pull the log meta and log data settings out of zone_info, if they exist, then pop them
         # as they don't actually belong in the zone info
         for key in ['rgw log meta', 'rgw log data']:
-            new_key = key.split(' ',1)[1]
+            new_key = key.split(' ', 1)[1]
             new_key = new_key.replace(' ', '_')
 
             if key in zone_info:
@@ -366,6 +409,10 @@ def fill_in_endpoints(region_info, role_zones, role_endpoints):
 
 @contextlib.contextmanager
 def configure_users(ctx, config):
+    """
+    Create users by remotely running rgwadmin commands using extracted
+    user information.
+    """
     log.info('Configuring users...')
 
     # extract the user info and append it to the payload tuple for the given client
@@ -395,6 +442,9 @@ def configure_users(ctx, config):
 
 @contextlib.contextmanager
 def configure_regions_and_zones(ctx, config, regions, role_endpoints):
+    """
+    Configure regions and zones from rados and rgw.
+    """
     if not regions:
         log.debug('In rgw.configure_regions_and_zones() and regions is None. Bailing')
         yield