1 ##############################################################################
2 # Copyright (c) 2016 Huawei Technologies Co.,Ltd 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 """ Handler for yardstick command 'plugin' """
18 import yardstick.ssh as ssh
20 from yardstick.common.utils import cliargs
21 from yardstick.common.task_template import TaskTemplate
23 LOG = logging.getLogger(__name__)
26 class PluginCommands(object):
29 Set of commands to manage plugins.
32 @cliargs("input_file", type=str, help="path to plugin configuration file",
34 def do_install(self, args):
35 '''Install a plugin.'''
37 total_start_time = time.time()
38 parser = PluginParser(args.input_file[0])
40 plugins, deployment = parser.parse_plugin()
41 plugin_name = plugins.get("name")
42 print("Installing plugin: %s" % plugin_name)
44 LOG.info("Executing _install_setup()")
45 self._install_setup(plugin_name, deployment)
47 LOG.info("Executing _run()")
48 self._run(plugin_name)
50 total_end_time = time.time()
51 LOG.info("total finished in %d secs",
52 total_end_time - total_start_time)
54 print("Done, exiting")
56 @cliargs("input_file", type=str, help="path to plugin configuration file",
58 def do_remove(self, args):
59 '''Remove a plugin.'''
61 total_start_time = time.time()
62 parser = PluginParser(args.input_file[0])
64 plugins, deployment = parser.parse_plugin()
65 plugin_name = plugins.get("name")
66 print("Removing plugin: %s" % plugin_name)
68 LOG.info("Executing _remove_setup()")
69 self._remove_setup(plugin_name, deployment)
71 LOG.info("Executing _run()")
72 self._run(plugin_name)
74 total_end_time = time.time()
75 LOG.info("total finished in %d secs",
76 total_end_time - total_start_time)
78 print("Done, exiting")
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)
86 deployment_user = deployment.get("user")
87 deployment_ssh_port = deployment.get("ssh_port", ssh.DEFAULT_PORT)
88 deployment_ip = deployment.get("ip", None)
89 deployment_password = deployment.get("password", None)
90 deployment_key_filename = deployment.get("key_filename",
93 if deployment_ip == "local":
94 installer_ip = os.environ.get("INSTALLER_IP", None)
96 if deployment_password is not None:
97 self._login_via_password(deployment_user, installer_ip,
101 self._login_via_key(self, deployment_user, installer_ip,
102 deployment_key_filename,
105 if deployment_password is not None:
106 self._login_via_password(deployment_user, deployment_ip,
110 self._login_via_key(self, deployment_user, deployment_ip,
111 deployment_key_filename,
113 # copy script to host
114 cmd = "cat > ~/%s.sh" % plugin_name
116 LOG.info("copying script to host: %s", cmd)
117 self.client.run(cmd, stdin=open(self.script, 'rb'))
119 def _remove_setup(self, plugin_name, deployment):
120 '''Deployment environment setup'''
121 target_script = plugin_name + ".bash"
122 self.script = pkg_resources.resource_filename(
123 'yardstick.resources', 'scripts/remove/' + target_script)
125 deployment_user = deployment.get("user")
126 deployment_ssh_port = deployment.get("ssh_port", ssh.DEFAULT_PORT)
127 deployment_ip = deployment.get("ip", None)
128 deployment_password = deployment.get("password", None)
129 deployment_key_filename = deployment.get("key_filename",
132 if deployment_ip == "local":
133 installer_ip = os.environ.get("INSTALLER_IP", None)
135 if deployment_password is not None:
136 self._login_via_password(deployment_user, installer_ip,
140 self._login_via_key(self, deployment_user, installer_ip,
141 deployment_key_filename,
144 if deployment_password is not None:
145 self._login_via_password(deployment_user, deployment_ip,
149 self._login_via_key(self, deployment_user, deployment_ip,
150 deployment_key_filename,
153 # copy script to host
154 cmd = "cat > ~/%s.sh" % plugin_name
156 LOG.info("copying script to host: %s", cmd)
157 self.client.run(cmd, stdin=open(self.script, 'rb'))
159 def _login_via_password(self, user, ip, password, ssh_port):
160 LOG.info("Log in via pw, user:%s, host:%s", user, ip)
161 self.client = ssh.SSH(user, ip, password=password, port=ssh_port)
162 self.client.wait(timeout=600)
164 def _login_via_key(self, user, ip, key_filename, ssh_port):
165 LOG.info("Log in via key, user:%s, host:%s", user, ip)
166 self.client = ssh.SSH(user, ip, key_filename=key_filename,
168 self.client.wait(timeout=600)
170 def _run(self, plugin_name):
171 '''Run installation script '''
172 cmd = "sudo bash %s" % plugin_name + ".sh"
174 LOG.info("Executing command: %s", cmd)
175 status, stdout, stderr = self.client.execute(cmd)
178 class PluginParser(object):
179 '''Parser for plugin configration files in yaml format'''
181 def __init__(self, path):
184 def parse_plugin(self):
185 '''parses the plugin file and return a plugins instance
186 and a deployment instance
189 print "Parsing plugin config:", self.path
193 with open(self.path) as f:
195 input_plugin = f.read()
196 rendered_plugin = TaskTemplate.render(input_plugin, **kw)
197 except Exception as e:
198 print(("Failed to render template:\n%(plugin)s\n%(err)s\n")
199 % {"plugin": input_plugin, "err": e})
201 print(("Input plugin is:\n%s\n") % rendered_plugin)
203 cfg = yaml.load(rendered_plugin)
204 except IOError as ioerror:
207 self._check_schema(cfg["schema"], "plugin")
209 return cfg["plugins"], cfg["deployment"]
211 def _check_schema(self, cfg_schema, schema_type):
212 '''Check if configration file is using the correct schema type'''
214 if cfg_schema != "yardstick:" + schema_type + ":0.1":
215 sys.exit("error: file %s has unknown schema %s" % (self.path,