CSIT-339: Add Keywords for SMT

[csit.git] / resources / libraries / python / IPv4Setup.py

diff --git a/resources/libraries/python/IPv4Setup.py b/resources/libraries/python/IPv4Setup.py
index d4be4c6..0220139 100644 (file)
--- a/resources/libraries/python/IPv4Setup.py
+++ b/resources/libraries/python/IPv4Setup.py
@@ -34,6 +34,14 @@ class IPv4Node(object):
 
     @staticmethod
     def _get_netmask(prefix_length):
+        """Convert IPv4 network prefix length into IPV4 network mask.
+
+        :param prefix_length: Length of network prefix.
+        :type prefix_length: int
+        :returns: Network mask.
+        :rtype: str
+        """
+
         bits = 0xffffffff ^ (1 << 32 - prefix_length) - 1
         return inet_ntoa(pack('>I', bits))
 
@@ -47,7 +55,7 @@ class IPv4Node(object):
         :type interface: str
         :type address: str
         :type prefix_length: int
-        :return: nothing
+        :returns: nothing
         """
         pass
 
@@ -63,7 +71,7 @@ class IPv4Node(object):
         :type prefix_length: int
         :type gateway: str
         :type interface: str
-        :return: nothing
+        :returns: nothing
         """
         pass
 
@@ -79,7 +87,7 @@ class IPv4Node(object):
         :type prefix_length: int
         :type gateway: str
         :type interface: str
-        :return: nothing
+        :returns: nothing
         """
         pass
 
@@ -101,7 +109,7 @@ class IPv4Node(object):
         :param source_interface: Source interface name.
         :type destination_address: str
         :type source_interface: str
-        :return: nothing
+        :returns: nothing
         """
         pass
 
@@ -112,9 +120,23 @@ class Tg(IPv4Node):
         super(Tg, self).__init__(node_info)
 
     def _execute(self, cmd):
+        """Executes the specified command on TG using SSH.
+
+        :param cmd: Command to be executed.
+        :type cmd: str
+        :returns: Content of stdout and stderr returned by command.
+        :rtype: tuple
+        """
         return exec_cmd_no_error(self.node_info, cmd)
 
     def _sudo_execute(self, cmd):
+        """Executes the specified command with sudo on TG using SSH.
+
+        :param cmd: Command to be executed.
+        :type cmd: str
+        :returns: Content of stdout and stderr returned by command.
+        :rtype: tuple
+        """
         return exec_cmd_no_error(self.node_info, cmd, sudo=True)
 
     def set_ip(self, interface, address, prefix_length):
@@ -135,6 +157,13 @@ class Tg(IPv4Node):
                            format(network, prefix_length))
 
     def arp_ping(self, destination_address, source_interface):
+        """Execute 'arping' command to send one ARP packet from the TG node.
+
+        :param destination_address: Destination IP address for the ARP packet.
+        :param source_interface: Name of an interface to send ARP packet from.
+        :type destination_address: str
+        :type source_interface: str
+        """
         self._sudo_execute('arping -c 1 -I {} {}'.format(source_interface,
                                                          destination_address))
 
@@ -156,7 +185,7 @@ class Dut(IPv4Node):
 
         :param interface: Interface name.
         :type interface: str
-        :return: sw_if_index of the interface or None.
+        :returns: sw_if_index of the interface or None.
         :rtype: int
         """
         return Topology().get_interface_sw_index(self.node_info, interface)
@@ -168,7 +197,7 @@ class Dut(IPv4Node):
         :param args: Parameters to the script.
         :type script: str
         :type args: dict
-        :return: nothing
+        :returns: nothing
         """
         # TODO: check return value
         VatExecutor.cmd_from_template(self.node_info, script, **args)
@@ -207,6 +236,7 @@ class Dut(IPv4Node):
                       sw_if_index=self.get_sw_if_index(interface))
 
     def arp_ping(self, destination_address, source_interface):
+        """Does nothing."""
         pass
 
     def flush_ip_addresses(self, interface):
@@ -222,7 +252,7 @@ def get_node(node_info):
 
     :param node_info: Dictionary containing information on nodes in topology.
     :type node_info: dict
-    :return: Class instance that is derived from Node.
+    :returns: Class instance that is derived from Node.
     """
     if node_info['type'] == NodeType.TG:
         return Tg(node_info)
@@ -244,7 +274,7 @@ class IPv4Setup(object):
         :param nodes_addr: Available nodes IPv4 addresses.
         :type nodes: dict
         :type nodes_addr: dict
-        :return: Affected interfaces as list of (node, interface) tuples.
+        :returns: Affected interfaces as list of (node, interface) tuples.
         :rtype: list
         """
         interfaces = []
@@ -277,7 +307,7 @@ class IPv4Setup(object):
         :type node: dict
         :type iface_key: str
         :type nodes_addr: dict
-        :return: IPv4 address.
+        :returns: IPv4 address.
         :rtype: str
         """
         interface = Topology.get_interface_name(node, iface_key)
@@ -286,9 +316,9 @@ class IPv4Setup(object):
                 host = port.get('node')
                 dev = port.get('if')
                 if host == node['host'] and dev == interface:
-                    ip = port.get('addr')
-                    if ip is not None:
-                        return ip
+                    ip_addr = port.get('addr')
+                    if ip_addr is not None:
+                        return ip_addr
                     else:
                         raise Exception(
                             'Node {n} port {p} IPv4 address is not set'.format(