resources/libraries/python/autogen/Regenerator.py

   1 # Copyright (c) 2018 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 glob import glob
  17 from os import getcwd
  18
  19 from .Testcase import Testcase
  20 from .DefaultTestcase import DefaultTestcase
  21
  22
  23 class Regenerator(object):
  24     """Class containing file generating methods."""
  25
  26     def __init__(self, testcase_class=DefaultTestcase):
  27         """Initialize Testcase class to use.
  28
  29         TODO: See the type doc for testcase_class?
  30         It implies the design is wrong. Fix it.
  31         Easiest: Hardcode Regenerator to use DefaultTestcase only.
  32
  33         :param testcase_class: Subclass of DefaultTestcase for generation.
  34             Default: DefaultTestcase
  35         :type testcase_class: subclass of DefaultTestcase accepting suite_id
  36         """
  37         self.testcase_class = testcase_class
  38
  39     def regenerate_glob(self, pattern, protocol="ip4", tc_kwargs_list=None):
  40         """Regenerate files matching glob pattern based on arguments.
  41
  42         In the current working directory, find all files matching
  43         the glob pattern. Use testcase template (from init) to regenerate
  44         test cases, autonumbering them, taking arguments from list.
  45         If the list is None, use default list, which depends on ip6 usage.
  46
  47         :param pattern: Glob pattern to select files. Example: *-ndrpdr.robot
  48         :param is_ip6: Flag determining minimal frame size. Default: False
  49         :param tc_kwargs_list: Arguments defining the testcases. Default: None
  50             When None, default list is used.
  51             List item is a dict, argument names are keys.
  52             The initialized testcase_class should accept those, and "num".
  53             DefaultTestcase accepts "framesize" and "phy_cores".
  54         :type pattern: str
  55         :type is_ip6: boolean
  56         :type tc_kwargs_list: list of tuple or None
  57         """
  58
  59         protocol_to_min_framesize = {
  60             "ip4": 64,
  61             "ip6": 78,
  62             "vxlan+ip4": 114  # What is the real minimum for latency stream?
  63         }
  64
  65         def get_iface_and_suite_id(filename):
  66             dash_split = filename.split("-", 1)
  67             if len(dash_split[0]) <= 4:
  68                 # It was something like "2n1l", we need one more split.
  69                 dash_split = dash_split[1].split("-", 1)
  70             return dash_split[0], dash_split[1].split(".", 1)[0]
  71
  72         def add_testcase(testcase, iface, file_out, num, **kwargs):
  73             # TODO: Is there a better way to disable some combinations?
  74             if kwargs["framesize"] != 9000 or "vic1227" not in iface:
  75                 file_out.write(testcase.generate(num=num, **kwargs))
  76             return num + 1
  77
  78         def add_testcases(testcase, iface, file_out, tc_kwargs_list):
  79             num = 1
  80             for tc_kwargs in tc_kwargs_list:
  81                 num = add_testcase(testcase, iface, file_out, num, **tc_kwargs)
  82
  83         print "Regenerator starts at {cwd}".format(cwd=getcwd())
  84         min_framesize = protocol_to_min_framesize[protocol]
  85         kwargs_list = tc_kwargs_list if tc_kwargs_list else [
  86             {"framesize": min_framesize, "phy_cores": 1},
  87             {"framesize": min_framesize, "phy_cores": 2},
  88             {"framesize": min_framesize, "phy_cores": 4},
  89             {"framesize": 1518, "phy_cores": 1},
  90             {"framesize": 1518, "phy_cores": 2},
  91             {"framesize": 1518, "phy_cores": 4},
  92             {"framesize": 9000, "phy_cores": 1},
  93             {"framesize": 9000, "phy_cores": 2},
  94             {"framesize": 9000, "phy_cores": 4},
  95             {"framesize": "IMIX_v4_1", "phy_cores": 1},
  96             {"framesize": "IMIX_v4_1", "phy_cores": 2},
  97             {"framesize": "IMIX_v4_1", "phy_cores": 4}
  98         ]
  99         for filename in glob(pattern):
 100             print "Regenerating filename:", filename
 101             with open(filename, "r") as file_in:
 102                 text = file_in.read()
 103                 text_prolog = "".join(text.partition("*** Test Cases ***")[:-1])
 104             iface, suite_id = get_iface_and_suite_id(filename)
 105             testcase = self.testcase_class(suite_id)
 106             with open(filename, "w") as file_out:
 107                 file_out.write(text_prolog)
 108                 add_testcases(testcase, iface, file_out, kwargs_list)
 109         print "Regenerator ends."
 110         print  # To make autogen check output more readable.