Add API to show test case documentation

JIRA: YARDSTICK-694

We need API to show test case documentation.
API: /yardstick/testcases/<testcase_name>/docs
method: GET

example:
http://192.168.131.2:8888/yardstick/testcases/opnfv_yardstick_tc002/docs

Change-Id: Ib8d591f0ff5f91c4d0a740539727ec73ddd86249
Signed-off-by: chenjiankun <chenjiankun1@huawei.com>

1 files changed, 30 insertions, 0 deletions

diff --git a/api/resources/case_docs.py b/api/resources/case_docs.py
new file mode 100644
index 000000000..289410d2d
--- /dev/null
+++ b/api/resources/case_docs.py
@@ -0,0 +1,30 @@
+import os
+import logging
+
+from api.utils.common import result_handler
+from yardstick.common import constants as consts
+
+LOG = logging.getLogger(__name__)
+LOG.setLevel(logging.DEBUG)
+
+
+def default(args):
+    return get_case_docs(args)
+
+
+def get_case_docs(args):
+    try:
+        case_name = args['case_name']
+    except KeyError:
+        return result_handler(consts.API_ERROR, 'case_name must be provided')
+
+    docs_path = os.path.join(consts.DOCS_DIR, '{}.rst'.format(case_name))
+
+    if not os.path.exists(docs_path):
+        return result_handler(consts.API_ERROR, 'case not exists')
+
+    LOG.info('Reading %s', case_name)
+    with open(docs_path) as f:
+        content = f.read()
+
+    return result_handler(consts.API_SUCCESS, {'docs': content})