move export options from root to scan command

Author: MarshalX

cycode/cli/app.py

@@ -1,5 +1,4 @@
 import logging
-from pathlib import Path
 from typing import Annotated, Optional
 
 import typer
@@ -8,7 +7,7 @@
 
 from cycode import __version__
 from cycode.cli.apps import ai_remediation, auth, configure, ignore, report, scan, status
-from cycode.cli.cli_types import ExportTypeOption, OutputTypeOption
+from cycode.cli.cli_types import OutputTypeOption
 from cycode.cli.consts import CLI_CONTEXT_SETTINGS
 from cycode.cli.printers import ConsolePrinter
 from cycode.cli.user_settings.configuration_manager import ConfigurationManager
@@ -70,7 +69,6 @@ def export_if_needed_on_close(ctx: typer.Context) -> None:
 
 
 _COMPLETION_RICH_HELP_PANEL = 'Completion options'
-_EXPORT_RICH_HELP_PANEL = 'Export options'
 
 
 @app.callback()
@@ -90,27 +88,6 @@ def app_callback(
         Optional[str],
         typer.Option(hidden=True, help='Characteristic JSON object that lets servers identify the application.'),
     ] = None,
-    export_type: Annotated[
-        ExportTypeOption,
-        typer.Option(
-            '--export-type',
-            case_sensitive=False,
-            help='Specify the export type. '
-            'HTML and SVG will export terminal output and rely on --output option. '
-            'JSON always exports JSON.',
-            rich_help_panel=_EXPORT_RICH_HELP_PANEL,
-        ),
-    ] = ExportTypeOption.JSON,
-    export_file: Annotated[
-        Optional[Path],
-        typer.Option(
-            '--export-file',
-            help='Export file. Path to the file where the export will be saved. ',
-            dir_okay=False,
-            writable=True,
-            rich_help_panel=_EXPORT_RICH_HELP_PANEL,
-        ),
-    ] = None,
     _: Annotated[
         Optional[bool],
         typer.Option(
@@ -152,8 +129,6 @@ def app_callback(
 
     ctx.obj['progress_bar'] = get_progress_bar(hidden=no_progress_meter, sections=SCAN_PROGRESS_BAR_SECTIONS)
 
-    ctx.obj['export_type'] = export_type
-    ctx.obj['export_file'] = export_file
     ctx.obj['console_printer'] = ConsolePrinter(ctx)
     ctx.call_on_close(lambda: export_if_needed_on_close(ctx))
 

cycode/cli/apps/scan/scan_command.py

@@ -1,9 +1,10 @@
+from pathlib import Path
 from typing import Annotated, Optional
 
 import click
 import typer
 
-from cycode.cli.cli_types import ScanTypeOption, ScaScanTypeOption, SeverityOption
+from cycode.cli.cli_types import ExportTypeOption, ScanTypeOption, ScaScanTypeOption, SeverityOption
 from cycode.cli.consts import (
     ISSUE_DETECTED_STATUS_CODE,
     NO_ISSUES_STATUS_CODE,
@@ -13,6 +14,7 @@
 from cycode.cli.utils.sentry import add_breadcrumb
 
 _AUTH_RICH_HELP_PANEL = 'Authentication options'
+_EXPORT_RICH_HELP_PANEL = 'Export options'
 _SCA_RICH_HELP_PANEL = 'SCA options'
 
 
@@ -66,6 +68,27 @@ def scan_command(
             'A link to the report will be displayed in the console output.',
         ),
     ] = False,
+    export_type: Annotated[
+        ExportTypeOption,
+        typer.Option(
+            '--export-type',
+            case_sensitive=False,
+            help='Specify the export type. '
+            'HTML and SVG will export terminal output and rely on --output option. '
+            'JSON always exports JSON.',
+            rich_help_panel=_EXPORT_RICH_HELP_PANEL,
+        ),
+    ] = ExportTypeOption.JSON,
+    export_file: Annotated[
+        Optional[Path],
+        typer.Option(
+            '--export-file',
+            help='Export file. Path to the file where the export will be saved. ',
+            dir_okay=False,
+            writable=True,
+            rich_help_panel=_EXPORT_RICH_HELP_PANEL,
+        ),
+    ] = None,
     sca_scan: Annotated[
         list[ScaScanTypeOption],
         typer.Option(
@@ -124,6 +147,10 @@ def scan_command(
     ctx.obj['monitor'] = monitor
     ctx.obj['report'] = report
 
+    if export_file:
+        console_printer = ctx.obj['console_printer']
+        console_printer.enable_recording(export_type, export_file)
+
     _ = no_restore, gradle_all_sub_projects  # they are actually used; via ctx.params
 
     _sca_scan_to_context(ctx, sca_scan)

cycode/cli/printers/console_printer.py

@@ -16,6 +16,8 @@
 from cycode.cli.printers.text_printer import TextPrinter
 
 if TYPE_CHECKING:
+    from pathlib import Path
+
     from cycode.cli.models import LocalScanResult
     from cycode.cli.printers.tables.table_printer_base import PrinterBase
 
@@ -43,17 +45,9 @@ def __init__(
         self.console_err = console_err_override or console_err
         self.output_type = output_type_override or self.ctx.obj.get('output')
 
-        self.console_record = None
-
-        self.export_type = self.ctx.obj.get('export_type')
-        self.export_file = self.ctx.obj.get('export_file')
-        if console_override is None and self.export_type and self.export_file:
-            self.console_record = ConsolePrinter(
-                ctx,
-                console_override=Console(record=True, file=io.StringIO()),
-                console_err_override=Console(stderr=True, record=True, file=io.StringIO()),
-                output_type_override='json' if self.export_type == 'json' else self.output_type,
-            )
+        self.export_type: Optional[str] = None
+        self.export_file: Optional[Path] = None
+        self.console_record: Optional[ConsolePrinter] = None
 
     @property
     def scan_type(self) -> str:
@@ -76,6 +70,18 @@ def printer(self) -> 'PrinterBase':
 
         return printer_class(self.ctx, self.console, self.console_err)
 
+    def enable_recording(self, export_type: str, export_file: 'Path') -> None:
+        if self.console_record is None:
+            self.export_file = export_file
+            self.export_type = export_type
+
+            self.console_record = ConsolePrinter(
+                self.ctx,
+                console_override=Console(record=True, file=io.StringIO()),
+                console_err_override=Console(stderr=True, record=True, file=io.StringIO()),
+                output_type_override='json' if self.export_type == 'json' else self.output_type,
+            )
+
     def print_scan_results(
         self,
         local_scan_results: list['LocalScanResult'],
@@ -106,16 +112,17 @@ def export(self) -> None:
         if self.console_record is None:
             raise CycodeError('Console recording was not enabled. Cannot export.')
 
-        if not self.export_file.suffix:
+        export_file = self.export_file
+        if not export_file.suffix:
             # resolve file extension based on the export type if not provided in the file name
-            self.export_file = self.export_file.with_suffix(f'.{self.export_type.lower()}')
+            export_file = export_file.with_suffix(f'.{self.export_type.lower()}')
 
         if self.export_type is ExportTypeOption.HTML:
-            self.console_record.console.save_html(self.export_file)
+            self.console_record.console.save_html(export_file)
         elif self.export_type is ExportTypeOption.SVG:
-            self.console_record.console.save_svg(self.export_file, title=consts.APP_NAME)
+            self.console_record.console.save_svg(export_file, title=consts.APP_NAME)
         elif self.export_type is ExportTypeOption.JSON:
-            with open(self.export_file, 'w', encoding='UTF-8') as f:
+            with open(export_file, 'w', encoding='UTF-8') as f:
                 self.console_record.console.file.seek(0)
                 f.write(self.console_record.console.file.read())
         else: