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 sys
  17 import uuid
  18
  19 import paramiko
  20 import pkg_resources
  21
  22 from yardstick.benchmark.contexts.base import Context
  23 from yardstick.benchmark.contexts.model import Network
  24 from yardstick.benchmark.contexts.model import PlacementGroup, ServerGroup
  25 from yardstick.benchmark.contexts.model import Server
  26 from yardstick.benchmark.contexts.model import update_scheduler_hints
  27 from yardstick.orchestrator.heat import HeatTemplate, get_short_key_uuid
  28 from yardstick.definitions import YARDSTICK_ROOT_PATH
  29
  30 LOG = logging.getLogger(__name__)
  31
  32
  33 class HeatContext(Context):
  34     """Class that represents a context in the logical model"""
  35
  36     __context_type__ = "Heat"
  37
  38     def __init__(self):
  39         self.name = None
  40         self.stack = None
  41         self.networks = []
  42         self.servers = []
  43         self.placement_groups = []
  44         self.server_groups = []
  45         self.keypair_name = None
  46         self.secgroup_name = None
  47         self._server_map = {}
  48         self._image = None
  49         self._flavor = None
  50         self._user = None
  51         self.template_file = None
  52         self.heat_parameters = None
  53         # generate an uuid to identify yardstick_key
  54         # the first 8 digits of the uuid will be used
  55         self.key_uuid = uuid.uuid4()
  56         self.key_filename = ''.join(
  57             [YARDSTICK_ROOT_PATH, 'yardstick/resources/files/yardstick_key-',
  58              get_short_key_uuid(self.key_uuid)])
  59         super(HeatContext, self).__init__()
  60
  61     def init(self, attrs):     # pragma: no cover
  62         """initializes itself from the supplied arguments"""
  63         self.name = attrs["name"]
  64
  65         if "user" in attrs:
  66             self._user = attrs["user"]
  67
  68         if "heat_template" in attrs:
  69             self.template_file = attrs["heat_template"]
  70             self.heat_parameters = attrs.get("heat_parameters", None)
  71             return
  72
  73         self.keypair_name = self.name + "-key"
  74         self.secgroup_name = self.name + "-secgroup"
  75
  76         if "image" in attrs:
  77             self._image = attrs.get("image")
  78
  79         if "flavor" in attrs:
  80             self._flavor = attrs.get("flavor")
  81
  82         self.placement_groups = [PlacementGroup(name, self, pgattrs["policy"])
  83                                  for name, pgattrs in attrs.get(
  84                                  "placement_groups", {}).items()]
  85
  86         self.server_groups = [ServerGroup(name, self, sgattrs["policy"])
  87                               for name, sgattrs in attrs.get(
  88                               "server_groups", {}).items()]
  89
  90         for name, netattrs in attrs["networks"].items():
  91             network = Network(name, self, netattrs)
  92             self.networks.append(network)
  93
  94         for name, serverattrs in attrs["servers"].items():
  95             server = Server(name, self, serverattrs)
  96             self.servers.append(server)
  97             self._server_map[server.dn] = server
  98
  99         rsa_key = paramiko.RSAKey.generate(bits=2048, progress_func=None)
 100         rsa_key.write_private_key_file(self.key_filename)
 101         print("Writing %s ..." % self.key_filename)
 102         with open(self.key_filename + ".pub", "w") as pubkey_file:
 103             pubkey_file.write(
 104                 "%s %s\n" % (rsa_key.get_name(), rsa_key.get_base64()))
 105         del rsa_key
 106
 107     @property
 108     def image(self):
 109         """returns application's default image name"""
 110         return self._image
 111
 112     @property
 113     def flavor(self):
 114         """returns application's default flavor name"""
 115         return self._flavor
 116
 117     @property
 118     def user(self):
 119         """return login user name corresponding to image"""
 120         return self._user
 121
 122     def _add_resources_to_template(self, template):
 123         """add to the template the resources represented by this context"""
 124         template.add_keypair(self.keypair_name, self.key_uuid)
 125         template.add_security_group(self.secgroup_name)
 126
 127         for network in self.networks:
 128             template.add_network(network.stack_name)
 129             template.add_subnet(network.subnet_stack_name, network.stack_name,
 130                                 network.subnet_cidr)
 131
 132             if network.router:
 133                 template.add_router(network.router.stack_name,
 134                                     network.router.external_gateway_info,
 135                                     network.subnet_stack_name)
 136                 template.add_router_interface(network.router.stack_if_name,
 137                                               network.router.stack_name,
 138                                               network.subnet_stack_name)
 139
 140         # create a list of servers sorted by increasing no of placement groups
 141         list_of_servers = sorted(self.servers,
 142                                  key=lambda s: len(s.placement_groups))
 143
 144         #
 145         # add servers with scheduler hints derived from placement groups
 146         #
 147
 148         # create list of servers with availability policy
 149         availability_servers = []
 150         for server in list_of_servers:
 151             for pg in server.placement_groups:
 152                 if pg.policy == "availability":
 153                     availability_servers.append(server)
 154                     break
 155
 156         # add servers with availability policy
 157         added_servers = []
 158         for server in availability_servers:
 159             scheduler_hints = {}
 160             for pg in server.placement_groups:
 161                 update_scheduler_hints(scheduler_hints, added_servers, pg)
 162             # workround for openstack nova bug, check JIRA: YARDSTICK-200
 163             # for details
 164             if len(availability_servers) == 2:
 165                 if not scheduler_hints["different_host"]:
 166                     scheduler_hints.pop("different_host", None)
 167                     server.add_to_template(template,
 168                                            self.networks,
 169                                            scheduler_hints)
 170                 else:
 171                     scheduler_hints["different_host"] = \
 172                         scheduler_hints["different_host"][0]
 173                     server.add_to_template(template,
 174                                            self.networks,
 175                                            scheduler_hints)
 176             else:
 177                 server.add_to_template(template,
 178                                        self.networks,
 179                                        scheduler_hints)
 180             added_servers.append(server.stack_name)
 181
 182         # create list of servers with affinity policy
 183         affinity_servers = []
 184         for server in list_of_servers:
 185             for pg in server.placement_groups:
 186                 if pg.policy == "affinity":
 187                     affinity_servers.append(server)
 188                     break
 189
 190         # add servers with affinity policy
 191         for server in affinity_servers:
 192             if server.stack_name in added_servers:
 193                 continue
 194             scheduler_hints = {}
 195             for pg in server.placement_groups:
 196                 update_scheduler_hints(scheduler_hints, added_servers, pg)
 197             server.add_to_template(template, self.networks, scheduler_hints)
 198             added_servers.append(server.stack_name)
 199
 200         # add server group
 201         for sg in self.server_groups:
 202             template.add_server_group(sg.name, sg.policy)
 203
 204         # add remaining servers with no placement group configured
 205         for server in list_of_servers:
 206             # TODO placement_group and server_group should combine
 207             if not server.placement_groups:
 208                 scheduler_hints = {}
 209                 # affinity/anti-aff server group
 210                 sg = server.server_group
 211                 if sg:
 212                     scheduler_hints["group"] = {'get_resource': sg.name}
 213                 server.add_to_template(template,
 214                                        self.networks, scheduler_hints)
 215
 216     def deploy(self):
 217         """deploys template into a stack using cloud"""
 218         print("Deploying context '%s'" % self.name)
 219
 220         heat_template = HeatTemplate(self.name, self.template_file,
 221                                      self.heat_parameters)
 222
 223         if self.template_file is None:
 224             self._add_resources_to_template(heat_template)
 225
 226         try:
 227             self.stack = heat_template.create()
 228         except KeyboardInterrupt:
 229             sys.exit("\nStack create interrupted")
 230         except RuntimeError as err:
 231             sys.exit("error: failed to deploy stack: '%s'" % err.args)
 232         except Exception as err:
 233             sys.exit("error: failed to deploy stack: '%s'" % err)
 234
 235         # copy some vital stack output into server objects
 236         for server in self.servers:
 237             if server.ports:
 238                 # TODO(hafe) can only handle one internal network for now
 239                 port = next(iter(server.ports.values()))
 240                 server.private_ip = self.stack.outputs[port["stack_name"]]
 241
 242             if server.floating_ip:
 243                 server.public_ip = \
 244                     self.stack.outputs[server.floating_ip["stack_name"]]
 245
 246         print("Context '%s' deployed" % self.name)
 247
 248     def undeploy(self):
 249         """undeploys stack from cloud"""
 250         if self.stack:
 251             print("Undeploying context '%s'" % self.name)
 252             self.stack.delete()
 253             self.stack = None
 254             print("Context '%s' undeployed" % self.name)
 255
 256         if os.path.exists(self.key_filename):
 257             try:
 258                 os.remove(self.key_filename)
 259                 os.remove(self.key_filename + ".pub")
 260             except OSError:
 261                 LOG.exception("Key filename %s", self.key_filename)
 262
 263     def _get_server(self, attr_name):
 264         """lookup server info by name from context
 265         attr_name: either a name for a server created by yardstick or a dict
 266         with attribute name mapping when using external heat templates
 267         """
 268         key_filename = pkg_resources.resource_filename(
 269             'yardstick.resources',
 270             'files/yardstick_key-' + get_short_key_uuid(self.key_uuid))
 271
 272         if isinstance(attr_name, collections.Mapping):
 273             cname = attr_name["name"].split(".")[1]
 274             if cname != self.name:
 275                 return None
 276
 277             public_ip = None
 278             private_ip = None
 279             if "public_ip_attr" in attr_name:
 280                 public_ip = self.stack.outputs[attr_name["public_ip_attr"]]
 281             if "private_ip_attr" in attr_name:
 282                 private_ip = self.stack.outputs[
 283                     attr_name["private_ip_attr"]]
 284
 285             # Create a dummy server instance for holding the *_ip attributes
 286             server = Server(attr_name["name"].split(".")[0], self, {})
 287             server.public_ip = public_ip
 288             server.private_ip = private_ip
 289         else:
 290             if attr_name not in self._server_map:
 291                 return None
 292             server = self._server_map[attr_name]
 293
 294         if server is None:
 295             return None
 296
 297         result = {
 298             "user": server.context.user,
 299             "key_filename": key_filename,
 300             "private_ip": server.private_ip
 301         }
 302         # Target server may only have private_ip
 303         if server.public_ip:
 304             result["ip"] = server.public_ip
 305
 306         return result