Merge "Use jsonschema for testing queue"

marconi/queues/api/v1/response.py

@@ -23,8 +23,7 @@ class ResponseSchema(api.Api):
     def __init__(self, limits):
         self.limits = limits
         self.schema = {
-            'message_get_many':
-            {
+            'message_get_many': {
                 "type": "array",
                 "items": {
                     "type": "object",
@@ -47,9 +46,62 @@ class ResponseSchema(api.Api):
                             "type": "object"
                         }
                     },
-                    "required": ["href", "ttl", "age", "body"]
+                    "required": ["href", "ttl", "age", "body"],
+                    "additionalProperties": False,
                 },
                 "minItems": 1,
                 "maxItems": self.limits.max_messages_per_page
+            },
+
+            'queue_list': {
+                'type': 'object',
+                'properties': {
+                    'links': {
+                        'type': 'array',
+                        'items': {
+                            'type': 'object',
+                            'properties': {
+                                'rel': {
+                                    'type': 'string',
+                                    'enum': ['next'],
+                                },
+                                'href': {
+                                    'type': 'string',
+                                    "pattern": "^/v1/queues\?",
+                                }
+                            },
+                            'required': ['rel', 'href'],
+                            'additionalProperties': False,
+                        },
+                        'minItems': 1,
+                        'maxItems': 1,
+                    },
+                    'queues': {
+                        'type': 'array',
+                        'items': {
+                            'type': 'object',
+                            'properties': {
+                                'name': {
+                                    'type': 'string',
+                                    'pattern': '^[a-zA-Z0-9_-]{1,64}$'
+                                },
+                                'href': {
+                                    'type': 'string',
+                                    'pattern': '^/v1/queues/'
+                                               '[a-zA-Z0-9_-]{1,64}$',
+                                },
+                                'metadata': {
+                                    'type': 'object',
+                                }
+                            },
+                            'required': ['name', 'href'],
+                            'additionalProperties': False,
+                        },
+                        'minItems': 1,
+                        'maxItems': self.limits.max_queues_per_page,
+                    }
+                },
+                'required': ['links', 'queues'],
+                'additionalProperties': False,
             }
         }

marconi/tests/functional/base.py

@@ -21,6 +21,7 @@ import os
 import six
 
 from marconi.openstack.common import timeutils
+from marconi.queues.api.v1 import response
 from marconi.queues import bootstrap
 # TODO(flaper87): This is necessary to register,
 # wsgi configs and won't be permanent. It'll be
@@ -61,6 +62,7 @@ class FunctionalTestBase(testing.TestBase):
 
         validator = validation.Validator(self.mconf)
         self.limits = validator._limits_conf
+        self.response = response.ResponseSchema(self.limits)
 
         if _TEST_INTEGRATION:
             # TODO(kgriffs): This code should be replaced to use
@@ -115,15 +117,16 @@ class FunctionalTestBase(testing.TestBase):
               ', actual count = {1}'.format(expectedCount, actualCount)
         self.assertTrue(actualCount <= expectedCount, msg)
 
-    def assertSchema(self, response, expectedSchema):
+    def assertSchema(self, response, expectedSchemaName):
         """Compares the json response with the expected schema
 
         :param response: response json returned by the API.
         :type response: dict
         :param expectedSchema: expected schema definition for response.
-        :type expectedSchema: dict
+        :type expectedSchema: string
         """
         try:
+            expectedSchema = self.response.get_schema(expectedSchemaName)
             jsonschema.validate(response, expectedSchema)
         except jsonschema.ValidationError as message:
             assert False, message

tests/functional/wsgi/v1/test_messages.py

@@ -17,7 +17,6 @@ import uuid
 
 import ddt
 
-from marconi.queues.api.v1 import response
 from marconi.tests.functional import base
 from marconi.tests.functional import helpers
 
@@ -43,8 +42,6 @@ class TestMessages(base.FunctionalTestBase):
         self.message_url = self.queue_url + '/messages'
         self.client.set_base_url(self.message_url)
 
-        self.response = response.ResponseSchema(self.limits)
-
     def tearDown(self):
         self.client.delete(self.queue_url)
         super(TestMessages, self).tearDown()
@@ -125,8 +122,7 @@ class TestMessages(base.FunctionalTestBase):
                       '(happens randomly)')
 
         # Verify that the response json schema matches the expected schema
-        expected_schema = self.response.get_schema('message_get_many')
-        self.assertSchema(result.json(), expected_schema)
+        self.assertSchema(result.json(), 'message_get_many')
 
         # Compare message metadata
         result_body = [result.json()[i]['body']

tests/functional/wsgi/v1/test_queues.py

@@ -277,10 +277,7 @@ class TestQueueMisc(base.FunctionalTestBase):
         result = self.client.get('/{0}/queues'
                                  .format(self.cfg.marconi.version))
         self.assertEqual(result.status_code, 200)
-
-        response_keys = result.json().keys()
-        for key in ['links', 'queues']:
-            self.assertIn(key, response_keys)
+        self.assertSchema(result.json(), 'queue_list')
 
     test_list_queues.tags = ['smoke', 'positive']
 
@@ -295,10 +292,10 @@ class TestQueueMisc(base.FunctionalTestBase):
                                  .format(self.cfg.marconi.version),
                                  params=params)
         self.assertEqual(result.status_code, 200)
+        self.assertSchema(result.json(), 'queue_list')
 
         response_keys = result.json()['queues'][0].keys()
-        for key in ['href', 'metadata', 'name']:
-            self.assertIn(key, response_keys)
+        self.assertIn('metadata', response_keys)
 
     test_list_queues_detailed.tags = ['smoke', 'positive']