1 # Copyright (c) 2021 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.
16 TODO: How can we check each suite id is unique,
17 when currently the suite generation is run on each directory separately?
27 from resources.libraries.python.Constants import Constants
28 from resources.libraries.python.autogen.Testcase import Testcase
31 PROTOCOL_TO_MIN_FRAME_SIZE = {
34 u"ethip4vxlan": 114, # What is the real minimum for latency stream?
37 MIN_FRAME_SIZE_VALUES = list(PROTOCOL_TO_MIN_FRAME_SIZE.values())
40 def replace_defensively(
41 whole, to_replace, replace_with, how_many, msg, in_filename):
42 """Replace substrings while checking the number of occurrences.
44 Return edited copy of the text. Assuming "whole" is really a string,
45 or something else with .replace not affecting it.
47 :param whole: The text to perform replacements on.
48 :param to_replace: Substring occurrences of which to replace.
49 :param replace_with: Substring to replace occurrences with.
50 :param how_many: Number of occurrences to expect.
51 :param msg: Error message to raise.
52 :param in_filename: File name in which the error occurred.
55 :type replace_with: str
58 :type in_filename: str
59 :returns: The whole text after replacements are done.
61 :raises ValueError: If number of occurrences does not match.
63 found = whole.count(to_replace)
65 raise ValueError(f"{in_filename}: {msg}")
66 return whole.replace(to_replace, replace_with)
69 def get_iface_and_suite_ids(filename):
70 """Get NIC code, suite ID and suite tag.
72 NIC code is the part of suite name
73 which should be replaced for other NIC.
74 Suite ID is the part os suite name
75 which is appended to test case names.
76 Suite tag is suite ID without both test type and NIC driver parts.
78 :param filename: Suite file.
80 :returns: NIC code, suite ID, suite tag.
81 :rtype: 3-tuple of str
83 dash_split = filename.split(u"-", 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(u"-", 1)
87 nic_code = dash_split[0]
88 suite_id = dash_split[1].split(u".robot", 1)[0]
89 suite_tag = suite_id.rsplit(u"-", 1)[0]
90 for prefix in Constants.FORBIDDEN_SUITE_PREFIX_LIST:
91 if suite_tag.startswith(prefix):
92 suite_tag = suite_tag[len(prefix):]
93 return nic_code, suite_id, suite_tag
96 def check_suite_tag(suite_tag, prolog):
97 """Verify suite tag occurres once in prolog.
99 Call this after all edits are done,
100 to confirm the (edited) suite tag still matches the (edited) suite name.
102 Currently, the edited suite tag is expect to be identical
103 to the primary suite tag, but having a function is more flexible.
105 The occurences are counted including "| " prefix,
106 to lower the chance to match a comment.
108 :param suite_tag: Part of suite name, between NIC driver and suite type.
109 :param prolog: The part of .robot file content without test cases.
112 :raises ValueError: If suite_tag not found exactly once.
114 found = prolog.count(u"| " + suite_tag)
116 raise ValueError(f"Suite tag found {found} times for {suite_tag}")
119 def add_default_testcases(testcase, iface, suite_id, file_out, tc_kwargs_list):
120 """Add default testcases to file.
122 :param testcase: Testcase class.
123 :param iface: Interface.
124 :param suite_id: Suite ID.
125 :param file_out: File to write testcases to.
126 :param tc_kwargs_list: Key-value pairs used to construct testcases.
127 :type testcase: Testcase
131 :type tc_kwargs_list: dict
133 for kwargs in tc_kwargs_list:
134 # TODO: Is there a better way to disable some combinations?
136 if kwargs[u"frame_size"] == 9000:
137 if u"vic1227" in iface:
138 # Not supported in HW.
140 if u"vic1385" in iface:
141 # Not supported in HW.
143 if u"-16vm2t-" in suite_id or u"-16dcr2t-" in suite_id:
144 if kwargs[u"phy_cores"] > 3:
145 # CSIT lab only has 28 (physical) core processors,
146 # so these test would fail when attempting to assign cores.
148 if u"-24vm1t-" in suite_id or u"-24dcr1t-" in suite_id:
149 if kwargs[u"phy_cores"] > 3:
150 # CSIT lab only has 28 (physical) core processors,
151 # so these test would fail when attempting to assign cores.
153 if u"soak" in suite_id:
154 # Soak test take too long, do not risk other than tc01.
155 if kwargs[u"phy_cores"] != 1:
157 if kwargs[u"frame_size"] not in MIN_FRAME_SIZE_VALUES:
161 or u"-pps-" in suite_id
162 or u"-tput-" in suite_id
164 if kwargs[u"frame_size"] not in MIN_FRAME_SIZE_VALUES:
167 file_out.write(testcase.generate(**kwargs))
170 def add_tcp_testcases(testcase, file_out, tc_kwargs_list):
171 """Add TCP testcases to file.
173 :param testcase: Testcase class.
174 :param file_out: File to write testcases to.
175 :param tc_kwargs_list: Key-value pairs used to construct testcases.
176 :type testcase: Testcase
178 :type tc_kwargs_list: dict
180 for kwargs in tc_kwargs_list:
181 file_out.write(testcase.generate(**kwargs))
184 def add_iperf3_testcases(testcase, file_out, tc_kwargs_list):
185 """Add iperf3 testcases to file.
187 :param testcase: Testcase class.
188 :param file_out: File to write testcases to.
189 :param tc_kwargs_list: Key-value pairs used to construct testcases.
190 :type testcase: Testcase
192 :type tc_kwargs_list: dict
194 for kwargs in tc_kwargs_list:
195 file_out.write(testcase.generate(**kwargs))
198 def write_default_files(in_filename, in_prolog, kwargs_list):
199 """Using given filename and prolog, write all generated suites.
201 :param in_filename: Template filename to derive real filenames from.
202 :param in_prolog: Template content to derive real content from.
203 :param kwargs_list: List of kwargs for add_default_testcase.
204 :type in_filename: str
206 :type kwargs_list: list of dict
208 for suite_type in Constants.PERF_TYPE_TO_KEYWORD:
209 tmp_filename = replace_defensively(
210 in_filename, u"ndrpdr", suite_type, 1,
211 u"File name should contain suite type once.", in_filename
213 tmp_prolog = replace_defensively(
214 in_prolog, u"ndrpdr".upper(), suite_type.upper(), 1,
215 u"Suite type should appear once in uppercase (as tag).",
218 tmp_prolog = replace_defensively(
220 u"Find NDR and PDR intervals using optimized search",
221 Constants.PERF_TYPE_TO_KEYWORD[suite_type], 1,
222 u"Main search keyword should appear once in suite.",
225 tmp_prolog = replace_defensively(
227 Constants.PERF_TYPE_TO_SUITE_DOC_VER[u"ndrpdr"],
228 Constants.PERF_TYPE_TO_SUITE_DOC_VER[suite_type],
229 1, u"Exact suite type doc not found.", in_filename
231 tmp_prolog = replace_defensively(
233 Constants.PERF_TYPE_TO_TEMPLATE_DOC_VER[u"ndrpdr"],
234 Constants.PERF_TYPE_TO_TEMPLATE_DOC_VER[suite_type],
235 1, u"Exact template type doc not found.", in_filename
237 _, suite_id, _ = get_iface_and_suite_ids(tmp_filename)
238 testcase = Testcase.default(suite_id)
239 for nic_name in Constants.NIC_NAME_TO_CODE:
240 tmp2_filename = replace_defensively(
241 tmp_filename, u"10ge2p1x710",
242 Constants.NIC_NAME_TO_CODE[nic_name], 1,
243 u"File name should contain NIC code once.", in_filename
245 tmp2_prolog = replace_defensively(
246 tmp_prolog, u"Intel-X710", nic_name, 2,
247 u"NIC name should appear twice (tag and variable).",
250 if tmp2_prolog.count(u"HW_") == 2:
251 # TODO CSIT-1481: Crypto HW should be read
252 # from topology file instead.
253 if nic_name in Constants.NIC_NAME_TO_CRYPTO_HW:
254 tmp2_prolog = replace_defensively(
255 tmp2_prolog, u"HW_DH895xcc",
256 Constants.NIC_NAME_TO_CRYPTO_HW[nic_name], 1,
257 u"HW crypto name should appear.", in_filename
259 iface, old_suite_id, old_suite_tag = get_iface_and_suite_ids(
262 if u"DPDK" in in_prolog:
263 for driver in Constants.DPDK_NIC_NAME_TO_DRIVER[nic_name]:
264 out_filename = replace_defensively(
265 tmp2_filename, old_suite_id,
266 Constants.DPDK_NIC_DRIVER_TO_SUITE_PREFIX[driver] \
268 1, u"Error adding driver prefix.", in_filename
270 out_prolog = replace_defensively(
271 tmp2_prolog, u"vfio-pci", driver, 1,
272 u"Driver name should appear once.", in_filename
274 out_prolog = replace_defensively(
276 Constants.DPDK_NIC_DRIVER_TO_TAG[u"vfio-pci"],
277 Constants.DPDK_NIC_DRIVER_TO_TAG[driver], 1,
278 u"Driver tag should appear once.", in_filename
280 iface, suite_id, suite_tag = get_iface_and_suite_ids(
283 # The next replace is probably a noop, but it is safer to
284 # maintain the same structure as for other edits.
285 out_prolog = replace_defensively(
286 out_prolog, old_suite_tag, suite_tag, 1,
287 f"Perf suite tag {old_suite_tag} should appear once.",
290 check_suite_tag(suite_tag, out_prolog)
291 # TODO: Reorder loops so suite_id is finalized sooner.
292 testcase = Testcase.default(suite_id)
293 with open(out_filename, u"wt") as file_out:
294 file_out.write(out_prolog)
295 add_default_testcases(
296 testcase, iface, suite_id, file_out, kwargs_list
299 for driver in Constants.NIC_NAME_TO_DRIVER[nic_name]:
300 out_filename = replace_defensively(
301 tmp2_filename, old_suite_id,
302 Constants.NIC_DRIVER_TO_SUITE_PREFIX[driver] + old_suite_id,
303 1, u"Error adding driver prefix.", in_filename
305 out_prolog = replace_defensively(
306 tmp2_prolog, u"vfio-pci", driver, 1,
307 u"Driver name should appear once.", in_filename
309 out_prolog = replace_defensively(
310 out_prolog, Constants.NIC_DRIVER_TO_TAG[u"vfio-pci"],
311 Constants.NIC_DRIVER_TO_TAG[driver], 1,
312 u"Driver tag should appear once.", in_filename
314 out_prolog = replace_defensively(
315 out_prolog, Constants.NIC_DRIVER_TO_PLUGINS[u"vfio-pci"],
316 Constants.NIC_DRIVER_TO_PLUGINS[driver], 1,
317 u"Driver plugin should appear once.", in_filename
319 out_prolog = replace_defensively(
320 out_prolog, Constants.NIC_DRIVER_TO_VFS[u"vfio-pci"],
321 Constants.NIC_DRIVER_TO_VFS[driver], 1,
322 u"NIC VFs argument should appear once.", in_filename
324 iface, suite_id, suite_tag = get_iface_and_suite_ids(
327 # The next replace is probably a noop, but it is safer to
328 # maintain the same structure as for other edits.
329 out_prolog = replace_defensively(
330 out_prolog, old_suite_tag, suite_tag, 1,
331 f"Perf suite tag {old_suite_tag} should appear once.",
334 check_suite_tag(suite_tag, out_prolog)
335 # TODO: Reorder loops so suite_id is finalized sooner.
336 testcase = Testcase.default(suite_id)
337 with open(out_filename, u"wt") as file_out:
338 file_out.write(out_prolog)
339 add_default_testcases(
340 testcase, iface, suite_id, file_out, kwargs_list
344 def write_reconf_files(in_filename, in_prolog, kwargs_list):
345 """Using given filename and prolog, write all generated reconf suites.
347 Use this for suite type reconf, as its local template
348 is incompatible with mrr/ndrpdr/soak local template,
349 while test cases are compatible.
351 :param in_filename: Template filename to derive real filenames from.
352 :param in_prolog: Template content to derive real content from.
353 :param kwargs_list: List of kwargs for add_testcase.
354 :type in_filename: str
356 :type kwargs_list: list of dict
358 _, suite_id, _ = get_iface_and_suite_ids(in_filename)
359 testcase = Testcase.default(suite_id)
360 for nic_name in Constants.NIC_NAME_TO_CODE:
361 tmp_filename = replace_defensively(
362 in_filename, u"10ge2p1x710",
363 Constants.NIC_NAME_TO_CODE[nic_name], 1,
364 u"File name should contain NIC code once.", in_filename
366 tmp_prolog = replace_defensively(
367 in_prolog, u"Intel-X710", nic_name, 2,
368 u"NIC name should appear twice (tag and variable).",
371 if tmp_prolog.count(u"HW_") == 2:
372 # TODO CSIT-1481: Crypto HW should be read
373 # from topology file instead.
374 if nic_name in Constants.NIC_NAME_TO_CRYPTO_HW.keys():
375 tmp_prolog = replace_defensively(
376 tmp_prolog, u"HW_DH895xcc",
377 Constants.NIC_NAME_TO_CRYPTO_HW[nic_name], 1,
378 u"HW crypto name should appear.", in_filename
380 iface, old_suite_id, old_suite_tag = get_iface_and_suite_ids(
383 for driver in Constants.NIC_NAME_TO_DRIVER[nic_name]:
384 out_filename = replace_defensively(
385 tmp_filename, old_suite_id,
386 Constants.NIC_DRIVER_TO_SUITE_PREFIX[driver] + old_suite_id,
387 1, u"Error adding driver prefix.", in_filename
389 out_prolog = replace_defensively(
390 tmp_prolog, u"vfio-pci", driver, 1,
391 u"Driver name should appear once.", in_filename
393 out_prolog = replace_defensively(
394 out_prolog, Constants.NIC_DRIVER_TO_TAG[u"vfio-pci"],
395 Constants.NIC_DRIVER_TO_TAG[driver], 1,
396 u"Driver tag should appear once.", in_filename
398 out_prolog = replace_defensively(
399 out_prolog, Constants.NIC_DRIVER_TO_PLUGINS[u"vfio-pci"],
400 Constants.NIC_DRIVER_TO_PLUGINS[driver], 1,
401 u"Driver plugin should appear once.", in_filename
403 out_prolog = replace_defensively(
404 out_prolog, Constants.NIC_DRIVER_TO_VFS[u"vfio-pci"],
405 Constants.NIC_DRIVER_TO_VFS[driver], 1,
406 u"NIC VFs argument should appear once.", in_filename
408 iface, suite_id, suite_tag = get_iface_and_suite_ids(out_filename)
409 out_prolog = replace_defensively(
410 out_prolog, old_suite_tag, suite_tag, 1,
411 u"Perf suite tag should appear once.", in_filename
413 check_suite_tag(suite_tag, out_prolog)
414 # TODO: Reorder loops so suite_id is finalized sooner.
415 testcase = Testcase.default(suite_id)
416 with open(out_filename, u"wt") as file_out:
417 file_out.write(out_prolog)
418 add_default_testcases(
419 testcase, iface, suite_id, file_out, kwargs_list
423 def write_tcp_files(in_filename, in_prolog, kwargs_list):
424 """Using given filename and prolog, write all generated tcp suites.
426 TODO: Suport drivers.
428 :param in_filename: Template filename to derive real filenames from.
429 :param in_prolog: Template content to derive real content from.
430 :param kwargs_list: List of kwargs for add_default_testcase.
431 :type in_filename: str
433 :type kwargs_list: list of dict
435 # TODO: Generate rps from cps? There are subtle differences.
436 _, suite_id, suite_tag = get_iface_and_suite_ids(in_filename)
437 testcase = Testcase.tcp(suite_id)
438 for nic_name in Constants.NIC_NAME_TO_CODE:
439 out_filename = replace_defensively(
440 in_filename, u"10ge2p1x710",
441 Constants.NIC_NAME_TO_CODE[nic_name], 1,
442 u"File name should contain NIC code once.", in_filename
444 out_prolog = replace_defensively(
445 in_prolog, u"Intel-X710", nic_name, 2,
446 u"NIC name should appear twice (tag and variable).",
449 check_suite_tag(suite_tag, out_prolog)
450 with open(out_filename, u"wt") as file_out:
451 file_out.write(out_prolog)
452 add_tcp_testcases(testcase, file_out, kwargs_list)
455 def write_iperf3_files(in_filename, in_prolog, kwargs_list):
456 """Using given filename and prolog, write all generated iperf3 suites.
458 :param in_filename: Template filename to derive real filenames from.
459 :param in_prolog: Template content to derive real content from.
460 :param kwargs_list: List of kwargs for add_default_testcase.
461 :type in_filename: str
463 :type kwargs_list: list of dict
465 _, suite_id, suite_tag = get_iface_and_suite_ids(in_filename)
466 testcase = Testcase.iperf3(suite_id)
467 out_filename = replace_defensively(
468 in_filename, u"10ge2p1x710",
469 Constants.NIC_NAME_TO_CODE[u"Intel-X710"], 1,
470 u"File name should contain NIC code once.", in_filename
472 out_prolog = replace_defensively(
473 in_prolog, u"Intel-X710", u"Intel-X710", 2,
474 u"NIC name should appear twice (tag and variable).",
477 check_suite_tag(suite_tag, out_prolog)
478 with open(out_filename, u"wt") as file_out:
479 file_out.write(out_prolog)
480 add_iperf3_testcases(testcase, file_out, kwargs_list)
484 """Class containing file generating methods."""
486 def __init__(self, quiet=True):
487 """Initialize the instance.
489 :param quiet: Reduce log prints (to stderr) when True (default).
494 def regenerate_glob(self, pattern, protocol=u"ip4"):
495 """Regenerate files matching glob pattern based on arguments.
497 In the current working directory, find all files matching
498 the glob pattern. Use testcase template to regenerate test cases
499 according to suffix, governed by protocol, autonumbering them.
500 Also generate suites for other NICs and drivers.
502 Log-like prints are emitted to sys.stderr.
504 :param pattern: Glob pattern to select files. Example: *-ndrpdr.robot
505 :param protocol: String determining minimal frame size. Default: "ip4"
508 :raises RuntimeError: If invalid source suite is encountered.
511 print(f"Regenerator starts at {getcwd()}", file=sys.stderr)
513 min_frame_size = PROTOCOL_TO_MIN_FRAME_SIZE[protocol]
514 default_kwargs_list = [
515 {u"frame_size": min_frame_size, u"phy_cores": 1},
516 {u"frame_size": min_frame_size, u"phy_cores": 2},
517 {u"frame_size": min_frame_size, u"phy_cores": 4},
518 {u"frame_size": 1518, u"phy_cores": 1},
519 {u"frame_size": 1518, u"phy_cores": 2},
520 {u"frame_size": 1518, u"phy_cores": 4},
521 {u"frame_size": 9000, u"phy_cores": 1},
522 {u"frame_size": 9000, u"phy_cores": 2},
523 {u"frame_size": 9000, u"phy_cores": 4},
524 {u"frame_size": u"IMIX_v4_1", u"phy_cores": 1},
525 {u"frame_size": u"IMIX_v4_1", u"phy_cores": 2},
526 {u"frame_size": u"IMIX_v4_1", u"phy_cores": 4}
528 hs_bps_kwargs_list = [
529 {u"frame_size": 1460, u"phy_cores": 1},
531 hs_quic_kwargs_list = [
532 {u"frame_size": 1280, u"phy_cores": 1},
534 iperf3_kwargs_list = [
535 {u"frame_size": 128000, u"phy_cores": 1},
536 {u"frame_size": 128000, u"phy_cores": 2},
537 {u"frame_size": 128000, u"phy_cores": 4}
539 # List for tests with one dataplane core
540 # (and variable number of other cores).
542 {u"frame_size": min_frame_size, u"phy_cores": 2},
543 {u"frame_size": min_frame_size, u"phy_cores": 3},
544 {u"frame_size": min_frame_size, u"phy_cores": 4},
545 {u"frame_size": 1518, u"phy_cores": 2},
546 {u"frame_size": 1518, u"phy_cores": 3},
547 {u"frame_size": 1518, u"phy_cores": 4},
548 {u"frame_size": 9000, u"phy_cores": 2},
549 {u"frame_size": 9000, u"phy_cores": 3},
550 {u"frame_size": 9000, u"phy_cores": 4},
551 {u"frame_size": u"IMIX_v4_1", u"phy_cores": 2},
552 {u"frame_size": u"IMIX_v4_1", u"phy_cores": 3},
553 {u"frame_size": u"IMIX_v4_1", u"phy_cores": 4}
557 {u"frame_size": 0, u"phy_cores": 1},
558 {u"frame_size": 0, u"phy_cores": 2},
559 {u"frame_size": 64, u"phy_cores": 1},
560 {u"frame_size": 64, u"phy_cores": 2},
561 {u"frame_size": 1024, u"phy_cores": 1},
562 {u"frame_size": 1024, u"phy_cores": 2},
563 {u"frame_size": 2048, u"phy_cores": 1},
564 {u"frame_size": 2048, u"phy_cores": 2}
567 for in_filename in glob(pattern):
570 u"Regenerating in_filename:", in_filename, file=sys.stderr
572 iface, _, _ = get_iface_and_suite_ids(in_filename)
573 if not iface.endswith(u"10ge2p1x710"):
575 f"Error in {in_filename}: non-primary NIC found."
577 for prefix in Constants.FORBIDDEN_SUITE_PREFIX_LIST:
578 if prefix in in_filename:
580 f"Error in {in_filename}: non-primary driver found."
582 with open(in_filename, u"rt") as file_in:
583 in_prolog = u"".join(
584 file_in.read().partition(u"*** Test Cases ***")[:-1]
586 if in_filename.endswith(u"-ndrpdr.robot"):
587 if u"scheduler" in in_filename:
589 in_filename, in_prolog, dp1_kwargs_list
593 in_filename, in_prolog, default_kwargs_list
595 elif in_filename.endswith(u"-reconf.robot"):
596 write_reconf_files(in_filename, in_prolog, default_kwargs_list)
597 elif in_filename.endswith(u"-rps.robot") \
598 or in_filename.endswith(u"-cps.robot"):
599 write_tcp_files(in_filename, in_prolog, http_kwargs_list)
600 elif in_filename.endswith(u"-bps.robot"):
601 hoststack_kwargs_list = \
602 hs_quic_kwargs_list if u"quic" in in_filename \
603 else hs_bps_kwargs_list
604 write_tcp_files(in_filename, in_prolog, hoststack_kwargs_list)
605 elif in_filename.endswith(u"-iperf3-mrr.robot"):
606 write_iperf3_files(in_filename, in_prolog, iperf3_kwargs_list)
609 f"Error in {in_filename}: non-primary suite type found."
612 print(u"Regenerator ends.", file=sys.stderr)
613 print(file=sys.stderr) # To make autogen check output more readable.