1 files changed, 105 insertions, 0 deletions
diff --git a/tests/test_util/test_util_display.py b/tests/test_util/test_util_display.py
new file mode 100644
index 0000000..a18fa1e
--- /dev/null
+++ b/tests/test_util/test_util_display.py
@@ -0,0 +1,105 @@
+"""Tests util functions."""
+
+import pytest
+
+from sphinx.util import logging
+from sphinx.util.console import strip_colors
+from sphinx.util.display import (
+    SkipProgressMessage,
+    display_chunk,
+    progress_message,
+    status_iterator,
+)
+
+
+def test_display_chunk():
+    assert display_chunk('hello') == 'hello'
+    assert display_chunk(['hello']) == 'hello'
+    assert display_chunk(['hello', 'sphinx', 'world']) == 'hello .. world'
+    assert display_chunk(('hello',)) == 'hello'
+    assert display_chunk(('hello', 'sphinx', 'world')) == 'hello .. world'
+
+
+@pytest.mark.sphinx('dummy')
+def test_status_iterator_length_0(app, status, warning):
+    logging.setup(app, status, warning)
+
+    # test for status_iterator (length=0)
+    status.seek(0)
+    status.truncate(0)
+    yields = list(status_iterator(['hello', 'sphinx', 'world'], 'testing ... '))
+    output = strip_colors(status.getvalue())
+    assert 'testing ... hello sphinx world \n' in output
+    assert yields == ['hello', 'sphinx', 'world']
+
+
+@pytest.mark.sphinx('dummy')
+def test_status_iterator_verbosity_0(app, status, warning, monkeypatch):
+    monkeypatch.setenv("FORCE_COLOR", "1")
+    logging.setup(app, status, warning)
+
+    # test for status_iterator (verbosity=0)
+    status.seek(0)
+    status.truncate(0)
+    yields = list(status_iterator(['hello', 'sphinx', 'world'], 'testing ... ',
+                                  length=3, verbosity=0))
+    output = strip_colors(status.getvalue())
+    assert 'testing ... [ 33%] hello\r' in output
+    assert 'testing ... [ 67%] sphinx\r' in output
+    assert 'testing ... [100%] world\r\n' in output
+    assert yields == ['hello', 'sphinx', 'world']
+
+
+@pytest.mark.sphinx('dummy')
+def test_status_iterator_verbosity_1(app, status, warning, monkeypatch):
+    monkeypatch.setenv("FORCE_COLOR", "1")
+    logging.setup(app, status, warning)
+
+    # test for status_iterator (verbosity=1)
+    status.seek(0)
+    status.truncate(0)
+    yields = list(status_iterator(['hello', 'sphinx', 'world'], 'testing ... ',
+                                  length=3, verbosity=1))
+    output = strip_colors(status.getvalue())
+    assert 'testing ... [ 33%] hello\n' in output
+    assert 'testing ... [ 67%] sphinx\n' in output
+    assert 'testing ... [100%] world\n\n' in output
+    assert yields == ['hello', 'sphinx', 'world']
+
+
+def test_progress_message(app, status, warning):
+    logging.setup(app, status, warning)
+    logger = logging.getLogger(__name__)
+
+    # standard case
+    with progress_message('testing'):
+        logger.info('blah ', nonl=True)
+
+    output = strip_colors(status.getvalue())
+    assert 'testing... blah done\n' in output
+
+    # skipping case
+    with progress_message('testing'):
+        raise SkipProgressMessage('Reason: %s', 'error')  # NoQA: EM101
+
+    output = strip_colors(status.getvalue())
+    assert 'testing... skipped\nReason: error\n' in output
+
+    # error case
+    try:
+        with progress_message('testing'):
+            raise
+    except Exception:
+        pass
+
+    output = strip_colors(status.getvalue())
+    assert 'testing... failed\n' in output
+
+    # decorator
+    @progress_message('testing')
+    def func():
+        logger.info('in func ', nonl=True)
+
+    func()
+    output = strip_colors(status.getvalue())
+    assert 'testing... in func done\n' in output