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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
|
# Copyright (c) 2018 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.
"""Implements IPv4 RobotFramework keywords"""
from robot.api import logger as log
from robot.api.deco import keyword
from resources.libraries.python.topology import Topology
from resources.libraries.python.IPv4Setup import get_node
from resources.libraries.python.VatExecutor import VatTerminal
from resources.libraries.python.ssh import exec_cmd
class IPv4Util(object):
"""Implements keywords for IPv4 tests."""
@staticmethod
@keyword('From node "${node}" interface "${port}" ARP-ping '
'IPv4 address "${ip_address}"')
def arp_ping(node, interface, ip_address):
"""Send an ARP ping from the specified node.
:param node: Node in topology.
:param ip_address: Destination IP address for the ARP packet.
:param interface: Name of an interface to send the ARP packet from.
:type node: dict
:type ip_address: str
:type interface: str
"""
log.debug('From node {} interface {} ARP-ping IPv4 address {}'.
format(Topology.get_node_hostname(node),
interface, ip_address))
get_node(node).arp_ping(ip_address, interface)
@staticmethod
def set_interface_address(node, interface, address, prefix_length):
"""See IPv4Node.set_ip for more information.
:param node: Node where IP address should be set to.
:param interface: Interface name.
:param address: IP address.
:param prefix_length: Prefix length.
:type node: dict
:type interface: str
:type address: str
:type prefix_length: int
"""
log.debug('Node {} interface {} has IPv4 address {} with prefix '
'length {}'.format(Topology.get_node_hostname(node),
interface, address, prefix_length))
get_node(node).set_ip(interface, address, int(prefix_length))
@staticmethod
def set_route(node, network, prefix_length, interface, gateway):
"""See IPv4Node.set_route for more information.
:param node: Node where IP address should be set to.
:param network: IP network.
:param prefix_length: Prefix length.
:param interface: Interface name.
:param gateway: Gateway.
:type node: dict
:type network: str
:type prefix_length: int
:type interface: str
:type gateway: str
"""
log.debug('Node {} routes to network {} with prefix length {} '
'via {} interface {}'.format(Topology.get_node_hostname(node),
network, prefix_length,
gateway, interface))
get_node(node).set_route(network, int(prefix_length),
gateway, interface)
@staticmethod
@keyword('Get IPv4 address prefix of node "${node}" interface "${port}" '
'from "${nodes_addr}"')
def get_ip_addr_prefix_length(node, port, nodes_addr):
""" Get IPv4 address prefix for specified interface.
:param node: Node dictionary.
:param port: Interface name.
:param nodes_addr: Available nodes IPv4 addresses.
:type node: dict
:type port: str
:type nodes_addr: dict
:returns: IPv4 prefix length.
:rtype: int
"""
for net in nodes_addr.values():
for net_port in net['ports'].values():
if net_port['node'] == node['host'] and net_port['if'] == port:
return net['prefix']
raise Exception('Subnet not found for node {n} port {p}'.
format(n=node['host'], p=port))
@staticmethod
@keyword('Get IPv4 subnet of node "${node}" interface "${port}" from '
'"${nodes_addr}"')
def get_ip_addr_subnet(node, port, nodes_addr):
""" Get IPv4 subnet of specified interface.
:param node: Node dictionary.
:param port: Interface name.
:param nodes_addr: Available nodes IPv4 addresses.
:type node: dict
:type port: int
:type nodes_addr: dict
:returns: IPv4 subnet.
:rtype: str
"""
for net in nodes_addr.values():
for net_port in net['ports'].values():
if net_port['node'] == node['host'] and net_port['if'] == port:
return net['net_addr']
raise Exception('Subnet not found for node {n} port {p}'.
format(n=node['host'], p=port))
@staticmethod
@keyword('Flush IPv4 addresses "${port}" "${node}"')
def flush_ip_addresses(port, node):
"""See IPv4Node.flush_ip_addresses for more information.
:param port: FIXME
:param node: FIXME
:returns: FIXME
"""
get_node(node).flush_ip_addresses(port)
@staticmethod
def get_link_address(link, nodes_addr):
"""Get link IPv4 address.
:param link: Link name.
:param nodes_addr: Available nodes IPv4 addresses.
:type link: str
:type nodes_addr: dict
:returns: Link IPv4 address.
:rtype: str
"""
net = nodes_addr.get(link)
if net is None:
raise ValueError('Link "{0}" not found'.format(link))
return net.get('net_addr')
@staticmethod
def get_link_prefix(link, nodes_addr):
"""Get link IPv4 address prefix.
:param link: Link name.
:param nodes_addr: Available nodes IPv4 addresses.
:type link: str
:type nodes_addr: dict
:returns: Link IPv4 address prefix.
:rtype: int
"""
net = nodes_addr.get(link)
if net is None:
raise ValueError('Link "{0}" not found'.format(link))
return net.get('prefix')
@staticmethod
def send_ping_from_node_to_dst(node, destination, namespace=None,
ping_count=3, interface=None):
"""Send a ping from node to destination. Optionally, you can define a
namespace and interface from where to send a ping.
:param node: Node to start ping on.
:param destination: IPv4 address where to send ping.
:param namespace: Namespace to send ping from. Optional
:param ping_count: Number of pings to send. Default 3
:param interface: Interface from where to send ping. Optional
:type node: dict
:type destination: str
:type namespace: str
:type ping_count: int
:type interface: str
:raises RuntimeError: If no response for ping, raise error
"""
cmd = ''
if namespace is not None:
cmd = 'ip netns exec {0} ping -c{1} {2}'.format(
namespace, ping_count, destination)
elif interface is not None:
cmd = 'ping -I {0} -c{1} {2}'.format(
interface, ping_count, destination)
else:
cmd = 'ping -c{0} {1}'.format(ping_count, destination)
ret_code, _, _ = exec_cmd(node, cmd, sudo=True)
if ret_code != 0:
raise RuntimeError("Ping Not Successful")
@staticmethod
def set_linux_interface_arp(node, interface, ip_addr, mac, namespace=None):
"""Set arp on interface in linux.
:param node: Node where to execute command.
:param interface: Interface in namespace.
:param ip_addr: IP address for ARP entry.
:param mac: MAC address.
:param namespace: Execute command in namespace. Optional
:type node: dict
:type interface: str
:type ip_addr: str
:type mac: str
:type namespace: str
:raises RuntimeError: Could not set ARP properly.
"""
if namespace is not None:
cmd = 'ip netns exec {} arp -i {} -s {} {}'.format(
namespace, interface, ip_addr, mac)
else:
cmd = 'arp -i {} -s {} {}'.format(interface, ip_addr, mac)
ret_code, _, stderr = exec_cmd(node, cmd, sudo=True)
if ret_code != 0:
raise RuntimeError("Arp set not successful, reason:{}".
format(stderr))
@staticmethod
def vpp_show_ip_table(node):
"""Get IP FIB table data from a VPP node.
:param node: VPP node.
:type node: dict
"""
with VatTerminal(node, json_param=False) as vat:
vat.vat_terminal_exec_cmd_from_template("show_ip_fib.vat")
|
