resources/libraries/python/NodePath.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 """Path utilities library for nodes in the topology."""
  15
  16 from resources.libraries.python.topology import Topology
  17
  18
  19 class NodePath(object):
  20     """Path utilities for nodes in the topology.
  21
  22     :Example:
  23
  24     node1--link1-->node2--link2-->node3--link3-->node2--link4-->node1
  25     RobotFramework:
  26     | Library | resources/libraries/python/NodePath.py
  27
  28     | Path test
  29     | | [Arguments] | ${node1} | ${node2} | ${node3}
  30     | | Append Node | ${nodes1}
  31     | | Append Node | ${nodes2}
  32     | | Append Nodes | ${nodes3} | ${nodes2}
  33     | | Append Node | ${nodes1}
  34     | | Compute Path | ${FALSE}
  35     | | ${first_int} | ${node}= | First Interface
  36     | | ${last_int} | ${node}= | Last Interface
  37     | | ${first_ingress} | ${node}= | First Ingress Interface
  38     | | ${last_egress} | ${node}= | Last Egress Interface
  39     | | ${next} | ${node}= | Next Interface
  40
  41     Python:
  42     >>> from NodePath import NodePath
  43     >>> path = NodePath()
  44     >>> path.append_node(node1)
  45     >>> path.append_node(node2)
  46     >>> path.append_nodes(node3, node2)
  47     >>> path.append_node(node1)
  48     >>> path.compute_path()
  49     >>> (interface, node) = path.first_interface()
  50     >>> (interface, node) = path.last_interface()
  51     >>> (interface, node) = path.first_ingress_interface()
  52     >>> (interface, node) = path.last_egress_interface()
  53     >>> (interface, node) = path.next_interface()
  54     """
  55
  56     def __init__(self):
  57         self._nodes = []
  58         self._nodes_filter = []
  59         self._links = []
  60         self._path = []
  61         self._path_iter = []
  62
  63     def append_node(self, node, filter_list=None):
  64         """Append node to the path.
  65
  66         :param node: Node to append to the path.
  67         :param filter_list: Filter criteria list.
  68         :type node: dict
  69         :type filter_list: list of strings
  70         """
  71         self._nodes_filter.append(filter_list)
  72         self._nodes.append(node)
  73
  74     def append_nodes(self, *nodes):
  75         """Append nodes to the path.
  76
  77         :param nodes: Nodes to append to the path.
  78         :type nodes: dict
  79
  80         .. note:: Node order does matter.
  81         """
  82         for node in nodes:
  83             self.append_node(node)
  84
  85     def clear_path(self):
  86         """Clear path."""
  87         self._nodes = []
  88         self._nodes_filter = []
  89         self._links = []
  90         self._path = []
  91         self._path_iter = []
  92
  93     def compute_path(self, always_same_link=True):
  94         """Compute path for added nodes.
  95
  96         :param always_same_link: If True use always same link between two nodes
  97         in path. If False use different link (if available) between two
  98         nodes if one link was used before.
  99         :type always_same_link: bool
 100
 101         .. note:: First add at least two nodes to the topology.
 102         """
 103         nodes = self._nodes
 104         nodes_filer = self._nodes_filter
 105         if len(nodes) < 2:
 106             raise RuntimeError('Not enough nodes to compute path')
 107
 108         for idx in range(0, len(nodes) - 1):
 109             topo = Topology()
 110             node1 = nodes[idx]
 111             node2 = nodes[idx + 1]
 112             n1_list = self._nodes_filter[idx]
 113             n2_list = self._nodes_filter[idx + 1]
 114             links = topo.get_active_connecting_links(node1, node2,
 115                                                      filter_list_node1=n1_list,
 116                                                      filter_list_node2=n2_list)
 117             if not links:
 118                 raise RuntimeError('No link between {0} and {1}'.format(
 119                     node1['host'], node2['host']))
 120
 121             if always_same_link:
 122                 l_set = set(links).intersection(self._links)
 123             else:
 124                 l_set = set(links).difference(self._links)
 125                 if not l_set:
 126                     raise RuntimeError(
 127                         'No free link between {0} and {1}, all links already '
 128                         'used'.format(node1['host'], node2['host']))
 129
 130             if not l_set:
 131                 link = links.pop()
 132             else:
 133                 link = l_set.pop()
 134
 135             self._links.append(link)
 136             interface1 = topo.get_interface_by_link_name(node1, link)
 137             interface2 = topo.get_interface_by_link_name(node2, link)
 138             self._path.append((interface1, node1))
 139             self._path.append((interface2, node2))
 140
 141         self._path_iter.extend(self._path)
 142         self._path_iter.reverse()
 143
 144     def next_interface(self):
 145         """Path interface iterator.
 146
 147         :return: Interface and node or None if not next interface.
 148         :rtype: tuple (str, dict)
 149
 150         .. note:: Call compute_path before.
 151         """
 152         if not self._path_iter:
 153             return None, None
 154         else:
 155             return self._path_iter.pop()
 156
 157     def first_interface(self):
 158         """Return first interface on the path.
 159
 160         :return: Interface and node.
 161         :rtype: tuple (str, dict)
 162
 163         .. note:: Call compute_path before.
 164         """
 165         if not self._path:
 166             raise RuntimeError('No path for topology')
 167         return self._path[0]
 168
 169     def last_interface(self):
 170         """Return last interface on the path.
 171
 172         :return: Interface and node.
 173         :rtype: tuple (str, dict)
 174
 175         .. note:: Call compute_path before.
 176         """
 177         if not self._path:
 178             raise RuntimeError('No path for topology')
 179         return self._path[-1]
 180
 181     def first_ingress_interface(self):
 182         """Return first ingress interface on the path.
 183
 184         :return: Interface and node.
 185         :rtype: tuple (str, dict)
 186
 187         .. note:: Call compute_path before.
 188         """
 189         if not self._path:
 190             raise RuntimeError('No path for topology')
 191         return self._path[1]
 192
 193     def last_egress_interface(self):
 194         """Return last egress interface on the path.
 195
 196         :return: Interface and node.
 197         :rtype: tuple (str, dict)
 198
 199         .. note:: Call compute_path before.
 200         """
 201         if not self._path:
 202             raise RuntimeError('No path for topology')
 203         return self._path[-2]