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:
6 # http://www.apache.org/licenses/LICENSE-2.0
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.
14 """Module defining utilities for test directory regeneration."""
19 from .Testcase import Testcase
20 from .DefaultTestcase import DefaultTestcase
23 class Regenerator(object):
24 """Class containing file generating methods."""
26 def __init__(self, testcase_class=DefaultTestcase):
27 """Initialize Testcase class to use.
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.
33 :param testcase_class: Subclass of DefaultTestcase for generation.
34 Default: DefaultTestcase
35 :type testcase_class: subclass of DefaultTestcase accepting suite_id
37 self.testcase_class = testcase_class
39 def regenerate_glob(self, pattern, protocol="ip4", tc_kwargs_list=None):
40 """Regenerate files matching glob pattern based on arguments.
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.
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".
56 :type tc_kwargs_list: list of tuple or None
59 protocol_to_min_framesize = {
65 def get_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[1].split(".", 1)[0]
72 def add_testcase(file_out, num, **kwargs):
73 file_out.write(testcase.generate(num=num, **kwargs))
76 def add_testcases(file_out, tc_kwargs_list):
78 for tc_kwargs in tc_kwargs_list:
79 num = add_testcase(file_out, num, **tc_kwargs)
81 print "Regenerator starts at {cwd}".format(cwd=getcwd())
82 min_framesize = protocol_to_min_framesize[protocol]
83 kwargs_list = tc_kwargs_list if tc_kwargs_list else [
84 {"framesize": min_framesize, "phy_cores": 1},
85 {"framesize": min_framesize, "phy_cores": 2},
86 {"framesize": min_framesize, "phy_cores": 4},
87 {"framesize": 1518, "phy_cores": 1},
88 {"framesize": 1518, "phy_cores": 2},
89 {"framesize": 1518, "phy_cores": 4},
90 {"framesize": 9000, "phy_cores": 1},
91 {"framesize": 9000, "phy_cores": 2},
92 {"framesize": 9000, "phy_cores": 4},
93 {"framesize": "IMIX_v4_1", "phy_cores": 1},
94 {"framesize": "IMIX_v4_1", "phy_cores": 2},
95 {"framesize": "IMIX_v4_1", "phy_cores": 4}
97 for filename in glob(pattern):
98 with open(filename, "r") as file_in:
100 text_prolog = "".join(text.partition("*** Test Cases ***")[:-1])
101 # TODO: Make the following work for 2n suites.
102 suite_id = get_suite_id(filename)
103 print "Regenerating suite_id:", suite_id
104 testcase = self.testcase_class(suite_id)
105 with open(filename, "w") as file_out:
106 file_out.write(text_prolog)
107 add_testcases(file_out, kwargs_list)
108 print "Regenerator ends."
109 print # To make autogen check output more readable.