de.ppi.selenium.util

Class ScreenshotUtils

java.lang.Object

de.ppi.selenium.util.ScreenshotUtils

public final class ScreenshotUtils
extends java.lang.Object

Utilities to take and compare screenshots of elements Based on JTafExtWebdriver.

Method Summary

Modifier and Type	Method and Description
static boolean	isSimilarToScreenshot(org.openqa.selenium.WebDriver wd, org.openqa.selenium.WebElement element, java.io.File controlPicture, java.io.File toSaveAs) Prereq: The page on which you are taking the screenshot is fully loaded Take a screenshot of the element identified by element and save the file as toSaveAs (Note that this file should be saved as a png).
static boolean	isSimilarToScreenshot(org.openqa.selenium.WebDriver wd, org.openqa.selenium.WebElement element, java.io.File controlPicture, java.io.File toSaveAs, double threshold) Prereq: The page on which you are taking the screenshot is fully loaded Take a screenshot of the element identified by element and save the file as toSaveAs (Note that this file should be saved as a png).
static void	saveScreenshot(java.lang.String screenshotFileName, org.openqa.selenium.WebDriver driver) Save a screenshot.
static void	takeScreenshotOfElement(org.openqa.selenium.WebElement element, java.io.File toSaveAs, org.openqa.selenium.WebDriver wd) You can use this method to take your control pictures.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

saveScreenshot

public static void saveScreenshot(java.lang.String screenshotFileName,
                                  org.openqa.selenium.WebDriver driver)

Save a screenshot.

Parameters:

screenshotFileName - name of the file, without ending.

driver - the webdriver.

takeScreenshotOfElement

public static void takeScreenshotOfElement(org.openqa.selenium.WebElement element,
                                           java.io.File toSaveAs,
                                           org.openqa.selenium.WebDriver wd)
                                    throws java.io.IOException

You can use this method to take your control pictures. Note that the file should be a png.

Parameters:

element - the webelement

toSaveAs - the file where the screenshot should be save.

wd - the webdriver.

Throws:

java.io.IOException - if something goes wrong writing the result.

isSimilarToScreenshot

public static boolean isSimilarToScreenshot(org.openqa.selenium.WebDriver wd,
                                            org.openqa.selenium.WebElement element,
                                            java.io.File controlPicture,
                                            java.io.File toSaveAs,
                                            double threshold)
                                     throws java.io.IOException

Prereq: The page on which you are taking the screenshot is fully loaded Take a screenshot of the element identified by element and save the file as toSaveAs (Note that this file should be saved as a png). Test that the control picture, controlPicture, is both the same size as, and, has a similarity value greater than or equal to the threshold.

Parameters:

wd - the webdriver.

element - - the element to be tested

controlPicture - - the file of the picture that will serve as the control

toSaveAs - - for example, save the file at "testData/textFieldWidget/screenshot.png"

threshold - - you are asserting that the similarity between the two pictures is a double greater than or equal to this double (between 0.0 and 1.0)

Returns:

true is the pictures are similar.

Throws:

java.io.IOException - if something goes wrong writing or reading.

isSimilarToScreenshot

public static boolean isSimilarToScreenshot(org.openqa.selenium.WebDriver wd,
                                            org.openqa.selenium.WebElement element,
                                            java.io.File controlPicture,
                                            java.io.File toSaveAs)
                                     throws java.io.IOException

Prereq: The page on which you are taking the screenshot is fully loaded Take a screenshot of the element identified by element and save the file as toSaveAs (Note that this file should be saved as a png). Test that the control picture, controlPicture, is both the same size as, and, has a similarity value greater than or equal to the default threshold of .85.

Parameters:

wd - the webdriver.

element - - the element to be tested

controlPicture - - the file of the picture that will serve as the control

toSaveAs - - for example, save the file at "testData/textFieldWidget/screenshot.png"

Returns:

true if the screenshots are similar.

Throws:

java.io.IOException - if something goes wrong reading or writing.