API: Add collection for 24225/3
[csit.git] / resources / libraries / python / DMM / SingleCliSer.py
index 9bf18bb..aa77eaa 100644 (file)
 
 
 """
-This module exists to provide the vs_epoll ping test for DMM on topology nodes.
+This module exists to provide single client-server test for DMM
+on topology nodes.
 """
 import time
+import os
+import glob
 
 from resources.libraries.python.ssh import SSH
+from resources.libraries.python.ssh import exec_cmd, exec_cmd_no_error
 from resources.libraries.python.DMM.DMMConstants import DMMConstants as con
 from resources.libraries.python.topology import Topology
-from robot.api import logger
 
-class SingleCliSer(object):
-    """Test the DMM vs_epoll ping function."""
+class SingleCliSer:
+    """Test DMM with single client-server topology."""
 
     @staticmethod
-    def exec_the_base_vs_epoll_test(dut1_node, dut2_node):
-        """Execute the vs_epoll on the dut1_node.
+    def set_dmm_interface_address(dut_node, ifname, ip_addr, ip4_prefix):
+        """
+        Flush ip, set ip, set interface up.
+
+        :param dut_node: Node to set the interface address on.
+        :param ifname: Interface name.
+        :param ip_addr: IP address to configure.
+        :param ip4_prefix: Prefix length.
+        :type dut_node: dict
+        :type ifname: str
+        :type ip_addr: str
+        :type ip4_prefix: int
+        """
+        cmd = 'sudo ip -4 addr flush dev {}'.format(ifname)
+        exec_cmd_no_error(dut_node, cmd)
+        cmd = 'sudo ip addr add {}/{} dev {}'\
+            .format(ip_addr, ip4_prefix, ifname)
+        exec_cmd_no_error(dut_node, cmd)
+        cmd = 'sudo ip link set {0} up'.format(ifname)
+        exec_cmd_no_error(dut_node, cmd)
 
-        :param dut1_node: Will execute the vs_epoll on this node.
-        :param dut2_node: Will execute the vc_epoll on this node.
+    @staticmethod
+    def setup_dmm_dut(dut1_node, dut2_node, dut1_if_name, dut2_if_name,
+                      script_name, dut1_ip, dut2_ip, prefix_len):
+        """
+        Setup DMM on DUT nodes.
+
+        :param dut1_node: Node to setup DMM on.
+        :param dut2_node: Node to setup DMM on.
+        :param dut1_if_name: DUT1 to DUT2 interface name.
+        :param dut2_if_name: DUT2 to DUT1 interface name.
+        :param script_name: Name of the script to run.
+        :param dut1_ip: IP address to configure on DUT1.
+        :param dut2_ip: IP address to configure on DUT2.
+        :param prefix_len: Prefix length.
         :type dut1_node: dict
         :type dut2_node: dict
-        :returns: positive value if packets are sent and received
-        :raises RuntimeError:If failed to execute vs_epoll test on  dut1_node.
+        :type dut1_if_name: str
+        :type dut2_if_name: str
+        :type script_name: str
+        :type dut1_ip: str
+        :type dut2_ip: str
+        :type prefix_len: int
         """
-        dut1_ip = Topology.get_node_hostname(dut1_node)
-        dut2_ip = Topology.get_node_hostname(dut2_node)
+        SingleCliSer.set_dmm_interface_address(dut1_node, dut1_if_name,
+                                               dut1_ip, prefix_len)
+        SingleCliSer.set_dmm_interface_address(dut2_node, dut2_if_name,
+                                               dut2_ip, prefix_len)
+        cmd = 'cd {0}/{1} && ./{2} setup 0 {3} {4} {5}'\
+            .format(con.REMOTE_FW_DIR, con.DMM_RUN_SCRIPTS, script_name,
+                    dut1_if_name, dut1_ip, dut2_ip)
+        exec_cmd(dut1_node, cmd)
 
-        ssh = SSH()
-        ssh.connect(dut1_node)
+        cmd = 'cd {0}/{1} && ./{2} setup 1 {3} {4} {5}'\
+            .format(con.REMOTE_FW_DIR, con.DMM_RUN_SCRIPTS, script_name,
+                    dut2_if_name, dut1_ip, dut2_ip)
+        exec_cmd(dut2_node, cmd)
 
-        cmd = 'cd {0}/{1} && ./run_dmm.sh {2} {3} {4} ' \
-        .format(con.REMOTE_FW_DIR, con.DMM_SCRIPTS, dut1_ip, dut2_ip, 0)
+    @staticmethod
+    def execute_test(dut1_node, dut2_node, dut1_if_name, dut2_if_name,
+                     script_name, dut1_ip, dut2_ip):
+        """
+        Run the given test case.
 
-        cmd += '2>&1 | tee log_run_dmm.txt &'
+        :param dut1_node: Node to run an app with DMM on.
+        :param dut2_node: Node to run an app with DMM on.
+        :param dut1_if_name: DUT1 to DUT2 interface name.
+        :param dut2_if_name: DUT2 to DUT1 interface name.
+        :param script_name: Name of the script to run.
+        :param dut1_ip: DUT1 IP address.
+        :param dut2_ip: DUT2 IP address.
+        :type dut1_node: dict
+        :type dut2_node: dict
+        :type dut1_if_name: str
+        :type dut2_if_name: str
+        :type script_name: str
+        :type dut1_ip: str
+        :type dut2_ip: str
+        """
+        cmd = 'cd {0}/{1} && ./{2} run 0 {3} {4} {5} ' \
+            .format(con.REMOTE_FW_DIR, con.DMM_RUN_SCRIPTS, script_name,
+                    dut1_if_name, dut1_ip, dut2_ip)
+        cmd += '2>&1 | tee log_{0}.txt &'.format(script_name)
+        exec_cmd(dut1_node, cmd)
+        time.sleep(10)
 
-        (ret_code, _, _) = ssh.exec_command(cmd, timeout=6000)
-        if ret_code != 0:
-            raise RuntimeError('Failed to execute vs_epoll test at node {0}'
-                               .format(dut1_node['host']))
+        cmd = 'cd {0}/{1} && ./{2} run 1 {3} {4} {5} ' \
+            .format(con.REMOTE_FW_DIR, con.DMM_RUN_SCRIPTS, script_name,
+                    dut2_if_name, dut1_ip, dut2_ip)
+        cmd += '2>&1 | tee log_{0}.txt'.format(script_name)
+        exec_cmd(dut2_node, cmd)
 
-        time.sleep(10)
+    @staticmethod
+    def verify_test_result(dut1_node, dut2_node, script_name):
+        """
+        Verify the test and return result.
 
-        ssh = SSH()
-        ssh.connect(dut2_node)
+        :param dut1_node: Node to verify test result on.
+        :param dut2_node: Node to verify test result on.
+        :param script_name: Name of the script to run.
+        :type dut1_node: dict
+        :type dut2_node: dict
+        :type script_name: str
+        :returns: test result PASS/FAIL.
+        :rtype: str
+        """
+        cmd = 'cd {0}/{1} && ./{2} verify 0' \
+            .format(con.REMOTE_FW_DIR, con.DMM_RUN_SCRIPTS, script_name)
+        (_, stdout_ser, _) = exec_cmd(dut1_node, cmd)
+
+        cmd = 'cd {0}/{1} && ./{2} verify 1' \
+            .format(con.REMOTE_FW_DIR, con.DMM_RUN_SCRIPTS, script_name)
+        (_, stdout_cli, _) = exec_cmd(dut2_node, cmd)
 
-        cmd = 'cd {0}/{1} && ./run_dmm.sh {2} {3} {4} ' \
-        .format(con.REMOTE_FW_DIR, con.DMM_SCRIPTS, dut1_ip, dut2_ip, 1)
+        if stdout_ser.find('DMM_CSIT_TEST_PASSED') != -1 \
+                and stdout_cli.find('DMM_CSIT_TEST_PASSED') != -1:
+            return "PASS"
+        else:
+            return "FAIL"
 
-        cmd += '2>&1 | tee log_run_dmm.txt'
+    @staticmethod
+    def print_dmm_log(dut1_node, dut2_node, script_name):
+        """
+        Print DMM logs.
 
-        (ret_code, stdout_cli, _) = ssh.exec_command(cmd, timeout=6000)
-        if ret_code != 0:
-            raise RuntimeError('Failed to execute vs_epoll test at node {0}'
-                               .format(dut1_node['host']))
+        :param dut1_node: Node to print DMM logs of.
+        :param dut2_node: Node to print DMM logs of.
+        :param script_name: Name of the script to run.
+        :type dut1_node: dict
+        :type dut2_node: dict
+        :type script_name: str
+        """
+        cmd = 'cd {0}/{1} && ./{2} log 0'\
+            .format(con.REMOTE_FW_DIR, con.DMM_RUN_SCRIPTS, script_name)
+        exec_cmd(dut1_node, cmd)
 
-        return stdout_cli.find("send 50000")
+        cmd = 'cd {0}/{1} && ./{2} log 1'\
+            .format(con.REMOTE_FW_DIR, con.DMM_RUN_SCRIPTS, script_name)
+        exec_cmd(dut2_node, cmd)
+        cmd = 'mv /var/log/nStack/running.log /var/log/nStack/{0}_ser.log'\
+            .format(script_name)
+        exec_cmd(dut1_node, cmd, sudo=True)
+        cmd = 'mv /var/log/nStack/running.log /var/log/nStack/{0}_cli.log'\
+            .format(script_name)
+        exec_cmd(dut2_node, cmd, sudo=True)
 
     @staticmethod
-    def get_the_test_result(dut_node):
+    def cleanup_dmm_dut(dut1_node, dut2_node, script_name):
         """
-        After executing exec_the_base_vs_epoll_test, use this
-        to get the test result
+        Cleanup DMM DUT node.
 
-        :param dut_node: will get the test result in this dut node
-        :type dut_node: dict
-        :returns: str.
-        :rtype: str.
-        :raises RuntimeError: If failed to get the test result.
+        :param dut1_node: DMM node to be cleaned up.
+        :param dut2_node: DMM node to be cleaned up.
+        :param script_name: Name of the script to run.
+        :type dut1_node: dict
+        :type dut2_node: dict
+        :type script_name: str
         """
-        ssh = SSH()
-        ssh.connect(dut_node)
-        cmd = 'cat {0}/{1}/log_run_dmm.txt | grep "send 50000" | wc -l' \
-        .format(con.REMOTE_FW_DIR, con.DMM_SCRIPTS)
+        cmd = 'cd {0}/{1} && ./{2} cleanup 0'\
+            .format(con.REMOTE_FW_DIR, con.DMM_RUN_SCRIPTS, script_name)
+        exec_cmd(dut1_node, cmd)
+        exec_cmd(dut2_node, cmd)
+        time.sleep(5)
+
+    @staticmethod
+    def run_dmm_func_test_cases(dut1_node, dut2_node, dut1_if_name,
+                                dut2_if_name, dut1_ip, dut2_ip, prefix_len):
+        """
+        Execute all the functional test cases and return result.
+
+        :param dut1_node: Node to run an app with DMM on.
+        :param dut2_node: Node to run an app with DMM on.
+        :param dut1_if_name: DUT1 to DUT2 interface name.
+        :param dut2_if_name: DUT2 to DUT1 interface name.
+        :param dut1_ip: IP address to configure on DUT1.
+        :param dut2_ip: IP address to configure on DUT2.
+        :param prefix_len: Prefix length.
+        :type dut1_node: dict
+        :type dut2_node: dict
+        :type dut1_if_name: str
+        :type dut2_if_name: str
+        :type dut1_ip: str
+        :type dut2_ip: str
+        :type prefix_len: int
+        :returns: Total testcase count, Passed testcase count.
+        :rtype: tuple(int, int)
+        """
+        passed = 0
+        total = 0
+        failed = 0
+        path = '{0}/*'.format(con.DMM_RUN_SCRIPTS)
+        files = [os.path.basename(x) for x in glob.glob(path)]
+        print "list of files : {0}".format(files)
+
+        for name in files:
+            print("file name : {}").format(name)
+            total += 1
+            SingleCliSer.setup_dmm_dut(dut1_node, dut2_node, dut1_if_name,
+                                       dut2_if_name, name, dut1_ip, dut2_ip,
+                                       prefix_len)
+            SingleCliSer.execute_test(dut1_node, dut2_node, dut1_if_name,
+                                      dut2_if_name, name, dut1_ip, dut2_ip)
+            result = SingleCliSer.verify_test_result(dut1_node, dut2_node,
+                                                     '{0}'.format(name))
+            if result == "PASS":
+                passed += 1
+            elif result == "FAIL":
+                failed += 1
+
+            SingleCliSer.print_dmm_log(dut1_node, dut2_node, name)
+            SingleCliSer.cleanup_dmm_dut(dut1_node, dut2_node, name)
+            print("TOTAL :{} PASSED : {} FAILED: {}").format\
+                (total, passed, failed)
+
+        return total, passed
 
-        (ret_code, stdout, _) = ssh.exec_command(cmd, timeout=100)
-        if ret_code != 0:
-            raise RuntimeError('Failed to get test result at node {0}'
-                               .format(dut_node['host']))
+    @staticmethod
+    def dmm_get_interface_name(dut_node, dut_interface):
+        """
+        Get the interface name.
 
-        return stdout
+        :param dut_node: Node to get the interface name on.
+        :param dut_interface: Interface key.
+        :type dut_node: dict
+        :type dut_interface: str
+        :returns: Interface name.
+        :rtype: str
+        """
+        mac = Topology.get_interface_mac(dut_node, dut_interface)
+        cmd = 'ifconfig -a | grep {0}'.format(mac)
+        (stdout, _) = exec_cmd_no_error(dut_node, cmd)
+        interface_name = stdout.split(' ', 1)[0]
+        return interface_name
 
     @staticmethod
-    def echo_dmm_logs(dut_node):
+    def get_logs_from_node(dut_node):
         """
-        :param dut_node:
-        :return:
+        Get logs from node to the test executor machine.
+
+        :param dut_node: Node to artifact the logs of.
+        :type dut_node: dict
         """
         ssh = SSH()
         ssh.connect(dut_node)
-        cmd = 'cat {0}/{1}/log_install_dmm.txt' \
-        .format(con.REMOTE_FW_DIR, con.DMM_SCRIPTS)
+        ssh.scp(".", '/var/log/nStack/*.log',
+                get=True, timeout=60, wildcard=True)
 
-        (ret_code, stdout, _) = ssh.exec_command(cmd, timeout=100)
-        if ret_code != 0:
-            raise RuntimeError('Failed to get log_install_dmm at node {0}'
-                               .format(dut_node['host']))
-        else:
-            logger.console('....log_install_dmm on node {1}.... {0}'
-                           .format(stdout, dut_node['host']))
+        (ret, _, _) = exec_cmd(dut_node, 'ls -l /var/log/app*.log')
+        if ret == 0:
+            ssh.scp(".", '/var/log/app*.log',
+                    get=True, timeout=60, wildcard=True)
 
+        exec_cmd(dut_node, 'rm -rf /var/log/nStack/*.log', sudo=True)
+        exec_cmd(dut_node, 'rm -rf /var/log/app*.log', sudo=True)
+
+    @staticmethod
+    def archive_dmm_logs(dut1_node, dut2_node):
+        """
+        Get logs from both DUT's to the test executor machine.
+
+        :param dut1_node: DUT1 node.
+        :param dut2_node: DUT2 node.
+        :type dut1_node: dict
+        :type dut2_node: dict
+        """
+        SingleCliSer.get_logs_from_node(dut1_node)
+        SingleCliSer.get_logs_from_node(dut2_node)