Refactor core (#12)

Refactor AgentConnector to ServerConnector

Author: eirenik0

.pre-commit-config.yaml

@@ -31,3 +31,5 @@ repos:
           - id: trailing-whitespace
           - id: end-of-file-fixer
           - id: debug-statements
+          - id: mixed-line-ending
+            fix: lr

.travis.yml

@@ -7,6 +7,12 @@ addons:
             - google-chrome-stable
 matrix:
     include:
+        - python: 2.7
+          env:
+              - TOX_ENV=core
+        - python: 3.5
+          env:
+              - TOX_ENV=core
         - python: 2.7
           env:
               - TOX_ENV=images

eyes_core/applitools/core/__init__.py

@@ -7,7 +7,7 @@
 from .scaling import *  # noqa
 from .eyes_base import *  # noqa
 from .geometry import *  # noqa
-from .agent_connector import AgentConnector  # noqa
+from .server_connector import ServerConnector  # noqa
 from .positioning import *  # noqa
 from .match import *  # noqa
 from .metadata import *  # noqa
@@ -25,5 +25,5 @@
     + positioning.__all__  # noqa
     + match.__all__  # noqa
     + metadata.__all__  # noqa
-    + ("logger", "AgentConnector")  # noqa
+    + ("logger", "ServerConnector")  # noqa
 )

eyes_core/applitools/core/eyes_base.py

@@ -5,13 +5,13 @@
 import typing as tp
 
 from . import logger
-from .utils import ABC
+from .errors import DiffsFoundError, EyesError, NewTestError, TestFailedError
 from .match import ImageMatchSettings
-from .metadata import BatchInfo
-from .agent_connector import AgentConnector
-from .errors import EyesError, NewTestError, DiffsFoundError, TestFailedError
 from .match_window_task import MatchWindowTask
+from .metadata import BatchInfo
+from .server_connector import ServerConnector
 from .test_results import TestResults, TestResultsStatus
+from .utils import ABC
 
 if tp.TYPE_CHECKING:
     from .utils.custom_types import (
@@ -40,17 +40,16 @@ class FailureReports(object):
 class EyesBase(ABC):
     _DEFAULT_MATCH_TIMEOUT = 2000  # Milliseconds
     _DEFAULT_WAIT_BEFORE_SCREENSHOTS = 100  # ms
-    DEFAULT_EYES_SERVER = "https://eyesapi.applitools.com"
 
-    def __init__(self, server_url=DEFAULT_EYES_SERVER):
+    def __init__(self, server_url=None):
         # type: (tp.Text) -> None
         """
         Creates a new (possibly disabled) Eyes instance that
         interacts with the Eyes server.
 
         :param server_url: The URL of the Eyes server
         """
-        self._agent_connector = AgentConnector(server_url)  # type: AgentConnector
+        self._server_connector = ServerConnector(server_url)  # type: ServerConnector
         self._should_get_title = False  # type: bool
         self._is_open = False  # type: bool
         self._app_name = None  # type: tp.Optional[tp.Text]
@@ -209,7 +208,7 @@ def api_key(self):
 
         :return: The Api key used for authenticating the user with Eyes.
         """
-        return self._agent_connector.api_key
+        return self._server_connector.api_key
 
     @api_key.setter
     def api_key(self, api_key):
@@ -219,7 +218,7 @@ def api_key(self, api_key):
 
         :param api_key: The api key used for authenticating the user with Eyes.
         """
-        self._agent_connector.api_key = api_key  # type: ignore
+        self._server_connector.api_key = api_key  # type: ignore
 
     @property
     def server_url(self):
@@ -229,7 +228,7 @@ def server_url(self):
 
         :return: The URL of the Eyes server, or None to use the default server.
         """
-        return self._agent_connector.server_url
+        return self._server_connector.server_url
 
     @server_url.setter
     def server_url(self, server_url):
@@ -240,10 +239,7 @@ def server_url(self, server_url):
         :param server_url: The URL of the Eyes server, or None to use the default server.
         :return: None
         """
-        if server_url is None:
-            self._agent_connector.server_url = EyesBase.DEFAULT_EYES_SERVER
-        else:
-            self._agent_connector.server_url = server_url
+        self._server_connector.server_url = server_url
 
     @property
     @abc.abstractmethod
@@ -317,7 +313,7 @@ def close(self, raise_ex=True):
                 (not is_new_session) and self.save_failed_tests
             )
             logger.debug("close(): automatically save session? %s" % should_save)
-            results = self._agent_connector.stop_session(
+            results = self._server_connector.stop_session(
                 self._running_session, False, should_save
             )
             results.is_new = is_new_session
@@ -383,7 +379,7 @@ def abort_if_not_closed(self):
             if self._running_session:
                 logger.debug("abort_if_not_closed(): Aborting session...")
                 try:
-                    self._agent_connector.stop_session(
+                    self._server_connector.stop_session(
                         self._running_session, True, False
                     )
                     logger.info("--- Test aborted.")
@@ -421,13 +417,10 @@ def _open_base(self, app_name, test_name, viewport_size=None):
         logger.info("\nEyes version: {}\n".format(self.full_agent_id))
 
         if self.api_key is None:
-            try:
-                self.api_key = os.environ["APPLITOOLS_API_KEY"]
-            except KeyError:
-                raise EyesError(
-                    "API key not set! Log in to https://applitools.com to obtain your"
-                    " API Key and use 'api_key' to set it."
-                )
+            raise EyesError(
+                "API key not set! Log in to https://applitools.com to obtain your"
+                " API Key and use 'api_key' to set it."
+            )
 
         logger.info(
             "open(%s, %s, %s, %s)"
@@ -436,7 +429,7 @@ def _open_base(self, app_name, test_name, viewport_size=None):
 
         if self.is_open:
             self.abort_if_not_closed()
-            raise EyesError("a test is already running")
+            raise EyesError("A test is already running")
 
         self._before_open()
 
@@ -487,7 +480,7 @@ def _start_session(self):
 
         self._create_start_info()
         # Actually start the session.
-        self._running_session = self._agent_connector.start_session(self._start_info)
+        self._running_session = self._server_connector.start_session(self._start_info)
         self._should_match_once_on_timeout = self._running_session["is_new_session"]
 
     def _reset_last_screenshot(self):
@@ -501,7 +494,7 @@ def _ensure_running_session(self):
             return
         self._start_session()
         self._match_window_task = MatchWindowTask(
-            self, self._agent_connector, self._running_session, self.match_timeout
+            self, self._server_connector, self._running_session, self.match_timeout
         )
 
     def _before_match_window(self):
@@ -574,7 +567,7 @@ def _try_post_dom_snapshot(self, dom_json):
         if dom_json is None:
             return None
         try:
-            return self._agent_connector.post_dom_snapshot(dom_json)
+            return self._server_connector.post_dom_snapshot(dom_json)
         except Exception as e:
             logger.warning(
                 "Couldn't send DOM Json. Passing...\n Got next error: {}".format(e)

eyes_core/applitools/core/match_window_task.py

@@ -20,7 +20,7 @@
         UserInputs,
         MatchResult,
     )
-    from .agent_connector import AgentConnector
+    from .server_connector import ServerConnector
     from .match import ImageMatchSettings
     from .capture import EyesScreenshot
 
@@ -36,22 +36,22 @@ class MatchWindowTask(object):
     (including retry and 'ignore mismatch' when needed).
     """
 
-    _MATCH_INTERVAL = 0.5
+    MATCH_INTERVAL = 0.5
 
     MINIMUM_MATCH_TIMEOUT = 60  # Milliseconds
 
-    def __init__(self, eyes, agent_connector, running_session, default_retry_timeout):
-        # type: (EyesBase, AgentConnector, RunningSession, Num) -> None
+    def __init__(self, eyes, server_connector, running_session, default_retry_timeout):
+        # type: (EyesBase, ServerConnector, RunningSession, Num) -> None
         """
         Ctor.
 
         :param eyes: The Eyes instance which created this task.
-        :param agent_connector: The agent connector to use for communication.
+        :param server_connector: The agent connector to use for communication.
         :param running_session:  The current eyes session.
         :param default_retry_timeout: The default match timeout. (milliseconds)
         """
         self._eyes = eyes
-        self._agent_connector = agent_connector
+        self._server_connector = server_connector
         self._running_session = running_session
         self._default_retry_timeout = (
             default_retry_timeout / 1000.0
@@ -186,17 +186,17 @@ def _run_with_intervals(self, prepare_action, retry_timeout):
         # Start the timer.
         start = time.time()
         logger.debug("First match attempt...")
-        as_expected = self._agent_connector.match_window(self._running_session, data)
+        as_expected = self._server_connector.match_window(self._running_session, data)
         if as_expected:
             return {"as_expected": True, "screenshot": self._screenshot}
         retry = time.time() - start
         logger.debug("Failed. Elapsed time: {0:.1f} seconds".format(retry))
 
         while retry < retry_timeout:
             logger.debug("Matching...")
-            time.sleep(self._MATCH_INTERVAL)
+            time.sleep(self.MATCH_INTERVAL)
             data = prepare_action(ignore_mismatch=True)
-            as_expected = self._agent_connector.match_window(
+            as_expected = self._server_connector.match_window(
                 self._running_session, data
             )
             if as_expected:
@@ -206,7 +206,7 @@ def _run_with_intervals(self, prepare_action, retry_timeout):
         # One last try
         logger.debug("One last matching attempt...")
         data = prepare_action()
-        as_expected = self._agent_connector.match_window(self._running_session, data)
+        as_expected = self._server_connector.match_window(self._running_session, data)
         return {"as_expected": as_expected, "screenshot": self._screenshot}
 
     def _run(self, prepare_action, run_once_after_wait=False, retry_timeout=-1):
@@ -228,7 +228,7 @@ def _run(self, prepare_action, run_once_after_wait=False, retry_timeout=-1):
             # If the load time is 0, the sleep would immediately return anyway.
             time.sleep(retry_timeout)
             data = prepare_action()
-            as_expected = self._agent_connector.match_window(
+            as_expected = self._server_connector.match_window(
                 self._running_session, data
             )
             result = {