add supported modules

Author: MarshalX

cycode/cli/commands/status/status_command.py

@@ -1,17 +1,63 @@
 import dataclasses
 import json
 import platform
+from typing import Dict
 
 import click
 
 from cycode import __version__
 from cycode.cli.commands.auth_common import get_authorization_info
 from cycode.cli.consts import PROGRAM_NAME
 from cycode.cli.user_settings.configuration_manager import ConfigurationManager
+from cycode.cli.utils.get_api_client import get_scan_cycode_client
+from cycode.cyclient import logger
+
+
+class CliStatusBase:
+    def as_dict(self) -> Dict[str, any]:
+        return dataclasses.asdict(self)
+
+    def _get_text_message_part(self, key: str, value: any, intent: int = 0) -> str:
+        message_parts = []
+
+        intent_prefix = ' ' * intent * 2
+        human_readable_key = key.replace('_', ' ').capitalize()
+
+        if isinstance(value, dict):
+            message_parts.append(f'{intent_prefix}{human_readable_key}:')
+            for sub_key, sub_value in value.items():
+                message_parts.append(self._get_text_message_part(sub_key, sub_value, intent=intent + 1))
+        elif isinstance(value, (list, set, tuple)):
+            message_parts.append(f'{intent_prefix}{human_readable_key}:')
+            for index, sub_value in enumerate(value):
+                message_parts.append(self._get_text_message_part(f'#{index}', sub_value, intent=intent + 1))
+        else:
+            message_parts.append(f'{intent_prefix}{human_readable_key}: {value}')
+
+        return '\n'.join(message_parts)
+
+    def as_text(self) -> str:
+        message_parts = []
+        for key, value in self.as_dict().items():
+            message_parts.append(self._get_text_message_part(key, value))
+
+        return '\n'.join(message_parts)
+
+    def as_json(self) -> str:
+        return json.dumps(self.as_dict())
+
+
+@dataclasses.dataclass
+class CliSupportedModulesStatus(CliStatusBase):
+    secret_scanning: bool = False
+    sca_scanning: bool = False
+    iac_scanning: bool = False
+    sast_scanning: bool = False
+    ai_large_language_model: bool = False
 
 
 @dataclasses.dataclass
-class Status:
+class CliStatus(CliStatusBase):
     program: str
     version: str
     os: str
@@ -23,26 +69,30 @@ class Status:
     is_authenticated: bool
     user_id: str = None
     tenant_id: str = None
+    supported_modules: CliSupportedModulesStatus = None
 
-    def as_text(self) -> str:
-        message_parts = []
-        for key, value in dataclasses.asdict(self).items():
-            human_readable_key = key.replace('_', ' ').capitalize()
-            message_parts.append(f'{human_readable_key}: {value}')
 
-        return '\n'.join(message_parts)
-
-    def as_json(self) -> str:
-        return json.dumps(dataclasses.asdict(self))
-
-
-def get_cli_status() -> Status:
+def get_cli_status() -> CliStatus:
     configuration_manager = ConfigurationManager()
+
     auth_info = get_authorization_info()
+    is_authenticated = auth_info is not None
+
+    supported_modules_status = CliSupportedModulesStatus()
+    if is_authenticated:
+        try:
+            client = get_scan_cycode_client()
+            supported_modules_preferences = client.get_supported_modules_preferences()
 
-    # TODO: Add supported modules; add AI status
+            supported_modules_status.secret_scanning = supported_modules_preferences.secret_scanning
+            supported_modules_status.sca_scanning = supported_modules_preferences.sca_scanning
+            supported_modules_status.iac_scanning = supported_modules_preferences.iac_scanning
+            supported_modules_status.sast_scanning = supported_modules_preferences.sast_scanning
+            supported_modules_status.ai_large_language_model = supported_modules_preferences.ai_large_language_model
+        except Exception as e:
+            logger.debug('Failed to get supported modules preferences', exc_info=e)
 
-    return Status(
+    return CliStatus(
         program=PROGRAM_NAME,
         version=__version__,
         os=platform.system(),
@@ -51,9 +101,10 @@ def get_cli_status() -> Status:
         installation_id=configuration_manager.get_or_create_installation_id(),
         app_url=configuration_manager.get_cycode_app_url(),
         api_url=configuration_manager.get_cycode_api_url(),
-        is_authenticated=auth_info is not None,
+        is_authenticated=is_authenticated,
         user_id=auth_info.user_id if auth_info else None,
         tenant_id=auth_info.tenant_id if auth_info else None,
+        supported_modules=supported_modules_status,
     )
 
 

cycode/cyclient/models.py

@@ -478,3 +478,41 @@ class Meta:
     @post_load
     def build_dto(self, data: Dict[str, Any], **_) -> ScanResultsSyncFlow:
         return ScanResultsSyncFlow(**data)
+
+
+@dataclass
+class SupportedModulesPreferences:
+    secret_scanning: bool
+    leak_scanning: bool
+    iac_scanning: bool
+    sca_scanning: bool
+    ci_cd_scanning: bool
+    sast_scanning: bool
+    container_scanning: bool
+    access_review: bool
+    asoc: bool
+    cimon: bool
+    ai_machine_learning: bool
+    ai_large_language_model: bool
+
+
+class SupportedModulesPreferencesSchema(Schema):
+    class Meta:
+        unknown = EXCLUDE
+
+    secret_scanning = fields.Boolean()
+    leak_scanning = fields.Boolean()
+    iac_scanning = fields.Boolean()
+    sca_scanning = fields.Boolean()
+    ci_cd_scanning = fields.Boolean()
+    sast_scanning = fields.Boolean()
+    container_scanning = fields.Boolean()
+    access_review = fields.Boolean()
+    asoc = fields.Boolean()
+    cimon = fields.Boolean()
+    ai_machine_learning = fields.Boolean()
+    ai_large_language_model = fields.Boolean()
+
+    @post_load
+    def build_dto(self, data: Dict[str, Any], **_) -> 'SupportedModulesPreferences':
+        return SupportedModulesPreferences(**data)

cycode/cyclient/scan_client.py

@@ -27,7 +27,7 @@ def __init__(
         self._DETECTIONS_SERVICE_CONTROLLER_PATH = 'api/v1/detections'
         self._DETECTIONS_SERVICE_CLI_CONTROLLER_PATH = 'api/v1/detections/cli'
 
-        self.POLICIES_SERVICE_CONTROLLER_PATH_V3 = 'api/v3/policies'
+        self._POLICIES_SERVICE_CONTROLLER_PATH_V3 = 'api/v3/policies'
 
         self._hide_response_log = hide_response_log
 
@@ -198,10 +198,14 @@ def get_scan_details(self, scan_type: str, scan_id: str) -> models.ScanDetailsRe
     def get_detection_rules_path(self) -> str:
         return (
             f'{self.scan_config.get_detections_prefix()}/'
-            f'{self.POLICIES_SERVICE_CONTROLLER_PATH_V3}/'
+            f'{self._POLICIES_SERVICE_CONTROLLER_PATH_V3}/'
             f'detection_rules/byIds'
         )
 
+    def get_supported_modules_preferences(self) -> models.SupportedModulesPreferences:
+        response = self.scan_cycode_client.get(url_path='preferences/api/v1/supportedmodules')
+        return models.SupportedModulesPreferencesSchema().load(response.json())
+
     @staticmethod
     def _get_policy_type_by_scan_type(scan_type: str) -> str:
         scan_type_to_policy_type = {