com.thoughtworks.selenium.DefaultSelenium Maven / Gradle / Ivy
/*
* Copyright 2011 Software Freedom Conservatory.
*
* 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 com.thoughtworks.selenium;
/**
* The default implementation of the Selenium interface; end users will primarily interact with
* this object.
*/
public class DefaultSelenium implements Selenium {
protected CommandProcessor commandProcessor;
/**
* Uses a CommandBridgeClient, specifying a server host/port, a command to launch the browser, and
* a starting URL for the browser.
*
*
* browserStartCommand may be any one of the following:
*
* *firefox [absolute path] - Automatically launch a new Firefox process using a
* custom Firefox profile. This profile will be automatically configured to use the Selenium
* Server as a proxy and to have all annoying prompts ("save your password?" "forms are insecure"
* "make Firefox your default browser?" disabled. You may optionally specify an absolute path to
* your firefox executable, or just say "*firefox". If no absolute path is specified, we'll look
* for firefox.exe in a default location (normally c:\program files\mozilla firefox\firefox.exe),
* which you can override by setting the Java system property firefoxDefaultPath to
* the correct path to Firefox.*iexplore [absolute path] - Automatically launch a new Internet Explorer
* process using custom Windows registry settings. This process will be automatically configured
* to use the Selenium Server as a proxy and to have all annoying prompts ("save your password?"
* "forms are insecure" "make Firefox your default browser?" disabled. You may optionally specify
* an absolute path to your iexplore executable, or just say "*iexplore". If no absolute path is
* specified, we'll look for iexplore.exe in a default location (normally c:\program
* files\internet explorer\iexplore.exe), which you can override by setting the Java system
* property iexploreDefaultPath to the correct path to Internet Explorer./path/to/my/browser [other arguments] - You may also simply specify the
* absolute path to your browser executable, or use a relative path to your executable (which
* we'll try to find on your path). Warning: If you specify your own custom browser, it's
* up to you to configure it correctly. At a minimum, you'll need to configure your browser to use
* the Selenium Server as a proxy, and disable all browser-specific prompting.
*
*
* @param serverHost the host name on which the Selenium Server resides
* @param serverPort the port on which the Selenium Server is listening
* @param browserStartCommand the command string used to launch the browser, e.g. "*firefox",
* "*iexplore" or "c:\\program files\\internet explorer\\iexplore.exe"
* @param browserURL the starting URL including just a domain name. We'll start the browser
* pointing at the Selenium resources on this URL, e.g. "http://www.google.com" would send
* the browser to "http://www.google.com/selenium-server/SeleneseRunner.html"
*/
public DefaultSelenium(String serverHost, int serverPort, String browserStartCommand,
String browserURL) {
this.commandProcessor =
detectCommandProcessor(serverHost, serverPort, browserStartCommand, browserURL);
}
private CommandProcessor detectCommandProcessor(String serverHost, int serverPort,
String browserStartCommand, String browserURL) {
return new HttpCommandProcessor(serverHost, serverPort, browserStartCommand, browserURL);
}
/** Uses an arbitrary CommandProcessor */
public DefaultSelenium(CommandProcessor processor) {
this.commandProcessor = processor;
}
/**
* Allows javascript to be specified for the test on a per-browser session basis. The javascript
* will be in-play the next time a session is created; that is, typically the next time
* start() is invoked (and getNewBrowserSession is sent to the RC under
* the sheets).
*
* @param extensionJs a string representing the extra extension javascript to include in the
* browser session. This is in addition to any specified via the -userExtensions switch
* when starting the RC.
*/
public void setExtensionJs(String extensionJs) {
commandProcessor.setExtensionJs(extensionJs);
}
public void start() {
try {
commandProcessor.start();
} catch (Exception e) {
final String message = e.getMessage();
if (message != null && message.startsWith("Connection refused")) {
throw new RuntimeException("Could not contact Selenium Server; have you started it on '" +
commandProcessor.getRemoteControlServerLocation() +
"' ?\nRead more at http://seleniumhq.org/projects/remote-control/not-started.html\n" +
e.getMessage());
}
throw new RuntimeException("Could not start Selenium session: " + e.getMessage(), e);
}
}
public void start(String optionsString) {
try {
commandProcessor.start(optionsString);
}
// TODO: EB Add exception catching for bad BrowserConfigurationOptions (i.e. Extension Not
// Found)
catch (Exception e) {
final String message = e.getMessage();
if (message != null && message.indexOf("Connection refused: connect") != -1) {
throw new RuntimeException("Could not contact Selenium Server; have you started it?\n" +
e.getMessage());
}
throw new RuntimeException("Could not start Selenium session: " + e.getMessage(), e);
}
}
public void start(Object optionsObject) {
start(optionsObject.toString());
}
public void stop() {
commandProcessor.stop();
}
public void showContextualBanner() {
try {
StackTraceElement[] e = Thread.currentThread().getStackTrace();
String className = null;
String methodName = null;
for (int i = 0; i < e.length; i++) {
if (e[i].getClassName().equals("java.lang.Thread")
|| e[i].getMethodName().equals("showContextualBanner")) {
continue;
}
className = e[i].getClassName();
methodName = e[i].getMethodName();
break;
}
showContextualBanner(className, methodName);
} catch (Exception e) {
this.setContext("");
}
}
public void showContextualBanner(String className, String methodName) {
StringBuilder context = new StringBuilder().append(className).append(": ");
boolean lastOneWasUpperCase = false;
boolean nextOneIsUpperCase = false;
int len = methodName.length();
for (int i = 0; i < len; i++) {
char ch = methodName.charAt(i);
nextOneIsUpperCase = i < len - 1 ? Character.isUpperCase(methodName.charAt(i + 1)) : true;
if ((Character.isUpperCase(ch) && (!lastOneWasUpperCase || !nextOneIsUpperCase))) {
context.append(" ");
lastOneWasUpperCase = true;
}
if (!Character.isUpperCase(ch)) {
lastOneWasUpperCase = false;
}
context.append(ch);
}
this.setContext(context.toString());
}
public void click(String locator) {
commandProcessor.doCommand("click", new String[] {locator,});
}
public void doubleClick(String locator) {
commandProcessor.doCommand("doubleClick", new String[] {locator,});
}
public void contextMenu(String locator) {
commandProcessor.doCommand("contextMenu", new String[] {locator,});
}
public void clickAt(String locator, String coordString) {
commandProcessor.doCommand("clickAt", new String[] {locator, coordString,});
}
public void doubleClickAt(String locator, String coordString) {
commandProcessor.doCommand("doubleClickAt", new String[] {locator, coordString,});
}
public void contextMenuAt(String locator, String coordString) {
commandProcessor.doCommand("contextMenuAt", new String[] {locator, coordString,});
}
public void fireEvent(String locator, String eventName) {
commandProcessor.doCommand("fireEvent", new String[] {locator, eventName,});
}
public void focus(String locator) {
commandProcessor.doCommand("focus", new String[] {locator,});
}
public void keyPress(String locator, String keySequence) {
commandProcessor.doCommand("keyPress", new String[] {locator, keySequence,});
}
public void shiftKeyDown() {
commandProcessor.doCommand("shiftKeyDown", new String[] {});
}
public void shiftKeyUp() {
commandProcessor.doCommand("shiftKeyUp", new String[] {});
}
public void metaKeyDown() {
commandProcessor.doCommand("metaKeyDown", new String[] {});
}
public void metaKeyUp() {
commandProcessor.doCommand("metaKeyUp", new String[] {});
}
public void altKeyDown() {
commandProcessor.doCommand("altKeyDown", new String[] {});
}
public void altKeyUp() {
commandProcessor.doCommand("altKeyUp", new String[] {});
}
public void controlKeyDown() {
commandProcessor.doCommand("controlKeyDown", new String[] {});
}
public void controlKeyUp() {
commandProcessor.doCommand("controlKeyUp", new String[] {});
}
public void keyDown(String locator, String keySequence) {
commandProcessor.doCommand("keyDown", new String[] {locator, keySequence,});
}
public void keyUp(String locator, String keySequence) {
commandProcessor.doCommand("keyUp", new String[] {locator, keySequence,});
}
public void mouseOver(String locator) {
commandProcessor.doCommand("mouseOver", new String[] {locator,});
}
public void mouseOut(String locator) {
commandProcessor.doCommand("mouseOut", new String[] {locator,});
}
public void mouseDown(String locator) {
commandProcessor.doCommand("mouseDown", new String[] {locator,});
}
public void mouseDownRight(String locator) {
commandProcessor.doCommand("mouseDownRight", new String[] {locator,});
}
public void mouseDownAt(String locator, String coordString) {
commandProcessor.doCommand("mouseDownAt", new String[] {locator, coordString,});
}
public void mouseDownRightAt(String locator, String coordString) {
commandProcessor.doCommand("mouseDownRightAt", new String[] {locator, coordString,});
}
public void mouseUp(String locator) {
commandProcessor.doCommand("mouseUp", new String[] {locator,});
}
public void mouseUpRight(String locator) {
commandProcessor.doCommand("mouseUpRight", new String[] {locator,});
}
public void mouseUpAt(String locator, String coordString) {
commandProcessor.doCommand("mouseUpAt", new String[] {locator, coordString,});
}
public void mouseUpRightAt(String locator, String coordString) {
commandProcessor.doCommand("mouseUpRightAt", new String[] {locator, coordString,});
}
public void mouseMove(String locator) {
commandProcessor.doCommand("mouseMove", new String[] {locator,});
}
public void mouseMoveAt(String locator, String coordString) {
commandProcessor.doCommand("mouseMoveAt", new String[] {locator, coordString,});
}
public void type(String locator, String value) {
commandProcessor.doCommand("type", new String[] {locator, value,});
}
public void typeKeys(String locator, String value) {
commandProcessor.doCommand("typeKeys", new String[] {locator, value,});
}
public void setSpeed(String value) {
commandProcessor.doCommand("setSpeed", new String[] {value,});
}
public String getSpeed() {
return commandProcessor.getString("getSpeed", new String[] {});
}
public String getLog() {
return commandProcessor.getString("getLog", new String[] {});
}
public void check(String locator) {
commandProcessor.doCommand("check", new String[] {locator,});
}
public void uncheck(String locator) {
commandProcessor.doCommand("uncheck", new String[] {locator,});
}
public void select(String selectLocator, String optionLocator) {
commandProcessor.doCommand("select", new String[] {selectLocator, optionLocator,});
}
public void addSelection(String locator, String optionLocator) {
commandProcessor.doCommand("addSelection", new String[] {locator, optionLocator,});
}
public void removeSelection(String locator, String optionLocator) {
commandProcessor.doCommand("removeSelection", new String[] {locator, optionLocator,});
}
public void removeAllSelections(String locator) {
commandProcessor.doCommand("removeAllSelections", new String[] {locator,});
}
public void submit(String formLocator) {
commandProcessor.doCommand("submit", new String[] {formLocator,});
}
public void open(String url, String ignoreResponseCode) {
commandProcessor.doCommand("open", new String[] {url, ignoreResponseCode});
}
public void open(String url) {
commandProcessor.doCommand("open", new String[] {url,});
}
public void openWindow(String url, String windowID) {
commandProcessor.doCommand("openWindow", new String[] {url, windowID,});
}
public void selectWindow(String windowID) {
commandProcessor.doCommand("selectWindow", new String[] {windowID,});
}
public void selectPopUp(String windowID) {
commandProcessor.doCommand("selectPopUp", new String[] {windowID,});
}
public void deselectPopUp() {
commandProcessor.doCommand("deselectPopUp", new String[] {});
}
public void selectFrame(String locator) {
commandProcessor.doCommand("selectFrame", new String[] {locator,});
}
public boolean getWhetherThisFrameMatchFrameExpression(String currentFrameString, String target) {
return commandProcessor.getBoolean("getWhetherThisFrameMatchFrameExpression", new String[] {
currentFrameString, target,});
}
public boolean getWhetherThisWindowMatchWindowExpression(String currentWindowString, String target) {
return commandProcessor.getBoolean("getWhetherThisWindowMatchWindowExpression", new String[] {
currentWindowString, target,});
}
public void waitForPopUp(String windowID, String timeout) {
commandProcessor.doCommand("waitForPopUp", new String[] {windowID, timeout,});
}
public void chooseCancelOnNextConfirmation() {
commandProcessor.doCommand("chooseCancelOnNextConfirmation", new String[] {});
}
public void chooseOkOnNextConfirmation() {
commandProcessor.doCommand("chooseOkOnNextConfirmation", new String[] {});
}
public void answerOnNextPrompt(String answer) {
commandProcessor.doCommand("answerOnNextPrompt", new String[] {answer,});
}
public void goBack() {
commandProcessor.doCommand("goBack", new String[] {});
}
public void refresh() {
commandProcessor.doCommand("refresh", new String[] {});
}
public void close() {
commandProcessor.doCommand("close", new String[] {});
}
public boolean isAlertPresent() {
return commandProcessor.getBoolean("isAlertPresent", new String[] {});
}
public boolean isPromptPresent() {
return commandProcessor.getBoolean("isPromptPresent", new String[] {});
}
public boolean isConfirmationPresent() {
return commandProcessor.getBoolean("isConfirmationPresent", new String[] {});
}
public String getAlert() {
return commandProcessor.getString("getAlert", new String[] {});
}
public String getConfirmation() {
return commandProcessor.getString("getConfirmation", new String[] {});
}
public String getPrompt() {
return commandProcessor.getString("getPrompt", new String[] {});
}
public String getLocation() {
return commandProcessor.getString("getLocation", new String[] {});
}
public String getTitle() {
return commandProcessor.getString("getTitle", new String[] {});
}
public String getBodyText() {
return commandProcessor.getString("getBodyText", new String[] {});
}
public String getValue(String locator) {
return commandProcessor.getString("getValue", new String[] {locator,});
}
public String getText(String locator) {
return commandProcessor.getString("getText", new String[] {locator,});
}
public void highlight(String locator) {
commandProcessor.doCommand("highlight", new String[] {locator,});
}
public String getEval(String script) {
return commandProcessor.getString("getEval", new String[] {script,});
}
public boolean isChecked(String locator) {
return commandProcessor.getBoolean("isChecked", new String[] {locator,});
}
public String getTable(String tableCellAddress) {
return commandProcessor.getString("getTable", new String[] {tableCellAddress,});
}
public String[] getSelectedLabels(String selectLocator) {
return commandProcessor.getStringArray("getSelectedLabels", new String[] {selectLocator,});
}
public String getSelectedLabel(String selectLocator) {
return commandProcessor.getString("getSelectedLabel", new String[] {selectLocator,});
}
public String[] getSelectedValues(String selectLocator) {
return commandProcessor.getStringArray("getSelectedValues", new String[] {selectLocator,});
}
public String getSelectedValue(String selectLocator) {
return commandProcessor.getString("getSelectedValue", new String[] {selectLocator,});
}
public String[] getSelectedIndexes(String selectLocator) {
return commandProcessor.getStringArray("getSelectedIndexes", new String[] {selectLocator,});
}
public String getSelectedIndex(String selectLocator) {
return commandProcessor.getString("getSelectedIndex", new String[] {selectLocator,});
}
public String[] getSelectedIds(String selectLocator) {
return commandProcessor.getStringArray("getSelectedIds", new String[] {selectLocator,});
}
public String getSelectedId(String selectLocator) {
return commandProcessor.getString("getSelectedId", new String[] {selectLocator,});
}
public boolean isSomethingSelected(String selectLocator) {
return commandProcessor.getBoolean("isSomethingSelected", new String[] {selectLocator,});
}
public String[] getSelectOptions(String selectLocator) {
return commandProcessor.getStringArray("getSelectOptions", new String[] {selectLocator,});
}
public String getAttribute(String attributeLocator) {
return commandProcessor.getString("getAttribute", new String[] {attributeLocator,});
}
public boolean isTextPresent(String pattern) {
return commandProcessor.getBoolean("isTextPresent", new String[] {pattern,});
}
public boolean isElementPresent(String locator) {
return commandProcessor.getBoolean("isElementPresent", new String[] {locator,});
}
public boolean isVisible(String locator) {
return commandProcessor.getBoolean("isVisible", new String[] {locator,});
}
public boolean isEditable(String locator) {
return commandProcessor.getBoolean("isEditable", new String[] {locator,});
}
public String[] getAllButtons() {
return commandProcessor.getStringArray("getAllButtons", new String[] {});
}
public String[] getAllLinks() {
return commandProcessor.getStringArray("getAllLinks", new String[] {});
}
public String[] getAllFields() {
return commandProcessor.getStringArray("getAllFields", new String[] {});
}
public String[] getAttributeFromAllWindows(String attributeName) {
return commandProcessor.getStringArray("getAttributeFromAllWindows",
new String[] {attributeName,});
}
public void dragdrop(String locator, String movementsString) {
commandProcessor.doCommand("dragdrop", new String[] {locator, movementsString,});
}
public void setMouseSpeed(String pixels) {
commandProcessor.doCommand("setMouseSpeed", new String[] {pixels,});
}
public Number getMouseSpeed() {
return commandProcessor.getNumber("getMouseSpeed", new String[] {});
}
public void dragAndDrop(String locator, String movementsString) {
commandProcessor.doCommand("dragAndDrop", new String[] {locator, movementsString,});
}
public void dragAndDropToObject(String locatorOfObjectToBeDragged,
String locatorOfDragDestinationObject) {
commandProcessor.doCommand("dragAndDropToObject", new String[] {locatorOfObjectToBeDragged,
locatorOfDragDestinationObject,});
}
public void windowFocus() {
commandProcessor.doCommand("windowFocus", new String[] {});
}
public void windowMaximize() {
commandProcessor.doCommand("windowMaximize", new String[] {});
}
public String[] getAllWindowIds() {
return commandProcessor.getStringArray("getAllWindowIds", new String[] {});
}
public String[] getAllWindowNames() {
return commandProcessor.getStringArray("getAllWindowNames", new String[] {});
}
public String[] getAllWindowTitles() {
return commandProcessor.getStringArray("getAllWindowTitles", new String[] {});
}
public String getHtmlSource() {
return commandProcessor.getString("getHtmlSource", new String[] {});
}
public void setCursorPosition(String locator, String position) {
commandProcessor.doCommand("setCursorPosition", new String[] {locator, position,});
}
public Number getElementIndex(String locator) {
return commandProcessor.getNumber("getElementIndex", new String[] {locator,});
}
public boolean isOrdered(String locator1, String locator2) {
return commandProcessor.getBoolean("isOrdered", new String[] {locator1, locator2,});
}
public Number getElementPositionLeft(String locator) {
return commandProcessor.getNumber("getElementPositionLeft", new String[] {locator,});
}
public Number getElementPositionTop(String locator) {
return commandProcessor.getNumber("getElementPositionTop", new String[] {locator,});
}
public Number getElementWidth(String locator) {
return commandProcessor.getNumber("getElementWidth", new String[] {locator,});
}
public Number getElementHeight(String locator) {
return commandProcessor.getNumber("getElementHeight", new String[] {locator,});
}
public Number getCursorPosition(String locator) {
return commandProcessor.getNumber("getCursorPosition", new String[] {locator,});
}
public String getExpression(String expression) {
return commandProcessor.getString("getExpression", new String[] {expression,});
}
public Number getXpathCount(String xpath) {
return commandProcessor.getNumber("getXpathCount", new String[] {xpath,});
}
public Number getCssCount(String css) {
return commandProcessor.getNumber("getCssCount", new String[] {css,});
}
public void assignId(String locator, String identifier) {
commandProcessor.doCommand("assignId", new String[] {locator, identifier,});
}
public void allowNativeXpath(String allow) {
commandProcessor.doCommand("allowNativeXpath", new String[] {allow,});
}
public void ignoreAttributesWithoutValue(String ignore) {
commandProcessor.doCommand("ignoreAttributesWithoutValue", new String[] {ignore,});
}
public void waitForCondition(String script, String timeout) {
commandProcessor.doCommand("waitForCondition", new String[] {script, timeout,});
}
public void setTimeout(String timeout) {
commandProcessor.doCommand("setTimeout", new String[] {timeout,});
}
public void waitForPageToLoad(String timeout) {
commandProcessor.doCommand("waitForPageToLoad", new String[] {timeout,});
}
public void waitForFrameToLoad(String frameAddress, String timeout) {
commandProcessor.doCommand("waitForFrameToLoad", new String[] {frameAddress, timeout,});
}
public String getCookie() {
return commandProcessor.getString("getCookie", new String[] {});
}
public String getCookieByName(String name) {
return commandProcessor.getString("getCookieByName", new String[] {name,});
}
public boolean isCookiePresent(String name) {
return commandProcessor.getBoolean("isCookiePresent", new String[] {name,});
}
public void createCookie(String nameValuePair, String optionsString) {
commandProcessor.doCommand("createCookie", new String[] {nameValuePair, optionsString,});
}
public void deleteCookie(String name, String optionsString) {
commandProcessor.doCommand("deleteCookie", new String[] {name, optionsString,});
}
public void deleteAllVisibleCookies() {
commandProcessor.doCommand("deleteAllVisibleCookies", new String[] {});
}
public void setBrowserLogLevel(String logLevel) {
commandProcessor.doCommand("setBrowserLogLevel", new String[] {logLevel,});
}
public void runScript(String script) {
commandProcessor.doCommand("runScript", new String[] {script,});
}
public void addLocationStrategy(String strategyName, String functionDefinition) {
commandProcessor.doCommand("addLocationStrategy", new String[] {strategyName,
functionDefinition,});
}
public void captureEntirePageScreenshot(String filename, String kwargs) {
commandProcessor.doCommand("captureEntirePageScreenshot", new String[] {filename, kwargs,});
}
public void rollup(String rollupName, String kwargs) {
commandProcessor.doCommand("rollup", new String[] {rollupName, kwargs,});
}
public void addScript(String scriptContent, String scriptTagId) {
commandProcessor.doCommand("addScript", new String[] {scriptContent, scriptTagId,});
}
public void removeScript(String scriptTagId) {
commandProcessor.doCommand("removeScript", new String[] {scriptTagId,});
}
public void useXpathLibrary(String libraryName) {
commandProcessor.doCommand("useXpathLibrary", new String[] {libraryName,});
}
public void setContext(String context) {
commandProcessor.doCommand("setContext", new String[] {context,});
}
public void attachFile(String fieldLocator, String fileLocator) {
commandProcessor.doCommand("attachFile", new String[] {fieldLocator, fileLocator,});
}
public void captureScreenshot(String filename) {
commandProcessor.doCommand("captureScreenshot", new String[] {filename,});
}
public String captureScreenshotToString() {
return commandProcessor.getString("captureScreenshotToString", new String[] {});
}
public String captureNetworkTraffic(String type) {
return commandProcessor.getString("captureNetworkTraffic", new String[] {type});
}
public void addCustomRequestHeader(String key, String value) {
commandProcessor.getString("addCustomRequestHeader", new String[] {key, value});
}
public String captureEntirePageScreenshotToString(String kwargs) {
return commandProcessor
.getString("captureEntirePageScreenshotToString", new String[] {kwargs,});
}
public void shutDownSeleniumServer() {
commandProcessor.doCommand("shutDownSeleniumServer", new String[] {});
}
public String retrieveLastRemoteControlLogs() {
return commandProcessor.getString("retrieveLastRemoteControlLogs", new String[] {});
}
public void keyDownNative(String keycode) {
commandProcessor.doCommand("keyDownNative", new String[] {keycode,});
}
public void keyUpNative(String keycode) {
commandProcessor.doCommand("keyUpNative", new String[] {keycode,});
}
public void keyPressNative(String keycode) {
commandProcessor.doCommand("keyPressNative", new String[] {keycode,});
}
}