integration of tornado and swagger-ui

this code will be applied to testApi later, as regards how to use it,
please refer utils/test/result_collection_api/tornado_swagger_ui/README.md

JIRA: FUNCTEST-247

Change-Id: Ie40e125846add7ceda15f05a38232dc8813b8f29
Signed-off-by: SerenaFeng <feng.xiaowei@zte.com.cn>

1 files changed, 146 insertions, 0 deletions

diff --git a/utils/test/result_collection_api/tornado_swagger_ui/example/basic.py b/utils/test/result_collection_api/tornado_swagger_ui/example/basic.py
new file mode 100644
index 000000000..ded99d55d
--- /dev/null
+++ b/utils/test/result_collection_api/tornado_swagger_ui/example/basic.py
@@ -0,0 +1,146 @@
+import json
+
+import tornado.ioloop
+from tornado.web import RequestHandler, HTTPError
+from tornado_swagger import swagger
+
+DEFAULT_REPRESENTATION = "application/json"
+HTTP_BAD_REQUEST = 400
+HTTP_FORBIDDEN = 403
+HTTP_NOT_FOUND = 404
+
+swagger.docs()
+
+
+@swagger.model
+class PropertySubclass:
+    def __init__(self, sub_property=None):
+        self.sub_property = sub_property
+
+
+@swagger.model
+class Item:
+    """
+        @description:
+            This is an example of a model class that has parameters in its constructor
+            and the fields in the swagger spec are derived from the parameters to __init__.
+        @notes:
+            In this case we would have property1, name as required parameters and property3 as optional parameter.
+        @property property3: Item description
+        @ptype property3: L{PropertySubclass}
+    """
+    def __init__(self, property1, property2=None, property3=None):
+        self.property1 = property1
+        self.property2 = property2
+        self.property3 = property3
+
+items = {}
+
+
+class GenericApiHandler(RequestHandler):
+    """
+    The purpose of this class is to take benefit of inheritance and prepare
+    a set of common functions for
+    the handlers
+    """
+
+    def initialize(self):
+        """ Prepares the database for the entire class """
+        pass
+
+    def prepare(self):
+        if not (self.request.method == "GET" or self.request.method == "DELETE"):
+            if self.request.headers.get("Content-Type") is not None:
+                if self.request.headers["Content-Type"].startswith(DEFAULT_REPRESENTATION):
+                    try:
+                        self.json_args = json.loads(self.request.body)
+                    except (ValueError, KeyError, TypeError) as error:
+                        raise HTTPError(HTTP_BAD_REQUEST,
+                                        "Bad Json format [{}]".
+                                        format(error))
+                else:
+                    self.json_args = None
+
+    def finish_request(self, json_object):
+        self.write(json.dumps(json_object))
+        self.set_header("Content-Type", DEFAULT_REPRESENTATION)
+        self.finish()
+
+
+class ItemNoParamHandler(GenericApiHandler):
+    @swagger.operation(nickname='create')
+    def post(self):
+        """
+            @param body: create test results for a pod.
+            @type body: L{Item}
+            @return 200: pod is created.
+            @raise 400: invalid input
+        """
+        property1 = self.json_args.get('property1')
+        items[property1] = self.json_args
+        self.finish_request(items[property1])
+
+    @swagger.operation(nickname='list')
+    def get(self):
+        """
+           @rtype: L{Item}
+        """
+        self.finish_request(items)
+
+    def options(self):
+        """
+        I'm not visible in the swagger docs
+        """
+        self.finish_request("I'm invisible in the swagger docs")
+
+
+class ItemHandler(GenericApiHandler):
+    @swagger.operation(nickname='get')
+    def get(self, arg):
+        """
+            @rtype: L{Item}
+            @description: get pod's test results
+            @notes:
+                get a pod test results,
+
+                This will be added to the Implementation Notes.It lets you put very long text in your api.
+        """
+        self.finish_request(items[arg])
+
+    @swagger.operation(nickname='delete')
+    def delete(self, arg):
+        """
+            @description: delete pod by pod_id
+            @notes:
+                delete test results of a pod
+
+                This will be added to the Implementation Notes.It lets you put very long text in your api.
+        """
+        del items[arg]
+        self.finish_request("success")
+
+
+class ItemOptionParamHandler(GenericApiHandler):
+    @swagger.operation(nickname='create')
+    def post(self, arg1, arg2=''):
+        """
+        @return 200: case is created
+        """
+        print("ProjectHandler.post: %s -- %s -- %s" % (arg1, arg2, self.request.full_url()))
+        fs = open("/home/swagger/tornado-rest-swagger/%s/%s" % (arg1, arg2), "wb")
+        fs.write(self.request.body)
+        self.write("success")
+
+
+def make_app():
+    return swagger.Application([
+        (r"/items", ItemNoParamHandler),
+        (r"/items/([^/]+)", ItemHandler),
+        (r"/items/([^/]+)/cases/([^/]+)", ItemOptionParamHandler),
+    ])
+
+
+if __name__ == "__main__":
+    app = make_app()
+    app.listen(711)
+    tornado.ioloop.IOLoop.current().start()