CM-45153, CM-45154, CM-45155, CM-45156, CM-45546 - Migrate CLI from Click to Typer

Author: MarshalX

cycode/cli/__main__.py

@@ -0,0 +1,3 @@
+from cycode.cli.main import app
+
+app()

cycode/cli/app.py

@@ -0,0 +1,87 @@
+import logging
+from typing import Annotated, Optional
+
+import typer
+
+from cycode import __version__
+from cycode.cli.apps import ai_remediation, auth, configure, ignore, report, scan, status
+from cycode.cli.cli_types import OutputTypeOption
+from cycode.cli.consts import CLI_CONTEXT_SETTINGS
+from cycode.cli.user_settings.configuration_manager import ConfigurationManager
+from cycode.cli.utils.progress_bar import SCAN_PROGRESS_BAR_SECTIONS, get_progress_bar
+from cycode.cli.utils.sentry import add_breadcrumb, init_sentry
+from cycode.cli.utils.version_checker import version_checker
+from cycode.cyclient.config import set_logging_level
+from cycode.cyclient.cycode_client_base import CycodeClientBase
+from cycode.cyclient.models import UserAgentOptionScheme
+
+app = typer.Typer(
+    pretty_exceptions_show_locals=False,
+    pretty_exceptions_short=True,
+    context_settings=CLI_CONTEXT_SETTINGS,
+    rich_markup_mode='rich',
+)
+
+app.add_typer(ai_remediation.app)
+app.add_typer(auth.app)
+app.add_typer(configure.app)
+app.add_typer(ignore.app)
+app.add_typer(report.app)
+app.add_typer(scan.app)
+app.add_typer(status.app)
+
+
+def check_latest_version_on_close(ctx: typer.Context) -> None:
+    output = ctx.obj.get('output')
+    # don't print anything if the output is JSON
+    if output == OutputTypeOption.JSON:
+        return
+
+    # we always want to check the latest version for "version" and "status" commands
+    should_use_cache = ctx.invoked_subcommand not in {'version', 'status'}
+    version_checker.check_and_notify_update(
+        current_version=__version__, use_color=ctx.color, use_cache=should_use_cache
+    )
+
+
+@app.callback()
+def app_callback(
+    ctx: typer.Context,
+    verbose: Annotated[bool, typer.Option('--verbose', '-v', help='Show detailed logs.')] = False,
+    no_progress_meter: Annotated[
+        bool, typer.Option('--no-progress-meter', help='Do not show the progress meter.')
+    ] = False,
+    no_update_notifier: Annotated[
+        bool, typer.Option('--no-update-notifier', help='Do not check CLI for updates.')
+    ] = False,
+    output: Annotated[
+        OutputTypeOption, typer.Option('--output', '-o', case_sensitive=False, help='Specify the output type.')
+    ] = OutputTypeOption.TEXT,
+    user_agent: Annotated[
+        Optional[str],
+        typer.Option(hidden=True, help='Characteristic JSON object that lets servers identify the application.'),
+    ] = None,
+) -> None:
+    init_sentry()
+    add_breadcrumb('cycode')
+
+    ctx.ensure_object(dict)
+    configuration_manager = ConfigurationManager()
+
+    verbose = verbose or configuration_manager.get_verbose_flag()
+    ctx.obj['verbose'] = verbose
+    if verbose:
+        set_logging_level(logging.DEBUG)
+
+    ctx.obj['output'] = output
+    if output == OutputTypeOption.JSON:
+        no_progress_meter = True
+
+    ctx.obj['progress_bar'] = get_progress_bar(hidden=no_progress_meter, sections=SCAN_PROGRESS_BAR_SECTIONS)
+
+    if user_agent:
+        user_agent_option = UserAgentOptionScheme().loads(user_agent)
+        CycodeClientBase.enrich_user_agent(user_agent_option.user_agent_suffix)
+
+    if not no_update_notifier:
+        ctx.call_on_close(lambda: check_latest_version_on_close(ctx))

cycode/cli/commands/__init__.py cycode/cli/apps/__init__.pycycode/cli/commands/__init__.py renamed to cycode/cli/apps/__init__.py

@@ -0,0 +1,6 @@
+import typer
+
+from cycode.cli.apps.ai_remediation.ai_remediation_command import ai_remediation_command
+
+app = typer.Typer()
+app.command(name='ai_remediation', short_help='Get AI remediation (INTERNAL).', hidden=True)(ai_remediation_command)

cycode/cli/apps/ai_remediation/__init__.py

@@ -0,0 +1,32 @@
+from typing import Annotated
+from uuid import UUID
+
+import typer
+
+from cycode.cli.apps.ai_remediation.apply_fix import apply_fix
+from cycode.cli.apps.ai_remediation.print_remediation import print_remediation
+from cycode.cli.exceptions.handle_ai_remediation_errors import handle_ai_remediation_exception
+from cycode.cli.utils.get_api_client import get_scan_cycode_client
+
+
+def ai_remediation_command(
+    ctx: typer.Context,
+    detection_id: Annotated[UUID, typer.Argument(help='Detection ID to get remediation for', show_default=False)],
+    fix: Annotated[
+        bool, typer.Option('--fix', help='Apply fixes to resolve violations. Note: fix could be not available.')
+    ] = False,
+) -> None:
+    """Get AI remediation (INTERNAL)."""
+    client = get_scan_cycode_client()
+
+    try:
+        remediation_markdown = client.get_ai_remediation(detection_id)
+        fix_diff = client.get_ai_remediation(detection_id, fix=True)
+        is_fix_available = bool(fix_diff)  # exclude empty string, None, etc.
+
+        if fix:
+            apply_fix(ctx, fix_diff, is_fix_available)
+        else:
+            print_remediation(ctx, remediation_markdown, is_fix_available)
+    except Exception as err:
+        handle_ai_remediation_exception(ctx, err)

cycode/cli/apps/ai_remediation/ai_remediation_command.py

@@ -0,0 +1,25 @@
+import os
+
+import typer
+from patch_ng import fromstring
+
+from cycode.cli.models import CliResult
+from cycode.cli.printers import ConsolePrinter
+
+
+def apply_fix(ctx: typer.Context, diff: str, is_fix_available: bool) -> None:
+    printer = ConsolePrinter(ctx)
+    if not is_fix_available:
+        printer.print_result(CliResult(success=False, message='Fix is not available for this violation'))
+        return
+
+    patch = fromstring(diff.encode('UTF-8'))
+    if patch is False:
+        printer.print_result(CliResult(success=False, message='Failed to parse fix diff'))
+        return
+
+    is_fix_applied = patch.apply(root=os.getcwd(), strip=0)
+    if is_fix_applied:
+        printer.print_result(CliResult(success=True, message='Fix applied successfully'))
+    else:
+        printer.print_result(CliResult(success=False, message='Failed to apply fix'))

cycode/cli/apps/ai_remediation/apply_fix.py

@@ -0,0 +1,15 @@
+import typer
+from rich.console import Console
+from rich.markdown import Markdown
+
+from cycode.cli.models import CliResult
+from cycode.cli.printers import ConsolePrinter
+
+
+def print_remediation(ctx: typer.Context, remediation_markdown: str, is_fix_available: bool) -> None:
+    printer = ConsolePrinter(ctx)
+    if printer.is_json_printer:
+        data = {'remediation': remediation_markdown, 'is_fix_available': is_fix_available}
+        printer.print_result(CliResult(success=True, message='Remediation fetched successfully', data=data))
+    else:  # text or table
+        Console().print(Markdown(remediation_markdown))

cycode/cli/apps/ai_remediation/print_remediation.py

@@ -0,0 +1,11 @@
+import typer
+
+from cycode.cli.apps.auth.auth_command import auth_command
+from cycode.cli.apps.auth.check_command import check_command
+
+app = typer.Typer(
+    name='auth',
+    help='Authenticate your machine to associate the CLI with your Cycode account.',
+)
+app.callback(invoke_without_command=True)(auth_command)
+app.command(name='check')(check_command)

cycode/cli/apps/auth/__init__.py

@@ -0,0 +1,28 @@
+import typer
+
+from cycode.cli.apps.auth.auth_manager import AuthManager
+from cycode.cli.exceptions.handle_auth_errors import handle_auth_exception
+from cycode.cli.models import CliResult
+from cycode.cli.printers import ConsolePrinter
+from cycode.cli.utils.sentry import add_breadcrumb
+from cycode.cyclient import logger
+
+
+def auth_command(ctx: typer.Context) -> None:
+    """Authenticates your machine."""
+    add_breadcrumb('auth')
+
+    if ctx.invoked_subcommand is not None:
+        # if it is a subcommand, do nothing
+        return
+
+    try:
+        logger.debug('Starting authentication process')
+
+        auth_manager = AuthManager()
+        auth_manager.authenticate()
+
+        result = CliResult(success=True, message='Successfully logged into cycode')
+        ConsolePrinter(ctx).print_result(result)
+    except Exception as err:
+        handle_auth_exception(ctx, err)

cycode/cli/apps/auth/auth_command.py

@@ -1,20 +1,16 @@
-from typing import NamedTuple, Optional
+from typing import Optional
 
-import click
+import typer
 
+from cycode.cli.apps.auth.models import AuthInfo
 from cycode.cli.exceptions.custom_exceptions import HttpUnauthorizedError, RequestHttpError
 from cycode.cli.printers import ConsolePrinter
 from cycode.cli.user_settings.credentials_manager import CredentialsManager
 from cycode.cli.utils.jwt_utils import get_user_and_tenant_ids_from_access_token
 from cycode.cyclient.cycode_token_based_client import CycodeTokenBasedClient
 
 
-class AuthInfo(NamedTuple):
-    user_id: str
-    tenant_id: str
-
-
-def get_authorization_info(context: Optional[click.Context] = None) -> Optional[AuthInfo]:
+def get_authorization_info(ctx: Optional[typer.Context] = None) -> Optional[AuthInfo]:
     client_id, client_secret = CredentialsManager().get_credentials()
     if not client_id or not client_secret:
         return None
@@ -27,7 +23,7 @@ def get_authorization_info(context: Optional[click.Context] = None) -> Optional[
         user_id, tenant_id = get_user_and_tenant_ids_from_access_token(access_token)
         return AuthInfo(user_id=user_id, tenant_id=tenant_id)
     except (RequestHttpError, HttpUnauthorizedError):
-        if context:
-            ConsolePrinter(context).print_exception()
+        if ctx:
+            ConsolePrinter(ctx).print_exception()
 
         return None