Add match timeout option

Author: valandi

README.md

@@ -86,11 +86,12 @@ The tool build in java and requires minimal set of parameters the minimal comman
     + `-id` - Ignore displacement of shifting elements.
     + `-pn` - Prompt new tests, new tests will not be saved automatically, the user will have to review and save manually.
     + `-dv` - Disable SSL certificate validation. !!!Unsecured!!!
-    + `-lo` - Use legacy files order to comply with baselines that were created with versions below 2.0
+    + `-lo` - Use legacy files order complying with baselines that were created with versions below 2.0
     + `-ac [Level:GuidelineVer]` - Set accessibility validation and optionally it's arguments split by semicolons ':' default: "AA:WCAG_2_0", available options: [AA|AAA:WCAG_2_0|WCAG_2_1]
     + `-dcb` - ImageTester will not automatically close batch(es) when test is complete.
     + `-mp` - ImageTester will read from and execute tests based on the batch mapper CSV.
     + `-te` - ImageTester will throw an exception if Eyes detects a mismatch or failure. <br>
+    + `-mt` - Sets match timeout and retry timeout (default=500). <br> 
     + `-ir` - Ignore regions will be applied to all pages. <br>
       **Example:** `-ir "300,300,500,100|500,500,200,200"` will create ignored regions at <br> 
       + x:300, y:300, with width:500, height:100 and <br>

pom.xml

@@ -4,7 +4,7 @@
 
 	<groupId>com.applitools.imagetester</groupId>
 	<artifactId>ImageTester</artifactId>
-	<version>3.2.0</version>
+	<version>3.2.1</version>
 	<packaging>jar</packaging>
 	<properties>
 		<maven.compiler.source>1.8</maven.compiler.source>

src/main/java/com/applitools/imagetester/ImageTester.java

@@ -115,6 +115,7 @@ public static void main(String[] args) {
             config.setAccessibilityBoldTextRegions(cmd.getOptionValue("arb", null));
             config.setAccessibilityGraphicsRegions(cmd.getOptionValue("arg", null));
             config.setCaptureRegion(cmd.getOptionValue("rc", null));
+            config.setMatchTimeout(cmd.getOptionValue("mt", null));
 
             // Full page for ac regions capability
             if (cmd.hasOption("arr") && config.accessibilityRegularTextRegions == null) {
@@ -219,6 +220,7 @@ private static void runTestWithBatchMapper(final Logger logger, final CommandLin
                 currentConfiguration.dontCloseBatches = cmd.hasOption("dcb");
                 currentConfiguration.shouldThrowException = cmd.hasOption("te");
                 currentConfiguration.setCaptureRegion(cmd.getOptionValue("rc", null));
+                currentConfiguration.setMatchTimeout(cmd.getOptionValue("mt", null));
 
                 try {
                     File root = new File(currentBatch.filePath);
@@ -510,6 +512,13 @@ private static Options getOptions() {
                 .hasArgs()
                 .optionalArg(false)
                 .build());
+        options.addOption(Option.builder("mt")
+                .longOpt("matchTimeout")
+                .desc("Set value for match timeout and retry timeout in ms(minimum 500).\nexample: `-mt 2000`")
+                .hasArgs()
+                .optionalArg(false)
+                .build());
+
 
         EyesUtilitiesConfig.injectOptions(options);
         return options;

src/main/java/com/applitools/imagetester/lib/Config.java

@@ -50,6 +50,7 @@ public class Config {
     public boolean accessibilityBoldTextFullPage = false;
     public boolean accessibilityGraphicsFullPage = false;
     public Region captureRegion;
+    public String matchTimeout;
 
     public void setViewport(String viewport) {
         if (viewport == null) return;
@@ -239,4 +240,12 @@ public void setAccessibilityGraphicsRegions(String accessibilityGraphicsRegions)
             }
         }
     }
+
+    public void setMatchTimeout(String matchTimeout) {
+        this.matchTimeout = matchTimeout;
+    }
+
+    public String getMatchTimeout() {
+        return this.matchTimeout;
+    }
 }

src/main/java/com/applitools/imagetester/lib/TestExecutor.java

@@ -31,6 +31,7 @@ public void enqueue(TestBase test, BatchInfo overrideBatch) {
             Eyes eyes = thEyes_.get();
             //set batch
             setBatch(eyes, overrideBatch, config_);
+            setTimeout(eyes, config_);
             TestResults result = test.runSafe(eyes);
             eyes.abortIfNotClosed();
 
@@ -98,4 +99,12 @@ public void setBatch(Eyes eyes, BatchInfo overrideBatch, Config config) {
         if (config_.sequenceName != null && !StringUtils.isEmpty(config_.sequenceName))
             eyes.getBatch().setSequenceName(config_.sequenceName);
     }
+
+    //set eyes correct batch
+    public void setTimeout(Eyes eyes, Config config) {
+        if (config.getMatchTimeout() != null) {
+            int matchTimeoutValue = Integer.parseInt(config.getMatchTimeout());
+            if (matchTimeoutValue >= 500) eyes.setMatchTimeout(matchTimeoutValue);
+        }
+    }
 }