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>

6 files changed, 178 insertions, 0 deletions

diff --git a/functest/api/resources/__init__.py b/functest/api/resources/__init__.py
new file mode 100644
index 000000000..e69de29bb
--- /dev/null
+++ b/functest/api/resources/__init__.py
diff --git a/functest/api/resources/v1/__init__.py b/functest/api/resources/v1/__init__.py
new file mode 100644
index 000000000..e69de29bb
--- /dev/null
+++ b/functest/api/resources/v1/__init__.py
diff --git a/functest/api/resources/v1/creds.py b/functest/api/resources/v1/creds.py
new file mode 100644
index 000000000..e402d7e3a
--- /dev/null
+++ b/functest/api/resources/v1/creds.py
@@ -0,0 +1,29 @@
+#!/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 openstack related requests
+"""
+
+from flask import jsonify
+
+from functest.api.base import ApiResource
+from functest.cli.commands.cli_os import OpenStack
+from functest.utils import openstack_utils as os_utils
+from functest.utils.constants import CONST
+
+
+class V1Creds(ApiResource):
+    """ V1Creds Resource class"""
+
+    def get(self):  # pylint: disable=no-self-use
+        """ Get credentials """
+        os_utils.source_credentials(CONST.__getattribute__('openstack_creds'))
+        credentials_show = OpenStack.show_credentials()
+        return jsonify(credentials_show)
diff --git a/functest/api/resources/v1/envs.py b/functest/api/resources/v1/envs.py
new file mode 100644
index 000000000..35bffb04f
--- /dev/null
+++ b/functest/api/resources/v1/envs.py
@@ -0,0 +1,34 @@
+#!/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 environment related requests
+"""
+
+from flask import jsonify
+
+from functest.api.base import ApiResource
+from functest.cli.commands.cli_env import Env
+import functest.utils.functest_utils as ft_utils
+
+
+class V1Envs(ApiResource):
+    """ V1Envs Resource class"""
+
+    def get(self):  # pylint: disable=no-self-use
+        """ Get environment """
+        environment_show = Env().show()
+        return jsonify(environment_show)
+
+    def post(self):
+        """ Used to handle post request """
+        return self._dispatch_post()
+
+    def prepare(self, args):  # pylint: disable=no-self-use, unused-argument
+        """ Prepare environment """
+        ft_utils.execute_command("prepare_env start")
diff --git a/functest/api/resources/v1/testcases.py b/functest/api/resources/v1/testcases.py
new file mode 100644
index 000000000..c3b8217a1
--- /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)
diff --git a/functest/api/resources/v1/tiers.py b/functest/api/resources/v1/tiers.py
new file mode 100644
index 000000000..71a98bea6
--- /dev/null
+++ b/functest/api/resources/v1/tiers.py
@@ -0,0 +1,67 @@
+#!/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 tier related requests
+"""
+
+import re
+
+from flask import abort, jsonify
+
+from functest.api.base import ApiResource
+from functest.cli.commands.cli_tier import Tier
+
+
+class V1Tiers(ApiResource):
+    """ V1Tiers Resource class """
+
+    def get(self):
+        # pylint: disable=no-self-use
+        """ GET all tiers """
+        tiers_list = Tier().list()
+        data = re.split("[\n\t]", tiers_list)
+        data = [i.strip() for i in data if i != '']
+        data_dict = dict()
+        for i in range(len(data) / 2):
+            one_data = {data[i * 2]: data[i * 2 + 1]}
+            if i == 0:
+                data_dict = one_data
+            else:
+                data_dict.update(one_data)
+        result = {'tiers': data_dict}
+        return jsonify(result)
+
+
+class V1Tier(ApiResource):
+    """ V1Tier Resource class """
+
+    def get(self, tier_name):  # pylint: disable=no-self-use
+        """ GET the info of one tier """
+        testcases = Tier().gettests(tier_name)
+        if not testcases:
+            abort(404, "The tier with name '%s' does not exist." % tier_name)
+        tier_info = Tier().show(tier_name)
+        tier_info.__dict__.pop('name')
+        tier_info.__dict__.pop('tests_array')
+        result = {'tier': tier_name, 'testcases': testcases}
+        result.update(tier_info.__dict__)
+        return jsonify(result)
+
+
+class V1TestcasesinTier(ApiResource):
+    """ V1TestcasesinTier Resource class """
+
+    def get(self, tier_name):  # pylint: disable=no-self-use
+        """ GET all testcases within given tier """
+        testcases = Tier().gettests(tier_name)
+        if not testcases:
+            abort(404, "The tier with name '%s' does not exist." % tier_name)
+        result = {'tier': tier_name, 'testcases': testcases}
+        return jsonify(result)