refactor: replace some remaining click.echo() calls with ui.display_*()

Author: agateau-gg

ggshield/cmd/iac/scan/ci.py

@@ -13,6 +13,7 @@
 from ggshield.cmd.utils.common_decorators import display_beta_warning, exception_wrapper
 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.git_hooks.ci.get_scan_ci_parameters import (
     NotAMergeRequestError,
     get_scan_ci_parameters,
@@ -58,10 +59,7 @@ def scan_ci_cmd(
             ci_mode, wd=directory, verbose=config.user_config.verbose
         )
         if params is None:
-            click.echo(
-                "No commit found in merge request, skipping scan.",
-                err=True,
-            )
+            ui.display_info("No commit found in merge request, skipping scan.")
             return 0
 
         current_commit, reference_commit = params
@@ -78,13 +76,10 @@ def scan_ci_cmd(
         augment_unignored_issues(config.user_config, result)
         return display_iac_scan_diff_result(ctx, directory, result)
     except NotAMergeRequestError:
-        click.echo(
-            (
-                "WARNING: scan ci expects to be run in a merge-request pipeline.\n"
-                "No target branch could be identified, will perform a scan all instead.\n"
-                "This is a fallback behaviour, that will be removed in a future version."
-            ),
-            err=True,
+        ui.display_warning(
+            "scan ci expects to be run in a merge-request pipeline.\n"
+            "No target branch could be identified, will perform a scan all instead.\n"
+            "This is a fallback behaviour, that will be removed in a future version."
         )
         result = iac_scan_all(
             ctx, directory, scan_mode=ScanMode.CI_ALL, ci_mode=ci_mode

ggshield/cmd/sca/scan/ci.py

@@ -15,6 +15,7 @@
 from ggshield.cmd.utils.common_decorators import exception_wrapper
 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.git_hooks.ci.get_scan_ci_parameters import (
     NotAMergeRequestError,
     get_scan_ci_parameters,
@@ -75,10 +76,7 @@ def scan_ci_cmd(
             ci_mode, wd=directory, verbose=config.user_config.verbose
         )
         if params is None:
-            click.echo(
-                "No commit found in merge request, skipping scan.",
-                err=True,
-            )
+            ui.display_info("No commit found in merge request, skipping scan.")
             return 0
 
         current_commit, reference_commit = params
@@ -94,13 +92,10 @@ def scan_ci_cmd(
         scan = SCAScanDiffVulnerabilityCollection(id=str(directory), result=result)
         return output_handler.process_scan_diff_result(scan)
     except NotAMergeRequestError:
-        click.echo(
-            (
-                "WARNING: scan ci expects to be run in a merge-request pipeline.\n"
-                "No target branch could be identified, will perform a scan all instead.\n"
-                "This is a fallback behaviour, that will be removed in a future version."
-            ),
-            err=True,
+        ui.display_warning(
+            "scan ci expects to be run in a merge-request pipeline.\n"
+            "No target branch could be identified, will perform a scan all instead.\n"
+            "This is a fallback behaviour, that will be removed in a future version."
         )
         result = sca_scan_all(ctx, directory=directory, scan_mode=ScanMode.CI_ALL)
         scan = SCAScanAllVulnerabilityCollection(id=str(directory), result=result)

ggshield/cmd/secret/scan/precommit.py

@@ -104,8 +104,5 @@ def precommit_cmd(
         SecretScanCollection(id="cached", type="pre-commit", results=results)
     )
     if return_code:
-        click.echo(
-            ctx_obj.client.remediation_messages.pre_commit,
-            err=True,
-        )
+        ui.display_info(ctx_obj.client.remediation_messages.pre_commit)
     return return_code

ggshield/cmd/secret/scan/prepush.py

@@ -44,13 +44,12 @@ def prepush_cmd(ctx: click.Context, prepush_args: List[str], **kwargs: Any) -> i
     logger.debug("refs=(%s, %s)", local_commit, remote_commit)
 
     if local_commit == EMPTY_SHA:
-        click.echo("Deletion event or nothing to scan.", err=True)
+        ui.display_info("Deletion event or nothing to scan.")
         return 0
 
     if remote_commit == EMPTY_SHA:
-        click.echo(
-            f"New tree event. Scanning last {config.user_config.max_commits_for_hook} commits.",
-            err=True,
+        ui.display_info(
+            f"New tree event. Scanning last {config.user_config.max_commits_for_hook} commits."
         )
         before = EMPTY_TREE
         after = local_commit
@@ -65,19 +64,17 @@ def prepush_cmd(ctx: click.Context, prepush_args: List[str], **kwargs: Any) -> i
     )
 
     if not commit_list:
-        click.echo(
+        ui.display_warning(
             "Unable to get commit range.\n"
             f"  before: {before}\n"
             f"  after: {after}\n"
             "Skipping pre-push hook\n",
-            err=True,
         )
         return 0
 
     if len(commit_list) > config.user_config.max_commits_for_hook:
-        click.echo(
-            f"Too many commits. Scanning last {config.user_config.max_commits_for_hook} commits\n",
-            err=True,
+        ui.display_info(
+            f"Too many commits. Scanning last {config.user_config.max_commits_for_hook} commits\n"
         )
         commit_list = commit_list[-config.user_config.max_commits_for_hook :]
 
@@ -103,8 +100,5 @@ def prepush_cmd(ctx: click.Context, prepush_args: List[str], **kwargs: Any) -> i
         ignored_detectors=config.user_config.secret.ignored_detectors,
     )
     if return_code:
-        click.echo(
-            ctx_obj.client.remediation_messages.pre_push,
-            err=True,
-        )
+        ui.display_info(ctx_obj.client.remediation_messages.pre_push)
     return return_code

ggshield/cmd/secret/scan/prereceive.py

@@ -60,12 +60,9 @@ def _execute_prereceive(
             ignored_detectors=config.user_config.secret.ignored_detectors,
         )
         if return_code:
-            click.echo(
-                (
-                    config.user_config.secret.prereceive_remediation_message
-                    or client.remediation_messages.pre_receive
-                ),
-                err=True,
+            ui.display_info(
+                config.user_config.secret.prereceive_remediation_message
+                or client.remediation_messages.pre_receive
             )
         sys.exit(return_code)
     except Exception as error:
@@ -115,9 +112,8 @@ def prereceive_cmd(
     assert commit_list, "Commit list should not be empty at this point"
 
     if len(commit_list) > config.user_config.max_commits_for_hook:
-        click.echo(
+        ui.display_info(
             f"Too many commits. Scanning last {config.user_config.max_commits_for_hook} commits\n",
-            err=True,
         )
         commit_list = commit_list[-config.user_config.max_commits_for_hook :]
 

ggshield/core/git_hooks/prereceive.py

@@ -3,8 +3,6 @@
 import sys
 from typing import Optional, Tuple
 
-import click
-
 from ggshield.core import ui
 from ggshield.core.errors import UnexpectedError
 from ggshield.utils.git_shell import EMPTY_SHA, git
@@ -36,9 +34,8 @@ def get_breakglass_option() -> bool:
     if option_count is not None:
         for option in range(option_count):
             if os.getenv(f"GIT_PUSH_OPTION_{option}", "") == "breakglass":
-                click.echo(
-                    "SKIP: breakglass detected. Skipping GitGuardian pre-receive hook.",
-                    err=True,
+                ui.display_info(
+                    "SKIP: breakglass detected. Skipping GitGuardian pre-receive hook."
                 )
                 return True
 
@@ -78,7 +75,7 @@ def parse_stdin() -> Optional[Tuple[str, str]]:
 
     if new_commit == EMPTY_SHA:
         # Deletion event, nothing to do
-        click.echo("Deletion event or nothing to scan.", err=True)
+        ui.display_info("Deletion event or nothing to scan.")
         return None
 
     # ignore _old_commit because in case of a force-push, it is going to be overwritten
@@ -93,10 +90,7 @@ def parse_stdin() -> Optional[Tuple[str, str]]:
     assert old_commit != EMPTY_SHA
     assert new_commit != EMPTY_SHA
     if old_commit == new_commit:
-        click.echo(
-            "Pushed branch does not contain any new commit.",
-            err=True,
-        )
+        ui.display_info("Pushed branch does not contain any new commit.")
         return None
 
     return (old_commit, new_commit)

tests/unit/cmd/sca/test_ci.py

@@ -80,4 +80,4 @@ def test_sca_scan_ci_non_mr_env(
             sca_scan_all_mock.call_args.kwargs.items()
         )
         assert result.exit_code == ExitCode.SUCCESS
-        assert "WARNING: " in result.stderr
+        assert "Warning: " in result.stderr