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
  19 import pkg_resources
  20 from xtesting.core import testcase
  21
  22 from functest.core import singlevm
  23 from functest.opnfv_tests.vnf.ims import clearwater
  24 from functest.utils import config
  25 from functest.utils import env
  26 from functest.utils import functest_utils
  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=functest_utils.get_parameter_from_yaml(
  67                 "vnf.descriptor", config_file),
  68             parameters=functest_utils.get_parameter_from_yaml(
  69                 "vnf.inputs", config_file)
  70         )
  71         self.details['vnf'] = dict(
  72             descriptor_version=self.vnf['descriptor']['version'],
  73             name=functest_utils.get_parameter_from_yaml(
  74                 "vnf.name", config_file),
  75             version=functest_utils.get_parameter_from_yaml(
  76                 "vnf.version", config_file),
  77         )
  78         self.__logger.debug("VNF configuration: %s", self.vnf)
  79         self.keypair = None
  80         self.stack = None
  81         self.clearwater = None
  82         self.role = None
  83
  84     def execute(self):
  85         # pylint: disable=too-many-locals,too-many-statements
  86         """
  87         Prepare Tenant/User
  88
  89         network, security group, fip, VM creation
  90         """
  91         self.orig_cloud.set_network_quotas(
  92             self.project.project.name,
  93             security_group=self.quota_security_group,
  94             security_group_rule=self.quota_security_group_rule,
  95             port=self.quota_port)
  96         if not self.orig_cloud.get_role("heat_stack_owner"):
  97             self.role = self.orig_cloud.create_role("heat_stack_owner")
  98         self.orig_cloud.grant_role(
  99             "heat_stack_owner", user=self.project.user.id,
 100             project=self.project.project.id,
 101             domain=self.project.domain.id)
 102         self.keypair = self.cloud.create_keypair(
 103             '{}-kp_{}'.format(self.case_name, self.guid))
 104         self.__logger.debug("keypair: %s", self.keypair)
 105
 106         if self.deploy_vnf() and self.test_vnf():
 107             self.result = 100
 108             return 0
 109         self.result = 1/3 * 100
 110         return 1
 111
 112     def run(self, **kwargs):
 113         """Deploy and test clearwater
 114
 115         Here are the main actions:
 116         - deploy clearwater stack via heat
 117         - test the vnf instance
 118
 119         Returns:
 120         - TestCase.EX_OK
 121         - TestCase.EX_RUN_ERROR on error
 122         """
 123         status = testcase.TestCase.EX_RUN_ERROR
 124         try:
 125             assert self.cloud
 126             assert super(HeatIms, self).run(
 127                 **kwargs) == testcase.TestCase.EX_OK
 128             self.result = 0
 129             if not self.execute():
 130                 self.result = 100
 131                 status = testcase.TestCase.EX_OK
 132         except Exception:  # pylint: disable=broad-except
 133             self.__logger.exception('Cannot run %s', self.case_name)
 134         finally:
 135             self.stop_time = time.time()
 136         return status
 137
 138     def deploy_vnf(self):
 139         """Deploy Clearwater IMS."""
 140         start_time = time.time()
 141         descriptor = self.vnf['descriptor']
 142         parameters = self.vnf['parameters']
 143
 144         parameters['public_mgmt_net_id'] = self.ext_net.id
 145         parameters['public_sig_net_id'] = self.ext_net.id
 146         parameters['flavor'] = self.flavor.name
 147         parameters['image'] = self.image.name
 148         parameters['key_name'] = self.keypair.name
 149         parameters['external_mgmt_dns_ip'] = env.get('NAMESERVER')
 150         parameters['external_sig_dns_ip'] = env.get('NAMESERVER')
 151
 152         self.__logger.info("Create Heat Stack")
 153         self.stack = self.cloud.create_stack(
 154             name=descriptor.get('name'),
 155             template_file=descriptor.get('file_name'),
 156             wait=True, **parameters)
 157         self.__logger.debug("stack: %s", self.stack)
 158
 159         servers = self.cloud.list_servers(detailed=True)
 160         self.__logger.debug("servers: %s", servers)
 161         for server in servers:
 162             if not self.check_regex_in_console(
 163                     server.name, regex='Cloud-init .* finished at ', loop=60):
 164                 return False
 165             if 'ellis' in server.name:
 166                 self.__logger.debug("server: %s", server)
 167                 ellis_ip = server.public_v4
 168
 169         assert ellis_ip
 170         self.clearwater = clearwater.ClearwaterTesting(self.case_name,
 171                                                        ellis_ip)
 172         # This call can take time and many retry because Heat is
 173         # an infrastructure orchestrator so when Heat say "stack created"
 174         # it means that all OpenStack ressources are created but not that
 175         # Clearwater are up and ready (Cloud-Init script still running)
 176         self.clearwater.availability_check()
 177
 178         duration = time.time() - start_time
 179
 180         self.details['vnf'].update(status='PASS', duration=duration)
 181         self.result += 1/3 * 100
 182
 183         return True
 184
 185     def test_vnf(self):
 186         """Run test on clearwater ims instance."""
 187         start_time = time.time()
 188
 189         outputs = self.cloud.get_stack(self.stack.id).outputs
 190         self.__logger.debug("stack outputs: %s", outputs)
 191         dns_ip = re.findall(r'[0-9]+(?:\.[0-9]+){3}', str(outputs))[0]
 192
 193         if not dns_ip:
 194             return False
 195
 196         short_result = self.clearwater.run_clearwater_live_test(
 197             dns_ip=dns_ip,
 198             public_domain=self.vnf['parameters']["zone"])
 199         duration = time.time() - start_time
 200         self.__logger.info(short_result)
 201         self.details['test_vnf'] = dict(result=short_result,
 202                                         duration=duration)
 203         try:
 204             vnf_test_rate = short_result['passed'] / (
 205                 short_result['total'] - short_result['skipped'])
 206             # orchestrator + vnf + test_vnf
 207             self.result += vnf_test_rate / 3 * 100
 208         except ZeroDivisionError:
 209             self.__logger.error("No test has been executed")
 210             self.details['test_vnf'].update(status='FAIL')
 211             return False
 212         except Exception:  # pylint: disable=broad-except
 213             self.__logger.exception("Cannot calculate results")
 214             self.details['test_vnf'].update(status='FAIL')
 215             return False
 216         return True if vnf_test_rate > 0 else False
 217
 218     def clean(self):
 219         """Clean created objects/functions."""
 220         assert self.cloud
 221         try:
 222             if self.stack:
 223                 self.cloud.delete_stack(self.stack.id, wait=True)
 224         except TypeError:
 225             # shade raises TypeError exceptions when checking stack status
 226             pass
 227         except Exception:  # pylint: disable=broad-except
 228             self.__logger.exception("Cannot clean stack ressources")
 229         super(HeatIms, self).clean()
 230         if self.role:
 231             self.orig_cloud.delete_role(self.role.id)