initial CSIT-DMM test scripts

Change-Id: I77a965751010b85d21335932baa5345a095dc4f3
Signed-off-by: sharath reddy <sharathkumarboyanapally@gmail.com>
Signed-off-by: sharath <sharathkumarboyanapally@gmail.com>

5 files changed, 404 insertions, 0 deletions

diff --git a/resources/libraries/python/DMM/DMMConstants.py b/resources/libraries/python/DMM/DMMConstants.py
new file mode 100644
index 0000000000..ec6f192bf3
--- /dev/null
+++ b/resources/libraries/python/DMM/DMMConstants.py
@@ -0,0 +1,29 @@
+# Copyright (c) 2018 Huawei Technologies Co.,Ltd.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""This file defines the constants variables for the DMM test."""
+
+class DMMConstants(object):
+    """Define the directory path for the DMM test."""
+
+    # DMM testing directory location at topology nodes
+    REMOTE_FW_DIR = '/tmp/DMM-testing'
+
+    # Shell scripts location
+    DMM_SCRIPTS = 'tests/dmm/dmm_scripts'
+
+    # Libraries location
+    DMM_DEPLIBS = 'tests/dmm/dmm_deplibs'
+
+    # Config files location for the DMM test
+    DMM_TESTCONFIG = 'tests/dmm/dmm_testconfig'
diff --git a/resources/libraries/python/DMM/SetupDMMTest.py b/resources/libraries/python/DMM/SetupDMMTest.py
new file mode 100644
index 0000000000..7d219fcfd4
--- /dev/null
+++ b/resources/libraries/python/DMM/SetupDMMTest.py
@@ -0,0 +1,183 @@
+# Copyright (c) 2018 Huawei Technologies Co.,Ltd.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""This module exists to provide setup utilities for the framework on topology
+nodes. All tasks required to be run before the actual tests are started is
+supposed to end up here.
+"""
+
+from shlex import split
+from subprocess import Popen, PIPE
+from multiprocessing import Pool
+from tempfile import NamedTemporaryFile
+from os.path import basename
+
+from robot.api import logger
+from robot.libraries.BuiltIn import BuiltIn
+
+from resources.libraries.python.ssh import SSH
+from resources.libraries.python.DMM.DMMConstants import DMMConstants as con
+from resources.libraries.python.topology import NodeType, Topology
+from resources.libraries.python.TLDK.SetupTLDKTest import copy_tarball_to_node,\
+     delete_local_tarball
+
+__all__ = ["SetupDMMTest"]
+
+
+def pack_framework_dir():
+    """Pack the testing WS into temp file, return its name.
+    :returns: file_name
+    :rtype: str
+    :raises RuntimeError: If pack the testing framework failed.
+    """
+    tmpfile = NamedTemporaryFile(suffix=".tgz", prefix="DMM-testing-")
+    file_name = tmpfile.name
+    tmpfile.close()
+
+    proc = Popen(
+        split("tar --exclude-vcs --exclude=./tmp --exclude=dmm_depends.tar.gz"
+              " -zcf {0} .".format(file_name)), stdout=PIPE, stderr=PIPE)
+    (stdout, stderr) = proc.communicate()
+
+    logger.debug(stdout)
+    logger.debug(stderr)
+
+    return_code = proc.wait()
+    if return_code != 0:
+        raise RuntimeError("Could not pack testing framework.")
+
+    return file_name
+
+def extract_tarball_at_node(tarball, node):
+    """Extract tarball at given node.
+
+    Extracts tarball using tar on given node to specific CSIT location.
+    Raise runtime errors when failed.
+
+    :param tarball: Path to tarball to upload.
+    :param node: Dictionary created from topology.
+    :type tarball: str
+    :type node: dict
+    :return: nothing
+    :raises RuntimeError: If extract tarball failed.
+    """
+    logger.console('Extracting tarball to {0} on {1}'.format(
+        con.REMOTE_FW_DIR, node['host']))
+    ssh = SSH()
+    ssh.connect(node)
+
+    cmd = 'sudo rm -rf {1}; mkdir {1} ; tar -zxf {0} -C {1}; ' \
+          'rm -f {0};'.format(tarball, con.REMOTE_FW_DIR)
+    (ret_code, _, stderr) = ssh.exec_command(cmd, timeout=30)
+    if ret_code != 0:
+        logger.error('Unpack error: {0}'.format(stderr))
+        raise RuntimeError('Failed to unpack {0} at node {1}'.format(
+            tarball, node['host']))
+
+def install_dmm_test(node):
+    """Prepare the DMM test envrionment.
+    Raise errors when failed.
+
+    :param node: Dictionary created from topology.
+    :type node: dict
+    :returns: nothing.
+    :raises RuntimeError: If install dmm failed.
+    """
+
+    arch = Topology.get_node_arch(node)
+    logger.console('Install the DMM on {0} ({1})'.format(node['host'], arch))
+
+    ssh = SSH()
+    ssh.connect(node)
+    (ret_code, _, stderr) = ssh.exec_command(
+        'cd {0}/{1} && ./install_dmm.sh {2} 2>&1 | tee log_install_dmm.txt'
+        .format(con.REMOTE_FW_DIR, con.DMM_SCRIPTS, arch), timeout=600)
+
+    if ret_code != 0:
+        logger.error('Install the DMM error: {0}'.format(stderr))
+        raise RuntimeError('Install the DMM failed')
+    else:
+        logger.console('Install the DMM on {0} success!'.format(node['host']))
+
+def setup_node(args):
+    """Run all set-up methods for a node.
+
+    This method is used as map_async parameter. It receives tuple with all
+    parameters as passed to map_async function.
+
+    :param args: All parameters needed to setup one node.
+    :type args: tuple
+    :returns: True - success, False - error
+    :rtype: bool
+    :raises RuntimeError: If node setup failed.
+    """
+    tarball, remote_tarball, node = args
+
+    # if unset, arch defaults to x86_64
+    Topology.get_node_arch(node)
+
+    try:
+        if node['type'] == NodeType.DUT:
+            copy_tarball_to_node(tarball, node)
+            extract_tarball_at_node(remote_tarball, node)
+            install_dmm_test(node)
+    except RuntimeError as exc:
+        logger.error("Node setup failed, error:'{0}'".format(exc.message))
+        return False
+    else:
+        logger.console('Setup of node {0} done'.format(node['host']))
+        return True
+
+class SetupDMMTest(object):
+    """Setup suite run on topology nodes.
+
+    Many VAT/CLI based tests need the scripts at remote hosts before executing
+    them. This class packs the whole testing directory and copies it over
+    to all nodes in topology under /tmp/
+    """
+
+    @staticmethod
+    def setup_dmm_test(nodes):
+        """Pack the whole directory and extract in temp on each node."""
+
+        tarball = pack_framework_dir()
+        msg = 'Framework packed to {0}'.format(tarball)
+        logger.console(msg)
+        logger.trace(msg)
+        remote_tarball = "/tmp/{0}".format(basename(tarball))
+
+        # Turn off logging since we use multiprocessing.
+        log_level = BuiltIn().set_log_level('NONE')
+        params = ((tarball, remote_tarball, node) for node in nodes.values())
+        pool = Pool(processes=len(nodes))
+        result = pool.map_async(setup_node, params)
+        pool.close()
+        pool.join()
+
+        # Turn on logging.
+        BuiltIn().set_log_level(log_level)
+
+        logger.info(
+            'Executed node setups in parallel, waiting for processes to end')
+        result.wait()
+
+        results = result.get()
+        node_setup_success = all(results)
+        logger.info('Results: {0}'.format(results))
+
+        logger.trace('Test framework copied to all topology nodes')
+        delete_local_tarball(tarball)
+        if node_setup_success:
+            logger.console('All nodes are ready')
+        else:
+            logger.console('Failed to setup dpdk on all the nodes')
diff --git a/resources/libraries/python/DMM/SingleCliSer.py b/resources/libraries/python/DMM/SingleCliSer.py
new file mode 100644
index 0000000000..504f59c415
--- /dev/null
+++ b/resources/libraries/python/DMM/SingleCliSer.py
@@ -0,0 +1,113 @@
+# Copyright (c) 2018 Huawei Technologies Co.,Ltd.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+"""
+This module exists to provide the vs_epoll ping test for DMM on topology nodes.
+"""
+import time
+
+from resources.libraries.python.ssh import SSH
+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."""
+
+    @staticmethod
+    def exec_the_base_vs_epoll_test(dut1_node, dut2_node):
+        """Execute the vs_epoll on the dut1_node.
+
+        :param dut1_node: Will execute the vs_epoll on this node.
+        :param dut2_node: Will execute the vc_epoll on this node.
+        :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.
+        """
+        dut1_ip = Topology.get_node_hostname(dut1_node)
+        dut2_ip = Topology.get_node_hostname(dut2_node)
+
+        ssh = SSH()
+        ssh.connect(dut1_node)
+
+        cmd = 'cd {0}/{1} && ./run_dmm.sh {2} {3} {4} ' \
+        .format(con.REMOTE_FW_DIR, con.DMM_SCRIPTS, dut1_ip, dut2_ip, 0)
+
+        cmd += '2>&1 | tee log_run_dmm.txt &'
+
+        (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']))
+
+        time.sleep(10)
+
+        ssh = SSH()
+        ssh.connect(dut2_node)
+
+        cmd = 'cd {0}/{1} && ./run_dmm.sh {2} {3} {4} ' \
+        .format(con.REMOTE_FW_DIR, con.DMM_SCRIPTS, dut1_ip, dut2_ip, 1)
+
+        cmd += '2>&1 | tee log_run_dmm.txt'
+
+        (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']))
+
+        return stdout_cli.find("send 50000")
+
+    @staticmethod
+    def get_the_test_result(dut_node):
+        """
+        After executing exec_the_base_vs_epoll_test, use this
+        to get the test result
+
+        :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.
+        """
+        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)
+
+        (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']))
+
+        return stdout
+
+    @staticmethod
+    def echo_dmm_logs(dut_node):
+        """
+        :param dut_node:
+        :return:
+        """
+        ssh = SSH()
+        ssh.connect(dut_node)
+        cmd = 'cat {0}/{1}/log_install_dmm.txt' \
+        .format(con.REMOTE_FW_DIR, con.DMM_SCRIPTS)
+
+        (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']))
diff --git a/resources/libraries/python/DMM/__init__.py b/resources/libraries/python/DMM/__init__.py
new file mode 100644
index 0000000000..d7abcb27b1
--- /dev/null
+++ b/resources/libraries/python/DMM/__init__.py
@@ -0,0 +1,16 @@
+# Copyright (c) 2018 Huawei Technologies Co.,Ltd.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+"""
+__init__ file for directory resources/libraries/python/DMM
+"""
diff --git a/resources/libraries/robot/dmm/dmm_utils.robot b/resources/libraries/robot/dmm/dmm_utils.robot
new file mode 100644
index 0000000000..24931768fb
--- /dev/null
+++ b/resources/libraries/robot/dmm/dmm_utils.robot
@@ -0,0 +1,63 @@
+# Copyright (c) 2018 Huawei Technologies Co.,Ltd.
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at:
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+*** Settings ***
+| Library | resources.libraries.python.NodePath
+| Documentation | *Utilities for the path computing, pcap reading*
+| ...
+| ... | Utilities for the path computing, pcap file reading and also the port
+| ... | selection.
+
+*** Keywords ***
+| Path for 2-node testing is set
+| | [Documentation] | Compute the path for the 2 node testing.
+| | ...
+| | ... | *Arguments:*
+| | ... | - dut1_node - DUT1 node. Type: dictionary
+| | ... | - dut2_node - DUT2 node. Type: dictionary
+| | ...
+| | ... | *Return:*
+| | ... | - No value returned.
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Path for 2-node testing is set \| ${nodes['DUT1']} \
+| | ... | \| ${nodes['DUT2'] \|
+| | ...
+| | [Arguments] | ${dut1_node} | ${dut2_node}
+| | Append Nodes | ${dut1_node} | ${dut2_node}
+| | Compute Path
+
+| Pick out the port used to execute test
+| | [Documentation] | Pick out the port used to execute the test.
+| | ...
+| | ... | *Arguments:*
+| | ... | - No arguments.
+| | ...
+| | ... | *Return:*
+| | ... | - No value returned.
+| | ...
+| | ... | *Example:*
+| | ...
+| | ... | \| Pick out the port used to execute test \|
+| | ...
+| | ${tg_port} | ${tg_node}= | First Interface
+| | ${dut1_port} | ${dut1_node}= | Next Interface
+| | ${dut2_port} | ${dut2_node}= | Last Interface
+| | Set Suite Variable | ${tg_node}
+| | Set Suite Variable | ${dut1_node}
+| | Set Suite Variable | ${dut2_node}
+| | Set Suite Variable | ${tg_port}
+| | Set Suite Variable | ${dut1_port}
+| | Set Suite Variable | ${dut2_port}
+