Added empty packages and a test for the API v1

Created two packages in queues (api and api/v1)
added a api test to tests/unit/common. Also changed
the common/errors to include invalid operations
error used in test_api.

Change-Id: I32d7a2eebbde50e96cb49391b591c409e6ab6df2

marconi/common/api.py

@@ -0,0 +1,79 @@
+# Copyright (c) 2013 Red Hat, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import jsonschema
+from jsonschema import validators
+
+from marconi.common import errors
+from marconi.openstack.common import log
+
+LOG = log.getLogger(__name__)
+
+
+class Api(object):
+
+    schema = {}
+    validators = {}
+
+    def get_schema(self, operation):
+        """Returns the schema for an operation
+
+        :param operation: Operation for which params need
+        to be validated.
+        :type operation: `six.text_type`
+
+        :returns: Operation's schema
+        :rtype: dict
+
+        :raises: `errors.InvalidOperation` if the operation
+        does not exist
+        """
+        try:
+            return self.schema[operation]
+        except KeyError:
+            # TODO(flaper87): gettext support
+            msg = _('{0} is not a valid operation').format(operation)
+            raise errors.InvalidOperation(msg)
+
+    def validate(self, operation, params):
+        """Validates the request data
+
+        This method relies on jsonschema and exists
+        just as a way for third-party transport to validate
+        the request. It's not recommended to validate every
+        request since they are already validated server side.
+
+        :param operation: Operation's for which params need
+        to be validated.
+        :type operation: `six.text_type`
+        :param params: Params to validate
+        :type params: dict
+
+        :returns: True if the schema is valid, False otherwise
+        :raises: `errors.InvalidOperation` if the operation
+        does not exist
+        """
+
+        if operation not in self.validators:
+            schema = self.get_schema(operation)
+            self.validators[operation] = validators.Draft4Validator(schema)
+
+        try:
+            self.validators[operation].validate(params)
+        except jsonschema.ValidationError:
+            LOG.debug('Operation is invalid.')
+            return False
+
+        return True

marconi/common/errors.py

@@ -20,3 +20,7 @@ class InvalidDriver(Exception):
 
 class PatternNotFound(Exception):
     """A string did not match the expected pattern or regex."""
+
+
+class InvalidOperation(Exception):
+    """Raised when attempted a non existent operation."""

tests/unit/common/test_api.py

@@ -0,0 +1,57 @@
+# Copyright (c) 2013 Red Hat, Inc.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+# implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+from marconi.common import api
+from marconi.common import errors
+from marconi.tests import base
+
+
+class FakeApi(api.Api):
+    schema = {
+        'test_operation': {
+            'ref': 'test/{name}',
+            'method': 'GET',
+            'properties': {
+                'name': {'type': 'string'},
+                'address': {'type': 'string'}
+            },
+
+            'additionalProperties': False,
+            'required': ['name']
+        }
+    }
+
+
+class TestApi(base.TestBase):
+
+    def setUp(self):
+        super(TestApi, self).setUp()
+        self.api = FakeApi()
+
+    def test_valid_params(self):
+        self.assertTrue(self.api.validate('test_operation',
+                                          {'name': 'Sauron'}))
+
+    def test_invalid_params(self):
+        self.assertFalse(self.api.validate('test_operation',
+                                           {'name': 'Sauron',
+                                            'lastname': 'From Mordor'}))
+
+    def test_missing_params(self):
+        self.assertFalse(self.api.validate('test_operation', {}))
+
+    def test_invalid_operation(self):
+        self.assertRaises(errors.InvalidOperation, self.api.validate,
+                          'super_secret_op', {})