CommonServerPython lower camel case support (demisto#12064)

dansterenson · web-flow · commit 2f813b43889a · 2021-04-22T14:26:26.000+03:00
* Added the ability to convert a string to a camel case with the first letter not capitalised.

* Added example to camelcase functions.

* update release notes

* revert changes
diff --git a/Packs/Base/ReleaseNotes/1_10_1.md b/Packs/Base/ReleaseNotes/1_10_1.md
@@ -0,0 +1,4 @@
+
+#### Scripts
+##### CommonServerPython
+- Maintenance and stability enhancements.
diff --git a/Packs/Base/Scripts/CommonServerPython/CommonServerPython.py b/Packs/Base/Scripts/CommonServerPython/CommonServerPython.py
@@ -4255,7 +4255,7 @@ def to_context(self):
             return ret_value
 
 
-def camelize_string(src_str, delim='_'):
+def camelize_string(src_str, delim='_', upper_camel=True):
     """
     Transform snake_case to CamelCase
 
@@ -4265,11 +4265,22 @@ def camelize_string(src_str, delim='_'):
     :type delim: ``str``
     :param delim: indicator category.
 
+    :type upper_camel: ``bool``
+    :param upper_camel: When True then transforms string to camel case with the first letter capitalised
+                        (for example: demisto_content to DemistoContent), otherwise the first letter will not be capitalised
+                        (for example: demisto_content to demistoContent).
+
     :return: A CammelCase string.
     :rtype: ``str``
     """
+    if not src_str:  # empty string
+        return ""
     components = src_str.split(delim)
-    return ''.join(map(lambda x: x.title(), components))
+    camelize_without_first_char = ''.join(map(lambda x: x.title(), components[1:]))
+    if upper_camel:
+        return components[0].title() + camelize_without_first_char
+    else:
+        return components[0].lower() + camelize_without_first_char
 
 
 class IndicatorsTimeline:
@@ -5157,7 +5168,7 @@ def return_warning(message, exit=False, warning='', outputs=None, ignore_auto_ex
         sys.exit(0)
 
 
-def camelize(src, delim=' '):
+def camelize(src, delim=' ', upper_camel=True):
     """
         Convert all keys of a dictionary (or list of dictionaries) to CamelCase (with capital first letter)
 
@@ -5167,6 +5178,11 @@ def camelize(src, delim=' '):
         :type delim: ``str``
         :param delim: The delimiter between two words in the key (e.g. delim=' ' for "Start Date"). Default ' '.
 
+        :type upper_camel: ``bool``
+        :param upper_camel: When True then transforms dictionary keys to camel case with the first letter capitalised
+                            (for example: demisto_content to DemistoContent), otherwise the first letter will not be capitalised
+                            (for example: demisto_content to demistoContent).
+
         :return: The dictionary (or list of dictionaries) with the keys in CamelCase.
         :rtype: ``dict`` or ``list``
     """
@@ -5175,10 +5191,14 @@ def camelize_str(src_str):
         if callable(getattr(src_str, "decode", None)):
             src_str = src_str.decode('utf-8')
         components = src_str.split(delim)
-        return ''.join(map(lambda x: x.title(), components))
+        camelize_without_first_char = ''.join(map(lambda x: x.title(), components[1:]))
+        if upper_camel:
+            return components[0].title() + camelize_without_first_char
+        else:
+            return components[0].lower() + camelize_without_first_char
 
     if isinstance(src, list):
-        return [camelize(phrase, delim) for phrase in src]
+        return [camelize(phrase, delim, upper_camel=upper_camel) for phrase in src]
     return {camelize_str(key): value for key, value in src.items()}
 
 
@@ -5249,21 +5269,30 @@ def replace_str(src_str):
 # ############################## REGEX FORMATTING end ###############################
 
 
-def underscoreToCamelCase(s):
+def underscoreToCamelCase(s, upper_camel=True):
     """
        Convert an underscore separated string to camel case
 
        :type s: ``str``
        :param s: The string to convert (e.g. hello_world) (required)
 
+       :type upper_camel: ``bool``
+       :param upper_camel: When True then transforms dictionarykeys to camel case with the first letter capitalised
+                           (for example: demisto_content to DemistoContent), otherwise the first letter will not be capitalised
+                           (for example: demisto_content to demistoContent).
+
        :return: The converted string (e.g. HelloWorld)
        :rtype: ``str``
     """
     if not isinstance(s, STRING_OBJ_TYPES):
         return s
 
     components = s.split('_')
-    return ''.join(x.title() for x in components)
+    camel_without_first_char = ''.join(x.title() for x in components[1:])
+    if upper_camel:
+        return components[0].title() + camel_without_first_char
+    else:
+        return components[0].lower() + camel_without_first_char
 
 
 def camel_case_to_underscore(s):
diff --git a/Packs/Base/Scripts/CommonServerPython/CommonServerPython_test.py b/Packs/Base/Scripts/CommonServerPython/CommonServerPython_test.py
@@ -521,12 +521,40 @@ def test_hash_djb2():
 
 def test_camelize():
     non_camalized = [{'chookity_bop': 'asdasd'}, {'ab_c': 'd e', 'fgh_ijk': 'lm', 'nop': 'qr_st'}]
-    expected_output = [{'ChookityBop': 'asdasd'}, {'AbC': 'd e', 'Nop': 'qr_st', 'FghIjk': 'lm'}]
-    assert camelize(non_camalized, '_') == expected_output
+    expected_output_upper_camel = [{'ChookityBop': 'asdasd'}, {'AbC': 'd e', 'Nop': 'qr_st', 'FghIjk': 'lm'}]
+    expected_output_lower_camel = [{'chookityBop': 'asdasd'}, {'abC': 'd e', 'nop': 'qr_st', 'fghIjk': 'lm'}]
+    assert camelize(non_camalized, '_') == expected_output_upper_camel
+    assert camelize(non_camalized, '_', upper_camel=True) == expected_output_upper_camel
+    assert camelize(non_camalized, '_', upper_camel=False) == expected_output_lower_camel
 
     non_camalized2 = {'ab_c': 'd e', 'fgh_ijk': 'lm', 'nop': 'qr_st'}
-    expected_output2 = {'AbC': 'd e', 'Nop': 'qr_st', 'FghIjk': 'lm'}
-    assert camelize(non_camalized2, '_') == expected_output2
+    expected_output2_upper_camel = {'AbC': 'd e', 'Nop': 'qr_st', 'FghIjk': 'lm'}
+    expected_output2_lower_camel = {'abC': 'd e', 'nop': 'qr_st', 'fghIjk': 'lm'}
+    assert camelize(non_camalized2, '_') == expected_output2_upper_camel
+    assert camelize(non_camalized2, '_', upper_camel=True) == expected_output2_upper_camel
+    assert camelize(non_camalized2, '_', upper_camel=False) == expected_output2_lower_camel
+
+
+def test_camelize_string():
+    from CommonServerPython import camelize_string
+    non_camalized = ['chookity_bop', 'ab_c', 'fgh_ijk', 'nop']
+    expected_output_upper_camel = ['ChookityBop', 'AbC', 'FghIjk', 'Nop']
+    expected_output_lower_camel = ['chookityBop', 'abC', 'fghIjk', 'nop']
+    for i in range(len(non_camalized)):
+        assert camelize_string(non_camalized[i], '_') == expected_output_upper_camel[i]
+        assert camelize_string(non_camalized[i], '_', upper_camel=True) == expected_output_upper_camel[i]
+        assert camelize_string(non_camalized[i], '_', upper_camel=False) == expected_output_lower_camel[i]
+
+
+def test_underscoreToCamelCase():
+    from CommonServerPython import underscoreToCamelCase
+    non_camalized = ['chookity_bop', 'ab_c', 'fgh_ijk', 'nop']
+    expected_output_upper_camel = ['ChookityBop', 'AbC', 'FghIjk', 'Nop']
+    expected_output_lower_camel = ['chookityBop', 'abC', 'fghIjk', 'nop']
+    for i in range(len(non_camalized)):
+        assert underscoreToCamelCase(non_camalized[i]) == expected_output_upper_camel[i]
+        assert underscoreToCamelCase(non_camalized[i], upper_camel=True) == expected_output_upper_camel[i]
+        assert underscoreToCamelCase(non_camalized[i], upper_camel=False) == expected_output_lower_camel[i]
 
 
 # Note this test will fail when run locally (in pycharm/vscode) as it assumes the machine (docker image) has UTC timezone set
diff --git a/Packs/Base/pack_metadata.json b/Packs/Base/pack_metadata.json
@@ -2,7 +2,7 @@
     "name": "Base",
     "description": "The base pack for Cortex XSOAR.",
     "support": "xsoar",
-    "currentVersion": "1.10.0",
+    "currentVersion": "1.10.1",
     "author": "Cortex XSOAR",
     "serverMinVersion": "6.0.0",
     "url": "https://www.paloaltonetworks.com/cortex",
