cycode 1.9.6.dev1__tar.gz → 1.10.0__tar.gz

{cycode-1.9.6.dev1 → cycode-1.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: cycode
-Version: 1.9.6.dev1
+Version: 1.10.0
 Summary: Boost security in your dev lifecycle via SAST, SCA, Secrets & IaC scanning.
 Home-page: https://github.com/cycodehq/cycode-cli
 License: MIT

cycode-1.10.0/cycode/__init__.py

@@ -0,0 +1 @@
+__version__ = '1.10.0'  # DON'T TOUCH. Placeholder. Will be filled automatically on poetry build from Git Tag

{cycode-1.9.6.dev1 → cycode-1.10.0}/cycode/cli/commands/auth/auth_manager.py

@@ -29,20 +29,20 @@ class AuthManager:
         self.auth_client = AuthClient()
 
     def authenticate(self) -> None:
-        logger.debug('generating pkce code pair')
+        logger.debug('Generating PKCE code pair')
         code_challenge, code_verifier = self._generate_pkce_code_pair()
 
-        logger.debug('starting authentication session')
+        logger.debug('Starting authentication session')
         session_id = self.start_session(code_challenge)
-        logger.debug('authentication session created, %s', {'session_id': session_id})
+        logger.debug('Authentication session created, %s', {'session_id': session_id})
 
-        logger.debug('opening browser and redirecting to cycode login page')
+        logger.debug('Opening browser and redirecting to Cycode login page')
         self.redirect_to_login_page(code_challenge, session_id)
 
-        logger.debug('starting get api token process')
+        logger.debug('Getting API token')
         api_token = self.get_api_token(session_id, code_verifier)
 
-        logger.debug('saving get api token')
+        logger.debug('Saving API token')
         self.save_api_token(api_token)
 
     def start_session(self, code_challenge: str) -> str:
@@ -56,20 +56,20 @@ class AuthManager:
     def get_api_token(self, session_id: str, code_verifier: str) -> 'ApiToken':
         api_token = self.get_api_token_polling(session_id, code_verifier)
         if api_token is None:
-            raise AuthProcessError('getting api token is completed, but the token is missing')
+            raise AuthProcessError('API token pulling is completed, but the token is missing')
         return api_token
 
     def get_api_token_polling(self, session_id: str, code_verifier: str) -> 'ApiToken':
         end_polling_time = time.time() + self.POLLING_TIMEOUT_IN_SECONDS
         while time.time() < end_polling_time:
-            logger.debug('trying to get api token...')
+            logger.debug('Trying to get API token...')
             api_token_polling_response = self.auth_client.get_api_token(session_id, code_verifier)
             if self._is_api_token_process_completed(api_token_polling_response):
-                logger.debug('get api token process completed')
+                logger.debug('Got API token process completion response')
                 return api_token_polling_response.api_token
             if self._is_api_token_process_failed(api_token_polling_response):
-                logger.debug('get api token process failed')
-                raise AuthProcessError('error during getting api token')
+                logger.debug('Got API token process failure response')
+                raise AuthProcessError('Error while obtaining API token')
             time.sleep(self.POLLING_WAIT_INTERVAL_IN_SECONDS)
 
         raise AuthProcessError('session expired')

{cycode-1.9.6.dev1 → cycode-1.10.0}/cycode/cli/commands/report/sbom/common.py

@@ -70,7 +70,7 @@ def send_report_feedback(
 
         client.report_status(report_execution_id, scan_status)
     except Exception as e:
-        logger.debug(f'Failed to send report feedback: {e}')
+        logger.debug('Failed to send report feedback', exc_info=e)
 
 
 def create_sbom_report(

{cycode-1.9.6.dev1 → cycode-1.10.0}/cycode/cli/commands/scan/code_scanner.py

@@ -7,7 +7,6 @@ from typing import TYPE_CHECKING, Callable, Dict, List, Optional, Tuple
 from uuid import UUID, uuid4
 
 import click
-from git import NULL_TREE, Repo
 
 from cycode.cli import consts
 from cycode.cli.config import configuration_manager
@@ -28,9 +27,8 @@ from cycode.cli.files_collector.zip_documents import zip_documents
 from cycode.cli.models import CliError, Document, DocumentDetections, LocalScanResult, Severity
 from cycode.cli.printers import ConsolePrinter
 from cycode.cli.utils import scan_utils
-from cycode.cli.utils.path_utils import (
-    get_path_by_os,
-)
+from cycode.cli.utils.git_proxy import git_proxy
+from cycode.cli.utils.path_utils import get_path_by_os
 from cycode.cli.utils.progress_bar import ScanProgressBarSection
 from cycode.cli.utils.scan_batch import run_parallel_batched_scan
 from cycode.cli.utils.scan_utils import set_issue_detected
@@ -148,14 +146,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]]:
+) -> 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
@@ -200,7 +198,7 @@ def _get_scan_documents_thread_func(
             scan_id = local_scan_result.scan_id
 
         logger.debug(
-            'Finished scan process, %s',
+            'Processing scan results, %s',
             {
                 'all_violations_count': detections_count,
                 'relevant_violations_count': relevant_detections_count,
@@ -224,7 +222,7 @@ def _get_scan_documents_thread_func(
 
         return scan_id, error, local_scan_result
 
-    return _scan_batch_thread_func
+    return _scan_batch_thread_func, aggregation_id
 
 
 def scan_commit_range(
@@ -244,16 +242,16 @@ def scan_commit_range(
     documents_to_scan = []
     commit_ids_to_scan = []
 
-    repo = Repo(path)
+    repo = git_proxy.get_repo(path)
     total_commits_count = int(repo.git.rev_list('--count', commit_range))
-    logger.debug(f'Calculating diffs for {total_commits_count} commits in the commit range {commit_range}')
+    logger.debug('Calculating diffs for %s commits in the commit range %s', total_commits_count, commit_range)
 
     progress_bar.set_section_length(ScanProgressBarSection.PREPARE_LOCAL_FILES, total_commits_count)
 
     scanned_commits_count = 0
     for commit in repo.iter_commits(rev=commit_range):
         if _does_reach_to_max_commits_to_scan_limit(commit_ids_to_scan, max_commits_count):
-            logger.debug(f'Reached to max commits to scan count. Going to scan only {max_commits_count} last commits')
+            logger.debug('Reached to max commits to scan count. Going to scan only %s last commits', max_commits_count)
             progress_bar.update(ScanProgressBarSection.PREPARE_LOCAL_FILES, total_commits_count - scanned_commits_count)
             break
 
@@ -261,7 +259,7 @@ def scan_commit_range(
 
         commit_id = commit.hexsha
         commit_ids_to_scan.append(commit_id)
-        parent = commit.parents[0] if commit.parents else NULL_TREE
+        parent = commit.parents[0] if commit.parents else git_proxy.get_null_tree()
         diff = commit.diff(parent, create_patch=True, R=True)
         commit_documents_to_scan = []
         for blob in diff:
@@ -284,7 +282,7 @@ def scan_commit_range(
         scanned_commits_count += 1
 
     logger.debug('List of commit ids to scan, %s', {'commit_ids': commit_ids_to_scan})
-    logger.debug('Starting to scan commit range (It may take a few minutes)')
+    logger.debug('Starting to scan commit range (it may take a few minutes)')
 
     scan_documents(context, documents_to_scan, is_git_diff=True, is_commit_range=True)
     return None
@@ -307,16 +305,22 @@ def scan_documents(
         ConsolePrinter(context).print_error(
             CliError(
                 code='no_relevant_files',
-                message='Error: The scan could not be completed - relevant files to scan are not found.',
+                message='Error: The scan could not be completed - relevant files to scan are not found. '
+                'Enable verbose mode to see more details.',
             )
         )
         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']
+    )
+    set_aggregation_report_url(context, aggregation_report_url)
     progress_bar.set_section_length(ScanProgressBarSection.GENERATE_REPORT, 1)
     progress_bar.update(ScanProgressBarSection.GENERATE_REPORT)
     progress_bar.stop()
@@ -325,6 +329,25 @@ def scan_documents(
     print_results(context, local_scan_results, errors)
 
 
+def set_aggregation_report_url(context: click.Context, aggregation_report_url: Optional[str] = None) -> None:
+    context.obj['aggregation_report_url'] = 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(
     context: click.Context,
     from_documents_to_scan: List[Document],
@@ -392,7 +415,7 @@ def scan_commit_range_documents(
         scan_id = local_scan_result.scan_id
 
     logger.debug(
-        'Finished scan process, %s',
+        'Processing commit range scan results, %s',
         {
             'all_violations_count': detections_count,
             'relevant_violations_count': relevant_detections_count,
@@ -475,7 +498,7 @@ def perform_scan_async(
     scan_parameters: dict,
 ) -> ZippedFileScanResult:
     scan_async_result = cycode_client.zipped_file_scan_async(zipped_documents, scan_type, scan_parameters)
-    logger.debug('scan request has been triggered successfully, scan id: %s', scan_async_result.scan_id)
+    logger.debug('Async scan request has been triggered successfully, %s', {'scan_id': scan_async_result.scan_id})
 
     return poll_scan_results(
         cycode_client,
@@ -492,7 +515,7 @@ def perform_scan_sync(
     scan_parameters: dict,
 ) -> ZippedFileScanResult:
     scan_results = cycode_client.zipped_file_scan_sync(zipped_documents, scan_type, scan_parameters)
-    logger.debug('scan request has been triggered successfully, scan id: %s', scan_results.id)
+    logger.debug('Sync scan request has been triggered successfully, %s', {'scan_id': scan_results.id})
     return ZippedFileScanResult(
         did_detect=True,
         detections_per_file=_map_detections_per_file(scan_results.detection_messages),
@@ -512,7 +535,9 @@ def perform_commit_range_scan_async(
         from_commit_zipped_documents, to_commit_zipped_documents, scan_type, scan_parameters
     )
 
-    logger.debug('scan request has been triggered successfully, scan id: %s', scan_async_result.scan_id)
+    logger.debug(
+        'Async commit range scan request has been triggered successfully, %s', {'scan_id': scan_async_result.scan_id}
+    )
     return poll_scan_results(
         cycode_client, scan_async_result.scan_id, scan_type, scan_parameters.get('report'), timeout
     )
@@ -552,11 +577,12 @@ def poll_scan_results(
 
 
 def print_debug_scan_details(scan_details_response: 'ScanDetailsResponse') -> None:
-    logger.debug(f'Scan update: (scan_id: {scan_details_response.id})')
-    logger.debug(f'Scan status: {scan_details_response.scan_status}')
+    logger.debug(
+        'Scan update, %s', {'scan_id': scan_details_response.id, 'scan_status': scan_details_response.scan_status}
+    )
 
     if scan_details_response.message:
-        logger.debug(f'Scan message: {scan_details_response.message}')
+        logger.debug('Scan message: %s', scan_details_response.message)
 
 
 def print_results(
@@ -569,14 +595,16 @@ def print_results(
 def get_document_detections(
     scan_result: ZippedFileScanResult, documents_to_scan: List[Document]
 ) -> List[DocumentDetections]:
-    logger.debug('Get document detections')
+    logger.debug('Getting document detections')
 
     document_detections = []
     for detections_per_file in scan_result.detections_per_file:
         file_name = get_path_by_os(detections_per_file.file_name)
         commit_id = detections_per_file.commit_id
 
-        logger.debug('Going to find document of violated file, %s', {'file_name': file_name, 'commit_id': commit_id})
+        logger.debug(
+            'Going to find the document of the violated file., %s', {'file_name': file_name, 'commit_id': commit_id}
+        )
 
         document = _get_document_by_file_name(documents_to_scan, file_name, commit_id)
         document_detections.append(DocumentDetections(document=document, detections=detections_per_file.detections))
@@ -658,11 +686,11 @@ def get_scan_parameters(context: click.Context, paths: Tuple[str]) -> dict:
 
 def try_get_git_remote_url(path: str) -> Optional[str]:
     try:
-        remote_url = Repo(path).remotes[0].config_reader.get('url')
-        logger.debug(f'Found Git remote URL "{remote_url}" in path "{path}"')
+        remote_url = git_proxy.get_repo(path).remotes[0].config_reader.get('url')
+        logger.debug('Found Git remote URL, %s', {'remote_url': remote_url, 'path': path})
         return remote_url
     except Exception as e:
-        logger.debug('Failed to get git remote URL. %s', {'exception_message': str(e)})
+        logger.debug('Failed to get Git remote URL', exc_info=e)
         return None
 
 
@@ -719,15 +747,15 @@ def _should_exclude_detection(detection: Detection, exclusions: Dict) -> bool:
     exclusions_by_value = exclusions.get(consts.EXCLUSIONS_BY_VALUE_SECTION_NAME, [])
     if _is_detection_sha_configured_in_exclusions(detection, exclusions_by_value):
         logger.debug(
-            'Going to ignore violations because is in the values to ignore list, %s',
-            {'sha': detection.detection_details.get('sha512', '')},
+            'Going to ignore violations because they are on the values-to-ignore list, %s',
+            {'value_sha': detection.detection_details.get('sha512', '')},
         )
         return True
 
     exclusions_by_sha = exclusions.get(consts.EXCLUSIONS_BY_SHA_SECTION_NAME, [])
     if _is_detection_sha_configured_in_exclusions(detection, exclusions_by_sha):
         logger.debug(
-            'Going to ignore violations because is in the shas to ignore list, %s',
+            'Going to ignore violations because they are on the SHA ignore list, %s',
             {'sha': detection.detection_details.get('sha512', '')},
         )
         return True
@@ -737,7 +765,7 @@ def _should_exclude_detection(detection: Detection, exclusions: Dict) -> bool:
         detection_rule = detection.detection_rule_id
         if detection_rule in exclusions_by_rule:
             logger.debug(
-                'Going to ignore violations because is in the shas to ignore list, %s',
+                'Going to ignore violations because they are on the Rule ID ignore list, %s',
                 {'detection_rule': detection_rule},
             )
             return True
@@ -747,7 +775,7 @@ def _should_exclude_detection(detection: Detection, exclusions: Dict) -> bool:
         package = _get_package_name(detection)
         if package in exclusions_by_package:
             logger.debug(
-                'Going to ignore violations because is in the packages to ignore list, %s', {'package': package}
+                'Going to ignore violations because they are on the packages-to-ignore list, %s', {'package': package}
             )
             return True
 
@@ -810,7 +838,7 @@ def _report_scan_status(
 
         cycode_client.report_scan_status(scan_type, scan_id, scan_status, should_use_scan_service)
     except Exception as e:
-        logger.debug('Failed to report scan status, %s', {'exception_message': str(e)})
+        logger.debug('Failed to report scan status', exc_info=e)
 
 
 def _generate_unique_id() -> UUID:
@@ -868,7 +896,7 @@ def _try_get_report_url_if_needed(
         report_url_response = cycode_client.get_scan_report_url(scan_id, scan_type)
         return report_url_response.report_url
     except Exception as e:
-        logger.debug('Failed to get report url: %s', str(e))
+        logger.debug('Failed to get report URL', exc_info=e)
 
 
 def wait_for_detections_creation(
@@ -883,16 +911,18 @@ def wait_for_detections_creation(
     while time.time() < end_polling_time:
         scan_persisted_detections_count = cycode_client.get_scan_detections_count(scan_type, scan_id)
         logger.debug(
-            f'Excepted {expected_detections_count} detections, got {scan_persisted_detections_count} detections '
-            f'({expected_detections_count - scan_persisted_detections_count} more; '
-            f'{round(end_polling_time - time.time())} seconds left)'
+            'Excepting %s detections, got %s detections (%s more; %s seconds left)',
+            expected_detections_count,
+            scan_persisted_detections_count,
+            expected_detections_count - scan_persisted_detections_count,
+            round(end_polling_time - time.time()),
         )
         if scan_persisted_detections_count == expected_detections_count:
             return
 
         time.sleep(consts.DETECTIONS_COUNT_VERIFICATION_WAIT_INTERVAL_IN_SECONDS)
 
-    logger.debug(f'{scan_persisted_detections_count} detections has been created')
+    logger.debug('%s detections has been created', scan_persisted_detections_count)
     raise custom_exceptions.ScanAsyncError(
         f'Failed to wait for detections to be created after {polling_timeout} seconds'
     )
@@ -905,14 +935,14 @@ def _map_detections_per_file(detections: List[dict]) -> List[DetectionsPerFile]:
             detection['message'] = detection['correlation_message']
             file_name = _get_file_name_from_detection(detection)
             if file_name is None:
-                logger.debug('file name is missing from detection with id %s', detection.get('id'))
+                logger.debug('File name is missing from detection with ID %s', detection.get('id'))
                 continue
             if detections_per_files.get(file_name) is None:
                 detections_per_files[file_name] = [DetectionSchema().load(detection)]
             else:
                 detections_per_files[file_name].append(DetectionSchema().load(detection))
         except Exception as e:
-            logger.debug('Failed to parse detection: %s', str(e))
+            logger.debug('Failed to parse detection', exc_info=e)
             continue
 
     return [

{cycode-1.9.6.dev1 → cycode-1.10.0}/cycode/cli/commands/scan/pre_commit/pre_commit_command.py

@@ -2,7 +2,6 @@ import os
 from typing import List
 
 import click
-from git import Repo
 
 from cycode.cli import consts
 from cycode.cli.commands.scan.code_scanner import scan_documents, scan_sca_pre_commit
@@ -12,6 +11,7 @@ from cycode.cli.files_collector.repository_documents import (
     get_diff_file_path,
 )
 from cycode.cli.models import Document
+from cycode.cli.utils.git_proxy import git_proxy
 from cycode.cli.utils.path_utils import (
     get_path_by_os,
 )
@@ -31,7 +31,7 @@ def pre_commit_command(context: click.Context, ignored_args: List[str]) -> None:
         scan_sca_pre_commit(context)
         return
 
-    diff_files = Repo(os.getcwd()).index.diff('HEAD', create_patch=True, R=True)
+    diff_files = git_proxy.get_repo(os.getcwd()).index.diff('HEAD', create_patch=True, R=True)
 
     progress_bar.set_section_length(ScanProgressBarSection.PREPARE_LOCAL_FILES, len(diff_files))
 

{cycode-1.9.6.dev1 → cycode-1.10.0}/cycode/cli/commands/scan/pre_receive/pre_receive_command.py

@@ -32,14 +32,14 @@ def pre_receive_command(context: click.Context, ignored_args: List[str]) -> None
 
         if should_skip_pre_receive_scan():
             logger.info(
-                'A scan has been skipped as per your request.'
-                ' Please note that this may leave your system vulnerable to secrets that have not been detected'
+                'A scan has been skipped as per your request. '
+                'Please note that this may leave your system vulnerable to secrets that have not been detected.'
             )
             return
 
         if is_verbose_mode_requested_in_pre_receive_scan():
             enable_verbose_mode(context)
-            logger.debug('Verbose mode enabled, all log levels will be displayed')
+            logger.debug('Verbose mode enabled: all log levels will be displayed.')
 
         command_scan_type = context.info_name
         timeout = configuration_manager.get_pre_receive_command_timeout(command_scan_type)
@@ -51,7 +51,8 @@ def pre_receive_command(context: click.Context, ignored_args: List[str]) -> None
             commit_range = calculate_pre_receive_commit_range(branch_update_details)
             if not commit_range:
                 logger.info(
-                    'No new commits found for pushed branch, %s', {'branch_update_details': branch_update_details}
+                    'No new commits found for pushed branch, %s',
+                    {'branch_update_details': branch_update_details},
                 )
                 return
 

{cycode-1.9.6.dev1 → cycode-1.10.0}/cycode/cli/exceptions/handle_scan_errors.py

@@ -1,11 +1,11 @@
 from typing import Optional
 
 import click
-from git import InvalidGitRepositoryError
 
 from cycode.cli.exceptions import custom_exceptions
 from cycode.cli.models import CliError, CliErrors
 from cycode.cli.printers import ConsolePrinter
+from cycode.cli.utils.git_proxy import git_proxy
 
 
 def handle_scan_exception(
@@ -13,7 +13,7 @@ def handle_scan_exception(
 ) -> Optional[CliError]:
     context.obj['did_fail'] = True
 
-    ConsolePrinter(context).print_exception()
+    ConsolePrinter(context).print_exception(e)
 
     errors: CliErrors = {
         custom_exceptions.NetworkError: CliError(
@@ -49,7 +49,7 @@ def handle_scan_exception(
             'Please make sure that your file is well formed '
             'and execute the scan again',
         ),
-        InvalidGitRepositoryError: CliError(
+        git_proxy.get_invalid_git_repository_error(): CliError(
             soft_fail=False,
             code='invalid_git_error',
             message='The path you supplied does not correlate to a git repository. '
@@ -69,10 +69,13 @@ def handle_scan_exception(
         ConsolePrinter(context).print_error(error)
         return None
 
+    unknown_error = CliError(code='unknown_error', message=str(e))
+
     if return_exception:
-        return CliError(code='unknown_error', message=str(e))
+        return unknown_error
 
     if isinstance(e, click.ClickException):
         raise e
 
-    raise click.ClickException(str(e))
+    ConsolePrinter(context).print_error(unknown_error)
+    exit(1)

{cycode-1.9.6.dev1 → cycode-1.10.0}/cycode/cli/files_collector/excluder.py

@@ -62,23 +62,36 @@ def _does_document_exceed_max_size_limit(content: str) -> bool:
 
 def _is_relevant_file_to_scan(scan_type: str, filename: str) -> bool:
     if _is_subpath_of_cycode_configuration_folder(filename):
-        logger.debug('file is irrelevant because it is in cycode configuration directory, %s', {'filename': filename})
+        logger.debug(
+            'The file is irrelevant because it is in the Cycode configuration directory, %s',
+            {'filename': filename, 'configuration_directory': consts.CYCODE_CONFIGURATION_DIRECTORY},
+        )
         return False
 
     if _is_path_configured_in_exclusions(scan_type, filename):
-        logger.debug('file is irrelevant because the file path is in the ignore paths list, %s', {'filename': filename})
+        logger.debug('The file is irrelevant because its path is in the ignore paths list, %s', {'filename': filename})
         return False
 
     if not _is_file_extension_supported(scan_type, filename):
-        logger.debug('file is irrelevant because the file extension is not supported, %s', {'filename': filename})
+        logger.debug(
+            'The file is irrelevant because its extension is not supported, %s',
+            {'scan_type': scan_type, 'filename': filename},
+        )
         return False
 
     if is_binary_file(filename):
-        logger.debug('file is irrelevant because it is binary file, %s', {'filename': filename})
+        logger.debug('The file is irrelevant because it is a binary file, %s', {'filename': filename})
         return False
 
     if scan_type != consts.SCA_SCAN_TYPE and _does_file_exceed_max_size_limit(filename):
-        logger.debug('file is irrelevant because its exceeded max size limit, %s', {'filename': filename})
+        logger.debug(
+            'The file is irrelevant because it has exceeded the maximum size limit, %s',
+            {
+                'max_file_size': consts.FILE_MAX_SIZE_LIMIT_IN_BYTES,
+                'file_size': get_file_size(filename),
+                'filename': filename,
+            },
+        )
         return False
 
     if scan_type == consts.SCA_SCAN_TYPE and not _is_file_relevant_for_sca_scan(filename):
@@ -89,7 +102,9 @@ def _is_relevant_file_to_scan(scan_type: str, filename: str) -> bool:
 
 def _is_file_relevant_for_sca_scan(filename: str) -> bool:
     if any(sca_excluded_path in filename for sca_excluded_path in consts.SCA_EXCLUDED_PATHS):
-        logger.debug("file is irrelevant because it is from node_modules's inner path, %s", {'filename': filename})
+        logger.debug(
+            'The file is irrelevant because it is from the inner path of node_modules, %s', {'filename': filename}
+        )
         return False
 
     return True
@@ -98,27 +113,39 @@ def _is_file_relevant_for_sca_scan(filename: str) -> bool:
 def _is_relevant_document_to_scan(scan_type: str, filename: str, content: str) -> bool:
     if _is_subpath_of_cycode_configuration_folder(filename):
         logger.debug(
-            'document is irrelevant because it is in cycode configuration directory, %s', {'filename': filename}
+            'The document is irrelevant because it is in the Cycode configuration directory, %s',
+            {'filename': filename, 'configuration_directory': consts.CYCODE_CONFIGURATION_DIRECTORY},
         )
         return False
 
     if _is_path_configured_in_exclusions(scan_type, filename):
         logger.debug(
-            'document is irrelevant because the document path is in the ignore paths list, %s', {'filename': filename}
+            'The document is irrelevant because its path is in the ignore paths list, %s', {'filename': filename}
         )
         return False
 
     if not _is_file_extension_supported(scan_type, filename):
-        logger.debug('document is irrelevant because the file extension is not supported, %s', {'filename': filename})
+        logger.debug(
+            'The document is irrelevant because its extension is not supported, %s',
+            {'scan_type': scan_type, 'filename': filename},
+        )
         return False
 
     if is_binary_content(content):
-        logger.debug('document is irrelevant because it is binary, %s', {'filename': filename})
+        logger.debug('The document is irrelevant because it is a binary file, %s', {'filename': filename})
         return False
 
     if scan_type != consts.SCA_SCAN_TYPE and _does_document_exceed_max_size_limit(content):
-        logger.debug('document is irrelevant because its exceeded max size limit, %s', {'filename': filename})
+        logger.debug(
+            'The document is irrelevant because it has exceeded the maximum size limit, %s',
+            {
+                'max_document_size': consts.FILE_MAX_SIZE_LIMIT_IN_BYTES,
+                'document_size': get_content_size(content),
+                'filename': filename,
+            },
+        )
         return False
+
     return True
 
 

{cycode-1.9.6.dev1 → cycode-1.10.0}/cycode/cli/files_collector/path_documents.py

@@ -74,7 +74,7 @@ def _get_relevant_files(
     progress_bar.set_section_length(progress_bar_section, progress_bar_section_len)
 
     logger.debug(
-        'Found all relevant files for scanning %s', {'paths': paths, 'file_to_scan_count': len(relevant_files_to_scan)}
+        'Found all relevant files for scanning, %s', {'paths': paths, 'file_to_scan_count': len(relevant_files_to_scan)}
     )
 
     return relevant_files_to_scan