API proposal for functest

1. Propose a basic framework for API
2. And these functions have been realized:
   1) Show environment
   2) Prepare Environment
   3) Show credentials
   4) List all testcases
   5) Show a testcase
   6) List all tiers
   7) Show a tier
   8) List all testcases within given tier

JIRA: FUNCTEST-843

Change-Id: Ib961446708077b56465eda0052f6d38806b62594
Signed-off-by: Linda Wang <wangwulin@huawei.com>

1 files changed, 48 insertions, 0 deletions

diff --git a/functest/api/resources/v1/testcases.py b/functest/api/resources/v1/testcases.py
new file mode 100644
index 00000000..c3b8217a
--- /dev/null
+++ b/functest/api/resources/v1/testcases.py
@@ -0,0 +1,48 @@
+#!/usr/bin/env python
+
+# Copyright (c) 2017 Huawei Technologies Co.,Ltd and others.
+#
+# All rights reserved. This program and the accompanying materials
+# are made available under the terms of the Apache License, Version 2.0
+# which accompanies this distribution, and is available at
+# http://www.apache.org/licenses/LICENSE-2.0
+
+"""
+Resources to handle testcase related requests
+"""
+
+from flask import abort, jsonify
+
+from functest.api.base import ApiResource
+from functest.api.common import api_utils
+from functest.cli.commands.cli_testcase import Testcase
+
+
+class V1Testcases(ApiResource):
+    """ V1Testcases Resource class"""
+
+    def get(self):  # pylint: disable=no-self-use
+        """ GET all testcases """
+        testcases_list = Testcase().list()
+        result = {'testcases': testcases_list.split('\n')[:-1]}
+        return jsonify(result)
+
+
+class V1Testcase(ApiResource):
+    """ V1Testcase Resource class"""
+
+    def get(self, testcase_name):  # pylint: disable=no-self-use
+        """ GET the info of one testcase"""
+        testcase = Testcase().show(testcase_name)
+        if not testcase:
+            abort(404, "The test case '%s' does not exist or is not supported"
+                  % testcase_name)
+        testcase_info = api_utils.change_obj_to_dict(testcase)
+        dependency_dict = api_utils.change_obj_to_dict(
+            testcase_info.get('dependency'))
+        testcase_info.pop('name')
+        testcase_info.pop('dependency')
+        result = {'testcase': testcase_name}
+        result.update(testcase_info)
+        result.update({'dependency': dependency_dict})
+        return jsonify(result)