beffroi-tools/tests/test_progress.py

94 lines
4.0 KiB
Python

import contextlib
import io
import os
import unittest
from unittest.mock import patch
from tools import progress
class Terminal(io.StringIO):
def isatty(self):
return True
class ProgressTests(unittest.TestCase):
def test_terminal_steps_are_transient_and_summary_is_retained(self):
output, terminal = Terminal(), Terminal()
with patch.dict(os.environ, {'TERM': 'xterm', 'NO_COLOR': '1'}), \
contextlib.redirect_stdout(output), contextlib.redirect_stderr(terminal):
with progress.Progress() as bar:
bar.set(0, 2)
progress.status('Extracting')
bar.set(1)
progress.status('Probing')
bar.set(2)
progress.status('Done', 'success', persist=True)
self.assertFalse(bar.thread.is_alive())
self.assertIn('Extracting', terminal.getvalue())
self.assertIn('Probing', terminal.getvalue())
self.assertIn('2/2', terminal.getvalue())
self.assertNotIn('Probing\n', terminal.getvalue())
self.assertEqual(output.getvalue(), '[OK] Done\n')
self.assertTrue(terminal.getvalue().endswith('\r\033[2K'))
self.assertNotIn('\033[36m', terminal.getvalue())
self.assertIsNone(progress._active)
def test_redirected_output_logs_each_step_without_escapes(self):
output = io.StringIO()
with contextlib.redirect_stdout(output), contextlib.redirect_stderr(io.StringIO()):
with progress.Progress() as bar:
progress.status('Extracting')
progress.status('Probing')
progress.status('Done', 'success', persist=True)
self.assertIsNone(bar.thread)
self.assertEqual(output.getvalue(), '[INFO] Extracting\n[INFO] Probing\n[OK] Done\n')
self.assertNotIn('\033', output.getvalue())
def test_warnings_remain_and_exception_cleans_up(self):
output, terminal = Terminal(), Terminal()
with patch.dict(os.environ, {'TERM': 'xterm', 'NO_COLOR': '1'}), \
contextlib.redirect_stdout(output), contextlib.redirect_stderr(terminal):
with self.assertRaises(RuntimeError):
with progress.Progress() as bar:
progress.status('Probing')
progress.status('Cannot probe clip', 'warning')
raise RuntimeError('failed')
self.assertIn('[WARN] Cannot probe clip\n', terminal.getvalue())
self.assertTrue(terminal.getvalue().endswith('\r\033[2K'))
self.assertFalse(bar.thread.is_alive())
self.assertIsNone(progress._active)
def test_dumb_terminal_does_not_animate(self):
output, terminal = Terminal(), Terminal()
with patch.dict(os.environ, {'TERM': 'dumb'}), \
contextlib.redirect_stdout(output), contextlib.redirect_stderr(terminal):
with progress.Progress() as bar:
progress.status('Step')
self.assertIsNone(bar.thread)
self.assertEqual(output.getvalue(), '[INFO] Step\n')
self.assertEqual(terminal.getvalue(), '')
def test_eta_uses_average_time_of_completed_work(self):
output, terminal = Terminal(), Terminal()
with patch.dict(os.environ, {'TERM': 'xterm', 'NO_COLOR': '1'}), \
contextlib.redirect_stdout(output), contextlib.redirect_stderr(terminal), \
patch.object(progress.time, 'monotonic', return_value=40):
bar = progress.Progress()
bar.text = 'Rendering'
bar.started = 0
bar.phase_started = 10
bar.done = 2
bar.total = 5
bar._draw()
self.assertIn('2/5 ~45s left', terminal.getvalue())
def test_duration_formats_long_estimates_compactly(self):
self.assertEqual(progress._duration(5.4), '5s')
self.assertEqual(progress._duration(89.6), '1m 30s')
self.assertEqual(progress._duration(7380), '2h 03m')
if __name__ == '__main__':
unittest.main()