Merge pull request #39 from jenniexie/route_and_addr_api

add API to get node's route and ip

Author: jenniexie

happy/HappyNodeRoute.py

@@ -490,15 +490,30 @@ def __update_state(self):
         else:
             self.removeNodeRoute(self.node_id, self.to)
 
+    def getNodeRoute(self, node_id, route_type):
+        """This function will get node route base on node_id and route_type.
+
+        Args:
+           node_id (str): A string containing the node_id, example: "cloud", "BorderRouter"
+           route_type (str): A string containing ip type, example: "v4", "v6"
+
+        Returns:
+           node route ip
+        """
+        node_route_prefix = self.getNodeRoutePrefix(route_type, node_id)
+        node_route_via_id = self.getNodeRouteVia(route_type, node_id)
+        node_route_addrs = self.getNodeAddressesOnPrefix(node_route_prefix, node_route_via_id)
+        if len(node_route_addrs) != 1:
+            self.logger.error("HappyNodeRoute: there should be only one route for {}, given {}".format(node_id, len(node_route_addrs)))
+        return node_route_addrs[0]
+
+
     def run(self):
         # query node's route ip in v4 or v6 format.
         if not self.add and not self.delete:
-            node_route_prefix = self.getNodeRoutePrefix(self.route_type, self.node_id)
-            node_route_via_id = self.getNodeRouteVia(self.route_type, self.node_id)
-            node_route_addrs = self.getNodeAddressesOnPrefix(node_route_prefix, node_route_via_id)
-
+            route_ip = self.getNodeRoute(self.node_id, self.route_type)
             emsg = "virtual node: {}, route_type: {}, route ip: {}".format(
-                self.node_id, self.route_type, node_route_addrs)
+                self.node_id, self.route_type, route_ip)
             print emsg
         else:
             self.__pre_check()

happy/State.py

@@ -181,6 +181,24 @@ def getNodeInterfaceAddresses(self, interface_id, node_id=None, state=None):
             return []
         return node_interface["ip"].keys()
 
+    def getNodeAddrMatchingPrefix(self, node_id, interface, prefix):
+        """Each interface may have multiple addresses, this function will get addresses based on interface and prefix.
+
+        Args:
+           node_id (str): A string containing the node_id, example: "cloud", "BorderRouter"
+           interface (str): A string containing interface id, example: "wpan0", "wlan0"
+           prefix (str): A string containing an IP prefix, example: "10.0.1"
+
+        Returns:
+           addresses_matchPrefix: A string list containing IP addresses
+        """
+        addresses = self.getNodeInterfaceAddresses(interface, node_id)
+        addresses_matchPrefix = []
+        for address in addresses:
+            if IP.prefixMatchAddress(prefix, address):
+                addresses_matchPrefix.append(address)
+        return addresses_matchPrefix
+
     def getNodeInterfaceAddressInfo(self, interface_id, addr, node_id=None, state=None):
         node_interface = self.getNodeInterface(interface_id, node_id, state)
         if node_interface == {}: