Support using existing private key when using external heat template file

Currently, the private key is auto-generated from Yardstick.
This patch will allow user use their existing private key when
they use external heat template file.

JIRA: YARDSTICK-1447

Change-Id: I45a0ab4ac08e7ccedd770867ed43de92040b6a10
Signed-off-by: treyad <treyad@viosoft.com>

1 files changed, 43 insertions, 16 deletions

diff --git a/yardstick/benchmark/contexts/heat.py b/yardstick/benchmark/contexts/heat.py
index f4c48f4a5..403562c46 100644
--- a/yardstick/benchmark/contexts/heat.py
+++ b/yardstick/benchmark/contexts/heat.py
@@ -71,6 +71,7 @@ class HeatContext(Context):
         self.shade_client = None
         self.heat_timeout = None
         self.key_filename = None
+        self.yardstick_gen_key_file = True
         self.shade_client = None
         self.operator_client = None
         self.nodes = []
@@ -105,6 +106,14 @@ class HeatContext(Context):
 
         self.template_file = attrs.get("heat_template")
 
+        # try looking for external private key when using external heat template
+        if self.template_file is not None:
+            self.key_filename = attrs.get("key_filename", None)
+            if self.key_filename is not None:
+                # Disable key file generation if an external private key
+                # has been provided
+                self.yardstick_gen_key_file = False
+
         self.shade_client = openstack_utils.get_shade_client()
         self.operator_client = openstack_utils.get_shade_operator_client()
 
@@ -335,14 +344,16 @@ class HeatContext(Context):
         """deploys template into a stack using cloud"""
         LOG.info("Deploying context '%s' START", self.name)
 
-        self.key_filename = ''.join(
-            [consts.YARDSTICK_ROOT_PATH,
-             'yardstick/resources/files/yardstick_key-',
-             self.name])
+        # Check if there was no external private key provided
+        if self.key_filename is None:
+            self.key_filename = ''.join(
+                [consts.YARDSTICK_ROOT_PATH,
+                 'yardstick/resources/files/yardstick_key-',
+                 self.name])
         # Permissions may have changed since creation; this can be fixed. If we
         # overwrite the file, we lose future access to VMs using this key.
         # As long as the file exists, even if it is unreadable, keep it intact
-        if not os.path.exists(self.key_filename):
+        if self.yardstick_gen_key_file and not os.path.exists(self.key_filename):
             SSH.gen_keys(self.key_filename)
 
         heat_template = HeatTemplate(
@@ -442,12 +453,14 @@ class HeatContext(Context):
         }
 
     def _delete_key_file(self):
-        try:
-            utils.remove_file(self.key_filename)
-            utils.remove_file(self.key_filename + ".pub")
-        except OSError:
-            LOG.exception("There was an error removing the key file %s",
-                          self.key_filename)
+        # Only remove the key file if it has been generated by yardstick
+        if self.yardstick_gen_key_file:
+            try:
+                utils.remove_file(self.key_filename)
+                utils.remove_file(self.key_filename + ".pub")
+            except OSError:
+                LOG.exception("There was an error removing the key file %s",
+                              self.key_filename)
 
     def undeploy(self):
         """undeploys stack from cloud"""
@@ -505,11 +518,25 @@ class HeatContext(Context):
             if server is None:
                 return None
 
-        pkey = pkg_resources.resource_string(
-            'yardstick.resources',
-            h_join('files/yardstick_key', self.name)).decode('utf-8')
-        key_filename = pkg_resources.resource_filename('yardstick.resources',
-            h_join('files/yardstick_key', self.name))
+        # Get the pkey
+        if self.yardstick_gen_key_file:
+            pkey = pkg_resources.resource_string(
+                'yardstick.resources',
+                h_join('files/yardstick_key', self.name)).decode('utf-8')
+            key_filename = pkg_resources.resource_filename('yardstick.resources',
+                h_join('files/yardstick_key', self.name))
+        else:
+            # make sure the file exists before attempting to open it
+            if not os.path.exists(self.key_filename):
+                LOG.error("The key_filename provided %s does not exist!",
+                          self.key_filename)
+            else:
+                try:
+                    pkey = open(self.key_filename, 'r').read().decode('utf-8')
+                    key_filename = self.key_filename
+                except IOError:
+                    LOG.error("The key_filename provided (%s) is unreadable.",
+                              self.key_filename)
         result = {
             "user": server.context.user,
             "pkey": pkey,