-
-
Notifications
You must be signed in to change notification settings - Fork 8.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[java] add full page screenshot feature for Firefox (#7295)
Add FirefoxDriver calling /session/{session id}/moz/screenshot/full- Loading branch information
Showing
4 changed files
with
309 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,7 @@ | ||
| * { | ||
| margin: 0; | ||
| } | ||
| html, body, #output { | ||
| #output { | ||
| width: 100%; | ||
| height: 100%; | ||
| } | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
277 changes: 277 additions & 0 deletions
277
java/client/test/org/openqa/selenium/firefox/TakesFullPageScreenshotTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,277 @@ | ||
| // Licensed to the Software Freedom Conservancy (SFC) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The SFC licenses this file | ||
| // to you under the Apache License, Version 2.0 (the | ||
| // "License"); you may not use this file except in compliance | ||
| // with the License. You may obtain a copy of the License at | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // Unless required by applicable law or agreed to in writing, | ||
| // software distributed under the License is distributed on an | ||
| // "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| // KIND, either express or implied. See the License for the | ||
| // specific language governing permissions and limitations | ||
| // under the License. | ||
|
|
||
| package org.openqa.selenium.firefox; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
| import static org.junit.Assert.fail; | ||
| import static org.junit.Assume.assumeTrue; | ||
|
|
||
| import com.google.common.collect.Sets; | ||
|
|
||
| import org.junit.After; | ||
| import org.junit.Before; | ||
| import org.junit.Test; | ||
| import org.openqa.selenium.OutputType; | ||
| import org.openqa.selenium.testing.JUnit4TestBase; | ||
|
|
||
| import java.awt.image.BufferedImage; | ||
| import java.awt.image.Raster; | ||
| import java.io.ByteArrayInputStream; | ||
| import java.io.File; | ||
| import java.io.IOException; | ||
| import java.util.Set; | ||
| import java.util.TreeSet; | ||
|
|
||
| import javax.imageio.ImageIO; | ||
|
|
||
| /** | ||
| * Test screenshot feature. | ||
| * | ||
| * 1. check output for all possible types | ||
| * | ||
| * 2. check screenshot image | ||
| * | ||
| * Logic of screenshot check test is simple: | ||
| * - open page with fixed amount of fixed sized and coloured areas | ||
| * - take screenshot | ||
| * - calculate expected colors as in tested HTML page | ||
| * - scan screenshot for actual colors * compare | ||
| * | ||
| * @see org.openqa.selenium.TakesScreenshotTest | ||
| * | ||
| */ | ||
|
|
||
| // TODO(user): verify expected behaviour after frame switching | ||
|
|
||
| // TODO(user): test screenshots at guaranteed maximized browsers | ||
| // TODO(user): test screenshots at guaranteed non maximized browsers | ||
| // TODO(user): test screenshots at guaranteed minimized browsers | ||
| // TODO(user): test screenshots at guaranteed fullscreened/kiosked browsers (WINDOWS platform specific) | ||
|
|
||
| public class TakesFullPageScreenshotTest extends JUnit4TestBase { | ||
|
|
||
| private FirefoxDriver screenshooter; | ||
| private File tempFile = null; | ||
|
|
||
| @Before | ||
| public void setUp() { | ||
| assumeTrue(driver instanceof FirefoxDriver); | ||
| screenshooter = (FirefoxDriver) driver; | ||
| } | ||
|
|
||
| @After | ||
| public void tearDown() { | ||
| if (tempFile != null) { | ||
| tempFile.delete(); | ||
| tempFile = null; | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| public void testGetScreenshotAsFile() { | ||
| driver.get(pages.simpleTestPage); | ||
| tempFile = screenshooter.getFullPageScreenshotAs(OutputType.FILE); | ||
| assertThat(tempFile.exists()).isTrue(); | ||
| assertThat(tempFile.length()).isGreaterThan(0); | ||
| } | ||
|
|
||
| @Test | ||
| public void testGetScreenshotAsBase64() { | ||
| driver.get(pages.simpleTestPage); | ||
| String screenshot = screenshooter.getFullPageScreenshotAs(OutputType.BASE64); | ||
| assertThat(screenshot.length()).isGreaterThan(0); | ||
| } | ||
|
|
||
| @Test | ||
| public void testGetScreenshotAsBinary() { | ||
| driver.get(pages.simpleTestPage); | ||
| byte[] screenshot = screenshooter.getFullPageScreenshotAs(OutputType.BYTES); | ||
| assertThat(screenshot.length).isGreaterThan(0); | ||
| } | ||
|
|
||
| @Test | ||
| public void testShouldCaptureScreenshotOfCurrentViewport() { | ||
| driver.get(appServer.whereIs("screen/screen.html")); | ||
|
|
||
| BufferedImage screenshot = getImage(); | ||
|
|
||
| Set<String> actualColors = scanActualColors(screenshot, | ||
| /* stepX in pixels */ 5, | ||
| /* stepY in pixels */ 5); | ||
|
|
||
| Set<String> expectedColors = generateExpectedColors( /* initial color */ 0x0F0F0F, | ||
| /* color step */ 1000, | ||
| /* grid X size */ 6, | ||
| /* grid Y size */ 6); | ||
|
|
||
| compareColors(expectedColors, actualColors); | ||
| } | ||
|
|
||
| @Test | ||
| public void testShouldCaptureScreenshotOfPageWithLongY() { | ||
| driver.get(appServer.whereIs("screen/screen_y_long.html")); | ||
|
|
||
| BufferedImage screenshot = getImage(); | ||
|
|
||
| Set<String> actualColors = scanActualColors(screenshot, | ||
| /* stepX in pixels */ 5, | ||
| /* stepY in pixels */ 50); | ||
|
|
||
| Set<String> expectedColors = generateExpectedColors( /* initial color */ 0x0F0F0F, | ||
| /* color step*/ 1000, | ||
| /* grid X size */ 6, | ||
| /* grid Y size */ 6); | ||
|
|
||
| compareColors(expectedColors, actualColors); | ||
| } | ||
|
|
||
| /** | ||
| * get actual image screenshot | ||
| * | ||
| * @return Image object | ||
| */ | ||
| private BufferedImage getImage() { | ||
| BufferedImage image = null; | ||
| try { | ||
| byte[] imageData = screenshooter.getFullPageScreenshotAs(OutputType.BYTES); | ||
| assertThat(imageData).isNotNull(); | ||
| assertThat(imageData.length).isGreaterThan(0); | ||
| image = ImageIO.read(new ByteArrayInputStream(imageData)); | ||
| assertThat(image).isNotNull(); | ||
| } catch (IOException e) { | ||
| fail("Image screenshot file is invalid: " + e.getMessage()); | ||
| } | ||
|
|
||
| //saveImageToTmpFile(image); | ||
| return image; | ||
| } | ||
|
|
||
| /** | ||
| * generate expected colors as in checked page. | ||
| * | ||
| * @param initialColor - initial color of first (right top) cell of grid | ||
| * @param stepColor - step b/w grid colors as number | ||
| * @param nX - grid size at X dimension | ||
| * @param nY - grid size at Y dimension | ||
| * @return set of colors in string hex presentation | ||
| */ | ||
| private Set<String> generateExpectedColors(final int initialColor, final int stepColor, | ||
| final int nX, final int nY) { | ||
| Set<String> colors = new TreeSet<>(); | ||
| int cnt = 1; | ||
| for (int i = 1; i < nX; i++) { | ||
| for (int j = 1; j < nY; j++) { | ||
| int color = initialColor + (cnt * stepColor); | ||
| String hex = | ||
| String.format("#%02x%02x%02x", ((color & 0xFF0000) >> 16), ((color & 0x00FF00) >> 8), | ||
| ((color & 0x0000FF))); | ||
| colors.add(hex); | ||
| cnt++; | ||
| } | ||
| } | ||
|
|
||
| return colors; | ||
| } | ||
|
|
||
| /** | ||
| * Get colors from image from each point at grid defined by stepX/stepY. | ||
| * | ||
| * @param image - image | ||
| * @param stepX - interval in pixels b/w point in X dimension | ||
| * @param stepY - interval in pixels b/w point in Y dimension | ||
| * @return set of colors in string hex presentation | ||
| */ | ||
| private Set<String> scanActualColors(BufferedImage image, final int stepX, final int stepY) { | ||
| Set<String> colors = new TreeSet<>(); | ||
|
|
||
| try { | ||
| int height = image.getHeight(); | ||
| int width = image.getWidth(); | ||
| assertThat(width > 0).isTrue(); | ||
| assertThat(height > 0).isTrue(); | ||
|
|
||
| Raster raster = image.getRaster(); | ||
| for (int i = 0; i < width; i = i + stepX) { | ||
| for (int j = 0; j < height; j = j + stepY) { | ||
| String hex = String.format("#%02x%02x%02x", | ||
| (raster.getSample(i, j, 0)), | ||
| (raster.getSample(i, j, 1)), | ||
| (raster.getSample(i, j, 2))); | ||
| colors.add(hex); | ||
| } | ||
| } | ||
| } catch (Exception e) { | ||
| fail("Unable to get actual colors from screenshot: " + e.getMessage()); | ||
| } | ||
|
|
||
| assertThat(colors).isNotEmpty(); | ||
|
|
||
| return colors; | ||
| } | ||
|
|
||
| /** | ||
| * Compares sets of colors are same. | ||
| * | ||
| * @param expectedColors - set of expected colors | ||
| * @param actualColors - set of actual colors | ||
| */ | ||
| private void compareColors(Set<String> expectedColors, Set<String> actualColors) { | ||
| assertThat(onlyBlack(actualColors)).as("Only black").isFalse(); | ||
| assertThat(onlyWhite(actualColors)).as("Only white").isFalse(); | ||
|
|
||
| // Ignore black and white for further comparison | ||
| Set<String> cleanActualColors = Sets.newHashSet(actualColors); | ||
| cleanActualColors.remove("#000000"); | ||
| cleanActualColors.remove("#ffffff"); | ||
|
|
||
| if (! expectedColors.containsAll(cleanActualColors)) { | ||
| fail("There are unexpected colors on the screenshot: " + | ||
| Sets.difference(cleanActualColors, expectedColors)); | ||
| } | ||
|
|
||
| if (! cleanActualColors.containsAll(expectedColors)) { | ||
| fail("There are expected colors not present on the screenshot: " + | ||
| Sets.difference(expectedColors, cleanActualColors)); | ||
| } | ||
| } | ||
|
|
||
| private boolean onlyBlack(Set<String> colors) { | ||
| return colors.size() == 1 && "#000000".equals(colors.toArray()[0]); | ||
| } | ||
|
|
||
| private boolean onlyWhite(Set<String> colors) { | ||
| return colors.size() == 1 && "#ffffff".equals(colors.toArray()[0]); | ||
| } | ||
|
|
||
| /** | ||
| * Simple helper to save screenshot to tmp file. For debug purposes. | ||
| * | ||
| * @param im image | ||
| */ | ||
| @SuppressWarnings("unused") | ||
| private void saveImageToTmpFile(BufferedImage im) { | ||
|
|
||
| File outputfile = new File( testName.getMethodName() + "_image.png"); | ||
| try { | ||
| ImageIO.write(im, "png", outputfile); | ||
| } catch (IOException e) { | ||
| fail("Unable to write image to file: " + e.getMessage()); | ||
| } | ||
| } | ||
|
|
||
| } |