Add option to test only specific region of PDF(s)/Image(s)

Author: valandi

README.md

@@ -123,6 +123,9 @@ The tool build in java and requires minimal set of parameters the minimal comman
       **Example:** `-arg "300,300,500,100|500,500,200,200"` will create accessibility graphics regions at <br>
       + x:300, y:300, with width:500, height:100 and <br>
       + x:500, y:500, with width:200, height:200 <br>
+    + `-rc` - Capture only a particular region of PDFs/Images. <br>
+      **Example:** `-rc "200,500,1000,1000"` instructs ImageTester to only test region with: <br>
+      + x:200, y:500, with width:1000, height:1000
 
 ### Using The Batch Mapper
 The Batch Mapper is a feature that allows you to specify tests from a CSV instead of supplying a path or file in the traditional way.

pom.xml

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

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

@@ -114,6 +114,7 @@ public static void main(String[] args) {
             config.setAccessibilityLargeTextRegions(cmd.getOptionValue("arl", null));
             config.setAccessibilityBoldTextRegions(cmd.getOptionValue("arb", null));
             config.setAccessibilityGraphicsRegions(cmd.getOptionValue("arg", null));
+            config.setCaptureRegion(cmd.getOptionValue("rc", null));
 
             // Full page for ac regions capability
             if (cmd.hasOption("arr") && config.accessibilityRegularTextRegions == null) {
@@ -217,6 +218,7 @@ private static void runTestWithBatchMapper(final Logger logger, final CommandLin
                 currentConfiguration.setBatchInfo(cmd.getOptionValue("fb", null), cmd.hasOption("nc"));
                 currentConfiguration.dontCloseBatches = cmd.hasOption("dcb");
                 currentConfiguration.shouldThrowException = cmd.hasOption("te");
+                currentConfiguration.setCaptureRegion(cmd.getOptionValue("rc", null));
 
                 try {
                     File root = new File(currentBatch.filePath);
@@ -502,6 +504,12 @@ private static Options getOptions() {
                 .hasArgs()
                 .optionalArg(true)
                 .build());
+        options.addOption(Option.builder("rc")
+                .longOpt("regionCapture")
+                .desc("Tests specific region of images and PDFs.\nexample: `-rc 0,200,1000,1000`")
+                .hasArgs()
+                .optionalArg(false)
+                .build());
 
         EyesUtilitiesConfig.injectOptions(options);
         return options;

src/main/java/com/applitools/imagetester/TestObjects/ImagesCheckSettingsFactory.java

@@ -20,7 +20,9 @@ public ImagesCheckSettingsFactory(BufferedImage image, Config config) {
         this.config = config;
     }
     public ImagesCheckSettingsFactory(BufferedImage image, Config config, RectangleSize viewport) {
-        this.imagesCheckSettings = new ImagesCheckSettings(image);
+        this.imagesCheckSettings = config.captureRegion == null ?
+                new ImagesCheckSettings(image) :
+                new ImagesCheckSettings(image, config.captureRegion);
         this.config = config;
         this.viewPortRegion = new Region(0, 0, viewport.getWidth(), viewport.getHeight());
     }

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

@@ -49,6 +49,7 @@ public class Config {
     public boolean accessibilityLargeTextFullPage = false;
     public boolean accessibilityBoldTextFullPage = false;
     public boolean accessibilityGraphicsFullPage = false;
+    public Region captureRegion;
 
     public void setViewport(String viewport) {
         if (viewport == null) return;
@@ -60,6 +61,19 @@ public void setViewport(String viewport) {
                 Integer.parseInt(dims[1]));
     }
 
+    public void setCaptureRegion(String captureRegionSpecs) {
+        if (captureRegionSpecs == null) return;
+        String[] regionSpecs = captureRegionSpecs.split(",");
+        if (regionSpecs.length != 4)
+            throw new RuntimeException("Invalid region capture values, make sure the call is -rc <left>,<top>,<width>,<height>");
+        this.captureRegion = new Region(
+                Integer.parseInt(regionSpecs[0]),
+                Integer.parseInt(regionSpecs[1]),
+                Integer.parseInt(regionSpecs[2]),
+                Integer.parseInt(regionSpecs[3])
+        );
+    }
+
     public void setProxy(String[] proxy) {
         if (proxy != null && proxy.length > 0)
             if (proxy.length == 1) {