align the format of printing report urls and errors across all printers; separate printing of summary using blank lines

Author: MarshalX

cycode/cli/apps/scan/code_scanner.py

@@ -571,6 +571,7 @@ def print_results(
     ctx: typer.Context, local_scan_results: list[LocalScanResult], errors: Optional[dict[str, 'CliError']] = None
 ) -> None:
     printer = ctx.obj.get('console_printer')
+    printer.update_ctx(ctx)
     printer.print_scan_results(local_scan_results, errors)
 
 

cycode/cli/printers/console_printer.py

@@ -70,6 +70,9 @@ def printer(self) -> 'PrinterBase':
 
         return printer_class(self.ctx, self.console, self.console_err)
 
+    def update_ctx(self, ctx: 'typer.Context') -> None:
+        self.ctx = ctx
+
     def enable_recording(self, export_type: str, export_file: 'Path') -> None:
         if self.console_record is None:
             self.export_file = export_file
@@ -117,6 +120,7 @@ def export(self) -> None:
             # resolve file extension based on the export type if not provided in the file name
             export_file = export_file.with_suffix(f'.{self.export_type.lower()}')
 
+        export_file = str(export_file)
         if self.export_type is ExportTypeOption.HTML:
             self.console_record.console.save_html(export_file)
         elif self.export_type is ExportTypeOption.SVG:

cycode/cli/printers/printer_base.py

@@ -20,10 +20,10 @@
 
 class PrinterBase(ABC):
     NO_DETECTIONS_MESSAGE = (
-        '[green]Good job! No issues were found!!! :clapping_hands::clapping_hands::clapping_hands:[/]'
+        '[b green]Good job! No issues were found!!! :clapping_hands::clapping_hands::clapping_hands:[/]'
     )
     FAILED_SCAN_MESSAGE = (
-        '[red]Unfortunately, Cycode was unable to complete the full scan. '
+        '[b red]Unfortunately, Cycode was unable to complete the full scan. '
         'Please note that not all results may be available:[/]'
     )
 
@@ -99,6 +99,7 @@ def print_scan_results_summary(self, local_scan_results: list['LocalScanResult']
                         detections_count += 1
                         severity_counts[SeverityOption(detection.severity)] += 1
 
+        self.console.line()
         self.console.print(f'[bold]Cycode found {detections_count} violations[/]', end=': ')
 
         # Example of string: CRITICAL - 6 | HIGH - 0 | MEDIUM - 14 | LOW - 0 | INFO - 0
@@ -110,3 +111,5 @@ def print_scan_results_summary(self, local_scan_results: list['LocalScanResult']
             self.console.print(
                 SeverityOption.get_member_emoji(severity), severity, '-', severity_counts[severity], end=end
             )
+
+        self.console.line()

cycode/cli/printers/tables/sca_table_printer.py

@@ -7,6 +7,7 @@
 from cycode.cli.printers.tables.table import Table
 from cycode.cli.printers.tables.table_models import ColumnInfoBuilder
 from cycode.cli.printers.tables.table_printer_base import TablePrinterBase
+from cycode.cli.printers.utils import is_git_diff_based_scan
 from cycode.cli.printers.utils.detection_ordering.sca_ordering import sort_and_group_detections
 from cycode.cli.utils.string_utils import shortcut_dependency_paths
 
@@ -31,23 +32,19 @@
 
 class ScaTablePrinter(TablePrinterBase):
     def _print_results(self, local_scan_results: list['LocalScanResult']) -> None:
-        aggregation_report_url = self.ctx.obj.get('aggregation_report_url')
         detections_per_policy_id = self._extract_detections_per_policy_id(local_scan_results)
         for policy_id, detections in detections_per_policy_id.items():
             table = self._get_table(policy_id)
 
             resulting_detections, group_separator_indexes = sort_and_group_detections(detections)
             for detection in resulting_detections:
-                self._enrich_table_with_values(policy_id, table, detection)
+                self._enrich_table_with_values(table, detection)
 
             table.set_group_separator_indexes(group_separator_indexes)
 
             self._print_summary_issues(len(detections), self._get_title(policy_id))
             self._print_table(table)
 
-        self.print_scan_results_summary(local_scan_results)
-        self._print_report_urls(local_scan_results, aggregation_report_url)
-
     @staticmethod
     def _get_title(policy_id: str) -> str:
         if policy_id == PACKAGE_VULNERABILITY_POLICY_ID:
@@ -66,7 +63,7 @@ def _get_table(self, policy_id: str) -> Table:
         elif policy_id == LICENSE_COMPLIANCE_POLICY_ID:
             table.add_column(LICENSE_COLUMN)
 
-        if self._is_git_repository():
+        if is_git_diff_based_scan(self.scan_type, self.command_scan_type):
             table.add_column(REPOSITORY_COLUMN)
 
         table.add_column(SEVERITY_COLUMN)
@@ -80,7 +77,7 @@ def _get_table(self, policy_id: str) -> Table:
         return table
 
     @staticmethod
-    def _enrich_table_with_values(policy_id: str, table: Table, detection: Detection) -> None:
+    def _enrich_table_with_values(table: Table, detection: Detection) -> None:
         detection_details = detection.detection_details
 
         if detection.severity:

cycode/cli/printers/tables/table_printer.py

@@ -6,6 +6,7 @@
 from cycode.cli.printers.tables.table import Table
 from cycode.cli.printers.tables.table_models import ColumnInfoBuilder
 from cycode.cli.printers.tables.table_printer_base import TablePrinterBase
+from cycode.cli.printers.utils import is_git_diff_based_scan
 from cycode.cli.printers.utils.detection_ordering.common_ordering import sort_and_group_detections_from_scan_result
 from cycode.cli.utils.string_utils import get_position_in_line, obfuscate_text
 
@@ -37,8 +38,6 @@ def _print_results(self, local_scan_results: list['LocalScanResult']) -> None:
         table.set_group_separator_indexes(group_separator_indexes)
 
         self._print_table(table)
-        self.print_scan_results_summary(local_scan_results)
-        self._print_report_urls(local_scan_results, self.ctx.obj.get('aggregation_report_url'))
 
     def _get_table(self) -> Table:
         table = Table()
@@ -49,7 +48,7 @@ def _get_table(self) -> Table:
         table.add_column(LINE_NUMBER_COLUMN)
         table.add_column(COLUMN_NUMBER_COLUMN)
 
-        if self._is_git_repository():
+        if is_git_diff_based_scan(self.scan_type, self.command_scan_type):
             table.add_column(COMMIT_SHA_COLUMN)
 
         if self.scan_type == SECRET_SCAN_TYPE:

cycode/cli/printers/tables/table_printer_base.py

@@ -11,11 +11,15 @@
 
 
 class TablePrinterBase(PrinterBase, abc.ABC):
+    def __init__(self, *args, **kwargs) -> None:
+        super().__init__(*args, **kwargs)
+        self.text_printer = TextPrinter(self.ctx, self.console, self.console_err)
+
     def print_result(self, result: CliResult) -> None:
-        TextPrinter(self.ctx, self.console, self.console_err).print_result(result)
+        self.text_printer.print_result(result)
 
     def print_error(self, error: CliError) -> None:
-        TextPrinter(self.ctx, self.console, self.console_err).print_error(error)
+        self.text_printer.print_error(error)
 
     def print_scan_results(
         self, local_scan_results: list['LocalScanResult'], errors: Optional[dict[str, 'CliError']] = None
@@ -26,16 +30,8 @@ def print_scan_results(
 
         self._print_results(local_scan_results)
 
-        if not errors:
-            return
-
-        self.console.print(self.FAILED_SCAN_MESSAGE)
-        for scan_id, error in errors.items():
-            self.console.print(f'- {scan_id}: ', end='')
-            self.print_error(error)
-
-    def _is_git_repository(self) -> bool:
-        return self.ctx.info_name in {'commit_history', 'pre_commit', 'pre_receive'} and 'remote_url' in self.ctx.obj
+        self.print_scan_results_summary(local_scan_results)
+        self.text_printer.print_report_urls_and_errors(local_scan_results, errors)
 
     @abc.abstractmethod
     def _print_results(self, local_scan_results: list['LocalScanResult']) -> None:
@@ -44,19 +40,3 @@ def _print_results(self, local_scan_results: list['LocalScanResult']) -> None:
     def _print_table(self, table: 'Table') -> None:
         if table.get_rows():
             self.console.print(table.get_table())
-
-    def _print_report_urls(
-        self,
-        local_scan_results: list['LocalScanResult'],
-        aggregation_report_url: Optional[str] = None,
-    ) -> None:
-        report_urls = [scan_result.report_url for scan_result in local_scan_results if scan_result.report_url]
-        if not report_urls and not aggregation_report_url:
-            return
-        if aggregation_report_url:
-            self.console.print(f'Report URL: {aggregation_report_url}')
-            return
-
-        self.console.print('Report URLs:')
-        for report_url in report_urls:
-            self.console.print(f'- {report_url}')

cycode/cli/printers/text_printer.py

@@ -98,10 +98,15 @@ def print_report_urls_and_errors(
     def print_report_urls(self, report_urls: list[str], aggregation_report_url: Optional[str] = None) -> None:
         if not report_urls and not aggregation_report_url:
             return
-        if aggregation_report_url:
-            self.console.print(f'Report URL: {aggregation_report_url}')
+
+        # Prioritize aggregation report URL; if report urls is only one, use it instead
+        single_url = report_urls[0] if len(report_urls) == 1 else None
+        single_url = aggregation_report_url or single_url
+        if single_url:
+            self.console.print(f'[b]Report URL:[/] {single_url}')
             return
 
-        self.console.print('Report URLs:')
+        # If there are multiple report URLs, print them all
+        self.console.print('[b]Report URLs:[/]')
         for report_url in report_urls:
             self.console.print(f'- {report_url}')

cycode/cli/printers/utils/__init__.py

@@ -0,0 +1,8 @@
+from cycode.cli import consts
+
+
+def is_git_diff_based_scan(scan_type: str, command_scan_type: str) -> bool:
+    return (
+        command_scan_type in consts.COMMIT_RANGE_BASED_COMMAND_SCAN_TYPES
+        and scan_type in consts.COMMIT_RANGE_SCAN_SUPPORTED_SCAN_TYPES
+    )

cycode/cli/printers/utils/code_snippet_syntax.py

@@ -5,6 +5,7 @@
 
 from cycode.cli import consts
 from cycode.cli.console import _SYNTAX_HIGHLIGHT_THEME
+from cycode.cli.printers.utils import is_git_diff_based_scan
 from cycode.cli.utils.string_utils import get_position_in_line, obfuscate_text
 
 if TYPE_CHECKING:
@@ -91,13 +92,6 @@ def _get_code_snippet_syntax_from_git_diff(
     )
 
 
-def _is_git_diff_based_scan(scan_type: str, command_scan_type: str) -> bool:
-    return (
-        command_scan_type in consts.COMMIT_RANGE_BASED_COMMAND_SCAN_TYPES
-        and scan_type in consts.COMMIT_RANGE_SCAN_SUPPORTED_SCAN_TYPES
-    )
-
-
 def get_code_snippet_syntax(
     scan_type: str,
     command_scan_type: str,
@@ -106,7 +100,7 @@ def get_code_snippet_syntax(
     lines_to_display: int = 3,
     obfuscate: bool = True,
 ) -> Syntax:
-    if _is_git_diff_based_scan(scan_type, command_scan_type):
+    if is_git_diff_based_scan(scan_type, command_scan_type):
         # it will return syntax with just one line
         return _get_code_snippet_syntax_from_git_diff(scan_type, detection, document, obfuscate)