com.applitools.eyes.EyesTargetLocator Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of eyes-selenium-java-jersey1x Show documentation
Show all versions of eyes-selenium-java-jersey1x Show documentation
Applitools Eyes SDK for Selenium Java WebDriver
/*
* Applitools SDK for Selenium integration.
*/
package com.applitools.eyes;
import com.applitools.utils.ArgumentGuard;
import org.openqa.selenium.Alert;
import org.openqa.selenium.NoSuchFrameException;
import org.openqa.selenium.WebDriver;
import org.openqa.selenium.WebElement;
import org.openqa.selenium.remote.RemoteWebElement;
import java.util.List;
/**
* Wraps a target locator so we can keep track of which frames have been
* switched to.
*/
class EyesTargetLocator implements WebDriver.TargetLocator {
private final Logger logger;
private final EyesWebDriver driver;
private final ScrollPositionProvider scrollPosition;
private final OnWillSwitch onWillSwitch;
private final WebDriver.TargetLocator targetLocator;
/**
* An enum for the different types of frames we can switch into.
*/
protected static enum TargetType { FRAME, PARENT_FRAME, DEFAULT_CONTENT }
/**
* A wrapper for an action to be performed before the actual switch is made.
*/
protected static interface OnWillSwitch {
/**
* Will be called before switching into a frame.
* @param targetType The type of frame we're about to switch into.
* @param targetFrame The element about to be switched to,
* if available. Otherwise, null.
*/
public void willSwitchToFrame(TargetType targetType,
WebElement targetFrame);
/**
* Will be called before switching into a window.
* @param nameOrHandle The name/handle of the window to be switched to.
*/
public void willSwitchToWindow(String nameOrHandle);
}
/**
* Initialized a new EyesTargetLocator object.
* @param driver The WebDriver from which the targetLocator was received.
* @param targetLocator The actual TargetLocator object.
* @param onWillSwitch A delegate to be called whenever a relavant switch
* is about to be performed.
*/
public EyesTargetLocator(Logger logger, EyesWebDriver driver,
WebDriver.TargetLocator
targetLocator, OnWillSwitch onWillSwitch) {
ArgumentGuard.notNull(logger, "logger");
ArgumentGuard.notNull(driver, "driver");
ArgumentGuard.notNull(targetLocator, "targetLocator");
ArgumentGuard.notNull(onWillSwitch, "onWillSwitch");
this.logger = logger;
this.driver = driver;
this.targetLocator = targetLocator;
this.onWillSwitch = onWillSwitch;
this.scrollPosition = new ScrollPositionProvider(logger, driver);
}
public WebDriver frame(int index) {
logger.verbose(String.format("EyesTargetLocator.frame(%d)", index));
// Finding the target element so and reporting it using onWillSwitch.
logger.verbose("Getting frames list...");
List frames = driver.findElementsByCssSelector(
"frame, iframe");
if (index > frames.size()) {
throw new NoSuchFrameException(String.format(
"Frame index [%d] is invalid!", index));
}
logger.verbose("Done! getting the specific frame...");
WebElement targetFrame = frames.get(index);
logger.verbose("Done! Making preparations...");
onWillSwitch.willSwitchToFrame(TargetType.FRAME, targetFrame);
logger.verbose("Done! Switching to frame...");
targetLocator.frame(index);
logger.verbose("Done!");
return driver;
}
public WebDriver frame(String nameOrId) {
logger.verbose(String.format("EyesTargetLocator.frame('%s')",
nameOrId));
// Finding the target element so we can report it.
// We use find elements(plural) to avoid exception when the element
// is not found.
logger.verbose("Getting frames by name...");
List frames = driver.findElementsByName(nameOrId);
if (frames.size() == 0) {
logger.verbose("No frames Found! Trying by id...");
// If there are no frames by that name, we'll try the id
frames = driver.findElementsById(nameOrId);
if (frames.size() == 0 ) {
// No such frame, bummer
throw new NoSuchFrameException(String.format(
"No frame with name or id '%s' exists!", nameOrId));
}
}
logger.verbose("Done! Making preparations..");
onWillSwitch.willSwitchToFrame(TargetType.FRAME, frames.get(0));
logger.verbose("Done! Switching to frame...");
targetLocator.frame(nameOrId);
logger.verbose("Done!");
return driver;
}
public WebDriver frame(WebElement frameElement) {
logger.verbose("EyesTargetLocator.frame(element)");
logger.verbose("Making preparations..");
onWillSwitch.willSwitchToFrame(TargetType.FRAME, frameElement);
logger.verbose("Done! Switching to frame...");
targetLocator.frame(frameElement);
logger.verbose("Done!");
return driver;
}
public WebDriver parentFrame() {
logger.verbose("EyesTargetLocator.parentFrame()");
if (driver.getFrameChain().size() != 0) {
logger.verbose("Making preparations..");
onWillSwitch.willSwitchToFrame(TargetType.PARENT_FRAME, null);
logger.verbose("Done! Switching to parent frame..");
targetLocator.parentFrame();
}
logger.verbose("Done!");
return driver;
}
/**
* Switches into every frame in the frame chain. This is used as way to
* switch into nested frames (while considering scroll) in a single call.
* @param frameChain The path to the frame to switch to.
* @return The WebDriver with the switched context.
*/
public WebDriver frames(FrameChain frameChain) {
logger.verbose("EyesTargetLocator.frames(frameChain)");
for (Frame frame: frameChain) {
logger.verbose("Scrolling by parent scroll position..");
scrollPosition.setPosition(frame.getParentScrollPosition());
logger.verbose("Done! Switching to frame...");
driver.switchTo().frame(frame.getReference());
logger.verbose("Done!");
}
logger.verbose("Done switching into nested frames!");
return driver;
}
/**
* Switches into every frame in the list. This is used as way to
* switch into nested frames in a single call.
* @param framesPath The path to the frame to check. This is a list of
* frame names/IDs (where each frame is nested in the
* previous frame).
* @return The WebDriver with the switched context.
*/
public WebDriver frames(String[] framesPath) {
logger.verbose("EyesTargetLocator.frames(framesPath)");
for (String frameNameOrId: framesPath) {
logger.verbose("Switching to frame...");
driver.switchTo().frame(frameNameOrId);
logger.verbose("Done!");
}
logger.verbose("Done switching into nested frames!");
return driver;
}
public WebDriver window(String nameOrHandle) {
logger.verbose("EyesTargetLocator.frames()");
logger.verbose("Making preparations..");
onWillSwitch.willSwitchToWindow(nameOrHandle);
logger.verbose("Done! Switching to window..");
targetLocator.window(nameOrHandle);
logger.verbose("Done!");
return driver;
}
public WebDriver defaultContent() {
logger.verbose("EyesTargetLocator.defaultContent()");
if (driver.getFrameChain().size() != 0) {
logger.verbose("Making preparations..");
onWillSwitch.willSwitchToFrame(TargetType.DEFAULT_CONTENT, null);
logger.verbose("Done! Switching to default content..");
targetLocator.defaultContent();
logger.verbose("Done!");
}
return driver;
}
public WebElement activeElement() {
logger.verbose("EyesTargetLocator.activeElement()");
logger.verbose("Switching to element..");
WebElement element = targetLocator.activeElement();
if (!(element instanceof RemoteWebElement)) {
throw new EyesException("Not a remote web element!");
}
EyesRemoteWebElement result = new EyesRemoteWebElement(logger, driver,
(RemoteWebElement)element);
logger.verbose("Done!");
return result;
}
public Alert alert() {
logger.verbose("EyesTargetLocator.alert()");
logger.verbose("Switching to alert..");
Alert result = targetLocator.alert();
logger.verbose("Done!");
return result;
}
}