Add possibility to change the threshold for one ByImage locator, with border value check

Author: mialeska

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

@@ -25,6 +25,7 @@ public class ByImage extends By {
     private static boolean wasLibraryLoaded = false;
     private final Mat template;
     private final String description;
+    private float threshold = 1 - AqualityServices.getConfiguration().getVisualizationConfiguration().getDefaultThreshold();
 
     private static void loadLibrary() {
         if (!wasLibraryLoaded) {
@@ -56,6 +57,27 @@ public ByImage(byte[] bytes) {
         this.template = Imgcodecs.imdecode(new MatOfByte(bytes), Imgcodecs.IMREAD_UNCHANGED);
     }
 
+    /**
+     * Sets threshold of image similarity.
+     * @param threshold a float between 0 and 1, where 1 means 100% match, and 0.5 means 50% match.
+     * @return current instance of ByImage locator.
+     */
+    public ByImage setThreshold(float threshold) {
+        if (threshold < 0 || threshold > 1) {
+            throw new IllegalArgumentException("Threshold must be a float between 0 and 1.");
+        }
+        this.threshold = threshold;
+        return this;
+    }
+
+    /**
+     * Gets threshold of image similarity.
+     * @return current value of threshold.
+     */
+    public float getThreshold() {
+        return threshold;
+    }
+
     @Override
     public String toString() {
         return String.format("ByImage: %s, size: (width:%d, height:%d)", description, template.width(), template.height());
@@ -84,7 +106,6 @@ public List<WebElement> findElements(SearchContext context) {
         Mat result = new Mat();
         Imgproc.matchTemplate(source, template, result, Imgproc.TM_CCOEFF_NORMED);
 
-        float threshold = 1 - AqualityServices.getConfiguration().getVisualizationConfiguration().getDefaultThreshold();
         Core.MinMaxLocResult minMaxLoc = Core.minMaxLoc(result);
 
         int matchCounter = Math.abs((result.width() - template.width() + 1) * (result.height() - template.height() + 1));

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

@@ -47,9 +47,11 @@ public void testByImageLocator() {
         Assert.assertEquals(docLabels.size(), childLabels.size(), "Should be possible to find child elements by image with the same count");
 
         ILabel documentByTag = AqualityServices.getElementFactory().getLabel(By.tagName("body"), "document by tag");
-        ILabel documentByImage = AqualityServices.getElementFactory().getLabel(new ByImage(documentByTag.getElement().getScreenshotAs(OutputType.BYTES)),
+        float fullThreshold = 1;
+        ILabel documentByImage = AqualityServices.getElementFactory().getLabel(new ByImage(documentByTag.getElement().getScreenshotAs(OutputType.BYTES)).setThreshold(fullThreshold),
                 "body screen");
         Assert.assertTrue(documentByImage.state().isDisplayed(), "Should be possible to find element by document screenshot");
+        Assert.assertEquals(((ByImage)documentByImage.getLocator()).getThreshold(), fullThreshold, "Should be possible to get ByImage threshold");
         Assert.assertEquals(documentByImage.getElement().getTagName(), "body", "Correct element must be found");
     }