CM-13317 - change url env var from BASE_URL to CYCODE_API_URL (#12)

change URL env var from legacy BASE_URL to CYCODE_API_URL

Author: MichalBor

cli/consts.py

@@ -14,10 +14,10 @@
     '.enc', '.deb', '.obj', '.model'
 ]
 
-DEFAULT_BASE_URL = "https://api.cycode.com"
+DEFAULT_CYCODE_API_URL = "https://api.cycode.com"
 
 # env var names
-BASE_URL_ENV_VAR_NAME = "BASE_URL"
+CYCODE_API_URL_VAR_NAME = "CYCODE_API_URL"
 TIMEOUT_ENV_VAR_NAME = "TIMEOUT"
 LOGGING_LEVEL_ENV_VAR_NAME = "LOGGING_LEVEL"
 # use only for dev envs locally

cli/user_settings/configuration_manager.py

@@ -2,11 +2,10 @@
 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, VERBOSE_ENV_VAR_NAME
+from cli.consts import DEFAULT_CYCODE_API_URL, CYCODE_API_URL_VAR_NAME, VERBOSE_ENV_VAR_NAME
 
 
 class ConfigurationManager:
-
     global_config_file_manager: ConfigFileManager
     local_config_file_manager: ConfigFileManager
 
@@ -27,7 +26,7 @@ def get_base_url(self) -> str:
         if base_url is not None:
             return base_url
 
-        return DEFAULT_BASE_URL
+        return DEFAULT_CYCODE_API_URL
 
     def get_verbose_flag(self) -> bool:
         verbose_flag_env_var = self.get_verbose_flag_from_environment_variables()
@@ -36,7 +35,8 @@ def get_verbose_flag(self) -> bool:
         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)
+        return self._get_value_from_environment_variables(CYCODE_API_URL_VAR_NAME)
+
 
     def get_verbose_flag_from_environment_variables(self) -> bool:
         value = self._get_value_from_environment_variables(VERBOSE_ENV_VAR_NAME, '')

cyclient/config.py

@@ -3,7 +3,7 @@
 import sys
 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, \
+from cli.consts import DEFAULT_CYCODE_API_URL, TIMEOUT_ENV_VAR_NAME, LOGGING_LEVEL_ENV_VAR_NAME, DEV_MODE_ENV_VAR_NAME, \
     BATCH_SIZE_ENV_VAR_NAME, VERBOSE_ENV_VAR_NAME
 
 
@@ -70,8 +70,8 @@ def _get_val_as_int(key):
 try:
     urlparse(base_url)
 except ValueError as e:
-    logger.warning(f'Invalid BASE_URL: {base_url}, using default value', e)
-    base_url = DEFAULT_CONFIGURATION.get(BASE_URL_ENV_VAR_NAME)
+    logger.warning(f'Invalid cycode api url: {base_url}, using default value', e)
+    base_url = DEFAULT_CYCODE_API_URL
 
 timeout = _get_val_as_int(TIMEOUT_ENV_VAR_NAME)
 dev_mode = _get_val_as_bool(DEV_MODE_ENV_VAR_NAME)

tests/user_settings/test_configuration_manager.py

@@ -1,6 +1,6 @@
 from mock import Mock
 from cli.user_settings.configuration_manager import ConfigurationManager
-from cli.consts import DEFAULT_BASE_URL
+from cli.consts import DEFAULT_CYCODE_API_URL
 
 """
 we check for base url in the three places, in the following order:
@@ -56,7 +56,7 @@ def test_get_base_url_not_configured(mocker):
     result = configuration_manager.get_base_url()
 
     # Assert
-    assert result == DEFAULT_BASE_URL
+    assert result == DEFAULT_CYCODE_API_URL
 
 
 def _configure_mocks(mocker,