yardstick/cmd/commands/plugin.py

   1 ##############################################################################
   2 # Copyright (c) 2016 Huawei Technologies Co.,Ltd 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 """ Handler for yardstick command 'plugin' """
  11
  12 import os
  13 import sys
  14 import yaml
  15 import time
  16 import logging
  17 import pkg_resources
  18 import yardstick.ssh as ssh
  19
  20 from yardstick.common.utils import cliargs
  21 from yardstick.common.task_template import TaskTemplate
  22
  23 LOG = logging.getLogger(__name__)
  24
  25
  26 class PluginCommands(object):
  27     '''Plugin commands.
  28
  29        Set of commands to manage plugins.
  30     '''
  31
  32     @cliargs("input_file", type=str, help="path to plugin configuration file",
  33              nargs=1)
  34     def do_install(self, args):
  35         '''Install a plugin.'''
  36
  37         total_start_time = time.time()
  38         parser = PluginParser(args.input_file[0])
  39
  40         plugins, deployment = parser.parse_plugin()
  41         plugin_name = plugins.get("name")
  42         print("Installing plugin: %s" % plugin_name)
  43
  44         LOG.info("Executing _install_setup()")
  45         self._install_setup(plugin_name, deployment)
  46
  47         LOG.info("Executing _run()")
  48         self._run(plugin_name)
  49
  50         total_end_time = time.time()
  51         LOG.info("total finished in %d secs",
  52                  total_end_time - total_start_time)
  53
  54         print("Done, exiting")
  55
  56     @cliargs("input_file", type=str, help="path to plugin configuration file",
  57              nargs=1)
  58     def do_remove(self, args):
  59         '''Remove a plugin.'''
  60
  61         total_start_time = time.time()
  62         parser = PluginParser(args.input_file[0])
  63
  64         plugins, deployment = parser.parse_plugin()
  65         plugin_name = plugins.get("name")
  66         print("Removing plugin: %s" % plugin_name)
  67
  68         LOG.info("Executing _remove_setup()")
  69         self._remove_setup(plugin_name, deployment)
  70
  71         LOG.info("Executing _run()")
  72         self._run(plugin_name)
  73
  74         total_end_time = time.time()
  75         LOG.info("total finished in %d secs",
  76                  total_end_time - total_start_time)
  77
  78         print("Done, exiting")
  79
  80     def _install_setup(self, plugin_name, deployment):
  81         '''Deployment environment setup'''
  82         target_script = plugin_name + ".bash"
  83         self.script = pkg_resources.resource_filename(
  84             'yardstick.resources', 'scripts/install/' + target_script)
  85
  86         deployment_user = deployment.get("user")
  87         deployment_ip = deployment.get("ip")
  88         deployment_password = deployment.get("password")
  89
  90         if deployment_ip == "local":
  91             installer_ip = os.environ.get("INSTALLER_IP", None)
  92
  93             LOG.info("user:%s, host:%s", deployment_user, installer_ip)
  94             self.client = ssh.SSH(deployment_user, installer_ip,
  95                                   password=deployment_password)
  96             self.client.wait(timeout=600)
  97         else:
  98             LOG.info("user:%s, host:%s", deployment_user, deployment_ip)
  99             self.client = ssh.SSH(deployment_user, deployment_ip,
 100                                   password=deployment_password)
 101             self.client.wait(timeout=600)
 102
 103         # copy script to host
 104         cmd = "cat > ~/%s.sh" % plugin_name
 105
 106         LOG.info("copying script to host: %s", cmd)
 107         self.client.run(cmd, stdin=open(self.script, 'rb'))
 108
 109     def _remove_setup(self, plugin_name, deployment):
 110         '''Deployment environment setup'''
 111         target_script = plugin_name + ".bash"
 112         self.script = pkg_resources.resource_filename(
 113             'yardstick.resources', 'scripts/remove/' + target_script)
 114
 115         deployment_user = deployment.get("user")
 116         deployment_ip = deployment.get("ip")
 117         deployment_password = deployment.get("password")
 118
 119         if deployment_ip == "local":
 120             installer_ip = os.environ.get("INSTALLER_IP", None)
 121
 122             LOG.info("user:%s, host:%s", deployment_user, installer_ip)
 123             self.client = ssh.SSH(deployment_user, installer_ip,
 124                                   password=deployment_password)
 125             self.client.wait(timeout=600)
 126         else:
 127             LOG.info("user:%s, host:%s", deployment_user, deployment_ip)
 128             self.client = ssh.SSH(deployment_user, deployment_ip,
 129                                   password=deployment_password)
 130             self.client.wait(timeout=600)
 131
 132         # copy script to host
 133         cmd = "cat > ~/%s.sh" % plugin_name
 134
 135         LOG.info("copying script to host: %s", cmd)
 136         self.client.run(cmd, stdin=open(self.script, 'rb'))
 137
 138     def _run(self, plugin_name):
 139         '''Run installation script '''
 140         cmd = "sudo bash %s" % plugin_name + ".sh"
 141
 142         LOG.info("Executing command: %s", cmd)
 143         status, stdout, stderr = self.client.execute(cmd)
 144
 145
 146 class PluginParser(object):
 147     '''Parser for plugin configration files in yaml format'''
 148     def __init__(self, path):
 149         self.path = path
 150
 151     def parse_plugin(self):
 152         '''parses the plugin file and return a plugins instance
 153            and a deployment instance
 154         '''
 155
 156         print "Parsing plugin config:", self.path
 157
 158         try:
 159             kw = {}
 160             with open(self.path) as f:
 161                 try:
 162                     input_plugin = f.read()
 163                     rendered_plugin = TaskTemplate.render(input_plugin, **kw)
 164                 except Exception as e:
 165                     print(("Failed to render template:\n%(plugin)s\n%(err)s\n")
 166                           % {"plugin": input_plugin, "err": e})
 167                     raise e
 168                 print(("Input plugin is:\n%s\n") % rendered_plugin)
 169
 170                 cfg = yaml.load(rendered_plugin)
 171         except IOError as ioerror:
 172             sys.exit(ioerror)
 173
 174         self._check_schema(cfg["schema"], "plugin")
 175
 176         return cfg["plugins"], cfg["deployment"]
 177
 178     def _check_schema(self, cfg_schema, schema_type):
 179         '''Check if configration file is using the correct schema type'''
 180
 181         if cfg_schema != "yardstick:" + schema_type + ":0.1":
 182             sys.exit("error: file %s has unknown schema %s" % (self.path,
 183                                                                cfg_schema))