functest/opnfv_tests/vnf/ims/cloudify_ims.py

   1 #!/usr/bin/env python
   2
   3 # Copyright (c) 2017 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 """CloudifyIms testcase implementation."""
  11
  12 from __future__ import division
  13
  14 import logging
  15 import os
  16 import time
  17
  18 import pkg_resources
  19 import scp
  20 import six
  21
  22 from functest.core import cloudify
  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@orange.com>"
  29
  30
  31 class CloudifyIms(cloudify.Cloudify):
  32     """Clearwater vIMS deployed with Cloudify Orchestrator Case."""
  33
  34     __logger = logging.getLogger(__name__)
  35
  36     filename_alt = ('/home/opnfv/functest/images/'
  37                     'ubuntu-14.04-server-cloudimg-amd64-disk1.img')
  38
  39     flavor_alt_ram = 2048
  40     flavor_alt_vcpus = 2
  41     flavor_alt_disk = 25
  42
  43     quota_security_group = 20
  44     quota_security_group_rule = 100
  45     quota_port = 50
  46
  47     def __init__(self, **kwargs):
  48         """Initialize CloudifyIms testcase object."""
  49         if "case_name" not in kwargs:
  50             kwargs["case_name"] = "cloudify_ims"
  51         super(CloudifyIms, self).__init__(**kwargs)
  52
  53         # Retrieve the configuration
  54         try:
  55             self.config = getattr(
  56                 config.CONF, 'vnf_{}_config'.format(self.case_name))
  57         except Exception:
  58             raise Exception("VNF config file not found")
  59
  60         self.case_dir = pkg_resources.resource_filename(
  61             'functest', 'opnfv_tests/vnf/ims')
  62         config_file = os.path.join(self.case_dir, self.config)
  63
  64         self.details['orchestrator'] = dict(
  65             name=functest_utils.get_parameter_from_yaml(
  66                 "orchestrator.name", config_file),
  67             version=functest_utils.get_parameter_from_yaml(
  68                 "orchestrator.version", config_file),
  69             status='ERROR',
  70             result=''
  71         )
  72
  73         self.vnf = dict(
  74             descriptor=functest_utils.get_parameter_from_yaml(
  75                 "vnf.descriptor", config_file),
  76             inputs=functest_utils.get_parameter_from_yaml(
  77                 "vnf.inputs", config_file)
  78         )
  79         self.details['vnf'] = dict(
  80             descriptor_version=self.vnf['descriptor']['version'],
  81             name=functest_utils.get_parameter_from_yaml(
  82                 "vnf.name", config_file),
  83             version=functest_utils.get_parameter_from_yaml(
  84                 "vnf.version", config_file),
  85         )
  86         self.__logger.debug("VNF configuration: %s", self.vnf)
  87
  88         self.details['test_vnf'] = dict(
  89             name=functest_utils.get_parameter_from_yaml(
  90                 "vnf_test_suite.name", config_file),
  91             version=functest_utils.get_parameter_from_yaml(
  92                 "vnf_test_suite.version", config_file)
  93         )
  94
  95         self.image_alt = None
  96         self.flavor_alt = None
  97         self.clearwater = None
  98
  99     def check_requirements(self):
 100         if env.get('NEW_USER_ROLE').lower() == "admin":
 101             self.__logger.warn(
 102                 "Defining NEW_USER_ROLE=admin will easily break the testcase "
 103                 "because Cloudify doesn't manage tenancy (e.g. subnet  "
 104                 "overlapping)")
 105
 106     def execute(self):
 107         """
 108         Deploy Cloudify Manager.
 109
 110         network, security group, fip, VM creation
 111         """
 112         assert super(CloudifyIms, self).execute() == 0
 113         start_time = time.time()
 114         self.orig_cloud.set_network_quotas(
 115             self.project.project.name,
 116             security_group=self.quota_security_group,
 117             security_group_rule=self.quota_security_group_rule,
 118             port=self.quota_port)
 119         self.__logger.info("Put OpenStack creds in manager")
 120         cfy_creds = dict(
 121             keystone_username=self.project.user.name,
 122             keystone_password=self.project.password,
 123             keystone_tenant_name=self.project.project.name,
 124             keystone_url=self.get_public_auth_url(self.orig_cloud),
 125             region=os.environ.get('OS_REGION_NAME', 'RegionOne'),
 126             user_domain_name=os.environ.get(
 127                 'OS_USER_DOMAIN_NAME', 'Default'),
 128             project_domain_name=os.environ.get(
 129                 'OS_PROJECT_DOMAIN_NAME', 'Default'))
 130         self.__logger.info("Set creds for cloudify manager %s", cfy_creds)
 131
 132         for loop in range(10):
 133             try:
 134                 secrets_list = self.cfy_client.secrets.list()
 135                 for k, val in six.iteritems(cfy_creds):
 136                     if not any(d.get('key', None) == k for d in secrets_list):
 137                         self.cfy_client.secrets.create(k, val)
 138                     else:
 139                         self.cfy_client.secrets.update(k, val)
 140                 break
 141             except Exception:  # pylint: disable=broad-except
 142                 self.__logger.info(
 143                     "try %s: Cannot create secrets", loop + 1)
 144                 time.sleep(30)
 145         else:
 146             self.__logger.error("Cannot create secrets")
 147             return 1
 148
 149         duration = time.time() - start_time
 150
 151         self.__logger.info("Put private keypair in manager")
 152         scpc = scp.SCPClient(self.ssh.get_transport())
 153         scpc.put(self.key_filename, remote_path='~/cloudify_ims.pem')
 154         (_, stdout, stderr) = self.ssh.exec_command(
 155             "sudo cp ~/cloudify_ims.pem /etc/cloudify/ && "
 156             "sudo chmod 444 /etc/cloudify/cloudify_ims.pem && "
 157             "sudo yum install -y gcc python-devel python-cmd2 && "
 158             "cfy status")
 159         self.__logger.info("output:\n%s", stdout.read())
 160         self.__logger.info("error:\n%s", stderr.read())
 161
 162         self.details['orchestrator'].update(status='PASS', duration=duration)
 163
 164         self.vnf['inputs'].update(dict(
 165             external_network_name=self.ext_net.name,
 166             network_name=self.network.name,
 167             key_pair_name=self.keypair.name
 168         ))
 169         if self.deploy_vnf() and self.test_vnf():
 170             self.result = 100
 171             return 0
 172         self.result = 1/3 * 100
 173         return 1
 174
 175     def deploy_vnf(self):
 176         """Deploy Clearwater IMS."""
 177         start_time = time.time()
 178
 179         secgroups = self.cloud.list_security_groups(
 180             filters={'name': 'default',
 181                      'project_id': self.project.project.id})
 182         if secgroups:
 183             secgroup = secgroups[0]
 184         else:
 185             self.__logger.error("No 'default' security group in project %s",
 186                                 self.project.project.name)
 187             return False
 188
 189         self.cloud.create_security_group_rule(
 190             secgroup.id, port_range_min=22, port_range_max=22,
 191             protocol='tcp', direction='ingress')
 192
 193         self.__logger.info("Upload VNFD")
 194         descriptor = self.vnf['descriptor']
 195         self.cfy_client.blueprints.upload(
 196             descriptor.get('file_name'), descriptor.get('name'))
 197
 198         self.image_alt = self.publish_image_alt()
 199         self.flavor_alt = self.create_flavor_alt()
 200         self.vnf['inputs'].update(dict(
 201             image_id=self.image_alt.id,
 202             flavor_id=self.flavor_alt.id,
 203         ))
 204
 205         self.__logger.info("Create VNF Instance")
 206         self.cfy_client.deployments.create(
 207             descriptor.get('name'), descriptor.get('name'),
 208             self.vnf.get('inputs'))
 209
 210         cloudify.wait_for_execution(
 211             self.cfy_client,
 212             cloudify.get_execution_id(self.cfy_client, descriptor.get('name')),
 213             self.__logger, timeout=300)
 214
 215         self.__logger.info("Start the VNF Instance deployment")
 216         execution = self.cfy_client.executions.start(
 217             descriptor.get('name'), 'install')
 218         # Show execution log
 219         execution = cloudify.wait_for_execution(
 220             self.cfy_client, execution, self.__logger, timeout=3600)
 221
 222         self.__logger.info(execution)
 223         if execution.status != 'terminated':
 224             self.details['vnf'].update(status='FAIL',
 225                                        duration=time.time() - start_time)
 226             return False
 227
 228         ellis_ip = self.cfy_client.deployments.outputs.get(
 229             self.vnf['descriptor'].get('name'))['outputs']['ellis_ip']
 230         self.clearwater = clearwater.ClearwaterTesting(self.case_name,
 231                                                        ellis_ip)
 232         self.clearwater.availability_check()
 233
 234         self.details['vnf'].update(status='PASS',
 235                                    duration=time.time() - start_time)
 236         self.result += 1/3 * 100
 237         return True
 238
 239     def test_vnf(self):
 240         """Run test on clearwater ims instance."""
 241         start_time = time.time()
 242
 243         dns_ip = self.cfy_client.deployments.outputs.get(
 244             self.vnf['descriptor'].get('name'))['outputs']['dns_ip']
 245
 246         if not dns_ip:
 247             return False
 248
 249         short_result = self.clearwater.run_clearwater_live_test(
 250             dns_ip=dns_ip,
 251             public_domain=self.vnf['inputs']["public_domain"])
 252         duration = time.time() - start_time
 253         self.__logger.info(short_result)
 254         self.details['test_vnf'].update(result=short_result,
 255                                         duration=duration)
 256         try:
 257             vnf_test_rate = short_result['passed'] / (
 258                 short_result['total'] - short_result['skipped'])
 259             # orchestrator + vnf + test_vnf
 260             self.result += vnf_test_rate / 3 * 100
 261         except ZeroDivisionError:
 262             self.__logger.error("No test has been executed")
 263             self.details['test_vnf'].update(status='FAIL')
 264             return False
 265         except Exception:  # pylint: disable=broad-except
 266             self.__logger.exception("Cannot calculate results")
 267             self.details['test_vnf'].update(status='FAIL')
 268             return False
 269         return True if vnf_test_rate > 0 else False
 270
 271     def clean(self):
 272         """Clean created objects/functions."""
 273         try:
 274             dep_name = self.vnf['descriptor'].get('name')
 275             # kill existing execution
 276             self.__logger.info('Deleting the current deployment')
 277             exec_list = self.cfy_client.executions.list()
 278             for execution in exec_list:
 279                 if execution['status'] == "started":
 280                     try:
 281                         self.cfy_client.executions.cancel(
 282                             execution['id'], force=True)
 283                     except Exception:  # pylint: disable=broad-except
 284                         self.__logger.warn("Can't cancel the current exec")
 285
 286             execution = self.cfy_client.executions.start(
 287                 dep_name,
 288                 'uninstall',
 289                 parameters=dict(ignore_failure=True),
 290                 force=True)
 291
 292             cloudify.wait_for_execution(
 293                 self.cfy_client, execution, self.__logger)
 294             self.cfy_client.deployments.delete(
 295                 self.vnf['descriptor'].get('name'))
 296             self.cfy_client.blueprints.delete(
 297                 self.vnf['descriptor'].get('name'))
 298         except Exception:  # pylint: disable=broad-except
 299             self.__logger.exception("Some issue during the undeployment ..")
 300         if self.image_alt:
 301             self.cloud.delete_image(self.image_alt)
 302         if self.flavor_alt:
 303             self.orig_cloud.delete_flavor(self.flavor_alt.id)
 304         super(CloudifyIms, self).clean()