com.applitools.eyes.EyesWebDriver Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of eyes-selenium-java Show documentation
Show all versions of eyes-selenium-java Show documentation
Applitools Eyes SDK for Selenium Java WebDriver
package com.applitools.eyes;
import com.applitools.utils.ArgumentGuard;
import com.applitools.utils.EyesSeleniumUtils;
import com.applitools.utils.ImageUtils;
import org.openqa.selenium.*;
import org.openqa.selenium.interactions.*;
import org.openqa.selenium.internal.*;
import org.openqa.selenium.remote.*;
import java.awt.image.BufferedImage;
import java.util.*;
/**
* An Eyes implementation of the interfaces implemented by
* {@link org.openqa.selenium.remote.RemoteWebDriver}.
* Used so we'll be able to return the users an object with the same
* functionality as {@link org.openqa.selenium.remote.RemoteWebDriver}.
*/
public class EyesWebDriver implements HasCapabilities, HasInputDevices,
FindsByClassName, FindsByCssSelector, FindsById, FindsByLinkText,
FindsByName, FindsByTagName, FindsByXPath, JavascriptExecutor,
SearchContext, TakesScreenshot, WebDriver, HasTouchScreen {
private final Logger logger;
private final Eyes eyes;
private final RemoteWebDriver driver;
private final TouchScreen touch;
private final Map elementsIds;
private final FrameChain frameChain;
private ImageRotation rotation;
private RectangleSize defaultContentViewportSize;
/**
* Rotates the image as necessary. The rotation is either manually forced
* by passing a non-null ImageRotation, or automatically inferred.
*
* @param driver The underlying driver which produced the screenshot.
* @param image The image to normalize.
* @param rotation The degrees by which to rotate the image:
* positive values = clockwise rotation,
* negative values = counter-clockwise,
* 0 = force no rotation, null = rotate automatically
* when needed.
* @return A normalized image.
*/
public static BufferedImage normalizeRotation(Logger logger,
WebDriver driver,
BufferedImage image,
ImageRotation rotation) {
ArgumentGuard.notNull(driver, "driver");
ArgumentGuard.notNull(image, "image");
BufferedImage normalizedImage = image;
if (rotation != null) {
if (rotation.getRotation() != 0) {
normalizedImage = ImageUtils.rotateImage(image,
rotation.getRotation());
}
} else { // Do automatic rotation if necessary
try {
logger.verbose("Trying to automatically normalize rotation...");
if (EyesSeleniumUtils.isMobileDevice(driver) &&
EyesSeleniumUtils.isLandscapeOrientation(driver)
&& image.getHeight() > image.getWidth()) {
// For Android, we need to rotate images to the right, and
// for iOS to the left.
int degrees =
EyesSeleniumUtils.isAndroid(driver) ? 90 : -90;
normalizedImage = ImageUtils.rotateImage(image, degrees);
}
} catch (Exception e) {
logger.verbose("Got exception: " + e.getMessage());
logger.verbose("Skipped automatic rotation handling.");
}
}
return normalizedImage;
}
public EyesWebDriver(Logger logger, Eyes eyes, RemoteWebDriver driver)
throws EyesException {
ArgumentGuard.notNull(logger, "logger");
ArgumentGuard.notNull(eyes, "eyes");
ArgumentGuard.notNull(driver, "driver");
this.logger = logger;
this.eyes = eyes;
this.driver = driver;
elementsIds = new HashMap();
this.frameChain = new FrameChain(logger);
defaultContentViewportSize = null;
// initializing "touch" if possible
ExecuteMethod executeMethod = null;
try {
executeMethod = new RemoteExecuteMethod(driver);
} catch (Exception e) {
// If an exception occurred, we simply won't instantiate "touch".
}
if (null != executeMethod) {
touch = new EyesTouchScreen(logger, this,
new RemoteTouchScreen(executeMethod));
} else {
touch = null;
}
logger.verbose("Driver session is " + getSessionId());
}
public Eyes getEyes() {
return eyes;
}
@SuppressWarnings("UnusedDeclaration")
public RemoteWebDriver getRemoteWebDriver() {
return driver;
}
public TouchScreen getTouch() {
return touch;
}
@SuppressWarnings("unused")
/**
*
* @return The image rotation data.
*/
public ImageRotation getRotation() {
return rotation;
}
/**
*
* @param rotation The image rotation data.
*/
public void setRotation(ImageRotation rotation) {
this.rotation = rotation;
}
public void get(String s) {
frameChain.clear();
driver.get(s);
}
public String getCurrentUrl() {
return driver.getCurrentUrl();
}
public String getTitle() {
return driver.getTitle();
}
public List findElements(By by) {
List foundWebElementsList = driver.findElements(by);
// This list will contain the found elements wrapped with our class.
List resultElementsList =
new ArrayList(foundWebElementsList.size());
for (WebElement currentElement : foundWebElementsList) {
if (currentElement instanceof RemoteWebElement) {
resultElementsList.add(new EyesRemoteWebElement(logger, this,
(RemoteWebElement) currentElement));
// For Remote web elements, we can keep the IDs
elementsIds.put(((RemoteWebElement) currentElement).getId(),
currentElement);
} else {
throw new EyesException(String.format(
"findElements: element is not a RemoteWebElement: %s",
by));
}
}
return resultElementsList;
}
public WebElement findElement(By by) {
WebElement webElement = driver.findElement(by);
if (webElement instanceof RemoteWebElement) {
webElement = new EyesRemoteWebElement(logger, this,
(RemoteWebElement) webElement);
// For Remote web elements, we can keep the IDs,
// for Id based lookup (mainly used for Javascript related
// activities).
elementsIds.put(((RemoteWebElement) webElement).getId(),
webElement);
} else {
throw new EyesException(String.format(
"findElement: Element is not a RemoteWebElement: %s", by));
}
return webElement;
}
/**
* Found elements are sometimes accessed by their IDs (e.g. tapping an
* element in Appium).
* @return Maps of IDs for found elements.
*/
@SuppressWarnings("UnusedDeclaration")
public Map getElementIds () {
return elementsIds;
}
public String getPageSource() {
return driver.getPageSource();
}
public void close() {
driver.close();
}
public void quit() {
driver.quit();
}
public Set getWindowHandles() {
return driver.getWindowHandles();
}
public String getWindowHandle() {
return driver.getWindowHandle();
}
public TargetLocator switchTo() {
logger.verbose("switchTo()");
return new EyesTargetLocator(logger, this, driver.switchTo(),
new EyesTargetLocator.OnWillSwitch() {
public void willSwitchToFrame(
EyesTargetLocator.TargetType targetType,
WebElement targetFrame) {
logger.verbose("willSwitchToFrame()");
switch(targetType) {
case DEFAULT_CONTENT:
logger.verbose("Default content.");
frameChain.clear();
break;
case PARENT_FRAME:
logger.verbose("Parent frame.");
frameChain.pop();
break;
default: // Switching into a frame
logger.verbose("Frame");
String frameId = ((EyesRemoteWebElement)
targetFrame).getId();
Point pl = targetFrame.getLocation();
Dimension ds = targetFrame.getSize();
// Get the frame's content location.
Location contentLocation = new
BordersAwareElementContentLocationProvider
().getLocation(logger, targetFrame,
new Location(pl.getX(), pl.getY()));
frameChain.push(new Frame(logger, targetFrame,
frameId,
contentLocation,
new RectangleSize(ds.getWidth(),
ds.getHeight()),
new ScrollPositionProvider(logger,
driver).getCurrentPosition()));
}
logger.verbose("Done!");
}
public void willSwitchToWindow(String nameOrHandle) {
logger.verbose("willSwitchToWindow()");
frameChain.clear();
logger.verbose("Done!");
}
});
}
public Navigation navigate() {
return driver.navigate();
}
public Options manage() {
return driver.manage();
}
public Mouse getMouse() {
return new EyesMouse(logger, this,
driver.getMouse());
}
public Keyboard getKeyboard() {
return new EyesKeyboard(logger, this, driver.getKeyboard());
}
public WebElement findElementByClassName(String className) {
return findElement(By.className(className));
}
public List findElementsByClassName(String className) {
return findElements(By.className(className));
}
public WebElement findElementByCssSelector(String cssSelector) {
return findElement(By.cssSelector(cssSelector));
}
public List findElementsByCssSelector(String cssSelector) {
return findElements(By.cssSelector(cssSelector));
}
public WebElement findElementById(String id) {
return findElement(By.id(id));
}
public List findElementsById(String id) {
return findElements(By.id(id));
}
public WebElement findElementByLinkText(String linkText) {
return findElement(By.linkText(linkText));
}
public List findElementsByLinkText(String linkText) {
return findElements(By.linkText(linkText));
}
public WebElement findElementByPartialLinkText(String partialLinkText) {
return findElement(By.partialLinkText(partialLinkText));
}
public List findElementsByPartialLinkText(String
partialLinkText) {
return findElements(By.partialLinkText(partialLinkText));
}
public WebElement findElementByName(String name) {
return findElement(By.name(name));
}
public List findElementsByName(String name) {
return findElements(By.name(name));
}
public WebElement findElementByTagName(String tagName) {
return findElement(By.tagName(tagName));
}
public List findElementsByTagName(String tagName) {
return findElements(By.tagName(tagName));
}
public WebElement findElementByXPath(String path) {
return findElement(By.xpath(path));
}
public List findElementsByXPath(String path) {
return findElements(By.xpath(path));
}
public Capabilities getCapabilities() {
return driver.getCapabilities();
}
public Object executeScript(String script, Object... args) {
// Appium commands are sometimes sent as Javascript
if (AppiumJsCommandExtractor.isAppiumJsCommand(script)) {
Trigger trigger =
AppiumJsCommandExtractor.extractTrigger(elementsIds,
driver.manage().window().getSize(), script, args);
if (trigger != null) {
// TODO - Daniel, additional type of triggers
if (trigger instanceof MouseTrigger) {
MouseTrigger mt = (MouseTrigger) trigger;
eyes.addMouseTrigger(mt.getMouseAction(),
mt.getControl(), mt.getLocation());
}
}
}
logger.verbose("Execute script...");
Object result = driver.executeScript(script, args);
logger.verbose("Done!");
return result;
}
public Object executeAsyncScript(String script, Object... args) {
// Appium commands are sometimes sent as Javascript
if (AppiumJsCommandExtractor.isAppiumJsCommand(script)) {
Trigger trigger =
AppiumJsCommandExtractor.extractTrigger(elementsIds,
driver.manage().window().getSize(), script, args);
if (trigger != null) {
// TODO - Daniel, additional type of triggers
if (trigger instanceof MouseTrigger) {
MouseTrigger mt = (MouseTrigger) trigger;
eyes.addMouseTrigger(mt.getMouseAction(),
mt.getControl(), mt.getLocation());
}
}
}
return driver.executeAsyncScript(script, args);
}
/**
* @param forceQuery If true, we will perform the query even if we have a
* cached viewport size.
* @return The viewport size of the default content (outer most frame).
*/
public RectangleSize getDefaultContentViewportSize(boolean forceQuery) {
logger.verbose("getDefaultContentViewportSize()");
if (defaultContentViewportSize != null && !forceQuery) {
logger.verbose("Using cached viewport size: "
+ defaultContentViewportSize);
return defaultContentViewportSize;
}
FrameChain currentFrames = getFrameChain();
// Optimization
if (currentFrames.size() > 0) {
switchTo().defaultContent();
}
logger.verbose("Extracting viewport size...");
defaultContentViewportSize =
EyesSeleniumUtils.getViewportSizeOrDisplaySize(logger, this);
logger.verbose("Done! Viewport size: " + defaultContentViewportSize);
if (currentFrames.size() > 0) {
((EyesTargetLocator) switchTo()).frames(currentFrames);
}
return defaultContentViewportSize;
}
/**
* See {@link #getDefaultContentViewportSize(boolean)}.
* {@code forceQuery} defaults to {@code false}.
*/
public RectangleSize getDefaultContentViewportSize() {
return getDefaultContentViewportSize(false);
}
/**
*
* @return A copy of the current frame chain.
*/
public FrameChain getFrameChain() {
return new FrameChain(logger, frameChain);
}
public X getScreenshotAs(OutputType xOutputType)
throws WebDriverException {
// Get the image as base64.
String screenshot64 = driver.getScreenshotAs(OutputType.BASE64);
BufferedImage screenshot = ImageUtils.imageFromBase64(screenshot64);
screenshot = normalizeRotation(logger, driver, screenshot, rotation);
// Return the image in the requested format.
screenshot64 = ImageUtils.base64FromImage(screenshot);
return xOutputType.convertFromBase64Png(screenshot64);
}
public String getUserAgent() {
String userAgent;
try {
userAgent = (String) this.driver.executeScript(
"return navigator.userAgent");
logger.verbose("user agent: "+ userAgent);
} catch (Exception e) {
logger.verbose("Failed to obtain user-agent string");
userAgent = null;
}
return userAgent;
}
private String getSessionId() {
// extract remote web driver information
return driver.getSessionId().toString();
}
}