feat: add ui.set_level() and ui.is_verbose()

Provide a single way to reset the whole module for tests.

Author: agateau-gg

ggshield/cmd/utils/debug.py

@@ -33,11 +33,3 @@ def setup_debug_mode(*, filename: Optional[str] = None) -> None:
 
     logger.debug("args=%s", sys.argv)
     logger.debug("py-gitguardian=%s", pygitguardian.__version__)
-
-
-def reset_debug_mode() -> None:
-    """
-    This function is used by unit-tests.
-    """
-    log_utils.reset_log_handler()
-    ui.set_level(ui.Level.INFO)

ggshield/core/ui/__init__.py

@@ -21,6 +21,18 @@ def set_level(level: Level) -> None:
     _ui.level = level
 
 
+def get_level() -> Level:
+    return _ui.level
+
+
+def is_verbose() -> bool:
+    """
+    Convenient function to check if verbose messages are visible. Use this if displaying
+    verbose messages is costly (for example displaying a list of files)
+    """
+    return _ui.level >= Level.VERBOSE
+
+
 def set_ui(ui: GGShieldUI) -> None:
     """Change the GGShieldUI instance used to output messages. Takes care of
     carrying existing settings from the old instance to the new one."""
@@ -67,3 +79,8 @@ def create_scanner_ui(total: int, verbose: bool = False) -> ScannerUI:
 
 def create_message_only_scanner_ui(verbose: bool = False) -> ScannerUI:
     return _ui.create_message_only_scanner_ui(verbose=verbose)
+
+
+def _reset_ui():
+    global _ui
+    _ui = PlainTextGGShieldUI()

ggshield/core/ui/log_utils.py

@@ -44,7 +44,7 @@ def set_log_handler(filename: Optional[str] = None) -> None:
     logging.basicConfig(level=logging.DEBUG, force=True, handlers=[_log_handler])
 
 
-def reset_log_handler():
+def _reset_log_handler():
     """Remove our log handler. Used by unit tests."""
     global _log_handler
     if _log_handler:

ggshield/core/ui/reset.py

@@ -0,0 +1,10 @@
+from . import _reset_ui
+from .log_utils import _reset_log_handler
+
+
+def reset():
+    """
+    This function is only used by unit-tests to reset the UI
+    """
+    _reset_log_handler()
+    _reset_ui()

tests/unit/conftest.py

@@ -14,8 +14,8 @@
 from pygitguardian.models import ScanResult, SecretIncident
 from requests.utils import DEFAULT_CA_BUNDLE_PATH, extract_zipped_paths
 
-from ggshield.cmd.utils.debug import reset_debug_mode
 from ggshield.core.cache import Cache
+from ggshield.core.ui.reset import reset
 from ggshield.core.url_utils import dashboard_to_api_url
 from ggshield.utils.git_shell import (
     _get_git_path,
@@ -706,15 +706,12 @@ def clear_cache():
 
 
 @pytest.fixture(autouse=True)
-def _reset_debug_mode():
+def _reset_ui_fixture():
     """
     Enabling debug mode has global side effects. Reset it to ensure a test touching the
     log or debug configuration does not affect other tests.
     """
-    try:
-        yield
-    finally:
-        reset_debug_mode()
+    reset()
 
 
 SECRET_INCIDENT_MOCK = SecretIncident.from_dict(

tests/unit/core/ui/test_ui.py

@@ -0,0 +1,28 @@
+from typing import Optional
+
+import pytest
+
+from ggshield.core import ui
+from ggshield.core.ui import Level
+
+
+def test_level():
+    assert ui.get_level() == Level.INFO
+
+    ui.set_level(Level.VERBOSE)
+    assert ui.get_level() == Level.VERBOSE
+
+
+@pytest.mark.parametrize(
+    ("level", "expected"),
+    (
+        (None, False),
+        (Level.VERBOSE, True),
+        (Level.DEBUG, True),
+        (Level.ERROR, False),
+    ),
+)
+def test_is_verbose(level: Optional[Level], expected: bool):
+    if level:
+        ui.set_level(level)
+    assert ui.is_verbose() == expected