Merge pull request #23 from applitools/develop

Develop to master

Author: eirenik0

.bumpversion.cfg

@@ -1,5 +1,5 @@
 [bumpversion]
-current_version = 4.0.1
+current_version = 4.0.2
 commit = True
 tag = True
 

eyes_common/README.rst

@@ -1,19 +1,19 @@
-Eyes Core Python SDK
-=============
+Eyes Common Python SDK
+======================
 
-Applitools Eyes Core SDK For Python
+Applitools Eyes Common SDK For Python
 
 
 Installation
 ------------
 
-Install the eyes-core SDK.
+Install the eyes-common SDK.
 
 ::
 
-    pip install eyes-core
+    pip install eyes-common
 
 Usage
 -----
 
-It could be used to create own Appltiools SDK
+It could be used to create own Applitools SDK

eyes_common/applitools/common/__version__.py

@@ -1 +1 @@
-__version__ = "4.0.1"
+__version__ = "4.0.2"

eyes_common/applitools/common/config/configuration.py

@@ -13,8 +13,8 @@
 
 __all__ = ("BatchInfo", "Configuration")
 
-MINIMUM_MATCH_TIMEOUT = 0.6  # seconds
-DEFAULT_TIMEOUT = 60 * 5  # seconds
+MINIMUM_MATCH_TIMEOUT_MS = 600
+DEFAULT_TIMEOUT_MS = 60 * 5 * 1000
 DEFAULT_SERVER_URL = "https://eyesapi.applitools.com"
 
 
@@ -54,7 +54,7 @@ def _to_rectangle(d):
 
 @attr.s
 class Configuration(object):
-    DEFAULT_MATCH_TIMEOUT = 2  # sec
+    DEFAULT_MATCH_TIMEOUT_MS = 2000
 
     batch = attr.ib(default=None)  # type: Optional[BatchInfo]
     branch_name = attr.ib(
@@ -83,7 +83,7 @@ class Configuration(object):
     host_os = attr.ib(default=None)
     properties = attr.ib(factory=list)
     hide_scrollbars = attr.ib(default=False)
-    match_timeout = attr.ib(default=DEFAULT_MATCH_TIMEOUT)
+    match_timeout = attr.ib(default=DEFAULT_MATCH_TIMEOUT_MS)  # ms
     match_level = attr.ib(default=MatchLevel.STRICT, converter=MatchLevel)
     is_disabled = attr.ib(default=False)
     save_new_tests = attr.ib(default=True)
@@ -96,15 +96,16 @@ class Configuration(object):
     default_match_settings = attr.ib(default=ImageMatchSettings())
     hide_caret = attr.ib(init=False, default=None)
     stitching_overlap = attr.ib(init=False, default=50)
+
     api_key = attr.ib(factory=lambda: os.environ.get("APPLITOOLS_API_KEY", None))
     server_url = attr.ib(default=DEFAULT_SERVER_URL)
-    timeout = attr.ib(default=DEFAULT_TIMEOUT)
+    timeout = attr.ib(default=DEFAULT_TIMEOUT_MS)  # ms
 
     @match_timeout.validator
     def validate1(self, attribute, value):
-        if 0 < value < MINIMUM_MATCH_TIMEOUT:
+        if 0 < value < MINIMUM_MATCH_TIMEOUT_MS:
             raise ValueError(
-                "Match timeout must be at least {} sec.".format(MINIMUM_MATCH_TIMEOUT)
+                "Match timeout must be at least {} ms.".format(MINIMUM_MATCH_TIMEOUT_MS)
             )
 
     @viewport_size.validator

eyes_common/applitools/common/config/selenium_configuration.py

@@ -18,12 +18,12 @@
 
 @attr.s
 class SeleniumConfiguration(Configuration):
-    DEFAULT_WAIT_BEFORE_SCREENSHOTS = 1  # sec
+    DEFAULT_WAIT_BEFORE_SCREENSHOTS_MS = 1000  # ms
 
     force_full_page_screenshot = attr.ib(default=False)  # type: bool
     wait_before_screenshots = attr.ib(
-        default=DEFAULT_WAIT_BEFORE_SCREENSHOTS
-    )  # type: int
+        default=DEFAULT_WAIT_BEFORE_SCREENSHOTS_MS
+    )  # type: int  # ms
     stitch_mode = attr.ib(default=StitchMode.Scroll)  # type: StitchMode
     hide_scrollbars = attr.ib(default=False)  # type: bool
     hide_caret = attr.ib(default=False)  # type: bool

eyes_common/applitools/common/visual_grid.py

@@ -247,6 +247,7 @@ def from_response(cls, url, response):
 @attr.s
 class RenderRequest(object):
     webhook = attr.ib(metadata={JsonInclude.NON_NONE: True})  # type: Text
+    agent_id = attr.ib(metadata={JsonInclude.THIS: True})
     url = attr.ib(metadata={JsonInclude.NON_NONE: True})  # type: Text
     dom = attr.ib(repr=False, metadata={JsonInclude.NON_NONE: True})  # type: RGridDom
     resources = attr.ib(repr=False, metadata={JsonInclude.NON_NONE: True})  # type: dict

eyes_core/README.rst

@@ -1,5 +1,5 @@
 Eyes Core Python SDK
-=============
+====================
 
 Applitools Eyes Core SDK For Python
 
@@ -16,4 +16,4 @@ Install the eyes-core SDK.
 Usage
 -----
 
-It could be used to create own Appltiools SDK
+It could be used to create own Applitools SDK

eyes_core/applitools/core/__version__.py

@@ -1 +1 @@
-__version__ = "4.0.1"
+__version__ = "4.0.2"

eyes_core/applitools/core/eyes_base.py

@@ -494,8 +494,8 @@ def _log_open_base(self):
         logger.debug(
             "Eyes server URL is '{}'".format(self._server_connector.server_url)
         )
-        logger.debug("Timeout = {} sec".format(self.configuration.timeout))
-        logger.debug("match_timeout = {} sec".format(self.configuration.match_timeout))
+        logger.debug("Timeout = {} ms".format(self.configuration.timeout))
+        logger.debug("match_timeout = {} ms".format(self.configuration.match_timeout))
         logger.debug(
             "Default match settings = '{}' ".format(
                 self.configuration.default_match_settings
@@ -667,9 +667,9 @@ def _try_post_dom_snapshot(self, dom_json):
     def _match_window(self, region_provider, tag, ignore_mismatch, check_settings):
         # type: (RegionProvider, Text, bool, CheckSettings) -> MatchResult
         # Update retry timeout if it wasn't specified.
-        retry_timeout = -1  # type: Num
+        retry_timeout_ms = -1  # type: Num
         if check_settings:
-            retry_timeout = check_settings.values.timeout
+            retry_timeout_ms = check_settings.values.timeout
 
         get_config_value = general_utils.use_default_if_none_factory(
             self.configuration.default_match_settings, self.configuration
@@ -691,7 +691,7 @@ def _match_window(self, region_provider, tag, ignore_mismatch, check_settings):
             )
 
         region = region_provider.get_region()
-        logger.debug("params: ([{}], {}, {})".format(region, tag, retry_timeout))
+        logger.debug("params: ([{}], {}, {})".format(region, tag, retry_timeout_ms))
 
         result = self._match_window_task.match_window(
             self._user_inputs,
@@ -700,7 +700,7 @@ def _match_window(self, region_provider, tag, ignore_mismatch, check_settings):
             self._should_match_once_on_timeout,
             ignore_mismatch,
             check_settings,
-            retry_timeout,
+            retry_timeout_ms,
         )
         return result
 

eyes_core/applitools/core/fluent/check_settings.py

@@ -29,7 +29,7 @@ class CheckSettingsValues(object):
     """
 
     target_region = attr.ib(init=False, default=None)  # type: Optional[Region]
-    timeout = attr.ib(init=False, default=-1)  # type: Num  # seconds
+    timeout = attr.ib(init=False, default=-1)  # type: Num  # milliseconds
 
     ignore_caret = attr.ib(init=False, default=False)  # type: bool
     stitch_content = attr.ib(init=False, default=False)  # type: bool