CM-12770 - add option to config verbose mode via env var and config file (#7)

* WIP

* done

Author: MichalBor

cli/consts.py

@@ -23,6 +23,7 @@
 # use only for dev envs locally
 DEV_MODE_ENV_VAR_NAME = "DEV_MODE"
 BATCH_SIZE_ENV_VAR_NAME = "BATCH_SIZE"
+VERBOSE_ENV_VAR_NAME = "CYCODE_CLI_VERBOSE"
 
 CYCODE_CONFIGURATION_DIRECTORY: str = '.cycode'
 

cli/cycode.py

@@ -6,6 +6,7 @@
 from cyclient import ScanClient, K8SUpdaterClient, logger
 from cli.user_settings.credentials_manager import CredentialsManager
 from cli.user_settings.user_settings_commands import set_credentials, add_exclusions
+from cli.user_settings.configuration_manager import ConfigurationManager
 
 CONTEXT = dict()
 ISSUE_DETECTED_STATUS_CODE = 1
@@ -92,6 +93,8 @@ def finalize(context: click.Context, *args, **kwargs):
 @click.pass_context
 def main_cli(context: click.Context, verbose: bool):
     context.ensure_object(dict)
+    configuration_manager = ConfigurationManager()
+    verbose = verbose or configuration_manager.get_verbose_flag()
     context.obj["verbose"] = verbose
     log_level = logging.DEBUG if verbose else logging.INFO
     logger.setLevel(log_level)

cli/user_settings/config_file_manager.py

@@ -12,6 +12,7 @@ class ConfigFileManager(BaseFileManager):
     EXCLUSIONS_SECTION_NAME: str = 'exclusions'
 
     BASE_URL_FIELD_NAME: str = 'cycode_base_url'
+    VERBOSE_FIELD_NAME: str = 'verbose'
 
     def __init__(self, path):
         self.path = path
@@ -23,6 +24,13 @@ def get_base_url(self) -> Optional[str]:
         base_url = environment_section.get(self.BASE_URL_FIELD_NAME)
         return base_url
 
+    def get_verbose_flag(self) -> Optional[bool]:
+        file_content = self.read_file()
+
+        environment_section = file_content.get(self.ENVIRONMENT_SECTION_NAME, {})
+        verbose_flag = environment_section.get(self.VERBOSE_FIELD_NAME)
+        return verbose_flag
+
     def get_exclusions_by_scan_type(self, scan_type) -> Dict:
         file_content = self.read_file()
         exclusions_section = file_content.get(self.EXCLUSIONS_SECTION_NAME, {})

cli/user_settings/configuration_manager.py

@@ -2,7 +2,7 @@
 from pathlib import Path
 from typing import Optional, Dict
 from cli.user_settings.config_file_manager import ConfigFileManager
-from cli.consts import DEFAULT_BASE_URL, BASE_URL_ENV_VAR_NAME
+from cli.consts import DEFAULT_BASE_URL, BASE_URL_ENV_VAR_NAME, VERBOSE_ENV_VAR_NAME
 
 
 class ConfigurationManager:
@@ -14,7 +14,7 @@ def __init__(self):
         self.global_config_file_manager = ConfigFileManager(Path.home())
         self.local_config_file_manager = ConfigFileManager(os.getcwd())
 
-    def get_base_url(self) -> Optional[str]:
+    def get_base_url(self) -> str:
         base_url = self.get_base_url_from_environment_variables()
         if base_url is not None:
             return base_url
@@ -29,8 +29,18 @@ def get_base_url(self) -> Optional[str]:
 
         return DEFAULT_BASE_URL
 
-    def get_base_url_from_environment_variables(self) -> str:
-        return os.getenv(BASE_URL_ENV_VAR_NAME)
+    def get_verbose_flag(self) -> bool:
+        verbose_flag_env_var = self.get_verbose_flag_from_environment_variables()
+        verbose_flag_local_config = self.local_config_file_manager.get_verbose_flag()
+        verbose_flag_global_config = self.global_config_file_manager.get_verbose_flag()
+        return verbose_flag_env_var or verbose_flag_local_config or verbose_flag_global_config
+
+    def get_base_url_from_environment_variables(self) -> Optional[str]:
+        return self._get_value_from_environment_variables(BASE_URL_ENV_VAR_NAME)
+
+    def get_verbose_flag_from_environment_variables(self) -> bool:
+        value = self._get_value_from_environment_variables(VERBOSE_ENV_VAR_NAME, '')
+        return value.lower() in ('true', '1')
 
     def get_exclusions_by_scan_type(self, scan_type) -> Dict:
         local_exclusions = self.local_config_file_manager.get_exclusions_by_scan_type(scan_type)
@@ -51,3 +61,6 @@ def update_base_url(self, base_url: str, scope: str = 'local'):
 
     def get_config_file_manager(self, scope):
         return self.local_config_file_manager if scope == 'local' else self.global_config_file_manager
+
+    def _get_value_from_environment_variables(self, env_var_name, default=None):
+        return os.getenv(env_var_name, default)

cyclient/config.py

@@ -4,7 +4,7 @@
 from urllib.parse import urlparse
 from cli.user_settings.configuration_manager import ConfigurationManager
 from cli.consts import BASE_URL_ENV_VAR_NAME, TIMEOUT_ENV_VAR_NAME, LOGGING_LEVEL_ENV_VAR_NAME, DEV_MODE_ENV_VAR_NAME, \
-    BATCH_SIZE_ENV_VAR_NAME
+    BATCH_SIZE_ENV_VAR_NAME, VERBOSE_ENV_VAR_NAME
 
 
 # set io encoding (for windows)
@@ -33,7 +33,7 @@
     TIMEOUT_ENV_VAR_NAME: 60,
     LOGGING_LEVEL_ENV_VAR_NAME: logging.INFO,
     DEV_MODE_ENV_VAR_NAME: 'False',
-    BATCH_SIZE_ENV_VAR_NAME: 20,
+    BATCH_SIZE_ENV_VAR_NAME: 20
 }
 
 configuration = dict(DEFAULT_CONFIGURATION, **os.environ)
@@ -76,3 +76,4 @@ def _get_val_as_int(key):
 timeout = _get_val_as_int(TIMEOUT_ENV_VAR_NAME)
 dev_mode = _get_val_as_bool(DEV_MODE_ENV_VAR_NAME)
 batch_size = _get_val_as_int(BATCH_SIZE_ENV_VAR_NAME)
+verbose = _get_val_as_bool(VERBOSE_ENV_VAR_NAME)