# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
-from ssh import SSH
-from robot.api import logger
-from constants import Constants
+
import json
+from robot.api import logger
+
+from resources.libraries.python.ssh import SSH
+from resources.libraries.python.constants import Constants
+
+
__all__ = ['VatExecutor']
def cleanup_vat_json_output(json_output):
- """Return VAT json output cleaned from VAT clutter.
+ """Return VAT JSON output cleaned from VAT clutter.
+
+ Clean up VAT JSON output from clutter like vat# prompts and such.
- Clean up VAT json output from clutter like vat# prompts and such
- :param json_output: cluttered json output.
- :return: cleaned up output json string
+ :param json_output: Cluttered JSON output.
+ :return: Cleaned up output JSON string.
"""
retval = json_output
class VatExecutor(object):
-
def __init__(self):
self._stdout = None
self._stderr = None
def execute_script(self, vat_name, node, timeout=10, json_out=True):
"""Copy local_path script to node, execute it and return result.
- :param vat_name: name of the vat script file. Only the file name of
- the script is required, the resources path is prepended
- automatically.
- :param node: node to execute the VAT script on.
- :param timeout: seconds to allow the script to run.
- :param json_out: require json output.
+ :param vat_name: Name of the vat script file. Only the file name of
+ the script is required, the resources path is prepended automatically.
+ :param node: Node to execute the VAT script on.
+ :param timeout: Seconds to allow the script to run.
+ :param json_out: Require JSON output.
:return: (rc, stdout, stderr) tuple.
"""
# TODO: download vpp_api_test output file
# self._delete_files(node, remote_file_path, remote_file_out)
- def execute_script_json_out(self, vat_name, node, timeout=10,):
+ def execute_script_json_out(self, vat_name, node, timeout=10):
self.execute_script(vat_name, node, timeout, json_out=True)
self._stdout = cleanup_vat_json_output(self._stdout)
- def _delete_files(self, node, *files):
+ @staticmethod
+ def _delete_files(node, *files):
ssh = SSH()
ssh.connect(node)
files = " ".join([str(x) for x in files])
@staticmethod
def cmd_from_template(node, vat_template_file, **vat_args):
"""Execute VAT script on specified node. This method supports
- script templates with parameters
- :param node: node in topology on witch the scrtipt is executed
- :param vat_template_file: template file of VAT script
- :param vat_args: arguments to the template file
- :return: list of json objects returned by VAT
- """
- vat = VatTerminal(node)
- ret = vat.vat_terminal_exec_cmd_from_template(vat_template_file,
- **vat_args)
- vat.vat_terminal_close()
- return ret
+ script templates with parameters.
- @staticmethod
- def copy_config_to_remote(node, local_path, remote_path):
- # TODO: will be removed once v4 is merged to master.
- """Copies vat configuration file to node
-
- :param node: Remote node on which to copy the VAT configuration file
- :param local_path: path of the VAT script on local device that launches
- test cases.
- :param remote_path: path on remote node where to copy the VAT
- configuration script file
+ :param node: Node in topology on witch the script is executed.
+ :param vat_template_file: Template file of VAT script.
+ :param vat_args: Arguments to the template file.
+ :return: List of JSON objects returned by VAT.
"""
- ssh = SSH()
- ssh.connect(node)
- logger.trace("Removing old file {}".format(remote_path))
- ssh.exec_command_sudo("rm -f {}".format(remote_path))
- ssh.scp(local_path, remote_path)
+ with VatTerminal(node) as vat:
+ return vat.vat_terminal_exec_cmd_from_template(vat_template_file,
+ **vat_args)
class VatTerminal(object):
- """VAT interactive terminal
+ """VAT interactive terminal.
+
+ :param node: Node to open VAT terminal on.
+ :param json_param: Defines if outputs from VAT are in JSON format.
+ Default is True.
+ :type node: dict
+ :type json_param: bool
- :param node: Node to open VAT terminal on.
"""
__VAT_PROMPT = "vat# "
__LINUX_PROMPT = ":~$ "
- def __init__(self, node):
+ def __init__(self, node, json_param=True):
+ json_text = ' json' if json_param else ''
+ self.json = json_param
self._ssh = SSH()
self._ssh.connect(node)
self._tty = self._ssh.interactive_terminal_open()
self._ssh.interactive_terminal_exec_command(
self._tty,
- 'sudo -S {vat} json'.format(vat=Constants.VAT_BIN_NAME),
+ 'sudo -S {}{}'.format(Constants.VAT_BIN_NAME, json_text),
self.__VAT_PROMPT)
+ def __enter__(self):
+ return self
+
+ def __exit__(self, exc_type, exc_val, exc_tb):
+ self.vat_terminal_close()
+
def vat_terminal_exec_cmd(self, cmd):
"""Execute command on the opened VAT terminal.
- :param cmd: Command to be executed.
+ :param cmd: Command to be executed.
- :return: Command output in python representation of JSON format.
+ :return: Command output in python representation of JSON format or
+ None if not in JSON mode.
"""
- logger.debug("Executing command in VAT terminal: {}".format(cmd));
+ logger.debug("Executing command in VAT terminal: {}".format(cmd))
out = self._ssh.interactive_terminal_exec_command(self._tty,
cmd,
self.__VAT_PROMPT)
- logger.debug("VAT output: {}".format(out));
- json_out = json.loads(out)
- return json_out
+ logger.debug("VAT output: {}".format(out))
+ if self.json:
+ obj_start = out.find('{')
+ obj_end = out.rfind('}')
+ array_start = out.find('[')
+ array_end = out.rfind(']')
+
+ if -1 == obj_start and -1 == array_start:
+ raise RuntimeError("No JSON data.")
+
+ if obj_start < array_start or -1 == array_start:
+ start = obj_start
+ end = obj_end + 1
+ else:
+ start = array_start
+ end = array_end + 1
+ out = out[start:end]
+ json_out = json.loads(out)
+ return json_out
+ else:
+ return None
def vat_terminal_close(self):
"""Close VAT terminal."""
def vat_terminal_exec_cmd_from_template(self, vat_template_file, **args):
"""Execute VAT script from a file.
- :param vat_template_file: template file name of a VAT script
- :param args: dictionary of parameters for VAT script
- :return: list of json objects returned by VAT
+
+ :param vat_template_file: Template file name of a VAT script.
+ :param args: Dictionary of parameters for VAT script.
+ :return: List of JSON objects returned by VAT.
"""
file_path = '{}/{}'.format(Constants.RESOURCES_TPL_VAT,
vat_template_file)
Code Review / csit.git / blobdiff