CM-44581 gradle - support restore projects and by selecting specific project

Author: morsa4406

cycode/cli/commands/scan/scan_command.py

@@ -13,7 +13,8 @@
 from cycode.cli.consts import (
     ISSUE_DETECTED_STATUS_CODE,
     NO_ISSUES_STATUS_CODE,
-    SCA_SKIP_RESTORE_DEPENDENCIES_FLAG, SCA_GRADLE_ALL_SUB_PROJECTS_FLAG,
+    SCA_GRADLE_ALL_SUB_PROJECTS_FLAG,
+    SCA_SKIP_RESTORE_DEPENDENCIES_FLAG,
 )
 from cycode.cli.models import Severity
 from cycode.cli.sentry import add_breadcrumb
@@ -114,7 +115,8 @@
     f'--{SCA_GRADLE_ALL_SUB_PROJECTS_FLAG}',
     is_flag=True,
     default=False,
-    help='When specified, Cycode will run gradle restore command for all sub projects. Should run from root project directory ONLY!',
+    help='When specified, Cycode will run gradle restore command for all sub projects. '
+    'Should run from root project directory ONLY!',
     type=bool,
     required=False,
 )
@@ -132,7 +134,7 @@ def scan_command(
     report: bool,
     no_restore: bool,
     sync: bool,
-    gradle_all_sub_projects: bool
+    gradle_all_sub_projects: bool,
 ) -> int:
     """Scans for Secrets, IaC, SCA or SAST violations."""
     add_breadcrumb('scan')

cycode/cli/files_collector/sca/maven/restore_gradle_dependencies.py

@@ -1,6 +1,6 @@
 import os
 import re
-from typing import List, Set, Optional
+from typing import List, Optional, Set
 
 import click
 
@@ -19,21 +19,26 @@
 
 
 class RestoreGradleDependencies(BaseRestoreDependencies):
-    def __init__(self, context: click.Context, is_git_diff: bool, command_timeout: int,
-                 projects: Set[str] = set()) -> None:
+    def __init__(
+        self, context: click.Context, is_git_diff: bool, command_timeout: int, projects: Optional[Set[str]] = None
+    ) -> None:
         super().__init__(context, is_git_diff, command_timeout, create_output_file_manually=True)
-        self.projects = projects
-        self.projects = self.get_all_projects() if self.is_gradle_sub_projects() else set()
+        if projects is None:
+            projects = set()
+        self.projects = self.get_all_projects() if self.is_gradle_sub_projects() else projects
 
-    def is_gradle_sub_projects(self):
+    def is_gradle_sub_projects(self) -> bool:
         return self.context.obj.get(SCA_GRADLE_ALL_SUB_PROJECTS_FLAG)
 
     def is_project(self, document: Document) -> bool:
         return document.path.endswith(BUILD_GRADLE_FILE_NAME) or document.path.endswith(BUILD_GRADLE_KTS_FILE_NAME)
 
     def get_commands(self, manifest_file_path: str) -> List[List[str]]:
-        return self.get_commands_for_sub_projects(manifest_file_path) if self.is_gradle_sub_projects() else [
-            ['gradle', 'dependencies', '-b', manifest_file_path, '-q', '--console', 'plain']]
+        return (
+            self.get_commands_for_sub_projects(manifest_file_path)
+            if self.is_gradle_sub_projects()
+            else [['gradle', 'dependencies', '-b', manifest_file_path, '-q', '--console', 'plain']]
+        )
 
     def get_lock_file_name(self) -> str:
         return BUILD_GRADLE_DEP_TREE_FILE_NAME
@@ -44,9 +49,12 @@ def verify_restore_file_already_exist(self, restore_file_path: str) -> bool:
     def get_working_directory(self, document: Document) -> Optional[str]:
         return get_path_from_context(self.context) if self.is_gradle_sub_projects() else None
 
-    def get_all_projects(self) -> List[str]:
-        projects_output = shell(command=BUILD_GRADLE_ALL_PROJECTS_COMMAND, timeout=BUILD_GRADLE_ALL_PROJECTS_TIMEOUT,
-                                working_directory=get_path_from_context(self.context))
+    def get_all_projects(self) -> Set[str]:
+        projects_output = shell(
+            command=BUILD_GRADLE_ALL_PROJECTS_COMMAND,
+            timeout=BUILD_GRADLE_ALL_PROJECTS_TIMEOUT,
+            working_directory=get_path_from_context(self.context),
+        )
 
         projects = re.findall(ALL_PROJECTS_REGEX, projects_output)
 
@@ -55,5 +63,8 @@ def get_all_projects(self) -> List[str]:
     def get_commands_for_sub_projects(self, manifest_file_path: str) -> List[List[str]]:
         project_name = os.path.basename(os.path.dirname(manifest_file_path))
         project_name = f':{project_name}'
-        return [['gradle', f'{project_name}:dependencies', '-q', '--console',
-                 'plain']] if project_name in self.projects else []
+        return (
+            [['gradle', f'{project_name}:dependencies', '-q', '--console', 'plain']]
+            if project_name in self.projects
+            else []
+        )

cycode/cli/utils/scan_batch.py

@@ -51,10 +51,7 @@ def run_parallel_batched_scan(
 ) -> Tuple[Dict[str, 'CliError'], List['LocalScanResult']]:
     max_size = consts.SCAN_BATCH_MAX_SIZE_IN_BYTES.get(scan_type, consts.DEFAULT_SCAN_BATCH_MAX_SIZE_IN_BYTES)
 
-    if scan_type == consts.SCA_SCAN_TYPE:
-        batches = [documents]
-    else:
-        batches = split_documents_into_batches(documents, max_size)
+    batches = [documents] if scan_type == consts.SCA_SCAN_TYPE else split_documents_into_batches(documents, max_size)
 
     progress_bar.set_section_length(ScanProgressBarSection.SCAN, len(batches))  # * 3
     # TODO(MarshalX): we should multiply the count of batches in SCAN section because each batch has 3 steps: