Implement visualization classes and tests

mialeska · mialeska · commit 6ce4132feae4 · 2023-03-14T15:48:02.000+01:00
Fixed typo in enum ElementsCount MORE_THAN_ZERO
Add selenium/chromedriver issue workaround
diff --git a/.gitignore b/.gitignore
@@ -5,6 +5,9 @@ downloads
 # Log file
 *.log
 
+# Visualization files
+visualDumps/
+
 # BlueJ files
 *.ctxt
 
diff --git a/pom.xml b/pom.xml
@@ -81,7 +81,7 @@
         <dependency>
             <groupId>com.github.aquality-automation</groupId>
             <artifactId>aquality-selenium-core</artifactId>
-            <version>2.0.6</version>
+            <version>3.0.0</version>
         </dependency>
 
         <dependency>
diff --git a/src/main/java/aquality/selenium/configuration/Configuration.java b/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;
+    }
 }
diff --git a/src/main/java/aquality/selenium/configuration/IConfiguration.java b/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();
 }
diff --git a/src/main/java/aquality/selenium/configuration/driversettings/ChromeSettings.java b/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
diff --git a/src/main/java/aquality/selenium/elements/Element.java b/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);
     }
diff --git a/src/main/java/aquality/selenium/elements/ElementStateProvider.java b/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;
diff --git a/src/main/java/aquality/selenium/forms/Form.java b/src/main/java/aquality/selenium/forms/Form.java
@@ -1,17 +1,24 @@
 package aquality.selenium.forms;
 
 import aquality.selenium.browser.AqualityServices;
+import aquality.selenium.core.configurations.IVisualizationConfiguration;
 import aquality.selenium.core.elements.interfaces.IElementStateProvider;
 import aquality.selenium.core.localization.ILocalizedLogger;
+import aquality.selenium.elements.interfaces.IElement;
 import aquality.selenium.elements.interfaces.IElementFactory;
 import aquality.selenium.elements.interfaces.ILabel;
 import org.openqa.selenium.By;
-import org.openqa.selenium.Dimension;
+
+import java.awt.*;
 
 /**
  * Defines base class for any UI form.
  */
-public abstract class Form {
+public abstract class Form extends aquality.selenium.core.forms.Form<IElement> {
+    /**
+     * Label of form element defined by its locator and name.
+     */
+    private final ILabel formLabel;
     /**
      * Locator for specified form
      */
@@ -25,8 +32,10 @@ public abstract class Form {
      * Constructor with parameters
      */
     protected Form(By locator, String name) {
+        super(IElement.class);
         this.locator = locator;
         this.name = name;
+        formLabel = getElementFactory().getLabel(locator, name);
     }
 
     /**
@@ -83,7 +92,7 @@ public void scrollBy(int x, int y) {
      * @return Size of the form element.
      */
     public Dimension getSize() {
-        return getFormLabel().getElement().getSize();
+        return getFormLabel().visual().getSize();
     }
 
 
@@ -94,7 +103,7 @@ public Dimension getSize() {
      * @return Label of form element.
      */
     protected ILabel getFormLabel() {
-        return getElementFactory().getLabel(locator, name);
+        return formLabel;
     }
 
     /**
@@ -111,7 +120,18 @@ protected IElementFactory getElementFactory() {
      *
      * @return instance of localized logger.
      */
-    protected ILocalizedLogger getLogger() {
+    @Override
+    protected ILocalizedLogger getLocalizedLogger() {
         return AqualityServices.getLocalizedLogger();
     }
+
+    /**
+     * Visualization configuration used by dump().
+     *
+     * @return instance of visualization configuration.
+     */
+    @Override
+    protected IVisualizationConfiguration getVisualizationConfiguration() {
+        return AqualityServices.getConfiguration().getVisualizationConfiguration();
+    }
 }
diff --git a/src/main/resources/settings.json b/src/main/resources/settings.json
@@ -120,5 +120,13 @@
   },
   "elementCache": {
     "isEnabled": false
+  },
+  "visualization": {
+    "imageExtension": "png",
+    "maxFullFileNameLength": 255,
+    "defaultThreshold": 0.012,
+    "comparisonWidth": 16,
+    "comparisonHeight": 16,
+    "pathToDumps": "./src/test/resources/visualDumps/"
   }
 }
diff --git a/src/test/java/automationpractice/forms/ProductListForm.java b/src/test/java/automationpractice/forms/ProductListForm.java
@@ -25,7 +25,7 @@ public ProductListForm() {
     }
 
     public List<ILabel> getProductContainerLabels(){
-        return getElementFactory().findElements(By.xpath(XPATH_PRODUCT_CONTAINER), ElementType.LABEL, ElementsCount.MORE_THEN_ZERO, ElementState.DISPLAYED);
+        return getElementFactory().findElements(By.xpath(XPATH_PRODUCT_CONTAINER), ElementType.LABEL, ElementsCount.MORE_THAN_ZERO, ElementState.DISPLAYED);
     }
 
     private ILabel getLblFirstProduct(){
diff --git a/src/test/java/automationpractice/forms/YourPersonalInfoForm.java b/src/test/java/automationpractice/forms/YourPersonalInfoForm.java
@@ -35,7 +35,7 @@ public void setFirstName(String firstName){
     }
 
     public Integer getNumOfDays(){
-        List<ILabel> lblDays = getElementFactory().findElements(By.xpath(XPATH_SELECT_DAYS), ElementType.LABEL, ElementsCount.MORE_THEN_ZERO, ElementState.EXISTS_IN_ANY_STATE);
+        List<ILabel> lblDays = getElementFactory().findElements(By.xpath(XPATH_SELECT_DAYS), ElementType.LABEL, ElementsCount.MORE_THAN_ZERO, ElementState.EXISTS_IN_ANY_STATE);
         return lblDays.size();
     }
 
diff --git a/src/test/java/tests/integration/BrowserTests.java b/src/test/java/tests/integration/BrowserTests.java
@@ -184,7 +184,7 @@ public void testShouldBePossibleToScrollWindowBy(){
         WelcomeForm scrollForm = new WelcomeForm();
         getBrowser().goTo(scrollForm.getUrl());
         int initialY = scrollForm.getFormPointInViewPort().getY();
-        int formHeight = scrollForm.getSize().getHeight();
+        int formHeight = (int) scrollForm.getSize().getHeight();
         getBrowser().scrollWindowBy(0, formHeight);
         Assert.assertEquals(initialY - scrollForm.getFormPointInViewPort().getY(), formHeight);
     }
diff --git a/src/test/java/tests/integration/ElementTests.java b/src/test/java/tests/integration/ElementTests.java
@@ -83,7 +83,7 @@ public void testCheckBox() {
         navigate(TheInternetPage.CHECKBOXES);
         String checkboxLocator = "//input[@type='checkbox']";
         List<ICheckBox> checkBoxes = elementFactory.findElements(By.xpath(checkboxLocator), ICheckBox.class,
-                ElementsCount.MORE_THEN_ZERO, ElementState.DISPLAYED);
+                ElementsCount.MORE_THAN_ZERO, ElementState.DISPLAYED);
         ICheckBox checkBox1 = checkBoxes.get(0);
         ICheckBox checkBox2 = checkBoxes.get(1);
         boolean stateFirst = checkBox1.isChecked();
@@ -108,7 +108,7 @@ public void testCheckBoxJsActions() {
         navigate(TheInternetPage.CHECKBOXES);
         String checkboxLocator = "//input[@type='checkbox']";
         List<ICheckBox> checkBoxes = elementFactory.findElements(By.xpath(checkboxLocator), ICheckBox.class,
-                ElementsCount.MORE_THEN_ZERO, ElementState.DISPLAYED);
+                ElementsCount.MORE_THAN_ZERO, ElementState.DISPLAYED);
         ICheckBox checkBox1 = checkBoxes.get(0);
         ICheckBox checkBox2 = checkBoxes.get(1);
         boolean stateFirst = checkBox1.getJsActions().isChecked();
diff --git a/src/test/java/tests/integration/HiddenElementsTests.java b/src/test/java/tests/integration/HiddenElementsTests.java
@@ -47,14 +47,14 @@ public void testHiddenElementExist() {
 
     @Test(dataProvider = "getHiddenElementListProviders")
     public void testHiddenElementsExist(Function<ElementsCount, List<ILabel>> elementsListProvider) {
-        List<ILabel> listElements = elementsListProvider.apply(ElementsCount.MORE_THEN_ZERO);
+        List<ILabel> listElements = elementsListProvider.apply(ElementsCount.MORE_THAN_ZERO);
         Assert.assertFalse(listElements.isEmpty());
         Assert.assertTrue(listElements.stream().allMatch(el -> el.state().isExist()));
     }
 
     @Test(dataProvider = "getHiddenElementListProviders")
     public void testHiddenElementsNotDisplayed(Function<ElementsCount, List<ILabel>> elementsListProvider) {
-        List<ILabel> listElements = elementsListProvider.apply(ElementsCount.MORE_THEN_ZERO);
+        List<ILabel> listElements = elementsListProvider.apply(ElementsCount.MORE_THAN_ZERO);
         Assert.assertFalse(listElements.isEmpty());
         Assert.assertTrue(listElements.stream().noneMatch(el -> el.state().isDisplayed()));
     }
diff --git a/src/test/java/tests/usecases/VisualTests.java b/src/test/java/tests/usecases/VisualTests.java
@@ -0,0 +1,37 @@
+package tests.usecases;
+
+import org.testng.Assert;
+import org.testng.annotations.BeforeMethod;
+import org.testng.annotations.Test;
+import tests.BaseTest;
+import theinternet.forms.DynamicContentForm;
+
+public class VisualTests extends BaseTest {
+    private static final DynamicContentForm dynamicContentForm = new DynamicContentForm();
+
+    @BeforeMethod
+    @Override
+    protected void beforeMethod() {
+        getBrowser().goTo(dynamicContentForm.getUrl());
+        getBrowser().maximize();
+    }
+
+    @Test
+    public void shouldBePossibleToCheckVisualStateWhenItHasNotChanged()
+    {
+        Assert.assertTrue(dynamicContentForm.state().waitForDisplayed(), "Form is not opened");
+        dynamicContentForm.dump().save();
+        Assert.assertEquals(dynamicContentForm.dump().compare(), 0, "Form dump should remain the same");
+    }
+
+    @Test
+    public void shouldBePossibleToCheckVisualStateWhenItDiffers()
+    {
+        final String dumpName = "the differed dump";
+        Assert.assertTrue(dynamicContentForm.state().waitForDisplayed(), "Form is not opened");
+        dynamicContentForm.dump().save(dumpName);
+        getBrowser().refresh();
+        Assert.assertTrue(dynamicContentForm.state().waitForDisplayed(), "Form is not opened");
+        Assert.assertTrue(dynamicContentForm.dump().compare(dumpName) > 0, "After clicking on slider next button, the form dump should differ");
+    }
+}
diff --git a/src/test/resources/TestSuite.xml b/src/test/resources/TestSuite.xml
@@ -36,6 +36,7 @@
             <class name="tests.usecases.devtools.InitializationScriptsTests"/>
             <class name="tests.usecases.devtools.JavaScriptSnippetsTests"/>
             <class name="tests.usecases.devtools.JavaScriptEventTests"/>
+            <class name="tests.usecases.VisualTests"/>
         </classes>
     </test>
     <test name="Single-thread tests" parallel="none">
diff --git a/src/test/resources/settings.json b/src/test/resources/settings.json
@@ -119,5 +119,13 @@
   },
   "elementCache": {
     "isEnabled": false
+  },
+  "visualization": {
+    "imageExtension": "png",
+    "maxFullFileNameLength": 255,
+    "defaultThreshold": 0.012,
+    "comparisonWidth": 16,
+    "comparisonHeight": 16,
+    "pathToDumps": "./src/test/resources/visualDumps/"
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -42,6 +42,11 @@ private void setChromeArgs(ChromeOptions options) {`
`42`	`42`	`for (String arg : getBrowserStartArguments()) {`
`43`	`43`	`options.addArguments(arg);`
`44`	`44`	`}`
	`45`	`+ // workaround for Selenium issue https://github.com/SeleniumHQ/selenium/issues/11750`
	`46`	`+ final String allowOriginsArgument = "--remote-allow-origins=*";`
	`47`	`+ if (!getBrowserStartArguments().contains(allowOriginsArgument)) {`
	`48`	`+ options.addArguments(allowOriginsArgument);`
	`49`	`+ }`
`45`	`50`	`}`
`46`	`51`
`47`	`52`	`@Override`
Original file line number	Diff line number	Diff line change
`@@ -120,5 +120,13 @@`
`120`	`120`	`},`
`121`	`121`	`"elementCache": {`
`122`	`122`	`"isEnabled": false`
	`123`	`+ },`
	`124`	`+ "visualization": {`
	`125`	`+ "imageExtension": "png",`
	`126`	`+ "maxFullFileNameLength": 255,`
	`127`	`+ "defaultThreshold": 0.012,`
	`128`	`+ "comparisonWidth": 16,`
	`129`	`+ "comparisonHeight": 16,`
	`130`	`+ "pathToDumps": "./src/test/resources/visualDumps/"`
`123`	`131`	`}`
`124`	`132`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ public ProductListForm() {`
`25`	`25`	`}`
`26`	`26`
`27`	`27`	`public List<ILabel> getProductContainerLabels(){`
`28`		`- return getElementFactory().findElements(By.xpath(XPATH_PRODUCT_CONTAINER), ElementType.LABEL, ElementsCount.MORE_THEN_ZERO, ElementState.DISPLAYED);`
	`28`	`+ return getElementFactory().findElements(By.xpath(XPATH_PRODUCT_CONTAINER), ElementType.LABEL, ElementsCount.MORE_THAN_ZERO, ElementState.DISPLAYED);`
`29`	`29`	`}`
`30`	`30`
`31`	`31`	`private ILabel getLblFirstProduct(){`