PEP8 db_type, also break out header verification

toolset/benchmark/test_types/db_type.py

@@ -2,133 +2,149 @@ from benchmark.test_types.framework_test_type import FrameworkTestType
 
 import json
 
+
 class DBTestType(FrameworkTestType):
-  def __init__(self):
-    kwargs = {
-      'name': 'db',
-      'accept_header': self.accept_json,
-      'requires_db': True,
-      'args': ['db_url']
-    }
-    FrameworkTestType.__init__(self, **kwargs)
-
-  def get_url(self):
-    return self.db_url
-
-  def verify(self, base_url):
-    '''Ensures body is valid JSON with a key 'id' and a key 
-    'randomNumber', both of which must map to integers
-    '''
-
-    url = base_url + self.db_url
-    headers, body = self.request_headers_and_body(url)
-    
-    # Empty response
-    if body is None:
-      return [('fail','No response', url)]
-    elif len(body) == 0:
-      return [('fail','Empty Response', url)]
-
-    # Valid JSON? 
-    try: 
-      response = json.loads(body)
-    except ValueError as ve:
-      return [('fail',"Invalid JSON - %s" % ve, url)]
-
-    problems = []
-
-    # We are allowing the single-object array 
-    # e.g. [{'id':5, 'randomNumber':10}] for now, 
-    # but will likely make this fail at some point
-    if type(response) == list:
-      response = response[0]
-      problems.append( ('warn', 'Response is a JSON array. Expected JSON object (e.g. [] vs {})', url) ) 
-
-      # Make sure there was a JSON object inside the array
-      if type(response) != dict:
-        problems.append( ('fail', 'Response is not a JSON object or an array of JSON objects', url) ) 
+
+    def __init__(self):
+        kwargs = {
+            'name': 'db',
+            'accept_header': self.accept_json,
+            'requires_db': True,
+            'args': ['db_url']
+        }
+        FrameworkTestType.__init__(self, **kwargs)
+
+    def get_url(self):
+        return self.db_url
+
+    def verify(self, base_url):
+        '''Ensures body is valid JSON with a key 'id' and a key 
+        'randomNumber', both of which must map to integers
+        '''
+
+        url = base_url + self.db_url
+        headers, body = self.request_headers_and_body(url)
+
+        # Empty response
+        if body is None:
+            return [('fail', 'No response', url)]
+        elif len(body) == 0:
+            return [('fail', 'Empty Response', url)]
+
+        # Valid JSON?
+        try:
+            response = json.loads(body)
+        except ValueError as ve:
+            return [('fail', "Invalid JSON - %s" % ve, url)]
+
+        problems = []
+
+        # We are allowing the single-object array
+        # e.g. [{'id':5, 'randomNumber':10}] for now,
+        # but will likely make this fail at some point
+        if type(response) == list:
+            response = response[0]
+            problems.append(
+                ('warn', 'Response is a JSON array. Expected JSON object (e.g. [] vs {})', url))
+
+            # Make sure there was a JSON object inside the array
+            if type(response) != dict:
+                problems.append(
+                    ('fail', 'Response is not a JSON object or an array of JSON objects', url))
+                return problems
+
+        # Verify response content
+        problems += self._verifyObject(response, url)
+        problems += self._verifyHeaders(headers, url)
+
+        if len(problems) == 0:
+            return [('pass', '', url)]
+        else:
+            return problems
+
+    def _verifyHeaders(self, headers, url):
+        '''Verifies the response headers'''
+
+        problems = []
+
+        if any(v.lower() not in headers for v in ('Server', 'Date', 'Content-Type')):
+            problems.append(
+                ('warn', 'Required response header missing: %s' % v, url))
+        elif all(v.lower() not in headers for v in ('Content-Length', 'Transfer-Encoding')):
+            problems.append(
+                ('warn',
+                 'Required response size header missing, please include either "Content-Length" or "Transfer-Encoding"',
+                 url))
+        else:
+            content_type = headers.get('Content-Type', None)
+            expected_type = 'application/json'
+            includes_charset = 'application/json; charset=utf-8'
+            if content_type == includes_charset:
+                problems.append(
+                    ('warn',
+                     ("Content encoding \"%s\" found where \"%s\" is acceptable.\n"
+                      "Additional response bytes may negatively affect benchmark performance."
+                      % (includes_charset, expected_type)),
+                     url))
+            elif content_type != expected_type:
+                problems.append(
+                    ('warn',
+                     'Unexpected content encoding, found %s, expected %s' % (
+                         content_type, expected_type),
+                     url))
         return problems
 
-    problems += self._verifyObject(response, url)
-
-    # Verify response headers
-    if any(v.lower() not in headers for v in ('Server','Date','Content-Type')):
-      problems.append( ('warn', 'Required response header missing: %s' % v, url) )
-    elif all(v.lower() not in headers for v in ('Content-Length','Transfer-Encoding')):
-      problems.append(
-        ('warn',
-         'Required response size header missing, please include either "Content-Length" or "Transfer-Encoding"',
-         url))
-    else:
-      content_type = headers.get('Content-Type', None)
-      expected_type = 'application/json'
-      includes_charset = 'application/json; charset=utf-8'
-      if content_type == includes_charset:
-        problems.append(
-          ('warn',
-           ("Content encoding \"%s\" found where \"%s\" is acceptable.\n"
-            "Additional response bytes may negatively affect benchmark performance."
-              % (includes_charset, expected_type)),
-           url))
-      elif content_type != expected_type:
-        problems.append(
-          ('warn',
-           'Unexpected content encoding, found %s, expected %s' % (content_type, expected_type),
-           url))
-
-    if len(problems) == 0:
-      return [('pass','',url)]
-    else:
-      return problems
-
-  def _verifyObject(self, db_object, url, max_infraction='fail'):
-    '''Ensure the passed item is a JSON object with 
-    keys 'id' and 'randomNumber' mapping to ints. 
-    Separate method allows the QueryTestType to 
-    reuse these checks'''
-
-    problems = []
-
-    # Dict is expected, handle bytes in non-cases
-    if type(db_object) != dict:
-      got = str(db_object)[:20]
-      if len(str(db_object)) > 20:
-        got = str(db_object)[:17] + '...'
-      return [(max_infraction, "Expected a JSON object, got '%s' instead" % got, url)]
-
-    # Make keys case insensitive
-    db_object = {k.lower(): v for k,v in db_object.iteritems()}
-
-    if any(v not in db_object for v in ('id','randomnumber')):
-      problems.append( (max_infraction, 'Response object was missing required key: %s' % v, url) )
-    
-    # All required keys must be present
-    if len(problems) > 0:
-      return problems
-
-    # Assert key types and values
-    try:
-      response_id = float(db_object["id"])
-      if response_id > 10000 or response_id < 1:
-        problems.append( ('warn', "Response key 'id' should be between 1 and 10,000", url) )
-      if type(db_object["id"]) != int:
-        problems.append(
-          ('warn',
-           ('%s%s' % ("Response key 'id' was not an integer and may result in additional response bytes.",
-                      "Additional response bytes may negatively affect benchmark performance.")),
-           url))
-    except ValueError as ve:
-      problems.append( (max_infraction, "Response key 'id' does not map to a number - %s" % ve, url) ) 
-
-    try:
-      response_rn = float(db_object["randomnumber"])
-      if response_rn > 10000:
-        problems.append(
-          ('warn',
-           "Response key 'randomNumber' is over 10,000. This may negatively affect performance by sending extra bytes.",
-           url))
-
-    except ValueError as ve:
-      problems.append( (max_infraction, "Response key 'randomNumber' does not map to a number - %s" % ve, url) ) 
-
-    return problems
+    def _verifyObject(self, db_object, url, max_infraction='fail'):
+        '''Ensure the passed item is a JSON object with 
+        keys 'id' and 'randomNumber' mapping to ints. 
+        Separate method allows the QueryTestType to 
+        reuse these checks'''
+
+        problems = []
+
+        # Dict is expected, handle bytes in non-cases
+        if type(db_object) != dict:
+            got = str(db_object)[:20]
+            if len(str(db_object)) > 20:
+                got = str(db_object)[:17] + '...'
+            return [(max_infraction, "Expected a JSON object, got '%s' instead" % got, url)]
+
+        # Make keys case insensitive
+        db_object = {k.lower(): v for k, v in db_object.iteritems()}
+
+        if any(v not in db_object for v in ('id', 'randomnumber')):
+            problems.append(
+                (max_infraction, 'Response object was missing required key: %s' % v, url))
+
+        # All required keys must be present
+        if len(problems) > 0:
+            return problems
+
+        # Assert key types and values
+        try:
+            response_id = float(db_object["id"])
+            if response_id > 10000 or response_id < 1:
+                problems.append(
+                    ('warn', "Response key 'id' should be between 1 and 10,000", url))
+            if type(db_object["id"]) != int:
+                problems.append(
+                    ('warn',
+                     ("Response key 'id' was not an integer and may result in additional response bytes.\n",
+                      "Additional response bytes may negatively affect benchmark performance."),
+                     url))
+        except ValueError as ve:
+            problems.append(
+                (max_infraction, "Response key 'id' does not map to a number - %s" % ve, url))
+
+        try:
+            response_rn = float(db_object["randomnumber"])
+            if response_rn > 10000:
+                problems.append(
+                    ('warn',
+                     "Response key 'randomNumber' is over 10,000. This may negatively affect performance by sending extra bytes.",
+                     url))
+        except ValueError as ve:
+            problems.append(
+                (max_infraction, "Response key 'randomNumber' does not map to a number - %s" % ve, url))
+
+        return problems