org.openqa.selenium.WebDriverBackedSelenium Maven / Gradle / Ivy
/*
Copyright 2007-2009 WebDriver committers
Copyright 2007-2009 Google Inc.
Licensed 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;
import com.thoughtworks.selenium.Selenium;
import com.thoughtworks.selenium.SeleniumException;
import com.thoughtworks.selenium.Wait;
import org.openqa.selenium.internal.AltLookupStrategy;
import org.openqa.selenium.internal.ClassLookupStrategy;
import org.openqa.selenium.internal.DomTraversalLookupStrategy;
import org.openqa.selenium.internal.ExactTextMatchingStrategy;
import org.openqa.selenium.internal.GlobTextMatchingStrategy;
import org.openqa.selenium.internal.IdLookupStrategy;
import org.openqa.selenium.internal.IdOptionSelectStrategy;
import org.openqa.selenium.internal.IdentifierLookupStrategy;
import org.openqa.selenium.internal.ImplicitLookupStrategy;
import org.openqa.selenium.internal.IndexOptionSelectStrategy;
import org.openqa.selenium.internal.LabelOptionSelectStrategy;
import org.openqa.selenium.internal.LinkLookupStrategy;
import org.openqa.selenium.internal.LookupStrategy;
import org.openqa.selenium.internal.NameLookupStrategy;
import org.openqa.selenium.internal.OptionSelectStrategy;
import org.openqa.selenium.internal.RegExTextMatchingStrategy;
import org.openqa.selenium.internal.TextMatchingStrategy;
import org.openqa.selenium.internal.ValueOptionSelectStrategy;
import org.openqa.selenium.internal.XPathLookupStrategy;
import java.awt.*;
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.MalformedURLException;
import java.net.URL;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Date;
import java.util.HashMap;
import java.util.Iterator;
import java.util.List;
import java.util.Map;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
public class WebDriverBackedSelenium implements Selenium {
private static final Pattern STRATEGY_AND_VALUE_PATTERN = Pattern.compile("^(\\p{Alpha}+)=(.*)");
private static final Pattern TEXT_MATCHING_STRATEGY_AND_VALUE_PATTERN = Pattern.compile("^(\\p{Alpha}+):(.*)");
protected WebDriver driver;
private final String baseUrl;
private final Map lookupStrategies = new HashMap();
private final Map optionSelectStrategies = new HashMap();
private final Map textMatchingStrategies = new HashMap();
private final Pattern NAME_VALUE_PAIR_PATTERN = Pattern.compile("([^\\s=\\[\\]\\(\\),\"\\/\\?@:;]+)=([^=\\[\\]\\(\\),\"\\/\\?@:;]*)");
private static final Pattern MAX_AGE_PATTERN = Pattern.compile("max_age=(\\d+)");
private static final Pattern PATH_PATTERN = Pattern.compile("path=([^\\s,]+)[,]?");
private static final Pattern TABLE_PARTS = Pattern.compile("(.*)\\.(\\d+)\\.(\\d+)");
private static final String injectableSelenium = "/org/openqa/selenium/internal/injectableSelenium.js";
private static final String htmlUtils = "/org/openqa/selenium/internal/htmlutils.js";
/**
* Regular expression for scripts passed to {@link #getEval(String)} that
* reference the current window.
*/
private static final Pattern SELENIUM_WINDOW_REF_REGEX = Pattern.compile(
"selenium\\.(browserbot|page\\(\\))\\.getCurrentWindow\\(\\)");
/**
* Regular expression for scripts passed to {@link #getEval(String)} that
* reference the current window's document.
*/
private static final Pattern SELENIUM_DOCUMENT_REF_REGEX = Pattern.compile(
"selenium\\.(browserbot|page\\(\\))\\.getDocument\\(\\)");
// Keyboard related stuff
private boolean metaKeyDown;
private boolean altKeyDown;
private boolean controlKeyDown;
private boolean shiftKeyDown;
private String originalWindowHandle;
// Emulated timeout in milliseconds.
private long timeout = 30000;
// Thread to emulate the timeout
private TimeoutThread timeoutThread;
public WebDriverBackedSelenium(WebDriver baseDriver, String baseUrl) {
setUpElementFindingStrategies();
setUpOptionFindingStrategies();
setUpTextMatchingStrategies();
this.driver = baseDriver;
if (baseUrl.endsWith("/")) {
this.baseUrl = baseUrl.substring(0, baseUrl.length() - 1);
} else {
this.baseUrl = baseUrl;
}
originalWindowHandle = driver.getWindowHandle();
}
/**
* Stops the timeout thread if it exists.
*/
private void stopTimeoutThreadIfExists() {
if (timeoutThread != null) {
timeoutThread.interrupt();
timeoutThread = null;
}
}
public WebDriver getUnderlyingWebDriver() {
return driver;
}
/**
* Creates a new timeout thread. If exists a previous existing timeout will
* be stopped.
*/
private void startTimeoutThread() {
stopTimeoutThreadIfExists();
timeoutThread = new TimeoutThread(Thread.currentThread(), timeout);
timeoutThread.start();
}
private void setUpTextMatchingStrategies() {
textMatchingStrategies.put("implicit", new GlobTextMatchingStrategy());
textMatchingStrategies.put("glob", new GlobTextMatchingStrategy());
textMatchingStrategies.put("regexp", new RegExTextMatchingStrategy());
textMatchingStrategies.put("exact", new ExactTextMatchingStrategy());
}
private void setUpOptionFindingStrategies() {
optionSelectStrategies.put("implicit", new LabelOptionSelectStrategy());
optionSelectStrategies.put("id", new IdOptionSelectStrategy());
optionSelectStrategies.put("index", new IndexOptionSelectStrategy());
optionSelectStrategies.put("label", new LabelOptionSelectStrategy());
optionSelectStrategies.put("value", new ValueOptionSelectStrategy());
}
private void setUpElementFindingStrategies() {
lookupStrategies.put("alt", new AltLookupStrategy());
lookupStrategies.put("class", new ClassLookupStrategy());
lookupStrategies.put("id", new IdLookupStrategy());
lookupStrategies.put("identifier", new IdentifierLookupStrategy());
lookupStrategies.put("implicit", new ImplicitLookupStrategy());
lookupStrategies.put("link", new LinkLookupStrategy());
lookupStrategies.put("name", new NameLookupStrategy());
lookupStrategies.put("xpath", new XPathLookupStrategy());
lookupStrategies.put("dom", new DomTraversalLookupStrategy());
}
/**
* Sets the per-session extension Javascript
*/
public void setExtensionJs(String s) {
throw new UnsupportedOperationException("setExtensionJs");
}
/**
* Launches the browser with a new Selenium session
*/
public void start() {
// no-op
}
/**
* Starts a new Selenium testing session with a String, representing a configuration
*/
public void start(String optionsString) {
// no-op
}
/**
* Starts a new Selenium testing session with a configuration options object
*/
public void start(Object optionsObject) {
// no-op
}
/**
* Ends the test session, killing the browser
*/
public void stop() {
driver.quit();
}
/**
* Shows in the RemoteRunner a banner for the current test
* The banner is 'classname : methodname' where those two are derived from the caller
* The method name will be unCamelCased with the insertion of spaces at word boundaries
*/
public void showContextualBanner() {
throw new UnsupportedOperationException("showContextualBanner");
}
/**
* Shows in the RemoteRunner a banner for the current test
* The banner is 'classname : methodname'
* The method name will be unCamelCased with the insertion of spaces at word boundaries
*/
public void showContextualBanner(String className, String methodName) {
throw new UnsupportedOperationException("showContextualBanner");
}
/**
* Clicks on a link, button, checkbox or radio button. If the click action
* causes a new page to load (like a link usually does), call
* waitForPageToLoad.
*
* @param locator an element locator
*/
public void click(String locator) {
WebElement element = findElement(locator);
element.click();
}
/**
* Double clicks on a link, button, checkbox or radio button. If the double click action
* causes a new page to load (like a link usually does), call
* waitForPageToLoad.
*
* @param locator an element locator
*/
public void doubleClick(String locator) {
WebElement element = findElement(locator);
element.click();
element.click();
}
/**
* Simulates opening the context menu for the specified element (as might happen if the user "right-clicked" on the element).
*
* @param locator an element locator
*/
public void contextMenu(String locator) {
throw new UnsupportedOperationException("contextMenu");
}
/**
* Clicks on a link, button, checkbox or radio button. If the click action
* causes a new page to load (like a link usually does), call
* waitForPageToLoad.
*
* @param locator an element locator
* @param coordString specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.
*/
public void clickAt(String locator, String coordString) {
throw new UnsupportedOperationException("clickAt");
}
/**
* Doubleclicks on a link, button, checkbox or radio button. If the action
* causes a new page to load (like a link usually does), call
* waitForPageToLoad.
*
* @param locator an element locator
* @param coordString specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.
*/
public void doubleClickAt(String locator, String coordString) {
throw new UnsupportedOperationException("doubleClickAt");
}
/**
* Simulates opening the context menu for the specified element (as might happen if the user "right-clicked" on the element).
*
* @param locator an element locator
* @param coordString specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.
*/
public void contextMenuAt(String locator, String coordString) {
throw new UnsupportedOperationException("contextMenuAt");
}
/**
* Explicitly simulate an event, to trigger the corresponding "onevent"
* handler.
*
* @param locator an element locator
* @param eventName the event name, e.g. "focus" or "blur"
*/
public void fireEvent(String locator, String eventName) {
WebElement element = findElement(locator);
callEmbeddedSelenium("doFireEvent", element, eventName);
}
/**
* Move the focus to the specified element; for example, if the element is an input field, move the cursor to that field.
*
* @param locator an element locator
*/
public void focus(String locator) {
fireEvent(locator, "focus");
}
/**
* Simulates a user pressing and releasing a key.
*
* @param locator an element locator
* @param keySequence Either be a string("\" followed by the numeric keycode of the key to be pressed, normally the ASCII value of that key), or a single character. For example: "w", "\119".
*/
public void keyPress(String locator, String keySequence) {
typeKeys(locator, keySequence);
}
/**
* Press the shift key and hold it down until doShiftUp() is called or a new page is loaded.
*/
public void shiftKeyDown() {
shiftKeyDown = true;
}
/**
* Release the shift key.
*/
public void shiftKeyUp() {
shiftKeyDown = false;
}
/**
* Press the meta key and hold it down until doMetaUp() is called or a new page is loaded.
*/
public void metaKeyDown() {
metaKeyDown = true;
}
/**
* Release the meta key.
*/
public void metaKeyUp() {
metaKeyDown = false;
}
/**
* Press the alt key and hold it down until doAltUp() is called or a new page is loaded.
*/
public void altKeyDown() {
altKeyDown = true;
}
/**
* Release the alt key.
*/
public void altKeyUp() {
altKeyDown = true;
}
/**
* Press the control key and hold it down until doControlUp() is called or a new page is loaded.
*/
public void controlKeyDown() {
controlKeyDown = true;
}
/**
* Release the control key.
*/
public void controlKeyUp() {
controlKeyDown = false;
}
/**
* Simulates a user pressing a key (without releasing it yet).
*
* @param locator an element locator
* @param keySequence Either be a string("\" followed by the numeric keycode of the key to be pressed, normally the ASCII value of that key), or a single character. For example: "w", "\119".
*/
public void keyDown(String locator, String keySequence) {
callEmbeddedSelenium("doKeyDown", findElement(locator), keySequence, controlKeyDown, altKeyDown, shiftKeyDown, metaKeyDown);
}
/**
* Simulates a user releasing a key.
*
* @param locator an element locator
* @param keySequence Either be a string("\" followed by the numeric keycode of the key to be pressed, normally the ASCII value of that key), or a single character. For example: "w", "\119".
*/
public void keyUp(String locator, String keySequence) {
callEmbeddedSelenium("doKeyUp", findElement(locator), keySequence, controlKeyDown, altKeyDown, shiftKeyDown, metaKeyDown);
}
/**
* Simulates a user hovering a mouse over the specified element.
*
* @param locator an element locator
*/
public void mouseOver(String locator) {
WebElement element = findElement(locator);
callEmbeddedSelenium("triggerMouseEvent", element, "mouseover", true);
}
/**
* Simulates a user moving the mouse pointer away from the specified element.
*
* @param locator an element locator
*/
public void mouseOut(String locator) {
WebElement element = findElement(locator);
callEmbeddedSelenium("triggerMouseEvent", element, "mouseout", true);
}
/**
* Simulates a user pressing the left mouse button (without releasing it yet) on
* the specified element.
*
* @param locator an element locator
*/
public void mouseDown(String locator) {
WebElement element = findElement(locator);
callEmbeddedSelenium("triggerMouseEvent", element, "mousedown", true);
}
/**
* Simulates a user pressing the right mouse button (without releasing it yet) on
* the specified element.
*
* @param locator an element locator
*/
public void mouseDownRight(String locator) {
throw new UnsupportedOperationException("mouseDownRight");
}
/**
* Simulates a user pressing the left mouse button (without releasing it yet) at
* the specified location.
*
* @param locator an element locator
* @param coordString specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.
*/
public void mouseDownAt(String locator, String coordString) {
WebElement element = findElement(locator);
callEmbeddedSelenium("triggerMouseEventAt", element, "mousedown", coordString);
}
/**
* Simulates a user pressing the right mouse button (without releasing it yet) at
* the specified location.
*
* @param locator an element locator
* @param coordString specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.
*/
public void mouseDownRightAt(String locator, String coordString) {
throw new UnsupportedOperationException("mouseDownRightAt");
}
/**
* Simulates the event that occurs when the user releases the mouse button (i.e., stops
* holding the button down) on the specified element.
*
* @param locator an element locator
*/
public void mouseUp(String locator) {
WebElement element = findElement(locator);
callEmbeddedSelenium("triggerMouseEvent", element, "mouseup", true);
}
/**
* Simulates the event that occurs when the user releases the right mouse button (i.e., stops
* holding the button down) on the specified element.
*
* @param locator an element locator
*/
public void mouseUpRight(String locator) {
throw new UnsupportedOperationException("mouseUpRight");
}
/**
* Simulates the event that occurs when the user releases the mouse button (i.e., stops
* holding the button down) at the specified location.
*
* @param locator an element locator
* @param coordString specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.
*/
public void mouseUpAt(String locator, String coordString) {
WebElement element = findElement(locator);
callEmbeddedSelenium("triggerMouseEventAt", element, "mouseup", coordString);
}
/**
* Simulates the event that occurs when the user releases the right mouse button (i.e., stops
* holding the button down) at the specified location.
*
* @param locator an element locator
* @param coordString specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.
*/
public void mouseUpRightAt(String locator, String coordString) {
throw new UnsupportedOperationException("mouseUpRightAt");
}
/**
* Simulates a user pressing the mouse button (without releasing it yet) on
* the specified element.
*
* @param locator an element locator
*/
public void mouseMove(String locator) {
WebElement element = findElement(locator);
callEmbeddedSelenium("triggerMouseEvent", element, "mousemove", true);
}
/**
* Simulates a user pressing the mouse button (without releasing it yet) on
* the specified element.
*
* @param locator an element locator
* @param coordString specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.
*/
public void mouseMoveAt(String locator, String coordString) {
WebElement element = findElement(locator);
callEmbeddedSelenium("triggerMouseEventAt", element, "mousemove", coordString);
}
/**
* Sets the value of an input field, as though you typed it in.
*
* Can also be used to set the value of combo boxes, check boxes, etc. In these cases,
* value should be the value of the option selected, not the visible text.
*
* @param locator an element locator
* @param value the value to type
*/
public void type(String locator, String value) {
if (controlKeyDown || altKeyDown || metaKeyDown)
throw new SeleniumException("type not supported immediately after call to controlKeyDown() or altKeyDown() or metaKeyDown()");
if (shiftKeyDown)
value = value.toUpperCase();
WebElement element = findElement(locator);
if(driver instanceof JavascriptExecutor && ((JavascriptExecutor) driver).isJavascriptEnabled()) {
callEmbeddedSelenium("replaceText", element, value);
} else {
element.sendKeys(value);
}
}
/**
* Simulates keystroke events on the specified element, as though you typed the value key-by-key.
*
* This is a convenience method for calling keyDown, keyUp, keyPress for every character in the specified string;
* this is useful for dynamic UI widgets (like auto-completing combo boxes) that require explicit key events.
Unlike the simple "type" command, which forces the specified value into the page directly, this command
* may or may not have any visible effect, even in cases where typing keys would normally have a visible effect.
* For example, if you use "typeKeys" on a form element, you may or may not see the results of what you typed in
* the field.
In some cases, you may need to use the simple "type" command to set the value of the field and then the "typeKeys" command to
* send the keystroke events corresponding to what you just typed.
*
* @param locator an element locator
* @param value the value to type
*/
public void typeKeys(String locator, String value) {
value = value.replace("\\38", Keys.ARROW_UP);
value = value.replace("\\40", Keys.ARROW_DOWN);
value = value.replace("\\37", Keys.ARROW_LEFT);
value = value.replace("\\39", Keys.ARROW_RIGHT);
findElement(locator).sendKeys(value);
}
/**
* Set execution speed (i.e., set the millisecond length of a delay which will follow each selenium operation). By default, there is no such delay, i.e.,
* the delay is 0 milliseconds.
*
* @param value the number of milliseconds to pause after operation
*/
public void setSpeed(String value) {
// no-op
}
/**
* Get execution speed (i.e., get the millisecond length of the delay following each selenium operation). By default, there is no such delay, i.e.,
* the delay is 0 milliseconds.
*
* See also setSpeed.
*
* @return the execution speed in milliseconds.
*/
public String getSpeed() {
// no-op. Pretend we work instantly. Which we do
return "0";
}
/**
* Check a toggle-button (checkbox/radio)
*
* @param locator an element locator
*/
public void check(String locator) {
findElement(locator).setSelected();
}
/**
* Uncheck a toggle-button (checkbox/radio)
*
* @param locator an element locator
*/
public void uncheck(String locator) {
WebElement element = findElement(locator);
if (element.isSelected())
element.toggle();
}
/**
* Select an option from a drop-down using an option locator.
*
*
* Option locators provide different ways of specifying options of an HTML
* Select element (e.g. for selecting a specific option, or for asserting
* that the selected option satisfies a specification). There are several
* forms of Select Option Locator.
*
- label=labelPattern:
* matches options based on their labels, i.e. the visible text. (This
* is the default.)
*
- label=regexp:^[Oo]ther
- value=valuePattern:
* matches options based on their values.
*
- value=other
- id=id:
*
* matches options based on their ids.
*
- id=option1
- index=index:
* matches an option based on its index (offset from zero).
*
- index=2
* If no option locator prefix is provided, the default behaviour is to match on label.
*
*
* @param selectLocator an element locator identifying a drop-down menu
* @param optionLocator an option locator (a label by default)
*/
public void select(String selectLocator, String optionLocator) {
removeAllSelections(selectLocator);
select(selectLocator, optionLocator, true, true);
}
/**
* Add a selection to the set of selected options in a multi-select element using an option locator.
*
* @param locator an element locator identifying a multi-select box
* @param optionLocator an option locator (a label by default)
*/
public void addSelection(String locator, String optionLocator) {
WebElement select = findElement(locator);
if (!"multiple".equals(select.getAttribute("multiple")))
throw new SeleniumException("You may only add a selection to a select that supports multiple selections");
select(locator, optionLocator, true, false);
}
/**
* Remove a selection from the set of selected options in a multi-select element using an option locator.
*
* @param locator an element locator identifying a multi-select box
* @param optionLocator an option locator (a label by default)
*/
public void removeSelection(String locator, String optionLocator) {
WebElement select = findElement(locator);
if (!"multiple".equals(select.getAttribute("multiple")))
throw new SeleniumException("You may only remove a selection to a select that supports multiple selections");
select(locator, optionLocator, false, false);
}
/**
* Unselects all of the selected options in a multi-select element.
*
* @param locator an element locator identifying a multi-select box
*/
public void removeAllSelections(String locator) {
WebElement select = findElement(locator);
List options = select.findElements(By.tagName("option"));
String multiple = select.getAttribute("multiple");
if (multiple == null || "".equals(multiple)) {
return;
}
removeAllSelections(options);
}
private void removeAllSelections(List options) {
for (WebElement option : options) {
if (option.isSelected())
option.toggle();
}
}
/**
* Submit the specified form. This is particularly useful for forms without
* submit buttons, e.g. single-input "Search" forms.
*
* @param formLocator an element locator for the form you want to submit
*/
public void submit(String formLocator) {
findElement(formLocator).submit();
}
/**
* Opens an URL in the test frame. This accepts both relative and absolute
* URLs.
*
* The "open" command waits for the page to load before proceeding,
* ie. the "AndWait" suffix is implicit.
*
* Note: The URL must be on the same domain as the runner HTML
* due to security restrictions in the browser (Same Origin Policy). If you
* need to open an URL on another domain, use the Selenium Server to start a
* new browser session on that domain.
*
* @param url the URL to open; may be relative or absolute
*/
public void open(String url) {
String urlToOpen = url;
if (url.indexOf("://") == -1) {
urlToOpen = baseUrl + (!url.startsWith("/") ? "/" : "") + url;
}
startTimeoutThread();
driver.get(urlToOpen);
stopTimeoutThreadIfExists();
}
/**
* Opens a popup window (if a window with that ID isn't already open).
* After opening the window, you'll need to select it using the selectWindow
* command.
*
* This command can also be a useful workaround for bug SEL-339. In some cases, Selenium will be unable to intercept a call to window.open (if the call occurs during or before the "onLoad" event, for example).
* In those cases, you can force Selenium to notice the open window's name by using the Selenium openWindow command, using
* an empty (blank) url, like this: openWindow("", "myFunnyWindow").
*
* @param url the URL to open, which can be blank
* @param windowID the JavaScript window ID of the window to select
*/
public void openWindow(String url, String windowID) {
startTimeoutThread();
getEval(String.format("window.open('%s', '%s');", url, windowID));
stopTimeoutThreadIfExists();
}
/**
* Selects a popup window using a window locator; once a popup window has been selected, all
* commands go to that window. To select the main window again, use null
* as the target.
*
*
*
* Window locators provide different ways of specifying the window object:
* by title, by internal JavaScript "name," or by JavaScript variable.
* - title=My Special Window:
* Finds the window using the text that appears in the title bar. Be careful;
* two windows can share the same title. If that happens, this locator will
* just pick one.
*
- name=myWindow:
* Finds the window using its internal JavaScript "name" property. This is the second
* parameter "windowName" passed to the JavaScript method window.open(url, windowName, windowFeatures, replaceFlag)
* (which Selenium intercepts).
*
- var=variableName:
* Some pop-up windows are unnamed (anonymous), but are associated with a JavaScript variable name in the current
* application window, e.g. "window.foo = window.open(url);". In those cases, you can open the window using
* "var=foo".
*
* If no window locator prefix is provided, we'll try to guess what you mean like this:
1.) if windowID is null, (or the string "null") then it is assumed the user is referring to the original window instantiated by the browser).
2.) if the value of the "windowID" parameter is a JavaScript variable name in the current application window, then it is assumed
* that this variable contains the return value from a call to the JavaScript window.open() method.
3.) Otherwise, selenium looks in a hash it maintains that maps string names to window "names".
4.) If that fails, we'll try looping over all of the known windows to try to find the appropriate "title".
* Since "title" is not necessarily unique, this may have unexpected behavior.
If you're having trouble figuring out the name of a window that you want to manipulate, look at the Selenium log messages
* which identify the names of windows created via window.open (and therefore intercepted by Selenium). You will see messages
* like the following for each window as it is opened:
debug: window.open call intercepted; window ID (which you can use with selectWindow()) is "myNewWindow"
In some cases, Selenium will be unable to intercept a call to window.open (if the call occurs during or before the "onLoad" event, for example).
* (This is bug SEL-339.) In those cases, you can force Selenium to notice the open window's name by using the Selenium openWindow command, using
* an empty (blank) url, like this: openWindow("", "myFunnyWindow").
*
* @param windowID the JavaScript window ID of the window to select
*/
public void selectWindow(String windowID) {
if ("null".equals(windowID)) {
driver.switchTo().window(originalWindowHandle);
} else if ("_blank".equals(windowID)) {
selectBlankWindow();
} else {
if (windowID.startsWith("title=")) {
selectWindowWithTitle(windowID.substring("title=".length()));
return;
}
if (windowID.startsWith("name=")) {
windowID = windowID.substring("name=".length());
}
try {
driver.switchTo().window(windowID);
} catch (NoSuchWindowException e) {
selectWindowWithTitle(windowID);
}
}
}
private void selectWindowWithTitle(String title) {
String current = driver.getWindowHandle();
for (String handle : driver.getWindowHandles()) {
driver.switchTo().window(handle);
if (title.equals(driver.getTitle())) {
return;
}
}
driver.switchTo().window(current);
throw new SeleniumException("Unable to select window with title: " + title);
}
/**
* Selects the only _blank window. A window open with
* target='_blank' will have a window.name = null.
*
* This method assumes that there will only be one single
* _blank window and selects the first one with no name.
* Therefore if for any reasons there are multiple windows with
* window.name = null the first found one will be selected.
*
*
If none of the windows have window.name = null the last
* selected one will be re-selected and a {@link SeleniumException} will
* be thrown.
*
* @throws NoSuchWindowException if no window with
* window.name = null is found.
*/
private void selectBlankWindow() {
String current = driver.getWindowHandle();
// Find the first window without a "name" attribute
List handles = new ArrayList(driver.getWindowHandles());
for (String handle: handles) {
driver.switchTo().window(handle);
String value = (String)
((JavascriptExecutor) driver).executeScript("return window.name;");
if (value == null) {
// We found it!
return;
}
}
// We couldn't find it
driver.switchTo().window(current);
throw new SeleniumException("Unable to select window _blank");
}
/** Simplifies the process of selecting a popup window (and does not offer
* functionality beyond what selectWindow() already provides).
* - If
windowID is either not specified, or specified as
* "null", the first non-top window is selected. The top window is the one
* that would be selected by selectWindow() without providing a
* windowID . This should not be used when more than one popup
* window is in play. - Otherwise, the window will be looked up considering
*
windowID as the following in order: 1) the "name" of the
* window, as specified to window.open(); 2) a javascript
* variable which is a reference to a window; and 3) the title of the
* window. This is the same ordered lookup performed by
* selectWindow .
*
* @param windowID an identifier for the popup window, which can take on a
* number of different meanings
*/
public void selectPopUp(String windowID) {
throw new UnsupportedOperationException("Not implemented yet.");
}
/** Selects the main window. Functionally equivalent to using
* selectWindow() and specifying no value for
* windowID.
*/
public void deselectPopUp() {
throw new UnsupportedOperationException("Not implemented yet.");
}
/**
* Selects a frame within the current window. (You may invoke this command
* multiple times to select nested frames.) To select the parent frame, use
* "relative=parent" as a locator; to select the top frame, use "relative=top".
* You can also select a frame by its 0-based index number; select the first frame with
* "index=0", or the third frame with "index=2".
*
* You may also use a DOM expression to identify the frame you want directly,
* like this: dom=frames["main"].frames["subframe"]
*
* @param locator an element locator identifying a frame or iframe
*/
public void selectFrame(String locator) {
if ("relative=top".equals(locator)) {
driver.switchTo().defaultContent();
return;
}
try {
driver.switchTo().frame(locator);
} catch (NoSuchFrameException e) {
throw new SeleniumException(e.getMessage(), e);
}
}
/**
* Determine whether current/locator identify the frame containing this running code.
*
* This is useful in proxy injection mode, where this code runs in every
* browser frame and window, and sometimes the selenium server needs to identify
* the "current" frame. In this case, when the test calls selectFrame, this
* routine is called for each frame to figure out which one has been selected.
* The selected frame will return true, while all others will return false.
*
* @param currentFrameString starting frame
* @param target new frame (which might be relative to the current one)
* @return true if the new frame is this code's window
*/
public boolean getWhetherThisFrameMatchFrameExpression(String currentFrameString, String target) {
throw new UnsupportedOperationException("getWhetherThisFrameMatchFrameExpression");
}
/**
* Determine whether currentWindowString plus target identify the window containing this running code.
*
* This is useful in proxy injection mode, where this code runs in every
* browser frame and window, and sometimes the selenium server needs to identify
* the "current" window. In this case, when the test calls selectWindow, this
* routine is called for each window to figure out which one has been selected.
* The selected window will return true, while all others will return false.
*
* @param currentWindowString starting window
* @param target new window (which might be relative to the current one, e.g., "_parent")
* @return true if the new window is this code's window
*/
public boolean getWhetherThisWindowMatchWindowExpression(String currentWindowString, String target) {
throw new UnsupportedOperationException("getWhetherThisWindowMatchWindowExpression");
}
/**
* Waits for a popup window to appear and load up.
*
* If windowID is equals to _blank then instead
* of searching the window by ID it is necessary to search for the only window
* without a name.
*
* @see #selectBlankWindow()
*
* @param windowID the JavaScript window "name" of the window that will appear (not the text of the title bar)
* @param timeout a timeout in milliseconds, after which the action will return with an error
*/
public void waitForPopUp(final String windowID, String timeout) {
final long millis = Long.parseLong(timeout);
final String current = driver.getWindowHandle();
startTimeoutThread();
new Wait() {
@Override
public boolean until() {
try {
if ("_blank".equals(windowID)) {
selectBlankWindow();
} else {
driver.switchTo().window(windowID);
}
return !"about:blank".equals(driver.getCurrentUrl());
} catch (SeleniumException e) {
// Swallow
}
return false;
}
}.wait(String.format("Timed out waiting for %s. Waited %s", windowID, timeout), millis);
stopTimeoutThreadIfExists();
driver.switchTo().window(current);
}
/**
*
* By default, Selenium's overridden window.confirm() function will
* return true, as if the user had manually clicked OK; after running
* this command, the next call to confirm() will return false, as if
* the user had clicked Cancel. Selenium will then resume using the
* default behavior for future confirmations, automatically returning
* true (OK) unless/until you explicitly call this command for each
* confirmation.
*
* Take note - every time a confirmation comes up, you must
* consume it with a corresponding getConfirmation, or else
* the next selenium operation will fail.
*
*/
public void chooseCancelOnNextConfirmation() {
throw new UnsupportedOperationException("chooseCancelOnNextConfirmation");
}
/**
*
* Undo the effect of calling chooseCancelOnNextConfirmation. Note
* that Selenium's overridden window.confirm() function will normally automatically
* return true, as if the user had manually clicked OK, so you shouldn't
* need to use this command unless for some reason you need to change
* your mind prior to the next confirmation. After any confirmation, Selenium will resume using the
* default behavior for future confirmations, automatically returning
* true (OK) unless/until you explicitly call chooseCancelOnNextConfirmation for each
* confirmation.
*
* Take note - every time a confirmation comes up, you must
* consume it with a corresponding getConfirmation, or else
* the next selenium operation will fail.
*
*/
public void chooseOkOnNextConfirmation() {
throw new UnsupportedOperationException("chooseOkOnNextConfirmation");
}
/**
* Instructs Selenium to return the specified answer string in response to
* the next JavaScript prompt [window.prompt()].
*
* @param answer the answer to give in response to the prompt pop-up
*/
public void answerOnNextPrompt(String answer) {
throw new UnsupportedOperationException("answerOnNextPrompt");
}
/**
* Simulates the user clicking the "back" button on their browser.
*/
public void goBack() {
startTimeoutThread();
driver.navigate().back();
stopTimeoutThreadIfExists();
}
/**
* Simulates the user clicking the "Refresh" button on their browser.
*/
public void refresh() {
startTimeoutThread();
driver.navigate().refresh();
stopTimeoutThreadIfExists();
}
/**
* Simulates the user clicking the "close" button in the titlebar of a popup
* window or tab.
*/
public void close() {
driver.close();
}
/**
* Has an alert occurred?
*
*
* This function never throws an exception
*
*
* @return true if there is an alert
*/
public boolean isAlertPresent() {
throw new UnsupportedOperationException("isAlertPresent");
}
/**
* Has a prompt occurred?
*
*
* This function never throws an exception
*
*
* @return true if there is a pending prompt
*/
public boolean isPromptPresent() {
throw new UnsupportedOperationException("isPromptPresent");
}
/**
* Has confirm() been called?
*
*
* This function never throws an exception
*
*
* @return true if there is a pending confirmation
*/
public boolean isConfirmationPresent() {
throw new UnsupportedOperationException("isConfirmationPresent");
}
/**
* Retrieves the message of a JavaScript alert generated during the previous action, or fail if there were no alerts.
*
* Getting an alert has the same effect as manually clicking OK. If an
* alert is generated but you do not consume it with getAlert, the next Selenium action
* will fail.
Under Selenium, JavaScript alerts will NOT pop up a visible alert
* dialog.
Selenium does NOT support JavaScript alerts that are generated in a
* page's onload() event handler. In this case a visible dialog WILL be
* generated and Selenium will hang until someone manually clicks OK.
*
* @return The message of the most recent JavaScript alert
*/
public String getAlert() {
throw new UnsupportedOperationException("getAlert");
}
/**
* Retrieves the message of a JavaScript confirmation dialog generated during
* the previous action.
*
*
* By default, the confirm function will return true, having the same effect
* as manually clicking OK. This can be changed by prior execution of the
* chooseCancelOnNextConfirmation command.
*
* If an confirmation is generated but you do not consume it with getConfirmation,
* the next Selenium action will fail.
*
* NOTE: under Selenium, JavaScript confirmations will NOT pop up a visible
* dialog.
*
* NOTE: Selenium does NOT support JavaScript confirmations that are
* generated in a page's onload() event handler. In this case a visible
* dialog WILL be generated and Selenium will hang until you manually click
* OK.
*
*
* @return the message of the most recent JavaScript confirmation dialog
*/
public String getConfirmation() {
throw new UnsupportedOperationException("getConfirmation");
}
/**
* Retrieves the message of a JavaScript question prompt dialog generated during
* the previous action.
*
* Successful handling of the prompt requires prior execution of the
* answerOnNextPrompt command. If a prompt is generated but you
* do not get/verify it, the next Selenium action will fail.
NOTE: under Selenium, JavaScript prompts will NOT pop up a visible
* dialog.
NOTE: Selenium does NOT support JavaScript prompts that are generated in a
* page's onload() event handler. In this case a visible dialog WILL be
* generated and Selenium will hang until someone manually clicks OK.
*
* @return the message of the most recent JavaScript question prompt
*/
public String getPrompt() {
throw new UnsupportedOperationException("getPrompt");
}
/**
* Gets the absolute URL of the current page.
*
* @return the absolute URL of the current page
*/
public String getLocation() {
return driver.getCurrentUrl();
}
/**
* Gets the title of the current page.
*
* @return the title of the current page
*/
public String getTitle() {
return driver.getTitle();
}
/**
* Gets the entire text of the page.
*
* @return the entire text of the page
*/
public String getBodyText() {
return driver.findElement(By.xpath("//body")).getText();
}
/**
* Gets the (whitespace-trimmed) value of an input field (or anything else with a value parameter).
* For checkbox/radio elements, the value will be "on" or "off" depending on
* whether the element is checked or not.
*
* @param locator an element locator
* @return the element value, or "on/off" for checkbox/radio elements
*/
public String getValue(String locator) {
return findElement(locator).getValue();
}
/**
* Gets the text of an element. This works for any element that contains
* text. This command uses either the textContent (Mozilla-like browsers) or
* the innerText (IE-like browsers) of the element, which is the rendered
* text shown to the user.
*
* @param locator an element locator
* @return the text of the element
*/
public String getText(String locator) {
return findElement(locator).getText().trim();
}
/**
* Briefly changes the backgroundColor of the specified element yellow. Useful for debugging.
*
* @param locator an element locator
*/
public void highlight(String locator) {
callEmbeddedHtmlUtils("highlight", findElement(locator));
}
/**
* Gets the result of evaluating the specified JavaScript snippet. The snippet may
* have multiple lines, but only the result of the last line will be returned.
*
* Note that, by default, the snippet will run in the context of the "selenium"
* object itself, so this will refer to the Selenium object. Use window to
* refer to the window of your application, e.g. window.document.getElementById('foo')
If you need to use
* a locator to refer to a single element in your application page, you can
* use this.browserbot.findElement("id=foo") where "id=foo" is your locator.
*
* @param script the JavaScript snippet to run
* @return the results of evaluating the snippet
*/
public String getEval(String script) {
script = script.replaceAll("\n", "\\\\n");
script = SELENIUM_WINDOW_REF_REGEX.matcher(script).replaceAll("window");
script = SELENIUM_DOCUMENT_REF_REGEX.matcher(script).replaceAll("window.document");
script = String.format("return eval(\"%s\");", script);
return String.valueOf(((JavascriptExecutor) driver).executeScript(script));
}
/**
* Gets whether a toggle-button (checkbox/radio) is checked. Fails if the specified element doesn't exist or isn't a toggle-button.
*
* @param locator an element locator pointing to a checkbox or radio button
* @return true if the checkbox is checked, false otherwise
*/
public boolean isChecked(String locator) {
return findElement(locator).isSelected();
}
/**
* Gets the text from a cell of a table. The cellAddress syntax
* tableLocator.row.column, where row and column start at 0.
*
* @param tableCellAddress a cell address, e.g. "foo.1.4"
* @return the text from the specified cell
*/
public String getTable(String tableCellAddress) {
Matcher matcher = TABLE_PARTS.matcher(tableCellAddress);
if (!matcher.matches()) {
throw new SeleniumException("Invalid target format. Correct format is tableName.rowNum.columnNum");
}
String tableName = matcher.group(1);
long row = Long.parseLong(matcher.group(2));
long col = Long.parseLong(matcher.group(3));
WebElement table = findElement(tableName);
String script =
"var table = arguments[0]; var row = arguments[1]; var col = arguments[2];" +
"if (row > table.rows.length) { return \"Cannot access row \" + row + \" - table has \" + table.rows.length + \" rows\"; }" +
"if (col > table.rows[row].cells.length) { return \"Cannot access column \" + col + \" - table row has \" + table.rows[row].cells.length + \" columns\"; }" +
"return table.rows[row].cells[col];";
Object value = executeScript(script, table, row, col);
if (value instanceof WebElement) {
return ((WebElement) value).getText().trim();
}
throw new SeleniumException((String) value);
}
/**
* Gets all option labels (visible text) for selected options in the specified select or multi-select element.
*
* @param selectLocator an element locator identifying a drop-down menu
* @return an array of all selected option labels in the specified select drop-down
*/
public String[] getSelectedLabels(String selectLocator) {
return findSelectedOptionProperties(selectLocator, "text");
}
/**
* Gets option label (visible text) for selected option in the specified select element.
*
* @param selectLocator an element locator identifying a drop-down menu
* @return the selected option label in the specified select drop-down
*/
public String getSelectedLabel(String selectLocator) {
String[] labels = findSelectedOptionProperties(selectLocator, "text");
return labels[0]; // Since we know that there must have been at least one thing selected
}
/**
* Gets all option values (value attributes) for selected options in the specified select or multi-select element.
*
* @param selectLocator an element locator identifying a drop-down menu
* @return an array of all selected option values in the specified select drop-down
*/
public String[] getSelectedValues(String selectLocator) {
return findSelectedOptionProperties(selectLocator, "value");
}
/**
* Gets option value (value attribute) for selected option in the specified select element.
*
* @param selectLocator an element locator identifying a drop-down menu
* @return the selected option value in the specified select drop-down
*/
public String getSelectedValue(String selectLocator) {
return findSelectedOptionProperties(selectLocator, "value")[0];
}
/**
* Gets all option indexes (option number, starting at 0) for selected options in the specified select or multi-select element.
*
* @param selectLocator an element locator identifying a drop-down menu
* @return an array of all selected option indexes in the specified select drop-down
*/
public String[] getSelectedIndexes(String selectLocator) {
List options = getOptions(selectLocator);
List selected = new ArrayList();
for (int i = 0; i < options.size(); i++) {
WebElement option = options.get(i);
if (option.isSelected())
selected.add(String.valueOf(i));
}
return selected.toArray(new String[selected.size()]);
}
/**
* Gets option index (option number, starting at 0) for selected option in the specified select element.
*
* @param selectLocator an element locator identifying a drop-down menu
* @return the selected option index in the specified select drop-down
*/
public String getSelectedIndex(String selectLocator) {
List options = getOptions(selectLocator);
for (int i = 0; i < options.size(); i++) {
WebElement option = options.get(i);
if (option.isSelected())
return String.valueOf(i);
}
throw new SeleniumException("No option is selected: " + selectLocator);
}
/**
* Gets all option element IDs for selected options in the specified select or multi-select element.
*
* @param selectLocator an element locator identifying a drop-down menu
* @return an array of all selected option IDs in the specified select drop-down
*/
public String[] getSelectedIds(String selectLocator) {
return findSelectedOptionProperties(selectLocator, "id");
}
/**
* Gets option element ID for selected option in the specified select element.
*
* @param selectLocator an element locator identifying a drop-down menu
* @return the selected option ID in the specified select drop-down
*/
public String getSelectedId(String selectLocator) {
return findSelectedOptionProperties(selectLocator, "id")[0];
}
/**
* Determines whether some option in a drop-down menu is selected.
*
* @param selectLocator an element locator identifying a drop-down menu
* @return true if some option has been selected, false otherwise
*/
public boolean isSomethingSelected(String selectLocator) {
WebElement select = findElement(selectLocator);
String tagName = select.getTagName().toLowerCase();
if (!"select".equals(tagName)) {
throw new SeleniumException("Specified element is not a Select");
}
for (WebElement option : select.findElements(By.tagName("option"))) {
if (option.isSelected()) {
return true;
}
}
return false;
}
/**
* Gets all option labels in the specified select drop-down.
*
* @param selectLocator an element locator identifying a drop-down menu
* @return an array of all option labels in the specified select drop-down
*/
public String[] getSelectOptions(String selectLocator) {
WebElement select = findElement(selectLocator);
List options = select.findElements(By.tagName("option"));
List optionValues = new ArrayList();
for (WebElement option : options) {
optionValues.add(option.getText());
}
return optionValues.toArray(new String[optionValues.size()]);
}
/**
* Gets the value of an element attribute. The value of the attribute may
* differ across browsers (this is the case for the "style" attribute, for
* example).
*
* @param attributeLocator an element locator followed by an @ sign and then the name of the attribute, e.g. "foo@bar"
* @return the value of the specified attribute
*/
public String getAttribute(String attributeLocator) {
int attributePos = attributeLocator.lastIndexOf("@");
String elementLocator = attributeLocator.substring(0, attributePos);
String attributeName = attributeLocator.substring(attributePos + 1);
// Find the element.
WebElement element = findElement(elementLocator);
return element.getAttribute(attributeName);
}
/**
* Verifies that the specified text pattern appears somewhere on the rendered page shown to the user.
*
* @param pattern a pattern to match with the text of the page
* @return true if the pattern matches the text, false otherwise
*/
public boolean isTextPresent(String pattern) {
String text = driver.findElement(By.xpath("/html/body")).getText();
text = text.trim();
String strategyName = "implicit";
String use = pattern;
Matcher matcher = TEXT_MATCHING_STRATEGY_AND_VALUE_PATTERN.matcher(pattern);
if (matcher.matches()) {
strategyName = matcher.group(1);
use = matcher.group(2);
}
TextMatchingStrategy strategy = textMatchingStrategies.get(strategyName);
return strategy.isAMatch(use, text);
}
/**
* Verifies that the specified element is somewhere on the page.
*
* @param locator an element locator
* @return true if the element is present, false otherwise
*/
public boolean isElementPresent(String locator) {
try {
findElement(locator);
return true;
} catch (SeleniumException e) {
return false;
}
}
/**
* Determines if the specified element is visible. An
* element can be rendered invisible by setting the CSS "visibility"
* property to "hidden", or the "display" property to "none", either for the
* element itself or one if its ancestors. This method will fail if
* the element is not present.
*
* @param locator an element locator
* @return true if the specified element is visible, false otherwise
*/
public boolean isVisible(String locator) {
return ((RenderedWebElement) findElement(locator)).isDisplayed();
}
/**
* Determines whether the specified input element is editable, ie hasn't been disabled.
* This method will fail if the specified element isn't an input element.
*
* @param locator an element locator
* @return true if the input element is editable, false otherwise
*/
public boolean isEditable(String locator) {
WebElement element = findElement(locator);
String tagName = element.getTagName().toLowerCase();
boolean acceptableTagName = "input".equals(tagName) || "select".equals(tagName);
String readonly = "";
if ("input".equals(tagName)) {
readonly = element.getAttribute("readonly");
if (readonly == null) readonly = "";
}
return element.isEnabled() && acceptableTagName && "".equals(readonly);
}
/**
* Returns the IDs of all buttons on the page.
*
* If a given button has no ID, it will appear as "" in this array.
*
* @return the IDs of all buttons on the page
*/
public String[] getAllButtons() {
List allInputs = driver.findElements(By.xpath("//input"));
List ids = new ArrayList();
for (WebElement input : allInputs) {
String type = input.getAttribute("type").toLowerCase();
if ("button".equals(type) || "submit".equals(type) || "reset".equals(type))
ids.add(input.getAttribute("id"));
}
return ids.toArray(new String[ids.size()]);
}
/**
* Returns the IDs of all links on the page.
*
* If a given link has no ID, it will appear as "" in this array.
*
* @return the IDs of all links on the page
*/
public String[] getAllLinks() {
List allLinks = driver.findElements(By.xpath("//a"));
Iterator i = allLinks.iterator();
List links = new ArrayList();
while (i.hasNext()) {
WebElement link = i.next();
String id = link.getAttribute("id");
if (id == null)
links.add("");
else
links.add(id);
}
return links.toArray(new String[links.size()]);
}
/**
* Returns the IDs of all input fields on the page.
*
* If a given field has no ID, it will appear as "" in this array.
*
* @return the IDs of all field on the page
*/
public String[] getAllFields() {
List allInputs = driver.findElements(By.xpath("//input"));
List ids = new ArrayList();
for (WebElement input : allInputs) {
String type = input.getAttribute("type").toLowerCase();
if ("text".equals(type))
ids.add(input.getAttribute("id"));
}
return ids.toArray(new String[ids.size()]);
}
/**
* Returns every instance of some attribute from all known windows.
*
* @param attributeName name of an attribute on the windows
* @return the set of values of this attribute from all known windows.
*/
public String[] getAttributeFromAllWindows(String attributeName) {
String current = driver.getWindowHandle();
List attributes = new ArrayList();
for (String handle : driver.getWindowHandles()) {
driver.switchTo().window(handle);
String value = (String) ((JavascriptExecutor) driver).executeScript(
"return '' + window[arguments[0]];", attributeName);
attributes.add(value);
}
driver.switchTo().window(current);
return attributes.toArray(new String[attributes.size()]);
}
/**
* deprecated - use dragAndDrop instead
*
* @param locator an element locator
* @param movementsString offset in pixels from the current location to which the element should be moved, e.g., "+70,-300"
*/
public void dragdrop(String locator, String movementsString) {
dragAndDrop(locator, movementsString);
}
/**
* Configure the number of pixels between "mousemove" events during dragAndDrop commands (default=10).
* Setting this value to 0 means that we'll send a "mousemove" event to every single pixel
* in between the start location and the end location; that can be very slow, and may
* cause some browsers to force the JavaScript to timeout.
If the mouse speed is greater than the distance between the two dragged objects, we'll
* just send one "mousemove" at the start location and then one final one at the end location.
*
* @param pixels the number of pixels between "mousemove" events
*/
public void setMouseSpeed(String pixels) {
throw new UnsupportedOperationException("setMouseSpeed");
}
/**
* Returns the number of pixels between "mousemove" events during dragAndDrop commands (default=10).
*
* @return the number of pixels between "mousemove" events during dragAndDrop commands (default=10)
*/
public Number getMouseSpeed() {
throw new UnsupportedOperationException("getMouseSpeed");
}
/**
* Drags an element a certain distance and then drops it
*
* @param locator an element locator
* @param movementsString offset in pixels from the current location to which the element should be moved, e.g., "+70,-300"
*/
public void dragAndDrop(String locator, String movementsString) {
String[] parts = movementsString.split("\\s*,\\s*", 2);
int xDelta = Integer.parseInt(parts[0].trim());
int yDelta = Integer.parseInt(parts[1].trim());
((RenderedWebElement) findElement(locator)).dragAndDropBy(xDelta, yDelta);
}
/**
* Drags an element and drops it on another element
*
* @param locatorOfObjectToBeDragged an element to be dragged
* @param locatorOfDragDestinationObject an element whose location (i.e., whose center-most pixel) will be the point where locatorOfObjectToBeDragged is dropped
*/
public void dragAndDropToObject(String locatorOfObjectToBeDragged, String locatorOfDragDestinationObject) {
RenderedWebElement dragger = (RenderedWebElement) findElement(locatorOfObjectToBeDragged);
RenderedWebElement draggee = (RenderedWebElement) findElement(locatorOfDragDestinationObject);
dragger.dragAndDropOn(draggee);
}
/**
* Gives focus to the currently selected window
*/
public void windowFocus() {
executeScript("window.focus()");
}
/**
* Resize currently selected window to take up the entire screen
*/
public void windowMaximize() {
executeScript("if (window.screen) { window.moveTo(0, 0); window.resizeTo(window.screen.availWidth, window.screen.availHeight);};");
}
/**
* Returns the IDs of all windows that the browser knows about.
*
* @return the IDs of all windows that the browser knows about.
*/
public String[] getAllWindowIds() {
return getAttributeFromAllWindows("id");
}
/**
* Returns the names of all windows that the browser knows about.
*
* @return the names of all windows that the browser knows about.
*/
public String[] getAllWindowNames() {
return getAttributeFromAllWindows("name");
}
/**
* Returns the titles of all windows that the browser knows about.
*
* @return the titles of all windows that the browser knows about.
*/
public String[] getAllWindowTitles() {
String current = driver.getWindowHandle();
List attributes = new ArrayList();
for (String handle : driver.getWindowHandles()) {
driver.switchTo().window(handle);
attributes.add(driver.getTitle());
}
driver.switchTo().window(current);
return attributes.toArray(new String[attributes.size()]);
}
/**
* Returns the entire HTML source between the opening and
* closing "html" tags.
*
* @return the entire HTML source
*/
public String getHtmlSource() {
return driver.getPageSource();
}
/**
* Moves the text cursor to the specified position in the given input element or textarea.
* This method will fail if the specified element isn't an input element or textarea.
*
* @param locator an element locator pointing to an input element or textarea
* @param position the numerical position of the cursor in the field; position should be 0 to move the position to the beginning of the field. You can also set the cursor to -1 to move it to the end of the field.
*/
public void setCursorPosition(String locator, String position) {
throw new UnsupportedOperationException("setCursorPosition");
}
/**
* Get the relative index of an element to its parent (starting from 0). The comment node and empty text node
* will be ignored.
*
* @param locator an element locator pointing to an element
* @return of relative index of the element to its parent (starting from 0)
*/
public Number getElementIndex(String locator) {
WebElement element = findElement(locator);
String script =
"var _isCommentOrEmptyTextNode = function(node) {\n" +
" return node.nodeType == 8 || ((node.nodeType == 3) && !(/[^\\t\\n\\r ]/.test(node.data)));\n" +
"}\n" +
" var element = arguments[0];\n" +
" var previousSibling;\n" +
" var index = 0;\n" +
" while ((previousSibling = element.previousSibling) != null) {\n" +
" if (!_isCommentOrEmptyTextNode(previousSibling)) {\n" +
" index++;\n" +
" }\n" +
" element = previousSibling;\n" +
" }\n" +
" return index;";
return (Long) executeScript(script, element);
}
/**
* Check if these two elements have same parent and are ordered siblings in the DOM. Two same elements will
* not be considered ordered.
*
* @param locator1 an element locator pointing to the first element
* @param locator2 an element locator pointing to the second element
* @return true if element1 is the previous sibling of element2, false otherwise
*/
public boolean isOrdered(String locator1, String locator2) {
WebElement one = findElement(locator1);
WebElement two = findElement(locator2);
String ordered =
" if (arguments[0] === arguments[1]) return false;\n" +
"\n" +
" var previousSibling;\n" +
" while ((previousSibling = arguments[1].previousSibling) != null) {\n" +
" if (previousSibling === arguments[0]) {\n" +
" return true;\n" +
" }\n" +
" arguments[1] = previousSibling;\n" +
" }\n" +
" return false;\n";
Boolean result = (Boolean) executeScript(ordered, one, two);
return result == null ? false : result.booleanValue();
}
/**
* Retrieves the horizontal position of an element
*
* @param locator an element locator pointing to an element OR an element itself
* @return of pixels from the edge of the frame.
*/
public Number getElementPositionLeft(String locator) {
Point location = ((RenderedWebElement) findElement(locator)).getLocation();
return (int) location.getX();
}
/**
* Retrieves the vertical position of an element
*
* @param locator an element locator pointing to an element OR an element itself
* @return of pixels from the edge of the frame.
*/
public Number getElementPositionTop(String locator) {
Point location = ((RenderedWebElement) findElement(locator)).getLocation();
return (int) location.getY();
}
/**
* Retrieves the width of an element
*
* @param locator an element locator pointing to an element
* @return width of an element in pixels
*/
public Number getElementWidth(String locator) {
Dimension size = ((RenderedWebElement) findElement(locator)).getSize();
return (int) size.getWidth();
}
/**
* Retrieves the height of an element
*
* @param locator an element locator pointing to an element
* @return height of an element in pixels
*/
public Number getElementHeight(String locator) {
Dimension size = ((RenderedWebElement) findElement(locator)).getSize();
return (int) size.getHeight();
}
/**
* Retrieves the text cursor position in the given input element or textarea; beware, this may not work perfectly on all browsers.
*
* Specifically, if the cursor/selection has been cleared by JavaScript, this command will tend to
* return the position of the last location of the cursor, even though the cursor is now gone from the page. This is filed as SEL-243.
* This method will fail if the specified element isn't an input element or textarea, or there is no cursor in the element.
*
* @param locator an element locator pointing to an input element or textarea
* @return the numerical position of the cursor in the field
*/
public Number getCursorPosition(String locator) {
throw new UnsupportedOperationException("getCursorPosition");
}
/**
* Returns the specified expression.
*
* This is useful because of JavaScript preprocessing.
* It is used to generate commands like assertExpression and waitForExpression.
*
* @param expression the value to return
* @return the value passed in
*/
public String getExpression(String expression) {
return expression;
}
/**
* Returns the number of nodes that match the specified xpath, eg. "//table" would give
* the number of tables.
*
* @param xpath the xpath expression to evaluate. do NOT wrap this expression in a 'count()' function; we will do that for you.
* @return the number of nodes that match the specified xpath
*/
public Number getXpathCount(String xpath) {
return driver.findElements(By.xpath(xpath)).size();
}
/**
* Temporarily sets the "id" attribute of the specified element, so you can locate it in the future
* using its ID rather than a slow/complicated XPath. This ID will disappear once the page is
* reloaded.
*
* @param locator an element locator pointing to an element
* @param identifier a string to be used as the ID of the specified element
*/
public void assignId(String locator, String identifier) {
executeScript("arguments[0].id = arguments[1]", findElement(locator), identifier);
}
/**
* Specifies whether Selenium should use the native in-browser implementation
* of XPath (if any native version is available); if you pass "false" to
* this function, we will always use our pure-JavaScript xpath library.
* Using the pure-JS xpath library can improve the consistency of xpath
* element locators between different browser vendors, but the pure-JS
* version is much slower than the native implementations.
*
* @param allow boolean, true means we'll prefer to use native XPath; false means we'll only use JS XPath
*/
public void allowNativeXpath(String allow) {
// no-op
}
/**
* Specifies whether Selenium will ignore xpath attributes that have no
* value, i.e. are the empty string, when using the non-native xpath
* evaluation engine. You'd want to do this for performance reasons in IE.
* However, this could break certain xpaths, for example an xpath that looks
* for an attribute whose value is NOT the empty string.
*
* The hope is that such xpaths are relatively rare, but the user should
* have the option of using them. Note that this only influences xpath
* evaluation when using the ajaxslt engine (i.e. not "javascript-xpath").
*
* @param ignore boolean, true means we'll ignore attributes without value at the expense of xpath "correctness"; false means we'll sacrifice speed for correctness.
*/
public void ignoreAttributesWithoutValue(String ignore) {
// no-op
}
/**
* Runs the specified JavaScript snippet repeatedly until it evaluates to "true".
* The snippet may have multiple lines, but only the result of the last line
* will be considered.
*
* Note that, by default, the snippet will be run in the runner's test window, not in the window
* of your application. To get the window of your application, you can use
* the JavaScript snippet selenium.browserbot.getCurrentWindow(), and then
* run your JavaScript in there
*
* @param script the JavaScript snippet to run
* @param timeout a timeout in milliseconds, after which this command will return with an error
*/
public void waitForCondition(final String script, String timeout) {
startTimeoutThread();
new Wait() {
@Override
public boolean until() {
return (Boolean) ((JavascriptExecutor) driver).executeScript(script);
}
}.wait("Failed to resolve " + script, Long.valueOf(timeout));
stopTimeoutThreadIfExists();
}
/**
* Specifies the amount of time that Selenium will wait for actions to complete.
*
* Actions that require waiting include "open" and the "waitFor*" actions.
* The default timeout is 30 seconds.
*
* @param timeout a timeout in milliseconds, after which the action will return with an error
*/
public void setTimeout(String timeout) {
this.timeout = Long.parseLong(timeout);
}
/**
* Waits for a new page to load.
*
* You can use this command instead of the "AndWait" suffixes, "clickAndWait", "selectAndWait", "typeAndWait" etc.
* (which are only available in the JS API).
Selenium constantly keeps track of new pages loading, and sets a "newPageLoaded"
* flag when it first notices a page load. Running any other Selenium command after
* turns the flag to false. Hence, if you want to wait for a page to load, you must
* wait immediately after a Selenium command that caused a page-load.
*
* @param timeout a timeout in milliseconds, after which this command will return with an error
*/
public void waitForPageToLoad(String timeout) {
// Wait until things look like they've been stable for a second
if (!(driver instanceof JavascriptExecutor)) {
// Assume that we Do The Right Thing
return;
}
new Wait() {
private long started = System.currentTimeMillis();
public boolean until() {
Object result = ((JavascriptExecutor) driver).executeScript(
"return document['readyState'] ? 'complete' == document.readyState : true");
if (result != null && result instanceof Boolean && (Boolean) result) {
long now = System.currentTimeMillis();
if (now - started > 1000) {
return true;
}
} else {
started = System.currentTimeMillis();
}
return false;
}
}.wait(timeout);
}
/**
* Waits for a new frame to load.
*
* Selenium constantly keeps track of new pages and frames loading,
* and sets a "newPageLoaded" flag when it first notices a page load.
*
* See waitForPageToLoad for more information.
*
* @param frameAddress FrameAddress from the server side
* @param timeout a timeout in milliseconds, after which this command will return with an error
*/
public void waitForFrameToLoad(String frameAddress, String timeout) {
// no-op
}
/**
* Return all cookies of the current page under test.
*
* @return all cookies of the current page under test
*/
public String getCookie() {
StringBuilder builder = new StringBuilder();
for (Cookie c : driver.manage().getCookies()) {
builder.append(c.toString());
builder.append("; ");
}
return builder.toString();
}
/**
* Returns the value of the cookie with the specified name, or throws an error if the cookie is not present.
*
* @param name the name of the cookie
* @return the value of the cookie
*/
public String getCookieByName(String name) {
Cookie cookie = driver.manage().getCookieNamed(name);
return cookie == null ? null : cookie.getValue();
}
/**
* Returns true if a cookie with the specified name is present, or false otherwise.
*
* @param name the name of the cookie
* @return true if a cookie with the specified name is present, or false otherwise.
*/
public boolean isCookiePresent(String name) {
return getCookieByName(name) != null;
}
/**
* Create a new cookie whose path and domain are same with those of current page
* under test, unless you specified a path for this cookie explicitly.
*
* @param nameValuePair name and value of the cookie in a format "name=value"
* @param optionsString options for the cookie. Currently supported options include 'path', 'max_age' and 'domain'. the optionsString's format is "path=/path/, max_age=60, domain=.foo.com". The order of options are irrelevant, the unit of the value of 'max_age' is second. Note that specifying a domain that isn't a subset of the current domain will usually fail.
*/
public void createCookie(String nameValuePair, String optionsString) {
Matcher nameValuePairMatcher = NAME_VALUE_PAIR_PATTERN.matcher(nameValuePair);
if (!nameValuePairMatcher.find())
throw new SeleniumException("Invalid parameter: " + nameValuePair);
String name = nameValuePairMatcher.group(1);
String value = nameValuePairMatcher.group(2);
Matcher maxAgeMatcher = MAX_AGE_PATTERN.matcher(optionsString);
Date maxAge = null;
if (maxAgeMatcher.find()) {
maxAge = new Date(System.currentTimeMillis() + Integer.parseInt(maxAgeMatcher.group(1)) * 1000);
}
String path = null;
Matcher pathMatcher = PATH_PATTERN.matcher(optionsString);
if (pathMatcher.find()) {
path = pathMatcher.group(1);
try {
if (path.startsWith("http")) {
path = new URL(path).getPath();
}
} catch (MalformedURLException e) {
// Fine.
}
}
Cookie cookie = new Cookie(name, value, path, maxAge);
driver.manage().addCookie(cookie);
}
/**
* Delete a named cookie with specified path and domain. Be careful; to delete a cookie, you
* need to delete it using the exact same path and domain that were used to create the cookie.
* If the path is wrong, or the domain is wrong, the cookie simply won't be deleted. Also
* note that specifying a domain that isn't a subset of the current domain will usually fail.
*
* Since there's no way to discover at runtime the original path and domain of a given cookie,
* we've added an option called 'recurse' to try all sub-domains of the current domain with
* all paths that are a subset of the current path. Beware; this option can be slow. In
* big-O notation, it operates in O(n*m) time, where n is the number of dots in the domain
* name and m is the number of slashes in the path.
*
* @param name the name of the cookie to be deleted
* @param optionsString options for the cookie. Currently supported options include 'path', 'domain' and 'recurse.' The optionsString's format is "path=/path/, domain=.foo.com, recurse=true". The order of options are irrelevant. Note that specifying a domain that isn't a subset of the current domain will usually fail.
*/
public void deleteCookie(String name, String optionsString) {
driver.manage().deleteCookieNamed(name);
}
/**
* Calls deleteCookie with recurse=true on all cookies visible to the current page.
* As noted on the documentation for deleteCookie, recurse=true can be much slower
* than simply deleting the cookies using a known domain/path.
*/
public void deleteAllVisibleCookies() {
driver.manage().deleteAllCookies();
}
/**
* Sets the threshold for browser-side logging messages; log messages beneath this threshold will be discarded.
* Valid logLevel strings are: "debug", "info", "warn", "error" or "off".
* To see the browser logs, you need to
* either show the log window in GUI mode, or enable browser-side logging in Selenium RC.
*
* @param logLevel one of the following: "debug", "info", "warn", "error" or "off"
*/
public void setBrowserLogLevel(String logLevel) {
}
/**
* Creates a new "script" tag in the body of the current test window, and
* adds the specified text into the body of the command. Scripts run in
* this way can often be debugged more easily than scripts executed using
* Selenium's "getEval" command. Beware that JS exceptions thrown in these script
* tags aren't managed by Selenium, so you should probably wrap your script
* in try/catch blocks if there is any chance that the script will throw
* an exception.
*
* @param script the JavaScript snippet to run
*/
public void runScript(String script) {
executeScript(script);
}
/**
* Defines a new function for Selenium to locate elements on the page.
* For example,
* if you define the strategy "foo", and someone runs click("foo=blah"), we'll
* run your function, passing you the string "blah", and click on the element
* that your function
* returns, or throw an "Element not found" error if your function returns null.
*
* We'll pass three arguments to your function:
* - locator: the string the user passed in
- inWindow: the currently selected window
- inDocument: the currently selected document
* The function must return null if the element can't be found.
*
* @param strategyName the name of the strategy to define; this should use only letters [a-zA-Z] with no spaces or other punctuation.
* @param functionDefinition a string defining the body of a function in JavaScript. For example: return inDocument.getElementById(locator);
*/
public void addLocationStrategy(String strategyName, String functionDefinition) {
throw new UnsupportedOperationException("addLocationStrategy");
}
/**
* Saves the entire contents of the current window canvas to a PNG file.
* Contrast this with the captureScreenshot command, which captures the
* contents of the OS viewport (i.e. whatever is currently being displayed
* on the monitor), and is implemented in the RC only. Currently this only
* works in Firefox when running in chrome mode, and in IE non-HTA using
* the EXPERIMENTAL "Snapsie" utility. The Firefox implementation is mostly
* borrowed from the Screengrab! Firefox extension. Please see
* http://www.screengrab.org and http://snapsie.sourceforge.net/ for
* details.
*
* @param filename the path to the file to persist the screenshot as. No filename extension will be appended by default. Directories will not be created if they do not exist, and an exception will be thrown, possibly by native code.
* @param kwargs a kwargs string that modifies the way the screenshot is captured. Example: "background=#CCFFDD" . Currently valid options: - background
- the background CSS for the HTML document. This may be useful to set for capturing screenshots of less-than-ideal layouts, for example where absolute positioning causes the calculation of the canvas dimension to fail and a black background is exposed (possibly obscuring black text).
*/
public void captureEntirePageScreenshot(String filename, String kwargs) {
throw new UnsupportedOperationException("captureEntirePageScreenshot");
}
/**
* Executes a command rollup, which is a series of commands with a unique
* name, and optionally arguments that control the generation of the set of
* commands. If any one of the rolled-up commands fails, the rollup is
* considered to have failed. Rollups may also contain nested rollups.
*
* @param rollupName the name of the rollup command
* @param kwargs keyword arguments string that influences how the rollup expands into commands
*/
public void rollup(String rollupName, String kwargs) {
throw new UnsupportedOperationException("rollup");
}
/**
* Allows choice of one of the available libraries.
*
* @param libraryName name of the desired library Only the following two can be chosen: ajaxslt - Google's library javascript - Cybozu Labs' faster library The default library is ajaxslt. If libraryName isn't one of them, then no change will be made.
*/
public void useXpathLibrary(String libraryName) {
// no-op
}
/**
* Writes a message to the status bar and adds a note to the browser-side
* log.
*
* @param context the message to be sent to the browser
*/
public void setContext(String context) {
// no-op
}
/**
* Sets a file input (upload) field to the file listed in fileLocator
*
* @param fieldLocator an element locator
* @param fileLocator a URL pointing to the specified file. Before the file can be set in the input field (fieldLocator), Selenium RC may need to transfer the file to the local machine before attaching the file in a web page form. This is common in selenium grid configurations where the RC server driving the browser is not the same machine that started the test. Supported Browsers: Firefox ("*chrome") only.
*/
public void attachFile(String fieldLocator, String fileLocator) {
WebElement element = findElement(fieldLocator);
element.clear();
throw new UnsupportedOperationException("attachFile");
}
/**
* Captures a PNG screenshot to the specified file.
*
* @param filename the absolute path to the file to be written, e.g. "c:\blah\screenshot.png"
*/
public void captureScreenshot(String filename) {
throw new UnsupportedOperationException("captureScreenshot");
}
/**
* Capture a PNG screenshot. It then returns the file as a base 64 encoded string.
*
* @return The base 64 encoded string of the screen shot (PNG file)
*/
public String captureScreenshotToString() {
throw new UnsupportedOperationException("captureScreenshotToString");
}
/**
* Returns the network traffic seen by the browser, including headers,
* AJAX requests, status codes, and timings. When this function is called,
* the traffic log is cleared, so the returned content is only the traffic
* seen since the last call.
*
* @param type The type of data to return the network traffic as.
* Valid values are: json, xml, or plain.
* @return A string representation in the defined type of the network traffic seen by the browser.
*/
public String captureNetworkTraffic(String type) {
throw new UnsupportedOperationException("Not implemented yet.");
}
/**
* Downloads a screenshot of the browser current window canvas to a
* based 64 encoded PNG file. The entire windows canvas is captured,
* including parts rendered outside of the current view port.
*
* Currently this only works in Mozilla and when running in chrome mode.
*
* @param kwargs A kwargs string that modifies the way the screenshot is captured. Example: "background=#CCFFDD". This may be useful to set for capturing screenshots of less-than-ideal layouts, for example where absolute positioning causes the calculation of the canvas dimension to fail and a black background is exposed (possibly obscuring black text).
* @return The base 64 encoded string of the page screenshot (PNG file)
*/
public String captureEntirePageScreenshotToString(String kwargs) {
throw new UnsupportedOperationException("captureEntirePageScreenshotToString");
}
/**
* Kills the running Selenium Server and all browser sessions. After you run this command, you will no longer be able to send
* commands to the server; you can't remotely start the server once it has been stopped. Normally
* you should prefer to run the "stop" command, which terminates the current browser session, rather than
* shutting down the entire server.
*/
public void shutDownSeleniumServer() {
driver.quit();
}
/**
* Retrieve the last messages logged on a specific remote control. Useful for error reports, especially
* when running multiple remote controls in a distributed environment. The maximum number of log messages
* that can be retrieve is configured on remote control startup.
*
* @return The last N log messages as a multi-line string.
*/
public String retrieveLastRemoteControlLogs() {
throw new UnsupportedOperationException("retrieveLastRemoteControlLogs");
}
/**
* Simulates a user pressing a key (without releasing it yet) by sending a native operating system keystroke.
* This function uses the java.awt.Robot class to send a keystroke; this more accurately simulates typing
* a key on the keyboard. It does not honor settings from the shiftKeyDown, controlKeyDown, altKeyDown and
* metaKeyDown commands, and does not target any particular HTML element. To send a keystroke to a particular
* element, focus on the element first before running this command.
*
* @param keycode an integer keycode number corresponding to a java.awt.event.KeyEvent; note that Java keycodes are NOT the same thing as JavaScript keycodes!
*/
public void keyDownNative(String keycode) {
throw new UnsupportedOperationException("keyDownNative");
}
/**
* Simulates a user releasing a key by sending a native operating system keystroke.
* This function uses the java.awt.Robot class to send a keystroke; this more accurately simulates typing
* a key on the keyboard. It does not honor settings from the shiftKeyDown, controlKeyDown, altKeyDown and
* metaKeyDown commands, and does not target any particular HTML element. To send a keystroke to a particular
* element, focus on the element first before running this command.
*
* @param keycode an integer keycode number corresponding to a java.awt.event.KeyEvent; note that Java keycodes are NOT the same thing as JavaScript keycodes!
*/
public void keyUpNative(String keycode) {
throw new UnsupportedOperationException("keyUpNative");
}
/**
* Simulates a user pressing and releasing a key by sending a native operating system keystroke.
* This function uses the java.awt.Robot class to send a keystroke; this more accurately simulates typing
* a key on the keyboard. It does not honor settings from the shiftKeyDown, controlKeyDown, altKeyDown and
* metaKeyDown commands, and does not target any particular HTML element. To send a keystroke to a particular
* element, focus on the element first before running this command.
*
* @param keycode an integer keycode number corresponding to a java.awt.event.KeyEvent; note that Java keycodes are NOT the same thing as JavaScript keycodes!
*/
public void keyPressNative(String keycode) {
throw new UnsupportedOperationException("keyPressNative");
}
protected WebElement findElement(String locator) {
LookupStrategy strategy = findStrategy(locator);
String use = determineWebDriverLocator(locator);
try {
return strategy.find(driver, use);
} catch (NoSuchElementException e) {
throw new SeleniumException("Element " + locator + " not found");
}
}
protected LookupStrategy findStrategy(String locator) {
String strategyName = "implicit";
Matcher matcher = STRATEGY_AND_VALUE_PATTERN.matcher(locator);
if (matcher.matches()) {
strategyName = matcher.group(1);
}
LookupStrategy strategy = lookupStrategies.get(strategyName);
if (strategy == null)
throw new SeleniumException("No matcher found for " + strategyName);
return strategy;
}
protected String determineWebDriverLocator(String locator) {
String use = locator;
Matcher matcher = STRATEGY_AND_VALUE_PATTERN.matcher(locator);
if (matcher.matches()) {
use = matcher.group(2);
}
return use;
}
private void callEmbeddedSelenium(String functionName, WebElement element, Object... values) {
StringBuilder builder = new StringBuilder(readScript(injectableSelenium));
builder.append("return browserbot.").append(functionName).append(".apply(browserbot, arguments);");
List