json-file

Author: jiasli

src/azure-cli-core/azure/cli/core/commands/validators.py

@@ -10,6 +10,7 @@
 from azure.cli.core.profiles import ResourceType
 
 from knack.log import get_logger
+from knack.util import CLIError
 from knack.validators import DefaultStr, DefaultInt  # pylint: disable=unused-import
 
 logger = get_logger(__name__)
@@ -84,12 +85,26 @@ def get_default_location_from_resource_group(cmd, namespace):
 def validate_file_or_dict(string):
     import os
     string = os.path.expanduser(string)
-    if os.path.exists(string):
-        from azure.cli.core.util import get_file_json
-        return get_file_json(string)
-
-    from azure.cli.core.util import shell_safe_json_parse
-    return shell_safe_json_parse(string)
+    try:
+        if os.path.exists(string):
+            from azure.cli.core.util import get_file_json
+            # Failure point 1: 'string' is a valid file path, but the file contains invalid JSON string
+            # ex has no recommendation
+            return get_file_json(string)
+
+        from azure.cli.core.util import shell_safe_json_parse
+        # Failure point 2:
+        # - 'string' is a non-existing file path
+        # - 'string' is an invalid JSON string
+        # ex has recommendations for shell interpretation
+        return shell_safe_json_parse(string)
+    except CLIError as ex:
+        from azure.cli.core.azclierror import InvalidArgumentValueError
+        new_ex = InvalidArgumentValueError(ex, recommendation="Please provide a valid JSON file path or JSON string.")
+        # Preserve the recommendation
+        if hasattr(ex, "recommendations"):
+            new_ex.set_recommendation(ex.recommendations)
+        raise new_ex from ex
 
 
 def validate_parameter_set(namespace, required, forbidden, dest_to_options=None, description=None):

src/azure-cli-core/azure/cli/core/util.py

@@ -523,7 +523,8 @@ def get_file_json(file_path, throw_on_empty=True, preserve_order=False):
     try:
         return shell_safe_json_parse(content, preserve_order)
     except CLIError as ex:
-        raise CLIError("Failed to parse {} with exception:\n    {}".format(file_path, ex))
+        # Reading file bypasses shell interpretation, so we discard the recommendation for shell quoting.
+        raise CLIError("Failed to parse file '{}' with exception:\n{}".format(file_path, ex))
 
 
 def read_file_content(file_path, allow_binary=False):
@@ -563,12 +564,13 @@ def shell_safe_json_parse(json_or_dict_string, preserve_order=False, strict=True
         except Exception as ex:
             logger.debug(ex)  # log the exception which could be a python dict parsing error.
 
-            # Echo the JSON received by CLI
-            msg = "Failed to parse JSON: {}\nError detail: {}".format(json_or_dict_string, json_ex)
+            # Echo the string received by CLI. Because the user may intend to provide a file path, we don't decisively
+            # say it is a JSON string.
+            msg = "Failed to parse string as JSON:\n{}\nError detail: {}".format(json_or_dict_string, json_ex)
 
             # Recommendation for all shells
             from azure.cli.core.azclierror import InvalidArgumentValueError
-            recommendation = "The JSON may have been parsed by the shell. See " \
+            recommendation = "The provided JSON string may have been parsed by the shell. See " \
                              "https://docs.microsoft.com/cli/azure/use-cli-effectively#use-quotation-marks-in-arguments"
 
             # Recommendation especially for PowerShell