+PROTOCOL_TO_MIN_FRAME_SIZE = {
+ u"ip4": 64,
+ u"ip6": 78,
+ u"ethip4vxlan": 114, # What is the real minimum for latency stream?
+ u"dot1qip4vxlan": 118
+}
+MIN_FRAME_SIZE_VALUES = list(PROTOCOL_TO_MIN_FRAME_SIZE.values())
+
+
+def replace_defensively(
+ whole, to_replace, replace_with, how_many, msg, in_filename):
+ """Replace substrings while checking the number of occurrences.
+
+ Return edited copy of the text. Assuming "whole" is really a string,
+ or something else with .replace not affecting it.
+
+ :param whole: The text to perform replacements on.
+ :param to_replace: Substring occurrences of which to replace.
+ :param replace_with: Substring to replace occurrences with.
+ :param how_many: Number of occurrences to expect.
+ :param msg: Error message to raise.
+ :param in_filename: File name in which the error occurred.
+ :type whole: str
+ :type to_replace: str
+ :type replace_with: str
+ :type how_many: int
+ :type msg: str
+ :type in_filename: str
+ :returns: The whole text after replacements are done.
+ :rtype: str
+ :raises ValueError: If number of occurrences does not match.
+ """
+ found = whole.count(to_replace)
+ if found != how_many:
+ raise ValueError(f"{in_filename}: {msg}")
+ return whole.replace(to_replace, replace_with)
+
+
+def get_iface_and_suite_ids(filename):
+ """Get NIC code, suite ID and suite tag.
+
+ NIC code is the part of suite name
+ which should be replaced for other NIC.
+ Suite ID is the part os suite name
+ which is appended to test case names.
+ Suite tag is suite ID without both test type and NIC driver parts.
+
+ :param filename: Suite file.
+ :type filename: str
+ :returns: NIC code, suite ID, suite tag.
+ :rtype: 3-tuple of str
+ """
+ dash_split = filename.split(u"-", 1)
+ if len(dash_split[0]) <= 4:
+ # 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".robot", 1)[0]
+ suite_tag = suite_id.rsplit(u"-", 1)[0]
+ for prefix in Constants.FORBIDDEN_SUITE_PREFIX_LIST:
+ if suite_tag.startswith(prefix):
+ suite_tag = suite_tag[len(prefix):]
+ return nic_code, suite_id, suite_tag
+
+
+def check_suite_tag(suite_tag, prolog):
+ """Verify suite tag occurres once in prolog.
+
+ Call this after all edits are done,
+ to confirm the (edited) suite tag still matches the (edited) suite name.
+
+ Currently, the edited suite tag is expect to be identical
+ to the primary suite tag, but having a function is more flexible.
+
+ The occurences are counted including "| " prefix,
+ to lower the chance to match a comment.
+
+ :param suite_tag: Part of suite name, between NIC driver and suite type.
+ :param prolog: The part of .robot file content without test cases.
+ :type suite_tag: str
+ :type prolog: str
+ :raises ValueError: If suite_tag not found exactly once.
+ """
+ found = prolog.count(u"| " + suite_tag)
+ if found != 1:
+ raise ValueError(f"Suite tag found {found} times for {suite_tag}")
+
+
+def add_default_testcases(testcase, iface, suite_id, file_out, tc_kwargs_list):
+ """Add default testcases to file.
+
+ :param testcase: Testcase class.
+ :param iface: Interface.
+ :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 iface: str
+ :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 kwargs[u"frame_size"] == 9000:
+ if u"vic1227" in iface:
+ # Not supported in HW.
+ emit = False
+ if u"vic1385" in iface:
+ # Not supported in HW.
+ 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,
+ # so these test would fail when attempting to assign cores.
+ emit = False
+ if u"-24vm1t-" in suite_id or u"-24dcr1t-" in suite_id:
+ if kwargs[u"phy_cores"] > 3:
+ # CSIT lab only has 28 (physical) core processors,
+ # so these test would fail when attempting to assign cores.
+ emit = False
+ if u"soak" in suite_id:
+ # Soak test take too long, do not risk other than tc01.
+ if kwargs[u"phy_cores"] != 1:
+ 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))
+
+
+def add_tcp_testcases(testcase, file_out, tc_kwargs_list):
+ """Add TCP 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_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.
+
+ :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.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, _ = 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(
+ tmp_prolog, u"Intel-X710", nic_name, 2,
+ u"NIC name should appear twice (tag and variable).",
+ in_filename
+ )
+ if tmp2_prolog.count(u"HW_") == 2:
+ # TODO CSIT-1481: Crypto HW should be read
+ # from topology file instead.
+ if nic_name in Constants.NIC_NAME_TO_CRYPTO_HW:
+ tmp2_prolog = replace_defensively(
+ tmp2_prolog, u"HW_DH895xcc",
+ Constants.NIC_NAME_TO_CRYPTO_HW[nic_name], 1,
+ u"HW crypto name should appear.", in_filename
+ )
+ iface, old_suite_id, old_suite_tag = get_iface_and_suite_ids(
+ tmp2_filename
+ )
+ if u"DPDK" in in_prolog:
+ for driver in Constants.DPDK_NIC_NAME_TO_DRIVER[nic_name]:
+ out_filename = replace_defensively(
+ tmp2_filename, old_suite_id,
+ Constants.DPDK_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.DPDK_NIC_DRIVER_TO_TAG[u"vfio-pci"],
+ Constants.DPDK_NIC_DRIVER_TO_TAG[driver], 1,
+ u"Driver tag should appear once.", in_filename
+ )
+ iface, suite_id, suite_tag = get_iface_and_suite_ids(
+ out_filename
+ )
+ # The next replace is probably a noop, but it is safer to
+ # maintain the same structure as for other edits.
+ out_prolog = replace_defensively(
+ out_prolog, old_suite_tag, suite_tag, 1,
+ f"Perf suite tag {old_suite_tag} should appear once.",
+ in_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
+ )
+ continue
+ 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
+ )
+ # The next replace is probably a noop, but it is safer to
+ # maintain the same structure as for other edits.
+ out_prolog = replace_defensively(
+ out_prolog, old_suite_tag, suite_tag, 1,
+ f"Perf suite tag {old_suite_tag} should appear once.",
+ in_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
+ )
+