Merge pull request #31 from applitools/develop

Release 4.0.6

Author: danielputerman

.gitignore

@@ -193,3 +193,4 @@ venv.bak/
 # mypy
 .mypy_cache/
 /eyes_selenium/node_modules/
+logs/

.travis.yml

@@ -1,49 +1,65 @@
 language: python
-addons:
-    chrome: stable
-#    firefox: latest
-matrix:
+install:
+    - pip install -U tox
+before_script:
+    # Run GUI apps in headless mode
+    - export DISPLAY=:99.0
+    - sh -e /etc/init.d/xvfb start
+    - sleep 10 # give webdriver some time to start
+    - export APPLITOOLS_BATCH_ID=`uuidgen -t`
+script:
+    - echo $APPLITOOLS_BATCH_ID
+    - tox -e $TOX_ENV
+stages:
+    - lint
+    - unit-tests
+    - integration-tests
+    - eyes-images-tests
+    - functional-tests
+jobs:
     include:
-        - python: 2.7
+        - stage: lint
+          python: 3.6
           env:
-              - TOX_ENV=unit
-        - python: 3.5
+              - TOX_ENV=lint
+
+        - stage: unit-tests
+          python: 2.7
           env:
               - TOX_ENV=unit
-        - python: 2.7
-          env:
-              - TOX_ENV=images
-        - python: 3.5
+        - python: 3.6
           env:
-              - TOX_ENV=images
-        - python: 2.7
+              - TOX_ENV=unit
+
+        - stage: integration-tests
+          python: 2.7
           env:
               - TOX_ENV=integration
         - python: 3.6
           env:
               - TOX_ENV=integration
-        - python: 2.7
+
+        - stage: functional-tests
+          python: 3.6
+          addons:
+              chrome: stable
+              firefox: latest
           env:
-              - TOX_ENV=selenium
+              - TOX_ENV=selenium-on-linux
         - python: 3.6
           env:
-              - TOX_ENV=selenium
+              - TOX_ENV=images
         - python: 3.6
+#          env:
+#              - TOX_ENV=selenium-on-windows-remote
+#        - python: 3.6
+#          env:
+#              - TOX_ENV=selenium-on-macos-remote
+#        - python: 3.6
           env:
-              - TOX_ENV=selenium-appium
+              - TOX_ENV=selenium-appium-remote
         - python: 3.6
+          addons:
+              chrome: stable
           env:
               - TOX_ENV=visualgrid
-        - python: 3.6
-          env:
-              - TOX_ENV=lint
-install:
-    - pip install -U tox
-before_script:
-    - export DISPLAY=:99.0
-    - sh -e /etc/init.d/xvfb start
-    - sleep 10 # give webdriver some time to start
-    - export APPLITOOLS_BATCH_ID=`uuidgen -t`
-script:
-    - echo $APPLITOOLS_BATCH_ID
-    - tox -e $TOX_ENV

eyes_common/applitools/common/config/configuration.py

@@ -26,7 +26,7 @@ class BatchInfo(object):
     """
 
     name = attr.ib(
-        factory=lambda: os.environ.get("APPLITOOLS_BATCH_NAME"),
+        factory=lambda: os.getenv("APPLITOOLS_BATCH_NAME"),
         metadata={JsonInclude.THIS: True},
     )  # type: Optional[Text]
     started_at = attr.ib(
@@ -35,12 +35,12 @@ class BatchInfo(object):
     )  # type: Union[datetime, Text]
     sequence_name = attr.ib(
         init=False,
-        factory=lambda: os.environ.get("APPLITOOLS_BATCH_SEQUENCE"),
+        factory=lambda: os.getenv("APPLITOOLS_BATCH_SEQUENCE"),
         metadata={JsonInclude.NAME: "batchSequenceName"},
     )  # type: Optional[Text]
     id = attr.ib(
         init=False,
-        factory=lambda: os.environ.get("APPLITOOLS_BATCH_ID", str(uuid.uuid4())),
+        factory=lambda: os.getenv("APPLITOOLS_BATCH_ID", str(uuid.uuid4())),
         metadata={JsonInclude.THIS: True},
     )  # type: Text
 
@@ -56,13 +56,13 @@ class Configuration(object):
 
     batch = attr.ib(default=None)  # type: Optional[BatchInfo]
     branch_name = attr.ib(
-        factory=lambda: os.environ.get("APPLITOOLS_BRANCH", None)
+        factory=lambda: os.getenv("APPLITOOLS_BRANCH", None)
     )  # type: Optional[Text]
     parent_branch_name = attr.ib(
-        factory=lambda: os.environ.get("APPLITOOLS_PARENT_BRANCH", None)
+        factory=lambda: os.getenv("APPLITOOLS_PARENT_BRANCH", None)
     )  # type: Optional[Text]
     baseline_branch_name = attr.ib(
-        factory=lambda: os.environ.get("APPLITOOLS_BASELINE_BRANCH", None)
+        factory=lambda: os.getenv("APPLITOOLS_BASELINE_BRANCH", None)
     )  # type: Optional[Text]
     agent_id = attr.ib(default=None)  # type: Optional[Text]
     baseline_env_name = attr.ib(default=None)  # type: Optional[Text]
@@ -95,7 +95,7 @@ class Configuration(object):
     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))
+    api_key = attr.ib(factory=lambda: os.getenv("APPLITOOLS_API_KEY", None))
     server_url = attr.ib(default=DEFAULT_SERVER_URL)
     timeout = attr.ib(default=DEFAULT_TIMEOUT_MS)  # ms
 

eyes_common/applitools/common/logger.py

@@ -15,9 +15,9 @@
 _DEFAULT_EYES_FORMATTER = logging.Formatter(
     "%(asctime)s [%(levelname)s] %(threadName)-9s) %(name)s: %(message)s"
 )
-_DEFAULT_LOGGER_LEVEL = int(os.environ.get("LOGGER_LEVEL", logging.INFO))
-_DEBUG_SCREENSHOT_PREFIX = os.environ.get("DEBUG_SCREENSHOT_PREFIX", "screenshot_")
-_DEBUG_SCREENSHOT_PATH = os.environ.get("DEBUG_SCREENSHOT_PATH", ".")
+_DEFAULT_LOGGER_LEVEL = int(os.getenv("LOGGER_LEVEL", logging.INFO))
+_DEBUG_SCREENSHOT_PREFIX = os.getenv("DEBUG_SCREENSHOT_PREFIX", "screenshot_")
+_DEBUG_SCREENSHOT_PATH = os.getenv("DEBUG_SCREENSHOT_PATH", ".")
 
 __all__ = ("StdoutLogger", "FileLogger", "NullLogger")
 

eyes_common/applitools/common/visual_grid.py

@@ -41,6 +41,7 @@ class RenderStatus(Enum):
     RENDERED = "rendered"
     ERROR = "error"
     NEED_MORE_DOM = "need-more-dom"
+    INTERNAL_FAILURE = "internal failure"
 
 
 @attr.s(frozen=True)

eyes_core/applitools/core/__init__.py

@@ -23,6 +23,7 @@
     NullRegionProvider,
     PositionProvider,
     RegionProvider,
+    PositionMomento,
 )
 from .scaling import (
     ContextBasedScaleProvider,
@@ -43,8 +44,12 @@
     "ScaleProvider",
     "EyesBase",
     "PositionProvider",
+    "PositionMomento",
     "InvalidPositionProvider",
     "RegionProvider",
+    "FixedCutProvider",
+    "NullCutProvider",
+    "UnscaledFixedCutProvider",
     "NullRegionProvider",
     "NULL_REGION_PROVIDER",
     "CheckSettings",

eyes_core/applitools/core/debug.py

@@ -11,8 +11,8 @@
 class DebugScreenshotProvider(object):
     """Interface for saving debug screenshots."""
 
-    DEFAULT_PREFIX = os.environ.get("DEBUG_SCREENSHOT_PREFIX", "screenshot_")
-    DEFAULT_PATH = os.environ.get("DEBUG_SCREENSHOT_PATH", "")
+    DEFAULT_PREFIX = os.getenv("DEBUG_SCREENSHOT_PREFIX", "screenshot_")
+    DEFAULT_PATH = os.getenv("DEBUG_SCREENSHOT_PATH", "")
 
     _prefix = attr.ib(default=DEFAULT_PREFIX)
     _path = attr.ib(default=DEFAULT_PATH)

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(
@@ -293,7 +307,7 @@ def close(self, raise_ex=True):
         try:
             logger.debug("close({})".format(raise_ex))
             if not self._is_opened:
-                raise ValueError("Eyes not open")
+                raise EyesError("Eyes not open")
 
             self._is_opened = False
 
@@ -325,7 +339,7 @@ def close(self, raise_ex=True):
                 if results.is_new:
                     instructions = "Please approve the new baseline at " + results_url
                     logger.info("--- New test ended. " + instructions)
-                    if raise_ex:
+                    if raise_ex or self.configuration.fail_on_new_test:
                         message = "'%s' of '%s'. %s" % (
                             self._session_start_info.scenario_id_or_name,
                             self._session_start_info.app_id_or_name,
@@ -369,19 +383,19 @@ def close(self, raise_ex=True):
             self._running_session = None
             logger.close()
 
-    def abort_if_not_closed(self):
+    def abort(self):
         # type: () -> None
         """
         If a test is running, aborts it. Otherwise, does nothing.
         """
         if self.configuration.is_disabled:
-            logger.debug("abort_if_not_closed(): ignored (disabled)")
+            logger.debug("abort(): ignored (disabled)")
             return
         try:
             self._reset_last_screenshot()
 
             if self._running_session:
-                logger.debug("abort_if_not_closed(): Aborting session...")
+                logger.debug("abort(): Aborting session...")
                 try:
                     self._server_connector.stop_session(
                         self._running_session, True, False
@@ -395,6 +409,10 @@ def abort_if_not_closed(self):
         finally:
             logger.close()
 
+    def abort_if_not_closed(self):
+        logger.deprecation("Use `abort()` instead")
+        self.abort()
+
     def open_base(
         self,
         app_name,  # type: Text
@@ -474,7 +492,6 @@ def _open_base(self):
         retry = 0
         while retry < self.MAX_ITERATION:
             try:
-                self._validate_api_key()
                 self._validate_session_open()
                 self._init_providers()
 
@@ -501,7 +518,7 @@ def _open_base(self):
 
     def _validate_session_open(self):
         if self.is_opened:
-            self.abort_if_not_closed()
+            self.abort()
             raise EyesError("A test is already running")
 
     def _log_open_base(self):
@@ -519,13 +536,6 @@ def _log_open_base(self):
             "FailureReports = '{}' ".format(self.configuration.failure_reports)
         )
 
-    def _validate_api_key(self):
-        if self.configuration.api_key is None:
-            raise EyesError(
-                "API key not set! Log in to https://applitools.com to obtain your"
-                " API Key and use 'api_key' to set it."
-            )
-
     def _create_session_start_info(self):
         # type: () -> None
         self._session_start_info = SessionStartInfo(

eyes_core/applitools/core/positioning/__init__.py

@@ -1,4 +1,8 @@
-from .position_provider import InvalidPositionProvider, PositionProvider  # noqa: F401
+from .position_provider import (
+    InvalidPositionProvider,
+    PositionProvider,
+    PositionMomento,
+)  # noqa: F401
 from .region_provider import (  # noqa: F401
     NULL_REGION_PROVIDER,
     NullRegionProvider,

eyes_core/applitools/core/positioning/position_provider.py

@@ -4,16 +4,32 @@
 import attr
 
 from applitools.common.geometry import Point
-from applitools.common.utils import ABC
+from applitools.common.utils import ABC, iteritems
 
 if typing.TYPE_CHECKING:
     from typing import List, Optional
     from applitools.common import RectangleSize
 
 
+class PositionMomento(object):
+    """
+    A base class for position related memento instances. This is intentionally
+    not an interface, since the mementos might vary in their interfaces.
+    """
+
+    def __init__(self, position, **kwargs):
+        self.position = position
+        for name, val in iteritems(kwargs):
+            setattr(self, name, val)
+
+    def __str__(self):
+        return "PositionMomento(position={}, ...)".format(self.position)
+
+
 @attr.s
 class PositionProvider(ABC):
-    _states = attr.ib(init=False, factory=list)  # type: List[Point]
+    _states = attr.ib(init=False, factory=list)  # type: List[PositionMomento]
+    _last_set_position = attr.ib(init=False, default=None)  # type: Point
 
     @abc.abstractmethod
     def get_current_position(self):
@@ -42,16 +58,15 @@ def push_state(self):
         """
         Adds the current position to the states list.
         """
-        self._states.append(self.get_current_position())
+        self._states.append(PositionMomento(self.get_current_position()))
 
     def pop_state(self):
-        # type: ()-> Point
         """
         Sets the position to be the last position added to the states list.
         """
         state = self._states.pop()
-        self.set_position(state)
-        return state
+        self.set_position(state.position)
+        self._last_set_position = state.position
 
     @property
     def states(self):