HA testcase containerized Compass support
[yardstick.git] / yardstick / benchmark / contexts / heat.py
index e584822..fed8fc3 100644 (file)
 # http://www.apache.org/licenses/LICENSE-2.0
 ##############################################################################
 
+from __future__ import absolute_import
+from __future__ import print_function
+
+import collections
+import logging
 import os
-import sys
+import uuid
+from collections import OrderedDict
+
+import ipaddress
+import paramiko
 import pkg_resources
 
 from yardstick.benchmark.contexts.base import Context
-from yardstick.benchmark.contexts.model import Server
-from yardstick.benchmark.contexts.model import PlacementGroup
 from yardstick.benchmark.contexts.model import Network
+from yardstick.benchmark.contexts.model import PlacementGroup, ServerGroup
+from yardstick.benchmark.contexts.model import Server
 from yardstick.benchmark.contexts.model import update_scheduler_hints
-from yardstick.orchestrator.heat import HeatTemplate
+from yardstick.orchestrator.heat import HeatTemplate, get_short_key_uuid
+from yardstick.common.constants import YARDSTICK_ROOT_PATH
+
+LOG = logging.getLogger(__name__)
+
+DEFAULT_HEAT_TIMEOUT = 3600
 
 
 class HeatContext(Context):
-    '''Class that represents a context in the logical model'''
+    """Class that represents a context in the logical model"""
 
     __context_type__ = "Heat"
 
     def __init__(self):
         self.name = None
         self.stack = None
-        self.networks = []
+        self.networks = OrderedDict()
         self.servers = []
         self.placement_groups = []
+        self.server_groups = []
         self.keypair_name = None
         self.secgroup_name = None
         self._server_map = {}
         self._image = None
         self._flavor = None
+        self.flavors = set()
         self._user = None
         self.template_file = None
         self.heat_parameters = None
-        super(self.__class__, self).__init__()
-
-    def init(self, attrs):
-        '''initializes itself from the supplied arguments'''
+        # generate an uuid to identify yardstick_key
+        # the first 8 digits of the uuid will be used
+        self.key_uuid = uuid.uuid4()
+        self.key_filename = ''.join(
+            [YARDSTICK_ROOT_PATH, 'yardstick/resources/files/yardstick_key-',
+             get_short_key_uuid(self.key_uuid)])
+        super(HeatContext, self).__init__()
+
+    def assign_external_network(self, networks):
+        sorted_networks = sorted(networks.items())
+        external_network = os.environ.get("EXTERNAL_NETWORK", "net04_ext")
+        have_external_network = [(name, net)
+                                 for name, net in sorted_networks if
+                                 net.get("external_network")]
+        # no external net defined, assign it to first network usig os.environ
+        if sorted_networks and not have_external_network:
+            sorted_networks[0][1]["external_network"] = external_network
+        return sorted_networks
+
+    def init(self, attrs):     # pragma: no cover
+        """initializes itself from the supplied arguments"""
         self.name = attrs["name"]
 
-        if "user" in attrs:
-            self._user = attrs["user"]
+        self._user = attrs.get("user")
 
-        if "heat_template" in attrs:
-            self.template_file = attrs["heat_template"]
-            self.heat_parameters = attrs.get("heat_parameters", None)
+        self.template_file = attrs.get("heat_template")
+        if self.template_file:
+            self.heat_parameters = attrs.get("heat_parameters")
             return
 
         self.keypair_name = self.name + "-key"
         self.secgroup_name = self.name + "-secgroup"
 
-        # Temporarily removing security group due to
-        # ssh problems with ODL scenarios.
-        scenario = os.environ.get('DEPLOY_SCENARIO', None)
-        if scenario and scenario.startswith('os-odl'):
-            print "INFO: ODL scenario - removing security group."
-            self.secgroup_name = None
+        self._image = attrs.get("image")
+
+        self._flavor = attrs.get("flavor")
 
-        if "image" in attrs:
-            self._image = attrs["image"]
+        self.heat_timeout = attrs.get("timeout", DEFAULT_HEAT_TIMEOUT)
 
-        if "flavor" in attrs:
-            self._flavor = attrs["flavor"]
+        self.placement_groups = [PlacementGroup(name, self, pgattrs["policy"])
+                                 for name, pgattrs in attrs.get(
+                                 "placement_groups", {}).items()]
 
-        if "placement_groups" in attrs:
-            for name, pgattrs in attrs["placement_groups"].items():
-                pg = PlacementGroup(name, self, pgattrs["policy"])
-                self.placement_groups.append(pg)
+        self.server_groups = [ServerGroup(name, self, sgattrs["policy"])
+                              for name, sgattrs in attrs.get(
+                              "server_groups", {}).items()]
 
-        for name, netattrs in attrs["networks"].items():
-            network = Network(name, self, netattrs)
-            self.networks.append(network)
+        # we have to do this first, because we are injecting external_network
+        # into the dict
+        sorted_networks = self.assign_external_network(attrs["networks"])
 
-        for name, serverattrs in attrs["servers"].items():
+        self.networks = OrderedDict(
+            (name, Network(name, self, netattrs)) for name, netattrs in
+            sorted_networks)
+
+        for name, serverattrs in sorted(attrs["servers"].items()):
             server = Server(name, self, serverattrs)
             self.servers.append(server)
             self._server_map[server.dn] = server
 
+        rsa_key = paramiko.RSAKey.generate(bits=2048, progress_func=None)
+        rsa_key.write_private_key_file(self.key_filename)
+        print("Writing %s ..." % self.key_filename)
+        with open(self.key_filename + ".pub", "w") as pubkey_file:
+            pubkey_file.write(
+                "%s %s\n" % (rsa_key.get_name(), rsa_key.get_base64()))
+        del rsa_key
+
     @property
     def image(self):
-        '''returns application's default image name'''
+        """returns application's default image name"""
         return self._image
 
     @property
     def flavor(self):
-        '''returns application's default flavor name'''
+        """returns application's default flavor name"""
         return self._flavor
 
     @property
     def user(self):
-        '''return login user name corresponding to image'''
+        """return login user name corresponding to image"""
         return self._user
 
     def _add_resources_to_template(self, template):
-        '''add to the template the resources represented by this context'''
-        template.add_keypair(self.keypair_name)
-        if self.secgroup_name:
-            template.add_security_group(self.secgroup_name)
-
-        for network in self.networks:
-            template.add_network(network.stack_name)
+        """add to the template the resources represented by this context"""
+
+        if self.flavor:
+            if isinstance(self.flavor, dict):
+                flavor = self.flavor.setdefault("name", self.name + "-flavor")
+                template.add_flavor(**self.flavor)
+                self.flavors.add(flavor)
+
+        template.add_keypair(self.keypair_name, self.key_uuid)
+        template.add_security_group(self.secgroup_name)
+
+        for network in self.networks.values():
+            template.add_network(network.stack_name,
+                                 network.physical_network,
+                                 network.provider,
+                                 network.segmentation_id)
             template.add_subnet(network.subnet_stack_name, network.stack_name,
                                 network.subnet_cidr)
 
@@ -132,6 +181,13 @@ class HeatContext(Context):
                     availability_servers.append(server)
                     break
 
+        for server in availability_servers:
+            if isinstance(server.flavor, dict):
+                try:
+                    self.flavors.add(server.flavor["name"])
+                except KeyError:
+                    self.flavors.add(server.stack_name + "-flavor")
+
         # add servers with availability policy
         added_servers = []
         for server in availability_servers:
@@ -141,24 +197,22 @@ class HeatContext(Context):
             # workround for openstack nova bug, check JIRA: YARDSTICK-200
             # for details
             if len(availability_servers) == 2:
-                if len(scheduler_hints["different_host"]) == 0:
+                if not scheduler_hints["different_host"]:
                     scheduler_hints.pop("different_host", None)
                     server.add_to_template(template,
-                                           self.networks,
+                                           list(self.networks.values()),
                                            scheduler_hints)
-                    added_servers.append(server.stack_name)
                 else:
                     scheduler_hints["different_host"] = \
                         scheduler_hints["different_host"][0]
                     server.add_to_template(template,
-                                           self.networks,
+                                           list(self.networks.values()),
                                            scheduler_hints)
-                    added_servers.append(server.stack_name)
             else:
                 server.add_to_template(template,
-                                       self.networks,
+                                       list(self.networks.values()),
                                        scheduler_hints)
-                added_servers.append(server.stack_name)
+            added_servers.append(server.stack_name)
 
         # create list of servers with affinity policy
         affinity_servers = []
@@ -175,17 +229,30 @@ class HeatContext(Context):
             scheduler_hints = {}
             for pg in server.placement_groups:
                 update_scheduler_hints(scheduler_hints, added_servers, pg)
-            server.add_to_template(template, self.networks, scheduler_hints)
+            server.add_to_template(template, list(self.networks.values()),
+                                   scheduler_hints)
             added_servers.append(server.stack_name)
 
+        # add server group
+        for sg in self.server_groups:
+            template.add_server_group(sg.name, sg.policy)
+
         # add remaining servers with no placement group configured
         for server in list_of_servers:
-            if len(server.placement_groups) == 0:
-                server.add_to_template(template, self.networks, {})
+            # TODO placement_group and server_group should combine
+            if not server.placement_groups:
+                scheduler_hints = {}
+                # affinity/anti-aff server group
+                sg = server.server_group
+                if sg:
+                    scheduler_hints["group"] = {'get_resource': sg.name}
+                server.add_to_template(template,
+                                       list(self.networks.values()),
+                                       scheduler_hints)
 
     def deploy(self):
-        '''deploys template into a stack using cloud'''
-        print "Deploying context '%s'" % self.name
+        """deploys template into a stack using cloud"""
+        print("Deploying context '%s'" % self.name)
 
         heat_template = HeatTemplate(self.name, self.template_file,
                                      self.heat_parameters)
@@ -194,44 +261,81 @@ class HeatContext(Context):
             self._add_resources_to_template(heat_template)
 
         try:
-            self.stack = heat_template.create()
+            self.stack = heat_template.create(block=True,
+                                              timeout=self.heat_timeout)
         except KeyboardInterrupt:
-            sys.exit("\nStack create interrupted")
-        except RuntimeError as err:
-            sys.exit("error: failed to deploy stack: '%s'" % err.args)
-        except Exception as err:
-            sys.exit("error: failed to deploy stack: '%s'" % err)
+            raise SystemExit("\nStack create interrupted")
+        except:
+            LOG.exception("stack failed")
+            raise
+        # let the other failures happend, we want stack trace
 
         # copy some vital stack output into server objects
         for server in self.servers:
-            if len(server.ports) > 0:
+            if server.ports:
                 # TODO(hafe) can only handle one internal network for now
-                port = server.ports.values()[0]
+                port = next(iter(server.ports.values()))
                 server.private_ip = self.stack.outputs[port["stack_name"]]
+                server.interfaces = {}
+                for network_name, port in server.ports.items():
+                    self.make_interface_dict(network_name, port['stack_name'],
+                                             server,
+                                             self.stack.outputs)
 
             if server.floating_ip:
                 server.public_ip = \
                     self.stack.outputs[server.floating_ip["stack_name"]]
 
-        print "Context '%s' deployed" % self.name
+        print("Context '%s' deployed" % self.name)
+
+    def make_interface_dict(self, network_name, stack_name, server, outputs):
+        server.interfaces[network_name] = {
+            "private_ip": outputs[stack_name],
+            "subnet_id": outputs[stack_name + "-subnet_id"],
+            "subnet_cidr": outputs[
+                "{}-{}-subnet-cidr".format(self.name, network_name)],
+            "netmask": str(ipaddress.ip_network(
+                outputs["{}-{}-subnet-cidr".format(self.name,
+                                                   network_name)]).netmask),
+            "gateway_ip": outputs[
+                "{}-{}-subnet-gateway_ip".format(self.name, network_name)],
+            "mac_address": outputs[stack_name + "-mac_address"],
+            "device_id": outputs[stack_name + "-device_id"],
+            "network_id": outputs[stack_name + "-network_id"],
+            "network_name": network_name,
+            # to match vnf_generic
+            "local_mac": outputs[stack_name + "-mac_address"],
+            "local_ip": outputs[stack_name],
+            "vld_id": self.networks[network_name].vld_id,
+        }
 
     def undeploy(self):
-        '''undeploys stack from cloud'''
+        """undeploys stack from cloud"""
         if self.stack:
-            print "Undeploying context '%s'" % self.name
+            print("Undeploying context '%s'" % self.name)
             self.stack.delete()
             self.stack = None
-            print "Context '%s' undeployed" % self.name
+            print("Context '%s' undeployed" % self.name)
+
+        if os.path.exists(self.key_filename):
+            try:
+                os.remove(self.key_filename)
+                os.remove(self.key_filename + ".pub")
+            except OSError:
+                LOG.exception("Key filename %s", self.key_filename)
+
+        super(HeatContext, self).undeploy()
 
     def _get_server(self, attr_name):
-        '''lookup server info by name from context
+        """lookup server info by name from context
         attr_name: either a name for a server created by yardstick or a dict
         with attribute name mapping when using external heat templates
-        '''
+        """
         key_filename = pkg_resources.resource_filename(
-            'yardstick.resources', 'files/yardstick_key')
+            'yardstick.resources',
+            'files/yardstick_key-' + get_short_key_uuid(self.key_uuid))
 
-        if type(attr_name) is dict:
+        if isinstance(attr_name, collections.Mapping):
             cname = attr_name["name"].split(".")[1]
             if cname != self.name:
                 return None
@@ -259,7 +363,8 @@ class HeatContext(Context):
         result = {
             "user": server.context.user,
             "key_filename": key_filename,
-            "private_ip": server.private_ip
+            "private_ip": server.private_ip,
+            "interfaces": server.interfaces,
         }
         # Target server may only have private_ip
         if server.public_ip: