resources/libraries/python/autogen/Regenerator.py

   1 # Copyright (c) 2019 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 from __future__ import print_function
  17
  18 from glob import glob
  19 from os import getcwd
  20 import sys
  21
  22 from resources.libraries.python.Constants import Constants
  23 from resources.libraries.python.autogen.Testcase import Testcase
  24
  25
  26 PROTOCOL_TO_MIN_FRAME_SIZE = {
  27     "ip4": 64,
  28     "ip6": 78,
  29     "ethip4vxlan": 114,  # What is the real minimum for latency stream?
  30     "dot1qip4vxlan": 118
  31 }
  32 MIN_FRAME_SIZE_VALUES = PROTOCOL_TO_MIN_FRAME_SIZE.values()
  33
  34
  35 # Copied from https://stackoverflow.com/a/14981125
  36 def eprint(*args, **kwargs):
  37     """Print to stderr."""
  38     print(*args, file=sys.stderr, **kwargs)
  39
  40
  41 def replace_defensively(
  42         whole, to_replace, replace_with, how_many, msg, in_filename):
  43     """Replace substrings while checking the number of occurences.
  44
  45     Return edited copy of the text. Assuming "whole" is really a string,
  46     or something else with .replace not affecting it.
  47
  48     :param whole: The text to perform replacements on.
  49     :param to_replace: Substring occurences of which to replace.
  50     :param replace_with: Substring to replace occurences with.
  51     :param how_many: Number of occurences to expect.
  52     :param msg: Error message to raise.
  53     :param in_filename: File name in which the error occured.
  54     :type whole: str
  55     :type to_replace: str
  56     :type replace_with: str
  57     :type how_many: int
  58     :type msg: str
  59     :type in_filename: str
  60     :return: The whole text after replacements are done.
  61     :rtype: str
  62     :raise ValueError: If number of occurences does not match.
  63     """
  64     found = whole.count(to_replace)
  65     if found != how_many:
  66         raise ValueError(in_filename + ": " + msg)
  67     return whole.replace(to_replace, replace_with)
  68
  69
  70 def get_iface_and_suite_id(filename):
  71     """Get interface and suite ID.
  72
  73     Interface ID is the part of suite name
  74     which should be replaced for other NIC.
  75     Suite ID is the part os suite name
  76     which si appended to testcase names.
  77
  78     :param filename: Suite file.
  79     :type filename: str
  80     :returns: Interface ID, Suite ID.
  81     :rtype: (str, str)
  82     """
  83     dash_split = filename.split("-", 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("-", 1)
  87     return dash_split[0], dash_split[1].split(".", 1)[0]
  88
  89
  90 def add_default_testcases(testcase, iface, suite_id, file_out, tc_kwargs_list):
  91     """Add default testcases to file.
  92
  93     :param testcase: Testcase class.
  94     :param iface: Interface.
  95     :param suite_id: Suite ID.
  96     :param file_out: File to write testcases to.
  97     :param tc_kwargs_list: Key-value pairs used to construct testcases.
  98     :type testcase: Testcase
  99     :type iface: str
 100     :type suite_id: str
 101     :type file_out: file
 102     :type tc_kwargs_list: dict
 103     """
 104     # We bump tc number in any case, so that future enables/disables
 105     # do not affect the numbering of other test cases.
 106     for num, kwargs in enumerate(tc_kwargs_list, start=1):
 107         # TODO: Is there a better way to disable some combinations?
 108         emit = True
 109         if kwargs["frame_size"] == 9000:
 110             if "vic1227" in iface:
 111                 # Not supported in HW.
 112                 emit = False
 113             if "vic1385" in iface:
 114                 # Not supported in HW.
 115                 emit = False
 116         if "-16vm2t-" in suite_id or "-16dcr2t-" in suite_id:
 117             if kwargs["phy_cores"] > 3:
 118                 # CSIT lab only has 28 (physical) core processors,
 119                 # so these test would fail when attempting to assign cores.
 120                 emit = False
 121         if "-24vm1t-" in suite_id or "-24dcr1t-" in suite_id:
 122             if kwargs["phy_cores"] > 3:
 123                 # CSIT lab only has 28 (physical) core processors,
 124                 # so these test would fail when attempting to assign cores.
 125                 emit = False
 126         if "soak" in suite_id:
 127             # Soak test take too long, do not risk other than tc01.
 128             if kwargs["phy_cores"] != 1:
 129                 emit = False
 130             if kwargs["frame_size"] not in MIN_FRAME_SIZE_VALUES:
 131                 emit = False
 132         if emit:
 133             file_out.write(testcase.generate(num=num, **kwargs))
 134
 135
 136 def add_tcp_testcases(testcase, file_out, tc_kwargs_list):
 137     """Add TCP testcases to file.
 138
 139     :param testcase: Testcase class.
 140     :param file_out: File to write testcases to.
 141     :param tc_kwargs_list: Key-value pairs used to construct testcases.
 142     :type testcase: Testcase
 143     :type file_out: file
 144     :type tc_kwargs_list: dict
 145     """
 146     for num, kwargs in enumerate(tc_kwargs_list, start=1):
 147         file_out.write(testcase.generate(num=num, **kwargs))
 148
 149
 150 def write_default_files(in_filename, in_prolog, kwargs_list):
 151     """Using given filename and prolog, write all generated suites.
 152
 153     :param in_filename: Template filename to derive real filenames from.
 154     :param in_prolog: Template content to derive real content from.
 155     :param kwargs_list: List of kwargs for add_default_testcase.
 156     :type in_filename: str
 157     :type in_prolog: str
 158     :type kwargs_list: list of dict
 159     """
 160     for suite_type in Constants.PERF_TYPE_TO_KEYWORD:
 161         tmp_filename = replace_defensively(
 162             in_filename, "ndrpdr", suite_type, 1,
 163             "File name should contain suite type once.", in_filename)
 164         tmp_prolog = replace_defensively(
 165             in_prolog, "ndrpdr".upper(), suite_type.upper(), 1,
 166             "Suite type should appear once in uppercase (as tag).",
 167             in_filename)
 168         tmp_prolog = replace_defensively(
 169             tmp_prolog,
 170             "Find NDR and PDR intervals using optimized search",
 171             Constants.PERF_TYPE_TO_KEYWORD[suite_type], 1,
 172             "Main search keyword should appear once in suite.",
 173             in_filename)
 174         tmp_prolog = replace_defensively(
 175             tmp_prolog,
 176             Constants.PERF_TYPE_TO_SUITE_DOC_VER["ndrpdr"],
 177             Constants.PERF_TYPE_TO_SUITE_DOC_VER[suite_type],
 178             1, "Exact suite type doc not found.", in_filename)
 179         tmp_prolog = replace_defensively(
 180             tmp_prolog,
 181             Constants.PERF_TYPE_TO_TEMPLATE_DOC_VER["ndrpdr"],
 182             Constants.PERF_TYPE_TO_TEMPLATE_DOC_VER[suite_type],
 183             1, "Exact template type doc not found.", in_filename)
 184         _, suite_id = get_iface_and_suite_id(tmp_filename)
 185         testcase = Testcase.default(suite_id)
 186         for nic_name in Constants.NIC_NAME_TO_CODE:
 187             out_filename = replace_defensively(
 188                 tmp_filename, "10ge2p1x710",
 189                 Constants.NIC_NAME_TO_CODE[nic_name], 1,
 190                 "File name should contain NIC code once.", in_filename)
 191             out_prolog = replace_defensively(
 192                 tmp_prolog, "Intel-X710", nic_name, 2,
 193                 "NIC name should appear twice (tag and variable).",
 194                 in_filename)
 195             if out_prolog.count("HW_") == 2:
 196                 # TODO CSIT-1481: Crypto HW should be read
 197                 # from topology file instead.
 198                 if nic_name in Constants.NIC_NAME_TO_CRYPTO_HW:
 199                     out_prolog = replace_defensively(
 200                         out_prolog, "HW_DH895xcc",
 201                         Constants.NIC_NAME_TO_CRYPTO_HW[nic_name], 1,
 202                         "HW crypto name should appear.", in_filename)
 203             iface, suite_id = get_iface_and_suite_id(out_filename)
 204             with open(out_filename, "w") as file_out:
 205                 file_out.write(out_prolog)
 206                 add_default_testcases(
 207                     testcase, iface, suite_id, file_out, kwargs_list)
 208
 209
 210 def write_reconf_files(in_filename, in_prolog, kwargs_list):
 211     """Using given filename and prolog, write all generated reconf suites.
 212
 213     Use this for suite type reconf, as its local template
 214     is incompatible with mrr/ndrpdr/soak local template,
 215     while test cases are compatible.
 216
 217     :param in_filename: Template filename to derive real filenames from.
 218     :param in_prolog: Template content to derive real content from.
 219     :param kwargs_list: List of kwargs for add_testcase.
 220     :type in_filename: str
 221     :type in_prolog: str
 222     :type kwargs_list: list of dict
 223     """
 224     _, suite_id = get_iface_and_suite_id(in_filename)
 225     testcase = Testcase.default(suite_id)
 226     for nic_name in Constants.NIC_NAME_TO_CODE:
 227         out_filename = replace_defensively(
 228             in_filename, "10ge2p1x710",
 229             Constants.NIC_NAME_TO_CODE[nic_name], 1,
 230             "File name should contain NIC code once.", in_filename)
 231         out_prolog = replace_defensively(
 232             in_prolog, "Intel-X710", nic_name, 2,
 233             "NIC name should appear twice (tag and variable).",
 234             in_filename)
 235         if out_prolog.count("HW_") == 2:
 236             # TODO CSIT-1481: Crypto HW should be read
 237             # from topology file instead.
 238             if nic_name in Constants.NIC_NAME_TO_CRYPTO_HW.keys():
 239                 out_prolog = replace_defensively(
 240                     out_prolog, "HW_DH895xcc",
 241                     Constants.NIC_NAME_TO_CRYPTO_HW[nic_name], 1,
 242                     "HW crypto name should appear.", in_filename)
 243         iface, suite_id = get_iface_and_suite_id(out_filename)
 244         with open(out_filename, "w") as file_out:
 245             file_out.write(out_prolog)
 246             add_default_testcases(
 247                 testcase, iface, suite_id, file_out, kwargs_list)
 248
 249
 250 def write_tcp_files(in_filename, in_prolog, kwargs_list):
 251     """Using given filename and prolog, write all generated tcp suites.
 252
 253     :param in_filename: Template filename to derive real filenames from.
 254     :param in_prolog: Template content to derive real content from.
 255     :param kwargs_list: List of kwargs for add_default_testcase.
 256     :type in_filename: str
 257     :type in_prolog: str
 258     :type kwargs_list: list of dict
 259     """
 260     # TODO: Generate rps from cps? There are subtle differences.
 261     _, suite_id = get_iface_and_suite_id(in_filename)
 262     testcase = Testcase.tcp(suite_id)
 263     for nic_name in Constants.NIC_NAME_TO_CODE:
 264         out_filename = replace_defensively(
 265             in_filename, "10ge2p1x710",
 266             Constants.NIC_NAME_TO_CODE[nic_name], 1,
 267             "File name should contain NIC code once.", in_filename)
 268         out_prolog = replace_defensively(
 269             in_prolog, "Intel-X710", nic_name, 2,
 270             "NIC name should appear twice (tag and variable).",
 271             in_filename)
 272         with open(out_filename, "w") as file_out:
 273             file_out.write(out_prolog)
 274             add_tcp_testcases(testcase, file_out, kwargs_list)
 275
 276
 277 class Regenerator(object):
 278     """Class containing file generating methods."""
 279
 280     def __init__(self, quiet=True):
 281         """Initialize the instance.
 282
 283         :param quiet: Reduce log prints (to stderr) when True (default).
 284         :type quiet: boolean
 285         """
 286         self.quiet = quiet
 287
 288     def regenerate_glob(self, pattern, protocol="ip4"):
 289         """Regenerate files matching glob pattern based on arguments.
 290
 291         In the current working directory, find all files matching
 292         the glob pattern. Use testcase template according to suffix
 293         to regenerate test cases, autonumbering them,
 294         taking arguments from list.
 295
 296         Log-like prints are emited to sys.stderr.
 297
 298         :param pattern: Glob pattern to select files. Example: *-ndrpdr.robot
 299         :param protocol: String determining minimal frame size. Default: "ip4"
 300         :type pattern: str
 301         :type protocol: str
 302         :raises RuntimeError: If invalid source suite is encountered.
 303         """
 304         if not self.quiet:
 305             eprint("Regenerator starts at {cwd}".format(cwd=getcwd()))
 306
 307         min_frame_size = PROTOCOL_TO_MIN_FRAME_SIZE[protocol]
 308         default_kwargs_list = [
 309             {"frame_size": min_frame_size, "phy_cores": 1},
 310             {"frame_size": min_frame_size, "phy_cores": 2},
 311             {"frame_size": min_frame_size, "phy_cores": 4},
 312             {"frame_size": 1518, "phy_cores": 1},
 313             {"frame_size": 1518, "phy_cores": 2},
 314             {"frame_size": 1518, "phy_cores": 4},
 315             {"frame_size": 9000, "phy_cores": 1},
 316             {"frame_size": 9000, "phy_cores": 2},
 317             {"frame_size": 9000, "phy_cores": 4},
 318             {"frame_size": "IMIX_v4_1", "phy_cores": 1},
 319             {"frame_size": "IMIX_v4_1", "phy_cores": 2},
 320             {"frame_size": "IMIX_v4_1", "phy_cores": 4}
 321         ]
 322         tcp_kwargs_list = [{"phy_cores": i, "frame_size": 0} for i in (1, 2, 4)]
 323         for in_filename in glob(pattern):
 324             if not self.quiet:
 325                 eprint("Regenerating in_filename:", in_filename)
 326             iface, _ = get_iface_and_suite_id(in_filename)
 327             if not iface.endswith("10ge2p1x710"):
 328                 raise RuntimeError(
 329                     "Error in {fil}: non-primary NIC found.".format(
 330                         fil=in_filename))
 331             with open(in_filename, "r") as file_in:
 332                 in_prolog = "".join(
 333                     file_in.read().partition("*** Test Cases ***")[:-1])
 334             if in_filename.endswith("-ndrpdr.robot"):
 335                 write_default_files(in_filename, in_prolog, default_kwargs_list)
 336             elif in_filename.endswith("-reconf.robot"):
 337                 write_reconf_files(in_filename, in_prolog, default_kwargs_list)
 338             elif in_filename[-10:] in ("-cps.robot", "-rps.robot"):
 339                 write_tcp_files(in_filename, in_prolog, tcp_kwargs_list)
 340             else:
 341                 raise RuntimeError(
 342                     "Error in {fil}: non-primary suite type found.".format(
 343                         fil=in_filename))
 344         if not self.quiet:
 345             eprint("Regenerator ends.")
 346         eprint()  # To make autogen check output more readable.