Implemented DumpsManager and Form abstraction

Finished visualization implementation, add tests

Author: mialeska

.gitignore

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

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

@@ -45,7 +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(IVisualizationConfiguration.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

@@ -5,10 +5,10 @@
  */
 public interface IConfigurationsModule {
     /**
-     * @return class which implements {@link IVisualConfiguration}
+     * @return class which implements {@link IVisualizationConfiguration}
      */
-    default Class<? extends IVisualConfiguration> getVisualConfigurationImplementation() {
-        return VisualConfiguration.class;
+    default Class<? extends IVisualizationConfiguration> getVisualConfigurationImplementation() {
+        return VisualizationConfiguration.class;
     }
 
     /**

src/main/java/aquality/selenium/core/configurations/IVisualConfiguration.java renamed to src/main/java/aquality/selenium/core/configurations/IVisualizationConfiguration.java

@@ -3,7 +3,7 @@
 /**
  * Represents visualization configuration, used for image comparison.
  */
-public interface IVisualConfiguration {
+public interface IVisualizationConfiguration {
     /**
      * Image format for comparison.
      * @return image format.

src/main/java/aquality/selenium/core/configurations/VisualConfiguration.java renamed to src/main/java/aquality/selenium/core/configurations/VisualizationConfiguration.java

@@ -4,16 +4,14 @@
 import aquality.selenium.core.utilities.ISettingsFile;
 import com.google.inject.Inject;
 
-import javax.imageio.ImageIO;
 import java.io.File;
 import java.io.IOException;
-import java.util.Arrays;
 
 /**
  * Represents visualization configuration, used for image comparison.
  * Uses {@link ISettingsFile} as source for configuration values.
  */
-public class VisualConfiguration implements IVisualConfiguration {
+public class VisualizationConfiguration implements IVisualizationConfiguration {
     private String imageFormat;
     private Integer maxFullFileNameLength;
     private Float defaultThreshold;
@@ -28,21 +26,15 @@ public class VisualConfiguration implements IVisualConfiguration {
      * @param settingsFile settings file.
      */
     @Inject
-    public VisualConfiguration(ISettingsFile settingsFile) {
+    public VisualizationConfiguration(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;
+            imageFormat = valueFromConfig.startsWith(".") ? valueFromConfig.substring(1) : valueFromConfig;
         }
         return imageFormat;
     }
@@ -86,7 +78,7 @@ public int getComparisonHeight() {
     @Override
     public String getPathToDumps() {
         if (pathToDumps == null) {
-            pathToDumps = settingsFile.getValueOrDefault(".visualization.pathToDumps", "./src/test/resources/VisualDumps/").toString();
+            pathToDumps = settingsFile.getValueOrDefault("/visualization/pathToDumps", "./src/test/resources/visualDumps/").toString();
             if (pathToDumps.startsWith(".")) {
                 try {
                     pathToDumps = new File(pathToDumps).getCanonicalPath();

src/main/java/aquality/selenium/core/forms/Form.java

@@ -0,0 +1,160 @@
+package aquality.selenium.core.forms;
+
+import aquality.selenium.core.configurations.IVisualizationConfiguration;
+import aquality.selenium.core.elements.Element;
+import aquality.selenium.core.elements.ElementState;
+import aquality.selenium.core.elements.interfaces.IElement;
+import aquality.selenium.core.localization.ILocalizedLogger;
+import aquality.selenium.core.logging.Logger;
+import aquality.selenium.core.visualization.DumpManager;
+import aquality.selenium.core.visualization.IDumpManager;
+
+import java.lang.reflect.Field;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.stream.Collectors;
+
+/**
+ * Describes form that could be used for visualization purposes (see {@link IDumpManager}).
+ *
+ * @param <T> Base type(class or interface) of elements of this form.
+ */
+public abstract class Form<T extends IElement> implements IForm {
+    private final Class<T> elementClass;
+
+    /**
+     * Initializes the form.
+     *
+     * @param elementClass Base type(class or interface) of elements of this form.
+     */
+    protected Form(Class<T> elementClass) {
+        this.elementClass = elementClass;
+    }
+
+    /**
+     * Visualization configuration used by {@link IDumpManager}.
+     * Could be obtained from AqualityServices.
+     *
+     * @return visualization configuration.
+     */
+    protected abstract IVisualizationConfiguration getVisualizationConfiguration();
+
+    /**
+     * Localized logger used by {@link IDumpManager}.
+     * Could be obtained from AqualityServices.
+     *
+     * @return localized logger.
+     */
+    protected abstract ILocalizedLogger getLocalizedLogger();
+
+    /**
+     * Name of the current form.
+     *
+     * @return form's name.
+     */
+    @Override
+    public abstract String getName();
+
+    /**
+     * Gets dump manager for the current form that could be used for visualization purposes,
+     * such as saving and comparing dumps.
+     * Uses getElementsForVisualization() as basis for dump creation and comparison.
+     *
+     * @return form's dump manager.
+     */
+    @Override
+    public IDumpManager dump() {
+        return new DumpManager<>(getElementsForVisualization(), getName(), getVisualizationConfiguration(), getLocalizedLogger());
+    }
+
+    /**
+     * List of pairs uniqueName-element to be used for dump saving and comparing.
+     * By default, only currently displayed elements to be used with getDisplayedElements().
+     * You can override this property with defined getAllElements(), getAllCurrentFormElements,
+     * getElementsInitializedAsDisplayed(), or your own element set.
+     *
+     * @return elements for visualization.
+     */
+    protected Map<String, T> getElementsForVisualization() {
+        return getDisplayedElements();
+    }
+
+    /**
+     * List of pairs uniqueName-element from the current form and it's parent forms, which are currently displayed.
+     *
+     * @return list of displayed elements.
+     */
+    protected Map<String, T> getDisplayedElements() {
+        return getAllElements().entrySet().stream().filter(element -> element.getValue().state().isDisplayed())
+                .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
+    }
+
+    /**
+     * List of pairs uniqueName-element from the current form and it's parent forms, which were initialized as displayed.
+     *
+     * @return list of displayed elements.
+     */
+    protected Map<String, T> getElementsInitializedAsDisplayed() {
+        return getAllElements().entrySet().stream().filter(element -> {
+            try {
+                Field stateField = Element.class.getDeclaredField("elementState");
+                stateField.setAccessible(true);
+                ElementState elementState = (ElementState) stateField.get(element.getValue());
+                stateField.setAccessible(false);
+                return ElementState.DISPLAYED == elementState;
+            } catch (ReflectiveOperationException exception) {
+                Logger.getInstance().fatal("Failed to read state the element: " + element.getKey(), exception);
+                return false;
+            }
+        }).collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue));
+    }
+
+    /**
+     * List of pairs uniqueName-element from the current form and it's parent forms.
+     *
+     * @return list of elements.
+     */
+    protected Map<String, T> getAllElements() {
+        Map<String, T> map = new HashMap<>();
+        addElementsToMap(map, this.getClass().getDeclaredFields());
+        Class<?> superClass = this.getClass().getSuperclass();
+        while (superClass != null) {
+            addElementsToMap(map, superClass.getDeclaredFields());
+            superClass = superClass.getSuperclass();
+        }
+        return map;
+    }
+
+    /**
+     * List of pairs uniqueName-element from the current form.
+     *
+     * @return list of elements.
+     */
+    protected Map<String, T> getAllCurrentFormElements() {
+        Map<String, T> map = new HashMap<>();
+        addElementsToMap(map, this.getClass().getDeclaredFields());
+        return map;
+    }
+
+    /**
+     * Adds pairs uniqueName-element from the specified fields array to map using the reflection.
+     *
+     * @param map map to save elements.
+     * @param fields any class fields (only assignable from target type will be added to map).
+     */
+    protected void addElementsToMap(Map<String, T> map, Field[] fields) {
+        for (Field field : fields) {
+            try {
+                if (elementClass.isAssignableFrom(field.getType())) {
+                    field.setAccessible(true);
+                    //noinspection unchecked
+                    map.put(field.getName(), (T) field.get(this));
+                    field.setAccessible(false);
+                }
+            }
+            catch (IllegalAccessException exception) {
+                Logger.getInstance().fatal("Failed to read the element: " + field.getName(), exception);
+            }
+        }
+    }
+}

src/main/java/aquality/selenium/core/forms/IForm.java

@@ -0,0 +1,24 @@
+package aquality.selenium.core.forms;
+
+import aquality.selenium.core.visualization.IDumpManager;
+
+/**
+ * Describes form that could be used for visualization purposes, such as saving and comparing dumps.
+ * See {@link aquality.selenium.core.visualization.IDumpManager} for more details.
+ */
+public interface IForm {
+    /**
+     * Name of the current form.
+     *
+     * @return form's name.
+     */
+    String getName();
+
+    /**
+     * Gets dump manager for the current form that could be used for visualization purposes,
+     * such as saving and comparing dumps.
+     *
+     * @return form's dump manager.
+     */
+    IDumpManager dump();
+}