From 67ce8e57e4400f6734a999b40ccd8c3f6a489094 Mon Sep 17 00:00:00 2001
From: SerenaFeng <feng.xiaowei@zte.com.cn>
Date: Sat, 4 Jun 2016 13:16:21 +0800
Subject: [PATCH] support 'GET /dashboard/v1/projects' REST api in testAPI

add get_dashboard_projects() in dashboard_utils.py
add DashboardProjectHandler in dashboard_handlers.py
add router mapping in url_mappings.py
add file test_dashboard_project.py to do the unittest

JIRA: FUNCTEST-292

Change-Id: I51ad8dd26abbd8d43c656c8b03ff302227255d11
Signed-off-by: SerenaFeng <feng.xiaowei@zte.com.cn>
---
 .../opnfv_testapi/dashboard/dashboard_utils.py       | 16 ++++++++++++++++
 .../opnfv_testapi/resources/dashboard_handlers.py    | 15 +++++++++++++--
 .../opnfv_testapi/router/url_mappings.py             |  4 +++-
 .../tests/unit/test_dashboard_project.py             | 20 ++++++++++++++++++++
 4 files changed, 52 insertions(+), 3 deletions(-)
 create mode 100644 utils/test/result_collection_api/opnfv_testapi/tests/unit/test_dashboard_project.py

diff --git a/utils/test/result_collection_api/opnfv_testapi/dashboard/dashboard_utils.py b/utils/test/result_collection_api/opnfv_testapi/dashboard/dashboard_utils.py
index 090aaa5b4..f331e28cd 100644
--- a/utils/test/result_collection_api/opnfv_testapi/dashboard/dashboard_utils.py
+++ b/utils/test/result_collection_api/opnfv_testapi/dashboard/dashboard_utils.py
@@ -67,6 +67,22 @@ def get_dashboard_cases():
     return modules
 
 
+def get_dashboard_projects():
+    # Retrieve all the projects that could provide
+    # Dashboard ready graphs
+    # look in the releng repo
+    # search all the project2Dashboard.py files
+    # we assume that dashboard processing of project <Project>
+    # is performed in the <Project>2Dashboard.py file
+    projects = []
+    cp = re.compile('opnfv_testapi\.dashboard\.(.+?)2Dashboard')
+    for module in sys.modules:
+        project = re.findall(cp, module)
+        if project:
+            projects.extend(project)
+    return projects
+
+
 def get_dashboard_result(project, case, results=None):
     # get the dashboard ready results
     # paramters are:
diff --git a/utils/test/result_collection_api/opnfv_testapi/resources/dashboard_handlers.py b/utils/test/result_collection_api/opnfv_testapi/resources/dashboard_handlers.py
index 84e7bc1b0..303e8d164 100644
--- a/utils/test/result_collection_api/opnfv_testapi/resources/dashboard_handlers.py
+++ b/utils/test/result_collection_api/opnfv_testapi/resources/dashboard_handlers.py
@@ -11,8 +11,8 @@ from tornado.web import HTTPError
 
 from opnfv_testapi.common.constants import HTTP_NOT_FOUND
 from opnfv_testapi.dashboard.dashboard_utils import \
-    check_dashboard_ready_project, \
-    check_dashboard_ready_case, get_dashboard_result
+    check_dashboard_ready_project, check_dashboard_ready_case, \
+    get_dashboard_result, get_dashboard_projects
 from opnfv_testapi.resources.result_handlers import GenericResultHandler
 from opnfv_testapi.resources.result_models import TestResult
 from opnfv_testapi.tornado_swagger import swagger
@@ -107,3 +107,14 @@ class DashboardHandler(GenericDashboardHandler):
                 return get_dashboard_result(project, case, res)
 
             self._list(self.set_query(), get_result, project_arg, case_arg)
+
+
+class DashboardProjectsHandler(GenericDashboardHandler):
+    @swagger.operation(nickname='list')
+    def get(self):
+        """
+            @description: Retrieve dashboard ready project(s)
+            @rtype: L{list}
+            @return 200: return all dashboard ready project(s)
+        """
+        self.finish_request(get_dashboard_projects())
diff --git a/utils/test/result_collection_api/opnfv_testapi/router/url_mappings.py b/utils/test/result_collection_api/opnfv_testapi/router/url_mappings.py
index 874754b91..695c27de1 100644
--- a/utils/test/result_collection_api/opnfv_testapi/router/url_mappings.py
+++ b/utils/test/result_collection_api/opnfv_testapi/router/url_mappings.py
@@ -14,7 +14,8 @@ from opnfv_testapi.resources.project_handlers import ProjectCLHandler, \
     ProjectGURHandler
 from opnfv_testapi.resources.result_handlers import ResultsCLHandler, \
     ResultsGURHandler
-from opnfv_testapi.resources.dashboard_handlers import DashboardHandler
+from opnfv_testapi.resources.dashboard_handlers import DashboardHandler, \
+    DashboardProjectsHandler
 
 
 mappings = [
@@ -53,4 +54,5 @@ mappings = [
     # get /dashboard
     #  => get the list of project with dashboard ready results
     (r"/dashboard/v1/results", DashboardHandler),
+    (r"/dashboard/v1/projects", DashboardProjectsHandler),
 ]
diff --git a/utils/test/result_collection_api/opnfv_testapi/tests/unit/test_dashboard_project.py b/utils/test/result_collection_api/opnfv_testapi/tests/unit/test_dashboard_project.py
new file mode 100644
index 000000000..f9d2015be
--- /dev/null
+++ b/utils/test/result_collection_api/opnfv_testapi/tests/unit/test_dashboard_project.py
@@ -0,0 +1,20 @@
+import json
+
+from opnfv_testapi.common.constants import HTTP_OK
+from test_base import TestBase
+
+
+class TestDashboardProjectBase(TestBase):
+    def setUp(self):
+        super(TestDashboardProjectBase, self).setUp()
+        self.basePath = '/dashboard/v1/projects'
+        self.list_res = None
+        self.projects = ['bottlenecks', 'doctor', 'functest',
+                         'promise', 'qtip', 'vsperf', 'yardstick']
+
+
+class TestDashboardProjectGet(TestDashboardProjectBase):
+    def test_list(self):
+        code, body = self.get()
+        self.assertEqual(code, HTTP_OK)
+        self.assertItemsEqual(self.projects, json.loads(body))
-- 
2.16.6