Merge pull request #21 from applitools/develop

Merge develop to master

Author: eirenik0

.bumpversion.cfg

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

eyes_common/applitools/common/__init__.py

@@ -29,7 +29,7 @@
 from .match_window_data import MatchWindowData, Options
 from .metadata import AppEnvironment, RunningSession, SessionStartInfo
 from .server import FailureReports, SessionType
-from .test_results import TestResults
+from .test_results import TestResults, TestResultSummary
 from .visual_grid import (
     ChromeEmulationInfo,
     DeviceName,

eyes_common/applitools/common/__version__.py

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

eyes_common/applitools/common/config/configuration.py

@@ -84,7 +84,7 @@ class Configuration(object):
     properties = attr.ib(factory=list)
     hide_scrollbars = attr.ib(default=False)
     match_timeout = attr.ib(default=DEFAULT_MATCH_TIMEOUT)
-    match_level = attr.ib(default=MatchLevel.STRICT)  # TODO add converter to enum
+    match_level = attr.ib(default=MatchLevel.STRICT, converter=MatchLevel)
     is_disabled = attr.ib(default=False)
     save_new_tests = attr.ib(default=True)
     save_failed_tests = attr.ib(default=False)

eyes_common/applitools/common/match.py

@@ -88,30 +88,30 @@ class ImageMatchSettings(object):
     """
 
     match_level = attr.ib(
-        default=MatchLevel.STRICT, metadata={JsonInclude.NON_NONE: True}
+        default=MatchLevel.STRICT, metadata={JsonInclude.THIS: True}
     )  # type: MatchLevel
     exact = attr.ib(
-        default=None, type=ExactMatchSettings, metadata={JsonInclude.NON_NONE: True}
+        default=None, type=ExactMatchSettings, metadata={JsonInclude.THIS: True}
     )  # type: Optional[ExactMatchSettings]
-    ignore_caret = attr.ib(default=None, metadata={JsonInclude.NON_NONE: True})
-    send_dom = attr.ib(default=False, metadata={JsonInclude.NON_NONE: True})
-    use_dom = attr.ib(default=False, metadata={JsonInclude.NON_NONE: True})
-    enable_patterns = attr.ib(default=False, metadata={JsonInclude.NON_NONE: True})
+    ignore_caret = attr.ib(default=False, metadata={JsonInclude.THIS: True})
+    send_dom = attr.ib(default=False, metadata={JsonInclude.THIS: True})
+    use_dom = attr.ib(default=False, metadata={JsonInclude.THIS: True})
+    enable_patterns = attr.ib(default=False, metadata={JsonInclude.THIS: True})
 
     ignore = attr.ib(
-        factory=list, type=typing.List[Region], metadata={JsonInclude.NON_NONE: True}
+        factory=list, type=typing.List[Region], metadata={JsonInclude.THIS: True}
     )
     layout = attr.ib(
-        factory=list, type=typing.List[Region], metadata={JsonInclude.NON_NONE: True}
+        factory=list, type=typing.List[Region], metadata={JsonInclude.THIS: True}
     )
     strict = attr.ib(
-        factory=list, type=typing.List[Region], metadata={JsonInclude.NON_NONE: True}
+        factory=list, type=typing.List[Region], metadata={JsonInclude.THIS: True}
     )
     content = attr.ib(
-        factory=list, type=typing.List[Region], metadata={JsonInclude.NON_NONE: True}
+        factory=list, type=typing.List[Region], metadata={JsonInclude.THIS: True}
     )
     floating = attr.ib(
-        factory=list, type=typing.List[Region], metadata={JsonInclude.NON_NONE: True}
+        factory=list, type=typing.List[Region], metadata={JsonInclude.THIS: True}
     )
 
 

eyes_common/applitools/common/test_results.py

@@ -9,13 +9,13 @@
 from .match import ImageMatchSettings
 
 if typing.TYPE_CHECKING:
-    from typing import Text, Any, Dict, Optional
+    from typing import Text, Any, Dict, Optional, List
 
     # TODO: Implement objects
     SessionUrls = Dict[Any, Any]
     StepInfo = Dict[Any, Any]
 
-__all__ = ("TestResults",)
+__all__ = ("TestResults", "TestResultSummary")
 
 
 class TestResultsStatus(Enum):
@@ -98,3 +98,30 @@ def __str__(self):
         origin_str = super(TestResults, self).__str__()
         preamble = "New test" if self.is_new else "Existing test"
         return "{} [{}]".format(preamble, origin_str)
+
+
+@attr.s
+class TestResultSummary(object):
+    all_results = attr.ib()  # type: List[TestResults]
+    exceptions = attr.ib(default=0)
+
+    passed = attr.ib(init=False, default=0)
+    unresolved = attr.ib(init=False, default=0)
+    failed = attr.ib(init=False, default=0)
+    mismatches = attr.ib(init=False, default=0)
+    missing = attr.ib(init=False, default=0)
+    matches = attr.ib(init=False, default=0)
+
+    def __attrs_post_init__(self):
+        for result in self.all_results:
+            if result is None:
+                continue
+            if result.is_failed:
+                self.failed += 1
+            elif result.is_passed:
+                self.passed += 1
+            elif result.is_unresolved:
+                self.unresolved += 1
+            self.matches += result.matches
+            self.missing += result.missing
+            self.mismatches += result.mismatches

eyes_core/applitools/core/__init__.py

@@ -1,29 +1,63 @@
-from .eyes_base import EyesBase  # noqa
-from .fluent import *  # noqa
-from .match_window_task import *  # noqa
-from .positioning import (  # noqa: F401
+from .capture import (
+    AppOutputProvider,
+    AppOutputWithScreenshot,
+    EyesScreenshotFactory,
+    ImageProvider,
+)
+from .cut import FixedCutProvider, NullCutProvider, UnscaledFixedCutProvider
+from .eyes_base import EyesBase
+from .fluent import (
+    CheckSettings,
+    CheckSettingsValues,
+    CheckTarget,
+    FloatingRegionByRectangle,
+    GetFloatingRegion,
+    GetRegion,
+    GetSelector,
+    IgnoreRegionByRectangle,
+)
+from .match_window_task import MatchWindowTask
+from .positioning import (
     NULL_REGION_PROVIDER,
     InvalidPositionProvider,
     NullRegionProvider,
     PositionProvider,
     RegionProvider,
 )
-from .scaling import *  # noqa
-from .server_connector import ServerConnector  # noqa
-from .triggers import *  # noqa
+from .scaling import (
+    ContextBasedScaleProvider,
+    FixedScaleProvider,
+    NullScaleProvider,
+    ScaleProvider,
+)
+from .server_connector import ServerConnector
+from .triggers import MouseTrigger, TextTrigger
 
 __all__ = (
-    triggers.__all__  # noqa
-    + match_window_task.__all__  # noqa
-    + scaling.__all__  # noqa
-    + eyes_base.__all__  # noqa
-    + (
-        "PositionProvider",
-        "InvalidPositionProvider",
-        "RegionProvider",
-        "NullRegionProvider",
-        "NULL_REGION_PROVIDER",
-    )
-    + fluent.__all__  # noqa
-    + ("ServerConnector",)  # noqa
+    "TextTrigger",
+    "MouseTrigger",
+    "MatchWindowTask",
+    "ContextBasedScaleProvider",
+    "FixedScaleProvider",
+    "NullScaleProvider",
+    "ScaleProvider",
+    "EyesBase",
+    "PositionProvider",
+    "InvalidPositionProvider",
+    "RegionProvider",
+    "NullRegionProvider",
+    "NULL_REGION_PROVIDER",
+    "CheckSettings",
+    "CheckSettingsValues",
+    "CheckTarget",
+    "GetRegion",
+    "GetFloatingRegion",
+    "FloatingRegionByRectangle",
+    "IgnoreRegionByRectangle",
+    "GetSelector",
+    "ServerConnector",
+    "AppOutputWithScreenshot",
+    "AppOutputProvider",
+    "EyesScreenshotFactory",
+    "ImageProvider",
 )

eyes_core/applitools/core/__version__.py

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

eyes_core/applitools/core/capture.py

@@ -8,10 +8,17 @@
 
 if typing.TYPE_CHECKING:
     from typing import Optional
-    from applitools.core.fluent import CheckSettings
+    from applitools.core import CheckSettings
 
     T = typing.TypeVar("T", bound=CheckSettings)
 
+__all__ = (
+    "AppOutputWithScreenshot",
+    "AppOutputProvider",
+    "EyesScreenshotFactory",
+    "ImageProvider",
+)
+
 
 @attr.s
 class AppOutputWithScreenshot(object):

eyes_core/applitools/core/cut.py

@@ -6,6 +6,8 @@
 from applitools.common import Region
 from applitools.common.utils import ABC, image_utils
 
+__all__ = ("FixedCutProvider", "UnscaledFixedCutProvider", "NullCutProvider")
+
 
 @attr.s
 class CutProvider(ABC):