CM-34882 - Add one report URL for all secrets found in the same scan

cycode/cli/commands/scan/code_scanner.py

@@ -148,14 +148,14 @@ def _enrich_scan_result_with_data_from_detection_rules(
 
 def _get_scan_documents_thread_func(
     context: click.Context, is_git_diff: bool, is_commit_range: bool, scan_parameters: dict
-) -> Callable[[List[Document]], Tuple[str, CliError, LocalScanResult]]:
+) -> List[Tuple[Callable[[List[Document]], Tuple[str, CliError, LocalScanResult]], str]]:
     cycode_client = context.obj['client']
     scan_type = context.obj['scan_type']
     severity_threshold = context.obj['severity_threshold']
     sync_option = context.obj['sync']
     command_scan_type = context.info_name
-
-    scan_parameters['aggregation_id'] = str(_generate_unique_id())
+    aggregation_id = str(_generate_unique_id())
+    scan_parameters['aggregation_id'] = aggregation_id
 
     def _scan_batch_thread_func(batch: List[Document]) -> Tuple[str, CliError, LocalScanResult]:
         local_scan_result = error = error_message = None
@@ -224,7 +224,7 @@ def _scan_batch_thread_func(batch: List[Document]) -> Tuple[str, CliError, Local
 
         return scan_id, error, local_scan_result
 
-    return _scan_batch_thread_func
+    return _scan_batch_thread_func, aggregation_id
 
 
 def scan_commit_range(
@@ -312,17 +312,37 @@ def scan_documents(
         )
         return
 
-    scan_batch_thread_func = _get_scan_documents_thread_func(context, is_git_diff, is_commit_range, scan_parameters)
+    scan_batch_thread_func, aggregation_id = _get_scan_documents_thread_func(
+        context, is_git_diff, is_commit_range, scan_parameters
+    )
     errors, local_scan_results = run_parallel_batched_scan(
         scan_batch_thread_func, documents_to_scan, progress_bar=progress_bar
     )
+    aggregation_report_url = _try_get_aggregation_report_url_if_needed(
+        scan_parameters, context.obj['client'], context.obj['scan_type']
+    )
 
     progress_bar.set_section_length(ScanProgressBarSection.GENERATE_REPORT, 1)
     progress_bar.update(ScanProgressBarSection.GENERATE_REPORT)
     progress_bar.stop()
 
     set_issue_detected_by_scan_results(context, local_scan_results)
-    print_results(context, local_scan_results, errors)
+    print_results(context, local_scan_results, errors, aggregation_report_url)
+
+
+def _try_get_aggregation_report_url_if_needed(
+    scan_parameters: dict, cycode_client: 'ScanClient', scan_type: str
+) -> Optional[str]:
+    aggregation_id = scan_parameters.get('aggregation_id')
+    if not scan_parameters.get('report'):
+        return None
+    if aggregation_id is None:
+        return None
+    try:
+        report_url_response = cycode_client.get_scan_aggregation_report_url(aggregation_id, scan_type)
+        return report_url_response.report_url
+    except Exception as e:
+        logger.debug('Failed to get aggregation report url: %s', str(e))
 
 
 def scan_commit_range_documents(
@@ -560,10 +580,13 @@ def print_debug_scan_details(scan_details_response: 'ScanDetailsResponse') -> No
 
 
 def print_results(
-    context: click.Context, local_scan_results: List[LocalScanResult], errors: Optional[Dict[str, 'CliError']] = None
+    context: click.Context,
+    local_scan_results: List[LocalScanResult],
+    errors: Optional[Dict[str, 'CliError']] = None,
+    aggregation_report_url: str = '',
 ) -> None:
     printer = ConsolePrinter(context)
-    printer.print_scan_results(local_scan_results, errors)
+    printer.print_scan_results(local_scan_results, errors, aggregation_report_url=aggregation_report_url)
 
 
 def get_document_detections(

cycode/cli/printers/console_printer.py

@@ -34,10 +34,13 @@ def __init__(self, context: click.Context) -> None:
             raise CycodeError(f'"{self.output_type}" output type is not supported.')
 
     def print_scan_results(
-        self, local_scan_results: List['LocalScanResult'], errors: Optional[Dict[str, 'CliError']] = None
+        self,
+        local_scan_results: List['LocalScanResult'],
+        errors: Optional[Dict[str, 'CliError']] = None,
+        aggregation_report_url: str = '',
     ) -> None:
         printer = self._get_scan_printer()
-        printer.print_scan_results(local_scan_results, errors)
+        printer.print_scan_results(local_scan_results, errors, aggregation_report_url=aggregation_report_url)
 
     def _get_scan_printer(self) -> 'PrinterBase':
         printer_class = self._printer_class

cycode/cli/printers/json_printer.py

@@ -23,7 +23,10 @@ def print_error(self, error: CliError) -> None:
         click.echo(self.get_data_json(result))
 
     def print_scan_results(
-        self, local_scan_results: List['LocalScanResult'], errors: Optional[Dict[str, 'CliError']] = None
+        self,
+        local_scan_results: List['LocalScanResult'],
+        errors: Optional[Dict[str, 'CliError']] = None,
+        aggregation_report_url: str = '',
     ) -> None:
         scan_ids = []
         report_urls = []

cycode/cli/printers/printer_base.py

@@ -21,7 +21,10 @@ def __init__(self, context: click.Context) -> None:
 
     @abstractmethod
     def print_scan_results(
-        self, local_scan_results: List['LocalScanResult'], errors: Optional[Dict[str, 'CliError']] = None
+        self,
+        local_scan_results: List['LocalScanResult'],
+        errors: Optional[Dict[str, 'CliError']] = None,
+        aggregation_report_url: str = '',
     ) -> None:
         pass
 

cycode/cli/printers/tables/sca_table_printer.py

@@ -13,7 +13,6 @@
 if TYPE_CHECKING:
     from cycode.cli.models import LocalScanResult
 
-
 column_builder = ColumnInfoBuilder()
 
 # Building must have strict order. Represents the order of the columns in the table (from left to right)
@@ -29,7 +28,6 @@
 DIRECT_DEPENDENCY_COLUMN = column_builder.build(name='Direct Dependency')
 DEVELOPMENT_DEPENDENCY_COLUMN = column_builder.build(name='Development Dependency')
 
-
 COLUMN_WIDTHS_CONFIG: ColumnWidths = {
     REPOSITORY_COLUMN: 2,
     CODE_PROJECT_COLUMN: 2,
@@ -41,7 +39,7 @@
 
 
 class ScaTablePrinter(TablePrinterBase):
-    def _print_results(self, local_scan_results: List['LocalScanResult']) -> None:
+    def _print_results(self, local_scan_results: List['LocalScanResult'], aggregation_report_url: str = '') -> None:
         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)
@@ -53,7 +51,7 @@ def _print_results(self, local_scan_results: List['LocalScanResult']) -> None:
             self._print_summary_issues(len(detections), self._get_title(policy_id))
             self._print_table(table)
 
-        self._print_report_urls(local_scan_results)
+        self._print_report_urls(local_scan_results, aggregation_report_url)
 
     @staticmethod
     def _get_title(policy_id: str) -> str:

cycode/cli/printers/tables/table_printer.py

@@ -51,7 +51,7 @@
 
 
 class TablePrinter(TablePrinterBase):
-    def _print_results(self, local_scan_results: List['LocalScanResult']) -> None:
+    def _print_results(self, local_scan_results: List['LocalScanResult'], aggregation_report_url: str = '') -> None:
         table = self._get_table()
         if self.scan_type in COLUMN_WIDTHS_CONFIG:
             table.set_cols_width(COLUMN_WIDTHS_CONFIG[self.scan_type])
@@ -63,7 +63,7 @@ def _print_results(self, local_scan_results: List['LocalScanResult']) -> None:
                     self._enrich_table_with_values(table, detection, document_detections.document)
 
         self._print_table(table)
-        self._print_report_urls(local_scan_results)
+        self._print_report_urls(local_scan_results, aggregation_report_url)
 
     def _get_table(self) -> Table:
         table = Table()

cycode/cli/printers/tables/table_printer_base.py

@@ -25,13 +25,16 @@ def print_error(self, error: CliError) -> None:
         TextPrinter(self.context).print_error(error)
 
     def print_scan_results(
-        self, local_scan_results: List['LocalScanResult'], errors: Optional[Dict[str, 'CliError']] = None
+        self,
+        local_scan_results: List['LocalScanResult'],
+        errors: Optional[Dict[str, 'CliError']] = None,
+        aggregation_report_url: str = '',
     ) -> None:
         if not errors and all(result.issue_detected == 0 for result in local_scan_results):
             click.secho('Good job! No issues were found!!! 👏👏👏', fg=self.GREEN_COLOR_NAME)
             return
 
-        self._print_results(local_scan_results)
+        self._print_results(local_scan_results, aggregation_report_url=aggregation_report_url)
 
         if not errors:
             return
@@ -49,7 +52,7 @@ def _is_git_repository(self) -> bool:
         return self.context.obj.get('remote_url') is not None
 
     @abc.abstractmethod
-    def _print_results(self, local_scan_results: List['LocalScanResult']) -> None:
+    def _print_results(self, local_scan_results: List['LocalScanResult'], aggregation_report_url: str = '') -> None:
         raise NotImplementedError
 
     @staticmethod
@@ -58,9 +61,12 @@ def _print_table(table: 'Table') -> None:
             click.echo(table.get_table().draw())
 
     @staticmethod
-    def _print_report_urls(local_scan_results: List['LocalScanResult']) -> None:
+    def _print_report_urls(local_scan_results: List['LocalScanResult'], aggregation_report_url: str = '') -> None:
         report_urls = [scan_result.report_url for scan_result in local_scan_results if scan_result.report_url]
-        if not report_urls:
+        if not report_urls and not aggregation_report_url:
+            return
+        if aggregation_report_url:
+            click.echo(f'Report URL: {aggregation_report_url}')
             return
 
         click.echo('Report URLs:')

cycode/cli/printers/text_printer.py

@@ -31,7 +31,10 @@ def print_error(self, error: CliError) -> None:
         click.secho(error.message, fg=self.RED_COLOR_NAME)
 
     def print_scan_results(
-        self, local_scan_results: List['LocalScanResult'], errors: Optional[Dict[str, 'CliError']] = None
+        self,
+        local_scan_results: List['LocalScanResult'],
+        errors: Optional[Dict[str, 'CliError']] = None,
+        aggregation_report_url: str = '',
     ) -> None:
         if not errors and all(result.issue_detected == 0 for result in local_scan_results):
             click.secho('Good job! No issues were found!!! 👏👏👏', fg=self.GREEN_COLOR_NAME)

cycode/cyclient/scan_client.py

@@ -59,7 +59,7 @@ def get_scan_service_url_path(
         self, scan_type: str, should_use_scan_service: bool = False, should_use_sync_flow: bool = False
     ) -> str:
         service_path = self.scan_config.get_service_name(scan_type, should_use_scan_service)
-        controller_path = self.get_scan_controller_path(scan_type)
+        controller_path = self.get_scan_controller_path(scan_type, should_use_scan_service)
         flow_type = self.get_scan_flow_type(should_use_sync_flow)
         return f'{service_path}/{controller_path}{flow_type}'
 
@@ -92,6 +92,12 @@ def get_scan_report_url(self, scan_id: str, scan_type: str) -> models.ScanReport
         response = self.scan_cycode_client.get(url_path=self.get_scan_report_url_path(scan_id, scan_type))
         return models.ScanReportUrlResponseSchema().build_dto(response.json())
 
+    def get_scan_aggregation_report_url(self, aggregation_id: str, scan_type: str) -> models.ScanReportUrlResponse:
+        response = self.scan_cycode_client.get(
+            url_path=self.get_scan_aggregation_report_url_path(aggregation_id, scan_type)
+        )
+        return models.ScanReportUrlResponseSchema().build_dto(response.json())
+
     def get_zipped_file_scan_async_url_path(self, scan_type: str, should_use_sync_flow: bool = False) -> str:
         async_scan_type = self.scan_config.get_async_scan_type(scan_type)
         async_entity_type = self.scan_config.get_async_entity_type(scan_type)
@@ -155,6 +161,12 @@ def get_scan_details_path(self, scan_type: str, scan_id: str) -> str:
     def get_scan_report_url_path(self, scan_id: str, scan_type: str) -> str:
         return f'{self.get_scan_service_url_path(scan_type, should_use_scan_service=True)}/reportUrl/{scan_id}'
 
+    def get_scan_aggregation_report_url_path(self, aggregation_id: str, scan_type: str) -> str:
+        return (
+            f'{self.get_scan_service_url_path(scan_type, should_use_scan_service=True)}'
+            f'/reportUrlByAggregationId/{aggregation_id}'
+        )
+
     def get_scan_details(self, scan_type: str, scan_id: str) -> models.ScanDetailsResponse:
         path = self.get_scan_details_path(scan_type, scan_id)
         response = self.scan_cycode_client.get(url_path=path)

tests/cyclient/mocked_responses/scan_client.py

@@ -85,6 +85,12 @@ def get_scan_report_url(scan_id: Optional[UUID], scan_client: ScanClient, scan_t
     return f'{api_url}/{service_url}'
 
 
+def get_scan_aggregation_report_url(aggregation_id: Optional[UUID], scan_client: ScanClient, scan_type: str) -> str:
+    api_url = scan_client.scan_cycode_client.api_url
+    service_url = scan_client.get_scan_aggregation_report_url_path(str(aggregation_id), scan_type)
+    return f'{api_url}/{service_url}'
+
+
 def get_scan_report_url_response(url: str, scan_id: Optional[UUID] = None) -> responses.Response:
     if not scan_id:
         scan_id = uuid4()
@@ -93,6 +99,14 @@ def get_scan_report_url_response(url: str, scan_id: Optional[UUID] = None) -> re
     return responses.Response(method=responses.GET, url=url, json=json_response, status=200)
 
 
+def get_scan_aggregation_report_url_response(url: str, aggregation_id: Optional[UUID] = None) -> responses.Response:
+    if not aggregation_id:
+        aggregation_id = uuid4()
+    json_response = {'report_url': f'https://app.domain/cli-logs-aggregation/{aggregation_id}'}
+
+    return responses.Response(method=responses.GET, url=url, json=json_response, status=200)
+
+
 def get_scan_details_response(url: str, scan_id: Optional[UUID] = None) -> responses.Response:
     if not scan_id:
         scan_id = uuid4()

tests/test_code_scanner.py

@@ -4,12 +4,20 @@
 import pytest
 import responses
 
-from cycode.cli.commands.scan.code_scanner import _try_get_report_url_if_needed
+from cycode.cli.commands.scan.code_scanner import (
+    _try_get_aggregation_report_url_if_needed,
+    _try_get_report_url_if_needed,
+)
 from cycode.cli.config import config
 from cycode.cli.files_collector.excluder import _is_relevant_file_to_scan
 from cycode.cyclient.scan_client import ScanClient
 from tests.conftest import TEST_FILES_PATH
-from tests.cyclient.mocked_responses.scan_client import get_scan_report_url, get_scan_report_url_response
+from tests.cyclient.mocked_responses.scan_client import (
+    get_scan_aggregation_report_url,
+    get_scan_aggregation_report_url_response,
+    get_scan_report_url,
+    get_scan_report_url_response,
+)
 
 
 def test_is_relevant_file_to_scan_sca() -> None:
@@ -37,3 +45,39 @@ def test_try_get_report_url_if_needed_return_result(
     scan_report_url_response = scan_client.get_scan_report_url(str(scan_id), scan_type)
     result = _try_get_report_url_if_needed(scan_client, True, str(scan_id), scan_type)
     assert result == scan_report_url_response.report_url
+
+
+@pytest.mark.parametrize('scan_type', config['scans']['supported_scans'])
+def test_try_get_aggregation_report_url_if_no_report_command_needed_return_none(
+    scan_type: str, scan_client: ScanClient
+) -> None:
+    aggregation_id = uuid4().hex
+    scan_parameter = {'aggregation_id': aggregation_id}
+    result = _try_get_aggregation_report_url_if_needed(scan_parameter, scan_client, scan_type)
+    assert result is None
+
+
+@pytest.mark.parametrize('scan_type', config['scans']['supported_scans'])
+def test_try_get_aggregation_report_url_if_no_aggregation_id_needed_return_none(
+    scan_type: str, scan_client: ScanClient
+) -> None:
+    scan_parameter = {'report': True}
+    result = _try_get_aggregation_report_url_if_needed(scan_parameter, scan_client, scan_type)
+    assert result is None
+
+
+@pytest.mark.parametrize('scan_type', config['scans']['supported_scans'])
+@responses.activate
+def test_try_get_aggregation_report_url_if_needed_return_result(
+    scan_type: str, scan_client: ScanClient, api_token_response: responses.Response
+) -> None:
+    aggregation_id = uuid4()
+    scan_parameter = {'report': True, 'aggregation_id': aggregation_id}
+    url = get_scan_aggregation_report_url(aggregation_id, scan_client, scan_type)
+    responses.add(api_token_response)  # mock token based client
+    responses.add(get_scan_aggregation_report_url_response(url, aggregation_id))
+
+    scan_aggregation_report_url_response = scan_client.get_scan_aggregation_report_url(str(aggregation_id), scan_type)
+
+    result = _try_get_aggregation_report_url_if_needed(scan_parameter, scan_client, scan_type)
+    assert result == scan_aggregation_report_url_response.report_url