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 """Defines nodes and topology structure."""
16 from resources.libraries.python.parsers.JsonParser import JsonParser
17 from resources.libraries.python.VatExecutor import VatExecutor
18 from resources.libraries.python.ssh import SSH
19 from resources.libraries.python.InterfaceSetup import InterfaceSetup
20 from robot.api import logger
21 from robot.libraries.BuiltIn import BuiltIn
22 from robot.api.deco import keyword
25 __all__ = ["DICT__nodes", 'Topology']
28 def load_topo_from_yaml():
29 """Load topology from file defined in "${TOPOLOGY_PATH}" variable
31 :return: nodes from loaded topology
33 topo_path = BuiltIn().get_variable_value("${TOPOLOGY_PATH}")
35 with open(topo_path) as work_file:
36 return load(work_file.read())['nodes']
39 class NodeType(object):
40 """Defines node types used in topology dictionaries"""
41 # Device Under Test (this node has VPP running on it)
43 # Traffic Generator (this node has traffic generator on it)
47 class NodeSubTypeTG(object):
48 #T-Rex traffic generator
55 DICT__nodes = load_topo_from_yaml()
58 class Topology(object):
59 """Topology data manipulation and extraction methods
61 Defines methods used for manipulation and extraction of data from
66 def get_node_by_hostname(nodes, hostname):
67 """Get node from nodes of the topology by hostname.
69 :param nodes: Nodes of the test topology.
70 :param hostname: Host name.
73 :return: Node dictionary or None if not found.
75 for node in nodes.values():
76 if node['host'] == hostname:
83 """Get list of links(networks) in the topology.
85 :param nodes: Nodes of the test topology.
87 :return: Links in the topology.
92 for node in nodes.values():
93 for interface in node['interfaces'].values():
94 link = interface.get('link')
102 def _get_interface_by_key_value(node, key, value):
103 """Return node interface name according to key and value
105 :param node: :param node: the node dictionary
106 :param key: key by which to select the interface.
107 :param value: value that should be found using the key.
111 interfaces = node['interfaces']
113 for interface in interfaces.values():
114 k_val = interface.get(key)
115 if k_val is not None:
117 retval = interface['name']
121 def get_interface_by_link_name(self, node, link_name):
122 """Return interface name of link on node.
124 This method returns the interface name asociated with a given link
126 :param link_name: name of the link that a interface is connected to.
127 :param node: the node topology dictionary
128 :return: interface name of the interface connected to the given link
131 return self._get_interface_by_key_value(node, "link", link_name)
133 def get_interfaces_by_link_names(self, node, link_names):
134 """Return dictionary of dicitonaries {"interfaceN", interface name}.
136 This method returns the interface names asociated with given links
138 The resulting dictionary can be then used to with VatConfigGenerator
139 to generate a VAT script with proper interface names.
140 :param link_names: list of names of the link that a interface is
142 :param node: the node topology directory
143 :return: dictionary of interface names that are connected to the given
148 interface_key_tpl = "interface{}"
150 for link_name in link_names:
151 interface_name = self.get_interface_by_link_name(node, link_name)
152 interface_key = interface_key_tpl.format(str(interface_number))
153 retval[interface_key] = interface_name
154 interface_number += 1
157 def get_interface_by_sw_index(self, node, sw_index):
158 """Return interface name of link on node.
160 This method returns the interface name asociated with a software index
161 assigned to the interface by vpp for a given node.
162 :param sw_index: sw_index of the link that a interface is connected to.
163 :param node: the node topology dictionary
164 :return: interface name of the interface connected to the given link
167 return self._get_interface_by_key_value(node, "vpp_sw_index", sw_index)
170 def convert_mac_to_number_list(mac_address):
171 """Convert mac address string to list of decimal numbers.
173 Converts a : separated mac address to decimal number list as used
174 in json interface dump.
175 :param mac_address: string mac address
176 :return: list representation of mac address
180 for num in mac_address.split(":"):
181 list_mac.append(int(num, 16))
184 def _extract_vpp_interface_by_mac(self, interfaces_list, mac_address):
185 """Return interface dictionary from interface_list by mac address.
187 Extracts interface dictionary from all of the interfaces in interfaces
188 list parsed from json according to mac_address of the interface
189 :param interfaces_list: dictionary of all interfaces parsed from json
190 :param mac_address: string mac address of interface we are looking for
191 :return: interface dictionary from json
195 list_mac_address = self.convert_mac_to_number_list(mac_address)
196 logger.trace(str(list_mac_address))
197 for interface in interfaces_list:
198 # TODO: create vat json integrity checking and move there
199 if "l2_address" not in interface:
201 "key l2_address not found in interface dict."
202 "Probably input list is not parsed from correct VAT "
204 if "l2_address_length" not in interface:
206 "key l2_address_length not found in interface "
207 "dict. Probably input list is not parsed from correct "
209 mac_from_json = interface["l2_address"][:6]
210 if mac_from_json == list_mac_address:
211 if interface["l2_address_length"] != 6:
212 raise ValueError("l2_address_length value is not 6.")
213 interface_dict = interface
215 return interface_dict
217 def vpp_interface_name_from_json_by_mac(self, json_data, mac_address):
218 """Return vpp interface name string from VAT interface dump json output
220 Extracts the name given to an interface by VPP.
221 These interface names differ from what you would see if you
222 used the ipconfig or similar command.
223 Required json data can be obtained by calling :
224 VatExecutor.execute_script_json_out("dump_interfaces.vat", node)
225 :param json_data: string json data from sw_interface_dump VAT command
226 :param mac_address: string containing mac address of interface
227 whose vpp name we wish to discover.
228 :return: string vpp interface name
231 interfaces_list = JsonParser().parse_data(json_data)
232 # TODO: checking if json data is parsed correctly
233 interface_dict = self._extract_vpp_interface_by_mac(interfaces_list,
235 interface_name = interface_dict["interface_name"]
236 return interface_name
238 def _update_node_interface_data_from_json(self, node, interface_dump_json):
239 """Update node vpp data in node__DICT from json interface dump.
241 This method updates vpp interface names and sw indexexs according to
242 interface mac addresses found in interface_dump_json
243 :param node: node dictionary
244 :param interface_dump_json: json output from dump_interface_list VAT
248 interface_list = JsonParser().parse_data(interface_dump_json)
249 for ifc in node['interfaces'].values():
250 if 'link' not in ifc:
252 if_mac = ifc['mac_address']
253 interface_dict = self._extract_vpp_interface_by_mac(interface_list,
255 if not interface_dict:
256 raise Exception('Interface {0} not found by MAC {1}'.
258 ifc['name'] = interface_dict["interface_name"]
259 ifc['vpp_sw_index'] = interface_dict["sw_if_index"]
261 def update_vpp_interface_data_on_node(self, node):
262 """Update vpp generated interface data for a given node in DICT__nodes
264 Updates interface names, software index numbers and any other details
265 generated specifically by vpp that are unknown before testcase run.
266 :param node: Node selected from DICT__nodes
269 vat_executor = VatExecutor()
270 vat_executor.execute_script_json_out("dump_interfaces.vat", node)
271 interface_dump_json = vat_executor.get_script_stdout()
272 self._update_node_interface_data_from_json(node,
276 def update_tg_interface_data_on_node(node):
277 """Update interface name for TG/linux node in DICT__nodes
279 :param node: Node selected from DICT__nodes.
283 # for dev in `ls /sys/class/net/`;
284 > do echo "\"`cat /sys/class/net/$dev/address`\": \"$dev\""; done
285 "52:54:00:9f:82:63": "eth0"
286 "52:54:00:77:ae:a9": "eth1"
287 "52:54:00:e1:8a:0f": "eth2"
288 "00:00:00:00:00:00": "lo"
290 .. todo:: parse lshw -json instead
292 # First setup interface driver specified in yaml file
293 InterfaceSetup.tg_set_interfaces_default_driver(node)
295 # Get interface names
299 cmd = 'for dev in `ls /sys/class/net/`; do echo "\\"`cat ' \
300 '/sys/class/net/$dev/address`\\": \\"$dev\\""; done;'
302 (ret_code, stdout, _) = ssh.exec_command(cmd)
303 if int(ret_code) != 0:
304 raise Exception('Get interface name and MAC failed')
305 tmp = "{" + stdout.rstrip().replace('\n', ',') + "}"
306 interfaces = JsonParser().parse_data(tmp)
307 for if_k, if_v in node['interfaces'].items():
310 name = interfaces.get(if_v['mac_address'])
315 # Set udev rules for interfaces
316 InterfaceSetup.tg_set_interfaces_udev_rules(node)
318 def update_all_interface_data_on_all_nodes(self, nodes):
319 """Update interface names on all nodes in DICT__nodes
321 :param nodes: Nodes in the topology.
324 This method updates the topology dictionary by querying interface lists
325 of all nodes mentioned in the topology dictionary.
326 It does this by dumping interface list to json output from all devices
327 using vpp_api_test, and pairing known information from topology
328 (mac address/pci address of interface) to state from VPP.
329 For TG/linux nodes add interface name only.
332 for node_data in nodes.values():
333 if node_data['type'] == NodeType.DUT:
334 self.update_vpp_interface_data_on_node(node_data)
335 elif node_data['type'] == NodeType.TG:
336 self.update_tg_interface_data_on_node(node_data)
339 def get_interface_sw_index(node, interface):
340 """Get VPP sw_index for the interface.
342 :param node: Node to get interface sw_index on.
343 :param interface: Interface name.
346 :return: Return sw_index or None if not found.
348 for port in node['interfaces'].values():
349 port_name = port.get('name')
350 if port_name is None:
352 if port_name == interface:
353 return port.get('vpp_sw_index')
358 def get_interface_mac_by_port_key(node, port_key):
359 """Get MAC address for the interface based on port key.
361 :param node: Node to get interface mac on.
362 :param port_key: Dictionary key name of interface.
365 :return: Return MAC or None if not found.
367 for port_name, port_data in node['interfaces'].iteritems():
368 if port_name == port_key:
369 return port_data['mac_address']
374 def get_interface_mac(node, interface):
375 """Get MAC address for the interface.
377 :param node: Node to get interface sw_index on.
378 :param interface: Interface name.
381 :return: Return MAC or None if not found.
383 for port in node['interfaces'].values():
384 port_name = port.get('name')
385 if port_name is None:
387 if port_name == interface:
388 return port.get('mac_address')
393 def get_adjacent_node_and_interface_by_key(nodes_info, node, port_key):
394 """Get node and interface adjacent to specified interface
397 :param nodes_info: Dictionary containing information on all nodes
399 :param node: Node that contains specified interface.
400 :param port_key: Interface port key.
401 :type nodes_info: dict
404 :return: Return (node, interface info) tuple or None if not found.
408 # get link name where the interface belongs to
409 for port_name, port_data in node['interfaces'].iteritems():
410 if port_name == 'mgmt':
412 if port_name == port_key:
413 link_name = port_data['link']
416 if link_name is None:
420 for node_data in nodes_info.values():
422 if node_data['host'] == node['host']:
424 for interface, interface_data \
425 in node_data['interfaces'].iteritems():
426 if 'link' not in interface_data:
428 if interface_data['link'] == link_name:
429 return node_data, node_data['interfaces'][interface]
432 def get_adjacent_node_and_interface(nodes_info, node, interface_name):
433 """Get node and interface adjacent to specified interface
436 :param nodes_info: Dictionary containing information on all nodes
438 :param node: Node that contains specified interface.
439 :param interface_name: Interface name.
440 :type nodes_info: dict
442 :type interface_name: str
443 :return: Return (node, interface info) tuple or None if not found.
447 # get link name where the interface belongs to
448 for port_name, port_data in node['interfaces'].iteritems():
449 if port_name == 'mgmt':
451 if port_data['name'] == interface_name:
452 link_name = port_data['link']
455 if link_name is None:
459 for node_data in nodes_info.values():
461 if node_data['host'] == node['host']:
463 for interface, interface_data \
464 in node_data['interfaces'].iteritems():
465 if 'link' not in interface_data:
467 if interface_data['link'] == link_name:
468 return node_data, node_data['interfaces'][interface]
471 def get_interface_pci_addr(node, interface):
472 """Get interface PCI address.
474 :param node: Node to get interface PCI address on.
475 :param interface: Interface name.
478 :return: Return PCI address or None if not found.
480 for port in node['interfaces'].values():
481 if interface == port.get('name'):
482 return port.get('pci_address')
486 def get_interface_driver(node, interface):
487 """Get interface driver.
489 :param node: Node to get interface driver on.
490 :param interface: Interface name.
493 :return: Return interface driver or None if not found.
495 for port in node['interfaces'].values():
496 if interface == port.get('name'):
497 return port.get('driver')
501 def get_node_link_mac(node, link_name):
502 """Return interface mac address by link name
504 :param node: Node to get interface sw_index on
505 :param link_name: link name
507 :type link_name: string
508 :return: mac address string
510 for port in node['interfaces'].values():
511 if port.get('link') == link_name:
512 return port.get('mac_address')
516 def _get_node_active_link_names(node):
517 """Return list of link names that are other than mgmt links
519 :param node: node topology dictionary
520 :return: list of strings that represent link names occupied by the node
522 interfaces = node['interfaces']
524 for interface in interfaces.values():
525 if 'link' in interface:
526 link_names.append(interface['link'])
527 if len(link_names) == 0:
531 @keyword('Get active links connecting "${node1}" and "${node2}"')
532 def get_active_connecting_links(self, node1, node2):
533 """Return list of link names that connect together node1 and node2
535 :param node1: node topology dictionary
536 :param node2: node topology dictionary
537 :return: list of strings that represent connecting link names
540 logger.trace("node1: {}".format(str(node1)))
541 logger.trace("node2: {}".format(str(node2)))
542 node1_links = self._get_node_active_link_names(node1)
543 node2_links = self._get_node_active_link_names(node2)
544 connecting_links = list(set(node1_links).intersection(node2_links))
546 return connecting_links
548 @keyword('Get first active connecting link between node "${node1}" and '
550 def get_first_active_connecting_link(self, node1, node2):
553 :param node1: Connected node
555 :param node2: Connected node
557 :return: name of link connecting the two nodes together
558 :raises: RuntimeError
561 connecting_links = self.get_active_connecting_links(node1, node2)
562 if len(connecting_links) == 0:
563 raise RuntimeError("No links connecting the nodes were found")
565 return connecting_links[0]
567 @keyword('Get egress interfaces on "${node1}" for link with "${node2}"')
568 def get_egress_interfaces_for_nodes(self, node1, node2):
569 """Get egress interfaces on node1 for link with node2.
571 :param node1: First node, node to get egress interface on.
572 :param node2: Second node.
575 :return: Egress interfaces.
579 links = self.get_active_connecting_links(node1, node2)
581 raise RuntimeError('No link between nodes')
582 for interface in node1['interfaces'].values():
583 link = interface.get('link')
588 name = interface.get('name')
591 interfaces.append(name)
594 @keyword('Get first egress interface on "${node1}" for link with '
596 def get_first_egress_interface_for_nodes(self, node1, node2):
597 """Get first egress interface on node1 for link with node2.
599 :param node1: First node, node to get egress interface on.
600 :param node2: Second node.
603 :return: Egress interface.
606 interfaces = self.get_egress_interfaces_for_nodes(node1, node2)
608 raise RuntimeError('No egress interface for nodes')
611 @keyword('Get link data useful in circular topology test from tg "${tgen}"'
612 ' dut1 "${dut1}" dut2 "${dut2}"')
613 def get_links_dict_from_nodes(self, tgen, dut1, dut2):
614 """Return link combinations used in tests in circular topology.
616 For the time being it returns links from the Node path:
618 :param tgen: traffic generator node data
619 :param dut1: DUT1 node data
620 :param dut2: DUT2 node data
624 :return: dictionary of possible link combinations
625 the naming convention until changed to something more general is
627 DUT1_DUT2_LINK: link name between DUT! and DUT2
628 DUT1_TG_LINK: link name between DUT1 and TG
629 DUT2_TG_LINK: link name between DUT2 and TG
630 TG_TRAFFIC_LINKS: list of link names that generated traffic is sent
632 DUT1_BD_LINKS: list of link names that will be connected by the bridge
634 DUT2_BD_LINKS: list of link names that will be connected by the bridge
637 # TODO: replace with generic function.
638 dut1_dut2_link = self.get_first_active_connecting_link(dut1, dut2)
639 dut1_tg_link = self.get_first_active_connecting_link(dut1, tgen)
640 dut2_tg_link = self.get_first_active_connecting_link(dut2, tgen)
641 tg_traffic_links = [dut1_tg_link, dut2_tg_link]
642 dut1_bd_links = [dut1_dut2_link, dut1_tg_link]
643 dut2_bd_links = [dut1_dut2_link, dut2_tg_link]
644 topology_links = {'DUT1_DUT2_LINK': dut1_dut2_link,
645 'DUT1_TG_LINK': dut1_tg_link,
646 'DUT2_TG_LINK': dut2_tg_link,
647 'TG_TRAFFIC_LINKS': tg_traffic_links,
648 'DUT1_BD_LINKS': dut1_bd_links,
649 'DUT2_BD_LINKS': dut2_bd_links}
650 return topology_links
653 def is_tg_node(node):
654 """Find out whether the node is TG
656 :param node: node to examine
657 :return: True if node is type of TG; False otherwise
659 return node['type'] == NodeType.TG
662 def get_node_hostname(node):
663 """Return host (hostname/ip address) of the node.
665 :param node: Node created from topology.
667 :return: host as 'str' type