Support for Accessibility Regions

calbert-hall · Casey Albert-Hall · web-flow · commit d635b9e38794 · 2022-10-26T12:41:51.000-04:00
Add accessibility regions to ImageTester options. 

Co-authored-by: Casey Albert-Hall &lt;casey@Caseys-MacBook-Pro.local&gt;
diff --git a/.DS_Store b/.DS_Store
diff --git a/.gitignore b/.gitignore
@@ -7,4 +7,5 @@ Artifacts/
 debug/
 src/test/java/Private/
 TestData/Private/
-output
+output
+dependency-reduced-pom.xml
diff --git a/README.md b/README.md
@@ -103,6 +103,26 @@ The tool build in java and requires minimal set of parameters the minimal comman
       **Example:** `-ir "300,300,500,100|500,500,200,200"` will create layout regions at <br>
       + x:300, y:300, with width:500, height:100 and <br>
       + x:500, y:500, with width:200, height:200 <br>
+    + `-ari` - Accessibility ignore regions will be applied to all pages. <br>
+      **Example:** `-ari "300,300,500,100|500,500,200,200"` will create accessibility ignore regions at <br>
+        + x:300, y:300, with width:500, height:100 and <br>
+        + x:500, y:500, with width:200, height:200 <br>
+    + `-arr` - Accessibility regular text regions will be applied to all pages. Without coordinates, region will be the viewport size. <br>
+      **Example:** `-arr "300,300,500,100|500,500,200,200"` will create accessibility regular text regions at <br>
+      + x:300, y:300, with width:500, height:100 and <br>
+      + x:500, y:500, with width:200, height:200 <br>
+    + `-arl` - Accessibility large text regions will be applied to all pages. Without coordinates, region will be the viewport size. <br>
+      **Example:** `-arl "300,300,500,100|500,500,200,200"` will create accessibility large text regions at <br>
+      + x:300, y:300, with width:500, height:100 and <br>
+      + x:500, y:500, with width:200, height:200 <br>
+    + `-arb` - Accessibility bold text regions will be applied to all pages. Without coordinates, region will be the viewport size. <br>
+      **Example:** `-arb "300,300,500,100|500,500,200,200"` will create accessibility bold text regions at <br>
+      + x:300, y:300, with width:500, height:100 and <br>
+      + x:500, y:500, with width:200, height:200 <br>
+    + `-arg` - Accessibility graphic regions will be applied to all pages. Without coordinates, region will be the viewport size. <br>
+      **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>
 
 ### 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.
diff --git a/dependency-reduced-pom.xml b/dependency-reduced-pom.xml
diff --git a/src/main/java/META-INF/MANIFEST.MF b/src/main/java/META-INF/MANIFEST.MF
@@ -1,3 +1,4 @@
 Manifest-Version: 1.0
 Main-Class: com.yanirta.ImageTester
 Implementation-Version: 3.0.4
+
diff --git a/src/main/java/com/yanirta/BatchObjects/PDFFileBatch.java b/src/main/java/com/yanirta/BatchObjects/PDFFileBatch.java
@@ -1,6 +1,8 @@
 package com.yanirta.BatchObjects;
 
+import com.applitools.eyes.images.ImagesCheckSettings;
 import com.yanirta.TestObjects.IDisposable;
+import com.yanirta.TestObjects.ImagesCheckSettingsFactory;
 import com.yanirta.TestObjects.TestBase;
 import com.applitools.eyes.BatchInfo;
 import com.applitools.eyes.TestResults;
@@ -39,7 +41,7 @@ public TestResults run(Eyes eyes) throws Exception {
             BufferedImage bim = safeRender();
             if (!eyes.getIsOpen())
                 eyes.open(appName(), name(), viewport(bim));
-            eyes.checkImage(bim, name());
+            eyes.check(name(), new ImagesCheckSettingsFactory(bim, config(), viewport(bim)).create());
             return eyes.close(false);
         }
 
diff --git a/src/main/java/com/yanirta/ImageTester.java b/src/main/java/com/yanirta/ImageTester.java
@@ -104,6 +104,25 @@ public static void main(String[] args) {
             config.setIgnoreRegions(cmd.getOptionValue("ir", null));
             config.setContentRegions(cmd.getOptionValue("cr", null));
             config.setLayoutRegions(cmd.getOptionValue("lr", null));
+            config.setAccessibilityIgnoreRegions(cmd.getOptionValue("ari", null));
+            config.setAccessibilityRegularTextRegions(cmd.getOptionValue("arr", null));
+            config.setAccessibilityLargeTextRegions(cmd.getOptionValue("arl", null));
+            config.setAccessibilityBoldTextRegions(cmd.getOptionValue("arb", null));
+            config.setAccessibilityGraphicsRegions(cmd.getOptionValue("arg", null));
+
+            // Full page for ac regions capability
+            if (cmd.hasOption("arr") && config.accessibilityRegularTextRegions == null) {
+                config.accessibilityRegularTextFullPage = true;
+            }
+            if (cmd.hasOption("arl") && config.accessibilityLargeTextRegions == null) {
+                config.accessibilityLargeTextFullPage = true;
+            }
+            if (cmd.hasOption("arb") && config.accessibilityBoldTextRegions == null) {
+                config.accessibilityBoldTextFullPage = true;
+            }
+            if (cmd.hasOption("arg") && config.accessibilityGraphicsRegions== null) {
+                config.accessibilityGraphicsFullPage = true;
+            }
 
             File root = new File(cmd.getOptionValue("f", "."));
 
@@ -442,6 +461,36 @@ private static Options getOptions() {
                 .longOpt("throwExceptions")
                 .desc("Throw exceptions on test failure")
                 .build());
+        options.addOption(Option.builder("ari")
+                .longOpt("accessibility region: ignore")
+                .desc("Parameters for accessibility ignore regions [x, y, width, height]")
+                .hasArgs()
+                .optionalArg(true)
+                .build());
+        options.addOption(Option.builder("arr")
+                .longOpt("accessibility region: regular text")
+                .desc("Parameters for accessibility regular text regions [x, y, width, height]")
+                .hasArgs()
+                .optionalArg(true)
+                .build());
+        options.addOption(Option.builder("arl")
+                .longOpt("accessibility region: large text")
+                .desc("Parameters for accessibility large text regions [x, y, width, height]")
+                .hasArgs()
+                .optionalArg(true)
+                .build());
+        options.addOption(Option.builder("arb")
+                .longOpt("accessibility region: bold text")
+                .desc("Parameters for accessibility bold text regions [x, y, width, height]")
+                .hasArgs()
+                .optionalArg(true)
+                .build());
+        options.addOption(Option.builder("arg")
+                .longOpt("accessibility region: graphic")
+                .desc("Parameters for accessibility graphics regions [x, y, width, height]")
+                .hasArgs()
+                .optionalArg(true)
+                .build());
 
         EyesUtilitiesConfig.injectOptions(options);
         return options;
diff --git a/src/main/java/com/yanirta/TestObjects/BatchMappedPdfFileTest.java b/src/main/java/com/yanirta/TestObjects/BatchMappedPdfFileTest.java
@@ -30,7 +30,7 @@ public TestResults run(Eyes eyes) throws Exception {
                         eyes.open(appName(), name(), viewport(bim));
                     eyes.check(
                             String.format("Page-%s", name()),
-                            new ImagesCheckSettingsFactory(bim, config()).create()
+                            new ImagesCheckSettingsFactory(bim, config(), viewport(bim)).create()
                     );
                     bim.getGraphics().dispose();
                     bim.flush();
diff --git a/src/main/java/com/yanirta/TestObjects/FolderTest.java b/src/main/java/com/yanirta/TestObjects/FolderTest.java
@@ -33,7 +33,7 @@ public TestResults run(Eyes eyes) throws Exception {
                 if (!eyes.getIsOpen()) eyes.open(appName(), name(), viewport(image));
                 eyes.check(
                 		img.getName(),
-                        new ImagesCheckSettingsFactory(image, config()).create()
+                        new ImagesCheckSettingsFactory(image, config(), viewport(image)).create()
                 );
                 image = null;
             } catch (IOException e) {
diff --git a/src/main/java/com/yanirta/TestObjects/ImageFileTest.java b/src/main/java/com/yanirta/TestObjects/ImageFileTest.java
@@ -18,7 +18,7 @@ public TestResults run(Eyes eyes) throws Exception {
         eyes.open(appName(), name(), viewport(image));
         eyes.check(
                 file().getName(),
-                new ImagesCheckSettingsFactory(image, config()).create()
+                new ImagesCheckSettingsFactory(image, config(), viewport(image)).create()
         );
         image = null;
         return eyes.close(false);
diff --git a/src/main/java/com/yanirta/TestObjects/ImagesCheckSettingsFactory.java b/src/main/java/com/yanirta/TestObjects/ImagesCheckSettingsFactory.java
@@ -1,20 +1,29 @@
 package com.yanirta.TestObjects;
 
 import com.applitools.ICheckSettings;
+import com.applitools.eyes.AccessibilityRegionType;
+import com.applitools.eyes.RectangleSize;
+import com.applitools.eyes.Region;
 import com.applitools.eyes.images.ImagesCheckSettings;
 import com.yanirta.lib.Config;
 
 import java.awt.image.BufferedImage;
 
 public class ImagesCheckSettingsFactory {
 
+    private Region viewPortRegion;
     private ICheckSettings imagesCheckSettings;
     private final Config config;
 
     public ImagesCheckSettingsFactory(BufferedImage image, Config config) {
         this.imagesCheckSettings = new ImagesCheckSettings(image);
         this.config = config;
     }
+    public ImagesCheckSettingsFactory(BufferedImage image, Config config, RectangleSize viewport) {
+        this.imagesCheckSettings = new ImagesCheckSettings(image);
+        this.config = config;
+        this.viewPortRegion = new Region(0, 0, viewport.getWidth(), viewport.getHeight());
+    }
 
     public ICheckSettings create() {
         if (config.layoutRegions != null) {
@@ -26,6 +35,47 @@ public ICheckSettings create() {
         if (config.contentRegions != null) {
             this.imagesCheckSettings = this.imagesCheckSettings.content(config.contentRegions);
         }
+
+        if (config.accessibilityRegularTextFullPage) {
+            this.imagesCheckSettings = this.imagesCheckSettings.accessibility(viewPortRegion, AccessibilityRegionType.RegularText);
+        }
+        if (config.accessibilityLargeTextFullPage) {
+            this.imagesCheckSettings = this.imagesCheckSettings.accessibility(viewPortRegion, AccessibilityRegionType.LargeText);
+        }
+        if (config.accessibilityBoldTextFullPage) {
+            this.imagesCheckSettings = this.imagesCheckSettings.accessibility(viewPortRegion, AccessibilityRegionType.BoldText);
+        }
+        if (config.accessibilityGraphicsFullPage) {
+            this.imagesCheckSettings = this.imagesCheckSettings.accessibility(viewPortRegion, AccessibilityRegionType.GraphicalObject);
+        }
+
+        if (config.accessibilityIgnoreRegions != null) {
+            // We have to loop because Eyes Images doesn't support Regions array
+            for (Region acRegion : config.accessibilityIgnoreRegions ) {
+                this.imagesCheckSettings = this.imagesCheckSettings.accessibility(acRegion, AccessibilityRegionType.IgnoreContrast);
+            }
+        }
+        if (config.accessibilityRegularTextRegions != null) {
+            for (Region acRegion: config.accessibilityRegularTextRegions) {
+                this.imagesCheckSettings = this.imagesCheckSettings.accessibility(acRegion, AccessibilityRegionType.RegularText);
+            }
+        }
+        if (config.accessibilityLargeTextRegions != null) {
+            for (Region acRegion : config.accessibilityLargeTextRegions) {
+                this.imagesCheckSettings = this.imagesCheckSettings.accessibility(acRegion, AccessibilityRegionType.LargeText);
+            }
+        }
+        if (config.accessibilityBoldTextRegions != null) {
+            for (Region acRegion : config.accessibilityBoldTextRegions) {
+                this.imagesCheckSettings = this.imagesCheckSettings.accessibility(acRegion, AccessibilityRegionType.BoldText);
+            }
+        }
+        if (config.accessibilityGraphicsRegions != null) {
+            for (Region acRegion : config.accessibilityGraphicsRegions) {
+                this.imagesCheckSettings = this.imagesCheckSettings.accessibility(acRegion, AccessibilityRegionType.GraphicalObject);
+            }
+        }
+
         return imagesCheckSettings;
     }
  }
diff --git a/src/main/java/com/yanirta/TestObjects/PdfFileTest.java b/src/main/java/com/yanirta/TestObjects/PdfFileTest.java
@@ -39,7 +39,7 @@ public TestResults run(Eyes eyes) throws Exception {
                         eyes.open(appName(), name(), viewport(bim));
                     eyes.check(
                             String.format("Page-%s", page),
-                            new ImagesCheckSettingsFactory(bim, config()).create()
+                            new ImagesCheckSettingsFactory(bim, config(), viewport(bim)).create()
                     );
                     bim.getGraphics().dispose();
                     bim.flush();
diff --git a/src/main/java/com/yanirta/lib/Config.java b/src/main/java/com/yanirta/lib/Config.java
@@ -39,6 +39,15 @@ public class Config {
     public Region[] contentRegions = null;
     public boolean shouldThrowException = false;
     private final HashSet<String> batchesIdListForBatchClose = new HashSet<>();
+    public Region[] accessibilityIgnoreRegions = null;
+    public Region[] accessibilityRegularTextRegions = null;
+    public Region[] accessibilityLargeTextRegions = null;
+    public Region[] accessibilityBoldTextRegions = null;
+    public Region[] accessibilityGraphicsRegions = null;
+    public boolean accessibilityRegularTextFullPage = false;
+    public boolean accessibilityLargeTextFullPage = false;
+    public boolean accessibilityBoldTextFullPage = false;
+    public boolean accessibilityGraphicsFullPage = false;
 
     public void setViewport(String viewport) {
         if (viewport == null) return;
@@ -146,7 +155,7 @@ public void setContentRegions(String contentRegionsOption) {
         if (contentRegionsOption != null) {
             try{
                 this.contentRegions = generateRegionsArray(contentRegionsOption);
-            } catch(ArrayIndexOutOfBoundsException e) {
+            } catch (ArrayIndexOutOfBoundsException e) {
                 logger.printMessage("Error parsing parameters for content regions. " +
                         "Please ensure that the content regions are in the format x,y,width,height|x,y,width,height...");
             }
@@ -157,10 +166,62 @@ public void setLayoutRegions(String layoutRegionsOption) {
         if (layoutRegionsOption != null) {
             try {
                 this.layoutRegions = generateRegionsArray(layoutRegionsOption);
-            } catch(ArrayIndexOutOfBoundsException e) {
+            } catch (ArrayIndexOutOfBoundsException e) {
                 logger.printMessage("Error parsing parameters for layout regions. " +
                         "Please ensure that the layout regions are in the format x,y,width,height|x,y,width,height...");
             }
         }
     }
+
+    public void setAccessibilityIgnoreRegions(String accessibilityIgnoreRegions) {
+        if (accessibilityIgnoreRegions != null) {
+            try {
+                this.accessibilityIgnoreRegions = generateRegionsArray(accessibilityIgnoreRegions);
+            } catch (ArrayIndexOutOfBoundsException e) {
+                logger.printMessage("Error parsing parameters for accessibility ignore regions. " +
+                        "Please ensure that the layout regions are in the format x,y,width,height|x,y,width,height...");
+            }
+        }
+    }
+    public void setAccessibilityRegularTextRegions(String accessibilityRegularTextRegions) {
+        if (accessibilityRegularTextRegions != null) {
+            try {
+                this.accessibilityRegularTextRegions = generateRegionsArray(accessibilityRegularTextRegions);
+            } catch (ArrayIndexOutOfBoundsException e) {
+                logger.printMessage("Error parsing parameters for accessibility regular text regions. " +
+                        "Please ensure that the layout regions are in the format x,y,width,height|x,y,width,height...");
+            }
+        }
+    }
+
+    public void setAccessibilityLargeTextRegions(String accessibilityLargeTextRegions) {
+        if (accessibilityLargeTextRegions != null) {
+            try {
+                this.accessibilityLargeTextRegions = generateRegionsArray(accessibilityLargeTextRegions);
+            } catch (ArrayIndexOutOfBoundsException e) {
+                logger.printMessage("Error parsing parameters for accessibility large text regions. " +
+                        "Please ensure that the layout regions are in the format x,y,width,height|x,y,width,height...");
+            }
+        }
+    }
+    public void setAccessibilityBoldTextRegions(String accessibilityBoldTextRegions) {
+        if (accessibilityBoldTextRegions != null) {
+            try {
+                this.accessibilityBoldTextRegions = generateRegionsArray(accessibilityBoldTextRegions);
+            } catch (ArrayIndexOutOfBoundsException e) {
+                logger.printMessage("Error parsing parameters for accessibility bold text regions. " +
+                        "Please ensure that the layout regions are in the format x,y,width,height|x,y,width,height...");
+            }
+        }
+    }
+    public void setAccessibilityGraphicsRegions(String accessibilityGraphicsRegions) {
+        if (accessibilityGraphicsRegions != null) {
+            try {
+                this.accessibilityGraphicsRegions = generateRegionsArray(accessibilityGraphicsRegions);
+            } catch (ArrayIndexOutOfBoundsException e) {
+                logger.printMessage("Error parsing parameters for accessibility graphics regions. " +
+                        "Please ensure that the layout regions are in the format x,y,width,height|x,y,width,height...");
+            }
+        }
+    }
 }
diff --git a/src/main/java/com/yanirta/lib/Logger.java b/src/main/java/com/yanirta/lib/Logger.java
diff --git a/src/test/java/Tests/TestFullCommands.java b/src/test/java/Tests/TestFullCommands.java
