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>

13 files changed, 478 insertions, 0 deletions

diff --git a/functest/api/__init__.py b/functest/api/__init__.py
new file mode 100644
index 000000000..e69de29bb
--- /dev/null
+++ b/functest/api/__init__.py
diff --git a/functest/api/base.py b/functest/api/base.py
new file mode 100644
index 000000000..efeab8243
--- /dev/null
+++ b/functest/api/base.py
@@ -0,0 +1,66 @@
+#!/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
+
+"""
+The base class to dispatch request
+
+"""
+
+import logging
+
+from flask import request
+from flask_restful import Resource
+
+from functest.api.common import api_utils, error
+
+
+LOGGER = logging.getLogger(__name__)
+
+
+class ApiResource(Resource):
+    """ API Resource class"""
+
+    def __init__(self):
+        super(ApiResource, self).__init__()
+
+    def _post_args(self):  # pylint: disable=no-self-use
+        # pylint: disable=maybe-no-member
+        """ Return action and args after parsing request """
+
+        data = request.json if request.json else {}
+        params = api_utils.change_to_str_in_dict(data)
+        action = params.get('action', request.form.get('action', ''))
+        args = params.get('args', {})
+        try:
+            args['file'] = request.files['file']
+        except KeyError:
+            pass
+        LOGGER.debug('Input args are: action: %s, args: %s', action, args)
+
+        return action, args
+
+    def _dispatch_post(self):
+        """ Dispatch request """
+        action, args = self._post_args()
+        return self._dispatch(args, action)
+
+    def _dispatch(self, args, action):
+        """
+        Dynamically load the classes with reflection and
+        obtain corresponding methods
+        """
+        try:
+            return getattr(self, action)(args)
+        except AttributeError:
+            error.result_handler(status=1, data='No such action')
+
+
+# Import modules from package "functest.api.resources"
+# and append them into sys.modules
+api_utils.import_modules_from_package("functest.api.resources")
diff --git a/functest/api/common/__init__.py b/functest/api/common/__init__.py
new file mode 100644
index 000000000..e69de29bb
--- /dev/null
+++ b/functest/api/common/__init__.py
diff --git a/functest/api/common/api_utils.py b/functest/api/common/api_utils.py
new file mode 100644
index 000000000..f518e777c
--- /dev/null
+++ b/functest/api/common/api_utils.py
@@ -0,0 +1,91 @@
+#!/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
+
+"""
+Utils for functest restapi
+
+"""
+
+import collections
+import logging
+import os
+import sys
+from oslo_utils import importutils
+
+import six
+
+import functest
+
+LOGGER = logging.getLogger(__name__)
+
+
+def change_to_str_in_dict(obj):
+    """
+    Return a dict with key and value both in string if they are in Unicode
+    """
+    if isinstance(obj, collections.Mapping):
+        return {str(k): change_to_str_in_dict(v) for k, v in obj.items()}
+    elif isinstance(obj, list):
+        return [change_to_str_in_dict(ele) for ele in obj]
+    elif isinstance(obj, six.text_type):
+        return str(obj)
+    return obj
+
+
+def itersubclasses(cls, _seen=None):
+    """ Generator over all subclasses of a given class in depth first order """
+
+    if not isinstance(cls, type):
+        raise TypeError("itersubclasses must be called with "
+                        "new-style classes, not %.100r" % cls)
+    _seen = _seen or set()
+    try:
+        subs = cls.__subclasses__()
+    except TypeError:   # fails only when cls is type
+        subs = cls.__subclasses__(cls)
+    for sub in subs:
+        if sub not in _seen:
+            _seen.add(sub)
+            yield sub
+            for itersub in itersubclasses(sub, _seen):
+                yield itersub
+
+
+def import_modules_from_package(package):
+    """
+    Import modules from package and append into sys.modules
+    :param: package - Full package name. For example: functest.api.resources
+    """
+    path = [os.path.dirname(functest.__file__), ".."] + package.split(".")
+    path = os.path.join(*path)
+    for root, _, files in os.walk(path):
+        for filename in files:
+            if filename.startswith("__") or not filename.endswith(".py"):
+                continue
+            new_package = ".".join(root.split(os.sep)).split("....")[1]
+            module_name = "%s.%s" % (new_package, filename[:-3])
+            try:
+                try_append_module(module_name, sys.modules)
+            except ImportError:
+                LOGGER.exception("unable to import %s", module_name)
+
+
+def try_append_module(name, modules):
+    """ Append the module into specified module system """
+
+    if name not in modules:
+        modules[name] = importutils.import_module(name)
+
+
+def change_obj_to_dict(obj):
+    """  Transfer the object into dict """
+    dic = {}
+    for key, value in vars(obj).items():
+        dic.update({key: value})
+    return dic
diff --git a/functest/api/common/error.py b/functest/api/common/error.py
new file mode 100644
index 000000000..d00452252
--- /dev/null
+++ b/functest/api/common/error.py
@@ -0,0 +1,24 @@
+#!/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
+
+"""
+Used to handle results
+
+"""
+
+from flask import jsonify
+
+
+def result_handler(status, data):
+    """ Return the json format of result in dict """
+    result = {
+        'status': status,
+        'result': data
+    }
+    return jsonify(result)
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)
diff --git a/functest/api/server.py b/functest/api/server.py
new file mode 100644
index 000000000..e246333ef
--- /dev/null
+++ b/functest/api/server.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
+
+"""
+Used to launch Functest RestApi
+
+"""
+
+import logging
+import socket
+from urlparse import urljoin
+import pkg_resources
+
+from flask import Flask
+from flask_restful import Api
+
+from functest.api.base import ApiResource
+from functest.api.urls import URLPATTERNS
+from functest.api.common import api_utils
+
+
+LOGGER = logging.getLogger(__name__)
+
+
+def get_resource(resource_name):
+    """ Obtain the required resource according to resource name """
+    name = ''.join(resource_name.split('_'))
+    return next((r for r in api_utils.itersubclasses(ApiResource)
+                 if r.__name__.lower() == name))
+
+
+def get_endpoint(url):
+    """ Obtain the endpoint of url """
+    address = socket.gethostbyname(socket.gethostname())
+    return urljoin('http://{}:5000'.format(address), url)
+
+
+def api_add_resource(api):
+    """
+    The resource has multiple URLs and you can pass multiple URLs to the
+    add_resource() method on the Api object. Each one will be routed to
+    your Resource
+    """
+    for url_pattern in URLPATTERNS:
+        try:
+            api.add_resource(
+                get_resource(url_pattern.target), url_pattern.url,
+                endpoint=get_endpoint(url_pattern.url))
+        except StopIteration:
+            LOGGER.error('url resource not found: %s', url_pattern.url)
+
+
+def main():
+    """Entry point"""
+    logging.config.fileConfig(pkg_resources.resource_filename(
+        'functest', 'ci/logging.ini'))
+    LOGGER.info('Starting Functest server')
+    app = Flask(__name__)
+    api = Api(app)
+    api_add_resource(api)
+    app.run(host='0.0.0.0')
diff --git a/functest/api/urls.py b/functest/api/urls.py
new file mode 100644
index 000000000..ca45b4beb
--- /dev/null
+++ b/functest/api/urls.py
@@ -0,0 +1,52 @@
+#!/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
+
+"""
+Define multiple URLs
+"""
+
+
+class Url(object):  # pylint: disable=too-few-public-methods
+    """ Url Class """
+
+    def __init__(self, url, target):
+        super(Url, self).__init__()
+        self.url = url
+        self.target = target
+
+
+URLPATTERNS = [
+    # GET /api/v1/functest/envs => GET environment
+    Url('/api/v1/functest/envs', 'v1_envs'),
+
+    # POST /api/v1/functest/envs/action , {"action":"prepare"}
+    # => Prepare environment
+    Url('/api/v1/functest/envs/action', 'v1_envs'),
+
+    # GET /api/v1/functest/openstack/credentials => GET credentials
+    Url('/api/v1/functest/openstack/credentials', 'v1_creds'),
+
+    # GET /api/v1/functest/testcases => GET all testcases
+    Url('/api/v1/functest/testcases', 'v1_test_cases'),
+
+    # GET /api/v1/functest/testcases/<testcase_name>
+    # => GET the info of one testcase
+    Url('/api/v1/functest/testcases/<testcase_name>', 'v1_testcase'),
+
+    # GET /api/v1/functest/testcases => GET all tiers
+    Url('/api/v1/functest/tiers', 'v1_tiers'),
+
+    # GET /api/v1/functest/tiers/<tier_name>
+    # => GET the info of one tier
+    Url('/api/v1/functest/tiers/<tier_name>', 'v1_tier'),
+
+    # GET /api/v1/functest/tiers/<tier_name>/testcases
+    # => GET all testcases within given tier
+    Url('/api/v1/functest/tiers/<tier_name>/testcases', 'v1_testcases_in_tier')
+]