resources/libraries/python/autogen/Regenerator.py

   1 # Copyright (c) 2021 Cisco and/or its affiliates.
   2 # Licensed under the Apache License, Version 2.0 (the "License");
   3 # you may not use this file except in compliance with the License.
   4 # You may obtain a copy of the License at:
   5 #
   6 #     http://www.apache.org/licenses/LICENSE-2.0
   7 #
   8 # Unless required by applicable law or agreed to in writing, software
   9 # distributed under the License is distributed on an "AS IS" BASIS,
  10 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  11 # See the License for the specific language governing permissions and
  12 # limitations under the License.
  13
  14 """Module defining utilities for test directory regeneration.
  15
  16 TODO: How can we check each suite id is unique,
  17       when currently the suite generation is run on each directory separately?
  18 """
  19
  20 import sys
  21
  22 from glob import glob
  23 from io import open
  24 from os import getcwd
  25
  26
  27 from resources.libraries.python.Constants import Constants
  28 from resources.libraries.python.autogen.Testcase import Testcase
  29
  30
  31 PROTOCOL_TO_MIN_FRAME_SIZE = {
  32     u"ip4": 64,
  33     u"ip6": 78,
  34     u"ethip4vxlan": 114,  # What is the real minimum for latency stream?
  35     u"dot1qip4vxlan": 118
  36 }
  37 MIN_FRAME_SIZE_VALUES = list(PROTOCOL_TO_MIN_FRAME_SIZE.values())
  38
  39
  40 def replace_defensively(
  41         whole, to_replace, replace_with, how_many, msg, in_filename):
  42     """Replace substrings while checking the number of occurrences.
  43
  44     Return edited copy of the text. Assuming "whole" is really a string,
  45     or something else with .replace not affecting it.
  46
  47     :param whole: The text to perform replacements on.
  48     :param to_replace: Substring occurrences of which to replace.
  49     :param replace_with: Substring to replace occurrences with.
  50     :param how_many: Number of occurrences to expect.
  51     :param msg: Error message to raise.
  52     :param in_filename: File name in which the error occurred.
  53     :type whole: str
  54     :type to_replace: str
  55     :type replace_with: str
  56     :type how_many: int
  57     :type msg: str
  58     :type in_filename: str
  59     :returns: The whole text after replacements are done.
  60     :rtype: str
  61     :raises ValueError: If number of occurrences does not match.
  62     """
  63     found = whole.count(to_replace)
  64     if found != how_many:
  65         raise ValueError(f"{in_filename}: {msg}")
  66     return whole.replace(to_replace, replace_with)
  67
  68
  69 def get_iface_and_suite_ids(filename):
  70     """Get NIC code, suite ID and suite tag.
  71
  72     NIC code is the part of suite name
  73     which should be replaced for other NIC.
  74     Suite ID is the part os suite name
  75     which is appended to test case names.
  76     Suite tag is suite ID without both test type and NIC driver parts.
  77
  78     :param filename: Suite file.
  79     :type filename: str
  80     :returns: NIC code, suite ID, suite tag.
  81     :rtype: 3-tuple of str
  82     """
  83     dash_split = filename.split(u"-", 1)
  84     if len(dash_split[0]) <= 4:
  85         # It was something like "2n1l", we need one more split.
  86         dash_split = dash_split[1].split(u"-", 1)
  87     nic_code = dash_split[0]
  88     suite_id = dash_split[1].split(u".", 1)[0]
  89     suite_tag = suite_id.rsplit(u"-", 1)[0]
  90     for prefix in Constants.FORBIDDEN_SUITE_PREFIX_LIST:
  91         if suite_tag.startswith(prefix):
  92             suite_tag = suite_tag[len(prefix):]
  93     return nic_code, suite_id, suite_tag
  94
  95
  96 def check_suite_tag(suite_tag, prolog):
  97     """Verify suite tag occurres once in prolog.
  98
  99     Call this after all edits are done,
 100     to confirm the (edited) suite tag still matches the (edited) suite name.
 101
 102     Currently, the edited suite tag is expect to be identical
 103     to the primary suite tag, but having a function is more flexible.
 104
 105     The occurences are counted including "| " prefix,
 106     to lower the chance to match a comment.
 107
 108     :param suite_tag: Part of suite name, between NIC driver and suite type.
 109     :param prolog: The part of .robot file content without test cases.
 110     :type suite_tag: str
 111     :type prolog: str
 112     :raises ValueError: If suite_tag not found exactly once.
 113     """
 114     found = prolog.count(u"| " + suite_tag)
 115     if found != 1:
 116         raise ValueError(f"Suite tag found {found} times for {suite_tag}")
 117
 118
 119 def add_default_testcases(testcase, iface, suite_id, file_out, tc_kwargs_list):
 120     """Add default testcases to file.
 121
 122     :param testcase: Testcase class.
 123     :param iface: Interface.
 124     :param suite_id: Suite ID.
 125     :param file_out: File to write testcases to.
 126     :param tc_kwargs_list: Key-value pairs used to construct testcases.
 127     :type testcase: Testcase
 128     :type iface: str
 129     :type suite_id: str
 130     :type file_out: file
 131     :type tc_kwargs_list: dict
 132     """
 133     for kwargs in tc_kwargs_list:
 134         # TODO: Is there a better way to disable some combinations?
 135         emit = True
 136         if kwargs[u"frame_size"] == 9000:
 137             if u"vic1227" in iface:
 138                 # Not supported in HW.
 139                 emit = False
 140             if u"vic1385" in iface:
 141                 # Not supported in HW.
 142                 emit = False
 143         if u"-16vm2t-" in suite_id or u"-16dcr2t-" in suite_id:
 144             if kwargs[u"phy_cores"] > 3:
 145                 # CSIT lab only has 28 (physical) core processors,
 146                 # so these test would fail when attempting to assign cores.
 147                 emit = False
 148         if u"-24vm1t-" in suite_id or u"-24dcr1t-" in suite_id:
 149             if kwargs[u"phy_cores"] > 3:
 150                 # CSIT lab only has 28 (physical) core processors,
 151                 # so these test would fail when attempting to assign cores.
 152                 emit = False
 153         if u"soak" in suite_id:
 154             # Soak test take too long, do not risk other than tc01.
 155             if kwargs[u"phy_cores"] != 1:
 156                 emit = False
 157             if kwargs[u"frame_size"] not in MIN_FRAME_SIZE_VALUES:
 158                 emit = False
 159         if u"-cps-" in suite_id or u"-pps-" in suite_id:
 160             if kwargs[u"frame_size"] not in MIN_FRAME_SIZE_VALUES:
 161                 emit = False
 162         if emit:
 163             file_out.write(testcase.generate(**kwargs))
 164
 165
 166 def add_tcp_testcases(testcase, file_out, tc_kwargs_list):
 167     """Add TCP testcases to file.
 168
 169     :param testcase: Testcase class.
 170     :param file_out: File to write testcases to.
 171     :param tc_kwargs_list: Key-value pairs used to construct testcases.
 172     :type testcase: Testcase
 173     :type file_out: file
 174     :type tc_kwargs_list: dict
 175     """
 176     for kwargs in tc_kwargs_list:
 177         file_out.write(testcase.generate(**kwargs))
 178
 179
 180 def add_iperf3_testcases(testcase, file_out, tc_kwargs_list):
 181     """Add iperf3 testcases to file.
 182
 183     :param testcase: Testcase class.
 184     :param file_out: File to write testcases to.
 185     :param tc_kwargs_list: Key-value pairs used to construct testcases.
 186     :type testcase: Testcase
 187     :type file_out: file
 188     :type tc_kwargs_list: dict
 189     """
 190     for kwargs in tc_kwargs_list:
 191         file_out.write(testcase.generate(**kwargs))
 192
 193
 194 def write_default_files(in_filename, in_prolog, kwargs_list):
 195     """Using given filename and prolog, write all generated suites.
 196
 197     :param in_filename: Template filename to derive real filenames from.
 198     :param in_prolog: Template content to derive real content from.
 199     :param kwargs_list: List of kwargs for add_default_testcase.
 200     :type in_filename: str
 201     :type in_prolog: str
 202     :type kwargs_list: list of dict
 203     """
 204     for suite_type in Constants.PERF_TYPE_TO_KEYWORD:
 205         tmp_filename = replace_defensively(
 206             in_filename, u"ndrpdr", suite_type, 1,
 207             u"File name should contain suite type once.", in_filename
 208         )
 209         tmp_prolog = replace_defensively(
 210             in_prolog, u"ndrpdr".upper(), suite_type.upper(), 1,
 211             u"Suite type should appear once in uppercase (as tag).",
 212             in_filename
 213         )
 214         tmp_prolog = replace_defensively(
 215             tmp_prolog,
 216             u"Find NDR and PDR intervals using optimized search",
 217             Constants.PERF_TYPE_TO_KEYWORD[suite_type], 1,
 218             u"Main search keyword should appear once in suite.",
 219             in_filename
 220         )
 221         tmp_prolog = replace_defensively(
 222             tmp_prolog,
 223             Constants.PERF_TYPE_TO_SUITE_DOC_VER[u"ndrpdr"],
 224             Constants.PERF_TYPE_TO_SUITE_DOC_VER[suite_type],
 225             1, u"Exact suite type doc not found.", in_filename
 226         )
 227         tmp_prolog = replace_defensively(
 228             tmp_prolog,
 229             Constants.PERF_TYPE_TO_TEMPLATE_DOC_VER[u"ndrpdr"],
 230             Constants.PERF_TYPE_TO_TEMPLATE_DOC_VER[suite_type],
 231             1, u"Exact template type doc not found.", in_filename
 232         )
 233         _, suite_id, _ = get_iface_and_suite_ids(tmp_filename)
 234         testcase = Testcase.default(suite_id)
 235         for nic_name in Constants.NIC_NAME_TO_CODE:
 236             tmp2_filename = replace_defensively(
 237                 tmp_filename, u"10ge2p1x710",
 238                 Constants.NIC_NAME_TO_CODE[nic_name], 1,
 239                 u"File name should contain NIC code once.", in_filename
 240             )
 241             tmp2_prolog = replace_defensively(
 242                 tmp_prolog, u"Intel-X710", nic_name, 2,
 243                 u"NIC name should appear twice (tag and variable).",
 244                 in_filename
 245             )
 246             if tmp2_prolog.count(u"HW_") == 2:
 247                 # TODO CSIT-1481: Crypto HW should be read
 248                 #      from topology file instead.
 249                 if nic_name in Constants.NIC_NAME_TO_CRYPTO_HW:
 250                     tmp2_prolog = replace_defensively(
 251                         tmp2_prolog, u"HW_DH895xcc",
 252                         Constants.NIC_NAME_TO_CRYPTO_HW[nic_name], 1,
 253                         u"HW crypto name should appear.", in_filename
 254                     )
 255             iface, old_suite_id, old_suite_tag = get_iface_and_suite_ids(
 256                 tmp2_filename
 257             )
 258             if u"DPDK" in in_prolog:
 259                 for driver in Constants.DPDK_NIC_NAME_TO_DRIVER[nic_name]:
 260                     out_filename = replace_defensively(
 261                         tmp2_filename, old_suite_id,
 262                         Constants.DPDK_NIC_DRIVER_TO_SUITE_PREFIX[driver] \
 263                             + old_suite_id,
 264                         1, u"Error adding driver prefix.", in_filename
 265                     )
 266                     out_prolog = replace_defensively(
 267                         tmp2_prolog, u"vfio-pci", driver, 1,
 268                         u"Driver name should appear once.", in_filename
 269                     )
 270                     out_prolog = replace_defensively(
 271                         out_prolog,
 272                         Constants.DPDK_NIC_DRIVER_TO_TAG[u"vfio-pci"],
 273                         Constants.DPDK_NIC_DRIVER_TO_TAG[driver], 1,
 274                         u"Driver tag should appear once.", in_filename
 275                     )
 276                     iface, suite_id, suite_tag = get_iface_and_suite_ids(
 277                         out_filename
 278                     )
 279                     # The next replace is probably a noop, but it is safer to
 280                     # maintain the same structure as for other edits.
 281                     out_prolog = replace_defensively(
 282                         out_prolog, old_suite_tag, suite_tag, 1,
 283                         f"Perf suite tag {old_suite_tag} should appear once.",
 284                         in_filename
 285                     )
 286                     check_suite_tag(suite_tag, out_prolog)
 287                     # TODO: Reorder loops so suite_id is finalized sooner.
 288                     testcase = Testcase.default(suite_id)
 289                     with open(out_filename, u"wt") as file_out:
 290                         file_out.write(out_prolog)
 291                         add_default_testcases(
 292                             testcase, iface, suite_id, file_out, kwargs_list
 293                         )
 294                 continue
 295             for driver in Constants.NIC_NAME_TO_DRIVER[nic_name]:
 296                 out_filename = replace_defensively(
 297                     tmp2_filename, old_suite_id,
 298                     Constants.NIC_DRIVER_TO_SUITE_PREFIX[driver] + old_suite_id,
 299                     1, u"Error adding driver prefix.", in_filename
 300                 )
 301                 out_prolog = replace_defensively(
 302                     tmp2_prolog, u"vfio-pci", driver, 1,
 303                     u"Driver name should appear once.", in_filename
 304                 )
 305                 out_prolog = replace_defensively(
 306                     out_prolog, Constants.NIC_DRIVER_TO_TAG[u"vfio-pci"],
 307                     Constants.NIC_DRIVER_TO_TAG[driver], 1,
 308                     u"Driver tag should appear once.", in_filename
 309                 )
 310                 out_prolog = replace_defensively(
 311                     out_prolog, Constants.NIC_DRIVER_TO_PLUGINS[u"vfio-pci"],
 312                     Constants.NIC_DRIVER_TO_PLUGINS[driver], 1,
 313                     u"Driver plugin should appear once.", in_filename
 314                 )
 315                 out_prolog = replace_defensively(
 316                     out_prolog, Constants.NIC_DRIVER_TO_VFS[u"vfio-pci"],
 317                     Constants.NIC_DRIVER_TO_VFS[driver], 1,
 318                     u"NIC VFs argument should appear once.", in_filename
 319                 )
 320                 iface, suite_id, suite_tag = get_iface_and_suite_ids(
 321                     out_filename
 322                 )
 323                 # The next replace is probably a noop, but it is safer to
 324                 # maintain the same structure as for other edits.
 325                 out_prolog = replace_defensively(
 326                     out_prolog, old_suite_tag, suite_tag, 1,
 327                     f"Perf suite tag {old_suite_tag} should appear once.",
 328                     in_filename
 329                 )
 330                 check_suite_tag(suite_tag, out_prolog)
 331                 # TODO: Reorder loops so suite_id is finalized sooner.
 332                 testcase = Testcase.default(suite_id)
 333                 with open(out_filename, u"wt") as file_out:
 334                     file_out.write(out_prolog)
 335                     add_default_testcases(
 336                         testcase, iface, suite_id, file_out, kwargs_list
 337                     )
 338
 339
 340 def write_reconf_files(in_filename, in_prolog, kwargs_list):
 341     """Using given filename and prolog, write all generated reconf suites.
 342
 343     Use this for suite type reconf, as its local template
 344     is incompatible with mrr/ndrpdr/soak local template,
 345     while test cases are compatible.
 346
 347     :param in_filename: Template filename to derive real filenames from.
 348     :param in_prolog: Template content to derive real content from.
 349     :param kwargs_list: List of kwargs for add_testcase.
 350     :type in_filename: str
 351     :type in_prolog: str
 352     :type kwargs_list: list of dict
 353     """
 354     _, suite_id, _ = get_iface_and_suite_ids(in_filename)
 355     testcase = Testcase.default(suite_id)
 356     for nic_name in Constants.NIC_NAME_TO_CODE:
 357         tmp_filename = replace_defensively(
 358             in_filename, u"10ge2p1x710",
 359             Constants.NIC_NAME_TO_CODE[nic_name], 1,
 360             u"File name should contain NIC code once.", in_filename
 361         )
 362         tmp_prolog = replace_defensively(
 363             in_prolog, u"Intel-X710", nic_name, 2,
 364             u"NIC name should appear twice (tag and variable).",
 365             in_filename
 366         )
 367         if tmp_prolog.count(u"HW_") == 2:
 368             # TODO CSIT-1481: Crypto HW should be read
 369             #      from topology file instead.
 370             if nic_name in Constants.NIC_NAME_TO_CRYPTO_HW.keys():
 371                 tmp_prolog = replace_defensively(
 372                     tmp_prolog, u"HW_DH895xcc",
 373                     Constants.NIC_NAME_TO_CRYPTO_HW[nic_name], 1,
 374                     u"HW crypto name should appear.", in_filename
 375                 )
 376         iface, old_suite_id, old_suite_tag = get_iface_and_suite_ids(
 377             tmp_filename
 378         )
 379         for driver in Constants.NIC_NAME_TO_DRIVER[nic_name]:
 380             out_filename = replace_defensively(
 381                 tmp_filename, old_suite_id,
 382                 Constants.NIC_DRIVER_TO_SUITE_PREFIX[driver] + old_suite_id,
 383                 1, u"Error adding driver prefix.", in_filename
 384             )
 385             out_prolog = replace_defensively(
 386                 tmp_prolog, u"vfio-pci", driver, 1,
 387                 u"Driver name should appear once.", in_filename
 388             )
 389             out_prolog = replace_defensively(
 390                 out_prolog, Constants.NIC_DRIVER_TO_TAG[u"vfio-pci"],
 391                 Constants.NIC_DRIVER_TO_TAG[driver], 1,
 392                 u"Driver tag should appear once.", in_filename
 393             )
 394             out_prolog = replace_defensively(
 395                 out_prolog, Constants.NIC_DRIVER_TO_PLUGINS[u"vfio-pci"],
 396                 Constants.NIC_DRIVER_TO_PLUGINS[driver], 1,
 397                 u"Driver plugin should appear once.", in_filename
 398             )
 399             out_prolog = replace_defensively(
 400                 out_prolog, Constants.NIC_DRIVER_TO_VFS[u"vfio-pci"],
 401                 Constants.NIC_DRIVER_TO_VFS[driver], 1,
 402                 u"NIC VFs argument should appear once.", in_filename
 403             )
 404             iface, suite_id, suite_tag = get_iface_and_suite_ids(out_filename)
 405             out_prolog = replace_defensively(
 406                 out_prolog, old_suite_tag, suite_tag, 1,
 407                 u"Perf suite tag should appear once.", in_filename
 408             )
 409             check_suite_tag(suite_tag, out_prolog)
 410             # TODO: Reorder loops so suite_id is finalized sooner.
 411             testcase = Testcase.default(suite_id)
 412             with open(out_filename, u"wt") as file_out:
 413                 file_out.write(out_prolog)
 414                 add_default_testcases(
 415                     testcase, iface, suite_id, file_out, kwargs_list
 416                 )
 417
 418
 419 def write_tcp_files(in_filename, in_prolog, kwargs_list):
 420     """Using given filename and prolog, write all generated tcp suites.
 421
 422     TODO: Suport drivers.
 423
 424     :param in_filename: Template filename to derive real filenames from.
 425     :param in_prolog: Template content to derive real content from.
 426     :param kwargs_list: List of kwargs for add_default_testcase.
 427     :type in_filename: str
 428     :type in_prolog: str
 429     :type kwargs_list: list of dict
 430     """
 431     # TODO: Generate rps from cps? There are subtle differences.
 432     _, suite_id, suite_tag = get_iface_and_suite_ids(in_filename)
 433     testcase = Testcase.tcp(suite_id)
 434     for nic_name in Constants.NIC_NAME_TO_CODE:
 435         out_filename = replace_defensively(
 436             in_filename, u"10ge2p1x710",
 437             Constants.NIC_NAME_TO_CODE[nic_name], 1,
 438             u"File name should contain NIC code once.", in_filename
 439         )
 440         out_prolog = replace_defensively(
 441             in_prolog, u"Intel-X710", nic_name, 2,
 442             u"NIC name should appear twice (tag and variable).",
 443             in_filename
 444         )
 445         check_suite_tag(suite_tag, out_prolog)
 446         with open(out_filename, u"wt") as file_out:
 447             file_out.write(out_prolog)
 448             add_tcp_testcases(testcase, file_out, kwargs_list)
 449
 450
 451 def write_iperf3_files(in_filename, in_prolog, kwargs_list):
 452     """Using given filename and prolog, write all generated iperf3 suites.
 453
 454     :param in_filename: Template filename to derive real filenames from.
 455     :param in_prolog: Template content to derive real content from.
 456     :param kwargs_list: List of kwargs for add_default_testcase.
 457     :type in_filename: str
 458     :type in_prolog: str
 459     :type kwargs_list: list of dict
 460     """
 461     _, suite_id, suite_tag = get_iface_and_suite_ids(in_filename)
 462     testcase = Testcase.iperf3(suite_id)
 463     out_filename = replace_defensively(
 464         in_filename, u"10ge2p1x710",
 465         Constants.NIC_NAME_TO_CODE[u"Intel-X710"], 1,
 466         u"File name should contain NIC code once.", in_filename
 467     )
 468     out_prolog = replace_defensively(
 469         in_prolog, u"Intel-X710", u"Intel-X710", 2,
 470         u"NIC name should appear twice (tag and variable).",
 471         in_filename
 472     )
 473     check_suite_tag(suite_tag, out_prolog)
 474     with open(out_filename, u"wt") as file_out:
 475         file_out.write(out_prolog)
 476         add_iperf3_testcases(testcase, file_out, kwargs_list)
 477
 478
 479 class Regenerator:
 480     """Class containing file generating methods."""
 481
 482     def __init__(self, quiet=True):
 483         """Initialize the instance.
 484
 485         :param quiet: Reduce log prints (to stderr) when True (default).
 486         :type quiet: boolean
 487         """
 488         self.quiet = quiet
 489
 490     def regenerate_glob(self, pattern, protocol=u"ip4"):
 491         """Regenerate files matching glob pattern based on arguments.
 492
 493         In the current working directory, find all files matching
 494         the glob pattern. Use testcase template to regenerate test cases
 495         according to suffix, governed by protocol, autonumbering them.
 496         Also generate suites for other NICs and drivers.
 497
 498         Log-like prints are emitted to sys.stderr.
 499
 500         :param pattern: Glob pattern to select files. Example: *-ndrpdr.robot
 501         :param protocol: String determining minimal frame size. Default: "ip4"
 502         :type pattern: str
 503         :type protocol: str
 504         :raises RuntimeError: If invalid source suite is encountered.
 505         """
 506         if not self.quiet:
 507             print(f"Regenerator starts at {getcwd()}", file=sys.stderr)
 508
 509         min_frame_size = PROTOCOL_TO_MIN_FRAME_SIZE[protocol]
 510         default_kwargs_list = [
 511             {u"frame_size": min_frame_size, u"phy_cores": 1},
 512             {u"frame_size": min_frame_size, u"phy_cores": 2},
 513             {u"frame_size": min_frame_size, u"phy_cores": 4},
 514             {u"frame_size": 1518, u"phy_cores": 1},
 515             {u"frame_size": 1518, u"phy_cores": 2},
 516             {u"frame_size": 1518, u"phy_cores": 4},
 517             {u"frame_size": 9000, u"phy_cores": 1},
 518             {u"frame_size": 9000, u"phy_cores": 2},
 519             {u"frame_size": 9000, u"phy_cores": 4},
 520             {u"frame_size": u"IMIX_v4_1", u"phy_cores": 1},
 521             {u"frame_size": u"IMIX_v4_1", u"phy_cores": 2},
 522             {u"frame_size": u"IMIX_v4_1", u"phy_cores": 4}
 523         ]
 524         hs_bps_kwargs_list = [
 525             {u"frame_size": 1460, u"phy_cores": 1},
 526         ]
 527         hs_quic_kwargs_list = [
 528             {u"frame_size": 1280, u"phy_cores": 1},
 529         ]
 530         iperf3_kwargs_list = [
 531             {u"frame_size": 128000, u"phy_cores": 1},
 532             {u"frame_size": 128000, u"phy_cores": 2},
 533             {u"frame_size": 128000, u"phy_cores": 4}
 534         ]
 535
 536         for in_filename in glob(pattern):
 537             if not self.quiet:
 538                 print(
 539                     u"Regenerating in_filename:", in_filename, file=sys.stderr
 540                 )
 541             iface, _, _ = get_iface_and_suite_ids(in_filename)
 542             if not iface.endswith(u"10ge2p1x710"):
 543                 raise RuntimeError(
 544                     f"Error in {in_filename}: non-primary NIC found."
 545                 )
 546             for prefix in Constants.FORBIDDEN_SUITE_PREFIX_LIST:
 547                 if prefix in in_filename:
 548                     raise RuntimeError(
 549                         f"Error in {in_filename}: non-primary driver found."
 550                     )
 551             with open(in_filename, u"rt") as file_in:
 552                 in_prolog = u"".join(
 553                     file_in.read().partition(u"*** Test Cases ***")[:-1]
 554                 )
 555             if in_filename.endswith(u"-ndrpdr.robot"):
 556                 write_default_files(in_filename, in_prolog, default_kwargs_list)
 557             elif in_filename.endswith(u"-reconf.robot"):
 558                 write_reconf_files(in_filename, in_prolog, default_kwargs_list)
 559             elif in_filename.endswith(u"-bps.robot"):
 560                 hoststack_kwargs_list = \
 561                     hs_quic_kwargs_list if u"quic" in in_filename \
 562                     else hs_bps_kwargs_list
 563                 write_tcp_files(in_filename, in_prolog, hoststack_kwargs_list)
 564             elif in_filename.endswith(u"-iperf3.robot"):
 565                 write_iperf3_files(in_filename, in_prolog, iperf3_kwargs_list)
 566             else:
 567                 raise RuntimeError(
 568                     f"Error in {in_filename}: non-primary suite type found."
 569                 )
 570         if not self.quiet:
 571             print(u"Regenerator ends.", file=sys.stderr)
 572         print(file=sys.stderr)  # To make autogen check output more readable.