Skip to content

CM-50594 - Add --maven-settings-file SCA option #324

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 17, 2025
Merged

CM-50594 - Add --maven-settings-file SCA option #324

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3281578
added --maven-settings-file parameter
omerr-cycode Jul 16, 2025
3a42545
ruff format amendments
omerr-cycode Jul 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions cycode/cli/apps/scan/scan_command.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,16 @@ def scan_command(
rich_help_panel=_SCA_RICH_HELP_PANEL,
),
] = False,
maven_settings_file: Annotated[
Optional[Path],
typer.Option(
'--maven-settings-file',
show_default=False,
help='When specified, Cycode will use this settings.xml file when building the maven dependency tree.',
dir_okay=False,
rich_help_panel=_SCA_RICH_HELP_PANEL,
),
] = None,
export_type: Annotated[
ExportTypeOption,
typer.Option(
Expand Down Expand Up @@ -143,6 +153,7 @@ def scan_command(
ctx.obj['sync'] = sync
ctx.obj['severity_threshold'] = severity_threshold
ctx.obj['monitor'] = monitor
ctx.obj['maven_settings_file'] = maven_settings_file
ctx.obj['report'] = report

scan_client = get_scan_cycode_client(ctx)
Expand Down
22 changes: 15 additions & 7 deletions cycode/cli/files_collector/sca/maven/restore_maven_dependencies.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,12 @@ def is_project(self, document: Document) -> bool:
return path.basename(document.path).split('/')[-1] == BUILD_MAVEN_FILE_NAME

def get_commands(self, manifest_file_path: str) -> list[list[str]]:
return [['mvn', 'org.cyclonedx:cyclonedx-maven-plugin:2.7.4:makeAggregateBom', '-f', manifest_file_path]]
command = ['mvn', 'org.cyclonedx:cyclonedx-maven-plugin:2.7.4:makeAggregateBom', '-f', manifest_file_path]

maven_settings_file = self.ctx.obj.get('maven_settings_file')
if maven_settings_file:
command += ['-s', str(maven_settings_file)]
return [command]

def get_lock_file_name(self) -> str:
return join_paths('target', MAVEN_CYCLONE_DEP_TREE_FILE_NAME)
Expand All @@ -46,7 +51,7 @@ def try_restore_dependencies(self, document: Document) -> Optional[Document]:

def restore_from_secondary_command(self, document: Document, manifest_file_path: str) -> Optional[Document]:
restore_content = execute_commands(
commands=create_secondary_restore_commands(manifest_file_path),
commands=self.create_secondary_restore_commands(manifest_file_path),
timeout=self.command_timeout,
working_directory=self.get_working_directory(document),
)
Expand All @@ -61,10 +66,8 @@ def restore_from_secondary_command(self, document: Document, manifest_file_path:
absolute_path=restore_file_path,
)


def create_secondary_restore_commands(manifest_file_path: str) -> list[list[str]]:
return [
[
def create_secondary_restore_commands(self, manifest_file_path: str) -> list[list[str]]:
command = [
'mvn',
'dependency:tree',
'-B',
Expand All @@ -73,4 +76,9 @@ def create_secondary_restore_commands(manifest_file_path: str) -> list[list[str]
manifest_file_path,
f'-DoutputFile={MAVEN_DEP_TREE_FILE_NAME}',
]
]

maven_settings_file = self.ctx.obj.get('maven_settings_file')
if maven_settings_file:
command += ['-s', str(maven_settings_file)]

return [command]
Loading