Merge pull request #1102 from GitGuardian/agateau/consistent-secret-in-manager

fix: make "Secret in Secrets Manager" more consistent

Author: agateau-gg

ggshield/core/text_utils.py

@@ -54,6 +54,10 @@ def format_line_count(line_count: Union[int, None], padding: int) -> str:
     return " " * max(0, padding - len(str(line_count))) + str(line_count)
 
 
+def format_bool(value: bool) -> str:
+    return "YES" if value else "NO"
+
+
 _VALIDITY_TEXT_FOR_ID = {
     "unknown": "Unknown",
     # cannot_check is the old ID for secrets for which there are no checkers

ggshield/verticals/secret/output/secret_sarif_output_handler.py

@@ -6,6 +6,7 @@
 
 from ggshield import __version__ as ggshield_version
 from ggshield.core.match_span import MatchSpan
+from ggshield.core.text_utils import format_bool
 
 from ..extended_match import ExtendedMatch
 from ..secret_scan_collection import Result, Secret, SecretScanCollection
@@ -83,7 +84,7 @@ def _create_sarif_result_dict(
         markdown_message = f"Secret detected: [{secret.detector_display_name}]({secret.documentation_url})"
     else:
         markdown_message = f"Secret detected: {secret.detector_display_name}"
-    markdown_message += f"\nSecret in Secrets Manager: {secret.is_vaulted}"
+    markdown_message += f"\nSecret in Secrets Manager: {format_bool(secret.is_vaulted)}"
     markdown_message += f"\nMatches:\n{matches_li}"
 
     # Create dict

ggshield/verticals/secret/output/secret_text_output_handler.py

@@ -9,6 +9,7 @@
 from ggshield.core.text_utils import (
     STYLE,
     clip_long_line,
+    format_bool,
     format_text,
     pluralize,
     translate_validity,
@@ -304,10 +305,10 @@ def secret_header(
     message = f"""
 {start_line} Secret detected: {secret_type}{validity_msg}
 {indent}Occurrences: {number_occurrences}
-{indent}Known by GitGuardian dashboard: {"YES" if known_secret else "NO"}
+{indent}Known by GitGuardian dashboard: {format_bool(known_secret)}
 {indent}Incident URL: {secret.incident_url if known_secret and secret.incident_url else "N/A"}
 {indent}Secret SHA: {ignore_sha}
-{indent}Secret in Secrets Manager: {secret.is_vaulted}
+{indent}Secret in Secrets Manager: {format_bool(secret.is_vaulted)}
 """
     if secret.documentation_url is not None:
         message += f"{indent}Detector documentation: {secret.documentation_url}\n"