fbe7b60183a11969dbc17e8b195db930be46bbe1
[csit.git] / resources / libraries / python / Routing.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 """Routing utilities library."""
15
16 from resources.libraries.python.VatExecutor import VatTerminal
17 from resources.libraries.python.topology import Topology
18 from resources.libraries.python.ssh import exec_cmd_no_error
19
20 class Routing(object):
21
22     """Routing utilities."""
23
24     @staticmethod
25     def vpp_route_add(node, network, prefix_len, gateway=None,
26                       interface=None, use_sw_index=True, resolve_attempts=10,
27                       count=1, vrf=None, lookup_vrf=None):
28         """Add route to the VPP node.
29
30         :param node: Node to add route on.
31         :param network: Route destination network address.
32         :param prefix_len: Route destination network prefix length.
33         :param gateway: Route gateway address.
34         :param interface: Route interface.
35         :param vrf: VRF table ID (Optional).
36         :param use_sw_index: Use sw_if_index in VAT command.
37         :param resolve_attempts: Resolve attempts IP route add parameter.
38         :param count: number of IP addresses to add starting from network IP
39         with same prefix (increment is 1). If None, then is not used.
40         :param lookup_vrf: VRF table ID for lookup.
41         :type node: dict
42         :type network: str
43         :type prefix_len: int
44         :type gateway: str
45         :type interface: str
46         :type use_sw_index: bool
47         :type resolve_attempts: int
48         :type count: int
49         :type vrf: int
50         :type lookup_vrf: int
51         """
52         if use_sw_index:
53             int_cmd = ('sw_if_index {}'.
54                        format(Topology.get_interface_sw_index(node, interface)))
55         else:
56             int_cmd = interface
57
58         rap = 'resolve-attempts {}'.format(resolve_attempts) \
59             if resolve_attempts else ''
60
61         via = 'via {}'.format(gateway) if gateway else ''
62
63         cnt = 'count {}'.format(count) \
64             if count else ''
65
66         vrf = 'vrf {}'.format(vrf) if vrf else ''
67
68         lookup_vrf = 'lookup-in-vrf {}'.format(lookup_vrf) if lookup_vrf else ''
69
70         with VatTerminal(node, json_param=False) as vat:
71             vat.vat_terminal_exec_cmd_from_template('add_route.vat',
72                                                     network=network,
73                                                     prefix_length=prefix_len,
74                                                     via=via,
75                                                     vrf=vrf,
76                                                     interface=int_cmd,
77                                                     resolve_attempts=rap,
78                                                     count=cnt,
79                                                     lookup_vrf=lookup_vrf)
80
81     @staticmethod
82     def add_fib_table(node, network, prefix_len, fib_id, place):
83         """Create new FIB table according to ID.
84
85         :param node: Node to add FIB on.
86         :param network: IP address to add to the FIB table.
87         :param prefix_len: IP address prefix length.
88         :param fib_id: FIB table ID.
89         :param place: Possible variants are local, drop.
90         :type node: dict
91         :type network: str
92         :type prefix_len: int
93         :type fib_id: int
94         :type place: str
95         """
96         with VatTerminal(node) as vat:
97             vat.vat_terminal_exec_cmd_from_template('add_fib_table.vat',
98                                                     network=network,
99                                                     prefix_length=prefix_len,
100                                                     fib_number=fib_id,
101                                                     where=place)
102
103     @staticmethod
104     def add_route(node, ip, prefix, gw, namespace=None):
105         """Add route in namespace.
106
107         :param node: Node where to execute command.
108         :param ip: Route destination IP.
109         :param prefix: IP prefix.
110         :param namespace: Execute command in namespace. Optional
111         :param gw: Gateway.
112         :type node: dict
113         :type ip: str
114         :type prefix: int
115         :type gw: str
116         :type namespace: str
117         """
118         if namespace is not None:
119             cmd = 'ip netns exec {} ip route add {}/{} via {}'.format(
120                 namespace, ip, prefix, gw)
121         else:
122             cmd = 'ip route add {}/{} via {}'.format(ip, prefix, gw)
123         exec_cmd_no_error(node, cmd, sudo=True)

©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.