9cf29981b4198991cb82a2f7b2f28b6e7d023660
[yardstick.git] / 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 sys
11
12 from yardstick.benchmark.contexts.base import Context
13 from yardstick.benchmark.contexts.model import Server
14 from yardstick.benchmark.contexts.model import PlacementGroup
15 from yardstick.benchmark.contexts.model import Network
16 from yardstick.benchmark.contexts.model import update_scheduler_hints
17 from yardstick.orchestrator.heat import HeatTemplate
18
19
20 class HeatContext(Context):
21     '''Class that represents a context in the logical model'''
22
23     __context_type__ = "Heat"
24
25     def __init__(self):
26         self.name = None
27         self.stack = None
28         self.networks = []
29         self.servers = []
30         self.placement_groups = []
31         self.keypair_name = None
32         self.secgroup_name = None
33         self._server_map = {}
34         self._image = None
35         self._flavor = None
36         self._user = None
37         self.template_file = None
38         self.heat_parameters = None
39         super(self.__class__, self).__init__()
40
41     def init(self, attrs):
42         '''initializes itself from the supplied arguments'''
43         self.name = attrs["name"]
44
45         if "user" in attrs:
46             self._user = attrs["user"]
47
48         if "heat_template" in attrs:
49             self.template_file = attrs["heat_template"]
50             self.heat_parameters = attrs.get("heat_parameters", None)
51             return
52
53         self.keypair_name = self.name + "-key"
54         self.secgroup_name = self.name + "-secgroup"
55
56         if "image" in attrs:
57             self._image = attrs["image"]
58
59         if "flavor" in attrs:
60             self._flavor = attrs["flavor"]
61
62         if "placement_groups" in attrs:
63             for name, pgattrs in attrs["placement_groups"].items():
64                 pg = PlacementGroup(name, self, pgattrs["policy"])
65                 self.placement_groups.append(pg)
66
67         for name, netattrs in attrs["networks"].items():
68             network = Network(name, self, netattrs)
69             self.networks.append(network)
70
71         for name, serverattrs in attrs["servers"].items():
72             server = Server(name, self, serverattrs)
73             self.servers.append(server)
74             self._server_map[server.dn] = server
75
76     @property
77     def image(self):
78         '''returns application's default image name'''
79         return self._image
80
81     @property
82     def flavor(self):
83         '''returns application's default flavor name'''
84         return self._flavor
85
86     @property
87     def user(self):
88         '''return login user name corresponding to image'''
89         return self._user
90
91     def _add_resources_to_template(self, template):
92         '''add to the template the resources represented by this context'''
93         template.add_keypair(self.keypair_name)
94         template.add_security_group(self.secgroup_name)
95
96         for network in self.networks:
97             template.add_network(network.stack_name)
98             template.add_subnet(network.subnet_stack_name, network.stack_name,
99                                 network.subnet_cidr)
100
101             if network.router:
102                 template.add_router(network.router.stack_name,
103                                     network.router.external_gateway_info,
104                                     network.subnet_stack_name)
105                 template.add_router_interface(network.router.stack_if_name,
106                                               network.router.stack_name,
107                                               network.subnet_stack_name)
108
109         # create a list of servers sorted by increasing no of placement groups
110         list_of_servers = sorted(self.servers,
111                                  key=lambda s: len(s.placement_groups))
112
113         #
114         # add servers with scheduler hints derived from placement groups
115         #
116
117         # create list of servers with availability policy
118         availability_servers = []
119         for server in list_of_servers:
120             for pg in server.placement_groups:
121                 if pg.policy == "availability":
122                     availability_servers.append(server)
123                     break
124
125         # add servers with availability policy
126         added_servers = []
127         for server in availability_servers:
128             scheduler_hints = {}
129             for pg in server.placement_groups:
130                 update_scheduler_hints(scheduler_hints, added_servers, pg)
131             server.add_to_template(template, self.networks, scheduler_hints)
132             added_servers.append(server.stack_name)
133
134         # create list of servers with affinity policy
135         affinity_servers = []
136         for server in list_of_servers:
137             for pg in server.placement_groups:
138                 if pg.policy == "affinity":
139                     affinity_servers.append(server)
140                     break
141
142         # add servers with affinity policy
143         for server in affinity_servers:
144             if server.stack_name in added_servers:
145                 continue
146             scheduler_hints = {}
147             for pg in server.placement_groups:
148                 update_scheduler_hints(scheduler_hints, added_servers, pg)
149             server.add_to_template(template, self.networks, scheduler_hints)
150             added_servers.append(server.stack_name)
151
152         # add remaining servers with no placement group configured
153         for server in list_of_servers:
154             if len(server.placement_groups) == 0:
155                 server.add_to_template(template, self.networks, {})
156
157     def deploy(self):
158         '''deploys template into a stack using cloud'''
159         print "Deploying context '%s'" % self.name
160
161         heat_template = HeatTemplate(self.name, self.template_file,
162                                      self.heat_parameters)
163
164         if self.template_file is None:
165             self._add_resources_to_template(heat_template)
166
167         try:
168             self.stack = heat_template.create()
169         except KeyboardInterrupt:
170             sys.exit("\nStack create interrupted")
171         except RuntimeError as err:
172             sys.exit("error: failed to deploy stack: '%s'" % err.args)
173         except Exception as err:
174             sys.exit("error: failed to deploy stack: '%s'" % err)
175
176         # copy some vital stack output into server objects
177         for server in self.servers:
178             if len(server.ports) > 0:
179                 # TODO(hafe) can only handle one internal network for now
180                 port = server.ports.values()[0]
181                 server.private_ip = self.stack.outputs[port["stack_name"]]
182
183             if server.floating_ip:
184                 server.public_ip = \
185                     self.stack.outputs[server.floating_ip["stack_name"]]
186
187         print "Context '%s' deployed" % self.name
188
189     def undeploy(self):
190         '''undeploys stack from cloud'''
191         if self.stack:
192             print "Undeploying context '%s'" % self.name
193             self.stack.delete()
194             self.stack = None
195             print "Context '%s' undeployed" % self.name
196
197     def _get_server(self, attr_name):
198         '''lookup server object by name from context
199         attr_name: either a name for a server created by yardstick or a dict
200         with attribute name mapping when using external heat templates
201         '''
202         if type(attr_name) is dict:
203             cname = attr_name["name"].split(".")[1]
204             if cname != self.name:
205                 return None
206
207             public_ip = None
208             private_ip = None
209             if "public_ip_attr" in attr_name:
210                 public_ip = self.stack.outputs[attr_name["public_ip_attr"]]
211             if "private_ip_attr" in attr_name:
212                 private_ip = self.stack.outputs[
213                     attr_name["private_ip_attr"]]
214
215             # Create a dummy server instance for holding the *_ip attributes
216             server = Server(attr_name["name"].split(".")[0], self, {})
217             server.public_ip = public_ip
218             server.private_ip = private_ip
219             return server
220         else:
221             if attr_name not in self._server_map:
222                 return None
223             return self._server_map[attr_name]