Merge pull request #30 from applitools/feautre-fixed-cut-provider

Feautre fixed cut provider

Author: eirenik0

eyes_core/applitools/core/__init__.py

@@ -47,6 +47,9 @@
     "PositionMomento",
     "InvalidPositionProvider",
     "RegionProvider",
+    "FixedCutProvider",
+    "NullCutProvider",
+    "UnscaledFixedCutProvider",
     "NullRegionProvider",
     "NULL_REGION_PROVIDER",
     "CheckSettings",

eyes_core/applitools/core/eyes_base.py

@@ -25,7 +25,11 @@
 from applitools.common.utils import ABC, argument_guard, general_utils
 from applitools.common.visual_grid import RenderingInfo
 from applitools.core.capture import AppOutputProvider, AppOutputWithScreenshot
-from applitools.core.cut import NullCutProvider
+from applitools.core.cut import (
+    NullCutProvider,
+    FixedCutProvider,
+    UnscaledFixedCutProvider,
+)
 from applitools.core.debug import (
     FileDebugScreenshotProvider,
     NullDebugScreenshotProvider,
@@ -40,7 +44,7 @@
     from applitools.common.utils.custom_types import ViewPort, UserInputs, Num
     from applitools.core.fluent.check_settings import CheckSettings
     from applitools.common.capture import EyesScreenshot
-    from typing import Optional, Text
+    from typing import Optional, Text, Union
 
 __all__ = ("EyesBase",)
 
@@ -172,8 +176,17 @@ def debug_screenshot_provider(self):
 
     @property
     def cut_provider(self):
+        # type: () -> Union[FixedCutProvider, UnscaledFixedCutProvider, NullCutProvider]
         return self._cut_provider
 
+    @cut_provider.setter
+    def cut_provider(self, provider):
+        # type: (Union[FixedCutProvider, UnscaledFixedCutProvider, NullCutProvider]) -> None
+        argument_guard.is_in(
+            provider, [FixedCutProvider, UnscaledFixedCutProvider, NullCutProvider]
+        )
+        self._cut_provider = provider
+
     @property
     def is_debug_screenshot_provided(self):
         # type: () -> bool
@@ -182,6 +195,7 @@ def is_debug_screenshot_provided(self):
 
     @is_debug_screenshot_provided.setter
     def is_debug_screenshot_provided(self, save):
+        # type: (bool) -> None
         prev = self._debug_screenshot_provider
         if save:
             self._debug_screenshot_provider = FileDebugScreenshotProvider(

eyes_images/applitools/images/__init__.py

@@ -1,6 +1,21 @@
 from applitools.common import BatchInfo, MatchLevel, Region, logger
+from applitools.core.cut import (
+    FixedCutProvider,
+    UnscaledFixedCutProvider,
+    NullCutProvider,
+)
 from applitools.images.fluent import Target
 
 from .eyes import Eyes
 
-__all__ = ("Eyes", "BatchInfo", "Region", "MatchLevel", "logger", "Target")
+__all__ = (
+    "Eyes",
+    "BatchInfo",
+    "Region",
+    "MatchLevel",
+    "logger",
+    "Target",
+    "FixedCutProvider",
+    "UnscaledFixedCutProvider",
+    "NullCutProvider",
+)

eyes_images/applitools/images/eyes.py

@@ -2,7 +2,12 @@
 
 from applitools.common import Configuration, EyesError, RectangleSize, Region, logger
 from applitools.common.utils.general_utils import proxy_to
-from applitools.core import NULL_REGION_PROVIDER, EyesBase, RegionProvider
+from applitools.core import (
+    NULL_REGION_PROVIDER,
+    EyesBase,
+    RegionProvider,
+    NullCutProvider,
+)
 from applitools.images.fluent import ImagesCheckSettings, Target
 
 from .__version__ import __version__
@@ -125,7 +130,11 @@ def _check_image(self, region_provider, name, ignore_mismatch, check_settings):
             raise EyesError("you must call open() before checking")
 
         image = check_settings.values.image  # type: Image.Image
-        # TODO: Add cut provider
+
+        if not isinstance(self.cut_provider, NullCutProvider):
+            logger.debug("cutting...")
+            image = self.cut_provider.cut(image)
+            self.debug_screenshot_provider.save(image, "cut")
 
         self._screenshot = EyesImagesScreenshot(image)
         if not self.configuration.viewport_size:

eyes_selenium/applitools/selenium/__init__.py

@@ -11,6 +11,11 @@
     ScreenOrientation,
 )
 from applitools.common.server import FailureReports  # noqa
+from applitools.core.cut import (
+    NullCutProvider,
+    FixedCutProvider,
+    UnscaledFixedCutProvider,
+)  # noqa
 
 from .eyes import Eyes  # noqa
 from .fluent.target import Target  # noqa
@@ -34,4 +39,7 @@
     "DeviceName",
     "Configuration",
     "ScreenOrientation",
+    "FixedCutProvider",
+    "NullCutProvider",
+    "UnscaledFixedCutProvider",
 )

eyes_selenium/applitools/selenium/eyes.py

@@ -34,6 +34,7 @@ class Eyes(object):
         "device_pixel_ratio",
         "scale_ratio",
         "position_provider",
+        "cut_provider",
         "_original_frame_chain",
         "full_agent_id",
         "agent_setup",

eyes_selenium/applitools/selenium/eyes_selenium_utils.py

@@ -100,46 +100,43 @@
 _RETRIES = 3
 
 
-def is_mobile_device(driver):
+def is_mobile_platform(driver):
     # type: (AnyWebDriver) -> bool
     """
-    Returns whether the platform running is a mobile device or not.
-
-    :return: True if the platform running the test is a mobile platform. False otherwise.
-    """
-    is_mobile = """
-if( navigator.userAgent.match(/Android/i) ||
-    navigator.userAgent.match(/iPhone/i) ||
-    navigator.userAgent.match(/iPad/i)   ||
-    navigator.userAgent.match(/iPod/i) ) {
-    return true;
-} else {
-    return false;
-}
+    Returns whether the platform running is a mobile browser or app.
     """
-    # TODO: Implement proper UserAgent handling
     driver = get_underlying_driver(driver)
     if isinstance(driver, AppiumWebDriver):
         return True
+    return is_mobile_web(driver) or is_mobile_app(driver)
+
 
+def is_mobile_web(driver):
+    # type: (AnyWebDriver) -> bool
+    """
+    Returns whether the platform running is a mobile browser.
+    """
     # if driver is selenium based
     platform_name = driver.desired_capabilities.get("platformName", "").lower()
-    # platformName sometime have different names
-    is_mobile_platform = "android" in platform_name or "ios" in platform_name
-    if not is_mobile_platform:
-        try:
-            is_mobile_platform = driver.execute_script(is_mobile)
-        except WebDriverException as e:
-            logger.warning(
-                "Got error during checking if current platform is mobile. "
-                "\n\t {}".format(str(e))
-            )
-            if "Method is not implemented" in str(e):
-                # potentially mobile app
-                is_mobile_platform = True
-            else:
-                is_mobile_platform = False
-    return is_mobile_platform
+    browser_name = driver.desired_capabilities.get("browserName", "").lower()
+    is_mobile = "android" in platform_name or "ios" in platform_name
+    if is_mobile and browser_name:
+        return True
+    return False
+
+
+def is_mobile_app(driver):
+    # type: (AnyWebDriver) -> bool
+    """
+    Returns whether the platform running is a mobile app.
+    """
+    platform_name = driver.desired_capabilities.get("platformName", "").lower()
+    browser_name = driver.desired_capabilities.get("browserName", "").lower()
+    app = driver.desired_capabilities.get("app", None)
+    is_mobile = "android" in platform_name or "ios" in platform_name
+    if is_mobile and app and not browser_name:
+        return True
+    return False
 
 
 def get_underlying_driver(driver):
@@ -210,7 +207,7 @@ def set_browser_size(driver, required_size):
     retries_left = _RETRIES
 
     # set browser size for mobile devices isn't working
-    if is_mobile_device(driver):
+    if is_mobile_web(driver):
         return True
 
     while True:
@@ -380,7 +377,7 @@ def timeout(timeout):
 
 
 def is_landscape_orientation(driver):
-    if is_mobile_device(driver):
+    if is_mobile_web(driver):
         # could be AppiumRemoteWebDriver
         appium_driver = get_underlying_driver(
             driver
@@ -453,7 +450,7 @@ def root_html():
         return driver.find_element_by_tag_name("html")
 
     scroll_root_element = None
-    if not driver.is_mobile_device():
+    if not driver.is_mobile_app:
         if container is None:
             scroll_root_element = root_html()
         else:
@@ -479,6 +476,6 @@ def current_frame_scroll_root_element(driver):
     root_element = None
     if cur_frame:
         root_element = cur_frame.scroll_root_element
-    if root_element is None and not driver.is_mobile_device():
+    if root_element is None and not driver.is_mobile_app:
         root_element = driver.find_element_by_tag_name("html")
     return root_element

eyes_selenium/applitools/selenium/positioning.py

@@ -50,7 +50,7 @@ def __init__(self, driver, scroll_root_element):
 
     def __enter__(self):
         # type: () -> SeleniumPositionProvider
-        if self._driver.is_mobile_device():
+        if self._driver.is_mobile_app:
             return self
         return super(SeleniumPositionProvider, self).__enter__()
 
@@ -61,7 +61,7 @@ def __exit__(
         exc_tb,  # type: Optional[Any]
     ):
         # type: (...) -> Union[CSSTranslatePositionProvider, ScrollPositionProvider]
-        if self._driver.is_mobile_device():
+        if self._driver.is_mobile_app:
             return self
         return super(SeleniumPositionProvider, self).__exit__(exc_type, exc_val, exc_tb)
 
@@ -71,7 +71,7 @@ def get_entire_size(self):
         :return: The entire size of the container which the position is relative to.
         """
         try:
-            if self._driver.is_mobile_device():
+            if self._driver.is_mobile_app:
                 width, height = self._driver.execute_script(
                     self._JS_GET_CONTENT_ENTIRE_SIZE
                 )
@@ -108,7 +108,7 @@ def set_position(self, location):
         logger.debug(
             "setting position of %s to %s" % (location, self._scroll_root_element)
         )
-        if self._driver.is_mobile_device():
+        if self._driver.is_mobile_web:
             scroll_command = "window.scrollTo({0}, {1})".format(location.x, location.y)
             self._driver.execute_script(scroll_command)
             self._last_set_position = location
@@ -139,7 +139,7 @@ def get_current_position(self):
         """
         The scroll position of the current frame.
         """
-        if self._driver.is_mobile_device():
+        if self._driver.is_mobile_web:
             x, y = self._driver.execute_script(
                 self._JS_GET_CURRENT_SCROLL_POSITION, self._scroll_root_element
             )

eyes_selenium/applitools/selenium/selenium_eyes.py

@@ -27,6 +27,7 @@
     PositionProvider,
     RegionProvider,
     TextTrigger,
+    NullCutProvider,
 )
 from applitools.selenium.capture.eyes_webdriver_screenshot import (
     EyesWebDriverScreenshotFactory,
@@ -242,7 +243,7 @@ def check(self, name, check_settings=None):
         )
         self._original_frame_chain = self.driver.frame_chain.clone()
 
-        if not self.driver.is_mobile_device():
+        if not self.driver.is_mobile_platform:
             # hide scrollbar for main window
             self._try_hide_scrollbars()
 
@@ -293,7 +294,7 @@ def _check_result_flow(self, name, check_settings):
                     result = self._check_frame_fluent(name, check_settings)
             else:
                 logger.debug("default case")
-                if not self.driver.is_mobile_device():
+                if not self.driver.is_mobile_platform:
                     # required to prevent cut line on the last stitched part of the
                     # page on some browsers (like firefox).
                     self.driver.switch_to.default_content()
@@ -498,7 +499,7 @@ def _set_viewport_size(self, size):
         #     logger.info("Ignored (viewport size given explicitly)")
         #     return None
 
-        if not self.driver.is_mobile_device():
+        if not self.driver.is_mobile_platform:
             original_frame = self.driver.frame_chain.clone()
             self.driver.switch_to.default_content()
 
@@ -524,7 +525,7 @@ def _environment(self):
             logger.info("No OS set, checking for mobile OS...")
             # Since in Python Appium driver is the same for Android and iOS,
             # we need to use the desired capabilities to figure this out.
-            if eyes_selenium_utils.is_mobile_device(self._driver):
+            if eyes_selenium_utils.is_mobile_platform(self._driver):
                 platform_name = self._driver.platform_name
                 logger.info(platform_name + " detected")
                 platform_version = self._driver.platform_version
@@ -667,7 +668,7 @@ def _try_hide_caret(self):
 
     def _get_screenshot(self):
         with self._driver.switch_to.frames_and_back(self._original_frame_chain):
-            if self.position_provider and not self.driver.is_mobile_device():
+            if self.position_provider and not self.driver.is_mobile_platform:
                 self.position_provider.push_state()
 
         self._try_hide_caret()
@@ -682,7 +683,7 @@ def _get_screenshot(self):
             self._last_screenshot = self._viewport_screenshot(scale_provider)
 
         with self._driver.switch_to.frames_and_back(self._original_frame_chain):
-            if self.position_provider and not self.driver.is_mobile_device():
+            if self.position_provider and not self.driver.is_mobile_platform:
                 self.position_provider.pop_state()
 
         return self._last_screenshot
@@ -756,10 +757,18 @@ def _viewport_screenshot(self, scale_provider):
         sleep(self.configuration.wait_before_screenshots / 1000.0)
         image = self._image_provider.get_image()
         self._debug_screenshot_provider.save(image, "original")
+
         scale_provider.update_scale_ratio(image.width)
         pixel_ratio = 1 / scale_provider.scale_ratio
         if pixel_ratio != 1.0:
+            logger.info("Scalling")
             image = image_utils.scale_image(image, 1.0 / pixel_ratio)
+            self._debug_screenshot_provider.save(image, "scaled")
+
+        if not isinstance(self.cut_provider, NullCutProvider):
+            logger.info("Cutting")
+            image = self.cut_provider.cut(image)
+            self._debug_screenshot_provider.save(image, "cutted")
 
         return EyesWebDriverScreenshot.create_viewport(self._driver, image)
 
@@ -781,7 +790,7 @@ def _ensure_element_visible(self, element):
         if self._target_element is None:
             # No element? we must be checking the window.
             return None
-        if self.driver.is_mobile_device():
+        if self.driver.is_mobile_platform:
             logger.debug("NATIVE context identified, skipping 'ensure element visible'")
             return None
 

eyes_selenium/applitools/selenium/visual_grid/render_task.py

@@ -19,7 +19,7 @@
 
 if typing.TYPE_CHECKING:
     from typing import Callable, Dict, Any, Text, List
-    from applitools.common.visual_grid import RenderStatusResults
+    from applitools.common import RenderStatusResults, Region
     from applitools.selenium.visual_grid import RunningTest, EyesConnector
 
 
@@ -36,7 +36,7 @@ class RenderTask(VGTask):
     rendering_info = attr.ib()
     region_selectors = attr.ib(hash=False, factory=list)
     size_mode = attr.ib(default=None)
-    region_to_check = attr.ib(hash=False, default=None)
+    region_to_check = attr.ib(hash=False, default=None)  # type: Region
     agent_id = attr.ib(default=None)
     func_to_run = attr.ib(default=None, hash=False, repr=False)  # type: Callable