|
| 1 | +# Copyright 2025 The Emscripten Authors. All rights reserved. |
| 2 | +# Emscripten is available under two separate licenses, the MIT license and the |
| 3 | +# University of Illinois/NCSA Open Source License. Both these licenses can be |
| 4 | +# found in the LICENSE file. |
| 5 | + |
| 6 | +import logging |
| 7 | +import shutil |
| 8 | +import unittest |
| 9 | + |
| 10 | +from tools.colored_logger import CYAN, GREEN, RED, with_color |
| 11 | + |
| 12 | + |
| 13 | +def clearline(stream): |
| 14 | + stream.write('\r\033[K') |
| 15 | + stream.flush() |
| 16 | + |
| 17 | + |
| 18 | +def term_width(): |
| 19 | + return shutil.get_terminal_size()[0] |
| 20 | + |
| 21 | + |
| 22 | +class BufferingMixin: |
| 23 | + """This class takes care of redirectting `logging` output in `buffer=True` mode. |
| 24 | +
|
| 25 | + To use this class inherit from it along with a one of the standard unittest result |
| 26 | + classe. |
| 27 | + """ |
| 28 | + def _setupStdout(self): |
| 29 | + super()._setupStdout() |
| 30 | + # In addition to redirecting sys.stderr and sys.stdout, also update the python |
| 31 | + # loggers have cached versions of these. |
| 32 | + if self.buffer: |
| 33 | + for handler in logging.root.handlers: |
| 34 | + if handler.stream == self._original_stderr: |
| 35 | + handler.stream = self._stderr_buffer |
| 36 | + |
| 37 | + def _restoreStdout(self): |
| 38 | + super()._restoreStdout() |
| 39 | + if self.buffer: |
| 40 | + for handler in logging.root.handlers: |
| 41 | + if handler.stream == self._stderr_buffer: |
| 42 | + handler.stream = self._original_stderr |
| 43 | + |
| 44 | + |
| 45 | +class SingleLineTestResult(BufferingMixin, unittest.TextTestResult): |
| 46 | + """Similar to the standard TextTestResult but uses ANSI escape codes |
| 47 | + for color output and reusing a single line on the terminal. |
| 48 | + """ |
| 49 | + test_count = 0 |
| 50 | + |
| 51 | + def __init__(self, *args, **kwargs): |
| 52 | + super().__init__(*args, **kwargs) |
| 53 | + self.progress_counter = 0 |
| 54 | + |
| 55 | + def writeStatusLine(self, line): |
| 56 | + clearline(self._original_stderr) |
| 57 | + self._original_stderr.write(line) |
| 58 | + self._original_stderr.flush() |
| 59 | + |
| 60 | + def updateStatus(self, test, msg, color): |
| 61 | + self.progress_counter += 1 |
| 62 | + progress = f'[{self.progress_counter}/{self.test_count}] ' |
| 63 | + # Format the line so that it fix within the terminal width, unless its less then min_len |
| 64 | + # in which case there is not much we can do, and we just overflow the line. |
| 65 | + min_len = len(progress) + len(msg) + 5 |
| 66 | + test_name = str(test) |
| 67 | + if term_width() > min_len: |
| 68 | + max_name = term_width() - min_len |
| 69 | + test_name = test_name[:max_name] |
| 70 | + line = f'{with_color(CYAN, progress)}{test_name} ... {with_color(color, msg)}' |
| 71 | + self.writeStatusLine(line) |
| 72 | + |
| 73 | + def startTest(self, test): |
| 74 | + assert self.test_count > 0 |
| 75 | + # Note: We explicitly do not use `super()` here but instead call `unittest.TestResult`. i.e. |
| 76 | + # we skip the superclass (since we don't want its specific behaviour) and instead call its |
| 77 | + # superclass. |
| 78 | + unittest.TestResult.startTest(self, test) |
| 79 | + if self.progress_counter == 0: |
| 80 | + self.writeStatusLine('.. awaiting first test result') |
| 81 | + |
| 82 | + def addSuccess(self, test): |
| 83 | + unittest.TestResult.addSuccess(self, test) |
| 84 | + self.updateStatus(test, 'ok', GREEN) |
| 85 | + |
| 86 | + def addFailure(self, test, err): |
| 87 | + unittest.TestResult.addFailure(self, test, err) |
| 88 | + self.updateStatus(test, 'FAIL', RED) |
| 89 | + |
| 90 | + def addError(self, test, err): |
| 91 | + unittest.TestResult.addError(self, test, err) |
| 92 | + self.updateStatus(test, 'ERROR', RED) |
| 93 | + |
| 94 | + def addExpectedFailure(self, test, err): |
| 95 | + unittest.TestResult.addExpectedFailure(self, test, err) |
| 96 | + self.updateStatus(test, 'expected failure', RED) |
| 97 | + |
| 98 | + def addUnexpectedSuccess(self, test, err): |
| 99 | + unittest.TestResult.addUnexpectedSuccess(self, test, err) |
| 100 | + self.updateStatus(test, 'UNEXPECTED SUCCESS', RED) |
| 101 | + |
| 102 | + def addSkip(self, test, reason): |
| 103 | + unittest.TestResult.addSkip(self, test, reason) |
| 104 | + self.updateStatus(test, f"skipped '{reason}'", CYAN) |
| 105 | + |
| 106 | + def printErrors(self): |
| 107 | + # All tests have been run at this point so print a final newline |
| 108 | + # to end out status line |
| 109 | + self._original_stderr.write('\n') |
| 110 | + super().printErrors() |
| 111 | + |
| 112 | + |
| 113 | +class SingleLineTestRunner(unittest.TextTestRunner): |
| 114 | + """Subclass of TextTestResult that uses SingleLineTestResult""" |
| 115 | + resultclass = SingleLineTestResult |
| 116 | + |
| 117 | + def __init__(self, *args, **kwargs): |
| 118 | + super().__init__(*args, buffer=True, **kwargs) |
| 119 | + |
| 120 | + def _makeResult(self): |
| 121 | + result = super()._makeResult() |
| 122 | + result.test_count = self.test_count |
| 123 | + return result |
| 124 | + |
| 125 | + def run(self, test): |
| 126 | + self.test_count = test.countTestCases() |
| 127 | + return super().run(test) |
0 commit comments