functest/opnfv_tests/vnf/ims/heat_ims.py

   1 #!/usr/bin/env python
   2
   3 # Copyright (c) 2018 Kontron, 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 """HeatIms testcase implementation."""
  11
  12 from __future__ import division
  13
  14 import logging
  15 import os
  16 import re
  17 import time
  18 import yaml
  19
  20 import pkg_resources
  21 from xtesting.core import testcase
  22
  23 from functest.core import singlevm
  24 from functest.opnfv_tests.vnf.ims import clearwater
  25 from functest.utils import config
  26 from functest.utils import env
  27
  28 __author__ = "Valentin Boucher <valentin.boucher@kontron.com>"
  29
  30
  31 class HeatIms(singlevm.VmReady2):
  32     # pylint: disable=too-many-instance-attributes
  33     """Clearwater vIMS deployed with Heat Orchestrator Case."""
  34
  35     __logger = logging.getLogger(__name__)
  36
  37     filename = ('/home/opnfv/functest/images/'
  38                 'ubuntu-14.04-server-cloudimg-amd64-disk1.img')
  39
  40     flavor_ram = 2048
  41     flavor_vcpus = 2
  42     flavor_disk = 25
  43
  44     quota_security_group = 20
  45     quota_security_group_rule = 100
  46     quota_port = 50
  47
  48     def __init__(self, **kwargs):
  49         """Initialize HeatIms testcase object."""
  50         if "case_name" not in kwargs:
  51             kwargs["case_name"] = "heat_ims"
  52         super(HeatIms, self).__init__(**kwargs)
  53
  54         # Retrieve the configuration
  55         try:
  56             self.config = getattr(
  57                 config.CONF, 'vnf_{}_config'.format(self.case_name))
  58         except Exception:
  59             raise Exception("VNF config file not found")
  60
  61         self.case_dir = pkg_resources.resource_filename(
  62             'functest', 'opnfv_tests/vnf/ims')
  63         config_file = os.path.join(self.case_dir, self.config)
  64
  65         self.vnf = dict(
  66             descriptor=get_config("vnf.descriptor", config_file),
  67             parameters=get_config("vnf.inputs", config_file)
  68         )
  69         self.details['vnf'] = dict(
  70             descriptor_version=self.vnf['descriptor']['version'],
  71             name=get_config("vnf.name", config_file),
  72             version=get_config("vnf.version", config_file),
  73         )
  74         self.__logger.debug("VNF configuration: %s", self.vnf)
  75         self.keypair = None
  76         self.stack = None
  77         self.clearwater = None
  78         self.role = None
  79
  80     def execute(self):
  81         # pylint: disable=too-many-locals,too-many-statements
  82         """
  83         Prepare Tenant/User
  84
  85         network, security group, fip, VM creation
  86         """
  87         self.orig_cloud.set_network_quotas(
  88             self.project.project.name,
  89             security_group=self.quota_security_group,
  90             security_group_rule=self.quota_security_group_rule,
  91             port=self.quota_port)
  92         if not self.orig_cloud.get_role("heat_stack_owner"):
  93             self.role = self.orig_cloud.create_role("heat_stack_owner")
  94         self.orig_cloud.grant_role(
  95             "heat_stack_owner", user=self.project.user.id,
  96             project=self.project.project.id,
  97             domain=self.project.domain.id)
  98         self.keypair = self.cloud.create_keypair(
  99             '{}-kp_{}'.format(self.case_name, self.guid))
 100         self.__logger.debug("keypair: %s", self.keypair)
 101
 102         if (self.deploy_vnf() and self.test_vnf()):
 103             self.result = 100
 104             return 0
 105         self.result = 1/3 * 100
 106         return 1
 107
 108     def run(self, **kwargs):
 109         """Deploy and test clearwater
 110
 111         Here are the main actions:
 112         - deploy clearwater stack via heat
 113         - test the vnf instance
 114
 115         Returns:
 116         - TestCase.EX_OK
 117         - TestCase.EX_RUN_ERROR on error
 118         """
 119         status = testcase.TestCase.EX_RUN_ERROR
 120         try:
 121             assert self.cloud
 122             assert super(HeatIms, self).run(
 123                 **kwargs) == testcase.TestCase.EX_OK
 124             self.result = 0
 125             if not self.execute():
 126                 self.result = 100
 127                 status = testcase.TestCase.EX_OK
 128         except Exception:  # pylint: disable=broad-except
 129             self.__logger.exception('Cannot run %s', self.case_name)
 130         finally:
 131             self.stop_time = time.time()
 132         return status
 133
 134     def deploy_vnf(self):
 135         """Deploy Clearwater IMS."""
 136         start_time = time.time()
 137         descriptor = self.vnf['descriptor']
 138         parameters = self.vnf['parameters']
 139
 140         parameters['public_mgmt_net_id'] = self.ext_net.id
 141         parameters['public_sig_net_id'] = self.ext_net.id
 142         parameters['flavor'] = self.flavor.name
 143         parameters['image'] = self.image.name
 144         parameters['key_name'] = self.keypair.name
 145         parameters['external_mgmt_dns_ip'] = env.get('NAMESERVER')
 146         parameters['external_sig_dns_ip'] = env.get('NAMESERVER')
 147
 148         self.__logger.info("Create Heat Stack")
 149         self.stack = self.cloud.create_stack(
 150             name=descriptor.get('name'),
 151             template_file=descriptor.get('file_name'),
 152             wait=True, **parameters)
 153         self.__logger.debug("stack: %s", self.stack)
 154
 155         servers = self.cloud.list_servers(detailed=True)
 156         self.__logger.debug("servers: %s", servers)
 157         for server in servers:
 158             if not self.check_regex_in_console(
 159                     server.name, regex='Cloud-init .* finished at ', loop=60):
 160                 return False
 161             if 'ellis' in server.name:
 162                 self.__logger.debug("server: %s", server)
 163                 ellis_ip = server.public_v4
 164
 165         assert ellis_ip
 166         self.clearwater = clearwater.ClearwaterTesting(self.case_name,
 167                                                        ellis_ip)
 168         # This call can take time and many retry because Heat is
 169         # an infrastructure orchestrator so when Heat say "stack created"
 170         # it means that all OpenStack ressources are created but not that
 171         # Clearwater are up and ready (Cloud-Init script still running)
 172         self.clearwater.availability_check_by_creating_numbers()
 173
 174         duration = time.time() - start_time
 175
 176         self.details['vnf'].update(status='PASS', duration=duration)
 177         self.result += 1/3 * 100
 178
 179         return True
 180
 181     def test_vnf(self):
 182         """Run test on clearwater ims instance."""
 183         start_time = time.time()
 184
 185         outputs = self.cloud.get_stack(self.stack.id).outputs
 186         self.__logger.debug("stack outputs: %s", outputs)
 187         dns_ip = re.findall(r'[0-9]+(?:\.[0-9]+){3}', str(outputs))[0]
 188
 189         if not dns_ip:
 190             return False
 191
 192         short_result = self.clearwater.run_clearwater_live_test(
 193             dns_ip=dns_ip,
 194             public_domain=self.vnf['parameters']["zone"])
 195         duration = time.time() - start_time
 196         self.__logger.info(short_result)
 197         self.details['test_vnf'] = dict(result=short_result,
 198                                         duration=duration)
 199         try:
 200             vnf_test_rate = short_result['passed'] / (
 201                 short_result['total'] - short_result['skipped'])
 202             # orchestrator + vnf + test_vnf
 203             self.result += vnf_test_rate / 3 * 100
 204         except ZeroDivisionError:
 205             self.__logger.error("No test has been executed")
 206             self.details['test_vnf'].update(status='FAIL')
 207             return False
 208         except Exception:  # pylint: disable=broad-except
 209             self.__logger.exception("Cannot calculate results")
 210             self.details['test_vnf'].update(status='FAIL')
 211             return False
 212         return True if vnf_test_rate > 0 else False
 213
 214     def clean(self):
 215         """Clean created objects/functions."""
 216         assert self.cloud
 217         try:
 218             if self.stack:
 219                 self.cloud.delete_stack(self.stack.id, wait=True)
 220         except TypeError:
 221             # shade raises TypeError exceptions when checking stack status
 222             pass
 223         except Exception:  # pylint: disable=broad-except
 224             self.__logger.exception("Cannot clean stack ressources")
 225         super(HeatIms, self).clean()
 226         if self.role:
 227             self.orig_cloud.delete_role(self.role.id)
 228
 229
 230 # ----------------------------------------------------------
 231 #
 232 #               YAML UTILS
 233 #
 234 # -----------------------------------------------------------
 235 def get_config(parameter, file_path):
 236     """
 237     Get config parameter.
 238
 239     Returns the value of a given parameter in file.yaml
 240     parameter must be given in string format with dots
 241     Example: general.openstack.image_name
 242     """
 243     with open(file_path) as config_file:
 244         file_yaml = yaml.safe_load(config_file)
 245     config_file.close()
 246     value = file_yaml
 247     for element in parameter.split("."):
 248         value = value.get(element)
 249         if value is None:
 250             raise ValueError("The parameter %s is not defined in"
 251                              " reporting.yaml" % parameter)
 252     return value