mirrors/tor
1
0
Fork 0
mirror of https://gitlab.torproject.org/tpo/core/tor.git synced 2025-02-24 14:51:11 +01:00
Code Issues Projects Releases Wiki Activity

Practracker: new flags to control output.

Browse source 
These flags let you suppress the message about the number of
problems and warnings, and let you control the thresholds above
which something counts as a problem.

I need this for testing.
This commit is contained in:
Nick Mathewson 2019-07-30 11:49:50 -04:00
parent 31a0b81854
commit 3f303c102a
1 changed files with 16 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
scripts/maint/practracker/practracker.py
View file

@ -36,7 +36,6 @@ MAX_FUNCTION_SIZE = 100 # lines
# Recommended number of #includes # Recommended number of #includes
MAX_INCLUDE_COUNT = 50 MAX_INCLUDE_COUNT = 50
# Map from problem type to functions that adjust for tolerance # Map from problem type to functions that adjust for tolerance
TOLERANCE_FNS = { TOLERANCE_FNS = {
'include-count': lambda n: int(n*1.1), 'include-count': lambda n: int(n*1.1),
@ -49,12 +48,6 @@ TOLERANCE_FNS = {
# The Tor source code topdir # The Tor source code topdir
TOR_TOPDIR = None TOR_TOPDIR = None
# ProblemFilter singleton.
FILTER = problem.ProblemFilter()
FILTER.addThreshold(problem.FileSizeItem("*", MAX_FILE_SIZE))
FILTER.addThreshold(problem.IncludeCountItem("*", MAX_INCLUDE_COUNT))
FILTER.addThreshold(problem.FunctionSizeItem("*", MAX_FUNCTION_SIZE))
####################################################### #######################################################
if sys.version_info[0] <= 2: if sys.version_info[0] <= 2:
@ -166,6 +159,14 @@ def main(argv):
help="Override the location for the exceptions file") help="Override the location for the exceptions file")
parser.add_argument("--strict", action="store_true", parser.add_argument("--strict", action="store_true",
help="Make all warnings into errors") help="Make all warnings into errors")
parser.add_argument("--terse", action="store_true",
help="Do not emit helpful instructions.")
parser.add_argument("--max-file-size", default=MAX_FILE_SIZE,
help="Maximum lines per C file size")
parser.add_argument("--max-include-count", default=MAX_INCLUDE_COUNT,
help="Maximum includes per C file")
parser.add_argument("--max-function-size", default=MAX_FUNCTION_SIZE,
help="Maximum lines per function")
parser.add_argument("topdir", default=".", nargs="?", parser.add_argument("topdir", default=".", nargs="?",
help="Top-level directory for the tor source") help="Top-level directory for the tor source")
args = parser.parse_args(argv[1:]) args = parser.parse_args(argv[1:])
@ -177,6 +178,12 @@ def main(argv):
else: else:
exceptions_file = os.path.join(TOR_TOPDIR, "scripts/maint/practracker", EXCEPTIONS_FNAME) exceptions_file = os.path.join(TOR_TOPDIR, "scripts/maint/practracker", EXCEPTIONS_FNAME)
# 0) Configure our thresholds of "what is a problem actually"
filt = problem.ProblemFilter()
filt.addThreshold(problem.FileSizeItem("*", int(args.max_file_size)))
filt.addThreshold(problem.IncludeCountItem("*", int(args.max_include_count)))
filt.addThreshold(problem.FunctionSizeItem("*", int(args.max_function_size)))
# 1) Get all the .c files we care about # 1) Get all the .c files we care about
files_list = util.get_tor_c_files(TOR_TOPDIR) files_list = util.get_tor_c_files(TOR_TOPDIR)
@ -198,7 +205,7 @@ def main(argv):
# 3) Go through all the files and report problems if they are not exceptions # 3) Go through all the files and report problems if they are not exceptions
found_new_issues = 0 found_new_issues = 0
for item in FILTER.filter(consider_all_metrics(files_list)): for item in filt.filter(consider_all_metrics(files_list)):
status = ProblemVault.register_problem(item) status = ProblemVault.register_problem(item)
if status == problem.STATUS_ERR: if status == problem.STATUS_ERR:
print(item) print(item)
@ -212,7 +219,7 @@ def main(argv):
sys.exit(0) sys.exit(0)
# If new issues were found, try to give out some advice to the developer on how to resolve it. # If new issues were found, try to give out some advice to the developer on how to resolve it.
if found_new_issues and not args.regen: if found_new_issues and not args.regen and not args.terse:
new_issues_str = """\ new_issues_str = """\
FAILURE: practracker found {} new problem(s) in the code: see warnings above. FAILURE: practracker found {} new problem(s) in the code: see warnings above.