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 .DefaultTestcase import DefaultTestcase
  23
  24
  25 # Copied from https://stackoverflow.com/a/14981125
  26 def eprint(*args, **kwargs):
  27     """Print to stderr."""
  28     print(*args, file=sys.stderr, **kwargs)
  29
  30
  31 class Regenerator(object):
  32     """Class containing file generating methods."""
  33
  34     def __init__(self, testcase_class=DefaultTestcase, quiet=True):
  35         """Initialize Testcase class to use.
  36
  37         TODO: See the type doc for testcase_class?
  38         It implies the design is wrong. Fix it.
  39         Easiest: Hardcode Regenerator to use DefaultTestcase only.
  40
  41         :param testcase_class: Subclass of DefaultTestcase for generation.
  42             Default: DefaultTestcase
  43         :param quiet: Reduce log prints (to stderr) when True (default).
  44         :type testcase_class: subclass of DefaultTestcase accepting suite_id
  45         :type quiet: boolean
  46         """
  47         self.testcase_class = testcase_class
  48         self.quiet = quiet
  49
  50     def regenerate_glob(self, pattern, protocol="ip4", tc_kwargs_list=None):
  51         """Regenerate files matching glob pattern based on arguments.
  52
  53         In the current working directory, find all files matching
  54         the glob pattern. Use testcase template (from init) to regenerate
  55         test cases, autonumbering them, taking arguments from list.
  56         If the list is None, use default list, which depends on ip6 usage.
  57
  58         Log-like prints are emited to sys.stderr.
  59
  60         :param pattern: Glob pattern to select files. Example: *-ndrpdr.robot
  61         :param is_ip6: Flag determining minimal frame size. Default: False
  62         :param tc_kwargs_list: Arguments defining the testcases. Default: None
  63             When None, default list is used.
  64             List item is a dict, argument names are keys.
  65             The initialized testcase_class should accept those, and "num".
  66             DefaultTestcase accepts "framesize" and "phy_cores".
  67         :type pattern: str
  68         :type is_ip6: boolean
  69         :type tc_kwargs_list: list of tuple or None
  70         """
  71
  72         protocol_to_min_framesize = {
  73             "ip4": 64,
  74             "ip6": 78,
  75             "vxlan+ip4": 114  # What is the real minimum for latency stream?
  76         }
  77
  78         def get_iface_and_suite_id(filename):
  79             """Get interface and suite ID.
  80
  81             :param filename: Suite file.
  82             :type filename: str
  83             :returns: Interface ID, Suite ID.
  84             :rtype: tuple
  85             """
  86             dash_split = filename.split("-", 1)
  87             if len(dash_split[0]) <= 4:
  88                 # It was something like "2n1l", we need one more split.
  89                 dash_split = dash_split[1].split("-", 1)
  90             return dash_split[0], dash_split[1].split(".", 1)[0]
  91
  92         def add_testcase(testcase, iface, suite_id, file_out, num, **kwargs):
  93             """Add testcase to file.
  94
  95             :param testcase: Testcase class.
  96             :param iface: Interface.
  97             :param suite_id: Suite ID.
  98             :param file_out: File to write testcases to.
  99             :param num: Testcase number.
 100             :param kwargs: Key-value pairs used to construct testcase.
 101             :type testcase: Testcase
 102             :type iface: str
 103             :type suite_id: str
 104             :type file_out: file
 105             :type num: int
 106             :type kwargs: dict
 107             :returns: Next testcase number.
 108             :rtype: int
 109             """
 110             # TODO: Is there a better way to disable some combinations?
 111             if kwargs["framesize"] == 9000 and "vic1227" in iface:
 112                 # Not supported in HW.
 113                 pass
 114             elif kwargs["framesize"] == 9000 and "avf" in suite_id:
 115                 # Not supported by AVF driver.
 116                 # https://git.fd.io/vpp/tree/src/plugins/avf/README.md
 117                 pass
 118             elif ("soak" in suite_id and
 119                   (kwargs["phy_cores"] != 1
 120                    or kwargs["framesize"] in (1518, 9000, "IMIX_v4_1"))):
 121                 # Soak test take too long, do not risk other than tc01.
 122                 pass
 123             else:
 124                 file_out.write(testcase.generate(num=num, **kwargs))
 125             return num + 1
 126
 127         def add_testcases(testcase, iface, suite_id, file_out, tc_kwargs_list):
 128             """Add testcases to file.
 129
 130             :param testcase: Testcase class.
 131             :param iface: Interface.
 132             :param suite_id: Suite ID.
 133             :param file_out: File to write testcases to.
 134             :param tc_kwargs_list: Key-value pairs used to construct testcases.
 135             :type testcase: Testcase
 136             :type iface: str
 137             :type suite_id: str
 138             :type file_out: file
 139             :type tc_kwargs_list: dict
 140             """
 141             num = 1
 142             for tc_kwargs in tc_kwargs_list:
 143                 num = add_testcase(testcase, iface, suite_id, file_out, num,
 144                                    **tc_kwargs)
 145
 146         if not self.quiet:
 147             eprint("Regenerator starts at {cwd}".format(cwd=getcwd()))
 148         min_framesize = protocol_to_min_framesize[protocol]
 149         kwargs_list = tc_kwargs_list if tc_kwargs_list else [
 150             {"framesize": min_framesize, "phy_cores": 1},
 151             {"framesize": min_framesize, "phy_cores": 2},
 152             {"framesize": min_framesize, "phy_cores": 4},
 153             {"framesize": 1518, "phy_cores": 1},
 154             {"framesize": 1518, "phy_cores": 2},
 155             {"framesize": 1518, "phy_cores": 4},
 156             {"framesize": 9000, "phy_cores": 1},
 157             {"framesize": 9000, "phy_cores": 2},
 158             {"framesize": 9000, "phy_cores": 4},
 159             {"framesize": "IMIX_v4_1", "phy_cores": 1},
 160             {"framesize": "IMIX_v4_1", "phy_cores": 2},
 161             {"framesize": "IMIX_v4_1", "phy_cores": 4}
 162         ]
 163         for filename in glob(pattern):
 164             if not self.quiet:
 165                 eprint("Regenerating filename:", filename)
 166             with open(filename, "r") as file_in:
 167                 text = file_in.read()
 168                 text_prolog = "".join(text.partition("*** Test Cases ***")[:-1])
 169             iface, suite_id = get_iface_and_suite_id(filename)
 170             testcase = self.testcase_class(suite_id)
 171             with open(filename, "w") as file_out:
 172                 file_out.write(text_prolog)
 173                 add_testcases(testcase, iface, suite_id, file_out, kwargs_list)
 174         if not self.quiet:
 175             eprint("Regenerator ends.")
 176         eprint()  # To make autogen check output more readable.