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