-# Copyright (c) 2018 Cisco and/or its affiliates.
+# Copyright (c) 2019 Cisco and/or its affiliates.
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at:
"""Module defining utilities for test directory regeneration."""
+from __future__ import print_function
+
from glob import glob
from os import getcwd
+import sys
-from .Testcase import Testcase
from .DefaultTestcase import DefaultTestcase
+# Copied from https://stackoverflow.com/a/14981125
+def eprint(*args, **kwargs):
+ """Print to stderr."""
+ print(*args, file=sys.stderr, **kwargs)
+
+
class Regenerator(object):
"""Class containing file generating methods."""
- def __init__(self, testcase_class=DefaultTestcase):
+ def __init__(self, testcase_class=DefaultTestcase, quiet=True):
"""Initialize Testcase class to use.
TODO: See the type doc for testcase_class?
:param testcase_class: Subclass of DefaultTestcase for generation.
Default: DefaultTestcase
+ :param quiet: Reduce log prints (to stderr) when True (default).
:type testcase_class: subclass of DefaultTestcase accepting suite_id
+ :type quiet: boolean
"""
self.testcase_class = testcase_class
+ self.quiet = quiet
def regenerate_glob(self, pattern, protocol="ip4", tc_kwargs_list=None):
"""Regenerate files matching glob pattern based on arguments.
test cases, autonumbering them, taking arguments from list.
If the list is None, use default list, which depends on ip6 usage.
+ Log-like prints are emited to sys.stderr.
+
:param pattern: Glob pattern to select files. Example: *-ndrpdr.robot
:param is_ip6: Flag determining minimal frame size. Default: False
:param tc_kwargs_list: Arguments defining the testcases. Default: None
"ip6": 78,
"vxlan+ip4": 114 # What is the real minimum for latency stream?
}
+ min_framesize_values = protocol_to_min_framesize.values()
def get_iface_and_suite_id(filename):
+ """Get interface and suite ID.
+
+ :param filename: Suite file.
+ :type filename: str
+ :returns: Interface ID, Suite ID.
+ :rtype: tuple
+ """
dash_split = filename.split("-", 1)
if len(dash_split[0]) <= 4:
# It was something like "2n1l", we need one more split.
dash_split = dash_split[1].split("-", 1)
return dash_split[0], dash_split[1].split(".", 1)[0]
- def add_testcase(testcase, iface, file_out, num, **kwargs):
+ def add_testcase(testcase, iface, suite_id, file_out, num, **kwargs):
+ """Add testcase to file.
+
+ :param testcase: Testcase class.
+ :param iface: Interface.
+ :param suite_id: Suite ID.
+ :param file_out: File to write testcases to.
+ :param num: Testcase number.
+ :param kwargs: Key-value pairs used to construct testcase.
+ :type testcase: Testcase
+ :type iface: str
+ :type suite_id: str
+ :type file_out: file
+ :type num: int
+ :type kwargs: dict
+ :returns: Next testcase number.
+ :rtype: int
+ """
# TODO: Is there a better way to disable some combinations?
- if kwargs["framesize"] != 9000 or "vic1227" not in iface:
+ emit = True
+ if kwargs["framesize"] == 9000:
+ if "vic1227" in iface:
+ # Not supported in HW.
+ emit = False
+ if "avf" in suite_id:
+ # Not supported by AVF driver.
+ # https://git.fd.io/vpp/tree/src/plugins/avf/README.md
+ emit = False
+ if "-16vm-" in suite_id or "-16dcr-" in suite_id:
+ if kwargs["phy_cores"] > 3:
+ # CSIT lab only has 28 (physical) core processors,
+ # so these test would fail when attempting to assign cores.
+ emit = False
+ if "soak" in suite_id:
+ # Soak test take too long, do not risk other than tc01.
+ if kwargs["phy_cores"] != 1:
+ emit = False
+ if kwargs["framesize"] not in min_framesize_values:
+ emit = False
+ if emit:
file_out.write(testcase.generate(num=num, **kwargs))
+ # We bump tc number in any case, so that future enables/disables
+ # do not affect the numbering of other test cases.
return num + 1
- def add_testcases(testcase, iface, file_out, tc_kwargs_list):
+ def add_testcases(testcase, iface, suite_id, file_out, tc_kwargs_list):
+ """Add testcases to file.
+
+ :param testcase: Testcase class.
+ :param iface: Interface.
+ :param suite_id: Suite ID.
+ :param file_out: File to write testcases to.
+ :param tc_kwargs_list: Key-value pairs used to construct testcases.
+ :type testcase: Testcase
+ :type iface: str
+ :type suite_id: str
+ :type file_out: file
+ :type tc_kwargs_list: dict
+ """
num = 1
for tc_kwargs in tc_kwargs_list:
- num = add_testcase(testcase, iface, file_out, num, **tc_kwargs)
+ num = add_testcase(testcase, iface, suite_id, file_out, num,
+ **tc_kwargs)
- print "Regenerator starts at {cwd}".format(cwd=getcwd())
+ if not self.quiet:
+ eprint("Regenerator starts at {cwd}".format(cwd=getcwd()))
min_framesize = protocol_to_min_framesize[protocol]
kwargs_list = tc_kwargs_list if tc_kwargs_list else [
{"framesize": min_framesize, "phy_cores": 1},
{"framesize": "IMIX_v4_1", "phy_cores": 4}
]
for filename in glob(pattern):
- print "Regenerating filename:", filename
+ if not self.quiet:
+ eprint("Regenerating filename:", filename)
with open(filename, "r") as file_in:
text = file_in.read()
text_prolog = "".join(text.partition("*** Test Cases ***")[:-1])
testcase = self.testcase_class(suite_id)
with open(filename, "w") as file_out:
file_out.write(text_prolog)
- add_testcases(testcase, iface, file_out, kwargs_list)
- print "Regenerator ends."
- print # To make autogen check output more readable.
+ add_testcases(testcase, iface, suite_id, file_out, kwargs_list)
+ if not self.quiet:
+ eprint("Regenerator ends.")
+ eprint() # To make autogen check output more readable.
Code Review / csit.git / blobdiff