8ad01c491bb00785bdc68efe8c0ec33f201107fd
[csit.git] / resources / libraries / python / IPUtil.py
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:
5 #
6 #     http://www.apache.org/licenses/LICENSE-2.0
7 #
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.
13
14 """Common IP utilities library."""
15
16 from resources.libraries.python.ssh import SSH
17 from resources.libraries.python.constants import Constants
18
19
20 class IPUtil(object):
21     """Common IP utilities"""
22
23     @staticmethod
24     def vpp_ip_probe(node, interface, addr):
25         """Run ip probe on VPP node.
26
27         :param node: VPP node.
28         :param interface: Interface name.
29         :param addr: IPv4/IPv6 address.
30         :type node: dict
31         :type interface: str
32         :type addr: str
33         """
34         ssh = SSH()
35         ssh.connect(node)
36
37         cmd = "{c}".format(c=Constants.VAT_BIN_NAME)
38         cmd_input = 'exec ip probe {dev} {ip}'.format(dev=interface, ip=addr)
39         (ret_code, _, _) = ssh.exec_command_sudo(cmd, cmd_input)
40         if int(ret_code) != 0:
41             raise Exception('VPP ip probe {dev} {ip} failed on {h}'.format(
42                 dev=interface, ip=addr, h=node['host']))