- move js to separate file

- simplify getScreenshot method, remove debug logging
- add locator test

Author: mialeska

src/main/java/aquality/selenium/browser/JavaScript.java

@@ -22,6 +22,7 @@ public enum JavaScript {
     GET_COMBOBOX_SELECTED_TEXT("getCmbText.js"),
     GET_COMBOBOX_TEXTS("getCmbValues.js"),
     GET_ELEMENT_BY_XPATH("getElementByXpath.js"),
+    GET_ELEMENTS_FROM_POINT("getElementsFromPoint.js"),
     GET_ELEMENT_XPATH("getElementXPath.js"),
     GET_ELEMENT_TEXT("getElementText.js"),
     GET_TEXT_FIRST_CHILD("getTextFirstChild.js"),

src/main/java/aquality/selenium/elements/interfaces/ByImage.java

@@ -1,6 +1,7 @@
 package aquality.selenium.elements.interfaces;
 
 import aquality.selenium.browser.AqualityServices;
+import aquality.selenium.browser.JavaScript;
 import org.opencv.core.Point;
 import org.opencv.core.*;
 import org.opencv.imgcodecs.Imgcodecs;
@@ -97,7 +98,8 @@ protected WebElement getElementOnPoint(Point matchLocation, SearchContext contex
         int centerX = (int) (matchLocation.x + (template.width() / 2));
         int centerY = (int) (matchLocation.y + (template.height() / 2));
         //noinspection unchecked
-        List<WebElement> elements = (List<WebElement>) AqualityServices.getBrowser().executeScript("return document.elementsFromPoint(arguments[0], arguments[1]);", centerX, centerY);
+        List<WebElement> elements = (List<WebElement>) AqualityServices.getBrowser()
+                .executeScript(JavaScript.GET_ELEMENTS_FROM_POINT, centerX, centerY);
         elements.sort(Comparator.comparingDouble(e -> distanceToPoint(matchLocation, e)));
         return elements.get(0);
     }
@@ -121,16 +123,8 @@ protected static double distanceToPoint(Point matchLocation, WebElement element)
      * @return captured screenshot as byte array.
      */
     protected byte[] getScreenshot(SearchContext context) {
-        byte[] screenshotBytes;
-
-        if (!(context instanceof TakesScreenshot)) {
-            AqualityServices.getLogger().debug("Current search context doesn't support taking screenshots. " +
-                    "Will take browser screenshot instead");
-            screenshotBytes = AqualityServices.getBrowser().getScreenshot();
-        } else {
-            screenshotBytes = ((TakesScreenshot) context).getScreenshotAs(OutputType.BYTES);
-        }
-
-        return screenshotBytes;
+        return !(context instanceof TakesScreenshot)
+                ? AqualityServices.getBrowser().getScreenshot()
+                : ((TakesScreenshot) context).getScreenshotAs(OutputType.BYTES);
     }
 }

src/main/resources/js/getElementsFromPoint.js

@@ -0,0 +1 @@
+return document.elementsFromPoint(arguments[0], arguments[1]);

src/test/java/tests/integration/LocatorTests.java

@@ -1,16 +1,22 @@
 package tests.integration;
 
+import aquality.selenium.browser.AqualityServices;
+import aquality.selenium.elements.interfaces.ByImage;
 import aquality.selenium.elements.interfaces.ILabel;
 import automationpractice.forms.ChallengingDomForm;
 import org.openqa.selenium.By;
 import org.openqa.selenium.WebElement;
 import org.openqa.selenium.support.locators.RelativeLocator;
+import org.testng.Assert;
 import org.testng.annotations.BeforeMethod;
 import org.testng.annotations.Test;
 import org.testng.asserts.SoftAssert;
 import tests.BaseTest;
 import theinternet.TheInternetPage;
+import theinternet.forms.BrokenImagesForm;
+
 import java.util.List;
+
 import static aquality.selenium.locators.RelativeBySupplier.with;
 
 public class LocatorTests extends BaseTest {
@@ -26,6 +32,22 @@ public void beforeMethod() {
         navigate(TheInternetPage.CHALLENGING_DOM);
     }
 
+    @Test
+    public void testByImageLocator() {
+        BrokenImagesForm form = new BrokenImagesForm();
+        Assert.assertFalse(form.getLabelByImage().state().isDisplayed(), "Should be impossible to find element on page by image when it is absent");
+        getBrowser().goTo(form.getUrl());
+        Assert.assertTrue(form.getLabelByImage().state().isDisplayed(), "Should be possible to find element on page by image");
+
+        List<ILabel> childLabels = form.getChildLabelsByImage();
+        List<ILabel> docLabels = form.getLabelsByImage();
+        Assert.assertTrue(docLabels.size() > 1, "List of elements should be possible to find by image");
+        Assert.assertEquals(docLabels.size(), childLabels.size(), "Should be possible to find child elements by image with the same count");
+
+        ILabel screen = AqualityServices.getElementFactory().getLabel(new ByImage(AqualityServices.getBrowser().getScreenshot()), "full screen");
+        Assert.assertTrue(screen.state().waitForDisplayed(), "Should be possible to find element by full page screenshot");
+    }
+
     @Test
     public void testAboveLocatorWithDifferentAboveParametersType() {
         ILabel cellInRow5Column5 = challengingDomForm.getCellInRow5Column5();

src/test/java/theinternet/forms/BrokenImagesForm.java

@@ -0,0 +1,33 @@
+package theinternet.forms;
+
+import aquality.selenium.elements.interfaces.ByImage;
+import aquality.selenium.elements.interfaces.ILabel;
+import org.openqa.selenium.By;
+import utils.FileUtil;
+
+import java.util.List;
+
+public class BrokenImagesForm extends TheInternetForm {
+    private final By imageLocator = new ByImage(FileUtil.getResourceFileByName("brokenImage.png"));
+
+    public BrokenImagesForm(){
+        super(By.id("content"), "Broken Images form");
+    }
+
+    public ILabel getLabelByImage(){
+        return getElementFactory().getLabel(imageLocator, "broken image");
+    }
+
+    public List<ILabel> getLabelsByImage(){
+        return getElementFactory().findElements(imageLocator, "broken image", ILabel.class);
+    }
+
+    public List<ILabel> getChildLabelsByImage(){
+        return getFormLabel().findChildElements(imageLocator, "broken image", ILabel.class);
+    }
+
+    @Override
+    protected String getUri() {
+        return "/broken_images";
+    }
+}