Merge pull request #971 from GitGuardian/agateau/ui-refactor

Refactor how we print progress

Author: agateau-gg

changelog.d/20240930_104625_aurelien.gateau_ui_refactor.md

@@ -0,0 +1,3 @@
+### Fixed
+
+- When using the `--debug` option, the log output no longer overlaps with the progress bars.

ggshield/__main__.py

@@ -22,15 +22,14 @@
 from ggshield.cmd.status import status_cmd
 from ggshield.cmd.utils.common_options import add_common_options
 from ggshield.cmd.utils.context_obj import ContextObj
-from ggshield.cmd.utils.debug_logs import disable_logs, setup_debug_logs
-from ggshield.core import check_updates
+from ggshield.cmd.utils.debug import setup_debug_mode
+from ggshield.core import check_updates, ui
 from ggshield.core.cache import Cache
 from ggshield.core.config import Config
 from ggshield.core.env_utils import load_dot_env
 from ggshield.core.errors import ExitCode
-from ggshield.core.text_utils import display_warning
-from ggshield.core.ui.plain_text.plain_text_ggshield_ui import PlainTextGGShieldUI
-from ggshield.core.ui.rich.rich_ggshield_ui import RichGGShieldUI
+from ggshield.core.ui import log_utils
+from ggshield.core.ui.rich import RichGGShieldUI
 from ggshield.utils.click import RealPath
 from ggshield.utils.os import getenv_bool
 
@@ -66,10 +65,6 @@ def config_path_callback(
     if not ctx.obj:
         ctx.obj = ContextObj()
         ctx.obj.cache = Cache()
-        if sys.stderr.isatty():
-            ctx.obj.ui = RichGGShieldUI()
-        else:
-            ctx.obj.ui = PlainTextGGShieldUI()
 
     ctx.obj.config = Config(value)
     return value
@@ -112,8 +107,8 @@ def cli(
     _set_color(ctx)
 
     if config.user_config.debug:
-        # if `debug` is set in the configuration file, then setup logs now.
-        setup_debug_logs(filename=None)
+        # if `debug` is set in the configuration file, then setup debug mode now.
+        setup_debug_mode()
 
 
 def _set_color(ctx: click.Context):
@@ -144,7 +139,7 @@ def _set_color(ctx: click.Context):
 
 def _display_deprecation_message(cfg: Config) -> None:
     for message in cfg.user_config.deprecation_messages:
-        display_warning(message)
+        ui.display_warning(message)
 
 
 def _check_for_updates(check_for_updates: bool) -> None:
@@ -154,7 +149,7 @@ def _check_for_updates(check_for_updates: bool) -> None:
     if check_for_updates and "PYTEST_CURRENT_TEST" not in os.environ:
         latest_version = check_updates.check_for_updates()
         if latest_version:
-            display_warning(
+            ui.display_warning(
                 f"A new version of ggshield (v{latest_version}) has been released "
                 f"(https://github.com/GitGuardian/ggshield)."
             )
@@ -185,7 +180,10 @@ def main(args: Optional[List[str]] = None) -> Any:
     # See https://pyinstaller.org/en/latest/common-issues-and-pitfalls.html#multi-processing
     multiprocessing.freeze_support()
 
-    disable_logs()
+    log_utils.disable_logs()
+    if sys.stderr.isatty():
+        ui.set_ui(RichGGShieldUI())
+
     show_crash_log = getenv_bool("GITGUARDIAN_CRASH_LOG")
     return cli.main(args, prog_name="ggshield", standalone_mode=not show_crash_log)
 

ggshield/cmd/hmsl/check.py

@@ -15,7 +15,7 @@
     json_option,
     text_json_format_option,
 )
-from ggshield.core.text_utils import display_info
+from ggshield.core import ui
 from ggshield.verticals.hmsl.collection import (
     InputType,
     NamingStrategy,
@@ -51,13 +51,13 @@ def check_cmd(
     """
 
     # Collect secrets
-    display_info("Collecting secrets...")
+    ui.display_info("Collecting secrets...")
     input = cast(TextIO, click.open_file(path, "r"))
     secrets = list(collect(input, input_type))
     # full_hashes is True because we need the hashes to decrypt the secrets.
     # They will correctly be truncated by our client later.
     prepared_data = prepare(secrets, naming_strategy, full_hashes=True)
-    display_info(f"Collected {len(prepared_data.payload)} secrets.")
+    ui.display_info(f"Collected {len(prepared_data.payload)} secrets.")
 
     check_secrets(
         ctx=ctx,

ggshield/cmd/hmsl/check_secret_manager/hashicorp_vault.py

@@ -14,8 +14,9 @@
     text_json_format_option,
 )
 from ggshield.cmd.utils.context_obj import ContextObj
+from ggshield.core import ui
 from ggshield.core.errors import UnexpectedError
-from ggshield.core.text_utils import display_error, display_info, pluralize
+from ggshield.core.text_utils import pluralize
 from ggshield.verticals.hmsl.collection import NamingStrategy, collect_list, prepare
 from ggshield.verticals.hmsl.secret_manager.hashicorp_vault.api_client import (
     VaultAPIClient,
@@ -140,7 +141,7 @@ def check_hashicorp_vault_cmd(
             "that your token has access to it."
         )
 
-    display_info("Fetching secrets from Vault...")
+    ui.display_info("Fetching secrets from Vault...")
     try:
         result = vault_client.get_secrets(mount, secret_path, recursive)
     # catch this error here if the path provided is a file that we don't have access to
@@ -151,16 +152,16 @@ def check_hashicorp_vault_cmd(
         )
 
     if len(result.not_fetched_paths) > 0:
-        display_error(
+        ui.display_error(
             f"Could not fetch {len(result.not_fetched_paths)} paths. "
             "Make sure your token has access to all the secrets in your vault."
         )
         config = ContextObj.get(ctx).config
         if config.user_config.verbose:
-            display_error("> The following paths could not be fetched:")
+            ui.display_error("> The following paths could not be fetched:")
             for path in result.not_fetched_paths:
-                display_error(f"- {path}")
-    display_info(
+                ui.display_error(f"- {path}")
+    ui.display_info(
         f"Got {len(result.secrets)} {pluralize('secret', len(result.secrets))}."
     )
 

ggshield/cmd/hmsl/fingerprint.py

@@ -9,7 +9,7 @@
     naming_strategy_option,
 )
 from ggshield.cmd.utils.common_options import add_common_options
-from ggshield.core.text_utils import display_info
+from ggshield.core import ui
 from ggshield.verticals.hmsl.collection import (
     InputType,
     NamingStrategy,
@@ -62,5 +62,5 @@ def fingerprint_cmd(
     result = prepare(secrets, naming_strategy, full_hashes=full_hashes)
     write_outputs(result, prefix)
 
-    display_info(f"Prepared {len(secrets)} secrets.")
+    ui.display_info(f"Prepared {len(secrets)} secrets.")
     return 0

ggshield/cmd/hmsl/hmsl_utils.py

@@ -4,8 +4,9 @@
 from requests import HTTPError
 
 from ggshield.cmd.utils.context_obj import ContextObj
+from ggshield.core import ui
 from ggshield.core.errors import UnexpectedError
-from ggshield.core.text_utils import display_info, pluralize
+from ggshield.core.text_utils import pluralize
 from ggshield.verticals.hmsl import Secret, get_client
 from ggshield.verticals.hmsl.collection import PreparedSecrets
 from ggshield.verticals.hmsl.output import show_results
@@ -20,7 +21,7 @@ def check_secrets(
     Common code to check secrets and display results for check commands.
     """
     # Query the API
-    display_info("Querying HasMySecretLeaked...")
+    ui.display_info("Querying HasMySecretLeaked...")
     ctx_obj = ContextObj.get(ctx)
     client = get_client(ctx_obj.config, hmsl_command_path=ctx.command_path)
     found: Iterable[Secret] = []
@@ -29,7 +30,7 @@ def check_secrets(
         found = list(client.check(prepared_secrets.payload, full_hashes=full_hashes))
     except (ValueError, HTTPError) as exception:
         error = exception
-    display_info(
+    ui.display_info(
         f"{client.quota.remaining} {pluralize('credit', client.quota.remaining)} left for today."
     )
 

ggshield/cmd/hmsl/query.py

@@ -9,8 +9,9 @@
 from ggshield.cmd.hmsl.hmsl_common_options import input_arg
 from ggshield.cmd.utils.common_options import add_common_options
 from ggshield.cmd.utils.context_obj import ContextObj
+from ggshield.core import ui
 from ggshield.core.errors import ParseError, UnexpectedError
-from ggshield.core.text_utils import display_info, pluralize
+from ggshield.core.text_utils import pluralize
 from ggshield.verticals.hmsl import HASH_REGEX, PREFIX_REGEX, get_client
 
 
@@ -50,10 +51,10 @@ def query_cmd(
     except (ValueError, HTTPError) as error:
         raise UnexpectedError(str(error))
 
-    display_info(
+    ui.display_info(
         f"{client.quota.remaining} {pluralize('credit', client.quota.remaining)} left for today."
     )
-    display_info(f"Queried {len(payload)} {pluralize('secret', len(payload))}.")
+    ui.display_info(f"Queried {len(payload)} {pluralize('secret', len(payload))}.")
     return 0
 
 

ggshield/cmd/honeytoken/create.py

@@ -74,7 +74,7 @@ def create_cmd(
     if not name:
         name = generate_random_honeytoken_name()
     ctx_obj = ContextObj.get(ctx)
-    client = create_client_from_config(ctx_obj.config, ctx_obj.ui)
+    client = create_client_from_config(ctx_obj.config)
 
     response = client.create_honeytoken(name, type_, description)
     if not isinstance(response, (Detail, HoneytokenResponse)):

ggshield/cmd/honeytoken/create_with_context.py

@@ -99,7 +99,7 @@ def create_with_context_cmd(
     if not name:
         name = generate_random_honeytoken_name()
     ctx_obj = ContextObj.get(ctx)
-    client = create_client_from_config(ctx_obj.config, ctx_obj.ui)
+    client = create_client_from_config(ctx_obj.config)
 
     response = client.create_honeytoken_with_context(
         name=name,

ggshield/cmd/iac/scan/__init__.py

@@ -11,8 +11,8 @@
 from ggshield.cmd.iac.scan.prereceive import scan_pre_receive_cmd
 from ggshield.cmd.utils.common_options import directory_argument
 from ggshield.cmd.utils.context_obj import ContextObj
+from ggshield.core import ui
 from ggshield.core.client import create_client_from_config
-from ggshield.core.text_utils import display_warning
 from ggshield.utils.click import DefaultCommandGroup
 
 
@@ -47,7 +47,7 @@ def iac_scan_group(
 @click.pass_context
 def default_command(ctx: click.Context, **kwargs: Any) -> int:
     """Deprecated. Use `ggshield iac scan all` instead"""
-    display_warning("Deprecated. Please use 'ggshield iac scan all' instead")
+    ui.display_warning("Deprecated. Please use 'ggshield iac scan all' instead")
     result: int = scan_all_cmd.invoke(ctx)
     return result
 
@@ -59,6 +59,6 @@ def scan_group_impl(ctx: click.Context) -> int:
         scan_all_cmd.invoke(ctx)
 
     ctx_obj = ContextObj.get(ctx)
-    ctx_obj.client = create_client_from_config(ctx_obj.config, ctx_obj.ui)
+    ctx_obj.client = create_client_from_config(ctx_obj.config)
 
     return 0