Java visual

.github/workflows/jdk8.yml

@@ -1,7 +1,9 @@
-# This workflow will build a Java project with Maven
-# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven
 
 name: JDK 8
+env:
+  SCREENER_API_KEY: ${{ secrets.SCREENER_API_KEY }}
+  SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }}
+  SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }}
 
 on:
   push:
@@ -19,9 +21,6 @@ jobs:
         with:
           java-version: 1.8
       - name: Test with Maven
-        env:
-          SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }}
-          SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }}
         run: make java_tests
   junit4:
     runs-on: ubuntu-latest
@@ -32,9 +31,6 @@ jobs:
         with:
           java-version: 1.8
       - name: Test with Maven
-        env:
-          SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }}
-          SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }}
         run: make junit4_tests
   junit5:
     runs-on: ubuntu-latest
@@ -45,7 +41,4 @@ jobs:
         with:
           java-version: 1.8
       - name: Test with Maven
-        env:
-          SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }}
-          SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }}
         run: make junit5_tests

.github/workflows/jdk9.yml

@@ -2,6 +2,10 @@
 # For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven
 
 name: JDK 9+
+env:
+  SCREENER_API_KEY: ${{ secrets.SCREENER_API_KEY }}
+  SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }}
+  SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }}
 
 on:
   push:
@@ -19,9 +23,6 @@ jobs:
         with:
           java-version: 9
       - name: Test with Maven
-        env:
-          SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }}
-          SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }}
         run: cd java/main && mvn clean test -Dmaven.javadoc.skip=true;
   junit4:
     runs-on: ubuntu-latest
@@ -32,9 +33,6 @@ jobs:
         with:
           java-version: 9
       - name: Test with Maven
-        env:
-          SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }}
-          SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }}
         run: cd java/junit4 && mvn clean test -Dmaven.javadoc.skip=true;
   junit5:
     runs-on: ubuntu-latest
@@ -45,7 +43,4 @@ jobs:
         with:
           java-version: 9
       - name: Test with Maven
-        env:
-          SAUCE_USERNAME: ${{ secrets.SAUCE_USERNAME }}
-          SAUCE_ACCESS_KEY: ${{ secrets.SAUCE_ACCESS_KEY }}
         run: cd java/junit5 && mvn clean test -Dmaven.javadoc.skip=true;

java/main/src/main/java/com/saucelabs/saucebindings/GitManager.java

@@ -0,0 +1,24 @@
+package com.saucelabs.saucebindings;
+
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStreamReader;
+
+public class GitManager {
+    private static String currentBranch = "_default_";
+
+    public static String getCurrentBranch() {
+        try {
+            Process process = Runtime.getRuntime().exec("git rev-parse --abbrev-ref HEAD");
+            process.waitFor();
+            BufferedReader reader = new BufferedReader(new InputStreamReader(process.getInputStream()));
+            String line = reader.readLine();
+            if (!line.contains("fatal:")) {
+                currentBranch = line;
+            }
+        } catch (IOException | InterruptedException e) {
+            // Ignore exception and use default
+        }
+        return currentBranch;
+    }
+}

java/main/src/main/java/com/saucelabs/saucebindings/SauceVisualException.java

@@ -0,0 +1,7 @@
+package com.saucelabs.saucebindings;
+
+public class SauceVisualException extends RuntimeException {
+    public SauceVisualException(String message) {
+        super(message);
+    }
+}

java/main/src/main/java/com/saucelabs/saucebindings/VisualResults.java

@@ -0,0 +1,53 @@
+package com.saucelabs.saucebindings;
+
+import lombok.Getter;
+import lombok.Setter;
+import org.openqa.selenium.remote.RemoteWebDriver;
+
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Map;
+
+@Setter @Getter
+public class VisualResults {
+    Map<String, Object> results;
+    private Map<String, Object> totals;
+
+    private final Boolean passed;
+    private final String message;
+    private final String status;
+    private final List<VisualSnapshot> snapshots = new ArrayList<>();
+    private final Long totalNew;
+    private final Long totalChanged;
+    private final Long totalRejected;
+    private final Long totalAccepted;
+    private final Long total;
+
+    public static VisualResults generate(RemoteWebDriver driver) {
+        return new VisualResults(driver);
+    }
+
+    private VisualResults(RemoteWebDriver driver) {
+        results = (Map<String, Object>) driver.executeScript("/*@visual.end*/");
+
+        this.passed = (Boolean) results.get("passed");
+        this.message = (String) results.get("message");
+        this.status = (String) results.get("status"); // success, failure, error, timeout, cancelled
+
+        for (Map state : (List<Map>) results.get("states")) {
+            snapshots.add(new VisualSnapshot(state));
+        }
+
+        this.totals = (Map) results.get("totals");
+        this.totalNew = (Long) totals.get("new");
+        this.totalChanged = (Long) totals.get("changed");
+        this.totalRejected = (Long) totals.get("rejected");
+        this.totalAccepted = (Long) totals.get("accepted");
+        this.total = (Long) totals.get("all");
+    }
+
+    public String getSummary() {
+        String disposition = getPassed() ? getStatus() : getMessage();
+        return "Totals: " + getTotals() + "; Disposition: " + disposition + "\n";
+    }
+}

java/main/src/main/java/com/saucelabs/saucebindings/VisualSession.java

@@ -0,0 +1,85 @@
+package com.saucelabs.saucebindings;
+
+import com.saucelabs.saucebindings.options.SauceOptions;
+import com.saucelabs.saucebindings.options.VisualOptions;
+import org.openqa.selenium.InvalidArgumentException;
+import org.openqa.selenium.remote.RemoteWebDriver;
+
+import java.net.MalformedURLException;
+import java.net.URL;
+
+public class VisualSession extends SauceSession {
+    private VisualResults visualResults;
+    private final VisualOptions visualOptions;
+
+    public VisualSession(String testName) {
+        this(new VisualOptions(SauceOptions.chrome().setName(testName).build()));
+    }
+
+    public VisualSession(VisualOptions options) {
+        super(options.getSauceOptions());
+        this.visualOptions = options;
+    }
+
+    @Override
+    public RemoteWebDriver start() {
+        this.driver = createRemoteWebDriver(getSauceUrl(), visualOptions.toCapabilities());
+        newVisualTest(getSauceOptions().sauce().getName());
+        return driver;
+    }
+
+    @Override
+    public URL getSauceUrl() {
+        try {
+            return new URL("https://hub.screener.io/wd/hub");
+        } catch (MalformedURLException e) {
+            throw new InvalidArgumentException("Invalid URL", e);
+        }
+    }
+
+    public void newVisualTest(String testName) {
+        validateVisualStatus();
+        driver.executeScript("/*@visual.init*/", testName);
+    }
+
+    public void takeSnapshot(String name) {
+        validateVisualStatus();
+        driver.executeScript("/*@visual.snapshot*/", name);
+    }
+
+    public VisualResults getVisualResults() {
+        if (visualResults == null) {
+            this.visualResults = VisualResults.generate(driver);
+        }
+        return visualResults;
+    }
+
+    @Override
+    public void stop(Boolean passed) {
+        String result = passed ? "passed" : "failed";
+        stop(result);
+    }
+
+    @Override
+    public void stop(String result) {
+        if (driver != null) {
+            System.out.println(getVisualResults().getSummary());
+            super.stop(result);
+        }
+    }
+
+    public void stop() {
+        if (driver != null) {
+            VisualResults results = getVisualResults();
+            System.out.println(results.getSummary());
+            String result = results.getPassed() ? "passed" : "failed";
+            super.stop(result);
+        }
+    }
+
+    private void validateVisualStatus() {
+        if (this.visualResults != null) {
+            throw new SauceVisualException("Can not execute Visual Commands after calling getVisualResults()");
+        }
+    }
+}

java/main/src/main/java/com/saucelabs/saucebindings/VisualSnapshot.java

@@ -0,0 +1,26 @@
+package com.saucelabs.saucebindings;
+
+import lombok.Getter;
+import lombok.Setter;
+
+import java.util.Map;
+
+@Setter @Getter
+public class VisualSnapshot {
+    private final String name;
+    private final String groupName;
+    private final String status;
+    private final String url;
+
+    public VisualSnapshot(Map<String, String> results) {
+        this.name = results.get("name");
+        this.groupName = results.get("groupName");
+        this.status = results.get("status");
+        this.url = results.get("url");
+    }
+
+    @Override
+    public String toString() {
+        return name + ": " + url;
+    }
+}

java/main/src/main/java/com/saucelabs/saucebindings/options/VisualOptions.java

@@ -0,0 +1,105 @@
+package com.saucelabs.saucebindings.options;
+
+import com.saucelabs.saucebindings.CITools;
+import com.saucelabs.saucebindings.GitManager;
+import com.saucelabs.saucebindings.SauceSession;
+import com.saucelabs.saucebindings.SystemManager;
+import lombok.AccessLevel;
+import lombok.Getter;
+import lombok.Setter;
+import lombok.experimental.Accessors;
+import org.openqa.selenium.MutableCapabilities;
+
+import java.util.Arrays;
+import java.util.List;
+import java.util.Map;
+
+@Accessors(chain = true) @Setter @Getter
+public class VisualOptions extends BaseOptions {
+    @Setter(AccessLevel.NONE) private SauceOptions sauceOptions;
+    private String projectName;
+    private String viewportSize;
+    private String branch;
+    private String baseBranch;
+    private Map<String, Object> diffOptions = null;
+    private String ignore;
+    private Boolean failOnNewStates = null;
+    private Boolean alwaysAcceptBaseBranch = null;
+    private Boolean disableBranchBaseline = null;
+    private Boolean scrollAndStitchScreenshots = null;
+    private Boolean disableCORS = null;
+    private Boolean iframes = null;
+    private Map<String, Object> iframesOptions = null;
+
+    public final List<String> validOptions = Arrays.asList(
+            "projectName",
+            "viewportSize",
+            "branch",
+            "baseBranch",
+            "diffOptions",
+            "ignore",
+            "failOnNewStates",
+            "alwaysAcceptBaseBranch",
+            "disableBranchBaseline",
+            "scrollAndStitchScreenshots",
+            "disableCORS",
+            "iframes",
+            "iframesOptions");
+
+    public VisualOptions(String testName) {
+        this(SauceOptions.chrome().setName(testName).build());
+    }
+
+    public VisualOptions(SauceOptions options) {
+        if (options.sauce().getName() == null) {
+            String msg = "Visual Tests Require setting a name in SauceOptions";
+            throw new InvalidSauceOptionsArgumentException(msg);
+        }
+
+        this.sauceOptions = options;
+        capabilityManager = new CapabilityManager(this);
+    }
+
+    /**
+     * @return instance of MutableCapabilities representing all key value pairs set in SauceOptions
+     * @see SauceSession#start()
+     */
+    public MutableCapabilities toCapabilities() {
+        String msg = "Environment Variable or System Property for 'SCREENER_API_KEY' must be provided";
+        String sauceVisualApiKey = SystemManager.get("SCREENER_API_KEY", msg);
+        capabilities.setCapability("apiKey", sauceVisualApiKey);
+
+        if (projectName == null) {
+            projectName = CITools.getBuildName();
+        }
+
+        if (branch == null) {
+            branch = GitManager.getCurrentBranch();
+        }
+
+        capabilityManager.addCapabilities();
+
+        MutableCapabilities toReturn = getSauceOptions().toCapabilities();
+        toReturn.setCapability("sauce:visual", capabilities);
+
+        return toReturn;
+    }
+
+    /**
+     * Use Case is pulling serialized information from JSON/YAML, converting it to a HashMap and passing it in
+     * This is a preferred pattern as it avoids conditionals in code
+     * Warning: For VisualOptions this adds a hard coded Test Name that needs to be updated
+     *
+     * @param capabilitiesToMerge a Map object representing key value pairs to convert to capabilities
+     */
+    public void mergeCapabilities(Map<String, Object> capabilitiesToMerge) {
+        for (Map.Entry<String, Object> entry : capabilitiesToMerge.entrySet()) {
+            String key = entry.getKey();
+            if (key.equals("visual")) {
+                ((Map<String, Object>) entry.getValue()).forEach(this::setCapability);
+            } else {
+                sauceOptions.setCapability(key, entry.getValue());
+            }
+        }
+    }
+}