Create API to run a test case

Two APIs are created here:
1. Run a test case
2. Get the result of the task id

JIRA: FUNCTEST-853

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

14 files changed, 353 insertions, 36 deletions

diff --git a/functest/api/base.py b/functest/api/base.py
index efeab824..ffc56786 100644
--- a/functest/api/base.py
+++ b/functest/api/base.py
@@ -17,7 +17,7 @@ import logging
 from flask import request
 from flask_restful import Resource
 
-from functest.api.common import api_utils, error
+from functest.api.common import api_utils
 
 
 LOGGER = logging.getLogger(__name__)
@@ -58,7 +58,7 @@ class ApiResource(Resource):
         try:
             return getattr(self, action)(args)
         except AttributeError:
-            error.result_handler(status=1, data='No such action')
+            api_utils.result_handler(status=1, data='No such action')
 
 
 # Import modules from package "functest.api.resources"
diff --git a/functest/api/common/api_utils.py b/functest/api/common/api_utils.py
index f518e777..d85acf92 100644
--- a/functest/api/common/api_utils.py
+++ b/functest/api/common/api_utils.py
@@ -18,6 +18,7 @@ import os
 import sys
 from oslo_utils import importutils
 
+from flask import jsonify
 import six
 
 import functest
@@ -89,3 +90,12 @@ def change_obj_to_dict(obj):
     for key, value in vars(obj).items():
         dic.update({key: value})
     return dic
+
+
+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/common/error.py b/functest/api/common/error.py
deleted file mode 100644
index d0045225..00000000
--- a/functest/api/common/error.py
+++ /dev/null
@@ -1,24 +0,0 @@
-#!/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/common/thread.py b/functest/api/common/thread.py
new file mode 100644
index 00000000..fb60aaac
--- /dev/null
+++ b/functest/api/common/thread.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
+
+"""
+Used to handle multi-thread tasks
+"""
+
+import logging
+import threading
+
+from oslo_serialization import jsonutils
+
+
+LOGGER = logging.getLogger(__name__)
+
+
+class TaskThread(threading.Thread):
+    """ Task Thread Class """
+
+    def __init__(self, target, args, handler):
+        super(TaskThread, self).__init__(target=target, args=args)
+        self.target = target
+        self.args = args
+        self.handler = handler
+
+    def run(self):
+        """ Override the function run: run testcase and update database """
+        update_data = {'task_id': self.args.get('task_id'),
+                       'status': 'IN PROGRESS'}
+        self.handler.insert(update_data)
+
+        LOGGER.info('Starting running test case')
+
+        try:
+            data = self.target(self.args)
+        except Exception as err:  # pylint: disable=broad-except
+            LOGGER.exception('Task Failed')
+            update_data = {'status': 'FAIL', 'error': str(err)}
+            self.handler.update_attr(self.args.get('task_id'), update_data)
+        else:
+            LOGGER.info('Task Finished')
+            LOGGER.debug('Result: %s', data)
+            new_data = {'status': 'FINISHED',
+                        'result': jsonutils.dumps(data.get('result', {}))}
+
+            self.handler.update_attr(self.args.get('task_id'), new_data)
diff --git a/functest/api/database/__init__.py b/functest/api/database/__init__.py
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/functest/api/database/__init__.py
diff --git a/functest/api/database/db.py b/functest/api/database/db.py
new file mode 100644
index 00000000..ea861ddb
--- /dev/null
+++ b/functest/api/database/db.py
@@ -0,0 +1,26 @@
+#!/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
+
+"""
+Create database to store task results using sqlalchemy
+"""
+
+from sqlalchemy import create_engine
+from sqlalchemy.ext.declarative import declarative_base
+from sqlalchemy.orm import scoped_session, sessionmaker
+
+
+SQLITE = 'sqlite:////tmp/functest.db'
+
+ENGINE = create_engine(SQLITE, convert_unicode=True)
+DB_SESSION = scoped_session(sessionmaker(autocommit=False,
+                                         autoflush=False,
+                                         bind=ENGINE))
+BASE = declarative_base()
+BASE.query = DB_SESSION.query_property()
diff --git a/functest/api/database/v1/__init__.py b/functest/api/database/v1/__init__.py
new file mode 100644
index 00000000..e69de29b
--- /dev/null
+++ b/functest/api/database/v1/__init__.py
diff --git a/functest/api/database/v1/handlers.py b/functest/api/database/v1/handlers.py
new file mode 100644
index 00000000..7bd286de
--- /dev/null
+++ b/functest/api/database/v1/handlers.py
@@ -0,0 +1,43 @@
+#!/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 tasks: insert the task info into database and update it
+"""
+
+from functest.api.database.db import DB_SESSION
+from functest.api.database.v1.models import Tasks
+
+
+class TasksHandler(object):
+    """ Tasks Handler Class """
+
+    def insert(self, kwargs):  # pylint: disable=no-self-use
+        """ To insert the task info into database """
+        task = Tasks(**kwargs)
+        DB_SESSION.add(task)  # pylint: disable=maybe-no-member
+        DB_SESSION.commit()  # pylint: disable=maybe-no-member
+        return task
+
+    def get_task_by_taskid(self, task_id):  # pylint: disable=no-self-use
+        """ Obtain the task by task id """
+        # pylint: disable=maybe-no-member
+        task = Tasks.query.filter_by(task_id=task_id).first()
+        if not task:
+            raise ValueError
+
+        return task
+
+    def update_attr(self, task_id, attr):
+        """ Update the required attributes of the task """
+        task = self.get_task_by_taskid(task_id)
+
+        for key, value in attr.items():
+            setattr(task, key, value)
+        DB_SESSION.commit()  # pylint: disable=maybe-no-member
diff --git a/functest/api/database/v1/models.py b/functest/api/database/v1/models.py
new file mode 100644
index 00000000..c5de91bc
--- /dev/null
+++ b/functest/api/database/v1/models.py
@@ -0,0 +1,33 @@
+#!/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 tables for tasks
+"""
+
+from sqlalchemy import Column
+from sqlalchemy import Integer
+from sqlalchemy import String
+from sqlalchemy import Text
+
+from functest.api.database.db import BASE
+
+
+class Tasks(BASE):  # pylint: disable=too-few-public-methods, no-init
+    """ Create a table for tasks"""
+
+    __tablename__ = 'tasks'
+    id = Column(Integer, primary_key=True)  # pylint: disable=invalid-name
+    task_id = Column(String(50))
+    status = Column(Integer)
+    error = Column(String(120))
+    result = Column(Text)
+
+    def __repr__(self):
+        return '<Task %r>' % Tasks.task_id
diff --git a/functest/api/resources/v1/envs.py b/functest/api/resources/v1/envs.py
index 35bffb04..9c455198 100644
--- a/functest/api/resources/v1/envs.py
+++ b/functest/api/resources/v1/envs.py
@@ -14,6 +14,7 @@ from flask import jsonify
 
 from functest.api.base import ApiResource
 from functest.cli.commands.cli_env import Env
+from functest.api.common import api_utils
 import functest.utils.functest_utils as ft_utils
 
 
@@ -31,4 +32,9 @@ class V1Envs(ApiResource):
 
     def prepare(self, args):  # pylint: disable=no-self-use, unused-argument
         """ Prepare environment """
-        ft_utils.execute_command("prepare_env start")
+        try:
+            ft_utils.execute_command("prepare_env start")
+        except Exception as err:  # pylint: disable=broad-except
+            return api_utils.result_handler(status=1, data=str(err))
+        return api_utils.result_handler(
+            status=0, data="Prepare env successfully")
diff --git a/functest/api/resources/v1/tasks.py b/functest/api/resources/v1/tasks.py
new file mode 100644
index 00000000..7086e707
--- /dev/null
+++ b/functest/api/resources/v1/tasks.py
@@ -0,0 +1,58 @@
+#!/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 retrieve the task results
+"""
+
+
+import json
+import logging
+import uuid
+
+from flask import jsonify
+
+from functest.api.base import ApiResource
+from functest.api.common import api_utils
+from functest.api.database.v1.handlers import TasksHandler
+
+
+LOGGER = logging.getLogger(__name__)
+
+
+class V1Tasks(ApiResource):
+    """ V1Tasks Resource class"""
+
+    def get(self, task_id):  # pylint: disable=no-self-use
+        """ GET the result of the task id """
+        try:
+            uuid.UUID(task_id)
+        except ValueError:
+            return api_utils.result_handler(status=1, data='Invalid task id')
+
+        task_handler = TasksHandler()
+        try:
+            task = task_handler.get_task_by_taskid(task_id)
+        except ValueError:
+            return api_utils.result_handler(status=1, data='No such task id')
+
+        status = task.status
+        LOGGER.debug('Task status is: %s', status)
+
+        if status not in ['IN PROGRESS', 'FAIL', 'FINISHED']:
+            return api_utils.result_handler(status=1,
+                                            data='internal server error')
+        if status == 'IN PROGRESS':
+            result = {'status': status, 'result': ''}
+        elif status == 'FAIL':
+            result = {'status': status, 'error': task.error}
+        else:
+            result = {'status': status, 'result': json.loads(task.result)}
+
+        return jsonify(result)
diff --git a/functest/api/resources/v1/testcases.py b/functest/api/resources/v1/testcases.py
index c3b8217a..f146c24c 100644
--- a/functest/api/resources/v1/testcases.py
+++ b/functest/api/resources/v1/testcases.py
@@ -11,11 +11,20 @@
 Resources to handle testcase related requests
 """
 
+import os
+import logging
+import uuid
+
 from flask import abort, jsonify
 
 from functest.api.base import ApiResource
-from functest.api.common import api_utils
+from functest.api.common import api_utils, thread
 from functest.cli.commands.cli_testcase import Testcase
+from functest.api.database.v1.handlers import TasksHandler
+from functest.utils.constants import CONST
+import functest.utils.functest_utils as ft_utils
+
+LOGGER = logging.getLogger(__name__)
 
 
 class V1Testcases(ApiResource):
@@ -46,3 +55,61 @@ class V1Testcase(ApiResource):
         result.update(testcase_info)
         result.update({'dependency': dependency_dict})
         return jsonify(result)
+
+    def post(self):
+        """ Used to handle post request """
+        return self._dispatch_post()
+
+    def run_test_case(self, args):
+        """ Run a testcase """
+        try:
+            case_name = args['testcase']
+        except KeyError:
+            return api_utils.result_handler(
+                status=1, data='testcase name must be provided')
+
+        task_id = str(uuid.uuid4())
+
+        task_args = {'testcase': case_name, 'task_id': task_id}
+
+        task_args.update(args.get('opts', {}))
+
+        task_thread = thread.TaskThread(self._run, task_args, TasksHandler())
+        task_thread.start()
+
+        results = {'testcase': case_name, 'task_id': task_id}
+        return jsonify(results)
+
+    def _run(self, args):  # pylint: disable=no-self-use
+        """ The built_in function to run a test case """
+
+        case_name = args.get('testcase')
+
+        if not os.path.isfile(CONST.__getattribute__('env_active')):
+            raise Exception("Functest environment is not ready.")
+        else:
+            try:
+                cmd = "run_tests -t {}".format(case_name)
+                runner = ft_utils.execute_command(cmd)
+            except Exception:  # pylint: disable=broad-except
+                result = 'FAIL'
+                LOGGER.exception("Running test case %s failed!", case_name)
+            if runner == os.EX_OK:
+                result = 'PASS'
+            else:
+                result = 'FAIL'
+
+            env_info = {
+                'installer': CONST.__getattribute__('INSTALLER_TYPE'),
+                'scenario': CONST.__getattribute__('DEPLOY_SCENARIO'),
+                'build_tag': CONST.__getattribute__('BUILD_TAG'),
+                'ci_loop': CONST.__getattribute__('CI_LOOP')
+            }
+            result = {
+                'task_id': args.get('task_id'),
+                'case_name': case_name,
+                'env_info': env_info,
+                'result': result
+            }
+
+            return {'result': result}
diff --git a/functest/api/server.py b/functest/api/server.py
index e246333e..1d47b0dc 100644
--- a/functest/api/server.py
+++ b/functest/api/server.py
@@ -12,6 +12,7 @@ Used to launch Functest RestApi
 
 """
 
+import inspect
 import logging
 import socket
 from urlparse import urljoin
@@ -21,12 +22,28 @@ 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
+from functest.api.database.db import BASE
+from functest.api.database.db import DB_SESSION
+from functest.api.database.db import ENGINE
+from functest.api.database.v1 import models
+from functest.api.urls import URLPATTERNS
 
 
 LOGGER = logging.getLogger(__name__)
 
+APP = Flask(__name__)
+API = Api(APP)
+
+
+@APP.teardown_request
+def shutdown_session(exception=None):  # pylint: disable=unused-argument
+    """
+    To be called at the end of each request whether it is successful
+    or an exception is raised
+    """
+    DB_SESSION.remove()
+
 
 def get_resource(resource_name):
     """ Obtain the required resource according to resource name """
@@ -41,7 +58,7 @@ def get_endpoint(url):
     return urljoin('http://{}:5000'.format(address), url)
 
 
-def api_add_resource(api):
+def api_add_resource():
     """
     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
@@ -49,19 +66,38 @@ def api_add_resource(api):
     """
     for url_pattern in URLPATTERNS:
         try:
-            api.add_resource(
+            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 init_db():
+    """
+    Import all modules here that might define models so that
+    they will be registered properly on the metadata, and then
+    create a database
+    """
+    def func(subcls):
+        """ To check the subclasses of BASE"""
+        try:
+            if issubclass(subcls[1], BASE):
+                return True
+        except TypeError:
+            pass
+        return False
+    # pylint: disable=bad-builtin
+    subclses = filter(func, inspect.getmembers(models, inspect.isclass))
+    LOGGER.debug('Import models: %s', [subcls[1] for subcls in subclses])
+    BASE.metadata.create_all(bind=ENGINE)
+
+
 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')
+    api_add_resource()
+    init_db()
+    APP.run(host='0.0.0.0')
diff --git a/functest/api/urls.py b/functest/api/urls.py
index ca45b4be..160a3c1d 100644
--- a/functest/api/urls.py
+++ b/functest/api/urls.py
@@ -39,6 +39,11 @@ URLPATTERNS = [
     # => GET the info of one testcase
     Url('/api/v1/functest/testcases/<testcase_name>', 'v1_testcase'),
 
+    # POST /api/v1/functest/testcases/action
+    # {"action":"run_test_case", "args": {"opts": {}, "testcase": "vping_ssh"}}
+    # => Run a testcase
+    Url('/api/v1/functest/testcases/action', 'v1_testcase'),
+
     # GET /api/v1/functest/testcases => GET all tiers
     Url('/api/v1/functest/tiers', 'v1_tiers'),
 
@@ -48,5 +53,10 @@ URLPATTERNS = [
 
     # 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')
+    Url('/api/v1/functest/tiers/<tier_name>/testcases',
+        'v1_testcases_in_tier'),
+
+    # GET /api/v1/functest/tasks/<task_id>
+    # => GET the result of the task id
+    Url('/api/v1/functest/tasks/<task_id>', 'v1_tasks')
 ]