1 ##############################################################################
2 # Copyright (c) 2015 Ericsson AB and others.
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 ##############################################################################
10 from __future__ import absolute_import
11 from __future__ import print_function
22 from yardstick.benchmark.contexts.base import Context
23 from yardstick.benchmark.contexts.model import Network
24 from yardstick.benchmark.contexts.model import PlacementGroup
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
30 LOG = logging.getLogger(__name__)
33 class HeatContext(Context):
34 """Class that represents a context in the logical model"""
36 __context_type__ = "Heat"
43 self.placement_groups = []
44 self.keypair_name = None
45 self.secgroup_name = None
50 self.template_file = None
51 self.heat_parameters = None
52 # generate an uuid to identify yardstick_key
53 # the first 8 digits of the uuid will be used
54 self.key_uuid = uuid.uuid4()
55 self.key_filename = ''.join(
56 [YARDSTICK_ROOT_PATH, 'yardstick/resources/files/yardstick_key-',
57 get_short_key_uuid(self.key_uuid)])
58 super(self.__class__, self).__init__()
60 def init(self, attrs):
61 """initializes itself from the supplied arguments"""
62 self.name = attrs["name"]
65 self._user = attrs["user"]
67 if "heat_template" in attrs:
68 self.template_file = attrs["heat_template"]
69 self.heat_parameters = attrs.get("heat_parameters", None)
72 self.keypair_name = self.name + "-key"
73 self.secgroup_name = self.name + "-secgroup"
76 self._image = attrs["image"]
79 self._flavor = attrs["flavor"]
81 if "placement_groups" in attrs:
82 for name, pgattrs in attrs["placement_groups"].items():
83 pg = PlacementGroup(name, self, pgattrs["policy"])
84 self.placement_groups.append(pg)
86 for name, netattrs in attrs["networks"].items():
87 network = Network(name, self, netattrs)
88 self.networks.append(network)
90 for name, serverattrs in attrs["servers"].items():
91 server = Server(name, self, serverattrs)
92 self.servers.append(server)
93 self._server_map[server.dn] = server
95 rsa_key = paramiko.RSAKey.generate(bits=2048, progress_func=None)
96 rsa_key.write_private_key_file(self.key_filename)
97 open(self.key_filename + ".pub", "w").write("%s %s\n" %
99 rsa_key.get_base64()))
104 """returns application's default image name"""
109 """returns application's default flavor name"""
114 """return login user name corresponding to image"""
117 def _add_resources_to_template(self, template):
118 """add to the template the resources represented by this context"""
119 template.add_keypair(self.keypair_name, self.key_uuid)
120 template.add_security_group(self.secgroup_name)
122 for network in self.networks:
123 template.add_network(network.stack_name)
124 template.add_subnet(network.subnet_stack_name, network.stack_name,
128 template.add_router(network.router.stack_name,
129 network.router.external_gateway_info,
130 network.subnet_stack_name)
131 template.add_router_interface(network.router.stack_if_name,
132 network.router.stack_name,
133 network.subnet_stack_name)
135 # create a list of servers sorted by increasing no of placement groups
136 list_of_servers = sorted(self.servers,
137 key=lambda s: len(s.placement_groups))
140 # add servers with scheduler hints derived from placement groups
143 # create list of servers with availability policy
144 availability_servers = []
145 for server in list_of_servers:
146 for pg in server.placement_groups:
147 if pg.policy == "availability":
148 availability_servers.append(server)
151 # add servers with availability policy
153 for server in availability_servers:
155 for pg in server.placement_groups:
156 update_scheduler_hints(scheduler_hints, added_servers, pg)
157 # workround for openstack nova bug, check JIRA: YARDSTICK-200
159 if len(availability_servers) == 2:
160 if len(scheduler_hints["different_host"]) == 0:
161 scheduler_hints.pop("different_host", None)
162 server.add_to_template(template,
165 added_servers.append(server.stack_name)
167 scheduler_hints["different_host"] = \
168 scheduler_hints["different_host"][0]
169 server.add_to_template(template,
172 added_servers.append(server.stack_name)
174 server.add_to_template(template,
177 added_servers.append(server.stack_name)
179 # create list of servers with affinity policy
180 affinity_servers = []
181 for server in list_of_servers:
182 for pg in server.placement_groups:
183 if pg.policy == "affinity":
184 affinity_servers.append(server)
187 # add servers with affinity policy
188 for server in affinity_servers:
189 if server.stack_name in added_servers:
192 for pg in server.placement_groups:
193 update_scheduler_hints(scheduler_hints, added_servers, pg)
194 server.add_to_template(template, self.networks, scheduler_hints)
195 added_servers.append(server.stack_name)
197 # add remaining servers with no placement group configured
198 for server in list_of_servers:
199 if len(server.placement_groups) == 0:
200 server.add_to_template(template, self.networks, {})
203 """deploys template into a stack using cloud"""
204 print("Deploying context '%s'" % self.name)
206 heat_template = HeatTemplate(self.name, self.template_file,
207 self.heat_parameters)
209 if self.template_file is None:
210 self._add_resources_to_template(heat_template)
213 self.stack = heat_template.create()
214 except KeyboardInterrupt:
215 sys.exit("\nStack create interrupted")
216 except RuntimeError as err:
217 sys.exit("error: failed to deploy stack: '%s'" % err.args)
218 except Exception as err:
219 sys.exit("error: failed to deploy stack: '%s'" % err)
221 # copy some vital stack output into server objects
222 for server in self.servers:
223 if len(server.ports) > 0:
224 # TODO(hafe) can only handle one internal network for now
225 port = list(server.ports.values())[0]
226 server.private_ip = self.stack.outputs[port["stack_name"]]
228 if server.floating_ip:
230 self.stack.outputs[server.floating_ip["stack_name"]]
232 print("Context '%s' deployed" % self.name)
235 """undeploys stack from cloud"""
237 print("Undeploying context '%s'" % self.name)
240 print("Context '%s' undeployed" % self.name)
242 if os.path.exists(self.key_filename):
244 os.remove(self.key_filename)
245 os.remove(self.key_filename + ".pub")
247 LOG.exception("Key filename %s", self.key_filename)
249 def _get_server(self, attr_name):
250 """lookup server info by name from context
251 attr_name: either a name for a server created by yardstick or a dict
252 with attribute name mapping when using external heat templates
254 key_filename = pkg_resources.resource_filename(
255 'yardstick.resources',
256 'files/yardstick_key-' + get_short_key_uuid(self.key_uuid))
258 if isinstance(attr_name, collections.Mapping):
259 cname = attr_name["name"].split(".")[1]
260 if cname != self.name:
265 if "public_ip_attr" in attr_name:
266 public_ip = self.stack.outputs[attr_name["public_ip_attr"]]
267 if "private_ip_attr" in attr_name:
268 private_ip = self.stack.outputs[
269 attr_name["private_ip_attr"]]
271 # Create a dummy server instance for holding the *_ip attributes
272 server = Server(attr_name["name"].split(".")[0], self, {})
273 server.public_ip = public_ip
274 server.private_ip = private_ip
276 if attr_name not in self._server_map:
278 server = self._server_map[attr_name]
284 "user": server.context.user,
285 "key_filename": key_filename,
286 "private_ip": server.private_ip
288 # Target server may only have private_ip
290 result["ip"] = server.public_ip