AppTests: Add tests for RefreshPrinter

Signed-off-by: Gabe Goodhart <[email protected]>

Author: gabe-l-hart

scriptit/refresh_printer.py

@@ -38,6 +38,8 @@
 class RefreshPrinter:
     __doc__ = __doc__
 
+    UP_LINE = "\033[F"
+
     def __init__(
         self,
         do_refresh: bool = True,
@@ -90,7 +92,7 @@ def refresh(self, force: bool = False):
         width = shutil.get_terminal_size().columns
         if force or self.refresh_rate == 1 or self.refreshes % self.refresh_rate == 1:
             if self.do_refresh and self.last_report is not None and not self.mute:
-                line_clear = "\033[F" + " " * width
+                line_clear = self.UP_LINE + " " * width
                 self.write_stream.write(
                     line_clear * (len(self.last_report) + 1) + "\r\n"
                 )

tests/test_refresh_printer.py

@@ -0,0 +1,89 @@
+"""
+Tests for RefreshPrinter
+"""
+# Standard
+from unittest import mock
+import io
+
+# Third Party
+import pytest
+
+# Local
+from scriptit import RefreshPrinter
+
+
+def test_refresh_printer_multi_line():
+    """Test that adding multiple lines refreshes correctly"""
+    stream = io.StringIO()
+    printer = RefreshPrinter(write_stream=stream)
+
+    # Perform initial add and refresh
+    printer.add("Line one")
+    printer.add("Line two")
+    printer.refresh()
+    assert printer.refreshes == 1
+    printed_lines = stream.getvalue().split("\n")
+    assert len(printed_lines) == 3  # Two plus final empty line
+    assert not any(line.startswith(RefreshPrinter.UP_LINE) for line in printed_lines)
+
+    # Perform a second refresh and make sure clearing happens
+    printer.add("Line three")
+    printer.add("Line four")
+    printer.refresh()
+    assert printer.refreshes == 2
+    printed_lines = stream.getvalue().split("\n")
+    assert len(printed_lines) == 6  # First 2, clear, 2 new, final \n
+    assert printed_lines[2].count(RefreshPrinter.UP_LINE) == 3
+
+
+def test_refresh_printer_newline_in_add():
+    """Make sure that a newline in add is handled as separate lines"""
+    stream = io.StringIO()
+    printer = RefreshPrinter(write_stream=stream)
+
+    # Perform initial add and refresh
+    printer.add("Line one\nLine two")
+    printer.refresh()
+    assert printer.refreshes == 1
+    printed_lines = stream.getvalue().split("\n")
+    assert len(printed_lines) == 3  # Two plus final empty line
+    assert not any(line.startswith(RefreshPrinter.UP_LINE) for line in printed_lines)
+
+
+@pytest.mark.parametrize("wrap", [True, False])
+def test_refresh_printer_wrap_lines(wrap):
+    """Make sure long lines get wrapped if requested"""
+    term_size_mock = mock.MagicMock()
+    term_width = 5
+    term_size_mock.columns = term_width
+    with mock.patch("shutil.get_terminal_size", return_value=term_size_mock):
+        stream = io.StringIO()
+        printer = RefreshPrinter(write_stream=stream)
+
+        # Perform initial add and refresh
+        long_line = "*" * int(2.5 * term_width)
+        printer.add(long_line, wrap=wrap)
+        printer.refresh()
+        printed_lines = stream.getvalue().split("\n")
+        assert len(printed_lines) == 4 if wrap else 2
+
+
+def test_clear_last_report_chars():
+    """Make sure that shorter lines in an update don't retain characters from
+    previous reports
+    """
+    stream = io.StringIO()
+    printer = RefreshPrinter(write_stream=stream)
+
+    # Perform initial add and refresh
+    printer.add("Line one")
+    printer.refresh()
+
+    # Perform a second with a shorter line and make sure that the line does not
+    # have any of the previous report in it
+    printer.add("two")
+    printer.refresh()
+    printed_lines = stream.getvalue().split("\n")
+    assert len(printed_lines) == 4  # First 1, clear, 1 new, final \n
+    assert printed_lines[1].count(RefreshPrinter.UP_LINE) == 2
+    assert printed_lines[2].strip() == "two"