1 # Copyright (c) 2018 Cisco and/or its affiliates.
2 # Licensed under the Apache License, Version 2.0 (the "License");
3 # you may not use this file except in compliance with the License.
4 # You may obtain a copy of the License at:
6 # http://www.apache.org/licenses/LICENSE-2.0
8 # Unless required by applicable law or agreed to in writing, software
9 # distributed under the License is distributed on an "AS IS" BASIS,
10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 # See the License for the specific language governing permissions and
12 # limitations under the License.
14 """VAT executor library."""
19 from paramiko.ssh_exception import SSHException
20 from robot.api import logger
22 from resources.libraries.python.ssh import SSH, SSHTimeout
23 from resources.libraries.python.constants import Constants
24 from resources.libraries.python.VatHistory import VatHistory
26 __all__ = ['VatExecutor']
29 def cleanup_vat_json_output(json_output, vat_name=None):
30 """Return VAT JSON output cleaned from VAT clutter.
32 Clean up VAT JSON output from clutter like vat# prompts and such.
34 :param json_output: Cluttered JSON output.
35 :param vat_name: Name of the VAT script.
36 :type json_output: JSON
38 :returns: Cleaned up output JSON string.
43 clutter = ['vat#', 'dump_interface_table error: Misc']
45 remote_file_path = '{0}/{1}/{2}'.format(Constants.REMOTE_FW_DIR,
46 Constants.RESOURCES_TPL_VAT,
48 clutter.append("{0}(2):".format(remote_file_path))
49 for garbage in clutter:
50 retval = retval.replace(garbage, '')
54 def get_vpp_pid(node):
55 """Get PID of running VPP process.
57 :param node: DUT node.
59 :returns: PID of VPP process / List of PIDs if more VPP processes are
60 running on the DUT node.
63 import resources.libraries.python.DUTSetup as PidLib
64 pid = PidLib.DUTSetup.get_vpp_pid(node)
68 class VatExecutor(object):
69 """Contains methods for executing VAT commands on DUTs."""
74 self._script_name = None
76 def execute_script(self, vat_name, node, timeout=120, json_out=True,
77 copy_on_execute=False):
78 """Execute VAT script on remote node, and store the result. There is an
79 option to copy script from local host to remote host before execution.
80 Path is defined automatically.
82 :param vat_name: Name of the vat script file. Only the file name of
83 the script is required, the resources path is prepended
85 :param node: Node to execute the VAT script on.
86 :param timeout: Seconds to allow the script to run.
87 :param json_out: Require JSON output.
88 :param copy_on_execute: If true, copy the file from local host to remote
94 :type copy_on_execute: bool
95 :raises SSHException: If cannot open connection for VAT.
96 :raises SSHTimeout: If VAT execution is timed out.
97 :raises RuntimeError: If VAT script execution fails.
103 raise SSHException("Cannot open SSH connection to execute VAT "
104 "command(s) from vat script {name}"
105 .format(name=vat_name))
108 ssh.scp(vat_name, vat_name)
109 remote_file_path = vat_name
110 with open(vat_name, 'r') as vat_file:
111 for line in vat_file:
112 VatHistory.add_to_vat_history(node, line.replace('\n', ''))
114 remote_file_path = '{0}/{1}/{2}'.format(Constants.REMOTE_FW_DIR,
115 Constants.RESOURCES_TPL_VAT,
118 cmd = "{vat_bin} {json} in {vat_path} script".format(
119 vat_bin=Constants.VAT_BIN_NAME,
120 json="json" if json_out is True else "",
121 vat_path=remote_file_path)
124 ret_code, stdout, stderr = ssh.exec_command_sudo(cmd=cmd,
127 logger.error("VAT script execution timeout: {0}".format(cmd))
130 raise RuntimeError("VAT script execution failed: {0}".format(cmd))
132 self._ret_code = ret_code
133 self._stdout = stdout
134 self._stderr = stderr
135 self._script_name = vat_name
137 def write_and_execute_script(self, node, tmp_fn, commands, timeout=300,
139 """Write VAT commands to the script, copy it to node and execute it.
141 :param node: VPP node.
142 :param tmp_fn: Path to temporary file script.
143 :param commands: VAT command list.
144 :param timeout: Seconds to allow the script to run.
145 :param json_out: Require JSON output.
152 with open(tmp_fn, 'w') as tmp_f:
153 tmp_f.writelines(commands)
155 self.execute_script(tmp_fn, node, timeout=timeout, json_out=json_out,
156 copy_on_execute=True)
159 def execute_script_json_out(self, vat_name, node, timeout=120):
160 """Pass all arguments to 'execute_script' method, then cleanup returned
163 :param vat_name: Name of the vat script file. Only the file name of
164 the script is required, the resources path is prepended
166 :param node: Node to execute the VAT script on.
167 :param timeout: Seconds to allow the script to run.
172 self.execute_script(vat_name, node, timeout, json_out=True)
173 self._stdout = cleanup_vat_json_output(self._stdout, vat_name=vat_name)
175 def script_should_have_failed(self):
176 """Read return code from last executed script and raise exception if the
177 script didn't fail."""
178 if self._ret_code is None:
179 raise Exception("First execute the script!")
180 if self._ret_code == 0:
181 raise AssertionError(
182 "VAT Script execution passed, but failure was expected: {cmd}"
183 .format(cmd=self._script_name))
185 def script_should_have_passed(self):
186 """Read return code from last executed script and raise exception if the
188 if self._ret_code is None:
189 raise Exception("First execute the script!")
190 if self._ret_code != 0:
191 raise AssertionError(
192 "VAT Script execution failed, but success was expected: {cmd}"
193 .format(cmd=self._script_name))
195 def get_script_stdout(self):
196 """Returns value of stdout from last executed script."""
199 def get_script_stderr(self):
200 """Returns value of stderr from last executed script."""
204 def cmd_from_template(node, vat_template_file, **vat_args):
205 """Execute VAT script on specified node. This method supports
206 script templates with parameters.
208 :param node: Node in topology on witch the script is executed.
209 :param vat_template_file: Template file of VAT script.
210 :param vat_args: Arguments to the template file.
211 :returns: List of JSON objects returned by VAT.
213 with VatTerminal(node) as vat:
214 return vat.vat_terminal_exec_cmd_from_template(vat_template_file,
218 class VatTerminal(object):
219 """VAT interactive terminal.
221 :param node: Node to open VAT terminal on.
222 :param json_param: Defines if outputs from VAT are in JSON format.
225 :type json_param: bool
229 __VAT_PROMPT = ("vat# ", )
230 __LINUX_PROMPT = (":~# ", ":~$ ", "~]$ ", "~]# ")
232 def __init__(self, node, json_param=True):
233 json_text = ' json' if json_param else ''
234 self.json = json_param
237 self._ssh.connect(self._node)
239 self._tty = self._ssh.interactive_terminal_open()
241 raise RuntimeError("Cannot open interactive terminal on node {0}".
246 self._ssh.interactive_terminal_exec_command(
248 'sudo -S {0}{1}'.format(Constants.VAT_BIN_NAME, json_text),
255 vpp_pid = get_vpp_pid(self._node)
257 if isinstance(vpp_pid, int):
258 logger.trace("VPP running on node {0}".
259 format(self._node['host']))
261 logger.error("More instances of VPP running on node {0}.".
262 format(self._node['host']))
264 logger.error("VPP not running on node {0}.".
265 format(self._node['host']))
266 raise RuntimeError("Failed to open VAT console on node {0}".
267 format(self._node['host']))
269 self._exec_failure = False
270 self.vat_stdout = None
275 def __exit__(self, exc_type, exc_val, exc_tb):
276 self.vat_terminal_close()
278 def vat_terminal_exec_cmd(self, cmd):
279 """Execute command on the opened VAT terminal.
281 :param cmd: Command to be executed.
283 :returns: Command output in python representation of JSON format or
284 None if not in JSON mode.
286 VatHistory.add_to_vat_history(self._node, cmd)
287 logger.debug("Executing command in VAT terminal: {0}".format(cmd))
289 out = self._ssh.interactive_terminal_exec_command(self._tty, cmd,
291 self.vat_stdout = out
293 self._exec_failure = True
294 vpp_pid = get_vpp_pid(self._node)
296 if isinstance(vpp_pid, int):
297 raise RuntimeError("VPP running on node {0} but VAT command"
298 " {1} execution failed.".
299 format(self._node['host'], cmd))
301 raise RuntimeError("More instances of VPP running on node "
302 "{0}. VAT command {1} execution failed.".
303 format(self._node['host'], cmd))
305 raise RuntimeError("VPP not running on node {0}. VAT command "
306 "{1} execution failed.".
307 format(self._node['host'], cmd))
309 logger.debug("VAT output: {0}".format(out))
311 obj_start = out.find('{')
312 obj_end = out.rfind('}')
313 array_start = out.find('[')
314 array_end = out.rfind(']')
316 if obj_start == -1 and array_start == -1:
317 raise RuntimeError("VAT command {0}: no JSON data.".format(cmd))
319 if obj_start < array_start or array_start == -1:
326 json_out = json.loads(out)
331 def vat_terminal_close(self):
332 """Close VAT terminal."""
333 # interactive terminal is dead, we only need to close session
334 if not self._exec_failure:
336 self._ssh.interactive_terminal_exec_command(self._tty,
340 vpp_pid = get_vpp_pid(self._node)
342 if isinstance(vpp_pid, int):
343 logger.trace("VPP running on node {0}.".
344 format(self._node['host']))
346 logger.error("More instances of VPP running on node "
347 "{0}.".format(self._node['host']))
349 logger.error("VPP not running on node {0}.".
350 format(self._node['host']))
351 raise RuntimeError("Failed to close VAT console on node {0}".
352 format(self._node['host']))
354 self._ssh.interactive_terminal_close(self._tty)
356 raise RuntimeError("Cannot close interactive terminal on node {0}".
357 format(self._node['host']))
359 def vat_terminal_exec_cmd_from_template(self, vat_template_file, **args):
360 """Execute VAT script from a file.
362 :param vat_template_file: Template file name of a VAT script.
363 :param args: Dictionary of parameters for VAT script.
364 :returns: List of JSON objects returned by VAT.
366 file_path = '{}/{}'.format(Constants.RESOURCES_TPL_VAT,
368 with open(file_path, 'r') as template_file:
369 cmd_template = template_file.readlines()
371 for line_tmpl in cmd_template:
372 vat_cmd = line_tmpl.format(**args)
373 ret.append(self.vat_terminal_exec_cmd(vat_cmd.replace('\n', '')))