Yardstick API refactor

JIRA: YARDSTICK-503

Now in api/views.py there are many redundant code.
So I do some refactoring and make it to be a lightweight framework.

Change-Id: Id7cecc95e60f5403b2d26239a3ef41d01bbb542a
Signed-off-by: chenjiankun <chenjiankun1@huawei.com>

5 files changed, 401 insertions, 0 deletions

diff --git a/api/resources/__init__.py b/api/resources/__init__.py
new file mode 100644
index 000000000..e69de29bb
--- /dev/null
+++ b/api/resources/__init__.py
diff --git a/api/resources/env_action.py b/api/resources/env_action.py
new file mode 100644
index 000000000..fa0f95d90
--- /dev/null
+++ b/api/resources/env_action.py
@@ -0,0 +1,259 @@
+##############################################################################
+# Copyright (c) 2016 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
+##############################################################################
+import logging
+import threading
+import subprocess
+import time
+import json
+import os
+import errno
+
+from docker import Client
+
+from yardstick.common import constants as config
+from yardstick.common import utils as yardstick_utils
+from yardstick.common.httpClient import HttpClient
+from api import conf as api_conf
+from api.utils import influx
+from api.utils.common import result_handler
+
+logger = logging.getLogger(__name__)
+
+
+def createGrafanaContainer(args):
+    thread = threading.Thread(target=_create_grafana)
+    thread.start()
+    return result_handler('success', [])
+
+
+def _create_grafana():
+    client = Client(base_url=config.DOCKER_URL)
+
+    try:
+        if not _check_image_exist(client, '%s:%s' % (config.GRAFANA_IMAGE,
+                                                     config.GRAFANA_TAGS)):
+            client.pull(config.GRAFANA_IMAGE, config.GRAFANA_TAGS)
+
+        _create_grafana_container(client)
+
+        time.sleep(5)
+
+        _create_data_source()
+
+        _create_dashboard()
+    except Exception as e:
+        logger.debug('Error: %s', e)
+
+
+def _create_dashboard():
+    url = 'http://admin:admin@%s:3000/api/dashboards/db' % api_conf.GATEWAY_IP
+    with open('../dashboard/ping_dashboard.json') as dashboard_json:
+        data = json.load(dashboard_json)
+    HttpClient().post(url, data)
+
+
+def _create_data_source():
+    url = 'http://admin:admin@%s:3000/api/datasources' % api_conf.GATEWAY_IP
+    data = {
+        "name": "yardstick",
+        "type": "influxdb",
+        "access": "proxy",
+        "url": "http://%s:8086" % api_conf.GATEWAY_IP,
+        "password": "root",
+        "user": "root",
+        "database": "yardstick",
+        "basicAuth": True,
+        "basicAuthUser": "admin",
+        "basicAuthPassword": "admin",
+        "isDefault": False,
+    }
+    HttpClient().post(url, data)
+
+
+def _create_grafana_container(client):
+    ports = [3000]
+    port_bindings = {k: k for k in ports}
+    host_config = client.create_host_config(port_bindings=port_bindings)
+
+    container = client.create_container(image='%s:%s' % (config.GRAFANA_IMAGE,
+                                                         config.GRAFANA_TAGS),
+                                        ports=ports,
+                                        detach=True,
+                                        tty=True,
+                                        host_config=host_config)
+    client.start(container)
+
+
+def _check_image_exist(client, t):
+    return any(t in a['RepoTags'][0] for a in client.images() if a['RepoTags'])
+
+
+def createInfluxDBContainer(args):
+    thread = threading.Thread(target=_create_influxdb)
+    thread.start()
+    return result_handler('success', [])
+
+
+def _create_influxdb():
+    client = Client(base_url=config.DOCKER_URL)
+
+    try:
+        _config_output_file()
+
+        if not _check_image_exist(client, '%s:%s' % (config.INFLUXDB_IMAGE,
+                                                     config.INFLUXDB_TAG)):
+            client.pull(config.INFLUXDB_IMAGE, tag=config.INFLUXDB_TAG)
+
+        _create_influxdb_container(client)
+
+        time.sleep(5)
+
+        _config_influxdb()
+    except Exception as e:
+        logger.debug('Error: %s', e)
+
+
+def _create_influxdb_container(client):
+
+    ports = [8083, 8086]
+    port_bindings = {k: k for k in ports}
+    host_config = client.create_host_config(port_bindings=port_bindings)
+
+    container = client.create_container(image='%s:%s' % (config.INFLUXDB_IMAGE,
+                                                         config.INFLUXDB_TAG),
+                                        ports=ports,
+                                        detach=True,
+                                        tty=True,
+                                        host_config=host_config)
+    client.start(container)
+
+
+def _config_influxdb():
+    try:
+        client = influx.get_data_db_client()
+        client.create_user(config.USER, config.PASSWORD, config.DATABASE)
+        client.create_database(config.DATABASE)
+        logger.info('Success to config influxDB')
+    except Exception as e:
+        logger.debug('Failed to config influxDB: %s', e)
+
+
+def _config_output_file():
+    yardstick_utils.makedirs(config.YARDSTICK_CONFIG_DIR)
+    with open(config.YARDSTICK_CONFIG_FILE, 'w') as f:
+        f.write("""\
+[DEFAULT]
+debug = False
+dispatcher = influxdb
+
+[dispatcher_file]
+file_path = /tmp/yardstick.out
+
+[dispatcher_http]
+timeout = 5
+# target = http://127.0.0.1:8000/results
+
+[dispatcher_influxdb]
+timeout = 5
+target = http://%s:8086
+db_name = yardstick
+username = root
+password = root
+"""
+                % api_conf.GATEWAY_IP)
+
+
+def prepareYardstickEnv(args):
+    thread = threading.Thread(target=_prepare_env_daemon)
+    thread.start()
+    return result_handler('success', [])
+
+
+def _prepare_env_daemon():
+
+    installer_ip = os.environ.get('INSTALLER_IP', 'undefined')
+    installer_type = os.environ.get('INSTALLER_TYPE', 'undefined')
+
+    _check_variables(installer_ip, installer_type)
+
+    _create_directories()
+
+    rc_file = config.OPENSTACK_RC_FILE
+
+    _get_remote_rc_file(rc_file, installer_ip, installer_type)
+
+    _source_file(rc_file)
+
+    _append_external_network(rc_file)
+
+    # update the external_network
+    _source_file(rc_file)
+
+    _load_images()
+
+
+def _check_variables(installer_ip, installer_type):
+
+    if installer_ip == 'undefined':
+        raise SystemExit('Missing INSTALLER_IP')
+
+    if installer_type == 'undefined':
+        raise SystemExit('Missing INSTALLER_TYPE')
+    elif installer_type not in config.INSTALLERS:
+        raise SystemExit('INSTALLER_TYPE is not correct')
+
+
+def _create_directories():
+    yardstick_utils.makedirs(config.YARDSTICK_CONFIG_DIR)
+
+
+def _source_file(rc_file):
+    yardstick_utils.source_env(rc_file)
+
+
+def _get_remote_rc_file(rc_file, installer_ip, installer_type):
+
+    os_fetch_script = os.path.join(config.RELENG_DIR, config.OS_FETCH_SCRIPT)
+
+    try:
+        cmd = [os_fetch_script, '-d', rc_file, '-i', installer_type,
+               '-a', installer_ip]
+        p = subprocess.Popen(cmd, stdout=subprocess.PIPE)
+        p.communicate()[0]
+
+        if p.returncode != 0:
+            logger.debug('Failed to fetch credentials from installer')
+    except OSError as e:
+        if e.errno != errno.EEXIST:
+            raise
+
+
+def _append_external_network(rc_file):
+    neutron_client = yardstick_utils.get_neutron_client()
+    networks = neutron_client.list_networks()['networks']
+    try:
+        ext_network = next(n['name'] for n in networks if n['router:external'])
+    except StopIteration:
+        logger.warning("Can't find external network")
+    else:
+        cmd = 'export EXTERNAL_NETWORK=%s' % ext_network
+        try:
+            with open(rc_file, 'a') as f:
+                f.write(cmd + '\n')
+        except OSError as e:
+            if e.errno != errno.EEXIST:
+                raise
+
+
+def _load_images():
+    cmd = [config.LOAD_IMAGES_SCRIPT]
+    p = subprocess.Popen(cmd, stdout=subprocess.PIPE,
+                         cwd=config.YARDSTICK_REPOS_DIR)
+    output = p.communicate()[0]
+    logger.debug('The result is: %s', output)
diff --git a/api/resources/release_action.py b/api/resources/release_action.py
new file mode 100644
index 000000000..fda0ffd32
--- /dev/null
+++ b/api/resources/release_action.py
@@ -0,0 +1,38 @@
+##############################################################################
+# Copyright (c) 2016 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
+##############################################################################
+import uuid
+import os
+import logging
+
+from api import conf
+from api.utils import common as common_utils
+
+logger = logging.getLogger(__name__)
+
+
+def runTestCase(args):
+    try:
+        opts = args.get('opts', {})
+        testcase = args['testcase']
+    except KeyError:
+        return common_utils.error_handler('Lack of testcase argument')
+
+    testcase = os.path.join(conf.TEST_CASE_PATH,
+                            conf.TEST_CASE_PRE + testcase + '.yaml')
+
+    task_id = str(uuid.uuid4())
+
+    command_list = ['task', 'start']
+    command_list = common_utils.get_command_list(command_list, opts, testcase)
+    logger.debug('The command_list is: %s', command_list)
+
+    logger.debug('Start to execute command list')
+    common_utils.exec_command_task(command_list, task_id)
+
+    return common_utils.result_handler('success', task_id)
diff --git a/api/resources/results.py b/api/resources/results.py
new file mode 100644
index 000000000..3de09fdc9
--- /dev/null
+++ b/api/resources/results.py
@@ -0,0 +1,67 @@
+##############################################################################
+# Copyright (c) 2016 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
+##############################################################################
+import logging
+import uuid
+import re
+
+from api.utils import influx as influx_utils
+from api.utils import common as common_utils
+from api import conf
+
+logger = logging.getLogger(__name__)
+
+
+def default(args):
+    return getResult(args)
+
+
+def getResult(args):
+    try:
+        measurement = args['measurement']
+        task_id = args['task_id']
+
+        if re.search("[^a-zA-Z0-9_-]", measurement):
+            raise ValueError('invalid measurement parameter')
+
+        uuid.UUID(task_id)
+    except KeyError:
+        message = 'measurement and task_id must be provided'
+        return common_utils.error_handler(message)
+
+    query_template = "select * from %s where task_id='%s'"
+    query_sql = query_template % ('tasklist', task_id)
+    data = common_utils.translate_to_str(influx_utils.query(query_sql))
+
+    def _unfinished():
+        return common_utils.result_handler(0, [])
+
+    def _finished():
+        query_sql = query_template % (conf.TEST_CASE_PRE + measurement,
+                                      task_id)
+        data = common_utils.translate_to_str(influx_utils.query(query_sql))
+        if not data:
+            query_sql = query_template % (measurement, task_id)
+            data = common_utils.translate_to_str(influx_utils.query(query_sql))
+
+        return common_utils.result_handler(1, data)
+
+    def _error():
+        return common_utils.result_handler(2, data[0]['error'])
+
+    try:
+        status = data[0]['status']
+
+        switcher = {
+            0: _unfinished,
+            1: _finished,
+            2: _error
+        }
+        return switcher.get(status, lambda: 'nothing')()
+    except IndexError:
+        return common_utils.error_handler('no such task')
diff --git a/api/resources/samples_action.py b/api/resources/samples_action.py
new file mode 100644
index 000000000..545447aec
--- /dev/null
+++ b/api/resources/samples_action.py
@@ -0,0 +1,37 @@
+##############################################################################
+# Copyright (c) 2016 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
+##############################################################################
+import uuid
+import os
+import logging
+
+from api import conf
+from api.utils import common as common_utils
+
+logger = logging.getLogger(__name__)
+
+
+def runTestCase(args):
+    try:
+        opts = args.get('opts', {})
+        testcase = args['testcase']
+    except KeyError:
+        return common_utils.error_handler('Lack of testcase argument')
+
+    testcase = os.path.join(conf.SAMPLE_PATH, testcase + '.yaml')
+
+    task_id = str(uuid.uuid4())
+
+    command_list = ['task', 'start']
+    command_list = common_utils.get_command_list(command_list, opts, testcase)
+    logger.debug('The command_list is: %s', command_list)
+
+    logger.debug('Start to execute command list')
+    common_utils.exec_command_task(command_list, task_id)
+
+    return common_utils.result_handler('success', task_id)