summaryrefslogtreecommitdiffstats
path: root/src/vpp-api/vom/tap_interface.cpp
blob: d7f16f5c1325170e25a396daeafcaa6ab806a1c0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
/*
 * Copyright (c) 2017 Cisco and/or its affiliates.
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at:
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * 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.
 */

#include "vom/tap_interface.hpp"
#include "vom/tap_interface_cmds.hpp"

#include <vapi/vpe.api.vapi.hpp>

namespace VOM {
tap_interface::event_handler tap_interface::m_evh;

/**
 * Construct a new object matching the desried state
 */
tap_interface::tap_interface(const std::string& name,
                             admin_state_t state,
                             route::prefix_t prefix)
  : interface(name, type_t::TAP, state)
  , m_prefix(prefix)
  , m_l2_address(l2_address_t::ZERO)
{
}

tap_interface::tap_interface(const std::string& name,
                             admin_state_t state,
                             route::prefix_t prefix,
                             const l2_address_t& l2_address)
  : interface(name, type_t::TAP, state)
  , m_prefix(prefix)
  , m_l2_address(l2_address)
{
}

tap_interface::~tap_interface()
{
  sweep();
  release();
}

tap_interface::tap_interface(const tap_interface& o)
  : interface(o)
  , m_prefix(o.m_prefix)
  , m_l2_address(o.m_l2_address)
{
}

std::queue<cmd*>&
tap_interface::mk_create_cmd(std::queue<cmd*>& q)
{
  q.push(
    new tap_interface_cmds::create_cmd(m_hdl, name(), m_prefix, m_l2_address));

  return (q);
}

std::queue<cmd*>&
tap_interface::mk_delete_cmd(std::queue<cmd*>& q)
{
  q.push(new tap_interface_cmds::delete_cmd(m_hdl));

  return (q);
}

std::shared_ptr<tap_interface>
tap_interface::singular() const
{
  return std::dynamic_pointer_cast<tap_interface>(singular_i());
}

std::shared_ptr<interface>
tap_interface::singular_i() const
{
  return m_db.find_or_add(name(), *this);
}

void
tap_interface::event_handler::handle_populate(const client_db::key_t& key)
{
  /*
   * dump VPP current states
   */
  std::shared_ptr<tap_interface_cmds::dump_cmd> cmd =
    std::make_shared<tap_interface_cmds::dump_cmd>();

  HW::enqueue(cmd);
  HW::write();

  for (auto& record : *cmd) {
    auto& payload = record.get_payload();

    std::string name = reinterpret_cast<const char*>(payload.dev_name);

    tap_interface itf(name, interface::admin_state_t::UP,
                      route::prefix_t::ZERO);

    VOM_LOG(log_level_t::DEBUG) << "tap-dump: " << itf.to_string();

    /*
     * Write each of the discovered interfaces into the OM,
     * but disable the HW Command q whilst we do, so that no
     * commands are sent to VPP
     */
    OM::commit(key, itf);
  }
}

tap_interface::event_handler::event_handler()
{
  OM::register_listener(this);
  inspect::register_handler({ "tap" }, "tap_interfaces", this);
}

void
tap_interface::event_handler::handle_replay()
{
  // It will be replayed by interface handler
}

dependency_t
tap_interface::event_handler::order() const
{
  return (dependency_t::INTERFACE);
}

void
tap_interface::event_handler::show(std::ostream& os)
{
  // dumped by the interface handler
}

}; // namespace VOM

/*
 * fd.io coding-style-patch-verification: ON
 *
 * Local Variables:
 * eval: (c-set-style "mozilla")
 * End:
 */
span> Clean up VAT JSON output from clutter like vat# prompts and such. :param json_output: Cluttered JSON output. :param vat_name: Name of the VAT script. :type json_output: JSON :type vat_name: str :returns: Cleaned up output JSON string. :rtype: JSON """ retval = json_output clutter = ['vat#', 'dump_interface_table error: Misc'] if vat_name: remote_file_path = '{0}/{1}/{2}'.format(Constants.REMOTE_FW_DIR, Constants.RESOURCES_TPL_VAT, vat_name) clutter.append("{0}(2):".format(remote_file_path)) for garbage in clutter: retval = retval.replace(garbage, '') 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 """ import resources.libraries.python.DUTSetup as PidLib pid = PidLib.DUTSetup.get_vpp_pid(node) return pid class VatExecutor(object): """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("Cannot open SSH connection to execute VAT " "command(s) from vat script {name}" .format(name=vat_name)) if copy_on_execute: ssh.scp(vat_name, vat_name) remote_file_path = vat_name if history: with open(vat_name, 'r') as vat_file: for line in vat_file: PapiHistory.add_to_papi_history(node, line.replace('\n', ''), papi=False) else: remote_file_path = '{0}/{1}/{2}'.format(Constants.REMOTE_FW_DIR, Constants.RESOURCES_TPL_VAT, vat_name) cmd = "{vat_bin} {json} in {vat_path} script".format( vat_bin=Constants.VAT_BIN_NAME, json="json" if json_out is True else "", vat_path=remote_file_path) try: ret_code, stdout, stderr = ssh.exec_command_sudo(cmd=cmd, timeout=timeout) except SSHTimeout: logger.error("VAT script execution timeout: {0}".format(cmd)) raise except: raise RuntimeError("VAT script execution failed: {0}".format(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, 'w') 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("First execute the script!") if self._ret_code == 0: raise AssertionError( "VAT Script execution passed, but failure was expected: {cmd}" .format(cmd=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("First execute the script!") if self._ret_code != 0: raise AssertionError( "VAT Script execution failed, but success was expected: {cmd}" .format(cmd=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 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(object): """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 = ("vat# ", ) __LINUX_PROMPT = (":~# ", ":~$ ", "~]$ ", "~]# ") def __init__(self, node, json_param=True): json_text = ' json' if json_param else '' 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("Cannot open interactive terminal on node {0}". format(self._node)) for _ in range(3): try: self._ssh.interactive_terminal_exec_command( self._tty, 'sudo -S {0}{1}'.format(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("VPP running on node {0}". format(self._node['host'])) else: logger.error("More instances of VPP running on node {0}.". format(self._node['host'])) else: logger.error("VPP not running on node {0}.". format(self._node['host'])) raise RuntimeError("Failed to open VAT console on node {0}". format(self._node['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("Executing command in VAT terminal: {0}".format(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): raise RuntimeError("VPP running on node {0} but VAT command" " {1} execution failed.". format(self._node['host'], cmd)) else: raise RuntimeError("More instances of VPP running on node " "{0}. VAT command {1} execution failed.". format(self._node['host'], cmd)) raise RuntimeError("VPP not running on node {0}. VAT command " "{1} execution failed.". format(self._node['host'], cmd)) logger.debug("VAT output: {0}".format(out)) if self.json: obj_start = out.find('{') obj_end = out.rfind('}') array_start = out.find('[') array_end = out.rfind(']') if obj_start == -1 and array_start == -1: raise RuntimeError("VAT command {0}: no JSON data.".format(cmd)) 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 else: 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, 'quit', self.__LINUX_PROMPT) except Exception: vpp_pid = get_vpp_pid(self._node) if vpp_pid: if isinstance(vpp_pid, int): logger.trace("VPP running on node {0}.". format(self._node['host'])) else: logger.error("More instances of VPP running on node " "{0}.".format(self._node['host'])) else: logger.error("VPP not running on node {0}.". format(self._node['host'])) raise RuntimeError("Failed to close VAT console on node {0}". format(self._node['host'])) try: self._ssh.interactive_terminal_close(self._tty) except: raise RuntimeError("Cannot close interactive terminal on node {0}". format(self._node['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 = '{}/{}'.format(Constants.RESOURCES_TPL_VAT, vat_template_file) with open(file_path, 'r') as template_file: cmd_template = template_file.readlines() ret = [] for line_tmpl in cmd_template: vat_cmd = line_tmpl.format(**args) ret.append(self.vat_terminal_exec_cmd(vat_cmd.replace('\n', ''))) return ret