yardstick/benchmark/contexts/heat.py

   1 ##############################################################################
   2 # Copyright (c) 2015 Ericsson AB and others.
   3 #
   4 # All rights reserved. This program and the accompanying materials
   5 # are made available under the terms of the Apache License, Version 2.0
   6 # which accompanies this distribution, and is available at
   7 # http://www.apache.org/licenses/LICENSE-2.0
   8 ##############################################################################
   9
  10 from __future__ import absolute_import
  11 from __future__ import print_function
  12
  13 import collections
  14 import logging
  15 import os
  16 import uuid
  17 import errno
  18 from collections import OrderedDict
  19
  20 import ipaddress
  21 import pkg_resources
  22
  23 from yardstick.benchmark.contexts.base import Context
  24 from yardstick.benchmark.contexts.model import Network
  25 from yardstick.benchmark.contexts.model import PlacementGroup, ServerGroup
  26 from yardstick.benchmark.contexts.model import Server
  27 from yardstick.benchmark.contexts.model import update_scheduler_hints
  28 from yardstick.common.openstack_utils import get_neutron_client
  29 from yardstick.orchestrator.heat import HeatTemplate, get_short_key_uuid
  30 from yardstick.common import constants as consts
  31 from yardstick.common.utils import source_env
  32 from yardstick.ssh import SSH
  33
  34 LOG = logging.getLogger(__name__)
  35
  36 DEFAULT_HEAT_TIMEOUT = 3600
  37
  38
  39 def join_args(sep, *args):
  40     return sep.join(args)
  41
  42
  43 def h_join(*args):
  44     return '-'.join(args)
  45
  46
  47 class HeatContext(Context):
  48     """Class that represents a context in the logical model"""
  49
  50     __context_type__ = "Heat"
  51
  52     def __init__(self):
  53         self.name = None
  54         self.stack = None
  55         self.networks = OrderedDict()
  56         self.heat_timeout = None
  57         self.servers = []
  58         self.placement_groups = []
  59         self.server_groups = []
  60         self.keypair_name = None
  61         self.secgroup_name = None
  62         self._server_map = {}
  63         self.attrs = {}
  64         self._image = None
  65         self._flavor = None
  66         self.flavors = set()
  67         self._user = None
  68         self.template_file = None
  69         self.heat_parameters = None
  70         self.neutron_client = None
  71         # generate an uuid to identify yardstick_key
  72         # the first 8 digits of the uuid will be used
  73         self.key_uuid = uuid.uuid4()
  74         self.heat_timeout = None
  75         self.key_filename = ''.join(
  76             [consts.YARDSTICK_ROOT_PATH, 'yardstick/resources/files/yardstick_key-',
  77              get_short_key_uuid(self.key_uuid)])
  78         super(HeatContext, self).__init__()
  79
  80     @staticmethod
  81     def assign_external_network(networks):
  82         sorted_networks = sorted(networks.items())
  83         external_network = os.environ.get("EXTERNAL_NETWORK", "net04_ext")
  84
  85         have_external_network = any(net.get("external_network") for net in networks.values())
  86         if sorted_networks and not have_external_network:
  87             # no external net defined, assign it to first network using os.environ
  88             sorted_networks[0][1]["external_network"] = external_network
  89
  90         return sorted_networks
  91
  92     def init(self, attrs):
  93         self.check_environment()
  94         """initializes itself from the supplied arguments"""
  95         self.name = attrs["name"]
  96
  97         self._user = attrs.get("user")
  98
  99         self.template_file = attrs.get("heat_template")
 100         if self.template_file:
 101             self.heat_parameters = attrs.get("heat_parameters")
 102             return
 103
 104         self.keypair_name = h_join(self.name, "key")
 105         self.secgroup_name = h_join(self.name, "secgroup")
 106
 107         self._image = attrs.get("image")
 108
 109         self._flavor = attrs.get("flavor")
 110
 111         self.heat_timeout = attrs.get("timeout", DEFAULT_HEAT_TIMEOUT)
 112
 113         self.placement_groups = [PlacementGroup(name, self, pg_attrs["policy"])
 114                                  for name, pg_attrs in attrs.get(
 115                                  "placement_groups", {}).items()]
 116
 117         self.server_groups = [ServerGroup(name, self, sg_attrs["policy"])
 118                               for name, sg_attrs in attrs.get(
 119                               "server_groups", {}).items()]
 120
 121         # we have to do this first, because we are injecting external_network
 122         # into the dict
 123         sorted_networks = self.assign_external_network(attrs["networks"])
 124
 125         self.networks = OrderedDict(
 126             (name, Network(name, self, net_attrs)) for name, net_attrs in
 127             sorted_networks)
 128
 129         for name, server_attrs in sorted(attrs["servers"].items()):
 130             server = Server(name, self, server_attrs)
 131             self.servers.append(server)
 132             self._server_map[server.dn] = server
 133
 134         self.attrs = attrs
 135         SSH.gen_keys(self.key_filename)
 136
 137     def check_environment(self):
 138         try:
 139             os.environ['OS_AUTH_URL']
 140         except KeyError:
 141             try:
 142                 source_env(consts.OPENRC)
 143             except IOError as e:
 144                 if e.errno != errno.EEXIST:
 145                     LOG.error('OPENRC file not found')
 146                     raise
 147                 else:
 148                     LOG.error('OS_AUTH_URL not found')
 149
 150     @property
 151     def image(self):
 152         """returns application's default image name"""
 153         return self._image
 154
 155     @property
 156     def flavor(self):
 157         """returns application's default flavor name"""
 158         return self._flavor
 159
 160     @property
 161     def user(self):
 162         """return login user name corresponding to image"""
 163         return self._user
 164
 165     def _add_resources_to_template(self, template):
 166         """add to the template the resources represented by this context"""
 167
 168         if self.flavor:
 169             if isinstance(self.flavor, dict):
 170                 flavor = self.flavor.setdefault("name", self.name + "-flavor")
 171                 template.add_flavor(**self.flavor)
 172                 self.flavors.add(flavor)
 173
 174         template.add_keypair(self.keypair_name, self.key_uuid)
 175         template.add_security_group(self.secgroup_name)
 176
 177         for network in self.networks.values():
 178             template.add_network(network.stack_name,
 179                                  network.physical_network,
 180                                  network.provider,
 181                                  network.segmentation_id,
 182                                  network.port_security_enabled,
 183                                  network.network_type)
 184             template.add_subnet(network.subnet_stack_name, network.stack_name,
 185                                 network.subnet_cidr,
 186                                 network.enable_dhcp,
 187                                 network.gateway_ip)
 188
 189             if network.router:
 190                 template.add_router(network.router.stack_name,
 191                                     network.router.external_gateway_info,
 192                                     network.subnet_stack_name)
 193                 template.add_router_interface(network.router.stack_if_name,
 194                                               network.router.stack_name,
 195                                               network.subnet_stack_name)
 196
 197         # create a list of servers sorted by increasing no of placement groups
 198         list_of_servers = sorted(self.servers,
 199                                  key=lambda s: len(s.placement_groups))
 200
 201         #
 202         # add servers with scheduler hints derived from placement groups
 203         #
 204
 205         # create list of servers with availability policy
 206         availability_servers = []
 207         for server in list_of_servers:
 208             for pg in server.placement_groups:
 209                 if pg.policy == "availability":
 210                     availability_servers.append(server)
 211                     break
 212
 213         for server in availability_servers:
 214             if isinstance(server.flavor, dict):
 215                 try:
 216                     self.flavors.add(server.flavor["name"])
 217                 except KeyError:
 218                     self.flavors.add(h_join(server.stack_name, "flavor"))
 219
 220         # add servers with availability policy
 221         added_servers = []
 222         for server in availability_servers:
 223             scheduler_hints = {}
 224             for pg in server.placement_groups:
 225                 update_scheduler_hints(scheduler_hints, added_servers, pg)
 226             # workaround for openstack nova bug, check JIRA: YARDSTICK-200
 227             # for details
 228             if len(availability_servers) == 2:
 229                 if not scheduler_hints["different_host"]:
 230                     scheduler_hints.pop("different_host", None)
 231                     server.add_to_template(template,
 232                                            list(self.networks.values()),
 233                                            scheduler_hints)
 234                 else:
 235                     scheduler_hints["different_host"] = \
 236                         scheduler_hints["different_host"][0]
 237                     server.add_to_template(template,
 238                                            list(self.networks.values()),
 239                                            scheduler_hints)
 240             else:
 241                 server.add_to_template(template,
 242                                        list(self.networks.values()),
 243                                        scheduler_hints)
 244             added_servers.append(server.stack_name)
 245
 246         # create list of servers with affinity policy
 247         affinity_servers = []
 248         for server in list_of_servers:
 249             for pg in server.placement_groups:
 250                 if pg.policy == "affinity":
 251                     affinity_servers.append(server)
 252                     break
 253
 254         # add servers with affinity policy
 255         for server in affinity_servers:
 256             if server.stack_name in added_servers:
 257                 continue
 258             scheduler_hints = {}
 259             for pg in server.placement_groups:
 260                 update_scheduler_hints(scheduler_hints, added_servers, pg)
 261             server.add_to_template(template, list(self.networks.values()),
 262                                    scheduler_hints)
 263             added_servers.append(server.stack_name)
 264
 265         # add server group
 266         for sg in self.server_groups:
 267             template.add_server_group(sg.name, sg.policy)
 268
 269         # add remaining servers with no placement group configured
 270         for server in list_of_servers:
 271             # TODO placement_group and server_group should combine
 272             if not server.placement_groups:
 273                 scheduler_hints = {}
 274                 # affinity/anti-aff server group
 275                 sg = server.server_group
 276                 if sg:
 277                     scheduler_hints["group"] = {'get_resource': sg.name}
 278                 server.add_to_template(template,
 279                                        list(self.networks.values()),
 280                                        scheduler_hints)
 281
 282     def get_neutron_info(self):
 283         if not self.neutron_client:
 284             self.neutron_client = get_neutron_client()
 285
 286         networks = self.neutron_client.list_networks()
 287         for network in self.networks.values():
 288             for neutron_net in networks['networks']:
 289                 if neutron_net['name'] == network.stack_name:
 290                     network.segmentation_id = neutron_net.get('provider:segmentation_id')
 291                     # we already have physical_network
 292                     # network.physical_network = neutron_net.get('provider:physical_network')
 293                     network.network_type = neutron_net.get('provider:network_type')
 294                     network.neutron_info = neutron_net
 295
 296     def deploy(self):
 297         """deploys template into a stack using cloud"""
 298         print("Deploying context '%s'" % self.name)
 299
 300         heat_template = HeatTemplate(self.name, self.template_file,
 301                                      self.heat_parameters)
 302
 303         if self.template_file is None:
 304             self._add_resources_to_template(heat_template)
 305
 306         try:
 307             self.stack = heat_template.create(block=True,
 308                                               timeout=self.heat_timeout)
 309         except KeyboardInterrupt:
 310             raise SystemExit("\nStack create interrupted")
 311         except:
 312             LOG.exception("stack failed")
 313             # let the other failures happen, we want stack trace
 314             raise
 315
 316         # TODO: use Neutron to get segmentation-id
 317         self.get_neutron_info()
 318
 319         # copy some vital stack output into server objects
 320         for server in self.servers:
 321             if server.ports:
 322                 self.add_server_port(server)
 323
 324             if server.floating_ip:
 325                 server.public_ip = \
 326                     self.stack.outputs[server.floating_ip["stack_name"]]
 327
 328         print("Context '%s' deployed" % self.name)
 329
 330     def add_server_port(self, server):
 331         # TODO(hafe) can only handle one internal network for now
 332         # use private ip from first port
 333         private_port = next(iter(server.ports.values()))
 334         server.private_ip = self.stack.outputs[private_port["stack_name"]]
 335         server.interfaces = {}
 336         for network_name, port in server.ports.items():
 337             # port['port'] is either port name from mapping or default network_name
 338             server.interfaces[port['port']] = self.make_interface_dict(network_name, port['port'],
 339                                                                        port['stack_name'],
 340                                                                        self.stack.outputs)
 341
 342     def make_interface_dict(self, network_name, port, stack_name, outputs):
 343         private_ip = outputs[stack_name]
 344         mac_address = outputs[h_join(stack_name, "mac_address")]
 345         # these are attributes of the network, not the port
 346         output_subnet_cidr = outputs[h_join(self.name, network_name,
 347                                             'subnet', 'cidr')]
 348
 349         # these are attributes of the network, not the port
 350         output_subnet_gateway = outputs[h_join(self.name, network_name,
 351                                                'subnet', 'gateway_ip')]
 352
 353         return {
 354             "private_ip": private_ip,
 355             "subnet_id": outputs[h_join(stack_name, "subnet_id")],
 356             "subnet_cidr": output_subnet_cidr,
 357             "network": str(ipaddress.ip_network(output_subnet_cidr).network_address),
 358             "netmask": str(ipaddress.ip_network(output_subnet_cidr).netmask),
 359             "gateway_ip": output_subnet_gateway,
 360             "mac_address": mac_address,
 361             "device_id": outputs[h_join(stack_name, "device_id")],
 362             "network_id": outputs[h_join(stack_name, "network_id")],
 363             # this should be == vld_id for NSB tests
 364             "network_name": network_name,
 365             # to match vnf_generic
 366             "local_mac": mac_address,
 367             "local_ip": private_ip,
 368         }
 369
 370     def undeploy(self):
 371         """undeploys stack from cloud"""
 372         if self.stack:
 373             print("Undeploying context '%s'" % self.name)
 374             self.stack.delete()
 375             self.stack = None
 376             print("Context '%s' undeployed" % self.name)
 377
 378         if os.path.exists(self.key_filename):
 379             try:
 380                 os.remove(self.key_filename)
 381                 os.remove(self.key_filename + ".pub")
 382             except OSError:
 383                 LOG.exception("Key filename %s", self.key_filename)
 384
 385         super(HeatContext, self).undeploy()
 386
 387     @staticmethod
 388     def generate_routing_table(server):
 389         routes = [
 390             {
 391                 "network": intf["network"],
 392                 "netmask": intf["netmask"],
 393                 "if": name,
 394                 # We have to encode a None gateway as '' for Jinja2 to YAML conversion
 395                 "gateway": intf["gateway_ip"] if intf["gateway_ip"] else '',
 396             }
 397             for name, intf in server.interfaces.items()
 398         ]
 399         return routes
 400
 401     def _get_server(self, attr_name):
 402         """lookup server info by name from context
 403         attr_name: either a name for a server created by yardstick or a dict
 404         with attribute name mapping when using external heat templates
 405         """
 406         key_filename = pkg_resources.resource_filename(
 407             'yardstick.resources',
 408             h_join('files/yardstick_key', get_short_key_uuid(self.key_uuid)))
 409
 410         if isinstance(attr_name, collections.Mapping):
 411             node_name, cname = self.split_name(attr_name['name'])
 412             if cname is None or cname != self.name:
 413                 return None
 414
 415             # Create a dummy server instance for holding the *_ip attributes
 416             server = Server(node_name, self, {})
 417             server.public_ip = self.stack.outputs.get(
 418                 attr_name.get("public_ip_attr", object()), None)
 419
 420             server.private_ip = self.stack.outputs.get(
 421                 attr_name.get("private_ip_attr", object()), None)
 422         else:
 423             server = self._server_map.get(attr_name, None)
 424             if server is None:
 425                 return None
 426
 427         result = {
 428             "user": server.context.user,
 429             "key_filename": key_filename,
 430             "private_ip": server.private_ip,
 431             "interfaces": server.interfaces,
 432             "routing_table": self.generate_routing_table(server),
 433             # empty IPv6 routing table
 434             "nd_route_tbl": [],
 435         }
 436         # Target server may only have private_ip
 437         if server.public_ip:
 438             result["ip"] = server.public_ip
 439
 440         return result
 441
 442     def _get_network(self, attr_name):
 443         if not isinstance(attr_name, collections.Mapping):
 444             network = self.networks.get(attr_name, None)
 445
 446         else:
 447             # Only take the first key, value
 448             key, value = next(iter(attr_name.items()), (None, None))
 449             if key is None:
 450                 return None
 451             network_iter = (n for n in self.networks.values() if getattr(n, key) == value)
 452             network = next(network_iter, None)
 453
 454         if network is None:
 455             return None
 456
 457         result = {
 458             "name": network.name,
 459             "segmentation_id": network.segmentation_id,
 460             "network_type": network.network_type,
 461             "physical_network": network.physical_network,
 462         }
 463         return result