Allow to set json key by specifying a metadata name

Author: eirenik0

eyes_common/applitools/common/utils/json_utils.py

@@ -63,9 +63,21 @@ def attr_from_response(response, cls):
     return attr_from_json(response.text, cls)
 
 
+# Uses for replacing of regular attr.name to specified in metadata
+REPLACE_TO_DICT = dict()
+
+
 class _CamelCasedDict(dict):
     def __setitem__(self, key, value):
-        key = underscore_to_camelcase(key)
+        if key in REPLACE_TO_DICT:
+            # use key specified in metadata
+            old_key = key
+            key = REPLACE_TO_DICT[old_key]
+            del REPLACE_TO_DICT[old_key]
+        else:
+            # convert key into camel case format
+            key = underscore_to_camelcase(key)
+        # process Enum's
         if hasattr(value, "value"):
             value = value.value
         super(_CamelCasedDict, self).__setitem__(key, value)
@@ -78,7 +90,11 @@ def _filter(attr_, value):
         if value is None:
             return False
         return True
-    if attr_.metadata.get(JsonInclude.THIS) or attr_.metadata.get(JsonInclude.NAME):
+    if attr_.metadata.get(JsonInclude.THIS):
+        return True
+    if attr_.metadata.get(JsonInclude.NAME):
+        # set key from metadata which would be used by default
+        REPLACE_TO_DICT[attr_.name] = attr_.metadata[JsonInclude.NAME]
         return True
     return False
 

tests/unit/eyes_selenium/test_eyes.py

@@ -1,13 +1,16 @@
+import json
+
 import pytest
 from mock import patch
 
-from applitools.common import MatchLevel, StitchMode
+from applitools.common import MatchLevel, StitchMode, BatchInfo
+from applitools.common.utils import json_utils
 from applitools.core import NullScaleProvider
 from applitools.selenium import Eyes
 from applitools.selenium.visual_grid import VisualGridRunner
 
 
-def get_start_session_info_from_open(eyes, driver):
+def open_and_get_start_session_info(eyes, driver):
     eyes.api_key = "Some API KEY"
     eyes._is_viewport_size_set = True
 
@@ -83,7 +86,7 @@ def test_baseline_name(eyes, driver_mock):
     assert eyes.configuration.baseline_branch_name == "Baseline"
 
     if not eyes._visual_grid_eyes:
-        session_info = get_start_session_info_from_open(eyes, driver_mock)
+        session_info = open_and_get_start_session_info(eyes, driver_mock)
         assert session_info.baseline_branch_name == "Baseline"
 
 
@@ -93,7 +96,7 @@ def test_branch_name(eyes, driver_mock):
     assert eyes.configuration.branch_name == "Branch"
 
     if not eyes._visual_grid_eyes:
-        session_info = get_start_session_info_from_open(eyes, driver_mock)
+        session_info = open_and_get_start_session_info(eyes, driver_mock)
         assert session_info.branch_name == "Branch"
 
 
@@ -103,5 +106,16 @@ def test_baseline_env_name(eyes, driver_mock):
     assert eyes.configuration.baseline_env_name == "Baseline Env"
 
     if not eyes._visual_grid_eyes:
-        session_info = get_start_session_info_from_open(eyes, driver_mock)
+        session_info = open_and_get_start_session_info(eyes, driver_mock)
         assert session_info.baseline_env_name == "Baseline Env"
+
+
+def test_batch_info_sequence_name(eyes, driver_mock):
+    eyes.batch = BatchInfo("Batch Info")
+    eyes.batch.sequence_name = "Sequence"
+
+    if not eyes._visual_grid_eyes:
+        session_info = open_and_get_start_session_info(eyes, driver_mock)
+        info_json = json_utils.to_json(session_info)
+        batch_info = json.loads(info_json)["startInfo"]["batchInfo"]
+        assert batch_info["batchSequenceName"] == "Sequence"