diff --git a/package.json b/package.json index 4711c51..72d9dfe 100644 --- a/package.json +++ b/package.json @@ -4,6 +4,6 @@ "test": "npx percy exec --testing -- mvn test" }, "devDependencies": { - "@percy/cli": "1.30.9" + "@percy/cli": "1.31.10" } } diff --git a/pom.xml b/pom.xml index 0590aa6..bacd8fc 100644 --- a/pom.xml +++ b/pom.xml @@ -5,7 +5,7 @@ io.percy percy-java-selenium - 2.1.1 + 2.1.2-beta.0 jar ${project.groupId}:${project.artifactId} @@ -32,7 +32,7 @@ scm:git:git://github.com/percy/percy-java-selenium.git scm:git:https://github.com/percy/percy-java-selenium.git https://github.com/percy/percy-java-selenium/tree/master - v2.0.0 + v2.1.2-beta.0 diff --git a/src/main/java/io/percy/selenium/Environment.java b/src/main/java/io/percy/selenium/Environment.java index 0c38284..c2b4e9d 100644 --- a/src/main/java/io/percy/selenium/Environment.java +++ b/src/main/java/io/percy/selenium/Environment.java @@ -10,7 +10,7 @@ */ class Environment { private WebDriver driver; - private final static String SDK_VERSION = "2.1.1"; + private final static String SDK_VERSION = "2.1.2-beta.0"; private final static String SDK_NAME = "percy-java-selenium"; Environment(WebDriver driver) { diff --git a/src/main/java/io/percy/selenium/Percy.java b/src/main/java/io/percy/selenium/Percy.java index 0cf20f0..453c4bf 100644 --- a/src/main/java/io/percy/selenium/Percy.java +++ b/src/main/java/io/percy/selenium/Percy.java @@ -14,6 +14,7 @@ import org.json.JSONObject; import org.json.JSONArray; +import java.net.URI; import java.time.Duration; import java.util.*; import java.util.concurrent.ConcurrentHashMap; @@ -47,8 +48,15 @@ public class Percy { // Determine if we're debug logging private static boolean PERCY_DEBUG = System.getenv().getOrDefault("PERCY_LOGLEVEL", "info").equals("debug"); - private static String RESONSIVE_CAPTURE_SLEEP_TIME = System.getenv().getOrDefault("RESONSIVE_CAPTURE_SLEEP_TIME", ""); + private static String RESPONSIVE_CAPTURE_SLEEP_TIME = System.getenv().getOrDefault( + "RESPONSIVE_CAPTURE_SLEEP_TIME", + System.getenv().getOrDefault("RESONSIVE_CAPTURE_SLEEP_TIME", "") + ); + private static boolean PERCY_RESPONSIVE_CAPTURE_RELOAD_PAGE = Boolean.parseBoolean(System.getenv().getOrDefault("PERCY_RESPONSIVE_CAPTURE_RELOAD_PAGE", "false").toLowerCase()); + + private static boolean PERCY_RESPONSIVE_CAPTURE_MIN_HEIGHT = Boolean.parseBoolean(System.getenv().getOrDefault("PERCY_RESPONSIVE_CAPTURE_MIN_HEIGHT", "false").toLowerCase()); + private static final int WIDTHS_CONFIG_TIMEOUT_MS = 30000; // for logging private static String LABEL = "[\u001b[35m" + (PERCY_DEBUG ? "percy:java" : "percy") + "\u001b[39m]"; @@ -247,6 +255,79 @@ public JSONObject snapshot(String name, @Nullable List widths, Integer return snapshot(name, options); } + private List> getResponsiveWidths(List widths) { + String queryParam = buildWidthsQueryParam(widths); + RequestConfig requestConfig = buildRequestConfig(WIDTHS_CONFIG_TIMEOUT_MS); + + try (CloseableHttpClient httpClient = HttpClients.custom().setDefaultRequestConfig(requestConfig).build()) { + HttpResponse response = fetchWidthsConfigResponse(httpClient, queryParam); + return parseWidthsConfigResponse(response); + } catch (RuntimeException re) { + throw re; + } catch (Exception ex) { + log("Update Percy CLI to the latest version to use responsiveSnapshotCapture"); + log("Failed to fetch widths-config: " + ex.getMessage(), "debug"); + throw new RuntimeException( + "Failed to fetch widths-config: " + ex.getMessage(), ex); + } + } + + // Builds the optional `?widths=` query string from SDK-provided widths. + private String buildWidthsQueryParam(List widths) { + if (widths == null || widths.isEmpty()) { + return ""; + } + String joined = widths.stream().map(String::valueOf).collect(Collectors.joining(",")); + return "?widths=" + joined; + } + + // Creates HTTP request timeout configuration for the widths-config endpoint. + private RequestConfig buildRequestConfig(int timeoutMs) { + return RequestConfig.custom() + .setSocketTimeout(timeoutMs) + .setConnectTimeout(timeoutMs) + .build(); + } + + // Calls Percy CLI widths-config endpoint and validates that the HTTP status is successful. + private HttpResponse fetchWidthsConfigResponse(CloseableHttpClient httpClient, String queryParam) throws Exception { + HttpGet httpget = new HttpGet(PERCY_SERVER_ADDRESS + "/percy/widths-config" + queryParam); + HttpResponse response = httpClient.execute(httpget); + int statusCode = response.getStatusLine().getStatusCode(); + + if (statusCode != 200) { + EntityUtils.consume(response.getEntity()); + log("Update Percy CLI to the latest version to use responsiveSnapshotCapture"); + throw new RuntimeException("Failed to fetch widths-config (HTTP " + statusCode + ")"); + } + + return response; + } + + // Parses widths-config JSON and converts the payload to SDK width/height maps. + private List> parseWidthsConfigResponse(HttpResponse response) throws Exception { + String responseString = EntityUtils.toString(response.getEntity(), "UTF-8"); + JSONObject json = new JSONObject(responseString); + + if (!json.has("widths") || json.isNull("widths")) { + log("Update Percy CLI to the latest version to use responsiveSnapshotCapture"); + throw new RuntimeException("Missing \"widths\" in widths-config response"); + } + + JSONArray widthsArray = json.getJSONArray("widths"); + List> result = new ArrayList<>(); + for (int i = 0; i < widthsArray.length(); i++) { + JSONObject entry = widthsArray.getJSONObject(i); + Map item = new HashMap<>(); + item.put("width", entry.getInt("width")); + if (entry.has("height") && !entry.isNull("height")) { + item.put("height", entry.getInt("height")); + } + result.add(item); + } + return result; + } + private boolean isCaptureResponsiveDOM(Map options) { if (cliConfig.has("percy") && !cliConfig.isNull("percy")) { JSONObject percyProperty = cliConfig.getJSONObject("percy"); @@ -289,6 +370,8 @@ public JSONObject snapshot(String name, Map options) { } catch (WebDriverException e) { // For some reason, the execution in the browser failed. log(e.getMessage(), "debug"); + } catch (Exception e) { + log("Snapshot failed: " + e.getMessage(), "debug"); } return postSnapshot(domSnapshot, name, driver.getCurrentUrl(), options); @@ -515,11 +598,127 @@ private String buildSnapshotJS(Map options) { return jsBuilder.toString(); } + static class FatalIframeException extends RuntimeException { + FatalIframeException(String message, Throwable cause) { + super(message, cause); + } + } + + private boolean isUnsupportedIframeSrc(String src) { + return src == null || src.isEmpty() || + src.equals("about:blank") || + src.startsWith("javascript:") || + src.startsWith("data:") || + src.startsWith("vbscript:"); + } + + private String getOrigin(String url) { + try { + URI uri = new URI(url); + String scheme = uri.getScheme(); + String authority = uri.getAuthority(); + if (scheme == null || authority == null) return ""; + return scheme + "://" + authority; + } catch (Exception e) { + return ""; + } + } + + private Map processFrame(WebElement frameElement, Map options) { + // Read attributes while still in parent context — these calls will + // fail if made after switchTo().frame(). + String frameUrl = frameElement.getAttribute("src"); + if (frameUrl == null) frameUrl = "unknown-src"; + final String finalFrameUrl = frameUrl; + String percyElementId = frameElement.getAttribute("data-percy-element-id"); + log("processFrame: data-percy-element-id=\"" + percyElementId + "\" for src=\"" + finalFrameUrl + "\"", "debug"); + if (percyElementId == null || percyElementId.isEmpty()) { + log("Skipping frame " + finalFrameUrl + ": no matching percyElementId found", "debug"); + return null; + } + + Map iframeSnapshot = null; + try { + driver.switchTo().frame(frameElement); + JavascriptExecutor jse = (JavascriptExecutor) driver; + // Inject Percy DOM into the cross-origin frame context + jse.executeScript(domJs); + // Serialize inside the frame; enableJavaScript=true is required for CORS iframes + Map iframeOptions = new HashMap<>(options); + iframeOptions.put("enableJavaScript", true); + JSONObject optionsJson = new JSONObject(iframeOptions); + iframeSnapshot = (Map) jse.executeScript( + "return PercyDOM.serialize(" + optionsJson.toString() + ")" + ); + } catch (Exception e) { + log("Failed to process cross-origin frame " + finalFrameUrl + ": " + e.getMessage(), "error"); + throw new RuntimeException("Failed to process cross-origin frame " + finalFrameUrl, e); + } finally { + try { + driver.switchTo().defaultContent(); + } catch (Exception err) { + throw new FatalIframeException( + "Could not exit iframe context after processing \"" + finalFrameUrl + "\". Driver may be unstable.", err + ); + } + } + + Map iframeData = new HashMap<>(); + iframeData.put("percyElementId", percyElementId); + + Map result = new HashMap<>(); + result.put("iframeData", iframeData); + result.put("iframeSnapshot", iframeSnapshot); + result.put("frameUrl", finalFrameUrl); + return result; + } + private Map getSerializedDOM(JavascriptExecutor jse, Set cookies, Map options) { Map domSnapshot = (Map) jse.executeScript(buildSnapshotJS(options)); Map mutableSnapshot = new HashMap<>(domSnapshot); mutableSnapshot.put("cookies", cookies); - + try { + String pageOrigin = getOrigin(driver.getCurrentUrl()); + List iframes = driver.findElements(By.tagName("iframe")); + if (!iframes.isEmpty() && !domJs.trim().isEmpty()) { + List> processedFrames = new ArrayList<>(); + for (WebElement frame : iframes) { + String frameSrc = frame.getAttribute("src"); + if (isUnsupportedIframeSrc(frameSrc)) { + continue; + } + String frameOrigin; + try { + URI base = new URI(driver.getCurrentUrl()); + URI resolved = base.resolve(frameSrc); + frameOrigin = getOrigin(resolved.toString()); + } catch (Exception e) { + log("Skipping iframe \"" + frameSrc + "\": " + e.getMessage(), "debug"); + continue; + } + if (frameOrigin.equals(pageOrigin)) { + continue; + } + try { + Map result = processFrame(frame, options); + if (result != null) { + processedFrames.add(result); + } + } catch (FatalIframeException e) { + throw e; + } catch (Exception e) { + log("Skipping frame \"" + frameSrc + "\" due to error: " + e.getMessage(), "debug"); + } + } + if (!processedFrames.isEmpty()) { + mutableSnapshot.put("corsIframes", processedFrames); + } + } + } catch (FatalIframeException e) { + throw e; + } catch (Exception e) { + log("Failed to process cross-origin iframes: " + e.getMessage(), "debug"); + } return mutableSnapshot; } @@ -532,39 +731,6 @@ private List getElementIdFromElement(List elements) { return ignoredElementsArray; } - // Get widths for multi DOM - private List getWidthsForMultiDom(Map options) { - List widths; - if (options.containsKey("widths") && options.get("widths") instanceof List) { - widths = (List) options.get("widths"); - } else { - widths = new ArrayList<>(); - } - // Create a Set to avoid duplicates - Set allWidths = new HashSet<>(); - - JSONArray mobileWidths = eligibleWidths.getJSONArray("mobile"); - for (int i = 0; i < mobileWidths.length(); i++) { - allWidths.add(mobileWidths.getInt(i)); - } - - // Add input widths if provided - if (widths.size() != 0) { - for (int width : widths) { - allWidths.add(width); - } - } else { - // Add config widths if no input widths are provided - JSONArray configWidths = eligibleWidths.getJSONArray("config"); - for (int i = 0; i < configWidths.length(); i++) { - allWidths.add(configWidths.getInt(i)); - } - } - - // Convert Set back to List - return allWidths.stream().collect(Collectors.toList()); - } - // Method to check if ChromeDriver supports CDP by checking the existence of executeCdpCommand private static boolean isCdpSupported(ChromeDriver chromeDriver) { try { @@ -593,56 +759,138 @@ private static void changeWindowDimensionAndWait(WebDriver driver, int width, in log("Resizing using CDP failed, falling back to driver for width " + width + ": " + e.getMessage(), "debug"); driver.manage().window().setSize(new Dimension(width, height)); } - // Wait for window resize event using WebDriverWait try { WebDriverWait wait = new WebDriverWait(driver, Duration.ofSeconds(1)); - wait.until((ExpectedCondition) d -> - (long) ((JavascriptExecutor) d).executeScript("return window.resizeCount") == resizeCount); + wait.until((ExpectedCondition) d -> { + Object resizeCountObj = ((JavascriptExecutor) d).executeScript("return window.resizeCount"); + if (resizeCountObj == null) { + return false; + } + return (resizeCountObj instanceof Number) && ((Number) resizeCountObj).longValue() == resizeCount; + }); } catch (WebDriverException e) { log("Timed out waiting for window resize event for width " + width, "debug"); } } - // Capture responsive DOM for different widths - public List> captureResponsiveDom(WebDriver driver, Set cookies, Map options) { - List widths = getWidthsForMultiDom(options); + private List extractResponsiveWidths(Map options) { + if (options == null) { + return null; + } + Object widthsOption = options.get("widths"); + if (!(widthsOption instanceof List)) { + return null; + } + List rawWidths = (List) widthsOption; + List coercedWidths = new ArrayList<>(); + for (Object value : rawWidths) { + if (value instanceof Number) { + coercedWidths.add(((Number) value).intValue()); + } else if (value instanceof String) { + try { + coercedWidths.add(Integer.parseInt((String) value)); + } catch (NumberFormatException ignore) { + } + } + } + return coercedWidths.isEmpty() ? null : coercedWidths; + } - List> domSnapshots = new ArrayList<>(); + // Resolves final viewport height for responsive capture using minHeight config when enabled. + private int resolveResponsiveTargetHeight(Map options, int currentHeight) { + if (!PERCY_RESPONSIVE_CAPTURE_MIN_HEIGHT) { + log("PERCY_RESPONSIVE_CAPTURE_MIN_HEIGHT is disabled, using current window height: " + currentHeight, "debug"); + return currentHeight; + } + + Integer minHeight = resolveConfiguredMinHeight(options); + if (minHeight == null) { + log("minHeight not found in options or cliConfig, using current window height: " + currentHeight, "debug"); + return currentHeight; + } + + return minHeight; + } + // Reads minHeight from snapshot options first, then falls back to CLI snapshot config. + private Integer resolveConfiguredMinHeight(Map options) { + Object minHeightObj = options.get("minHeight"); + if (minHeightObj == null && cliConfig != null && cliConfig.has("snapshot")) { + JSONObject snapshotConfig = cliConfig.getJSONObject("snapshot"); + if (snapshotConfig.has("minHeight")) { + minHeightObj = snapshotConfig.getInt("minHeight"); + } + } + + if (minHeightObj == null) { + return null; + } + + try { + return Integer.parseInt(minHeightObj.toString()); + } catch (NumberFormatException e) { + log("Invalid minHeight value " + minHeightObj + "; expected integer, using current window height instead.", "debug"); + return null; + } + } + + + + public List> captureResponsiveDom(WebDriver driver, Set cookies, Map options) { + List responsiveWidths = extractResponsiveWidths(options); + List> widths = getResponsiveWidths(responsiveWidths); + List> domSnapshots = new ArrayList<>(); Dimension windowSize = driver.manage().window().getSize(); int currentWidth = windowSize.getWidth(); int currentHeight = windowSize.getHeight(); int lastWindowWidth = currentWidth; + int lastWindowHeight = currentHeight; int resizeCount = 0; JavascriptExecutor jse = (JavascriptExecutor) driver; - - // Inject JS to count window resize events jse.executeScript("PercyDOM.waitForResize()"); - - for (int width : widths) { - if (lastWindowWidth != width) { - resizeCount++; - changeWindowDimensionAndWait(driver, width, currentHeight, resizeCount); - lastWindowWidth = width; - } - - try { - int sleepTime = Integer.parseInt(RESONSIVE_CAPTURE_SLEEP_TIME); - Thread.sleep(sleepTime * 1000); // Sleep if needed - } catch (InterruptedException | NumberFormatException ignored) { + int targetHeight = resolveResponsiveTargetHeight(options, currentHeight); + try { + for (Map widthMap : widths) { + Object widthObj = widthMap.get("width"); + if (!(widthObj instanceof Number)) { + continue; + } + int width = ((Number) widthObj).intValue(); + Object heightObj = widthMap.get("height"); + log("Processing responsive snapshot for width " + width + " with target height " + targetHeight + ", height obj: " + heightObj, "debug"); + int heightForWidth = (heightObj instanceof Number) ? ((Number) heightObj).intValue() : targetHeight; + log("Final height: " + heightForWidth, "debug"); + if (lastWindowWidth != width || lastWindowHeight != heightForWidth) { + resizeCount++; + log("Resizing window to width " + width + " and height " + heightForWidth, "debug"); + changeWindowDimensionAndWait(driver, width, heightForWidth, resizeCount); + lastWindowWidth = width; + lastWindowHeight = heightForWidth; + } + if (PERCY_RESPONSIVE_CAPTURE_RELOAD_PAGE) { + driver.navigate().refresh(); + jse.executeScript(fetchPercyDOM()); + jse.executeScript("PercyDOM.waitForResize()"); + resizeCount = 0; + } + try { + if (RESPONSIVE_CAPTURE_SLEEP_TIME != null && !RESPONSIVE_CAPTURE_SLEEP_TIME.isEmpty()) { + int sleepTime = Integer.parseInt(RESPONSIVE_CAPTURE_SLEEP_TIME); + Thread.sleep(sleepTime * 1000L); + } + } catch (InterruptedException | NumberFormatException ignored) { + } + Map domSnapshot = getSerializedDOM(jse, cookies, options); + domSnapshot.put("width", width); + domSnapshots.add(domSnapshot); } - Map domSnapshot = getSerializedDOM(jse, cookies, options); - domSnapshot.put("width", width); - domSnapshots.add(domSnapshot); + } finally { + changeWindowDimensionAndWait(driver, currentWidth, currentHeight, resizeCount + 1); } - - // Revert to the original window size - changeWindowDimensionAndWait(driver, currentWidth, currentHeight, resizeCount + 1); - return domSnapshots; } - + protected static void log(String message) { log(message, "info"); } diff --git a/src/test/java/io/percy/selenium/SdkTest.java b/src/test/java/io/percy/selenium/SdkTest.java index d7c6b6f..7a92677 100644 --- a/src/test/java/io/percy/selenium/SdkTest.java +++ b/src/test/java/io/percy/selenium/SdkTest.java @@ -1,9 +1,21 @@ package io.percy.selenium; import java.io.IOException; +import java.io.OutputStream; +import java.lang.reflect.Field; +import java.lang.reflect.InvocationTargetException; +import java.lang.reflect.Method; +import java.net.InetSocketAddress; +import java.net.HttpURLConnection; import java.util.Arrays; +import java.util.Collections; +import java.util.HashSet; import java.util.HashMap; +import java.util.List; +import java.util.Set; import java.util.Map; +import java.util.concurrent.atomic.AtomicInteger; +import java.util.concurrent.atomic.AtomicReference; import org.junit.jupiter.api.AfterAll; import org.junit.jupiter.api.BeforeEach; @@ -12,20 +24,33 @@ import org.junit.jupiter.api.Test; import static org.junit.jupiter.api.Assertions.*; +import org.apache.http.HttpResponse; +import org.apache.http.client.config.RequestConfig; +import org.apache.http.impl.client.CloseableHttpClient; +import org.apache.http.impl.client.HttpClients; + import org.json.JSONArray; import org.json.JSONObject; import org.openqa.selenium.By; +import org.openqa.selenium.Cookie; +import org.openqa.selenium.Dimension; +import org.openqa.selenium.JavascriptExecutor; import org.openqa.selenium.Keys; import org.openqa.selenium.WebDriver; import org.openqa.selenium.WebElement; +import org.openqa.selenium.WebDriver.TargetLocator; import org.openqa.selenium.firefox.FirefoxDriver; import io.github.bonigarcia.wdm.WebDriverManager; import org.openqa.selenium.remote.*; +import com.sun.net.httpserver.HttpExchange; +import com.sun.net.httpserver.HttpHandler; +import com.sun.net.httpserver.HttpServer; import static org.mockito.ArgumentMatchers.any; import static org.mockito.ArgumentMatchers.eq; +import org.mockito.ArgumentCaptor; import static org.mockito.Mockito.*; import java.net.URL; public class SdkTest { @@ -36,7 +61,7 @@ public class SdkTest { @BeforeAll public static void testSetup() throws IOException { // Disable browser logs from being logged to stdout - System.setProperty(FirefoxDriver.SystemProperty.BROWSER_LOGFILE,"/dev/null"); + System.setProperty("webdriver.firefox.logfile","/dev/null"); WebDriverManager.firefoxdriver().setup(); TestServer.startServer(); @@ -88,6 +113,12 @@ public void takesMultipleSnapshotsInOneTestCase() { percy.snapshot("Multiple snapshots in one test case -- #2", Arrays.asList(768, 992, 1200)); } + @Test + public void takesSnapshotWithCrossOriginIframe() { + driver.get(TEST_URL + "/cors-iframe.html"); + percy.snapshot("Snapshot with cross-origin iframe"); + } + @Test public void snapshotALiveHTTPSite() { driver.get("http://example.com"); @@ -125,11 +156,33 @@ public void snapshotWithOptions() { @Test public void takeSnapshotWithSyncCLI(){ - driver.get("https://example.com"); + RemoteWebDriver mockedDriver = mock(RemoteWebDriver.class); + Percy mockedPercy = spy(new Percy(mockedDriver)); + + try { + setField(mockedPercy, "isPercyEnabled", true); + setField(mockedPercy, "domJs", "window.PercyDOM = window.PercyDOM || {}; window.PercyDOM.serialize = function(){ return {}; };"); + setField(mockedPercy, "cliConfig", new JSONObject().put("snapshot", new JSONObject())); + } catch (Exception e) { + fail("Failed to setup test state: " + e.getMessage()); + } + + when(mockedDriver.getCurrentUrl()).thenReturn("https://example.com"); + WebDriver.Options mockedOptions = mock(WebDriver.Options.class); + when(mockedDriver.manage()).thenReturn(mockedOptions); + when(mockedOptions.getCookies()).thenReturn(Collections.emptySet()); + when(((JavascriptExecutor) mockedDriver).executeScript(any(String.class))).thenReturn(new HashMap()); + + JSONObject mockedResponse = new JSONObject(); + mockedResponse.put("snapshot-name", "test_sync_cli_snapshot"); + mockedResponse.put("status", "success"); + mockedResponse.put("screenshots", new JSONArray()); + doReturn(mockedResponse).when(mockedPercy).request(eq("/percy/snapshot"), any(JSONObject.class), eq("test_sync_cli_snapshot")); + Map options = new HashMap(); options.put("sync", true); - JSONObject data = percy.snapshot("test_sync_cli_snapshot", options); + JSONObject data = mockedPercy.snapshot("test_sync_cli_snapshot", options); assertEquals(data.getString("snapshot-name"), "test_sync_cli_snapshot"); assertEquals(data.getString("status"), "success"); assertEquals(data.get("screenshots").getClass().isAssignableFrom(JSONArray.class), true); @@ -159,6 +212,11 @@ public void takeScreenshot() { } catch (Exception e) { } Percy mockedPercy = spy(new Percy(mockedDriver)); + try { + setField(mockedPercy, "isPercyEnabled", true); + } catch (Exception e) { + fail("Failed to setup test state: " + e.getMessage()); + } mockedPercy.sessionType = "automate"; when(mockedDriver.getSessionId()).thenReturn(new SessionId("123")); when(mockedDriver.getCommandExecutor()).thenReturn(commandExecutor); @@ -178,6 +236,11 @@ public void takeScreenshotWithOptions() { } catch (Exception e) { } Percy mockedPercy = spy(new Percy(mockedDriver)); + try { + setField(mockedPercy, "isPercyEnabled", true); + } catch (Exception e) { + fail("Failed to setup test state: " + e.getMessage()); + } mockedPercy.sessionType = "automate"; when(mockedDriver.getSessionId()).thenReturn(new SessionId("123")); when(mockedDriver.getCommandExecutor()).thenReturn(commandExecutor); @@ -196,8 +259,15 @@ public void takeScreenshotWithOptions() { @Test public void takeSnapshotThrowErrorForPOA() { - percy.sessionType = "automate"; - Throwable exception = assertThrows(RuntimeException.class, () -> percy.snapshot("Test")); + RemoteWebDriver mockedDriver = mock(RemoteWebDriver.class); + Percy mockedPercy = spy(new Percy(mockedDriver)); + mockedPercy.sessionType = "automate"; + try { + setField(mockedPercy, "isPercyEnabled", true); + } catch (Exception e) { + fail("Failed to setup test state: " + e.getMessage()); + } + Throwable exception = assertThrows(RuntimeException.class, () -> mockedPercy.snapshot("Test")); assertEquals("Invalid function call - snapshot(). Please use screenshot() function while using Percy with Automate. For more information on usage of PercyScreenshot, refer https://www.browserstack.com/docs/percy/integrate/functional-and-visual", exception.getMessage()); } @@ -205,10 +275,598 @@ public void takeSnapshotThrowErrorForPOA() { public void takeScreenshotThrowErrorForWeb() { RemoteWebDriver mockedDriver = mock(RemoteWebDriver.class); Percy mockedPercy = spy(new Percy(mockedDriver)); + try { + setField(mockedPercy, "isPercyEnabled", true); + } catch (Exception e) { + fail("Failed to setup test state: " + e.getMessage()); + } Throwable exception = assertThrows(RuntimeException.class, () -> mockedPercy.screenshot("Test")); assertEquals("Invalid function call - screenshot(). Please use snapshot() function for taking screenshot. screenshot() should be used only while using Percy with Automate. For more information on usage of snapshot(), refer doc for your language https://www.browserstack.com/docs/percy/integrate/overview", exception.getMessage()); } + @Test + public void responsiveSnapshotCaptureUsesSdkOptionWhenEligible() throws Exception { + RemoteWebDriver mockedDriver = mock(RemoteWebDriver.class); + Percy mockedPercy = spy(new Percy(mockedDriver)); + + setField(mockedPercy, "eligibleWidths", new JSONObject().put("default", 1280)); + setField(mockedPercy, "cliConfig", new JSONObject().put("snapshot", new JSONObject().put("responsiveSnapshotCapture", false))); + + Map options = new HashMap(); + options.put("responsiveSnapshotCapture", true); + + boolean result = (boolean) invokePrivate(mockedPercy, "isCaptureResponsiveDOM", new Class[]{Map.class}, options); + + assertTrue(result); + } + + @Test + public void responsiveSnapshotCaptureDisabledForDeferUploads() throws Exception { + RemoteWebDriver mockedDriver = mock(RemoteWebDriver.class); + Percy mockedPercy = spy(new Percy(mockedDriver)); + + setField(mockedPercy, "eligibleWidths", new JSONObject().put("default", 1280)); + setField( + mockedPercy, + "cliConfig", + new JSONObject() + .put("percy", new JSONObject().put("deferUploads", true)) + .put("snapshot", new JSONObject().put("responsiveSnapshotCapture", true)) + ); + + Map options = new HashMap(); + options.put("responsiveSnapshotCapture", true); + + boolean result = (boolean) invokePrivate(mockedPercy, "isCaptureResponsiveDOM", new Class[]{Map.class}, options); + + assertFalse(result); + } + + @Test + public void buildWidthsQueryParamReturnsJoinedValues() throws Exception { + RemoteWebDriver mockedDriver = mock(RemoteWebDriver.class); + Percy mockedPercy = spy(new Percy(mockedDriver)); + + String result = (String) invokePrivate( + mockedPercy, + "buildWidthsQueryParam", + new Class[]{List.class}, + Arrays.asList(375, 1280) + ); + + assertEquals("?widths=375,1280", result); + } + + @Test + public void buildWidthsQueryParamReturnsEmptyForNullOrEmptyInput() throws Exception { + RemoteWebDriver mockedDriver = mock(RemoteWebDriver.class); + Percy mockedPercy = spy(new Percy(mockedDriver)); + + String nullResult = (String) invokePrivate( + mockedPercy, + "buildWidthsQueryParam", + new Class[]{List.class}, + new Object[]{null} + ); + String emptyResult = (String) invokePrivate( + mockedPercy, + "buildWidthsQueryParam", + new Class[]{List.class}, + Collections.emptyList() + ); + + assertEquals("", nullResult); + assertEquals("", emptyResult); + } + + @Test + public void buildRequestConfigUsesProvidedTimeout() throws Exception { + RemoteWebDriver mockedDriver = mock(RemoteWebDriver.class); + Percy mockedPercy = spy(new Percy(mockedDriver)); + + RequestConfig requestConfig = (RequestConfig) invokePrivate( + mockedPercy, + "buildRequestConfig", + new Class[]{int.class}, + 12345 + ); + + assertEquals(12345, requestConfig.getSocketTimeout()); + assertEquals(12345, requestConfig.getConnectTimeout()); + } + + @Test + public void fetchWidthsConfigResponseReturnsHttp200Response() throws Exception { + HttpServer server = HttpServer.create(new InetSocketAddress(0), 0); + server.createContext("/percy/widths-config", new HttpHandler() { + @Override + public void handle(HttpExchange exchange) throws IOException { + byte[] body = "{\"widths\":[{\"width\":375}]}".getBytes("UTF-8"); + exchange.sendResponseHeaders(HttpURLConnection.HTTP_OK, body.length); + try (OutputStream os = exchange.getResponseBody()) { + os.write(body); + } + } + }); + server.start(); + + String originalAddress = getStaticStringField(Percy.class, "PERCY_SERVER_ADDRESS"); + try (CloseableHttpClient httpClient = HttpClients.createDefault()) { + setStaticField(Percy.class, "PERCY_SERVER_ADDRESS", "http://localhost:" + server.getAddress().getPort()); + RemoteWebDriver mockedDriver = mock(RemoteWebDriver.class); + Percy mockedPercy = spy(new Percy(mockedDriver)); + + HttpResponse response = (HttpResponse) invokePrivate( + mockedPercy, + "fetchWidthsConfigResponse", + new Class[]{CloseableHttpClient.class, String.class}, + httpClient, + "?widths=375" + ); + + assertEquals(HttpURLConnection.HTTP_OK, response.getStatusLine().getStatusCode()); + } finally { + setStaticField(Percy.class, "PERCY_SERVER_ADDRESS", originalAddress); + server.stop(0); + } + } + + @Test + public void parseWidthsConfigResponseParsesWidthAndHeightValues() throws Exception { + HttpServer server = HttpServer.create(new InetSocketAddress(0), 0); + server.createContext("/percy/widths-config", new HttpHandler() { + @Override + public void handle(HttpExchange exchange) throws IOException { + byte[] body = "{\"widths\":[{\"width\":375},{\"width\":1280,\"height\":900}]}".getBytes("UTF-8"); + exchange.sendResponseHeaders(HttpURLConnection.HTTP_OK, body.length); + try (OutputStream os = exchange.getResponseBody()) { + os.write(body); + } + } + }); + server.start(); + + String originalAddress = getStaticStringField(Percy.class, "PERCY_SERVER_ADDRESS"); + try (CloseableHttpClient httpClient = HttpClients.createDefault()) { + setStaticField(Percy.class, "PERCY_SERVER_ADDRESS", "http://localhost:" + server.getAddress().getPort()); + RemoteWebDriver mockedDriver = mock(RemoteWebDriver.class); + Percy mockedPercy = spy(new Percy(mockedDriver)); + + HttpResponse response = (HttpResponse) invokePrivate( + mockedPercy, + "fetchWidthsConfigResponse", + new Class[]{CloseableHttpClient.class, String.class}, + httpClient, + "" + ); + + @SuppressWarnings("unchecked") + List> parsed = (List>) invokePrivate( + mockedPercy, + "parseWidthsConfigResponse", + new Class[]{HttpResponse.class}, + response + ); + + assertEquals(2, parsed.size()); + assertEquals(375, parsed.get(0).get("width")); + assertEquals(1280, parsed.get(1).get("width")); + assertEquals(900, parsed.get(1).get("height")); + } finally { + setStaticField(Percy.class, "PERCY_SERVER_ADDRESS", originalAddress); + server.stop(0); + } + } + + @Test + public void resolveConfiguredMinHeightUsesOptionsAndCliFallback() throws Exception { + RemoteWebDriver mockedDriver = mock(RemoteWebDriver.class); + Percy mockedPercy = spy(new Percy(mockedDriver)); + + Map optionsWithValue = new HashMap(); + optionsWithValue.put("minHeight", "1200"); + Integer fromOptions = (Integer) invokePrivate( + mockedPercy, + "resolveConfiguredMinHeight", + new Class[]{Map.class}, + optionsWithValue + ); + assertEquals(1200, fromOptions); + + setField(mockedPercy, "cliConfig", new JSONObject().put("snapshot", new JSONObject().put("minHeight", 900))); + Map optionsWithoutValue = new HashMap(); + Integer fromCliConfig = (Integer) invokePrivate( + mockedPercy, + "resolveConfiguredMinHeight", + new Class[]{Map.class}, + optionsWithoutValue + ); + assertEquals(900, fromCliConfig); + } + + @Test + public void resolveConfiguredMinHeightReturnsNullForInvalidValue() throws Exception { + RemoteWebDriver mockedDriver = mock(RemoteWebDriver.class); + Percy mockedPercy = spy(new Percy(mockedDriver)); + + Map options = new HashMap(); + options.put("minHeight", "invalid"); + + Integer result = (Integer) invokePrivate( + mockedPercy, + "resolveConfiguredMinHeight", + new Class[]{Map.class}, + options + ); + + assertNull(result); + } + + @Test + public void resolveResponsiveTargetHeightRespectsFeatureFlagAndMinHeight() throws Exception { + RemoteWebDriver mockedDriver = mock(RemoteWebDriver.class); + Percy mockedPercy = spy(new Percy(mockedDriver)); + + boolean originalFlag = getStaticBooleanField(Percy.class, "PERCY_RESPONSIVE_CAPTURE_MIN_HEIGHT"); + try { + setStaticField(Percy.class, "PERCY_RESPONSIVE_CAPTURE_MIN_HEIGHT", false); + int disabledResult = (int) invokePrivate( + mockedPercy, + "resolveResponsiveTargetHeight", + new Class[]{Map.class, int.class}, + new HashMap(), + 800 + ); + assertEquals(800, disabledResult); + + setStaticField(Percy.class, "PERCY_RESPONSIVE_CAPTURE_MIN_HEIGHT", true); + Map options = new HashMap(); + options.put("minHeight", 1200); + int enabledResult = (int) invokePrivate( + mockedPercy, + "resolveResponsiveTargetHeight", + new Class[]{Map.class, int.class}, + options, + 800 + ); + assertEquals(1200, enabledResult); + } finally { + setStaticField(Percy.class, "PERCY_RESPONSIVE_CAPTURE_MIN_HEIGHT", originalFlag); + } + } + + @Test + public void getResponsiveWidthsParsesQueryAndResponse() throws Exception { + AtomicReference queryRef = new AtomicReference(null); + HttpServer server = HttpServer.create(new InetSocketAddress(0), 0); + server.createContext("/percy/widths-config", new HttpHandler() { + @Override + public void handle(HttpExchange exchange) throws IOException { + queryRef.set(exchange.getRequestURI().getQuery()); + byte[] body = "{\"widths\":[{\"width\":375},{\"width\":1280,\"height\":900}]}".getBytes("UTF-8"); + exchange.sendResponseHeaders(HttpURLConnection.HTTP_OK, body.length); + try (OutputStream os = exchange.getResponseBody()) { + os.write(body); + } + } + }); + server.start(); + + String originalAddress = getStaticStringField(Percy.class, "PERCY_SERVER_ADDRESS"); + try { + setStaticField(Percy.class, "PERCY_SERVER_ADDRESS", "http://localhost:" + server.getAddress().getPort()); + RemoteWebDriver mockedDriver = mock(RemoteWebDriver.class); + Percy mockedPercy = spy(new Percy(mockedDriver)); + + @SuppressWarnings("unchecked") + List> widths = (List>) invokePrivate( + mockedPercy, + "getResponsiveWidths", + new Class[]{List.class}, + Arrays.asList(375, 1280) + ); + + assertEquals("widths=375,1280", queryRef.get()); + assertEquals(2, widths.size()); + assertEquals(375, widths.get(0).get("width")); + assertEquals(1280, widths.get(1).get("width")); + assertEquals(900, widths.get(1).get("height")); + } finally { + setStaticField(Percy.class, "PERCY_SERVER_ADDRESS", originalAddress); + server.stop(0); + } + } + + @Test + public void capturesCrossOriginIframeDataInSerializedDom() throws Exception { + RemoteWebDriver mockedDriver = mock(RemoteWebDriver.class); + Percy mockedPercy = spy(new Percy(mockedDriver)); + + setField(mockedPercy, "domJs", "window.PercyDOM = window.PercyDOM || {};"); + + WebElement iframe = mock(WebElement.class); + when(iframe.getAttribute("src")).thenReturn("https://cdn.other.com/frame"); + when(iframe.getAttribute("data-percy-element-id")).thenReturn("frame-123"); + + when(mockedDriver.getCurrentUrl()).thenReturn("https://app.example.com/page"); + when(mockedDriver.findElements(By.tagName("iframe"))).thenReturn(Collections.singletonList(iframe)); + + TargetLocator targetLocator = mock(TargetLocator.class); + when(mockedDriver.switchTo()).thenReturn(targetLocator); + when(targetLocator.frame(iframe)).thenReturn(mockedDriver); + when(targetLocator.defaultContent()).thenReturn(mockedDriver); + + Map mainSnapshot = new HashMap(); + mainSnapshot.put("dom", "main"); + Map iframeSnapshot = new HashMap(); + iframeSnapshot.put("dom", "iframe"); + + when(((JavascriptExecutor) mockedDriver).executeScript(any(String.class))).thenAnswer(invocation -> { + String script = invocation.getArgument(0); + if (script.startsWith("return PercyDOM.serialize(")) { + if (script.contains("\"enableJavaScript\":true")) { + return iframeSnapshot; + } + return mainSnapshot; + } + return null; + }); + + @SuppressWarnings("unchecked") + Map serialized = (Map) invokePrivate( + mockedPercy, + "getSerializedDOM", + new Class[]{JavascriptExecutor.class, Set.class, Map.class}, + mockedDriver, + new HashSet(), + new HashMap() + ); + + assertTrue(serialized.containsKey("cookies")); + assertTrue(serialized.containsKey("corsIframes")); + + @SuppressWarnings("unchecked") + List> corsIframes = (List>) serialized.get("corsIframes"); + assertEquals(1, corsIframes.size()); + + Map frameData = corsIframes.get(0); + assertEquals("https://cdn.other.com/frame", frameData.get("frameUrl")); + + @SuppressWarnings("unchecked") + Map iframeData = (Map) frameData.get("iframeData"); + assertEquals("frame-123", iframeData.get("percyElementId")); + assertEquals("iframe", ((Map) frameData.get("iframeSnapshot")).get("dom")); + } + + @Test + public void getResponsiveWidthsThrowsForNon200Response() throws Exception { + HttpServer server = HttpServer.create(new InetSocketAddress(0), 0); + server.createContext("/percy/widths-config", new HttpHandler() { + @Override + public void handle(HttpExchange exchange) throws IOException { + byte[] body = "{}".getBytes("UTF-8"); + exchange.sendResponseHeaders(HttpURLConnection.HTTP_INTERNAL_ERROR, body.length); + try (OutputStream os = exchange.getResponseBody()) { + os.write(body); + } + } + }); + server.start(); + + String originalAddress = getStaticStringField(Percy.class, "PERCY_SERVER_ADDRESS"); + try { + setStaticField(Percy.class, "PERCY_SERVER_ADDRESS", "http://localhost:" + server.getAddress().getPort()); + RemoteWebDriver mockedDriver = mock(RemoteWebDriver.class); + Percy mockedPercy = spy(new Percy(mockedDriver)); + + InvocationTargetException exception = assertThrows( + InvocationTargetException.class, + () -> invokePrivate(mockedPercy, "getResponsiveWidths", new Class[]{List.class}, Arrays.asList(375, 1280)) + ); + assertNotNull(exception.getCause()); + assertTrue(exception.getCause() instanceof RuntimeException); + assertTrue(exception.getCause().getMessage().contains("Failed to fetch widths-config (HTTP 500)")); + } finally { + setStaticField(Percy.class, "PERCY_SERVER_ADDRESS", originalAddress); + server.stop(0); + } + } + + @Test + public void getResponsiveWidthsThrowsWhenWidthsKeyMissing() throws Exception { + HttpServer server = HttpServer.create(new InetSocketAddress(0), 0); + server.createContext("/percy/widths-config", new HttpHandler() { + @Override + public void handle(HttpExchange exchange) throws IOException { + byte[] body = "{}".getBytes("UTF-8"); + exchange.sendResponseHeaders(HttpURLConnection.HTTP_OK, body.length); + try (OutputStream os = exchange.getResponseBody()) { + os.write(body); + } + } + }); + server.start(); + + String originalAddress = getStaticStringField(Percy.class, "PERCY_SERVER_ADDRESS"); + try { + setStaticField(Percy.class, "PERCY_SERVER_ADDRESS", "http://localhost:" + server.getAddress().getPort()); + RemoteWebDriver mockedDriver = mock(RemoteWebDriver.class); + Percy mockedPercy = spy(new Percy(mockedDriver)); + + InvocationTargetException exception = assertThrows( + InvocationTargetException.class, + () -> invokePrivate(mockedPercy, "getResponsiveWidths", new Class[]{List.class}, Arrays.asList(375, 1280)) + ); + assertNotNull(exception.getCause()); + assertTrue(exception.getCause() instanceof RuntimeException); + assertTrue(exception.getCause().getMessage().contains("Missing \"widths\" in widths-config response")); + } finally { + setStaticField(Percy.class, "PERCY_SERVER_ADDRESS", originalAddress); + server.stop(0); + } + } + + @Test + public void responsiveSnapshotCaptureIsFalseWhenEligibleWidthsMissing() throws Exception { + RemoteWebDriver mockedDriver = mock(RemoteWebDriver.class); + Percy mockedPercy = spy(new Percy(mockedDriver)); + + setField(mockedPercy, "eligibleWidths", null); + setField(mockedPercy, "cliConfig", new JSONObject().put("snapshot", new JSONObject().put("responsiveSnapshotCapture", true))); + + Map options = new HashMap(); + options.put("responsiveSnapshotCapture", true); + + boolean result = (boolean) invokePrivate(mockedPercy, "isCaptureResponsiveDOM", new Class[]{Map.class}, options); + assertFalse(result); + } + + @Test + public void skipsUnsupportedIframeSrcInSerializedDom() throws Exception { + RemoteWebDriver mockedDriver = mock(RemoteWebDriver.class); + Percy mockedPercy = spy(new Percy(mockedDriver)); + + setField(mockedPercy, "domJs", "window.PercyDOM = window.PercyDOM || {};"); + + WebElement iframe = mock(WebElement.class); + when(iframe.getAttribute("src")).thenReturn("about:blank"); + + when(mockedDriver.getCurrentUrl()).thenReturn("https://app.example.com/page"); + when(mockedDriver.findElements(By.tagName("iframe"))).thenReturn(Collections.singletonList(iframe)); + + Map mainSnapshot = new HashMap(); + mainSnapshot.put("dom", "main"); + + when(((JavascriptExecutor) mockedDriver).executeScript(any(String.class))).thenReturn(mainSnapshot); + + @SuppressWarnings("unchecked") + Map serialized = (Map) invokePrivate( + mockedPercy, + "getSerializedDOM", + new Class[]{JavascriptExecutor.class, Set.class, Map.class}, + mockedDriver, + new HashSet(), + new HashMap() + ); + + assertFalse(serialized.containsKey("corsIframes")); + } + + @Test + public void skipsSameOriginIframeInSerializedDom() throws Exception { + RemoteWebDriver mockedDriver = mock(RemoteWebDriver.class); + Percy mockedPercy = spy(new Percy(mockedDriver)); + + setField(mockedPercy, "domJs", "window.PercyDOM = window.PercyDOM || {};"); + + WebElement iframe = mock(WebElement.class); + when(iframe.getAttribute("src")).thenReturn("https://app.example.com/frame"); + + when(mockedDriver.getCurrentUrl()).thenReturn("https://app.example.com/page"); + when(mockedDriver.findElements(By.tagName("iframe"))).thenReturn(Collections.singletonList(iframe)); + + Map mainSnapshot = new HashMap(); + mainSnapshot.put("dom", "main"); + + when(((JavascriptExecutor) mockedDriver).executeScript(any(String.class))).thenReturn(mainSnapshot); + + @SuppressWarnings("unchecked") + Map serialized = (Map) invokePrivate( + mockedPercy, + "getSerializedDOM", + new Class[]{JavascriptExecutor.class, Set.class, Map.class}, + mockedDriver, + new HashSet(), + new HashMap() + ); + + assertFalse(serialized.containsKey("corsIframes")); + } + + @Test + public void processFrameReturnsNullWhenPercyElementIdMissing() throws Exception { + RemoteWebDriver mockedDriver = mock(RemoteWebDriver.class); + Percy mockedPercy = spy(new Percy(mockedDriver)); + + WebElement iframe = mock(WebElement.class); + when(iframe.getAttribute("src")).thenReturn("https://cdn.other.com/frame"); + when(iframe.getAttribute("data-percy-element-id")).thenReturn(null); + + Object result = invokePrivate(mockedPercy, "processFrame", new Class[]{WebElement.class, Map.class}, iframe, new HashMap()); + assertNull(result); + verify(mockedDriver, never()).switchTo(); + } + + @Test + public void takeScreenshotWithCamelCaseAliasOptions() throws Exception { + RemoteWebDriver mockedDriver = mock(RemoteWebDriver.class); + HttpCommandExecutor commandExecutor = mock(HttpCommandExecutor.class); + when(commandExecutor.getAddressOfRemoteServer()).thenReturn(new URL("https://hub-cloud.browserstack.com/wd/hub")); + + Percy mockedPercy = spy(new Percy(mockedDriver)); + setField(mockedPercy, "isPercyEnabled", true); + mockedPercy.sessionType = "automate"; + + when(mockedDriver.getSessionId()).thenReturn(new SessionId("123")); + when(mockedDriver.getCommandExecutor()).thenReturn(commandExecutor); + DesiredCapabilities capabilities = new DesiredCapabilities(); + capabilities.setCapability("browserName", "Chrome"); + when(mockedDriver.getCapabilities()).thenReturn(capabilities); + + RemoteWebElement mockedIgnoreElement = mock(RemoteWebElement.class); + RemoteWebElement mockedConsiderElement = mock(RemoteWebElement.class); + when(mockedIgnoreElement.getId()).thenReturn("ignore-123"); + when(mockedConsiderElement.getId()).thenReturn("consider-456"); + + Map options = new HashMap(); + options.put("ignoreRegionSeleniumElements", Arrays.asList(mockedIgnoreElement)); + options.put("considerRegionSeleniumElements", Arrays.asList(mockedConsiderElement)); + + mockedPercy.screenshot("Test", options); + + ArgumentCaptor requestBodyCaptor = ArgumentCaptor.forClass(JSONObject.class); + verify(mockedPercy).request(eq("/percy/automateScreenshot"), requestBodyCaptor.capture(), eq("Test")); + + JSONObject requestBody = requestBodyCaptor.getValue(); + JSONObject capturedOptions = requestBody.getJSONObject("options"); + JSONArray ignoreElements = capturedOptions.getJSONArray("ignore_region_elements"); + JSONArray considerElements = capturedOptions.getJSONArray("consider_region_elements"); + + assertEquals("ignore-123", ignoreElements.getString(0)); + assertEquals("consider-456", considerElements.getString(0)); + assertFalse(capturedOptions.has("ignoreRegionSeleniumElements")); + assertFalse(capturedOptions.has("considerRegionSeleniumElements")); + } + + @Test + public void createRegionWithIntelliignoreIncludesConfiguration() { + Map params = new HashMap(); + params.put("algorithm", "intelliignore"); + params.put("diffSensitivity", 0.3); + params.put("carouselsEnabled", true); + + Map region = percy.createRegion(params); + + assertEquals("intelliignore", region.get("algorithm")); + @SuppressWarnings("unchecked") + Map configuration = (Map) region.get("configuration"); + assertNotNull(configuration); + assertEquals(0.3, configuration.get("diffSensitivity")); + assertTrue((Boolean) configuration.get("carouselsEnabled")); + } + + @Test + public void createRegionWithIgnoreAlgorithmOmitsConfiguration() { + Map params = new HashMap(); + params.put("algorithm", "ignore"); + params.put("diffSensitivity", 0.3); + + Map region = percy.createRegion(params); + + assertEquals("ignore", region.get("algorithm")); + assertFalse(region.containsKey("configuration")); + } + @Test public void createRegionTest() { // Setup the parameters for the region @@ -254,4 +912,231 @@ public void createRegionTest() { assertNotNull(assertion); assertEquals(0.1, assertion.get("diffIgnoreThreshold")); } + + @Test + public void captureResponsiveDomResizesToCorrectWidthAndHeight() throws Exception { + // Serve two widths: one with an explicit height and one without. + HttpServer server = HttpServer.create(new InetSocketAddress(0), 0); + server.createContext("/percy/widths-config", exchange -> { + byte[] body = "{\"widths\":[{\"width\":375,\"height\":812},{\"width\":1280}]}".getBytes("UTF-8"); + exchange.sendResponseHeaders(HttpURLConnection.HTTP_OK, body.length); + try (OutputStream os = exchange.getResponseBody()) { os.write(body); } + }); + server.start(); + + String originalAddress = getStaticStringField(Percy.class, "PERCY_SERVER_ADDRESS"); + try { + setStaticField(Percy.class, "PERCY_SERVER_ADDRESS", "http://localhost:" + server.getAddress().getPort()); + + RemoteWebDriver mockedDriver = mock(RemoteWebDriver.class); + Percy mockedPercy = spy(new Percy(mockedDriver)); + setField(mockedPercy, "domJs", "/* percy dom */"); + setField(mockedPercy, "cliConfig", new JSONObject().put("snapshot", new JSONObject())); + + // Track actual setSize calls so window.resizeCount can echo the right value. + AtomicInteger dimensionChangeCount = new AtomicInteger(0); + WebDriver.Options driverOptions = mock(WebDriver.Options.class); + WebDriver.Window driverWindow = mock(WebDriver.Window.class); + when(mockedDriver.manage()).thenReturn(driverOptions); + when(driverOptions.window()).thenReturn(driverWindow); + when(driverWindow.getSize()).thenReturn(new Dimension(1024, 768)); + doAnswer(inv -> { dimensionChangeCount.incrementAndGet(); return null; }) + .when(driverWindow).setSize(any(Dimension.class)); + + when(mockedDriver.getCurrentUrl()).thenReturn("https://example.com"); + when(mockedDriver.findElements(By.tagName("iframe"))).thenReturn(Collections.emptyList()); + when(((JavascriptExecutor) mockedDriver).executeScript(any(String.class))).thenAnswer(invocation -> { + String script = invocation.getArgument(0); + if (script.equals("return window.resizeCount")) { + return (long) dimensionChangeCount.get(); + } + if (script.startsWith("return PercyDOM.serialize(")) { + Map snap = new HashMap<>(); + snap.put("dom", "test"); + return snap; + } + return null; + }); + + Map options = new HashMap<>(); + options.put("widths", Arrays.asList(375, 1280)); + List> snapshots = + mockedPercy.captureResponsiveDom(mockedDriver, new HashSet<>(), options); + + ArgumentCaptor sizeCaptor = ArgumentCaptor.forClass(Dimension.class); + // 3 calls expected: resize to 375x812, resize to 1280x768, restore 1024x768. + verify(driverWindow, times(3)).setSize(sizeCaptor.capture()); + List sizes = sizeCaptor.getAllValues(); + + // First width uses the explicit height returned by the server. + assertEquals(375, sizes.get(0).getWidth()); + assertEquals(812, sizes.get(0).getHeight()); + + // Second width has no explicit height: falls back to currentHeight (768). + assertEquals(1280, sizes.get(1).getWidth()); + assertEquals(768, sizes.get(1).getHeight()); + + // Final call restores the original window size. + assertEquals(1024, sizes.get(2).getWidth()); + assertEquals(768, sizes.get(2).getHeight()); + + // Each snapshot must carry the width it was captured at. + assertEquals(2, snapshots.size()); + assertEquals(375, snapshots.get(0).get("width")); + assertEquals(1280, snapshots.get(1).get("width")); + } finally { + setStaticField(Percy.class, "PERCY_SERVER_ADDRESS", originalAddress); + server.stop(0); + } + } + + @Test + public void captureResponsiveDomSkipsResizeWhenDimensionsUnchanged() throws Exception { + // Return the exact same width as the initial window — no per-width resize should occur. + HttpServer server = HttpServer.create(new InetSocketAddress(0), 0); + server.createContext("/percy/widths-config", exchange -> { + byte[] body = "{\"widths\":[{\"width\":1024}]}".getBytes("UTF-8"); + exchange.sendResponseHeaders(HttpURLConnection.HTTP_OK, body.length); + try (OutputStream os = exchange.getResponseBody()) { os.write(body); } + }); + server.start(); + + String originalAddress = getStaticStringField(Percy.class, "PERCY_SERVER_ADDRESS"); + try { + setStaticField(Percy.class, "PERCY_SERVER_ADDRESS", "http://localhost:" + server.getAddress().getPort()); + + RemoteWebDriver mockedDriver = mock(RemoteWebDriver.class); + Percy mockedPercy = spy(new Percy(mockedDriver)); + setField(mockedPercy, "domJs", "/* percy dom */"); + setField(mockedPercy, "cliConfig", new JSONObject().put("snapshot", new JSONObject())); + + AtomicInteger dimensionChangeCount = new AtomicInteger(0); + WebDriver.Options driverOptions = mock(WebDriver.Options.class); + WebDriver.Window driverWindow = mock(WebDriver.Window.class); + when(mockedDriver.manage()).thenReturn(driverOptions); + when(driverOptions.window()).thenReturn(driverWindow); + when(driverWindow.getSize()).thenReturn(new Dimension(1024, 768)); + doAnswer(inv -> { dimensionChangeCount.incrementAndGet(); return null; }) + .when(driverWindow).setSize(any(Dimension.class)); + + when(mockedDriver.getCurrentUrl()).thenReturn("https://example.com"); + when(mockedDriver.findElements(By.tagName("iframe"))).thenReturn(Collections.emptyList()); + when(((JavascriptExecutor) mockedDriver).executeScript(any(String.class))).thenAnswer(invocation -> { + String script = invocation.getArgument(0); + if (script.equals("return window.resizeCount")) { + return (long) dimensionChangeCount.get(); + } + if (script.startsWith("return PercyDOM.serialize(")) { + Map snap = new HashMap<>(); + snap.put("dom", "test"); + return snap; + } + return null; + }); + + Map options = new HashMap<>(); + options.put("widths", Arrays.asList(1024)); + mockedPercy.captureResponsiveDom(mockedDriver, new HashSet<>(), options); + + // Only the final restore call should fire; no per-width resize. + ArgumentCaptor sizeCaptor = ArgumentCaptor.forClass(Dimension.class); + verify(driverWindow, times(1)).setSize(sizeCaptor.capture()); + Dimension restoreSize = sizeCaptor.getValue(); + assertEquals(1024, restoreSize.getWidth()); + assertEquals(768, restoreSize.getHeight()); + } finally { + setStaticField(Percy.class, "PERCY_SERVER_ADDRESS", originalAddress); + server.stop(0); + } + } + + @Test + public void captureResponsiveDomRefreshesDriverForEachWidthWhenReloadFlagSet() throws Exception { + HttpServer server = HttpServer.create(new InetSocketAddress(0), 0); + server.createContext("/percy/widths-config", exchange -> { + byte[] body = "{\"widths\":[{\"width\":375},{\"width\":1280}]}".getBytes("UTF-8"); + exchange.sendResponseHeaders(HttpURLConnection.HTTP_OK, body.length); + try (OutputStream os = exchange.getResponseBody()) { os.write(body); } + }); + server.start(); + + String originalAddress = getStaticStringField(Percy.class, "PERCY_SERVER_ADDRESS"); + boolean originalReloadFlag = getStaticBooleanField(Percy.class, "PERCY_RESPONSIVE_CAPTURE_RELOAD_PAGE"); + try { + setStaticField(Percy.class, "PERCY_SERVER_ADDRESS", "http://localhost:" + server.getAddress().getPort()); + setStaticField(Percy.class, "PERCY_RESPONSIVE_CAPTURE_RELOAD_PAGE", true); + + RemoteWebDriver mockedDriver = mock(RemoteWebDriver.class); + Percy mockedPercy = spy(new Percy(mockedDriver)); + setField(mockedPercy, "domJs", "/* percy dom */"); + setField(mockedPercy, "cliConfig", new JSONObject().put("snapshot", new JSONObject())); + + WebDriver.Options driverOptions = mock(WebDriver.Options.class); + WebDriver.Window driverWindow = mock(WebDriver.Window.class); + WebDriver.Navigation navigation = mock(WebDriver.Navigation.class); + when(mockedDriver.manage()).thenReturn(driverOptions); + when(driverOptions.window()).thenReturn(driverWindow); + when(driverWindow.getSize()).thenReturn(new Dimension(1024, 768)); + when(mockedDriver.navigate()).thenReturn(navigation); + when(mockedDriver.getCurrentUrl()).thenReturn("https://example.com"); + when(mockedDriver.findElements(By.tagName("iframe"))).thenReturn(Collections.emptyList()); + + // After each reload resizeCount resets to 0, so the next changeWindowDimensionAndWait + // call uses resizeCount=1. Return 1L so the wait resolves without timing out. + when(((JavascriptExecutor) mockedDriver).executeScript(any(String.class))).thenAnswer(invocation -> { + String script = invocation.getArgument(0); + if (script.equals("return window.resizeCount")) { + return 1L; + } + if (script.startsWith("return PercyDOM.serialize(")) { + Map snap = new HashMap<>(); + snap.put("dom", "test"); + return snap; + } + return null; + }); + + Map options = new HashMap<>(); + options.put("widths", Arrays.asList(375, 1280)); + mockedPercy.captureResponsiveDom(mockedDriver, new HashSet<>(), options); + + // driver.navigate().refresh() must be called once per captured width. + verify(navigation, times(2)).refresh(); + } finally { + setStaticField(Percy.class, "PERCY_SERVER_ADDRESS", originalAddress); + setStaticField(Percy.class, "PERCY_RESPONSIVE_CAPTURE_RELOAD_PAGE", originalReloadFlag); + server.stop(0); + } + } + + private static Object invokePrivate(Object target, String methodName, Class[] paramTypes, Object... args) + throws Exception { + Method method = Percy.class.getDeclaredMethod(methodName, paramTypes); + method.setAccessible(true); + return method.invoke(target, args); + } + + private static void setField(Object target, String fieldName, Object value) throws Exception { + Field field = Percy.class.getDeclaredField(fieldName); + field.setAccessible(true); + field.set(target, value); + } + + private static void setStaticField(Class clazz, String fieldName, Object value) throws Exception { + Field field = clazz.getDeclaredField(fieldName); + field.setAccessible(true); + field.set(null, value); + } + + private static String getStaticStringField(Class clazz, String fieldName) throws Exception { + Field field = clazz.getDeclaredField(fieldName); + field.setAccessible(true); + return (String) field.get(null); + } + + private static boolean getStaticBooleanField(Class clazz, String fieldName) throws Exception { + Field field = clazz.getDeclaredField(fieldName); + field.setAccessible(true); + return (boolean) field.get(null); + } } diff --git a/src/test/resources/testapp/cors-iframe.html b/src/test/resources/testapp/cors-iframe.html new file mode 100644 index 0000000..f42e06b --- /dev/null +++ b/src/test/resources/testapp/cors-iframe.html @@ -0,0 +1,16 @@ + + + + + CORS Iframe Test + + + +

Page with cross-origin iframe

+

The iframe below loads an external origin and is used to test Percy CORS iframe capture.

+ + +