-# Copyright (c) 2019 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:
# See the License for the specific language governing permissions and
# limitations under the License.
-"""Module defining utilities for test directory regeneration."""
+"""Module defining utilities for test directory regeneration.
+
+TODO: How can we check each suite id is unique,
+ when currently the suite generation is run on each directory separately?
+"""
import sys
:type how_many: int
:type msg: str
:type in_filename: str
- :return: The whole text after replacements are done.
+ :returns: The whole text after replacements are done.
:rtype: str
- :raise ValueError: If number of occurrences does not match.
+ :raises ValueError: If number of occurrences does not match.
"""
found = whole.count(to_replace)
if found != how_many:
return whole.replace(to_replace, replace_with)
-def get_iface_and_suite_id(filename):
- """Get interface and suite ID.
+def get_iface_and_suite_ids(filename):
+ """Get NIC code, suite ID and suite tag.
- Interface ID is the part of suite name
+ NIC code is the part of suite name
which should be replaced for other NIC.
Suite ID is the part os suite name
- which si appended to test case names.
+ 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: Interface ID, Suite ID.
- :rtype: (str, 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)
- return dash_split[0], dash_split[1].split(u".", 1)[0]
+ 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):
:type file_out: file
:type tc_kwargs_list: dict
"""
- # We bump tc number in any case, so that future enables/disables
- # do not affect the numbering of other test cases.
- for num, kwargs in enumerate(tc_kwargs_list, start=1):
+ 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"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,
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(num=num, **kwargs))
+ file_out.write(testcase.generate(**kwargs))
def add_tcp_testcases(testcase, file_out, tc_kwargs_list):
:type file_out: file
:type tc_kwargs_list: dict
"""
- for num, kwargs in enumerate(tc_kwargs_list, start=1):
- file_out.write(testcase.generate(num=num, **kwargs))
+ 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 write_default_files(in_filename, in_prolog, kwargs_list):
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_id(tmp_filename)
+ _, suite_id, _ = get_iface_and_suite_ids(tmp_filename)
testcase = Testcase.default(suite_id)
for nic_name in Constants.NIC_NAME_TO_CODE:
- out_filename = replace_defensively(
+ 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
)
- out_prolog = replace_defensively(
+ tmp2_prolog = replace_defensively(
tmp_prolog, u"Intel-X710", nic_name, 2,
u"NIC name should appear twice (tag and variable).",
in_filename
)
- if out_prolog.count(u"HW_") == 2:
+ if tmp2_prolog.count(u"HW_") == 2:
# TODO CSIT-1481: Crypto HW should be read
- # from topology file instead.
+ # from topology file instead.
if nic_name in Constants.NIC_NAME_TO_CRYPTO_HW:
- out_prolog = replace_defensively(
- out_prolog, u"HW_DH895xcc",
+ 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, suite_id = get_iface_and_suite_id(out_filename)
- with open(out_filename, "wt") as file_out:
- file_out.write(out_prolog)
- add_default_testcases(
- testcase, iface, suite_id, file_out, kwargs_list
+ 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
+ )
def write_reconf_files(in_filename, in_prolog, kwargs_list):
:type in_prolog: str
:type kwargs_list: list of dict
"""
- _, suite_id = get_iface_and_suite_id(in_filename)
+ _, suite_id, _ = get_iface_and_suite_ids(in_filename)
testcase = Testcase.default(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
)
- if out_prolog.count(u"HW_") == 2:
+ if tmp_prolog.count(u"HW_") == 2:
# TODO CSIT-1481: Crypto HW should be read
- # from topology file instead.
- if nic_name in list(Constants.NIC_NAME_TO_CRYPTO_HW.keys()):
- out_prolog = replace_defensively(
- out_prolog, u"HW_DH895xcc",
+ # from topology file instead.
+ if nic_name in Constants.NIC_NAME_TO_CRYPTO_HW.keys():
+ tmp_prolog = replace_defensively(
+ tmp_prolog, u"HW_DH895xcc",
Constants.NIC_NAME_TO_CRYPTO_HW[nic_name], 1,
u"HW crypto name should appear.", in_filename
)
- iface, suite_id = get_iface_and_suite_id(out_filename)
- with open(out_filename, "wt") as file_out:
- file_out.write(out_prolog)
- add_default_testcases(
- testcase, iface, suite_id, 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)
+ # 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
+ )
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.
:type kwargs_list: list of dict
"""
# TODO: Generate rps from cps? There are subtle differences.
- _, suite_id = get_iface_and_suite_id(in_filename)
+ _, 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(
u"NIC name should appear twice (tag and variable).",
in_filename
)
- with open(out_filename, "wt") as file_out:
+ 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)
+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)
+
+
class Regenerator:
"""Class containing file generating methods."""
"""Regenerate files matching glob pattern based on arguments.
In the current working directory, find all files matching
- the glob pattern. Use testcase template according to suffix
- to regenerate test cases, auto-numbering them,
- taking arguments from list.
+ the glob pattern. Use testcase template to regenerate test cases
+ according to suffix, governed by protocol, autonumbering them.
+ Also generate suites for other NICs and drivers.
Log-like prints are emitted to sys.stderr.
{u"frame_size": u"IMIX_v4_1", u"phy_cores": 2},
{u"frame_size": u"IMIX_v4_1", u"phy_cores": 4}
]
- tcp_kwargs_list = [
- {u"phy_cores": i, u"frame_size": 0} 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}
]
+
for in_filename in glob(pattern):
if not self.quiet:
print(
u"Regenerating in_filename:", in_filename, file=sys.stderr
)
- iface, _ = get_iface_and_suite_id(in_filename)
+ iface, _, _ = get_iface_and_suite_ids(in_filename)
if not iface.endswith(u"10ge2p1x710"):
raise RuntimeError(
f"Error in {in_filename}: non-primary NIC found."
)
- with open(in_filename, "rt") as file_in:
+ for prefix in Constants.FORBIDDEN_SUITE_PREFIX_LIST:
+ if prefix in in_filename:
+ raise RuntimeError(
+ f"Error in {in_filename}: non-primary driver found."
+ )
+ with open(in_filename, u"rt") as file_in:
in_prolog = u"".join(
- file_in.read().partition("*** Test Cases ***")[:-1]
+ file_in.read().partition(u"*** Test Cases ***")[:-1]
)
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, tcp_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)
else:
raise RuntimeError(
f"Error in {in_filename}: non-primary suite type found."