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 """Interface util library"""
16 from time import time, sleep
17 from robot.api import logger
18 from resources.libraries.python.ssh import exec_cmd_no_error
19 from resources.libraries.python.topology import NodeType, Topology
20 from resources.libraries.python.VatExecutor import VatExecutor, VatTerminal
23 class InterfaceUtil(object):
24 """General utilities for managing interfaces"""
27 def set_interface_state(node, interface, state):
28 """Set interface state on a node.
30 Function can be used for DUTs as well as for TGs.
32 :param node: node where the interface is
33 :param interface: interface name
34 :param state: one of 'up' or 'down'
40 if node['type'] == NodeType.DUT:
46 raise ValueError('Unexpected interface state: {}'.format(state))
48 sw_if_index = Topology.get_interface_sw_index(node, interface)
49 VatExecutor.cmd_from_template(node, 'set_if_state.vat',
50 sw_if_index=sw_if_index, state=state)
52 elif node['type'] == NodeType.TG:
53 cmd = 'ip link set {} {}'.format(interface, state)
54 exec_cmd_no_error(node, cmd, sudo=True)
56 raise Exception('Unknown NodeType: "{}"'.format(node['type']))
59 def vpp_node_interfaces_ready_wait(node, timeout=10):
60 """Wait until all interfaces with admin-up are in link-up state.
62 :param node: Node to wait on.
63 :param timeout: Waiting timeout in seconds (optional, default 10s)
66 :raises: RuntimeError if the timeout period value has elapsed.
69 with VatTerminal(node) as vat:
73 out = vat.vat_terminal_exec_cmd('sw_interface_dump')
74 if time() - start > timeout:
76 if interface.get('admin_up_down') == 1:
77 if interface.get('link_up_down') != 1:
78 logger.debug('{0} link-down'.format(
79 interface.get('interface_name')))
80 raise RuntimeError('timeout, not up {0}'.format(not_ready))
83 if interface.get('admin_up_down') == 1:
84 if interface.get('link_up_down') != 1:
85 not_ready.append(interface.get('interface_name'))
89 logger.debug('Interfaces still in link-down state: {0}, '
90 'waiting...'.format(not_ready))
94 def vpp_nodes_interfaces_ready_wait(nodes, timeout=10):
95 """Wait until all interfaces with admin-up are in link-up state for
98 :param nodes: List of nodes to wait on.
99 :param timeout: Seconds to wait per node for all interfaces to come up.
102 :raises: RuntimeError if the timeout period value has elapsed.
105 InterfaceUtil.vpp_node_interfaces_ready_wait(node, timeout)
108 def all_vpp_interfaces_ready_wait(nodes, timeout=10):
109 """Wait until all interfaces with admin-up are in link-up state for all
110 nodes in the topology.
112 :param nodes: Nodes in the topology.
113 :param timeout: Seconds to wait per node for all interfaces to come up.
116 :raises: RuntimeError if the timeout period value has elapsed.
118 for node in nodes.values():
119 if node['type'] == NodeType.DUT:
120 InterfaceUtil.vpp_node_interfaces_ready_wait(node, timeout)