Improve error handling of missing configuration

Author: const-cloudinary

cloudinary_cli/cli.py

@@ -10,8 +10,9 @@
 import cloudinary_cli.modules
 import cloudinary_cli.samples
 from cloudinary_cli.defaults import logger
-from cloudinary_cli.utils.config_utils import initialize, load_config, refresh_cloudinary_config
-from cloudinary_cli.utils.utils import log_exception
+from cloudinary_cli.utils.config_utils import initialize, load_config, refresh_cloudinary_config, \
+    is_valid_cloudinary_config
+from cloudinary_cli.utils.utils import log_exception, ConfigurationError
 
 CONTEXT_SETTINGS = dict(max_content_width=shutil.get_terminal_size()[0], terminal_width=shutil.get_terminal_size()[0])
 
@@ -34,7 +35,7 @@ def cli(config, config_saved):
 
         refresh_cloudinary_config(config[config_saved])
 
-    if cloudinary.config().cloud_name is None:
+    if not is_valid_cloudinary_config():
         logger.warning("No Cloudinary configuration found.")
 
     return 0
@@ -57,8 +58,15 @@ def main():
     initialize()
     try:
         exit_status = cli()
+    except ConfigurationError as e:
+        log_exception(e)
+        exit_status = 1
     except Exception as e:
-        log_exception(e, "Command execution failed")
+        # Improve configuration error handling
+        if "Must supply cloud_name" in str(e):
+            log_exception("No Cloudinary configuration found.")
+        else:
+            log_exception(e, "Command execution failed")
         exit_status = 1
 
     return exit_status

cloudinary_cli/utils/api_utils.py

@@ -2,6 +2,7 @@
 from os import path, makedirs
 from webbrowser import open as open_url
 
+import cloudinary
 import requests
 from click import style
 from cloudinary import Search, uploader
@@ -11,7 +12,8 @@
 from cloudinary_cli.utils.file_utils import normalize_file_extension, posix_rel_path
 from cloudinary_cli.utils.json_utils import print_json, write_json_to_file
 from cloudinary_cli.utils.utils import print_help, log_exception, confirm_action, \
-    get_command_params, merge_responses, normalize_list_params
+    get_command_params, merge_responses, normalize_list_params, ConfigurationError
+from cloudinary_cli.utils.config_utils import is_valid_cloudinary_config
 
 PAGINATION_MAX_RESULTS = 500
 
@@ -164,6 +166,9 @@ def handle_api_command(
         api_instance,
         api_name)
 
+    if not is_valid_cloudinary_config():
+        raise ConfigurationError("No Cloudinary configuration found.")
+
     res = call_api(func, args, kwargs)
 
     if auto_paginate:

cloudinary_cli/utils/config_utils.py

@@ -77,10 +77,13 @@ def migrate_old_config():
     os.remove(OLD_CLOUDINARY_CLI_CONFIG_FILE)
 
 
+def is_valid_cloudinary_config():
+    return None not in [cloudinary.config().cloud_name, cloudinary.config().api_key, cloudinary.config().api_secret]
+
+
 def initialize():
     migrate_old_config()
 
 
 def _verify_file_path(file):
     os.makedirs(os.path.dirname(file), exist_ok=True)
-

cloudinary_cli/utils/utils.py

@@ -20,6 +20,10 @@
 BLOCK_SIZE = 65536
 
 
+class ConfigurationError(Exception):
+    pass
+
+
 def etag(fi):
     file_hash = md5()
     with open(fi, 'rb') as f:

test/test_cli_config.py

@@ -22,6 +22,7 @@ class TestCLIConfig(unittest.TestCase):
     runner = CliRunner()
     TEST_CLOUD_NAME = 'test_cloud'
     TEST_CLOUDINARY_URL = 'cloudinary://key:secret@' + TEST_CLOUD_NAME
+    INVALID_CLOUDINARY_URL = 'cloudinary://key:secret@'
 
     @classmethod
     def tearDownClass(cls) -> None:
@@ -46,6 +47,12 @@ def test_cli_config_invalid_config(self):
         self.assertEqual(1, result.exit_code)
         self.assertIn('Invalid CLOUDINARY_URL scheme', str(result.exc_info[1]))
 
+    def test_cli_config_invalid_config_cloud_name(self):
+        result = self.runner.invoke(cli, ['--config', self.INVALID_CLOUDINARY_URL, 'ping'])
+
+        self.assertEqual(1, result.exit_code)
+        self.assertIn('No Cloudinary configuration found.', str(result.exc_info[1]))
+
     def test_cli_show_config(self):
         result = self.runner.invoke(cli, ['--config', self.TEST_CLOUDINARY_URL, 'config'])