fix(autogen): VSAP testcase naming
[csit.git] / resources / libraries / python / autogen / Regenerator.py
index 0d291e2..adbdbd9 100644 (file)
@@ -1,4 +1,4 @@
-# Copyright (c) 2020 Cisco and/or its affiliates.
+# Copyright (c) 2021 Cisco and/or its affiliates.
 # 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:
@@ -85,7 +85,7 @@ def get_iface_and_suite_ids(filename):
         # It was something like "2n1l", we need one more split.
         dash_split = dash_split[1].split(u"-", 1)
     nic_code = dash_split[0]
-    suite_id = dash_split[1].split(u".", 1)[0]
+    suite_id = dash_split[1].split(u".robot", 1)[0]
     suite_tag = suite_id.rsplit(u"-", 1)[0]
     for prefix in Constants.FORBIDDEN_SUITE_PREFIX_LIST:
         if suite_tag.startswith(prefix):
@@ -140,10 +140,6 @@ def add_default_testcases(testcase, iface, suite_id, file_out, tc_kwargs_list):
             if u"vic1385" in iface:
                 # Not supported in HW.
                 emit = False
-            if u"ipsec" in suite_id:
-                # IPsec code does not support chained buffers.
-                # Tracked by Jira ticket VPP-1207.
-                emit = False
         if u"-16vm2t-" in suite_id or u"-16dcr2t-" in suite_id:
             if kwargs[u"phy_cores"] > 3:
                 # CSIT lab only has 28 (physical) core processors,
@@ -160,6 +156,13 @@ def add_default_testcases(testcase, iface, suite_id, file_out, tc_kwargs_list):
                 emit = False
             if kwargs[u"frame_size"] not in MIN_FRAME_SIZE_VALUES:
                 emit = False
+        if (
+                u"-cps-" in suite_id
+                or u"-pps-" in suite_id
+                or u"-tput-" in suite_id
+        ):
+            if kwargs[u"frame_size"] not in MIN_FRAME_SIZE_VALUES:
+                emit = False
         if emit:
             file_out.write(testcase.generate(**kwargs))
 
@@ -178,6 +181,46 @@ def add_tcp_testcases(testcase, file_out, tc_kwargs_list):
         file_out.write(testcase.generate(**kwargs))
 
 
+def add_iperf3_testcases(testcase, file_out, tc_kwargs_list):
+    """Add iperf3 testcases to file.
+
+    :param testcase: Testcase class.
+    :param file_out: File to write testcases to.
+    :param tc_kwargs_list: Key-value pairs used to construct testcases.
+    :type testcase: Testcase
+    :type file_out: file
+    :type tc_kwargs_list: dict
+    """
+    for kwargs in tc_kwargs_list:
+        file_out.write(testcase.generate(**kwargs))
+
+
+def add_trex_testcases(testcase, suite_id, file_out, tc_kwargs_list):
+    """Add trex testcases to file.
+
+    :param testcase: Testcase class.
+    :param suite_id: Suite ID.
+    :param file_out: File to write testcases to.
+    :param tc_kwargs_list: Key-value pairs used to construct testcases.
+    :type testcase: Testcase
+    :type suite_id: str
+    :type file_out: file
+    :type tc_kwargs_list: dict
+    """
+    for kwargs in tc_kwargs_list:
+        # TODO: Is there a better way to disable some combinations?
+        emit = True
+        if (
+                u"-cps-" in suite_id
+                or u"-pps-" in suite_id
+                or u"-tput-" in suite_id
+        ):
+            if kwargs[u"frame_size"] not in MIN_FRAME_SIZE_VALUES:
+                emit = False
+        if emit:
+            file_out.write(testcase.generate(**kwargs))
+
+
 def write_default_files(in_filename, in_prolog, kwargs_list):
     """Using given filename and prolog, write all generated suites.
 
@@ -406,8 +449,6 @@ def write_reconf_files(in_filename, in_prolog, kwargs_list):
 def write_tcp_files(in_filename, in_prolog, kwargs_list):
     """Using given filename and prolog, write all generated tcp suites.
 
-    TODO: Suport drivers.
-
     :param in_filename: Template filename to derive real filenames from.
     :param in_prolog: Template content to derive real content from.
     :param kwargs_list: List of kwargs for add_default_testcase.
@@ -419,20 +460,209 @@ def write_tcp_files(in_filename, in_prolog, kwargs_list):
     _, suite_id, suite_tag = get_iface_and_suite_ids(in_filename)
     testcase = Testcase.tcp(suite_id)
     for nic_name in Constants.NIC_NAME_TO_CODE:
-        out_filename = replace_defensively(
+        tmp_filename = replace_defensively(
             in_filename, u"10ge2p1x710",
             Constants.NIC_NAME_TO_CODE[nic_name], 1,
             u"File name should contain NIC code once.", in_filename
         )
-        out_prolog = replace_defensively(
+        tmp_prolog = replace_defensively(
             in_prolog, u"Intel-X710", nic_name, 2,
             u"NIC name should appear twice (tag and variable).",
             in_filename
         )
-        check_suite_tag(suite_tag, out_prolog)
-        with open(out_filename, u"wt") as file_out:
-            file_out.write(out_prolog)
-            add_tcp_testcases(testcase, file_out, kwargs_list)
+        iface, old_suite_id, old_suite_tag = get_iface_and_suite_ids(
+            tmp_filename
+        )
+        for driver in Constants.NIC_NAME_TO_DRIVER[nic_name]:
+            out_filename = replace_defensively(
+                tmp_filename, old_suite_id,
+                Constants.NIC_DRIVER_TO_SUITE_PREFIX[driver] + old_suite_id,
+                1, u"Error adding driver prefix.", in_filename
+            )
+            out_prolog = replace_defensively(
+                tmp_prolog, u"vfio-pci", driver, 1,
+                u"Driver name should appear once.", in_filename
+            )
+            out_prolog = replace_defensively(
+                out_prolog, Constants.NIC_DRIVER_TO_TAG[u"vfio-pci"],
+                Constants.NIC_DRIVER_TO_TAG[driver], 1,
+                u"Driver tag should appear once.", in_filename
+            )
+            out_prolog = replace_defensively(
+                out_prolog, Constants.NIC_DRIVER_TO_PLUGINS[u"vfio-pci"],
+                Constants.NIC_DRIVER_TO_PLUGINS[driver], 1,
+                u"Driver plugin should appear once.", in_filename
+            )
+            out_prolog = replace_defensively(
+                out_prolog, Constants.NIC_DRIVER_TO_VFS[u"vfio-pci"],
+                Constants.NIC_DRIVER_TO_VFS[driver], 1,
+                u"NIC VFs argument should appear once.", in_filename
+            )
+            iface, suite_id, suite_tag = get_iface_and_suite_ids(out_filename)
+            out_prolog = replace_defensively(
+                out_prolog, old_suite_tag, suite_tag, 1,
+                u"Perf suite tag should appear once.", in_filename
+            )
+            check_suite_tag(suite_tag, out_prolog)
+            testcase = Testcase.tcp(suite_id)
+            with open(out_filename, u"wt") as file_out:
+                file_out.write(out_prolog)
+                add_tcp_testcases(testcase, file_out, kwargs_list)
+
+
+def write_iperf3_files(in_filename, in_prolog, kwargs_list):
+    """Using given filename and prolog, write all generated iperf3 suites.
+
+    :param in_filename: Template filename to derive real filenames from.
+    :param in_prolog: Template content to derive real content from.
+    :param kwargs_list: List of kwargs for add_default_testcase.
+    :type in_filename: str
+    :type in_prolog: str
+    :type kwargs_list: list of dict
+    """
+    _, suite_id, suite_tag = get_iface_and_suite_ids(in_filename)
+    testcase = Testcase.iperf3(suite_id)
+    out_filename = replace_defensively(
+        in_filename, u"10ge2p1x710",
+        Constants.NIC_NAME_TO_CODE[u"Intel-X710"], 1,
+        u"File name should contain NIC code once.", in_filename
+    )
+    out_prolog = replace_defensively(
+        in_prolog, u"Intel-X710", u"Intel-X710", 2,
+        u"NIC name should appear twice (tag and variable).",
+        in_filename
+    )
+    check_suite_tag(suite_tag, out_prolog)
+    with open(out_filename, u"wt") as file_out:
+        file_out.write(out_prolog)
+        add_iperf3_testcases(testcase, file_out, kwargs_list)
+
+
+def write_trex_files(in_filename, in_prolog, kwargs_list):
+    """Using given filename and prolog, write all generated trex suites.
+
+    :param in_filename: Template filename to derive real filenames from.
+    :param in_prolog: Template content to derive real content from.
+    :param kwargs_list: List of kwargs for add_trex_testcase.
+    :type in_filename: str
+    :type in_prolog: str
+    :type kwargs_list: list of dict
+    """
+    for suite_type in Constants.PERF_TYPE_TO_KEYWORD:
+        tmp_filename = replace_defensively(
+            in_filename, u"ndrpdr", suite_type, 1,
+            u"File name should contain suite type once.", in_filename
+        )
+        tmp_prolog = replace_defensively(
+            in_prolog, u"ndrpdr".upper(), suite_type.upper(), 1,
+            u"Suite type should appear once in uppercase (as tag).",
+            in_filename
+        )
+        tmp_prolog = replace_defensively(
+            tmp_prolog,
+            u"Find NDR and PDR intervals using optimized search",
+            Constants.PERF_TYPE_TO_KEYWORD[suite_type], 1,
+            u"Main search keyword should appear once in suite.",
+            in_filename
+        )
+        tmp_prolog = replace_defensively(
+            tmp_prolog,
+            Constants.PERF_TYPE_TO_SUITE_DOC_VER[u"ndrpdr"],
+            Constants.PERF_TYPE_TO_SUITE_DOC_VER[suite_type],
+            1, u"Exact suite type doc not found.", in_filename
+        )
+        tmp_prolog = replace_defensively(
+            tmp_prolog,
+            Constants.PERF_TYPE_TO_TEMPLATE_DOC_VER[u"ndrpdr"],
+            Constants.PERF_TYPE_TO_TEMPLATE_DOC_VER[suite_type],
+            1, u"Exact template type doc not found.", in_filename
+        )
+        _, suite_id, suite_tag = get_iface_and_suite_ids(tmp_filename)
+        testcase = Testcase.trex(suite_id)
+        for nic_name in Constants.NIC_NAME_TO_CODE:
+            out_filename = replace_defensively(
+                tmp_filename, u"10ge2p1x710",
+                Constants.NIC_NAME_TO_CODE[nic_name], 1,
+                u"File name should contain NIC code once.", in_filename
+            )
+            out_prolog = replace_defensively(
+                tmp_prolog, u"Intel-X710", nic_name, 2,
+                u"NIC name should appear twice (tag and variable).",
+                in_filename
+            )
+            check_suite_tag(suite_tag, out_prolog)
+            with open(out_filename, u"wt") as file_out:
+                file_out.write(out_prolog)
+                add_trex_testcases(testcase, suite_id, file_out, kwargs_list)
+
+
+def write_device_files(in_filename, in_prolog, kwargs_list):
+    """Using given filename and prolog, write all generated suites.
+
+    :param in_filename: Template filename to derive real filenames from.
+    :param in_prolog: Template content to derive real content from.
+    :param kwargs_list: List of kwargs for add_default_testcase.
+    :type in_filename: str
+    :type in_prolog: str
+    :type kwargs_list: list of dict
+    """
+    for suite_type in Constants.DEVICE_TYPE_TO_KEYWORD:
+        tmp_filename = replace_defensively(
+            in_filename, u"scapy", suite_type, 1,
+            u"File name should contain suite type once.", in_filename
+        )
+        _, suite_id, _ = get_iface_and_suite_ids(tmp_filename)
+        testcase = Testcase.default(suite_id)
+        for nic_name in Constants.NIC_NAME_TO_CODE:
+            tmp2_filename = replace_defensively(
+                tmp_filename, u"10ge2p1x710",
+                Constants.NIC_NAME_TO_CODE[nic_name], 1,
+                u"File name should contain NIC code once.", in_filename
+            )
+            tmp2_prolog = replace_defensively(
+                in_prolog, u"Intel-X710", nic_name, 2,
+                u"NIC name should appear twice (tag and variable).",
+                in_filename
+            )
+            iface, old_suite_id, _ = get_iface_and_suite_ids(
+                tmp2_filename
+            )
+            for driver in Constants.NIC_NAME_TO_DRIVER[nic_name]:
+                out_filename = replace_defensively(
+                    tmp2_filename, old_suite_id,
+                    Constants.NIC_DRIVER_TO_SUITE_PREFIX[driver] + old_suite_id,
+                    1, u"Error adding driver prefix.", in_filename
+                )
+                out_prolog = replace_defensively(
+                    tmp2_prolog, u"vfio-pci", driver, 1,
+                    u"Driver name should appear once.", in_filename
+                )
+                out_prolog = replace_defensively(
+                    out_prolog, Constants.NIC_DRIVER_TO_TAG[u"vfio-pci"],
+                    Constants.NIC_DRIVER_TO_TAG[driver], 1,
+                    u"Driver tag should appear once.", in_filename
+                )
+                out_prolog = replace_defensively(
+                    out_prolog, Constants.NIC_DRIVER_TO_PLUGINS[u"vfio-pci"],
+                    Constants.NIC_DRIVER_TO_PLUGINS[driver], 1,
+                    u"Driver plugin should appear once.", in_filename
+                )
+                out_prolog = replace_defensively(
+                    out_prolog, Constants.NIC_DRIVER_TO_VFS[u"vfio-pci"],
+                    Constants.NIC_DRIVER_TO_VFS[driver], 1,
+                    u"NIC VFs argument should appear once.", in_filename
+                )
+                iface, suite_id, suite_tag = get_iface_and_suite_ids(
+                    out_filename
+                )
+                check_suite_tag(suite_tag, out_prolog)
+                # TODO: Reorder loops so suite_id is finalized sooner.
+                testcase = Testcase.default(suite_id)
+                with open(out_filename, u"wt") as file_out:
+                    file_out.write(out_prolog)
+                    add_default_testcases(
+                        testcase, iface, suite_id, file_out, kwargs_list
+                    )
 
 
 class Regenerator:
@@ -456,7 +686,7 @@ class Regenerator:
 
         Log-like prints are emitted to sys.stderr.
 
-        :param pattern: Glob pattern to select files. Example: *-ndrpdr.robot
+        :param pattern: Glob pattern to select files. Example: \*-ndrpdr.robot
         :param protocol: String determining minimal frame size. Default: "ip4"
         :type pattern: str
         :type protocol: str
@@ -480,15 +710,55 @@ class Regenerator:
             {u"frame_size": u"IMIX_v4_1", u"phy_cores": 2},
             {u"frame_size": u"IMIX_v4_1", u"phy_cores": 4}
         ]
-        hs_wrk_kwargs_list = [
-            {u"frame_size": 0, u"phy_cores": i} for i in (1, 2, 4)
-        ]
         hs_bps_kwargs_list = [
             {u"frame_size": 1460, u"phy_cores": 1},
         ]
         hs_quic_kwargs_list = [
             {u"frame_size": 1280, u"phy_cores": 1},
         ]
+        iperf3_kwargs_list = [
+            {u"frame_size": 128000, u"phy_cores": 1},
+            {u"frame_size": 128000, u"phy_cores": 2},
+            {u"frame_size": 128000, u"phy_cores": 4}
+        ]
+        # List for tests with one dataplane core
+        # (and variable number of other cores).
+        dp1_kwargs_list = [
+            {u"frame_size": min_frame_size, u"phy_cores": 2},
+            {u"frame_size": min_frame_size, u"phy_cores": 3},
+            {u"frame_size": min_frame_size, u"phy_cores": 4},
+            {u"frame_size": 1518, u"phy_cores": 2},
+            {u"frame_size": 1518, u"phy_cores": 3},
+            {u"frame_size": 1518, u"phy_cores": 4},
+            {u"frame_size": 9000, u"phy_cores": 2},
+            {u"frame_size": 9000, u"phy_cores": 3},
+            {u"frame_size": 9000, u"phy_cores": 4},
+            {u"frame_size": u"IMIX_v4_1", u"phy_cores": 2},
+            {u"frame_size": u"IMIX_v4_1", u"phy_cores": 3},
+            {u"frame_size": u"IMIX_v4_1", u"phy_cores": 4}
+        ]
+
+        http_kwargs_list = [
+            {u"frame_size": 0, u"phy_cores": 1},
+            {u"frame_size": 0, u"phy_cores": 2},
+            {u"frame_size": 64, u"phy_cores": 1},
+            {u"frame_size": 64, u"phy_cores": 2},
+            {u"frame_size": 1024, u"phy_cores": 1},
+            {u"frame_size": 1024, u"phy_cores": 2},
+            {u"frame_size": 2048, u"phy_cores": 1},
+            {u"frame_size": 2048, u"phy_cores": 2}
+        ]
+
+        device_kwargs_list = [
+            {u"frame_size": min_frame_size, u"phy_cores": 0}
+        ]
+
+        trex_kwargs_list = [
+            {u"frame_size": min_frame_size},
+            {u"frame_size": 1518},
+            {u"frame_size": 9000},
+            {u"frame_size": u"IMIX_v4_1"}
+        ]
 
         for in_filename in glob(pattern):
             if not self.quiet:
@@ -509,17 +779,32 @@ class Regenerator:
                 in_prolog = u"".join(
                     file_in.read().partition(u"*** Test Cases ***")[:-1]
                 )
+            if "-tg" in in_filename:
+                write_trex_files(in_filename, in_prolog, trex_kwargs_list)
+                continue
             if in_filename.endswith(u"-ndrpdr.robot"):
-                write_default_files(in_filename, in_prolog, default_kwargs_list)
+                if u"scheduler" in in_filename:
+                    write_default_files(
+                        in_filename, in_prolog, dp1_kwargs_list
+                    )
+                else:
+                    write_default_files(
+                        in_filename, in_prolog, default_kwargs_list
+                    )
             elif in_filename.endswith(u"-reconf.robot"):
                 write_reconf_files(in_filename, in_prolog, default_kwargs_list)
-            elif in_filename[-10:] in (u"-cps.robot", u"-rps.robot"):
-                write_tcp_files(in_filename, in_prolog, hs_wrk_kwargs_list)
+            elif in_filename.endswith(u"-rps.robot") \
+                    or in_filename.endswith(u"-cps.robot"):
+                write_tcp_files(in_filename, in_prolog, http_kwargs_list)
             elif in_filename.endswith(u"-bps.robot"):
                 hoststack_kwargs_list = \
                     hs_quic_kwargs_list if u"quic" in in_filename \
                     else hs_bps_kwargs_list
                 write_tcp_files(in_filename, in_prolog, hoststack_kwargs_list)
+            elif in_filename.endswith(u"-iperf3-mrr.robot"):
+                write_iperf3_files(in_filename, in_prolog, iperf3_kwargs_list)
+            elif in_filename.endswith(u"-scapy.robot"):
+                write_device_files(in_filename, in_prolog, device_kwargs_list)
             else:
                 raise RuntimeError(
                     f"Error in {in_filename}: non-primary suite type found."