diff options
Diffstat (limited to 'dovetail/api')
| -rw-r--r-- | dovetail/api/app/__init__.py | 0 | ||||
| -rw-r--r-- | dovetail/api/app/constants.py | 15 | ||||
| -rw-r--r-- | dovetail/api/app/routes.py | 102 | ||||
| -rw-r--r-- | dovetail/api/app/server.py | 297 | ||||
| -rw-r--r-- | dovetail/api/app/utils.py | 24 | ||||
| -rwxr-xr-x | dovetail/api/boot.sh | 16 | ||||
| -rw-r--r-- | dovetail/api/swagger.yaml | 346 |
7 files changed, 800 insertions, 0 deletions
diff --git a/dovetail/api/app/__init__.py b/dovetail/api/app/__init__.py new file mode 100644 index 00000000..e69de29b --- /dev/null +++ b/dovetail/api/app/__init__.py diff --git a/dovetail/api/app/constants.py b/dovetail/api/app/constants.py new file mode 100644 index 00000000..f6ffd1ba --- /dev/null +++ b/dovetail/api/app/constants.py @@ -0,0 +1,15 @@ +NFVI_PROJECT = ['bottlenecks', 'functest', 'yardstick'] +VNF_PROJECT = ['onap-vtp', 'onap-vvp'] +RUN_TEST_ITEMS = { + 'arguments': { + 'no_multiple': ['testsuite', 'deploy_scenario'], + 'multiple': ['testarea', 'testcase'] + }, + 'options': ['mandatory', 'no_api_validation', 'no_clean', 'stop', 'debug', + 'opnfv_ci', 'report', 'offline', 'optional'] +} +CONFIG_YAML_FILES = { + 'hosts': 'hosts.yaml', + 'pods': 'pod.yaml', + 'tempest_conf': 'tempest_conf.yaml' +} diff --git a/dovetail/api/app/routes.py b/dovetail/api/app/routes.py new file mode 100644 index 00000000..352d69f3 --- /dev/null +++ b/dovetail/api/app/routes.py @@ -0,0 +1,102 @@ +#!flask/bin/python + +import json +import os +import subprocess +import time +import uuid + +from flask import Flask, jsonify, request +from flask_cors import CORS + +from app.server import Server + +app = Flask(__name__) +CORS(app) + + +@app.route('/api/v1/scenario/nfvi/testsuites', methods=['GET']) +def get_all_testsuites(): + testsuites = Server.list_testsuites() + return jsonify({'testsuites': testsuites}), 200 + + +@app.route('/api/v1/scenario/nfvi/testcases', methods=['GET']) +def get_testcases(): + testcases = Server.list_testcases() + return jsonify({'testcases': testcases}), 200 + + +@app.route('/api/v1/scenario/nfvi/execution', methods=['POST']) +def run_testcases(): + requestId = request.args.get('requestId') + if not requestId: + requestId = uuid.uuid1() + if os.getenv('DOVETAIL_HOME'): + dovetail_home = os.getenv('DOVETAIL_HOME') + else: + return 'No DOVETAIL_HOME found in env.\n', 500 + + server = Server(dovetail_home, requestId, request.json) + + msg, ret = server.set_conf_files() + if not ret: + return msg, 500 + + msg, ret = server.set_vm_images() + if not ret: + return msg, 500 + + input_str = server.parse_request() + + repo_dir = os.path.abspath(os.path.join(os.path.dirname(__file__), + os.pardir, os.pardir)) + run_script = os.path.join(repo_dir, 'run.py') + + cmd = 'python3 {} {}'.format(run_script, input_str) + api_home = os.path.join(dovetail_home, str(requestId)) + subprocess.Popen(cmd, shell=True, env={'DOVETAIL_HOME': api_home, + 'LC_ALL': 'C.UTF-8', 'LANG': 'C.UTF-8'}) + + testcases_file = os.path.join(dovetail_home, str(requestId), + 'results', 'testcases.json') + for loop in range(60): + if not os.path.isfile(testcases_file): + time.sleep(1) + else: + break + else: + return 'Can not get file testcases.json.\n', 500 + + with open(testcases_file, "r") as f: + for jsonfile in f: + data = json.loads(jsonfile) + testcases = data['testcases'] + testsuite = data['testsuite'] + + result = server.get_execution_status(testsuite, testcases, testcases) + + return jsonify({'result': result}), 200 + + +@app.route('/api/v1/scenario/nfvi/execution/status/<exec_id>', + methods=['POST']) +def get_testcases_status(exec_id): + if 'testcase' not in request.json: + return 'Need testcases list as input.\n', 400 + + testcases = request.json['testcase'] + dovetail_home = os.getenv('DOVETAIL_HOME') + + server = Server(dovetail_home, exec_id, request.json) + testcases_file = os.path.join(dovetail_home, str(exec_id), + 'results', 'testcases.json') + with open(testcases_file, "r") as f: + for jsonfile in f: + data = json.loads(jsonfile) + testsuite = data['testsuite'] + + result = server.get_execution_status(testsuite, testcases, + data['testcases']) + + return jsonify({'result': result}), 200 diff --git a/dovetail/api/app/server.py b/dovetail/api/app/server.py new file mode 100644 index 00000000..d44e2ee5 --- /dev/null +++ b/dovetail/api/app/server.py @@ -0,0 +1,297 @@ +import json +import os +import shutil + +import app.constants as constants +from app.utils import Utils + +from dovetail.testcase import Testsuite, Testcase + + +class Server(object): + + def __init__(self, dovetail_home=None, requestId=None, requestData=None): + self.dovetail_home = dovetail_home + self.requestId = requestId + self.requestData = requestData + + @staticmethod + def list_testsuites(): + return Testsuite.load() + + @staticmethod + def list_testcases(): + testcases = Testcase.load() + testcase_list = [] + for key, value in testcases.items(): + testcase = {'testCaseName': key, + 'description': value.objective(), + 'subTestCase': value.sub_testcase()} + if value.validate_type() in constants.NFVI_PROJECT: + testcase['scenario'] = 'nfvi' + elif value.validate_type() in constants.VNF_PROJECT: + testcase['scenario'] = 'vnf' + else: + testcase['scenario'] = 'unknown' + testcase_list.append(testcase) + return testcase_list + + def set_vm_images(self): + image_path = os.path.join(self.dovetail_home, str(self.requestId), + 'images') + try: + origin_image_path = self.requestData['conf']['vm_images'] + except KeyError: + origin_image_path = os.path.join(self.dovetail_home, 'images') + if os.path.exists(origin_image_path): + try: + shutil.copytree(origin_image_path, image_path) + except Exception as e: + return str(e), False + return "Success to set vm images.\n", True + else: + return "Could not find vm images.\n", False + + def set_conf_files(self): + config_path = os.path.join(self.dovetail_home, str(self.requestId), + 'pre_config') + origin_config_path = os.path.join(self.dovetail_home, 'pre_config') + if os.path.exists(origin_config_path): + try: + shutil.copytree(origin_config_path, config_path) + except Exception as e: + return str(e), False + + # check and prepare mandatory env_config.sh file + # if there are envs in request body, use it + # otherwise, use the file in pre_config + # if don't have this file, return False with error message + env_file = os.path.join(config_path, 'env_config.sh') + try: + Utils.write_env_file(self.requestData['conf']['envs'], env_file) + except KeyError: + if not os.path.isfile(env_file): + return "No 'envs' found in the request body.\n", False + else: + pass + except Exception as e: + return str(e), False + + # check and prepare other optional yaml files + for key, value in constants.CONFIG_YAML_FILES.items(): + config_file = os.path.join(config_path, value) + try: + Utils.write_yaml_file(self.requestData['conf'][key], + config_file) + except KeyError: + pass + except Exception as e: + return str(e), False + + return 'Success to prepare all config files.\n', True + + def parse_request(self): + output = '' + default_args = constants.RUN_TEST_ITEMS['arguments'] + default_options = constants.RUN_TEST_ITEMS['options'] + + for arg in default_args['no_multiple']: + if arg in self.requestData.keys(): + output = output + ' --{} {}'.format(arg, self.requestData[arg]) + for arg in default_args['multiple']: + if arg in self.requestData.keys() and self.requestData[arg]: + for item in self.requestData[arg]: + output = output + ' --{} {}'.format(arg, item) + + if 'options' not in self.requestData.keys(): + return output + + for option in default_options: + if option in self.requestData['options']: + output = output + ' --{}'.format(option) + + return output + + def get_execution_status(self, testsuite, request_testcases, + exec_testcases): + results_dir = os.path.join(self.dovetail_home, str(self.requestId), + 'results') + results = [] + for tc in request_testcases: + if tc not in exec_testcases: + res = {'testCaseName': tc, 'status': 'NOT_EXECUTED'} + results.append(res) + continue + + tc_type = tc.split('.')[0] + checker = CheckerFactory.create(tc_type) + status, result = checker.get_status(results_dir, tc) + + res = {'testCaseName': tc, 'testSuiteName': testsuite, + 'scenario': 'nfvi', 'executionId': self.requestId, + 'results': result, 'status': status, 'timestart': None, + 'endTime': None} + try: + res['timestart'] = result['timestart'] + res['endTime'] = result['timestop'] + except Exception: + pass + + results.append(res) + + return results + + +class Checker(object): + + def __init__(self): + pass + + @staticmethod + def get_status_from_total_file(total_file, testcase): + with open(total_file, 'r') as f: + for jsonfile in f: + try: + data = json.loads(jsonfile) + for item in data['testcases_list']: + if item['name'] == testcase: + return item['result'], item['sub_testcase'] + except KeyError as e: + return 'FAILED', None + except ValueError: + continue + return 'FAILED', None + + +class FunctestChecker(Checker): + + def get_status(self, results_dir, testcase): + functest_file = os.path.join(results_dir, 'functest_results.txt') + total_file = os.path.join(results_dir, 'results.json') + if not os.path.isfile(functest_file): + if not os.path.isfile(total_file): + return 'IN_PROGRESS', None + return 'FAILED', None + criteria = None + sub_testcase = [] + timestart = None + timestop = None + + # get criteria and sub_testcase when all tests completed + if os.path.isfile(total_file): + criteria, sub_testcase = self.get_status_from_total_file( + total_file, testcase) + if criteria == 'FAILED': + return 'FAILED', None + + # get detailed results from functest_results.txt + with open(functest_file, 'r') as f: + for jsonfile in f: + try: + data = json.loads(jsonfile) + if data['build_tag'].endswith(testcase): + criteria = data['criteria'] if not criteria \ + else criteria + timestart = data['start_date'] + timestop = data['stop_date'] + break + except KeyError: + return 'FAILED', None + except ValueError: + continue + else: + if not criteria: + return 'IN_PROGRESS', None + + status = 'COMPLETED' if criteria == 'PASS' else 'FAILED' + results = {'criteria': criteria, 'sub_testcase': sub_testcase, + 'timestart': timestart, 'timestop': timestop} + return status, results + + +class YardstickChecker(Checker): + + def get_status(self, results_dir, testcase): + yardstick_file = os.path.join(results_dir, 'ha_logs', + '{}.out'.format(testcase)) + total_file = os.path.join(results_dir, 'results.json') + if not os.path.isfile(yardstick_file): + if not os.path.isfile(total_file): + return 'IN_PROGRESS', None + return 'FAILED', None + + criteria = None + + # get criteria and sub_testcase when all tests completed + if os.path.isfile(total_file): + criteria, _ = self.get_status_from_total_file(total_file, testcase) + if criteria == 'FAILED': + return 'FAILED', None + + with open(yardstick_file, 'r') as f: + for jsonfile in f: + data = json.loads(jsonfile) + try: + if not criteria: + criteria = data['result']['criteria'] + if criteria == 'PASS': + details = data['result']['testcases'] + for key, value in details.items(): + sla_pass = value['tc_data'][0]['data']['sla_pass'] + if not 1 == sla_pass: + criteria = 'FAIL' + except KeyError: + return 'FAILED', None + + status = 'COMPLETED' if criteria == 'PASS' else 'FAILED' + results = {'criteria': criteria, 'timestart': None, 'timestop': None} + return status, results + + +class BottlenecksChecker(Checker): + + def get_status(self, results_dir, testcase): + bottlenecks_file = os.path.join(results_dir, 'stress_logs', + '{}.out'.format(testcase)) + total_file = os.path.join(results_dir, 'results.json') + if not os.path.isfile(bottlenecks_file): + if not os.path.isfile(total_file): + return 'IN_PROGRESS', None + return 'FAILED', None + + criteria = None + + # get criteria and sub_testcase when all tests completed + if os.path.isfile(total_file): + criteria, _ = self.get_status_from_total_file(total_file, testcase) + if criteria == 'FAILED': + return 'FAILED', None + + with open(bottlenecks_file, 'r') as f: + for jsonfile in f: + data = json.loads(jsonfile) + try: + if not criteria: + criteria = data['data_body']['result'] + except KeyError: + return 'FAILED', None + + status = 'COMPLETED' if criteria == 'PASS' else 'FAILED' + results = {'criteria': criteria, 'timestart': None, 'timestop': None} + return status, results + + +class CheckerFactory(object): + + CHECKER_MAP = { + 'functest': FunctestChecker, + 'yardstick': YardstickChecker, + 'bottlenecks': BottlenecksChecker + } + + @classmethod + def create(cls, tc_type): + try: + return cls.CHECKER_MAP[tc_type]() + except KeyError: + return None diff --git a/dovetail/api/app/utils.py b/dovetail/api/app/utils.py new file mode 100644 index 00000000..9f35ee03 --- /dev/null +++ b/dovetail/api/app/utils.py @@ -0,0 +1,24 @@ +import json +import os + + +class Utils(object): + + @staticmethod + def write_env_file(envs, file_path): + file_dir = os.path.dirname(file_path) + if not os.path.exists(file_dir): + os.makedirs(file_dir) + with open(file_path, "w") as f: + for key, value in envs.items(): + f.write("export {}={}\n".format(key, value)) + return True + + @staticmethod + def write_yaml_file(data, file_path): + file_dir = os.path.dirname(file_path) + if not os.path.exists(file_dir): + os.makedirs(file_dir) + with open(file_path, "w") as f: + f.write(json.dumps(data) + '\n') + return True diff --git a/dovetail/api/boot.sh b/dovetail/api/boot.sh new file mode 100755 index 00000000..9fbb5484 --- /dev/null +++ b/dovetail/api/boot.sh @@ -0,0 +1,16 @@ +#!/bin/sh + +mkdir -p /var/www/html/dovetail-api +cp -r /home/opnfv/swagger-ui/dist/* /var/www/html/dovetail-api +cp /home/opnfv/dovetail/dovetail/api/swagger.yaml /var/www/html/dovetail-api +sed -i 's#url: "https://petstore.swagger.io/v2/swagger.json"#url: "swagger.yaml"#g' /var/www/html/dovetail-api/index.html +sed -i '/deepLinking: true,/a\ validatorUrl: null,' /var/www/html/dovetail-api/index.html + +if [[ -n ${SWAGGER_HOST} ]]; then + sed -i "s/host: localhost:8888/host: ${SWAGGER_HOST}/g" /var/www/html/dovetail-api/swagger.yaml +fi + +/etc/init.d/apache2 start + +cd $(dirname $(readlink -f $0)) +exec gunicorn -b :5000 --access-logfile - --error-logfile - app.routes:app diff --git a/dovetail/api/swagger.yaml b/dovetail/api/swagger.yaml new file mode 100644 index 00000000..54695d7e --- /dev/null +++ b/dovetail/api/swagger.yaml @@ -0,0 +1,346 @@ +swagger: "2.0" +info: + description: "This is the dovetail API." + version: "1.0.0" + title: "Dovetail API" + contact: + email: "xudan16@huawei.com" + license: + name: "Apache 2.0" + url: "http://www.apache.org/licenses/LICENSE-2.0.html" +host: localhost:8888 +basePath: "/api/v1/scenario/nfvi" +tags: +- name: "testsuites" + description: "Operations about testsuites" +- name: "testcases" + description: "Operations about test cases" +- name: "execution" + description: "Operations about running test cases" +schemes: +- "http" +paths: + /testsuites: + get: + tags: + - "testsuites" + summary: "Get all testsuites" + description: "" + operationId: "getTestsuites" + consumes: + - "application/json" + produces: + - "application/json" + parameters: [] + responses: + 200: + description: "successful operation" + default: + description: Unexpected error + /testcases: + get: + tags: + - "testcases" + summary: "Get all test cases" + description: "" + operationId: "getTestcases" + consumes: + - "application/json" + produces: + - "application/json" + parameters: [] + responses: + 200: + description: "successful operation" + default: + description: Unexpected error + /execution: + post: + tags: + - "execution" + summary: "Run test cases" + description: "" + operationId: "runTestCases" + consumes: + - "application/json" + produces: + - "application/json" + parameters: + - name: "body" + in: "body" + description: "All info used to run tests" + required: false + schema: + $ref: "#/definitions/RunInfo" + responses: + 200: + description: "successful operation" + schema: + $ref: "#/definitions/StatusResponse" + 500: + description: "internal error" + default: + description: Unexpected error + /execution/{exec_id}: + post: + tags: + - "execution" + summary: "Run test cases with exec_id" + description: "" + operationId: "runTestCasesWithID" + consumes: + - "application/json" + produces: + - "application/json" + parameters: + - name: "exec_id" + in: "path" + description: "ID of this run, will generate randomly if not given" + required: true + schema: + type: "integer" + format: "uuid" + - name: "body" + in: "body" + description: "All info used to run tests" + required: false + schema: + $ref: "#/definitions/RunInfo" + responses: + 200: + description: "successful operation" + schema: + $ref: "#/definitions/StatusResponse" + 500: + description: "internal error" + default: + description: Unexpected error + /execution/status/{exec_id}: + post: + tags: + - "execution/status" + summary: "Get status of running test cases" + description: "" + operationId: "getTestCasesStatus" + consumes: + - "application/json" + produces: + - "application/json" + parameters: + - name: "exec_id" + in: "path" + description: "exec_id used to get the status of test cases" + required: true + schema: + type: "integer" + format: "uuid" + - name: "body" + in: "body" + description: "Test case list used to get status" + required: true + schema: + $ref: "#/definitions/TestCaseList" + responses: + 200: + description: "successful operation" + schema: + $ref: "#/definitions/StatusResponse" + 500: + description: "internal error" + default: + description: Unexpected error +definitions: + TestCaseList: + type: "object" + properties: + testcase: + type: "array" + items: + type: "string" + example: + - "functest.vping.ssh" + - "yardstick.ha.rabbitmq" + Node: + type: "object" + required: + - "name" + - "role" + - "ip" + - "user" + properties: + name: + type: "string" + example: "node1" + role: + type: "string" + enum: + - "Controller" + - "Compute" + - "Jumpserver" + ip: + type: "string" + example: "192.168.117.222" + user: + type: "string" + example: "root" + password: + type: "string" + example: "root" + key_filename: + type: "string" + example: "/home/ovp/pre_config/id_rsa" + ProcessInfo: + type: "object" + required: + - "testcase_name" + properties: + testcase_name: + type: "string" + example: "yardstick.ha.rabbitmq" + attack_host: + type: "string" + example: "node1" + attack_process: + type: "string" + example: "rabbitmq" + Pods: + type: "object" + properties: + nodes: + type: "array" + items: + $ref: '#/definitions/Node' + process_info: + type: "array" + items: + $ref: "#/definitions/ProcessInfo" + tempestconf: + type: "object" + additionalProperties: + type: string + TempestConf: + type: "object" + additionalProperties: + $ref: "#/definitions/tempestconf" + Hosts: + type: "object" + additionalProperties: + type: "array" + items: + type: "string" + Envs: + type: "object" + additionalProperties: + type: string + example: + OS_USERNAME: "admin" + OS_PASSWORD: "admin" + OS_AUTH_URL: "https://192.168.117.222:5000/v3" + EXTERNAL_NETWORK: "ext-net" + Conf: + type: "object" + properties: + vm_images: + type: "string" + example: "/home/ovp/images" + pods: + $ref: "#/definitions/Pods" + tempest_conf: + $ref: "#/definitions/TempestConf" + hosts: + $ref: "#/definitions/Hosts" + envs: + $ref: "#/definitions/Envs" + RunInfo: + type: "object" + properties: + conf: + $ref: "#/definitions/Conf" + testcase: + type: "array" + items: + type: "string" + example: + - "functest.vping.ssh" + - "yardstick.ha.rabbitmq" + testsuite: + type: "string" + example: "ovp.2019.12" + testarea: + type: "array" + items: + type: "string" + example: + - "vping" + - "ha" + deploy_scenario: + type: "string" + example: "os-nosdn-ovs-ha" + options: + type: "array" + items: + type: "string" + enum: + - "opnfv-ci" + - "optional" + - "offline" + - "report" + - "debug" + - "stop" + - "no-clean" + - "no-api-validation" + - "mandatory" + example: + - "debug" + - "report" + Results: + type: "object" + properties: + criteria: + type: "string" + enum: + - "PASS" + - "FAIL" + timestart: + type: "string" + format: "date-time" + timestop: + type: "string" + format: "date-time" + TestCaseStatus: + type: "object" + properties: + endTime: + type: "string" + format: "date-time" + executionId: + type: "string" + format: "uuid" + results: + $ref: "#/definitions/Results" + scenario: + type: "string" + example: "nfvi" + status: + type: "string" + enum: + - "IN_PROGRESS" + - "COMPLETED" + - "FAILED" + - "NOT_EXECUTED" + testCaseName: + type: "string" + example: "functest.vping.ssh" + testSuiteName: + type: "string" + example: "ovp.2019.12" + timestart: + type: "string" + format: "date-time" + StatusResponse: + type: "object" + properties: + result: + type: "array" + items: + $ref: "#/definitions/TestCaseStatus" |