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