functest/core/vnf_base.py

   1 #!/usr/bin/env python
   2
   3 # Copyright (c) 2016 Orange and others.
   4 #
   5 # All rights reserved. This program and the accompanying materials
   6 # are made available under the terms of the Apache License, Version 2.0
   7 # which accompanies this distribution, and is available at
   8 # http://www.apache.org/licenses/LICENSE-2.0
   9
  10 import time
  11
  12 import inspect
  13
  14 import functest.utils.functest_logger as ft_logger
  15 import functest.utils.openstack_utils as os_utils
  16 import functest.utils.functest_utils as ft_utils
  17 import testcase_base as base
  18 from functest.utils.constants import CONST
  19
  20
  21 class VnfOnBoardingBase(base.TestcaseBase):
  22
  23     logger = ft_logger.Logger(__name__).getLogger()
  24
  25     def __init__(self, project='functest', case='', repo='', cmd=''):
  26         super(VnfOnBoardingBase, self).__init__()
  27         self.repo = repo
  28         self.project_name = project
  29         self.case_name = case
  30         self.cmd = cmd
  31         self.details = {}
  32         self.data_dir = CONST.dir_functest_data
  33         self.details['orchestrator'] = {}
  34         self.details['vnf'] = {}
  35         self.details['test_vnf'] = {}
  36         self.images = {}
  37         try:
  38             self.tenant_name = CONST.__getattribute__(
  39                 'vnf_{}_tenant_name'.format(self.case_name))
  40             self.tenant_description = CONST.__getattribute__(
  41                 'vnf_{}_tenant_description'.format(self.case_name))
  42         except:
  43             raise Exception("Unknown VNF case=" + self.case_name)
  44
  45         try:
  46             self.images = CONST.__getattribute__(
  47                 'vnf_{}_tenant_images'.format(self.case_name))
  48         except:
  49             self.logger.warn("No tenant image defined for this VNF")
  50
  51     def execute(self):
  52         self.start_time = time.time()
  53         # Prepare the test (Create Tenant, User, ...)
  54         self.logger.info("Create VNF Onboarding environment")
  55         self.prepare()
  56
  57         # Deploy orchestrator
  58         try:
  59             self.logger.info("Deploy orchestrator (if necessary)")
  60             orchestrator_ready_time = time.time()
  61             res_orchestrator = self.deploy_orchestrator()
  62             # orchestrator is not mandatory
  63             if res_orchestrator is not None:
  64                 self.details['orchestrator']['status'] = (
  65                     res_orchestrator['status'])
  66                 self.details['orchestrator']['result'] = (
  67                     res_orchestrator['result'])
  68                 self.details['orchestrator']['duration'] = round(
  69                     orchestrator_ready_time - self.start_time, 1)
  70         except Exception:
  71             self.logger.warn("Problem with the Orchestrator", exc_info=True)
  72
  73         # Deploy VNF
  74         try:
  75             self.logger.info("Deploy VNF " + self.case_name)
  76             res_deploy_vnf = self.deploy_vnf()
  77             vnf_ready_time = time.time()
  78             self.details['vnf']['status'] = res_deploy_vnf['status']
  79             self.details['vnf']['result'] = res_deploy_vnf['result']
  80             self.details['vnf']['duration'] = round(
  81                 vnf_ready_time - orchestrator_ready_time, 1)
  82         except Exception:
  83             self.logger.error("Error during VNF deployment", exc_info=True)
  84             raise Exception("Error during VNF deployment")
  85
  86         # Test VNF
  87         try:
  88             self.logger.info("Test VNF")
  89             res_test_vnf = self.test_vnf()
  90             test_vnf_done_time = time.time()
  91             self.details['test_vnf']['status'] = res_test_vnf['status']
  92             self.details['test_vnf']['result'] = res_test_vnf['result']
  93             self.details['test_vnf']['duration'] = round(
  94                 test_vnf_done_time - vnf_ready_time, 1)
  95         except Exception:
  96             self.logger.error("Error when running VNF tests", exc_info=True)
  97             raise Exception("Error when running VNF tests")
  98
  99         # Clean the system
 100         self.clean()
 101         self.stop_time = time.time()
 102
 103         exit_code = self.parse_results()
 104         self.log_results()
 105         return exit_code
 106
 107     # prepare state could consist in the creation of the resources
 108     # a dedicated user
 109     # a dedictaed tenant
 110     # dedicated images
 111     def prepare(self):
 112         self.creds = os_utils.get_credentials()
 113         self.keystone_client = os_utils.get_keystone_client()
 114
 115         self.logger.info("Prepare OpenStack plateform(create tenant and user)")
 116         admin_user_id = os_utils.get_user_id(self.keystone_client,
 117                                              self.creds['username'])
 118         if admin_user_id == '':
 119             self.step_failure("Failed to get id of " +
 120                               self.creds['username'])
 121
 122         tenant_id = os_utils.create_tenant(
 123             self.keystone_client, self.tenant_name, self.tenant_description)
 124         if not tenant_id:
 125             self.step_failure("Failed to create " +
 126                               self.tenant_name + " tenant")
 127
 128         roles_name = ["admin", "Admin"]
 129         role_id = ''
 130         for role_name in roles_name:
 131             if role_id == '':
 132                 role_id = os_utils.get_role_id(self.keystone_client, role_name)
 133
 134         if role_id == '':
 135             self.logger.error("Failed to get id for %s role" % role_name)
 136             self.step_failure("Failed to get role id of " + role_name)
 137
 138         if not os_utils.add_role_user(self.keystone_client, admin_user_id,
 139                                       role_id, tenant_id):
 140             self.logger.error("Failed to add %s on tenant" %
 141                               self.creds['username'])
 142             self.step_failure("Failed to add %s on tenant" %
 143                               self.creds['username'])
 144
 145         user_id = os_utils.create_user(self.keystone_client,
 146                                        self.tenant_name,
 147                                        self.tenant_name,
 148                                        None,
 149                                        tenant_id)
 150         if not user_id:
 151             self.logger.error("Failed to create %s user" % self.tenant_name)
 152             self.step_failure("Failed to create user ")
 153
 154         if not os_utils.add_role_user(self.keystone_client, user_id,
 155                                       role_id, tenant_id):
 156             self.logger.error("Failed to add %s on tenant" %
 157                               self.tenant_name)
 158             self.step_failure("Failed to add %s on tenant" %
 159                               self.tenant_name)
 160
 161         self.logger.info("Update OpenStack creds informations")
 162         self.admin_creds = self.creds.copy()
 163         self.admin_creds.update({
 164             "tenant": self.tenant_name
 165         })
 166         self.neutron_client = os_utils.get_neutron_client(self.admin_creds)
 167         self.nova_client = os_utils.get_nova_client(self.admin_creds)
 168         self.creds.update({
 169             "tenant": self.tenant_name,
 170             "username": self.tenant_name,
 171             "password": self.tenant_name,
 172         })
 173
 174     # orchestrator is not mandatory to dpeloy and test VNF
 175     def deploy_orchestrator(self, **kwargs):
 176         pass
 177
 178     # TODO see how to use built-in exception from releng module
 179     def deploy_vnf(self):
 180         self.logger.error("VNF must be deployed")
 181         raise Exception("VNF not deployed")
 182
 183     def test_vnf(self):
 184         self.logger.error("VNF must be tested")
 185         raise Exception("VNF not tested")
 186
 187     def clean(self):
 188         self.logger.info("test cleaning")
 189
 190         self.logger.info("Removing %s tenant .." % self.tenant_name)
 191         tenant_id = os_utils.get_tenant_id(self.keystone_client,
 192                                            self.tenant_name)
 193         if tenant_id == '':
 194             self.logger.error("Error : Failed to get id of %s tenant" %
 195                               self.tenant_name)
 196         else:
 197             if not os_utils.delete_tenant(self.keystone_client, tenant_id):
 198                 self.logger.error("Error : Failed to remove %s tenant" %
 199                                   self.tenant_name)
 200
 201         self.logger.info("Removing %s user .." % self.tenant_name)
 202         user_id = os_utils.get_user_id(
 203             self.keystone_client, self.tenant_name)
 204         if user_id == '':
 205             self.logger.error("Error : Failed to get id of %s user" %
 206                               self.tenant_name)
 207         else:
 208             if not os_utils.delete_user(self.keystone_client, user_id):
 209                 self.logger.error("Error : Failed to remove %s user" %
 210                                   self.tenant_name)
 211
 212     def parse_results(self):
 213         exit_code = self.EX_OK
 214         self.criteria = "PASS"
 215         self.logger.info(self.details)
 216         # The 2 VNF steps must be OK to get a PASS result
 217         if (self.details['vnf']['status'] is not "PASS" or
 218                 self.details['test_vnf']['status'] is not "PASS"):
 219             exit_code = self.EX_RUN_ERROR
 220             self.criteria = "FAIL"
 221         return exit_code
 222
 223     def log_results(self):
 224         ft_utils.logger_test_results(self.project_name,
 225                                      self.case_name,
 226                                      self.criteria,
 227                                      self.details)
 228
 229     def step_failure(self, error_msg):
 230         part = inspect.stack()[1][3]
 231         self.details[part]['status'] = 'FAIL'
 232         self.details[part]['result'] = error_msg
 233         raise Exception(error_msg)