Add properties argument (-pr)

Author: valandi

README.md

@@ -136,6 +136,12 @@ The tool build in java and requires minimal set of parameters the minimal comman
     + `-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
+    + `-pr` - Add properties to Eyes tests. Format is `key1:value1|key2:value2`.<br> 
+      Each property will have the format "key1:value1", and each subsequent format will be separated by a "|" character. <br>
+      **Example:** `-pr "prop1:value1|prop2:value2|prop3:value3"` will add properties: <br>
+      + prop1, value1
+      + prop2, value2
+      + prop3, value3
 
 ### 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.5.7</version>
+	<version>3.6.0</version>
 	<packaging>jar</packaging>
 	<properties>
 		<maven.compiler.source>1.8</maven.compiler.source>
@@ -19,26 +19,6 @@
 	</repositories>
 
 	<dependencies>
-		<dependency>
-			<groupId>com.applitools</groupId>
-			<artifactId>eyes-universal-core-win</artifactId>
-			<version>RELEASE</version>
-		</dependency>
-		<dependency>
-			<groupId>com.applitools</groupId>
-			<artifactId>eyes-universal-core-mac</artifactId>
-			<version>RELEASE</version>
-		</dependency>
-		<dependency>
-			<groupId>com.applitools</groupId>
-			<artifactId>eyes-universal-core-linux</artifactId>
-			<version>RELEASE</version>
-		</dependency>
-		<dependency>
-			<groupId>com.applitools</groupId>
-			<artifactId>eyes-universal-core-alpine</artifactId>
-			<version>RELEASE</version>
-		</dependency>
 		<dependency>
 			<groupId>com.applitools</groupId>
 			<artifactId>eyes-universal-core-arm</artifactId>

src/main/java/META-INF/MANIFEST.MF

@@ -1,4 +1,4 @@
 Manifest-Version: 1.0
 Main-Class: com.applitools.imagetester.ImageTester
-Implementation-Version: 3.5.7
+Implementation-Version: 3.6.0
 

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

@@ -26,7 +26,7 @@
 import com.applitools.imagetester.lib.Utils;
 
 public class ImageTester {
-    private static final String cur_ver = "3.5.7";
+    private static final String cur_ver = "3.6.0";
 
     public static void main(String[] args) {
 
@@ -119,6 +119,7 @@ public static void main(String[] args) {
             config.setAccessibilityGraphicsRegions(cmd.getOptionValue("arg", null));
             config.setCaptureRegion(cmd.getOptionValue("rc", null));
             config.setMatchTimeout(cmd.getOptionValue("mt", null));
+            config.setProperties(cmd.getOptionValue("pr", null));
 
             // Full page for ac regions capability
             if (cmd.hasOption("arr") && config.accessibilityRegularTextRegions == null) {
@@ -242,6 +243,7 @@ private static void runTestWithBatchMapper(final Logger logger, final CommandLin
                 currentConfiguration.shouldThrowException = cmd.hasOption("te");
                 currentConfiguration.setCaptureRegion(cmd.getOptionValue("rc", null));
                 currentConfiguration.setMatchTimeout(cmd.getOptionValue("mt", null));
+                currentConfiguration.setProperties(cmd.getOptionValue("pr", null));
 
                 // Full page for ac regions capability
                 if (cmd.hasOption("arr") && currentConfiguration.accessibilityRegularTextRegions == null) {
@@ -578,6 +580,11 @@ private static Options getOptions() {
             .hasArg()
             .argName("deviceNameArg")
             .build());
+        options.addOption(Option.builder("pr")
+            .longOpt("properties")
+            .desc("Eyes Properties")
+            .hasArgs()
+            .build());
 
 
         EyesUtilitiesConfig.injectOptions(options);

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

@@ -59,6 +59,9 @@ public String name() {
 
     public TestResults runSafe(Eyes eyes) {
         try {
+            for(int i = 0; i < conf_.properties.length; i++) {
+                eyes.addProperty(conf_.properties[i][0], conf_.properties[i][1]);
+            }
             eyes.addProperty(FILE_NAME_PROP, file_.getName());
             TestResults res = run(eyes);
             Utils.handleResultsDownload(conf_.eyesUtilsConf, res);

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

@@ -54,6 +54,7 @@ public class Config {
     public String matchTimeout;
     public String deviceName;
     public String regexFileNameFilter;
+    public String[][] properties = null;
 
     public void setViewport(String viewport) {
         if (viewport == null) return;
@@ -242,6 +243,20 @@ public void setAccessibilityGraphicsRegions(String accessibilityGraphicsRegions)
         }
     }
 
+    public void setProperties(String propArgument) {
+        boolean isValidFormat = Arrays.stream(propArgument.split("\\|"))
+            .allMatch(s -> s.matches("[^:]+:[^:]+"));
+
+        if (!isValidFormat) {
+            throw new IllegalArgumentException("Argument properties (-pr) does not follow the "
+                + "'key:value' format for all segments separated by \"|\".");
+        }
+
+        properties = Arrays.stream(propArgument.split("\\|"))
+            .map(prop -> prop.split(":", 2))
+            .toArray(String[][]::new);
+    }
+
     public void setMatchTimeout(String matchTimeout) {
         this.matchTimeout = matchTimeout;
     }