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, 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
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.server_groups = []
45 self.keypair_name = None
46 self.secgroup_name = 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__()
61 def init(self, attrs): # pragma: no cover
62 """initializes itself from the supplied arguments"""
63 self.name = attrs["name"]
65 self._user = attrs.get("user")
67 self.template_file = attrs.get("heat_template")
68 if self.template_file:
69 self.heat_parameters = attrs.get("heat_parameters")
72 self.keypair_name = self.name + "-key"
73 self.secgroup_name = self.name + "-secgroup"
75 self._image = attrs.get("image")
77 self._flavor = attrs.get("flavor")
79 self.placement_groups = [PlacementGroup(name, self, pgattrs["policy"])
80 for name, pgattrs in attrs.get(
81 "placement_groups", {}).items()]
83 self.server_groups = [ServerGroup(name, self, sgattrs["policy"])
84 for name, sgattrs in attrs.get(
85 "server_groups", {}).items()]
87 for name, netattrs in attrs["networks"].items():
88 network = Network(name, self, netattrs)
89 self.networks.append(network)
91 for name, serverattrs in attrs["servers"].items():
92 server = Server(name, self, serverattrs)
93 self.servers.append(server)
94 self._server_map[server.dn] = server
96 rsa_key = paramiko.RSAKey.generate(bits=2048, progress_func=None)
97 rsa_key.write_private_key_file(self.key_filename)
98 print("Writing %s ..." % self.key_filename)
99 with open(self.key_filename + ".pub", "w") as pubkey_file:
101 "%s %s\n" % (rsa_key.get_name(), rsa_key.get_base64()))
106 """returns application's default image name"""
111 """returns application's default flavor name"""
116 """return login user name corresponding to image"""
119 def _add_resources_to_template(self, template):
120 """add to the template the resources represented by this context"""
121 template.add_keypair(self.keypair_name, self.key_uuid)
122 template.add_security_group(self.secgroup_name)
124 for network in self.networks:
125 template.add_network(network.stack_name)
126 template.add_subnet(network.subnet_stack_name, network.stack_name,
130 template.add_router(network.router.stack_name,
131 network.router.external_gateway_info,
132 network.subnet_stack_name)
133 template.add_router_interface(network.router.stack_if_name,
134 network.router.stack_name,
135 network.subnet_stack_name)
137 # create a list of servers sorted by increasing no of placement groups
138 list_of_servers = sorted(self.servers,
139 key=lambda s: len(s.placement_groups))
142 # add servers with scheduler hints derived from placement groups
145 # create list of servers with availability policy
146 availability_servers = []
147 for server in list_of_servers:
148 for pg in server.placement_groups:
149 if pg.policy == "availability":
150 availability_servers.append(server)
153 # add servers with availability policy
155 for server in availability_servers:
157 for pg in server.placement_groups:
158 update_scheduler_hints(scheduler_hints, added_servers, pg)
159 # workround for openstack nova bug, check JIRA: YARDSTICK-200
161 if len(availability_servers) == 2:
162 if not scheduler_hints["different_host"]:
163 scheduler_hints.pop("different_host", None)
164 server.add_to_template(template,
168 scheduler_hints["different_host"] = \
169 scheduler_hints["different_host"][0]
170 server.add_to_template(template,
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)
198 for sg in self.server_groups:
199 template.add_server_group(sg.name, sg.policy)
201 # add remaining servers with no placement group configured
202 for server in list_of_servers:
203 # TODO placement_group and server_group should combine
204 if not server.placement_groups:
206 # affinity/anti-aff server group
207 sg = server.server_group
209 scheduler_hints["group"] = {'get_resource': sg.name}
210 server.add_to_template(template,
211 self.networks, scheduler_hints)
214 """deploys template into a stack using cloud"""
215 print("Deploying context '%s'" % self.name)
217 heat_template = HeatTemplate(self.name, self.template_file,
218 self.heat_parameters)
220 if self.template_file is None:
221 self._add_resources_to_template(heat_template)
224 self.stack = heat_template.create()
225 except KeyboardInterrupt:
226 sys.exit("\nStack create interrupted")
227 except RuntimeError as err:
228 sys.exit("error: failed to deploy stack: '%s'" % err.args)
229 except Exception as err:
230 sys.exit("error: failed to deploy stack: '%s'" % err)
232 # copy some vital stack output into server objects
233 for server in self.servers:
235 # TODO(hafe) can only handle one internal network for now
236 port = next(iter(server.ports.values()))
237 server.private_ip = self.stack.outputs[port["stack_name"]]
239 if server.floating_ip:
241 self.stack.outputs[server.floating_ip["stack_name"]]
243 print("Context '%s' deployed" % self.name)
246 """undeploys stack from cloud"""
248 print("Undeploying context '%s'" % self.name)
251 print("Context '%s' undeployed" % self.name)
253 if os.path.exists(self.key_filename):
255 os.remove(self.key_filename)
256 os.remove(self.key_filename + ".pub")
258 LOG.exception("Key filename %s", self.key_filename)
260 super(HeatContext, self).undeploy()
262 def _get_server(self, attr_name):
263 """lookup server info by name from context
264 attr_name: either a name for a server created by yardstick or a dict
265 with attribute name mapping when using external heat templates
267 key_filename = pkg_resources.resource_filename(
268 'yardstick.resources',
269 'files/yardstick_key-' + get_short_key_uuid(self.key_uuid))
271 if isinstance(attr_name, collections.Mapping):
272 cname = attr_name["name"].split(".")[1]
273 if cname != self.name:
278 if "public_ip_attr" in attr_name:
279 public_ip = self.stack.outputs[attr_name["public_ip_attr"]]
280 if "private_ip_attr" in attr_name:
281 private_ip = self.stack.outputs[
282 attr_name["private_ip_attr"]]
284 # Create a dummy server instance for holding the *_ip attributes
285 server = Server(attr_name["name"].split(".")[0], self, {})
286 server.public_ip = public_ip
287 server.private_ip = private_ip
289 if attr_name not in self._server_map:
291 server = self._server_map[attr_name]
297 "user": server.context.user,
298 "key_filename": key_filename,
299 "private_ip": server.private_ip
301 # Target server may only have private_ip
303 result["ip"] = server.public_ip