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