Add sequence_name to BatchInfo

Author: eirenik0

eyes_common/applitools/common/config/configuration.py

@@ -8,7 +8,7 @@
 from applitools.common.geometry import RectangleSize
 from applitools.common.match import ImageMatchSettings, MatchLevel
 from applitools.common.server import FailureReports, SessionType
-from applitools.common.utils import general_utils
+from applitools.common.utils import general_utils, argument_guard
 from applitools.common.utils.json_utils import JsonInclude
 
 __all__ = ("BatchInfo", "Configuration")
@@ -28,6 +28,10 @@ class BatchInfo(object):
         factory=lambda: os.environ.get("APPLITOOLS_BATCH_NAME"),
         metadata={JsonInclude.THIS: True},
     )  # type: Optional[Text]
+    sequence_name = attr.ib(
+        factory=lambda: os.environ.get("APPLITOOLS_BATCH_SEQUENCE"),
+        metadata={JsonInclude.NAME: "batchSequenceName"},
+    )  # type: Optional[Text]
     started_at = attr.ib(
         factory=lambda: datetime.now(general_utils.UTC),
         metadata={JsonInclude.THIS: True},
@@ -46,6 +50,11 @@ def id_(self):
     def id_(self, value):
         self.id = value
 
+    def with_batch_id(self, id):
+        argument_guard.not_none(id)
+        self.id = id
+        return self
+
 
 @attr.s
 class Configuration(object):

tests/unit/eyes_common/test_batch_info.py

@@ -20,20 +20,33 @@ def test_create_batch_info(monkeypatch):
         ) as mocked_datetime:
             mocked_datetime.now.return_value = now
             bi = BatchInfo(batch_name)
+            bi.sequence_name = "sequence name"
 
     assert bi.name == batch_name
     assert bi.id == uuid_value
     assert bi.started_at == now
+    assert bi.sequence_name == "sequence name"
+
+
+def test_create_batch_with_batch_id():
+    bi = BatchInfo("My name").with_batch_id("custom id")
+    assert bi.id == "custom id"
 
 
 def test_set_env_params_in_batch_info():
     with patch.dict(
-        os.environ, {"APPLITOOLS_BATCH_NAME": "name", "APPLITOOLS_BATCH_ID": "id"}
+        os.environ,
+        {
+            "APPLITOOLS_BATCH_NAME": "name",
+            "APPLITOOLS_BATCH_ID": "id",
+            "APPLITOOLS_BATCH_SEQUENCE": "sequence name",
+        },
     ):
         bi = BatchInfo()
 
     assert bi.name == "name"
     assert bi.id == "id"
+    assert bi.sequence_name == "sequence name"
 
 
 def test_get_set_id_in_batch_info():