Merge pull request #119 from aquality-automation/breaking/add-visualization

[Feature] [Breaking] Visualization

Author: aqualityAutomation

.gitignore

@@ -5,6 +5,9 @@ downloads
 # Log file
 *.log
 
+# Visualization files
+visualDumps/
+
 # BlueJ files
 *.ctxt
 

README.md

@@ -22,7 +22,7 @@ Alternatively, you can follow the steps below:
 <dependency>
     <groupId>com.github.aquality-automation</groupId>
     <artifactId>aquality-selenium</artifactId>
-    <version>3.x.x</version>
+    <version>4.x.x</version>
 </dependency>
 ```
 

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>com.github.aquality-automation</groupId>
     <artifactId>aquality-selenium</artifactId>
-    <version>3.2.1</version>
+    <version>4.0.0</version>
     <packaging>jar</packaging>
     <name>Aquality Selenium</name>
     <description>Library around Selenium WebDriver</description>
@@ -81,19 +81,19 @@
         <dependency>
             <groupId>com.github.aquality-automation</groupId>
             <artifactId>aquality-selenium-core</artifactId>
-            <version>2.0.6</version>
+            <version>3.0.0</version>
         </dependency>
 
         <dependency>
             <groupId>io.github.bonigarcia</groupId>
             <artifactId>webdrivermanager</artifactId>
-            <version>5.3.1</version>
+            <version>5.3.2</version>
         </dependency>
 
         <dependency>
             <groupId>com.fasterxml.jackson.core</groupId>
             <artifactId>jackson-databind</artifactId>
-            <version>2.14.1</version>
+            <version>2.14.2</version>
         </dependency>
 
         <dependency>

src/main/java/aquality/selenium/configuration/Configuration.java

@@ -3,6 +3,7 @@
 import aquality.selenium.core.configurations.IElementCacheConfiguration;
 import aquality.selenium.core.configurations.ILoggerConfiguration;
 import aquality.selenium.core.configurations.IRetryConfiguration;
+import aquality.selenium.core.configurations.IVisualizationConfiguration;
 import com.google.inject.Inject;
 
 public class Configuration implements IConfiguration {
@@ -12,16 +13,18 @@ public class Configuration implements IConfiguration {
     private final IBrowserProfile browserProfile;
     private final ILoggerConfiguration loggerConfiguration;
     private final IElementCacheConfiguration elementCacheConfiguration;
+    private final IVisualizationConfiguration visualizationConfiguration;
 
     @Inject
     public Configuration(ITimeoutConfiguration timeoutConfiguration, IRetryConfiguration retryConfiguration,
                          IBrowserProfile browserProfile, ILoggerConfiguration loggerConfiguration,
-                         IElementCacheConfiguration elementCacheConfiguration) {
+                         IElementCacheConfiguration elementCacheConfiguration, IVisualizationConfiguration visualizationConfiguration) {
         this.timeoutConfiguration = timeoutConfiguration;
         this.retryConfiguration = retryConfiguration;
         this.browserProfile = browserProfile;
         this.loggerConfiguration = loggerConfiguration;
         this.elementCacheConfiguration = elementCacheConfiguration;
+        this.visualizationConfiguration = visualizationConfiguration;
     }
 
     @Override
@@ -48,4 +51,9 @@ public ILoggerConfiguration getLoggerConfiguration() {
     public IElementCacheConfiguration getElementCacheConfiguration() {
         return elementCacheConfiguration;
     }
+
+    @Override
+    public IVisualizationConfiguration getVisualizationConfiguration() {
+        return visualizationConfiguration;
+    }
 }

src/main/java/aquality/selenium/configuration/IConfiguration.java

@@ -3,6 +3,7 @@
 import aquality.selenium.core.configurations.IElementCacheConfiguration;
 import aquality.selenium.core.configurations.ILoggerConfiguration;
 import aquality.selenium.core.configurations.IRetryConfiguration;
+import aquality.selenium.core.configurations.IVisualizationConfiguration;
 
 /**
  * Describes tool configuration.
@@ -43,4 +44,11 @@ public interface IConfiguration {
      * @return Configuration of element caching.
      */
     IElementCacheConfiguration getElementCacheConfiguration();
+
+    /**
+     * Gets configuration of VisualStateProvider and Dump manager.
+     *
+     * @return Visualization configuration.
+     */
+    IVisualizationConfiguration getVisualizationConfiguration();
 }

src/main/java/aquality/selenium/configuration/TimeoutConfiguration.java

@@ -37,7 +37,7 @@ private enum TIMEOUT {
         SCRIPT("timeoutScript"),
         PAGE_LOAD("timeoutPageLoad");
 
-        private String key;
+        private final String key;
 
         TIMEOUT(String key) {
             this.key = key;

src/main/java/aquality/selenium/configuration/driversettings/ChromeSettings.java

@@ -42,6 +42,11 @@ private void setChromeArgs(ChromeOptions options) {
         for (String arg : getBrowserStartArguments()) {
             options.addArguments(arg);
         }
+        // workaround for Selenium issue https://github.com/SeleniumHQ/selenium/issues/11750
+        final String allowOriginsArgument = "--remote-allow-origins=*";
+        if (!getBrowserStartArguments().contains(allowOriginsArgument)) {
+            options.addArguments(allowOriginsArgument);
+        }
     }
 
     @Override

src/main/java/aquality/selenium/elements/Element.java

@@ -12,6 +12,7 @@
 import aquality.selenium.core.localization.ILocalizationManager;
 import aquality.selenium.core.localization.ILocalizedLogger;
 import aquality.selenium.core.utilities.IElementActionRetrier;
+import aquality.selenium.core.visualization.IImageComparator;
 import aquality.selenium.core.waitings.IConditionalWait;
 import aquality.selenium.elements.actions.JsActions;
 import aquality.selenium.elements.actions.MouseActions;
@@ -64,6 +65,11 @@ void setElementFinder(IElementFinder elementFinder) {
         this.elementFinder = elementFinder;
     }
 
+    @Override
+    protected IImageComparator getImageComparator() {
+        return AqualityServices.get(IImageComparator.class);
+    }
+
     @Override
     protected IElementCacheConfiguration getElementCacheConfiguration() {
         return AqualityServices.get(IElementCacheConfiguration.class);
@@ -79,6 +85,7 @@ protected ILocalizedLogger getLocalizedLogger() {
         return AqualityServices.getLocalizedLogger();
     }
 
+    @Override
     protected ILocalizationManager getLocalizationManager() {
         return AqualityServices.get(ILocalizationManager.class);
     }

src/main/java/aquality/selenium/elements/ElementStateProvider.java

@@ -2,7 +2,7 @@
 
 import aquality.selenium.core.elements.DefaultElementStateProvider;
 import aquality.selenium.core.elements.interfaces.IElementFinder;
-import aquality.selenium.core.elements.interfaces.ILogElementState;
+import aquality.selenium.core.logging.ILogElementState;
 import aquality.selenium.core.waitings.IConditionalWait;
 import org.openqa.selenium.By;
 import org.openqa.selenium.WebElement;

src/main/java/aquality/selenium/elements/ElementType.java

@@ -11,13 +11,14 @@ public enum ElementType {
     RADIOBUTTON(IRadioButton.class),
     TEXTBOX(ITextBox.class);
 
-    private Class<? extends IElement> clazz;
+    private final Class<? extends IElement> clazz;
 
     <T extends IElement> ElementType(Class<T> clazz){
         this.clazz = clazz;
     }
 
     public <T extends IElement> Class<T> getClazz() {
+        //noinspection unchecked
         return (Class<T>) clazz;
     }
 }