fix(vlan): do not apply strip offload
[csit.git] / resources / libraries / python / autogen / Regenerator.py
index 14a9fd0..4474996 100644 (file)
@@ -1,4 +1,4 @@
-# Copyright (c) 2021 Cisco and/or its affiliates.
+# Copyright (c) 2022 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:
@@ -17,6 +17,7 @@ TODO: How can we check each suite id is unique,
       when currently the suite generation is run on each directory separately?
 """
 
+import copy
 import sys
 
 from glob import glob
@@ -116,6 +117,39 @@ def check_suite_tag(suite_tag, prolog):
         raise ValueError(f"Suite tag found {found} times for {suite_tag}")
 
 
+def filter_and_edit_kwargs_for_astf(suite_id, kwargs):
+    """Return possibly edited kwargs, or None if to be skipped.
+
+    This is a code block used in few places.
+    Kwargs is (a copy of) one item from tc_kwargs_list.
+    Currently, the editable field is frame_size,
+    to be increased to for tests with data (not just CPS).
+
+    :param suite_id: Suite ID.
+    :param kwargs: Key-value pairs used to construct one testcase.
+    :type suite_id: str
+    :type tc_kwargs_list: dict
+    :returns: Edited kwargs.
+    :rtype Optional[dict]
+    """
+    if u"-cps-" in suite_id:
+        # Contrary to UDP, there is no place to affect frame size
+        # in TCP CPS tests. Actual frames are close to min size.
+        # UDP uses the min value too, for fairer comparison to TCP.
+        if kwargs[u"frame_size"] not in MIN_FRAME_SIZE_VALUES:
+            return None
+    elif (u"-pps-" in suite_id or u"-tput-" in suite_id):
+        if u"imix" in str(kwargs[u"frame_size"]).lower():
+            # ASTF does not support IMIX (yet).
+            return None
+        if kwargs[u"frame_size"] in MIN_FRAME_SIZE_VALUES:
+            # Minimal (TRex) TCP data frame is 80B for IPv4.
+            # In future, we may want to have also IPv6 TCP.
+            # UDP uses the same value, for fairer comparison to TCP.
+            kwargs[u"frame_size"] = 100
+    return kwargs
+
+
 def add_default_testcases(testcase, iface, suite_id, file_out, tc_kwargs_list):
     """Add default testcases to file.
 
@@ -130,7 +164,9 @@ def add_default_testcases(testcase, iface, suite_id, file_out, tc_kwargs_list):
     :type file_out: file
     :type tc_kwargs_list: dict
     """
-    for kwargs in tc_kwargs_list:
+    for kwas in tc_kwargs_list:
+        # We may edit framesize for ASTF, the copy should be local.
+        kwargs = copy.deepcopy(kwas)
         # TODO: Is there a better way to disable some combinations?
         emit = True
         if kwargs[u"frame_size"] == 9000:
@@ -156,14 +192,8 @@ 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:
+        kwargs = filter_and_edit_kwargs_for_astf(suite_id, kwargs)
+        if emit and kwargs is not None:
             file_out.write(testcase.generate(**kwargs))
 
 
@@ -195,18 +225,24 @@ def add_iperf3_testcases(testcase, file_out, tc_kwargs_list):
         file_out.write(testcase.generate(**kwargs))
 
 
-def add_trex_testcases(testcase, file_out, tc_kwargs_list):
+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:
-        file_out.write(testcase.generate(**kwargs))
+    for kwas in tc_kwargs_list:
+        # We may edit framesize for ASTF, the copy should be local.
+        kwargs = copy.deepcopy(kwas)
+        kwargs = filter_and_edit_kwargs_for_astf(suite_id, kwargs)
+        if kwargs is not None:
+            file_out.write(testcase.generate(**kwargs))
 
 
 def write_default_files(in_filename, in_prolog, kwargs_list):
@@ -437,8 +473,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.
@@ -450,20 +484,54 @@ 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):
@@ -478,20 +546,21 @@ def write_iperf3_files(in_filename, in_prolog, kwargs_list):
     """
     _, 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)
+    for nic_name in Constants.NIC_NAME_TO_CODE:
+        out_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(
+            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_iperf3_testcases(testcase, file_out, kwargs_list)
 
 
 def write_trex_files(in_filename, in_prolog, kwargs_list):
@@ -549,7 +618,7 @@ def write_trex_files(in_filename, in_prolog, kwargs_list):
             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, file_out, kwargs_list)
+                add_trex_testcases(testcase, suite_id, file_out, kwargs_list)
 
 
 def write_device_files(in_filename, in_prolog, kwargs_list):
@@ -642,7 +711,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
@@ -735,7 +804,7 @@ class Regenerator:
                 in_prolog = u"".join(
                     file_in.read().partition(u"*** Test Cases ***")[:-1]
                 )
-            if "-tg-" in in_filename:
+            if "-tg" in in_filename:
                 write_trex_files(in_filename, in_prolog, trex_kwargs_list)
                 continue
             if in_filename.endswith(u"-ndrpdr.robot"):