resources/libraries/python/autogen/Regenerator.py

   1 # Copyright (c) 2020 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"ipsec" in suite_id:
 144                 # IPsec code does not support chained buffers.
 145                 # Tracked by Jira ticket VPP-1207.
 146                 emit = False
 147         if u"-16vm2t-" in suite_id or u"-16dcr2t-" in suite_id:
 148             if kwargs[u"phy_cores"] > 3:
 149                 # CSIT lab only has 28 (physical) core processors,
 150                 # so these test would fail when attempting to assign cores.
 151                 emit = False
 152         if u"-24vm1t-" in suite_id or u"-24dcr1t-" in suite_id:
 153             if kwargs[u"phy_cores"] > 3:
 154                 # CSIT lab only has 28 (physical) core processors,
 155                 # so these test would fail when attempting to assign cores.
 156                 emit = False
 157         if u"soak" in suite_id:
 158             # Soak test take too long, do not risk other than tc01.
 159             if kwargs[u"phy_cores"] != 1:
 160                 emit = False
 161             if kwargs[u"frame_size"] not in MIN_FRAME_SIZE_VALUES:
 162                 emit = False
 163         if u"-cps-" in suite_id or u"-pps-" in suite_id:
 164             if kwargs[u"frame_size"] not in MIN_FRAME_SIZE_VALUES:
 165                 emit = False
 166         if emit:
 167             file_out.write(testcase.generate(**kwargs))
 168
 169
 170 def add_tcp_testcases(testcase, file_out, tc_kwargs_list):
 171     """Add TCP testcases to file.
 172
 173     :param testcase: Testcase class.
 174     :param file_out: File to write testcases to.
 175     :param tc_kwargs_list: Key-value pairs used to construct testcases.
 176     :type testcase: Testcase
 177     :type file_out: file
 178     :type tc_kwargs_list: dict
 179     """
 180     for kwargs in tc_kwargs_list:
 181         file_out.write(testcase.generate(**kwargs))
 182
 183
 184 def write_default_files(in_filename, in_prolog, kwargs_list):
 185     """Using given filename and prolog, write all generated suites.
 186
 187     :param in_filename: Template filename to derive real filenames from.
 188     :param in_prolog: Template content to derive real content from.
 189     :param kwargs_list: List of kwargs for add_default_testcase.
 190     :type in_filename: str
 191     :type in_prolog: str
 192     :type kwargs_list: list of dict
 193     """
 194     for suite_type in Constants.PERF_TYPE_TO_KEYWORD:
 195         tmp_filename = replace_defensively(
 196             in_filename, u"ndrpdr", suite_type, 1,
 197             u"File name should contain suite type once.", in_filename
 198         )
 199         tmp_prolog = replace_defensively(
 200             in_prolog, u"ndrpdr".upper(), suite_type.upper(), 1,
 201             u"Suite type should appear once in uppercase (as tag).",
 202             in_filename
 203         )
 204         tmp_prolog = replace_defensively(
 205             tmp_prolog,
 206             u"Find NDR and PDR intervals using optimized search",
 207             Constants.PERF_TYPE_TO_KEYWORD[suite_type], 1,
 208             u"Main search keyword should appear once in suite.",
 209             in_filename
 210         )
 211         tmp_prolog = replace_defensively(
 212             tmp_prolog,
 213             Constants.PERF_TYPE_TO_SUITE_DOC_VER[u"ndrpdr"],
 214             Constants.PERF_TYPE_TO_SUITE_DOC_VER[suite_type],
 215             1, u"Exact suite type doc not found.", in_filename
 216         )
 217         tmp_prolog = replace_defensively(
 218             tmp_prolog,
 219             Constants.PERF_TYPE_TO_TEMPLATE_DOC_VER[u"ndrpdr"],
 220             Constants.PERF_TYPE_TO_TEMPLATE_DOC_VER[suite_type],
 221             1, u"Exact template type doc not found.", in_filename
 222         )
 223         _, suite_id, _ = get_iface_and_suite_ids(tmp_filename)
 224         testcase = Testcase.default(suite_id)
 225         for nic_name in Constants.NIC_NAME_TO_CODE:
 226             tmp2_filename = replace_defensively(
 227                 tmp_filename, u"10ge2p1x710",
 228                 Constants.NIC_NAME_TO_CODE[nic_name], 1,
 229                 u"File name should contain NIC code once.", in_filename
 230             )
 231             tmp2_prolog = replace_defensively(
 232                 tmp_prolog, u"Intel-X710", nic_name, 2,
 233                 u"NIC name should appear twice (tag and variable).",
 234                 in_filename
 235             )
 236             if tmp2_prolog.count(u"HW_") == 2:
 237                 # TODO CSIT-1481: Crypto HW should be read
 238                 #      from topology file instead.
 239                 if nic_name in Constants.NIC_NAME_TO_CRYPTO_HW:
 240                     tmp2_prolog = replace_defensively(
 241                         tmp2_prolog, u"HW_DH895xcc",
 242                         Constants.NIC_NAME_TO_CRYPTO_HW[nic_name], 1,
 243                         u"HW crypto name should appear.", in_filename
 244                     )
 245             iface, old_suite_id, old_suite_tag = get_iface_and_suite_ids(
 246                 tmp2_filename
 247             )
 248             if u"DPDK" in in_prolog:
 249                 for driver in Constants.DPDK_NIC_NAME_TO_DRIVER[nic_name]:
 250                     out_filename = replace_defensively(
 251                         tmp2_filename, old_suite_id,
 252                         Constants.DPDK_NIC_DRIVER_TO_SUITE_PREFIX[driver] \
 253                             + old_suite_id,
 254                         1, u"Error adding driver prefix.", in_filename
 255                     )
 256                     out_prolog = replace_defensively(
 257                         tmp2_prolog, u"vfio-pci", driver, 1,
 258                         u"Driver name should appear once.", in_filename
 259                     )
 260                     out_prolog = replace_defensively(
 261                         out_prolog,
 262                         Constants.DPDK_NIC_DRIVER_TO_TAG[u"vfio-pci"],
 263                         Constants.DPDK_NIC_DRIVER_TO_TAG[driver], 1,
 264                         u"Driver tag should appear once.", in_filename
 265                     )
 266                     iface, suite_id, suite_tag = get_iface_and_suite_ids(
 267                         out_filename
 268                     )
 269                     # The next replace is probably a noop, but it is safer to
 270                     # maintain the same structure as for other edits.
 271                     out_prolog = replace_defensively(
 272                         out_prolog, old_suite_tag, suite_tag, 1,
 273                         f"Perf suite tag {old_suite_tag} should appear once.",
 274                         in_filename
 275                     )
 276                     check_suite_tag(suite_tag, out_prolog)
 277                     # TODO: Reorder loops so suite_id is finalized sooner.
 278                     testcase = Testcase.default(suite_id)
 279                     with open(out_filename, u"wt") as file_out:
 280                         file_out.write(out_prolog)
 281                         add_default_testcases(
 282                             testcase, iface, suite_id, file_out, kwargs_list
 283                         )
 284                 continue
 285             for driver in Constants.NIC_NAME_TO_DRIVER[nic_name]:
 286                 out_filename = replace_defensively(
 287                     tmp2_filename, old_suite_id,
 288                     Constants.NIC_DRIVER_TO_SUITE_PREFIX[driver] + old_suite_id,
 289                     1, u"Error adding driver prefix.", in_filename
 290                 )
 291                 out_prolog = replace_defensively(
 292                     tmp2_prolog, u"vfio-pci", driver, 1,
 293                     u"Driver name should appear once.", in_filename
 294                 )
 295                 out_prolog = replace_defensively(
 296                     out_prolog, Constants.NIC_DRIVER_TO_TAG[u"vfio-pci"],
 297                     Constants.NIC_DRIVER_TO_TAG[driver], 1,
 298                     u"Driver tag should appear once.", in_filename
 299                 )
 300                 out_prolog = replace_defensively(
 301                     out_prolog, Constants.NIC_DRIVER_TO_PLUGINS[u"vfio-pci"],
 302                     Constants.NIC_DRIVER_TO_PLUGINS[driver], 1,
 303                     u"Driver plugin should appear once.", in_filename
 304                 )
 305                 out_prolog = replace_defensively(
 306                     out_prolog, Constants.NIC_DRIVER_TO_VFS[u"vfio-pci"],
 307                     Constants.NIC_DRIVER_TO_VFS[driver], 1,
 308                     u"NIC VFs argument should appear once.", in_filename
 309                 )
 310                 iface, suite_id, suite_tag = get_iface_and_suite_ids(
 311                     out_filename
 312                 )
 313                 # The next replace is probably a noop, but it is safer to
 314                 # maintain the same structure as for other edits.
 315                 out_prolog = replace_defensively(
 316                     out_prolog, old_suite_tag, suite_tag, 1,
 317                     f"Perf suite tag {old_suite_tag} should appear once.",
 318                     in_filename
 319                 )
 320                 check_suite_tag(suite_tag, out_prolog)
 321                 # TODO: Reorder loops so suite_id is finalized sooner.
 322                 testcase = Testcase.default(suite_id)
 323                 with open(out_filename, u"wt") as file_out:
 324                     file_out.write(out_prolog)
 325                     add_default_testcases(
 326                         testcase, iface, suite_id, file_out, kwargs_list
 327                     )
 328
 329
 330 def write_reconf_files(in_filename, in_prolog, kwargs_list):
 331     """Using given filename and prolog, write all generated reconf suites.
 332
 333     Use this for suite type reconf, as its local template
 334     is incompatible with mrr/ndrpdr/soak local template,
 335     while test cases are compatible.
 336
 337     :param in_filename: Template filename to derive real filenames from.
 338     :param in_prolog: Template content to derive real content from.
 339     :param kwargs_list: List of kwargs for add_testcase.
 340     :type in_filename: str
 341     :type in_prolog: str
 342     :type kwargs_list: list of dict
 343     """
 344     _, suite_id, _ = get_iface_and_suite_ids(in_filename)
 345     testcase = Testcase.default(suite_id)
 346     for nic_name in Constants.NIC_NAME_TO_CODE:
 347         tmp_filename = replace_defensively(
 348             in_filename, u"10ge2p1x710",
 349             Constants.NIC_NAME_TO_CODE[nic_name], 1,
 350             u"File name should contain NIC code once.", in_filename
 351         )
 352         tmp_prolog = replace_defensively(
 353             in_prolog, u"Intel-X710", nic_name, 2,
 354             u"NIC name should appear twice (tag and variable).",
 355             in_filename
 356         )
 357         if tmp_prolog.count(u"HW_") == 2:
 358             # TODO CSIT-1481: Crypto HW should be read
 359             #      from topology file instead.
 360             if nic_name in Constants.NIC_NAME_TO_CRYPTO_HW.keys():
 361                 tmp_prolog = replace_defensively(
 362                     tmp_prolog, u"HW_DH895xcc",
 363                     Constants.NIC_NAME_TO_CRYPTO_HW[nic_name], 1,
 364                     u"HW crypto name should appear.", in_filename
 365                 )
 366         iface, old_suite_id, old_suite_tag = get_iface_and_suite_ids(
 367             tmp_filename
 368         )
 369         for driver in Constants.NIC_NAME_TO_DRIVER[nic_name]:
 370             out_filename = replace_defensively(
 371                 tmp_filename, old_suite_id,
 372                 Constants.NIC_DRIVER_TO_SUITE_PREFIX[driver] + old_suite_id,
 373                 1, u"Error adding driver prefix.", in_filename
 374             )
 375             out_prolog = replace_defensively(
 376                 tmp_prolog, u"vfio-pci", driver, 1,
 377                 u"Driver name should appear once.", in_filename
 378             )
 379             out_prolog = replace_defensively(
 380                 out_prolog, Constants.NIC_DRIVER_TO_TAG[u"vfio-pci"],
 381                 Constants.NIC_DRIVER_TO_TAG[driver], 1,
 382                 u"Driver tag should appear once.", in_filename
 383             )
 384             out_prolog = replace_defensively(
 385                 out_prolog, Constants.NIC_DRIVER_TO_PLUGINS[u"vfio-pci"],
 386                 Constants.NIC_DRIVER_TO_PLUGINS[driver], 1,
 387                 u"Driver plugin should appear once.", in_filename
 388             )
 389             out_prolog = replace_defensively(
 390                 out_prolog, Constants.NIC_DRIVER_TO_VFS[u"vfio-pci"],
 391                 Constants.NIC_DRIVER_TO_VFS[driver], 1,
 392                 u"NIC VFs argument should appear once.", in_filename
 393             )
 394             iface, suite_id, suite_tag = get_iface_and_suite_ids(out_filename)
 395             out_prolog = replace_defensively(
 396                 out_prolog, old_suite_tag, suite_tag, 1,
 397                 u"Perf suite tag should appear once.", in_filename
 398             )
 399             check_suite_tag(suite_tag, out_prolog)
 400             # TODO: Reorder loops so suite_id is finalized sooner.
 401             testcase = Testcase.default(suite_id)
 402             with open(out_filename, u"wt") as file_out:
 403                 file_out.write(out_prolog)
 404                 add_default_testcases(
 405                     testcase, iface, suite_id, file_out, kwargs_list
 406                 )
 407
 408
 409 def write_tcp_files(in_filename, in_prolog, kwargs_list):
 410     """Using given filename and prolog, write all generated tcp suites.
 411
 412     TODO: Suport drivers.
 413
 414     :param in_filename: Template filename to derive real filenames from.
 415     :param in_prolog: Template content to derive real content from.
 416     :param kwargs_list: List of kwargs for add_default_testcase.
 417     :type in_filename: str
 418     :type in_prolog: str
 419     :type kwargs_list: list of dict
 420     """
 421     # TODO: Generate rps from cps? There are subtle differences.
 422     _, suite_id, suite_tag = get_iface_and_suite_ids(in_filename)
 423     testcase = Testcase.tcp(suite_id)
 424     for nic_name in Constants.NIC_NAME_TO_CODE:
 425         out_filename = replace_defensively(
 426             in_filename, u"10ge2p1x710",
 427             Constants.NIC_NAME_TO_CODE[nic_name], 1,
 428             u"File name should contain NIC code once.", in_filename
 429         )
 430         out_prolog = replace_defensively(
 431             in_prolog, u"Intel-X710", nic_name, 2,
 432             u"NIC name should appear twice (tag and variable).",
 433             in_filename
 434         )
 435         check_suite_tag(suite_tag, out_prolog)
 436         with open(out_filename, u"wt") as file_out:
 437             file_out.write(out_prolog)
 438             add_tcp_testcases(testcase, file_out, kwargs_list)
 439
 440
 441 class Regenerator:
 442     """Class containing file generating methods."""
 443
 444     def __init__(self, quiet=True):
 445         """Initialize the instance.
 446
 447         :param quiet: Reduce log prints (to stderr) when True (default).
 448         :type quiet: boolean
 449         """
 450         self.quiet = quiet
 451
 452     def regenerate_glob(self, pattern, protocol=u"ip4"):
 453         """Regenerate files matching glob pattern based on arguments.
 454
 455         In the current working directory, find all files matching
 456         the glob pattern. Use testcase template to regenerate test cases
 457         according to suffix, governed by protocol, autonumbering them.
 458         Also generate suites for other NICs and drivers.
 459
 460         Log-like prints are emitted to sys.stderr.
 461
 462         :param pattern: Glob pattern to select files. Example: *-ndrpdr.robot
 463         :param protocol: String determining minimal frame size. Default: "ip4"
 464         :type pattern: str
 465         :type protocol: str
 466         :raises RuntimeError: If invalid source suite is encountered.
 467         """
 468         if not self.quiet:
 469             print(f"Regenerator starts at {getcwd()}", file=sys.stderr)
 470
 471         min_frame_size = PROTOCOL_TO_MIN_FRAME_SIZE[protocol]
 472         default_kwargs_list = [
 473             {u"frame_size": min_frame_size, u"phy_cores": 1},
 474             {u"frame_size": min_frame_size, u"phy_cores": 2},
 475             {u"frame_size": min_frame_size, u"phy_cores": 4},
 476             {u"frame_size": 1518, u"phy_cores": 1},
 477             {u"frame_size": 1518, u"phy_cores": 2},
 478             {u"frame_size": 1518, u"phy_cores": 4},
 479             {u"frame_size": 9000, u"phy_cores": 1},
 480             {u"frame_size": 9000, u"phy_cores": 2},
 481             {u"frame_size": 9000, u"phy_cores": 4},
 482             {u"frame_size": u"IMIX_v4_1", u"phy_cores": 1},
 483             {u"frame_size": u"IMIX_v4_1", u"phy_cores": 2},
 484             {u"frame_size": u"IMIX_v4_1", u"phy_cores": 4}
 485         ]
 486         hs_bps_kwargs_list = [
 487             {u"frame_size": 1460, u"phy_cores": 1},
 488         ]
 489         hs_quic_kwargs_list = [
 490             {u"frame_size": 1280, u"phy_cores": 1},
 491         ]
 492
 493         for in_filename in glob(pattern):
 494             if not self.quiet:
 495                 print(
 496                     u"Regenerating in_filename:", in_filename, file=sys.stderr
 497                 )
 498             iface, _, _ = get_iface_and_suite_ids(in_filename)
 499             if not iface.endswith(u"10ge2p1x710"):
 500                 raise RuntimeError(
 501                     f"Error in {in_filename}: non-primary NIC found."
 502                 )
 503             for prefix in Constants.FORBIDDEN_SUITE_PREFIX_LIST:
 504                 if prefix in in_filename:
 505                     raise RuntimeError(
 506                         f"Error in {in_filename}: non-primary driver found."
 507                     )
 508             with open(in_filename, u"rt") as file_in:
 509                 in_prolog = u"".join(
 510                     file_in.read().partition(u"*** Test Cases ***")[:-1]
 511                 )
 512             if in_filename.endswith(u"-ndrpdr.robot"):
 513                 write_default_files(in_filename, in_prolog, default_kwargs_list)
 514             elif in_filename.endswith(u"-reconf.robot"):
 515                 write_reconf_files(in_filename, in_prolog, default_kwargs_list)
 516             elif in_filename.endswith(u"-bps.robot"):
 517                 hoststack_kwargs_list = \
 518                     hs_quic_kwargs_list if u"quic" in in_filename \
 519                     else hs_bps_kwargs_list
 520                 write_tcp_files(in_filename, in_prolog, hoststack_kwargs_list)
 521             else:
 522                 raise RuntimeError(
 523                     f"Error in {in_filename}: non-primary suite type found."
 524                 )
 525         if not self.quiet:
 526             print(u"Regenerator ends.", file=sys.stderr)
 527         print(file=sys.stderr)  # To make autogen check output more readable.