summaryrefslogtreecommitdiffstats
path: root/doxygen
AgeCommit message (Expand)AuthorFilesLines
2021-02-24docs: move pnat doc link into dev doc sectionDave Wallace1-1/+1
2021-02-01docs: fix up the markdownAndrew Yourtchenko2-0/+3
2020-12-16misc: Initial 21.06-rc0 commitv21.06-rc0Andrew Yourtchenko1-0/+3
2020-09-21build: remove opensuse build infraDave Wallace1-3/+0
2020-07-30docs: Add link to 20.05 test framework docsAndrew Yourtchenko1-0/+1
2020-04-23misc: Markdown cleanups for the 20.01 releaseAndrew Yourtchenko2-1/+5
2020-04-06misc: fix python sonarcloud BLOCKER level issuesPaul Vinciguerra1-0/+1
2020-03-10docs: doxygen fix siphon under python3Paul Vinciguerra1-3/+4
2019-11-15build: fix docs/doxygen targetsDave Wallace1-2/+5
2019-11-05docs: fix 'make doxygen' under python3Paul Vinciguerra13-74/+105
2019-08-07docs: Add link to 20.01 test framework docsAndrew Yourtchenko1-0/+1
2019-08-01docs: Small fixes and orderingNathan Skrzypczak2-1/+2
2019-07-03doxygen: improve .md file discoveryDave Barach1-0/+2
2019-06-18ipsec: ipsec-tun protectNeale Ranns1-1/+0
2019-05-28docs: Add VPP API language documentationOle Troan1-0/+1
2019-05-21docs: add quic subpage to user docsVratko Polak1-1/+2
2019-05-14rdma: update MAINTAINERS and add docBenoît Ganne1-0/+1
2019-05-01DOCS: Add link to 19.08 test framework docsDave Wallace1-0/+1
2019-05-01DOCS: Add link to 19.04 make test documentationDave Wallace1-0/+1
2019-04-19Doxygen cleanup.Dave Wallace2-0/+7
2019-02-06Update to doxygen documentation for release 19.01Andrew Yourtchenko1-0/+1
2018-11-22Add RFC5424 syslog protocol support (VPP-1139)Matus Fabian1-0/+1
2018-10-17Update to doxygen documentation for release 18.10Marco Varlese1-0/+2
2018-08-03API: Remove legacy vlibsocket code.Ole Troan1-1/+0
2018-04-30Add reference to 18.04 test framework documentationChris Luke1-1/+3
2018-04-04Doc updates prior to branchChris Luke2-5/+9
2018-02-02Add link to 18.01 test framework documentation.Dave Wallace1-0/+1
2018-01-30VPP-899: Run VPP under SELinuxBilly McFall2-1/+2
2018-01-24docs: Clean up TOCDave Wallace1-0/+2
2017-12-15apps: refactor uri and update build infraFlorin Coras1-1/+0
2017-11-03Add C++ files to DoxygenChris Luke1-1/+1
2017-09-28General documentation updatesChris Luke6-5/+23
2017-09-25Add binary API documentationDave Barach1-0/+1
2017-06-22NAT64: documentationMatus Fabian1-0/+1
2017-06-09Sample plugin: Add sample plugin documentationRay Kinsella2-2/+2
2017-05-30Flowprobe: Stateful flows and IPv6, L4 recordingOle Troan1-1/+1
2017-05-10doxygen: Fix some pathsChris Luke1-1/+3
2017-05-05First commit SR MPLSPablo Camarillo1-0/+1
2017-03-29Bugfixing and documentation for SRv6Pablo Camarillo2-9/+10
2017-02-22Add ref to test framework docs in doxygen output.Dave Wallace2-5/+8
2017-02-02Added support for openSUSEMarco Varlese1-1/+4
2017-01-11Remove vcgn pluginDamjan Marion1-2/+1
2017-01-10Revert "vppctl: bash completion for vppctl commands"Damjan Marion1-8/+17
2017-01-09vppctl: bash completion for vppctl commandsPadraig Connolly1-17/+8
2017-01-01Move java,lua api and remaining plugins to src/Damjan Marion1-4/+3
2016-12-28Repair Doxygen build infrastructureChris Luke2-11/+29
2016-11-28Add support for using documentation siphons in multiple waysChris Luke19-32/+199
2016-11-28dpdk: add ipsec cryptodev supportSergio Gonzalez Monroy1-0/+1
2016-10-27Per-packet IPFIX record generation pluginDave Barach1-0/+1
2016-10-04Minor tweaks to hqos docChris Luke1-3/+4
ass="sd"> :type vat_name: str :returns: Cleaned up output JSON string. :rtype: JSON """ retval = json_output clutter = [u"vat#", u"dump_interface_table error: Misc"] if vat_name: remote_file_path = f"{Constants.REMOTE_FW_DIR}/" \ f"{Constants.RESOURCES_TPL_VAT}/{vat_name}" clutter.append(f"{remote_file_path}(2):") for garbage in clutter: retval = retval.replace(garbage, u"") return retval def get_vpp_pid(node): """Get PID of running VPP process. :param node: DUT node. :type node: dict :returns: PID of VPP process / List of PIDs if more VPP processes are running on the DUT node. :rtype: int or list """ pid = PidLib.DUTSetup.get_pid(node, u"vpp") return pid class VatExecutor: """Contains methods for executing VAT commands on DUTs.""" def __init__(self): self._stdout = None self._stderr = None self._ret_code = None self._script_name = None def execute_script( self, vat_name, node, timeout=120, json_out=True, copy_on_execute=False, history=True): """Execute VAT script on remote node, and store the result. There is an option to copy script from local host to remote host before execution. Path is defined automatically. :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 copy_on_execute: If true, copy the file from local host to remote before executing. :param history: If true, add command to history. :type vat_name: str :type node: dict :type timeout: int :type json_out: bool :type copy_on_execute: bool :type history: bool :raises SSHException: If cannot open connection for VAT. :raises SSHTimeout: If VAT execution is timed out. :raises RuntimeError: If VAT script execution fails. """ ssh = SSH() try: ssh.connect(node) except: raise SSHException( f"Cannot open SSH connection to execute VAT command(s) " f"from vat script {vat_name}" ) if copy_on_execute: ssh.scp(vat_name, vat_name) remote_file_path = vat_name if history: with open(vat_name, u"rt") as vat_file: for line in vat_file: PapiHistory.add_to_papi_history( node, line.replace(u"\n", u""), papi=False ) else: remote_file_path = f"{Constants.REMOTE_FW_DIR}/" \ f"{Constants.RESOURCES_TPL_VAT}/{vat_name}" cmd = f"{Constants.VAT_BIN_NAME}" \ f"{u' json' if json_out is True else u''} " \ f"in {remote_file_path} script" try: ret_code, stdout, stderr = ssh.exec_command_sudo( cmd=cmd, timeout=timeout ) except SSHTimeout: logger.error(f"VAT script execution timeout: {cmd}") raise except Exception: raise RuntimeError(f"VAT script execution failed: {cmd}") self._ret_code = ret_code self._stdout = stdout self._stderr = stderr self._script_name = vat_name def write_and_execute_script( self, node, tmp_fn, commands, timeout=300, json_out=False): """Write VAT commands to the script, copy it to node and execute it. :param node: VPP node. :param tmp_fn: Path to temporary file script. :param commands: VAT command list. :param timeout: Seconds to allow the script to run. :param json_out: Require JSON output. :type node: dict :type tmp_fn: str :type commands: list :type timeout: int :type json_out: bool """ with open(tmp_fn, u"wt") as tmp_f: tmp_f.writelines(commands) self.execute_script( tmp_fn, node, timeout=timeout, json_out=json_out, copy_on_execute=True ) remove(tmp_fn) def execute_script_json_out(self, vat_name, node, timeout=120): """Pass all arguments to 'execute_script' method, then cleanup returned 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. :type vat_name: str :type node: dict :type timeout: int """ self.execute_script(vat_name, node, timeout, json_out=True) self._stdout = cleanup_vat_json_output(self._stdout, vat_name=vat_name) def script_should_have_failed(self): """Read return code from last executed script and raise exception if the script didn't fail.""" if self._ret_code is None: raise Exception(u"First execute the script!") if self._ret_code == 0: raise AssertionError( f"VAT Script execution passed, but failure was expected: " f"{self._script_name}" ) def script_should_have_passed(self): """Read return code from last executed script and raise exception if the script failed.""" if self._ret_code is None: raise Exception(u"First execute the script!") if self._ret_code != 0: raise AssertionError( f"VAT Script execution failed, but success was expected: " f"{self._script_name}" ) def get_script_stdout(self): """Returns value of stdout from last executed script.""" return self._stdout def get_script_stderr(self): """Returns value of stderr from last executed script.""" return self._stderr @staticmethod def cmd_from_template(node, vat_template_file, json_param=True, **vat_args): """Execute VAT script on specified node. This method supports script templates with parameters. :param node: Node in topology on witch the script is executed. :param vat_template_file: Template file of VAT script. :param json_param: Require JSON mode. :param vat_args: Arguments to the template file. :returns: List of JSON objects returned by VAT. """ with VatTerminal(node, json_param=json_param) as vat: return vat.vat_terminal_exec_cmd_from_template( vat_template_file, **vat_args ) class VatTerminal: """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 """ __VAT_PROMPT = (u"vat# ", ) __LINUX_PROMPT = (u":~# ", u":~$ ", u"~]$ ", u"~]# ") def __init__(self, node, json_param=True): json_text = u" json" if json_param else u"" self.json = json_param self._node = node self._ssh = SSH() self._ssh.connect(self._node) try: self._tty = self._ssh.interactive_terminal_open() except Exception: raise RuntimeError( f"Cannot open interactive terminal on node " f"{self._node[u'host']}" ) for _ in range(3): try: self._ssh.interactive_terminal_exec_command( self._tty, f"sudo -S {Constants.VAT_BIN_NAME}{json_text}", self.__VAT_PROMPT ) except Exception: continue else: break else: vpp_pid = get_vpp_pid(self._node) if vpp_pid: if isinstance(vpp_pid, int): logger.trace(f"VPP running on node {self._node[u'host']}") else: logger.error( f"More instances of VPP running " f"on node {self._node[u'host']}." ) else: logger.error(f"VPP not running on node {self._node[u'host']}.") raise RuntimeError( f"Failed to open VAT console on node {self._node[u'host']}" ) self._exec_failure = False self.vat_stdout = None 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. :returns: Command output in python representation of JSON format or None if not in JSON mode. """ PapiHistory.add_to_papi_history(self._node, cmd, papi=False) logger.debug(f"Executing command in VAT terminal: {cmd}") try: out = self._ssh.interactive_terminal_exec_command( self._tty, cmd, self.__VAT_PROMPT ) self.vat_stdout = out except Exception: self._exec_failure = True vpp_pid = get_vpp_pid(self._node) if vpp_pid: if isinstance(vpp_pid, int): msg = f"VPP running on node {self._node[u'host']} " \ f"but VAT command {cmd} execution failed." else: msg = f"More instances of VPP running on node " \ f"{self._node[u'host']}. VAT command {cmd} " \ f"execution failed." else: msg = f"VPP not running on node {self._node[u'host']}. " \ f"VAT command {cmd} execution failed." raise RuntimeError(msg) logger.debug(f"VAT output: {out}") if self.json: obj_start = out.find(u"{") obj_end = out.rfind(u"}") array_start = out.find(u"[") array_end = out.rfind(u"]") if obj_start == -1 and array_start == -1: raise RuntimeError(f"VAT command {cmd}: no JSON data.") if obj_start < array_start or array_start == -1: 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 return None def vat_terminal_close(self): """Close VAT terminal.""" # interactive terminal is dead, we only need to close session if not self._exec_failure: try: self._ssh.interactive_terminal_exec_command( self._tty, u"quit", self.__LINUX_PROMPT ) except Exception: vpp_pid = get_vpp_pid(self._node) if vpp_pid: if isinstance(vpp_pid, int): logger.trace( f"VPP running on node {self._node[u'host']}." ) else: logger.error( f"More instances of VPP running " f"on node {self._node[u'host']}." ) else: logger.error( f"VPP not running on node {self._node[u'host']}." ) raise RuntimeError( f"Failed to close VAT console " f"on node {self._node[u'host']}" ) try: self._ssh.interactive_terminal_close(self._tty) except Exception: raise RuntimeError( f"Cannot close interactive terminal " f"on node {self._node[u'host']}" ) 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. :returns: List of JSON objects returned by VAT. """ file_path = f"{Constants.RESOURCES_TPL_VAT}/{vat_template_file}" with open(file_path, u"rt") as template_file: cmd_template = template_file.readlines() ret = list() for line_tmpl in cmd_template: vat_cmd = line_tmpl.format(**args) ret.append(self.vat_terminal_exec_cmd(vat_cmd.replace(u"\n", u""))) return ret