Github/littlefs
1
Fork 0
Code Actions Activity

Added --color to test.py, fixed some terminal-clobbering issues

Browse Source 
With more features being added to test.py, the one-line status is
starting to get quite long and pass the ~80 column readability
heuristic. To make this worse this clobbers the terminal output
when the terminal is not wide enough.

Simple solution is to disable line-wrapping, potentially printing
some garbage if line-wrapping-disable is not supported, but also
printing a final status update to fix any garbage and avoid a race
condition where the script would show a non-final status.

Also added --color which disables any of this attempting-to-be-clever
stuff.
This commit is contained in:
Christopher Haster
2022-08-22 12:46:59 -05:00
parent 61455b6191
commit 4689678208
2 changed files with 82 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files
scripts/coverage.py
-1
View File
@@ -503,7 +503,6 @@ if __name__ == "__main__":
help="Show a additional lines of context. Defaults to 3.") help="Show a additional lines of context. Defaults to 3.")
parser.add_argument('-w', '--width', type=lambda x: int(x, 0), default=80, parser.add_argument('-w', '--width', type=lambda x: int(x, 0), default=80,
help="Assume source is styled with this many columns. Defaults to 80.") help="Assume source is styled with this many columns. Defaults to 80.")
# TODO add this to test.py?
parser.add_argument('--color', parser.add_argument('--color',
choices=['never', 'always', 'auto'], default='auto', choices=['never', 'always', 'auto'], default='auto',
help="When to use terminal colors.") help="When to use terminal colors.")
scripts/test.py
+66 -33
View File
@@ -58,6 +58,14 @@ def openio(path, mode='r'):
else: else:
return open(path, mode) return open(path, mode)
def color(**args):
if args.get('color') == 'auto':
return sys.stdout.isatty()
elif args.get('color') == 'always':
return True
else:
return False
class TestCase: class TestCase:
# create a TestCase object from a config # create a TestCase object from a config
def __init__(self, config, args={}): def __init__(self, config, args={}):
@@ -98,8 +106,11 @@ class TestCase:
(suite_defines_ | defines_).items()))))) (suite_defines_ | defines_).items())))))
for k in config.keys(): for k in config.keys():
print('\x1b[01;33mwarning:\x1b[m in %s, found unused key %r' print('%swarning:%s in %s, found unused key %r' % (
% (self.id(), k), '\x1b[01;33m' if color(**args) else '',
'\x1b[m' if color(**args) else '',
self.id(),
k),
file=sys.stderr) file=sys.stderr)
def id(self): def id(self):
@@ -170,7 +181,8 @@ class TestSuite:
'suite_defines': defines, 'suite_defines': defines,
'suite_in': in_, 'suite_in': in_,
'suite_reentrant': reentrant, 'suite_reentrant': reentrant,
**case})) **case},
args=args))
# combine per-case defines # combine per-case defines
self.defines = set.union(*( self.defines = set.union(*(
@@ -180,8 +192,11 @@ class TestSuite:
self.reentrant = any(case.reentrant for case in self.cases) self.reentrant = any(case.reentrant for case in self.cases)
for k in config.keys(): for k in config.keys():
print('\x1b[01;33mwarning:\x1b[m in %s, found unused key %r' print('%swarning:%s in %s, found unused key %r' % (
% (self.id(), k), '\x1b[01;33m' if color(**args) else '',
'\x1b[m' if color(**args) else '',
self.id(),
k),
file=sys.stderr) file=sys.stderr)
def id(self): def id(self):
@@ -210,10 +225,10 @@ def compile(**args):
sys.exit(-1) sys.exit(-1)
# load our suite # load our suite
suite = TestSuite(paths[0]) suite = TestSuite(paths[0], args)
else: else:
# load all suites # load all suites
suites = [TestSuite(path) for path in paths] suites = [TestSuite(path, args) for path in paths]
suites.sort(key=lambda s: s.name) suites.sort(key=lambda s: s.name)
# write generated test source # write generated test source
@@ -748,19 +763,15 @@ def run_stage(name, runner_, **args):
runners.append(th.Thread( runners.append(th.Thread(
target=run_job, args=(runner_, None, None))) target=run_job, args=(runner_, None, None)))
for r in runners: def print_update(done):
r.start() if not args.get('verbose') and (color(**args) or done):
sys.stdout.write('%s%srunning %s%s:%s %s%s' % (
needs_newline = False '\r\x1b[K' if color(**args) else '',
try: '\x1b[?7l' if not done else '',
while any(r.is_alive() for r in runners): ('\x1b[32m' if not failures else '\x1b[31m')
time.sleep(0.01) if color(**args) else '',
if not args.get('verbose'):
sys.stdout.write('\r\x1b[K'
'running \x1b[%dm%s:\x1b[m %s '
% (32 if not failures else 31,
name, name,
'\x1b[m' if color(**args) else '',
', '.join(filter(None, [ ', '.join(filter(None, [
'%d/%d suites' % ( '%d/%d suites' % (
sum(passed_suite_perms[k] == v sum(passed_suite_perms[k] == v
@@ -776,18 +787,28 @@ def run_stage(name, runner_, **args):
'%d/%d perms' % (passed_perms, expected_perms), '%d/%d perms' % (passed_perms, expected_perms),
'%dpls!' % powerlosses '%dpls!' % powerlosses
if powerlosses else None, if powerlosses else None,
'\x1b[31m%d/%d failures\x1b[m' '%s%d/%d failures%s' % (
% (len(failures), expected_perms) '\x1b[31m' if color(**args) else '',
if failures else None])))) len(failures),
expected_perms,
'\x1b[m' if color(**args) else '')
if failures else None])),
'\x1b[?7h' if not done else '\n'))
sys.stdout.flush() sys.stdout.flush()
needs_newline = True
for r in runners:
r.start()
try:
while any(r.is_alive() for r in runners):
time.sleep(0.01)
print_update(False)
except KeyboardInterrupt: except KeyboardInterrupt:
# this is handled by the runner threads, we just # this is handled by the runner threads, we just
# need to not abort here # need to not abort here
killed = True killed = True
finally: finally:
if needs_newline: print_update(True)
print()
for r in runners: for r in runners:
r.join() r.join()
@@ -838,8 +859,10 @@ def run(**args):
# show summary # show summary
print() print()
print('\x1b[%dmdone:\x1b[m %s' # %d/%d passed, %d/%d failed%s, in %.2fs' print('%sdone:%s %s' % (
% (32 if not failures else 31, ('\x1b[32m' if not failures else '\x1b[31m')
if color(**args) else '',
'\x1b[m' if color(**args) else '',
', '.join(filter(None, [ ', '.join(filter(None, [
'%d/%d passed' % (passed, expected), '%d/%d passed' % (passed, expected),
'%d/%d failed' % (len(failures), expected), '%d/%d failed' % (len(failures), expected),
@@ -858,10 +881,13 @@ def run(**args):
path, lineno = runner_paths[testcase(failure.id)] path, lineno = runner_paths[testcase(failure.id)]
defines = runner_defines.get(failure.id, {}) defines = runner_defines.get(failure.id, {})
print('\x1b[01m%s:%d:\x1b[01;31mfailure:\x1b[m %s%s failed' print('%s%s:%d:%sfailure:%s %s%s failed' % (
% (path, lineno, failure.id, '\x1b[01m' if color(**args) else '',
' (%s)' % ', '.join( path, lineno,
'%s=%s' % (k, v) for k, v in defines.items()) '\x1b[01;31m' if color(**args) else '',
'\x1b[m' if color(**args) else '',
failure.id,
' (%s)' % ', '.join('%s=%s' % (k,v) for k,v in defines.items())
if defines else '')) if defines else ''))
if failure.output: if failure.output:
@@ -873,8 +899,12 @@ def run(**args):
if failure.assert_ is not None: if failure.assert_ is not None:
path, lineno, message = failure.assert_ path, lineno, message = failure.assert_
print('\x1b[01m%s:%d:\x1b[01;31massert:\x1b[m %s' print('%s%s:%d:%sassert:%s %s' % (
% (path, lineno, message)) '\x1b[01m' if color(**args) else '',
path, lineno,
'\x1b[01;31m' if color(**args) else '',
'\x1b[m' if color(**args) else '',
message))
with open(path) as f: with open(path) as f:
line = next(it.islice(f, lineno-1, None)).strip('\n') line = next(it.islice(f, lineno-1, None)).strip('\n')
print(line) print(line)
@@ -946,6 +976,9 @@ if __name__ == "__main__":
dropped to run any matching tests. Defaults to %s." % TEST_PATHS) dropped to run any matching tests. Defaults to %s." % TEST_PATHS)
parser.add_argument('-v', '--verbose', action='store_true', parser.add_argument('-v', '--verbose', action='store_true',
help="Output commands that run behind the scenes.") help="Output commands that run behind the scenes.")
parser.add_argument('--color',
choices=['never', 'always', 'auto'], default='auto',
help="When to use terminal colors.")
# test flags # test flags
test_parser = parser.add_argument_group('test options') test_parser = parser.add_argument_group('test options')
test_parser.add_argument('-Y', '--summary', action='store_true', test_parser.add_argument('-Y', '--summary', action='store_true',