io.percy.selenium.Percy Maven / Gradle / Ivy
package io.percy.selenium;
import org.apache.commons.exec.util.StringUtils;
import org.apache.http.Header;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.util.EntityUtils;
import org.apache.http.entity.ContentType;
import org.apache.http.entity.StringEntity;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpPost;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.json.JSONObject;
import java.io.InputStream;
import java.util.*;
import java.util.concurrent.ConcurrentHashMap;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.annotation.Nullable;
import org.openqa.selenium.*;
import org.openqa.selenium.remote.*;
import java.lang.reflect.Field;
/**
* Percy client for visual testing.
*/
public class Percy {
// Selenium WebDriver we'll use for accessing the web pages to snapshot.
private WebDriver driver;
// The JavaScript contained in dom.js
private String domJs = "";
// Maybe get the CLI server address
private String PERCY_SERVER_ADDRESS = System.getenv().getOrDefault("PERCY_SERVER_ADDRESS", "http://localhost:5338");
// Determine if we're debug logging
private boolean PERCY_DEBUG = System.getenv().getOrDefault("PERCY_LOGLEVEL", "info").equals("debug");
// for logging
private String LABEL = "[\u001b[35m" + (PERCY_DEBUG ? "percy:java" : "percy") + "\u001b[39m]";
// Is the Percy server running or not
private boolean isPercyEnabled = healthcheck();
// Environment information like Java, browser, & SDK versions
private Environment env;
// Fetch following properties from capabilities
private final List capsNeeded = new ArrayList<>(Arrays.asList("browserName", "platform", "platformName", "version", "osVersion", "proxy", "deviceName"));
private final String ignoreElementKey = "ignore_region_selenium_elements";
private final String ignoreElementAltKey = "ignoreRegionSeleniumElements";
private final String considerElementKey = "consider_region_selenium_elements";
private final String considerElementAltKey = "considerRegionSeleniumElements";
/**
* @param driver The Selenium WebDriver object that will hold the browser
* session to snapshot.
*/
public Percy(WebDriver driver) {
this.driver = driver;
this.env = new Environment(driver);
}
/**
* Take a snapshot and upload it to Percy.
*
* @param name The human-readable name of the snapshot. Should be unique.
*
*/
public void snapshot(String name) {
snapshot(name, null, null, false, null, null);
}
/**
* Take a snapshot and upload it to Percy.
*
* @param name The human-readable name of the snapshot. Should be unique.
* @param widths The browser widths at which you want to take the snapshot. In
* pixels.
*/
public void snapshot(String name, List widths) {
snapshot(name, widths, null, false, null, null);
}
/**
* Take a snapshot and upload it to Percy.
*
* @param name The human-readable name of the snapshot. Should be unique.
* @param widths The browser widths at which you want to take the snapshot. In
* pixels.
* @param minHeight The minimum height of the resulting snapshot. In pixels.
*/
public void snapshot(String name, List widths, Integer minHeight) {
snapshot(name, widths, minHeight, false, null, null);
}
/**
* Take a snapshot and upload it to Percy.
*
* @param name The human-readable name of the snapshot. Should be unique.
* @param widths The browser widths at which you want to take the snapshot. In
* pixels.
* @param minHeight The minimum height of the resulting snapshot. In pixels.
* @param enableJavaScript Enable JavaScript in the Percy rendering environment
*/
public void snapshot(String name, List widths, Integer minHeight, boolean enableJavaScript) {
snapshot(name, widths, minHeight, enableJavaScript, null, null);
}
/**
* Take a snapshot and upload it to Percy.
*
* @param name The human-readable name of the snapshot. Should be unique.
* @param widths The browser widths at which you want to take the snapshot.
* In pixels.
* @param minHeight The minimum height of the resulting snapshot. In pixels.
* @param enableJavaScript Enable JavaScript in the Percy rendering environment
* @param percyCSS Percy specific CSS that is only applied in Percy's browsers
*/
public void snapshot(String name, @Nullable List widths, Integer minHeight, boolean enableJavaScript, String percyCSS) {
snapshot(name, widths, minHeight, enableJavaScript, percyCSS, null);
}
/**
* Take a snapshot and upload it to Percy.
*
* @param name The human-readable name of the snapshot. Should be unique.
* @param widths The browser widths at which you want to take the snapshot.
* In pixels.
* @param minHeight The minimum height of the resulting snapshot. In pixels.
* @param enableJavaScript Enable JavaScript in the Percy rendering environment
* @param percyCSS Percy specific CSS that is only applied in Percy's browsers
* @param scope A CSS selector to scope the screenshot to
*/
public void snapshot(String name, @Nullable List widths, Integer minHeight, boolean enableJavaScript, String percyCSS, String scope) {
if (!isPercyEnabled) { return; }
Map domSnapshot = null;
Map options = new HashMap();
options.put("widths", widths);
options.put("minHeight", minHeight);
options.put("enableJavaScript", enableJavaScript);
options.put("percyCSS", percyCSS);
options.put("scope", scope);
snapshot(name, options);
}
public void snapshot(String name, Map options) {
if (!isPercyEnabled) { return; }
Map domSnapshot = null;
try {
JavascriptExecutor jse = (JavascriptExecutor) driver;
jse.executeScript(fetchPercyDOM());
domSnapshot = (Map) jse.executeScript(buildSnapshotJS(options));
} catch (WebDriverException e) {
// For some reason, the execution in the browser failed.
if (PERCY_DEBUG) { log(e.getMessage()); }
}
postSnapshot(domSnapshot, name, driver.getCurrentUrl(), options);
}
/**
* Take a snapshot and upload it to Percy.
*
* @param name The human-readable name of the screenshot. Should be unique.
*/
public void screenshot(String name) throws UnsupportedOperationException {
Map options = new HashMap();
screenshot(name, options);
}
/**
* Take a snapshot and upload it to Percy.
*
* @param name The human-readable name of the screenshot. Should be unique.
* @param options Extra options
*/
public void screenshot(String name, Map options) throws UnsupportedOperationException {
if (!isPercyEnabled) { return; }
List driverArray = Arrays.asList(driver.getClass().toString().split("\\$")); // Added to handle testcase (mocked driver)
Iterator driverIterator = driverArray.iterator();
String driverClass = driverIterator.next();
String sessionId = ((RemoteWebDriver) driver).getSessionId().toString();
CommandExecutor executor = ((RemoteWebDriver) driver).getCommandExecutor();
// Get HttpCommandExecutor From TracedCommandExecutor
if (executor.getClass().toString().contains("TracedCommandExecutor")) {
Class className = executor.getClass();
try {
Field field = className.getDeclaredField("delegate");
// make private field accessible
field.setAccessible(true);
executor = (HttpCommandExecutor)field.get(executor);
} catch (Exception e) {
log(e.toString());
return;
}
}
String remoteWebAddress = ((HttpCommandExecutor) executor).getAddressOfRemoteServer().toString();
Capabilities caps = ((RemoteWebDriver) driver).getCapabilities();
ConcurrentHashMap capabilities = new ConcurrentHashMap();
Iterator iterator = capsNeeded.iterator();
while (iterator.hasNext()) {
String cap = iterator.next();
if (caps.getCapability(cap) != null) {
capabilities.put(cap, caps.getCapability(cap).toString());
}
}
if (options.containsKey(ignoreElementAltKey)) {
options.put(ignoreElementKey, options.get(ignoreElementAltKey));
options.remove(ignoreElementAltKey);
}
if (options.containsKey(considerElementAltKey)) {
options.put(considerElementKey, options.get(considerElementAltKey));
options.remove(considerElementAltKey);
}
if (options.containsKey(ignoreElementKey)) {
List ignoreElementIds = getElementIdFromElement((List) options.get(ignoreElementKey));
options.remove(ignoreElementKey);
options.put("ignore_region_elements", ignoreElementIds);
}
if (options.containsKey(considerElementKey)) {
List considerElementIds = getElementIdFromElement((List) options.get(considerElementKey));
options.remove(considerElementKey);
options.put("consider_region_elements", considerElementIds);
}
// Build a JSON object to POST back to the agent node process
JSONObject json = new JSONObject();
json.put("sessionId", sessionId);
json.put("commandExecutorUrl", remoteWebAddress);
json.put("capabilities", capabilities);
json.put("snapshotName", name);
json.put("clientInfo", env.getClientInfo());
json.put("environmentInfo", env.getEnvironmentInfo());
json.put("options", options);
request("/percy/automateScreenshot", json, name);
}
/**
* Checks to make sure the local Percy server is running. If not, disable Percy.
*/
private boolean healthcheck() {
try (CloseableHttpClient httpClient = HttpClientBuilder.create().build()) {
//Creating a HttpGet object
HttpGet httpget = new HttpGet(PERCY_SERVER_ADDRESS + "/percy/healthcheck");
//Executing the Get request
HttpResponse response = httpClient.execute(httpget);
int statusCode = response.getStatusLine().getStatusCode();
if (statusCode != 200){
throw new RuntimeException("Failed with HTTP error code : " + statusCode);
}
String version = response.getFirstHeader("x-percy-core-version").getValue();
if (version == null) {
log("You may be using @percy/agent" +
"which is no longer supported by this SDK." +
"Please uninstall @percy/agent and install @percy/cli instead." +
"https://docs.percy.io/docs/migrating-to-percy-cli"
);
return false;
}
if (!version.split("\\.")[0].equals("1")) {
log("Unsupported Percy CLI version, " + version);
return false;
}
return true;
} catch (Exception ex) {
log("Percy is not running, disabling snapshots");
// bike shed.. single line?
if (PERCY_DEBUG) { log(ex.toString()); }
return false;
}
}
/**
* Attempts to load dom.js from the local Percy server. Use cached value in `domJs`,
* if it exists.
*
* This JavaScript is critical for capturing snapshots. It serializes and captures
* the DOM. Without it, snapshots cannot be captured.
*/
private String fetchPercyDOM() {
if (!domJs.trim().isEmpty()) { return domJs; }
try (CloseableHttpClient httpClient = HttpClientBuilder.create().build()) {
HttpGet httpget = new HttpGet(PERCY_SERVER_ADDRESS + "/percy/dom.js");
HttpResponse response = httpClient.execute(httpget);
int statusCode = response.getStatusLine().getStatusCode();
if (statusCode != 200){
throw new RuntimeException("Failed with HTTP error code: " + statusCode);
}
HttpEntity httpEntity = response.getEntity();
String domString = EntityUtils.toString(httpEntity);
domJs = domString;
return domString;
} catch (Exception ex) {
isPercyEnabled = false;
if (PERCY_DEBUG) { log(ex.toString()); }
return "";
}
}
/**
* POST the DOM taken from the test browser to the Percy Agent node process.
*
* @param domSnapshot Stringified & serialized version of the site/applications DOM
* @param name The human-readable name of the snapshot. Should be unique.
* @param widths The browser widths at which you want to take the snapshot.
* In pixels.
* @param minHeight The minimum height of the resulting snapshot. In pixels.
* @param enableJavaScript Enable JavaScript in the Percy rendering environment
* @param percyCSS Percy specific CSS that is only applied in Percy's browsers
*/
private void postSnapshot(
Map domSnapshot,
String name,
String url,
Map options
) {
if (!isPercyEnabled) { return; }
// Build a JSON object to POST back to the agent node process
JSONObject json = new JSONObject(options);
json.put("url", url);
json.put("name", name);
json.put("domSnapshot", domSnapshot);
json.put("clientInfo", env.getClientInfo());
json.put("environmentInfo", env.getEnvironmentInfo());
request("/percy/snapshot", json, name);
}
/**
* POST data to the Percy Agent node process.
*
* @param url Endpoint to be called.
* @param name The human-readable name of the snapshot. Should be unique.
* @param json Json object of all properties.
*/
protected void request(String url, JSONObject json, String name) {
StringEntity entity = new StringEntity(json.toString(), ContentType.APPLICATION_JSON);
try (CloseableHttpClient httpClient = HttpClientBuilder.create().build()) {
HttpPost request = new HttpPost(PERCY_SERVER_ADDRESS + url);
request.setEntity(entity);
HttpResponse response = httpClient.execute(request);
} catch (Exception ex) {
if (PERCY_DEBUG) { log(ex.toString()); }
log("Could not post snapshot " + name);
}
}
/**
* @return A String containing the JavaScript needed to instantiate a PercyAgent
* and take a snapshot.
*/
private String buildSnapshotJS(Map options) {
StringBuilder jsBuilder = new StringBuilder();
JSONObject json = new JSONObject(options);
jsBuilder.append(String.format("return PercyDOM.serialize(%s)\n", json.toString()));
return jsBuilder.toString();
}
private List getElementIdFromElement(List elements) {
List ignoredElementsArray = new ArrayList<>();
for (int index = 0; index < elements.size(); index++) {
String elementId = elements.get(index).getId();
ignoredElementsArray.add(elementId);
}
return ignoredElementsArray;
}
private void log(String message) {
System.out.println(LABEL + " " + message);
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy