60e10a34e4c8d1e20467a75314196025bf01b951
[csit.git] / resources / libraries / python / IPv6Setup.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 """Library to set up IPv6 in topology."""
15
16 from robot.api import logger
17 from ipaddress import IPv6Network
18
19 from resources.libraries.python.ssh import SSH
20 from resources.libraries.python.topology import NodeType, Topology
21 from resources.libraries.python.constants import Constants
22 from resources.libraries.python.VatExecutor import VatTerminal, VatExecutor
23
24
25 class IPv6Networks(object):
26     """IPv6 network iterator.
27
28     :param networks: List of the available IPv6 networks.
29     :type networks: list
30     """
31     def __init__(self, networks):
32         self._networks = list()
33         for network in networks:
34             net = IPv6Network(unicode(network))
35             self._networks.append(net)
36         num = len(self._networks)
37         if num == 0:
38             raise Exception('No IPv6 networks')
39
40     def next_network(self):
41         """Get the next element of the iterator.
42
43         :return: IPv6 network.
44         :rtype: IPv6Network object
45         :raises: StopIteration if there is no more elements.
46         """
47         if len(self._networks):
48             return self._networks.pop()
49         else:
50             raise StopIteration()
51
52
53 class IPv6Setup(object):
54     """IPv6 setup in topology."""
55
56     def __init__(self):
57         pass
58
59     def nodes_set_ipv6_addresses(self, nodes, nodes_addr):
60         """Set IPv6 addresses on all VPP nodes in topology.
61
62         :param nodes: Nodes of the test topology.
63         :param nodes_addr: Available nodes IPv6 addresses.
64         :type nodes: dict
65         :type nodes_addr: dict
66         :returns: Affected interfaces as list of (node, interface) tuples.
67         :rtype: list
68         """
69         interfaces = []
70
71         for net in nodes_addr.values():
72             for port in net['ports'].values():
73                 host = port.get('node')
74                 if host is None:
75                     continue
76                 topo = Topology()
77                 node = topo.get_node_by_hostname(nodes, host)
78                 if node is None:
79                     continue
80                 if node['type'] == NodeType.DUT:
81                     port_key = topo.get_interface_by_name(node, port['if'])
82                     self.vpp_set_if_ipv6_addr(node, port_key, port['addr'],
83                                               net['prefix'])
84
85                     interfaces.append((node, port['if']))
86         return interfaces
87
88     def nodes_clear_ipv6_addresses(self, nodes, nodes_addr):
89         """Remove IPv6 addresses from all VPP nodes in topology.
90
91         :param nodes: Nodes of the test topology.
92         :param nodes_addr: Available nodes IPv6 addresses.
93         :type nodes: dict
94         :type nodes_addr: dict
95         """
96         for net in nodes_addr.values():
97             for port in net['ports'].values():
98                 host = port.get('node')
99                 if host is None:
100                     continue
101                 topo = Topology()
102                 node = topo.get_node_by_hostname(nodes, host)
103                 if node is None:
104                     continue
105                 if node['type'] == NodeType.DUT:
106                     self.vpp_del_if_ipv6_addr(node, port['if'], port['addr'],
107                                               net['prefix'])
108
109     @staticmethod
110     def linux_set_if_ipv6_addr(node, interface, addr, prefix):
111         """Set IPv6 address on linux host.
112
113         :param node: Linux node.
114         :param interface: Node interface.
115         :param addr: IPv6 address.
116         :param prefix: IPv6 address prefix.
117         :type node: dict
118         :type interface: str
119         :type addr: str
120         :type prefix: str
121         """
122         ssh = SSH()
123         ssh.connect(node)
124
125         cmd = "ifconfig {dev} inet6 add {ip}/{p} up".format(dev=interface,
126                                                             ip=addr, p=prefix)
127         (ret_code, _, _) = ssh.exec_command_sudo(cmd)
128         if int(ret_code) != 0:
129             raise Exception('TG ifconfig failed')
130
131     @staticmethod
132     def linux_del_if_ipv6_addr(node, interface, addr, prefix):
133         """Delete IPv6 address on linux host.
134
135         :param node: Linux node.
136         :param interface: Node interface.
137         :param addr: IPv6 address.
138         :param prefix: IPv6 address prefix.
139         :type node: dict
140         :type interface: str
141         :type addr: str
142         :type prefix: str
143         """
144         ssh = SSH()
145         ssh.connect(node)
146
147         cmd = "ifconfig {dev} inet6 del {ip}/{p}".format(dev=interface,
148                                                          ip=addr,
149                                                          p=prefix)
150         (ret_code, _, _) = ssh.exec_command_sudo(cmd)
151         if int(ret_code) != 0:
152             raise Exception('TG ifconfig failed')
153
154         cmd = "ifconfig {dev} down".format(dev=interface)
155         (ret_code, _, _) = ssh.exec_command_sudo(cmd)
156         if int(ret_code) != 0:
157             raise Exception('TG ifconfig failed')
158
159     @staticmethod
160     def vpp_set_if_ipv6_addr(node, iface_key, addr, prefix):
161         """Set IPv6 address on VPP.
162
163         :param node: VPP node.
164         :param iface_key: Node interface key.
165         :param addr: IPv6 address.
166         :param prefix: IPv6 address prefix.
167         :type node: dict
168         :type iface_key: str
169         :type addr: str
170         :type prefix: str
171         """
172         sw_if_index = Topology.get_interface_sw_index(node, iface_key)
173         with VatTerminal(node) as vat:
174             vat.vat_terminal_exec_cmd_from_template('add_ip_address.vat',
175                                                     sw_if_index=sw_if_index,
176                                                     address=addr,
177                                                     prefix_length=prefix)
178             vat.vat_terminal_exec_cmd_from_template('set_if_state.vat',
179                                                     sw_if_index=sw_if_index,
180                                                     state='admin-up')
181
182         ssh = SSH()
183         ssh.connect(node)
184         cmd_input = 'exec show int'
185         (ret_code, stdout, stderr) = ssh.exec_command_sudo(
186             Constants.VAT_BIN_NAME, cmd_input)
187         logger.debug('ret: {0}'.format(ret_code))
188         logger.debug('stdout: {0}'.format(stdout))
189         logger.debug('stderr: {0}'.format(stderr))
190
191     @staticmethod
192     def vpp_del_if_ipv6_addr(node, interface, addr, prefix):
193         """Delete IPv6 address on VPP.
194
195         :param node: VPP node.
196         :param interface: Node interface.
197         :param addr: IPv6 address.
198         :param prefix: IPv6 address prefix.
199         :type node: dict
200         :type interface: str
201         :type addr: str
202         :type prefix: str
203         """
204         sw_if_index = Topology.get_interface_sw_index(node, interface)
205         with VatTerminal(node) as vat:
206             vat.vat_terminal_exec_cmd_from_template('del_ip_address.vat',
207                                                     sw_if_index=sw_if_index,
208                                                     address=addr,
209                                                     prefix_length=prefix)
210             vat.vat_terminal_exec_cmd_from_template('set_if_state.vat',
211                                                     sw_if_index=sw_if_index,
212                                                     state='admin-down')
213
214     @staticmethod
215     def vpp_ra_suppress_link_layer(node, interface):
216         """Suppress ICMPv6 router advertisement message for link scope address.
217
218         :param node: VPP node.
219         :param interface: Interface name.
220         :type node: dict
221         :type interface: str
222         """
223         sw_if_index = Topology.get_interface_sw_index(node, interface)
224         VatExecutor.cmd_from_template(node,
225                                       'sw_interface_ip6nd_ra_config.vat',
226                                       sw_if_id=sw_if_index,
227                                       param='surpress')
228
229     @staticmethod
230     def vpp_ra_send_after_interval(node, interface, interval=2):
231         """Setup vpp router advertisement(RA) in such way it sends RA packet
232         after and every interval value.
233
234         :param node: VPP node.
235         :param interface: Interface name.
236         :param interval: Interval for RA resend
237         :type node: dict
238         :type interface: str
239         :type interval: int
240         """
241         sw_if_index = Topology.get_interface_sw_index(node, interface)
242         VatExecutor.cmd_from_template(node,
243                                       'sw_interface_ip6nd_ra_config.vat',
244                                       sw_if_id=sw_if_index,
245                                       param='interval {0}'.format(interval))
246
247     def vpp_all_ra_suppress_link_layer(self, nodes):
248         """Suppress ICMPv6 router advertisement message for link scope address
249         on all VPP nodes in the topology.
250
251         :param nodes: Nodes of the test topology.
252         :type nodes: dict
253         """
254         for node in nodes.values():
255             if node['type'] == NodeType.TG:
256                 continue
257             for port_k in node['interfaces'].keys():
258                 self.vpp_ra_suppress_link_layer(node, port_k)
259
260     @staticmethod
261     def get_link_address(link, nodes_addr):
262         """Get link IPv6 address.
263
264         :param link: Link name.
265         :param nodes_addr: Available nodes IPv6 addresses.
266         :type link: str
267         :type nodes_addr: dict
268         :returns: Link IPv6 address.
269         :rtype: str
270         """
271         net = nodes_addr.get(link)
272         if net is None:
273             raise ValueError('Link "{0}" address not found'.format(link))
274         return net.get('net_addr')
275
276     @staticmethod
277     def get_link_prefix(link, nodes_addr):
278         """Get link IPv6 address prefix.
279
280         :param link: Link name.
281         :param nodes_addr: Available nodes IPv6 addresses.
282         :type link: str
283         :type nodes_addr: dict
284         :returns: Link IPv6 address prefix.
285         :rtype: int
286         """
287         net = nodes_addr.get(link)
288         if net is None:
289             raise ValueError('Link "{0}" address not found'.format(link))
290         return net.get('prefix')

©2016 FD.io a Linux Foundation Collaborative Project. All Rights Reserved.
Linux Foundation is a registered trademark of The Linux Foundation. Linux is a registered trademark of Linus Torvalds.
Please see our privacy policy and terms of use.