Addressing comments.

Author: albertofori

src/azure-cli/azure/cli/command_modules/appconfig/_json.py

@@ -0,0 +1,91 @@
+import json
+
+
+DOUBLE_QUOTE = '\"'
+BACKSLASH = '\\'
+DOUBLE_SLASH = '//'
+MULTILINE_COMMENT_START = '/*'
+MULTILINE_COMMENT_END = '*/'
+NEW_LINE = '\n'
+
+
+def parse_json_with_comments(json_string):
+    try:
+        return json.loads(json_string)
+
+    except json.JSONDecodeError:
+        return json.loads(__strip_json_comments(json_string))
+
+
+def __strip_json_comments(json_string):
+    current_index = 0
+    length = len(json_string)
+    result = []
+
+    while current_index < length:
+        # Single line comment
+        if json_string[current_index:current_index + 2] == DOUBLE_SLASH:
+            current_index = __find_next_newline_index(json_string, current_index, length)
+            if current_index < length and json_string[current_index] == NEW_LINE:
+                result.append(NEW_LINE)
+
+        # Multi-line comment
+        elif json_string[current_index:current_index + 2] == MULTILINE_COMMENT_START:
+            current_index = __find_next_multiline_comment_end(json_string, current_index + 2, length)
+
+        # String literal
+        elif json_string[current_index] == DOUBLE_QUOTE:
+            literal_start_index = current_index
+            current_index = __find_next_double_quote_index(json_string, current_index + 1, length)
+
+            result.extend(json_string[literal_start_index:current_index + 1])
+        else:
+            result.append(json_string[current_index])
+
+        current_index += 1
+
+    return "".join(result)
+
+
+def __is_escaped(json_string, char_index):
+    backslash_count = 0
+    index = char_index - 1
+    while index >= 0 and json_string[index] == BACKSLASH:
+        backslash_count += 1
+        index -= 1
+
+    return backslash_count % 2 == 1
+
+
+def __find_next_newline_index(json_string, start_index, end_index):
+    index = start_index
+
+    while index < end_index:
+        if json_string[index] == NEW_LINE:
+            return index
+
+        index += 1
+
+    return index
+
+
+def __find_next_double_quote_index(json_string, start_index, end_index):
+    index = start_index
+    while index < end_index:
+        if json_string[index] == DOUBLE_QUOTE and not __is_escaped(json_string, index):
+            return index
+
+        index += 1
+
+    raise ValueError("Unterminated string literal")
+
+
+def __find_next_multiline_comment_end(json_string, start_index, end_index):
+    index = start_index
+    while index < end_index - 1:
+        if json_string[index:index + 2] == MULTILINE_COMMENT_END:
+            return index + 1
+
+        index += 1
+
+    raise ValueError("Unterminated multi-line comment")

src/azure-cli/azure/cli/command_modules/appconfig/_kv_import_helpers.py

@@ -47,9 +47,9 @@
     ImportMode,
 )
 from ._diff_utils import KVComparer, print_preview
+from ._json import parse_json_with_comments
 from ._utils import (
     is_json_content_type,
-    strip_json_comments,
     validate_feature_flag_name,
     validate_feature_flag_key,
 )
@@ -88,7 +88,7 @@ def __read_with_appropriate_encoding(file_path, format_):
     try:
         with io.open(file_path, "r", encoding=default_encoding) as config_file:
             if format_ == "json":
-                config_data = __parse_json_file_data(config_file.read())
+                config_data = parse_json_with_comments(config_file.read())
                 # Only accept json objects
                 if not isinstance(config_data, (dict, list)):
                     raise ValueError(
@@ -113,7 +113,7 @@ def __read_with_appropriate_encoding(file_path, format_):
 
         with io.open(file_path, "r", encoding=detected_encoding) as config_file:
             if format_ == "json":
-                config_data = __parse_json_file_data(config_file.read())
+                config_data = parse_json_with_comments(config_file.read())
 
             elif format_ == "yaml":
                 for yaml_data in list(yaml.safe_load_all(config_file)):
@@ -1122,11 +1122,3 @@ def __flatten_key_value(key, value, flattened_data, depth, separator):
             )  # Ensure boolean values are properly stringified.
     else:
         flattened_data[key] = value if isinstance(value, str) else json.dumps(value)
-
-
-def __parse_json_file_data(json_string):
-    try:
-        return json.loads(json_string)
-
-    except json.JSONDecodeError:
-        return json.loads(strip_json_comments(json_string))

src/azure-cli/azure/cli/command_modules/appconfig/_utils.py

@@ -20,13 +20,6 @@
 
 logger = get_logger(__name__)
 
-DOUBLE_QUOTE = '\"'
-BACKSLASH = '\\'
-DOUBLE_SLASH = '//'
-MULTILINE_COMMENT_START = '/*'
-MULTILINE_COMMENT_END = '*/'
-NEW_LINE = '\n'
-
 
 def construct_connection_string(cmd, config_store_name):
     connection_string_template = 'Endpoint={};Id={};Secret={}'
@@ -261,73 +254,3 @@ def parse_tags_to_dict(tags):
                 tags_dict[tag_key] = tag_value
         return tags_dict
     return tags
-
-
-def strip_json_comments(json_string):
-    current_index = 0
-    length = len(json_string)
-    result = []
-
-    def __is_escaped(json_string, char_index):
-        backslash_count = 0
-        index = char_index - 1
-        while index >= 0 and json_string[index] == BACKSLASH:
-            backslash_count += 1
-            index -= 1
-
-        return backslash_count % 2 == 1
-
-    def __find_next_newline_index(json_string, start_index):
-        index = start_index
-
-        while index < length:
-            if json_string[index] == NEW_LINE:
-                break
-
-            index += 1
-
-        return index
-
-    def __find_next_double_quote_index(json_string, start_index):
-        index = start_index
-        while index < length:
-            if json_string[index] == DOUBLE_QUOTE and not __is_escaped(json_string, index):
-                return index
-
-            index += 1
-
-        raise ValueError("Unterminated string literal")
-
-    def __find_next_multiline_comment_end(json_string, start_index):
-        index = start_index
-        while index < length - 1:
-            if json_string[index:index + 2] == MULTILINE_COMMENT_END:
-                return index + 1
-
-            index += 1
-
-        raise ValueError("Unterminated multi-line comment")
-
-    while current_index < length:
-        # Single line comment
-        if json_string[current_index:current_index + 2] == DOUBLE_SLASH:
-            current_index = __find_next_newline_index(json_string, current_index)
-            if current_index < length and json_string[current_index] == NEW_LINE:
-                result.append(NEW_LINE)
-
-        # Multi-line comment
-        elif json_string[current_index:current_index + 2] == MULTILINE_COMMENT_START:
-            current_index = __find_next_multiline_comment_end(json_string, current_index + 2)
-
-        # String literal
-        elif json_string[current_index] == DOUBLE_QUOTE:
-            literal_start_index = current_index
-            current_index = __find_next_double_quote_index(json_string, current_index + 1)
-
-            result.extend(json_string[literal_start_index:current_index + 1])
-        else:
-            result.append(json_string[current_index])
-
-        current_index += 1
-
-    return "".join(result)

src/azure-cli/azure/cli/command_modules/appconfig/keyvalue.py

@@ -52,8 +52,9 @@
                          ImportExportProfiles, CompareFieldsMap,
                          JsonDiff, ImportMode)
 from ._featuremodels import map_keyvalue_to_featureflag
+from ._json import parse_json_with_comments
 from ._models import (convert_configurationsetting_to_keyvalue, convert_keyvalue_to_configurationsetting)
-from ._utils import get_appconfig_data_client, prep_filter_for_url_encoding, resolve_store_metadata, get_store_endpoint_from_connection_string, is_json_content_type, strip_json_comments
+from ._utils import get_appconfig_data_client, prep_filter_for_url_encoding, resolve_store_metadata, get_store_endpoint_from_connection_string, is_json_content_type
 
 from ._diff_utils import print_preview, KVComparer
 from .feature import __list_features
@@ -510,7 +511,7 @@ def set_key(cmd,
                     # Ensure that provided value is valid JSON and strip comments if needed.
                     value = 'null' if value is None else value
 
-                    __validate_json_input(value)
+                    parse_json_with_comments(value)
                 except ValueError:
                     raise CLIErrors.ValidationError('Value "{}" is not a valid JSON object, which conflicts with the content type "{}".'.format(value, content_type))
 
@@ -525,7 +526,7 @@ def set_key(cmd,
             if is_json_content_type(content_type):
                 try:
                     # Ensure that provided value is valid JSON and strip comments if needed.
-                    __validate_json_input(value)
+                    parse_json_with_comments(value)
                 except (TypeError, ValueError):
                     raise CLIErrors.ValidationError('Value "{}" is not a valid JSON object, which conflicts with the content type "{}". Set the value again in valid JSON format.'.format(value, content_type))
             set_kv = ConfigurationSetting(key=key,
@@ -985,12 +986,3 @@ def list_revision(cmd,
         return retrieved_revisions
     except HttpResponseError as ex:
         raise CLIErrors.AzureResponseError('List revision operation failed.\n' + str(ex))
-
-
-# Helper function to validate JSON input that may contain comments
-def __validate_json_input(json_string):
-    try:
-        json.loads(json_string)
-
-    except json.JSONDecodeError:
-        json.loads(strip_json_comments(json_string))

src/azure-cli/azure/cli/command_modules/appconfig/tests/latest/test_appconfig_json_content_type.py

@@ -473,13 +473,13 @@ def test_azconfig_json_content_type(self, resource_group, location):
 
 class AppConfigJsonCommentsTest(TestCase):
     def test_azconfig_strip_json_comments(self):
-        from azure.cli.command_modules.appconfig._utils import strip_json_comments
+        from azure.cli.command_modules.appconfig._json import parse_json_with_comments
 
         json_with_comments_file_path = os.path.join(TEST_DIR, 'json_with_comments.json')
         clean_json_file_path = os.path.join(TEST_DIR, 'json_with_comments_stripped.json')
 
         with open(json_with_comments_file_path) as json_file:
-            parsed_json = json.loads(strip_json_comments(json_file.read()))
+            parsed_json = parse_json_with_comments(json_file.read())
 
         with open(clean_json_file_path) as json_file:
             expected_json = json.load(json_file)