fixup! feat(text-output): only display introduced secrets unless verbose is enabled

Author: Walz

ggshield/verticals/secret/output/secret_text_output_handler.py

@@ -1,6 +1,6 @@
 import shutil
 from io import StringIO
-from typing import Dict, List, Optional, Tuple
+from typing import Dict, List, Optional, Set, Tuple
 
 from pygitguardian.client import VERSIONS
 from pygitguardian.models import DiffKind, PolicyBreak
@@ -31,9 +31,9 @@
 class SecretTextOutputHandler(SecretOutputHandler):
     def _process_scan_impl(self, scan: SecretScanCollection) -> str:
         """Output Secret Scan Collection in text format"""
-        diff_kinds = [DiffKind.ADDITION]
+        diff_kinds: Set[DiffKind] = {DiffKind.ADDITION}
         if self.verbose:
-            diff_kinds += [DiffKind.DELETION, DiffKind.CONTEXT]
+            diff_kinds.update((DiffKind.DELETION, DiffKind.CONTEXT))
 
         processed_scan_results = self.process_scan_results(scan, diff_kinds=diff_kinds)
         scan_buf = StringIO()
@@ -77,7 +77,7 @@ def _process_scan_impl(self, scan: SecretScanCollection) -> str:
     def process_scan_results(
         self,
         scan: SecretScanCollection,
-        diff_kinds: List[DiffKind],
+        diff_kinds: Set[DiffKind],
         show_only_known_secrets: bool = False,
     ) -> str:
         """Iterate through the scans and sub-scan results to prepare the display."""
@@ -108,7 +108,7 @@ def process_scan_results(
     def process_result(
         self,
         result: Result,
-        diff_kinds: List[DiffKind],
+        diff_kinds: Set[DiffKind],
         show_only_known_secrets: bool = False,
     ) -> str:
         """
@@ -122,7 +122,7 @@ def process_result(
         result_buf = StringIO()
 
         sha_dict = group_policy_breaks_by_ignore_sha(
-            result.policy_breaks(diff_kinds=diff_kinds)
+            result.get_policy_breaks(diff_kinds=diff_kinds)
         )
 
         if not self.show_secrets:

ggshield/verticals/secret/secret_scan_collection.py

@@ -1,6 +1,17 @@
 from dataclasses import dataclass, field
 from pathlib import Path
-from typing import Any, Dict, Iterable, List, NamedTuple, Optional, Tuple, Union, cast
+from typing import (
+    Any,
+    Dict,
+    Iterable,
+    List,
+    NamedTuple,
+    Optional,
+    Set,
+    Tuple,
+    Union,
+    cast,
+)
 
 from pygitguardian import GGClient
 from pygitguardian.models import (
@@ -77,17 +88,16 @@ def censor(self) -> None:
     def has_policy_breaks(self) -> bool:
         return self.scan.has_policy_breaks
 
-    def policy_breaks(
-        self, *, diff_kinds: Optional[List[DiffKind]] = None
+    def get_policy_breaks(
+        self, *, diff_kinds: Optional[Set[DiffKind]] = None
     ) -> List[PolicyBreak]:
-        policy_breaks = self.scan.policy_breaks
         if diff_kinds is not None and self.scan.is_diff:
-            policy_breaks = [
+            return [
                 policy_break
                 for policy_break in self.scan.policy_breaks
                 if policy_break.diff_kind in diff_kinds
             ]
-        return policy_breaks
+        return self.scan.policy_breaks
 
 
 class Error(NamedTuple):