1 # Copyright (c) 2016 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."""
18 from robot.api import logger
20 from resources.libraries.python.ssh import SSH
21 from resources.libraries.python.constants import Constants
22 from resources.libraries.python.VatHistory import VatHistory
25 __all__ = ['VatExecutor']
28 def cleanup_vat_json_output(json_output):
29 """Return VAT JSON output cleaned from VAT clutter.
31 Clean up VAT JSON output from clutter like vat# prompts and such.
33 :param json_output: Cluttered JSON output.
34 :returns: Cleaned up output JSON string.
38 clutter = ['vat#', 'dump_interface_table error: Misc']
39 for garbage in clutter:
40 retval = retval.replace(garbage, '')
44 class VatExecutor(object):
45 """Contains methods for executing VAT commands on DUTs."""
51 def execute_script(self, vat_name, node, timeout=10, json_out=True):
52 """Copy local_path script to node, execute it and return result.
54 :param vat_name: Name of the vat script file. Only the file name of
55 the script is required, the resources path is prepended automatically.
56 :param node: Node to execute the VAT script on.
57 :param timeout: Seconds to allow the script to run.
58 :param json_out: Require JSON output.
59 :return: (rc, stdout, stderr) tuple.
65 remote_file_path = '{0}/{1}/{2}'.format(Constants.REMOTE_FW_DIR,
66 Constants.RESOURCES_TPL_VAT,
68 # TODO this overwrites the output if the vat script has been used twice
69 # remote_file_out = remote_file_path + ".out"
71 cmd = "sudo -S {vat} {json} < {input}".format(
72 vat=Constants.VAT_BIN_NAME,
73 json="json" if json_out is True else "",
74 input=remote_file_path)
75 (ret_code, stdout, stderr) = ssh.exec_command(cmd, timeout)
76 self._ret_code = ret_code
80 logger.trace("Command '{0}' returned {1}'".format(cmd, self._ret_code))
81 logger.trace("stdout: '{0}'".format(self._stdout))
82 logger.trace("stderr: '{0}'".format(self._stderr))
84 # TODO: download vpp_api_test output file
85 # self._delete_files(node, remote_file_path, remote_file_out)
87 def execute_script_json_out(self, vat_name, node, timeout=10):
88 """Pass all arguments to 'execute_script' method, then cleanup returned
90 self.execute_script(vat_name, node, timeout, json_out=True)
91 self._stdout = cleanup_vat_json_output(self._stdout)
94 def _delete_files(node, *files):
95 """Use SSH to delete the specified files on node.
97 :param node: Node in topology.
98 :param files: Files to delete.
100 :type files: iterable
105 files = " ".join([str(x) for x in files])
106 ssh.exec_command("rm {0}".format(files))
108 def script_should_have_failed(self):
109 """Read return code from last executed script and raise exception if the
110 script didn't fail."""
111 if self._ret_code is None:
112 raise Exception("First execute the script!")
113 if self._ret_code == 0:
114 raise AssertionError(
115 "Script execution passed, but failure was expected")
117 def script_should_have_passed(self):
118 """Read return code from last executed script and raise exception if the
120 if self._ret_code is None:
121 raise Exception("First execute the script!")
122 if self._ret_code != 0:
123 raise AssertionError(
124 "Script execution failed, but success was expected")
126 def get_script_stdout(self):
127 """Returns value of stdout from last executed script."""
130 def get_script_stderr(self):
131 """Returns value of stderr from last executed script."""
135 def cmd_from_template(node, vat_template_file, **vat_args):
136 """Execute VAT script on specified node. This method supports
137 script templates with parameters.
139 :param node: Node in topology on witch the script is executed.
140 :param vat_template_file: Template file of VAT script.
141 :param vat_args: Arguments to the template file.
142 :return: List of JSON objects returned by VAT.
144 with VatTerminal(node) as vat:
145 return vat.vat_terminal_exec_cmd_from_template(vat_template_file,
149 class VatTerminal(object):
150 """VAT interactive terminal.
152 :param node: Node to open VAT terminal on.
153 :param json_param: Defines if outputs from VAT are in JSON format.
156 :type json_param: bool
160 __VAT_PROMPT = ("vat# ", )
161 __LINUX_PROMPT = (":~$ ", "~]$ ")
163 def __init__(self, node, json_param=True):
164 json_text = ' json' if json_param else ''
165 self.json = json_param
168 self._ssh.connect(self._node)
169 self._tty = self._ssh.interactive_terminal_open()
170 self._ssh.interactive_terminal_exec_command(
172 'sudo -S {}{}'.format(Constants.VAT_BIN_NAME, json_text),
174 self._exec_failure = False
179 def __exit__(self, exc_type, exc_val, exc_tb):
180 self.vat_terminal_close()
182 def vat_terminal_exec_cmd(self, cmd):
183 """Execute command on the opened VAT terminal.
185 :param cmd: Command to be executed.
187 :return: Command output in python representation of JSON format or
188 None if not in JSON mode.
190 VatHistory.add_to_vat_history(self._node, cmd)
191 logger.debug("Executing command in VAT terminal: {}".format(cmd))
193 out = self._ssh.interactive_terminal_exec_command(self._tty, cmd,
196 self._exec_failure = True
199 logger.debug("VAT output: {}".format(out))
201 obj_start = out.find('{')
202 obj_end = out.rfind('}')
203 array_start = out.find('[')
204 array_end = out.rfind(']')
206 if obj_start == -1 and array_start == -1:
207 raise RuntimeError("VAT: no JSON data.")
209 if obj_start < array_start or array_start == -1:
216 json_out = json.loads(out)
221 def vat_terminal_close(self):
222 """Close VAT terminal."""
223 # interactive terminal is dead, we only need to close session
224 if not self._exec_failure:
225 self._ssh.interactive_terminal_exec_command(self._tty,
228 self._ssh.interactive_terminal_close(self._tty)
230 def vat_terminal_exec_cmd_from_template(self, vat_template_file, **args):
231 """Execute VAT script from a file.
233 :param vat_template_file: Template file name of a VAT script.
234 :param args: Dictionary of parameters for VAT script.
235 :return: List of JSON objects returned by VAT.
237 file_path = '{}/{}'.format(Constants.RESOURCES_TPL_VAT,
239 with open(file_path, 'r') as template_file:
240 cmd_template = template_file.readlines()
242 for line_tmpl in cmd_template:
243 vat_cmd = line_tmpl.format(**args)
244 ret.append(self.vat_terminal_exec_cmd(vat_cmd.replace('\n', '')))