Implement VisualStateProvider and tests for it

Add draft for VisualConfiguration and settings for it, add it to DI module
Add localization values for logger
moved ILogElementState to logging package

Author: mialeska

src/main/java/aquality/selenium/core/applications/AqualityModule.java

@@ -45,6 +45,7 @@ protected void configure() {
         bind(ITimeoutConfiguration.class).to(getTimeoutConfigurationImplementation()).in(Singleton.class);
         bind(IRetryConfiguration.class).to(getRetryConfigurationImplementation()).in(Singleton.class);
         bind(IElementCacheConfiguration.class).to(getElementCacheConfigurationImplementation()).in(Singleton.class);
+        bind(IVisualConfiguration.class).to(getVisualConfigurationImplementation()).in(Singleton.class);
         bind(IElementActionRetrier.class).to(getElementActionRetrierImplementation()).in(Singleton.class);
         bind(IActionRetrier.class).to(getActionRetrierImplementation()).in(Singleton.class);
         bind(ILocalizationManager.class).to(getLocalizationManagerImplementation()).in(Singleton.class);

src/main/java/aquality/selenium/core/configurations/IConfigurationsModule.java

@@ -4,6 +4,13 @@
  * Describes implementations of configurations to be registered in DI container.
  */
 public interface IConfigurationsModule {
+    /**
+     * @return class which implements {@link IVisualConfiguration}
+     */
+    default Class<? extends IVisualConfiguration> getVisualConfigurationImplementation() {
+        return VisualConfiguration.class;
+    }
+
     /**
      * @return class which implements {@link IElementCacheConfiguration}
      */

src/main/java/aquality/selenium/core/configurations/IVisualConfiguration.java

@@ -0,0 +1,12 @@
+package aquality.selenium.core.configurations;
+
+/**
+ * Represents visualization configuration, used for image comparison.
+ */
+public interface IVisualConfiguration {
+    /**
+     * Image format for comparison.
+     * @return image format.
+     */
+    String getImageFormat();
+}

src/main/java/aquality/selenium/core/configurations/VisualConfiguration.java

@@ -0,0 +1,40 @@
+package aquality.selenium.core.configurations;
+
+import aquality.selenium.core.utilities.ISettingsFile;
+import com.google.inject.Inject;
+
+import javax.imageio.ImageIO;
+import java.util.Arrays;
+
+/**
+ * Represents visualization configuration, used for image comparison.
+ * Uses {@link ISettingsFile} as source for configuration values.
+ */
+public class VisualConfiguration implements IVisualConfiguration {
+    private String imageFormat;
+    private final ISettingsFile settingsFile;
+
+    /**
+     * Instantiates class using {@link ISettingsFile} with visualization settings.
+     * @param settingsFile settings file.
+     */
+    @Inject
+    public VisualConfiguration(ISettingsFile settingsFile) {
+        this.settingsFile = settingsFile;
+    }
+
+    @Override
+    public String getImageFormat() {
+        if (imageFormat == null) {
+            String[] supportedFormats = ImageIO.getWriterFormatNames();
+            String valueFromConfig = settingsFile.getValueOrDefault("/visualization/imageExtension", "png").toString();
+            String actualFormat = valueFromConfig.startsWith(".") ? valueFromConfig.substring(1) : valueFromConfig;
+            if (Arrays.stream(supportedFormats).noneMatch(format -> format.equals(actualFormat))) {
+                throw new IllegalArgumentException(String.format(
+                        "Format [%s] is not supported by current JRE. Supported formats: %s", actualFormat, Arrays.toString(supportedFormats)));
+            }
+            imageFormat = actualFormat;
+        }
+        return imageFormat;
+    }
+}

src/main/java/aquality/selenium/core/elements/CachedElementStateProvider.java

@@ -1,7 +1,7 @@
 package aquality.selenium.core.elements;
 
 import aquality.selenium.core.elements.interfaces.IElementCacheHandler;
-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.NoSuchElementException;

src/main/java/aquality/selenium/core/elements/DefaultElementStateProvider.java

@@ -1,7 +1,7 @@
 package aquality.selenium.core.elements;
 
 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;
 

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

@@ -6,8 +6,13 @@
 import aquality.selenium.core.elements.interfaces.*;
 import aquality.selenium.core.localization.ILocalizationManager;
 import aquality.selenium.core.localization.ILocalizedLogger;
+import aquality.selenium.core.logging.ILogElementState;
+import aquality.selenium.core.logging.ILogVisualState;
 import aquality.selenium.core.logging.Logger;
 import aquality.selenium.core.utilities.IElementActionRetrier;
+import aquality.selenium.core.visualization.IImageComparator;
+import aquality.selenium.core.visualization.IVisualStateProvider;
+import aquality.selenium.core.visualization.VisualStateProvider;
 import aquality.selenium.core.waitings.IConditionalWait;
 import org.openqa.selenium.By;
 import org.openqa.selenium.NoSuchElementException;
@@ -37,6 +42,8 @@ protected Element(final By loc, final String name, final ElementState state) {
 
     protected abstract IElementFinder getElementFinder();
 
+    protected abstract IImageComparator getImageComparator();
+
     protected abstract IElementCacheConfiguration getElementCacheConfiguration();
 
     protected abstract IElementActionRetrier getElementActionRetrier();
@@ -70,6 +77,10 @@ protected ILogElementState logElementState() {
                         getLocalizationManager().getLocalizedMessage(stateKey)));
     }
 
+    protected ILogVisualState logVisualState() {
+        return this::logElementAction;
+    }
+
     @Override
     public By getLocator() {
         return locator;
@@ -87,6 +98,11 @@ public IElementStateProvider state() {
                 : new DefaultElementStateProvider(locator, getConditionalWait(), getElementFinder(), logElementState());
     }
 
+    @Override
+    public IVisualStateProvider visual() {
+        return new VisualStateProvider(getImageComparator(), getElementActionRetrier(), this::getElement, logVisualState());
+    }
+
     @Override
     public RemoteWebElement getElement(Duration timeout) {
         try {

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

@@ -1,7 +1,7 @@
 package aquality.selenium.core.elements;
 
 import aquality.selenium.core.elements.interfaces.IElementStateProvider;
-import aquality.selenium.core.elements.interfaces.ILogElementState;
+import aquality.selenium.core.logging.ILogElementState;
 import org.openqa.selenium.WebElement;
 
 public abstract class ElementStateProvider implements IElementStateProvider {

src/main/java/aquality/selenium/core/elements/interfaces/IElement.java

@@ -1,5 +1,6 @@
 package aquality.selenium.core.elements.interfaces;
 
+import aquality.selenium.core.visualization.IVisualStateProvider;
 import org.openqa.selenium.By;
 import org.openqa.selenium.remote.RemoteWebElement;
 
@@ -27,6 +28,12 @@ public interface IElement extends IParent {
      */
     IElementStateProvider state();
 
+    /**
+     * Gets element visual state.
+     * @return provider to define element's visual state.
+     */
+    IVisualStateProvider visual();
+
     /**
      * Gets current element by specified {@link #getLocator()}
      * Default timeout is provided in {@link aquality.selenium.core.configurations.ITimeoutConfiguration}

src/main/java/aquality/selenium/core/elements/interfaces/ILogElementState.java renamed to src/main/java/aquality/selenium/core/logging/ILogElementState.java

@@ -1,4 +1,4 @@
-package aquality.selenium.core.elements.interfaces;
+package aquality.selenium.core.logging;
 
 /**
  * Describes interface that can log element state.