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