GSO: TAP/VHOST use case

[csit.git] / resources / libraries / python / autogen / Testcase.py

diff --git a/resources/libraries/python/autogen/Testcase.py b/resources/libraries/python/autogen/Testcase.py
index 4f92e6c..173c591 100644 (file)
--- a/resources/libraries/python/autogen/Testcase.py
+++ b/resources/libraries/python/autogen/Testcase.py
@@ -1,4 +1,4 @@
-# Copyright (c) 2018 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:
@@ -16,7 +16,7 @@
 from string import Template
 
 
-class Testcase(object):
+class Testcase:
     """Class containing a template string and a substitution method."""
 
     def __init__(self, template_string):
@@ -29,42 +29,103 @@ class Testcase(object):
             - cores_str - Number of physical cores to use, example: "2".
             - frame_num - Framesize as a number, example: "${74}".
             - frame_str - Framesize in upper case, example: "74B".
-            - tc_num - Start of testcase name, example: "tc04".
         :type template_string: str
         """
         self.template = Template(template_string)
 
-    def generate(self, num, framesize, phy_cores):
+    def generate(self, frame_size, phy_cores):
         """Return string of test case code with placeholders filled.
 
         Fail if there are placeholders left unfilled.
+        It is not required for all placeholders to be present in template.
 
-        :param num: Test case number. Example value: 4.
-        :param framesize: Imix string or numeric frame size. Example: 74.
+        :param frame_size: Imix string or numeric frame size. Example: 74.
         :param phy_cores: Number of physical cores to use. Example: 2.
-        :type num: int
-        :type framesize: str or int
+        :type frame_size: str or int
         :type phy_cores: int or str
         :returns: Filled template, usable as test case code.
         :rtype: str
         """
         try:
-            fs = int(framesize)
+            fsize = int(frame_size)
             subst_dict = {
-                "frame_num": "${%d}" % fs,
-                "frame_str": "%dB" % fs
+                u"frame_num": f"${{{fsize:d}}}",
+                u"frame_str": f"{fsize:d}B"
             }
         except ValueError:  # Assuming an IMIX string.
             subst_dict = {
-                "frame_num": str(framesize),
-                "frame_str": "IMIX"
+                u"frame_num": str(frame_size),
+                u"frame_str": u"IMIX"
             }
         cores_str = str(phy_cores)
         cores_num = int(cores_str)
         subst_dict.update(
             {
-                "cores_num": "${%d}" % cores_num,
-                "cores_str": phy_cores,
-                "tc_num": "tc{num:02d}".format(num=num)
-            })
+                u"cores_num": f"${{{cores_num:d}}}",
+                u"cores_str": phy_cores,
+            }
+        )
         return self.template.substitute(subst_dict)
+
+    @classmethod
+    def default(cls, suite_id):
+        """Factory method for creating "default" testcase objects.
+
+        Testcase name will contain both frame size and core count.
+        Used for most performance tests, except TCP ones.
+
+        :param suite_id: Part of suite name to distinguish from other suites.
+        :type suite_id: str
+        :returns: Instance for generating testcase text of this type.
+        :rtype: Testcase
+        """
+        template_string = f'''
+| ${{frame_str}}-${{cores_str}}c-{suite_id}
+| | [Tags] | ${{frame_str}} | ${{cores_str}}C
+| | frame_size=${{frame_num}} | phy_cores=${{cores_num}}
+'''
+        return cls(template_string)
+
+    @classmethod
+    def tcp(cls, suite_id):
+        """Factory method for creating "tcp" testcase objects.
+
+        Testcase name will contain core count, but not frame size.
+
+        :param suite_id: Part of suite name to distinguish from other suites.
+        :type suite_id: str
+        :returns: Instance for generating testcase text of this type.
+        :rtype: Testcase
+        """
+        # TODO: Choose a better frame size identifier for streamed protocols
+        # (TCP, QUIC, SCTP, ...) where DUT (not TG) decides frame size.
+        if u"tcphttp" in suite_id:
+            template_string = f'''
+| IMIX-${{cores_str}}c-{suite_id}
+| | [Tags] | ${{cores_str}}C
+| | phy_cores=${{cores_num}}
+'''
+        else:
+            template_string = f'''
+| ${{frame_str}}-${{cores_str}}c-{suite_id[:-4]}-{suite_id[-3:]}
+| | [Tags] | ${{cores_str}}C\n| | phy_cores=${{cores_num}}
+'''
+        return cls(template_string)
+
+    @classmethod
+    def iperf3(cls, suite_id):
+        """Factory method for creating "iperf3" testcase objects.
+
+        Testcase name will contain core count, but not frame size.
+
+        :param suite_id: Part of suite name to distinguish from other suites.
+        :type suite_id: str
+        :returns: Instance for generating testcase text of this type.
+        :rtype: Testcase
+        """
+        template_string = f'''
+| 128KB-${{cores_str}}c-{suite_id}
+| | [Tags] | 128KB | ${{cores_str}}C
+| | frame_size=${{frame_num}} | phy_cores=${{cores_num}}
+'''
+        return cls(template_string)