/* * Copyright 2004 ThoughtWorks, 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. * */ // TODO: stop navigating this.page().document() ... it breaks encapsulation var storedVars = new Object(); function Selenium(browserbot) { /** * Defines an object that runs Selenium commands. * *

Element Locators

*

* Element Locators tell Selenium which HTML element a command refers to. * The format of a locator is:

*
* locatorType=argument *
* *

* We support the following strategies for locating elements: *

*
*
*
identifier=id
*
Select the element with the specified @id attribute. If no match is * found, select the first element whose @name attribute is id. * (This is normally the default; see below.)
*
id=id
*
Select the element with the specified @id attribute.
* *
name=name
*
Select the first element with the specified @name attribute.
*
    *
  • username
  • *
  • name=username
  • *
*
*
The name may optionally be followed by one or more element-filters, separated from the name by whitespace. If the filterType is not specified, value is assumed.
* *
    *
  • name=flavour value=chocolate
  • *
*
*
dom=javascriptExpression
* *
* *
Find an element using JavaScript traversal of the HTML Document Object * Model. DOM locators must begin with "document.". *
    *
  • dom=document.forms['myForm'].myDropdown
  • *
  • dom=document.images[56]
  • *
*
* * * *
xpath=xpathExpression
*
Locate an element using an XPath expression. *
    *
  • xpath=//img[@alt='The image alt text']
  • *
  • xpath=//table[@id='table1']//tr[4]/td[2]
  • * *
*
*
link=textPattern
*
Select the link (anchor) element which contains text matching the * specified pattern. *
    *
  • link=The link text
  • *
* *
* *
css=cssSelectorSyntax
*
Select the element using css selectors. Please refer to CSS2 selectors, CSS3 selectors for more information. You can also check the TestCssLocators test in the selenium test suite for an example of usage, which is included in the downloaded selenium core package. *
    *
  • css=a[href="#id3"]
  • *
  • css=span#firstChild + span
  • *
*
*
Currently the css selector locator supports all css1, css2 and css3 selectors except namespace in css3, some pseudo classes(:nth-of-type, :nth-last-of-type, :first-of-type, :last-of-type, :only-of-type, :visited, :hover, :active, :focus, :indeterminate) and pseudo elements(::first-line, ::first-letter, ::selection, ::before, ::after).
*
*
*

* Without an explicit locator prefix, Selenium uses the following default * strategies: *

* * * *

Element Filters

*
*

Element filters can be used with a locator to refine a list of candidate elements. They are currently used only in the 'name' element-locator.

*

Filters look much like locators, ie.

*
* filterType=argument
* *

Supported element-filters are:

*

value=valuePattern

*
* Matches elements based on their values. This is particularly useful for refining a list of similarly-named toggle-buttons.
*

index=index

*
* Selects a single element based on its position in the list (offset from zero).
*
* *

String-match Patterns

* *

* Various Pattern syntaxes are available for matching string values: *

*
*
*
glob:pattern
*
Match a string against a "glob" (aka "wildmat") pattern. "Glob" is a * kind of limited regular-expression syntax typically used in command-line * shells. In a glob pattern, "*" represents any sequence of characters, and "?" * represents any single character. Glob patterns match against the entire * string.
*
regexp:regexp
*
Match a string using a regular-expression. The full power of JavaScript * regular-expressions is available.
*
exact:string
* *
Match a string exactly, verbatim, without any of that fancy wildcard * stuff.
*
*
*

* If no pattern prefix is specified, Selenium assumes that it's a "glob" * pattern. *

*/ this.browserbot = browserbot; this.optionLocatorFactory = new OptionLocatorFactory(); this.page = function() { return browserbot.getCurrentPage(); }; this.defaultTimeout = Selenium.DEFAULT_TIMEOUT; } Selenium.DEFAULT_TIMEOUT = 30 * 1000; Selenium.createForWindow = function(window) { if (!window.location) { throw "error: not a window!"; } return new Selenium(BrowserBot.createForWindow(window)); }; Selenium.prototype.reset = function() { this.defaultTimeout = Selenium.DEFAULT_TIMEOUT; // todo: this.browserbot.reset() this.browserbot.selectWindow("null"); this.browserbot.resetPopups(); }; Selenium.prototype.doClick = function(locator) { /** * 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 * */ var element = this.page().findElement(locator); this.page().clickElement(element); }; Selenium.prototype.doClickAt = function(locator, coordString) { /** * 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. * * Beware of http://jira.openqa.org/browse/SEL-280, which will lead some event handlers to * get null event arguments. Read the bug for more details, including a workaround. * * @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. * */ var element = this.page().findElement(locator); var clientXY = getClientXY(element, coordString) this.page().clickElement(element, clientXY[0], clientXY[1]); }; Selenium.prototype.doFireEvent = function(locator, eventName) { /** * 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" */ var element = this.page().findElement(locator); triggerEvent(element, eventName, false); }; Selenium.prototype.doKeyPress = function(locator, keySequence) { /** * 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". */ var element = this.page().findElement(locator); triggerKeyEvent(element, 'keypress', keySequence, true); }; Selenium.prototype.doKeyDown = function(locator, keySequence) { /** * 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". */ var element = this.page().findElement(locator); triggerKeyEvent(element, 'keydown', keySequence, true); }; Selenium.prototype.doKeyUp = function(locator, keySequence) { /** * 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". */ var element = this.page().findElement(locator); triggerKeyEvent(element, 'keyup', keySequence, true); }; function getClientXY(element, coordString) { // Parse coordString var coords = null; var x; var y; if (coordString) { coords = coordString.split(/,/); x = Number(coords[0]); y = Number(coords[1]); } else { x = y = 0; } // Get position of element, // Return 2 item array with clientX and clientY return [Selenium.prototype.getElementPositionLeft(element) + x, Selenium.prototype.getElementPositionTop(element) + y]; } Selenium.prototype.doMouseOver = function(locator) { /** * Simulates a user hovering a mouse over the specified element. * * @param locator an element locator */ var element = this.page().findElement(locator); triggerMouseEvent(element, 'mouseover', true); }; Selenium.prototype.doMouseOut = function(locator) { /** * Simulates a user moving the mouse pointer away from the specified element. * * @param locator an element locator */ var element = this.page().findElement(locator); triggerMouseEvent(element, 'mouseout', true); }; Selenium.prototype.doMouseDown = function(locator) { /** * Simulates a user pressing the mouse button (without releasing it yet) on * the specified element. * * @param locator an element locator */ var element = this.page().findElement(locator); triggerMouseEvent(element, 'mousedown', true); }; Selenium.prototype.doMouseDownAt = function(locator, coordString) { /** * Simulates a user pressing the mouse button (without releasing it yet) on * the specified element. * * Beware of http://jira.openqa.org/browse/SEL-280, which will lead some event handlers to * get null event arguments. Read the bug for more details, including a workaround. * * @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. */ var element = this.page().findElement(locator); var clientXY = getClientXY(element, coordString) triggerMouseEvent(element, 'mousedown', true, clientXY[0], clientXY[1]); }; Selenium.prototype.doMouseUp = function(locator) { /** * Simulates a user pressing the mouse button (without releasing it yet) on * the specified element. * * @param locator an element locator */ var element = this.page().findElement(locator); triggerMouseEvent(element, 'mouseup', true); }; Selenium.prototype.doMouseUpAt = function(locator, coordString) { /** * Simulates a user pressing the mouse button (without releasing it yet) on * the specified element. * * Beware of http://jira.openqa.org/browse/SEL-280, which will lead some event handlers to * get null event arguments. Read the bug for more details, including a workaround. * * @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. */ var element = this.page().findElement(locator); var clientXY = getClientXY(element, coordString) triggerMouseEvent(element, 'mouseup', true, clientXY[0], clientXY[1]); }; Selenium.prototype.doMouseMove = function(locator) { /** * Simulates a user pressing the mouse button (without releasing it yet) on * the specified element. * * @param locator an element locator */ var element = this.page().findElement(locator); triggerMouseEvent(element, 'mousemove', true); }; Selenium.prototype.doMouseMoveAt = function(locator, coordString) { /** * Simulates a user pressing the mouse button (without releasing it yet) on * the specified element. * * Beware of http://jira.openqa.org/browse/SEL-280, which will lead some event handlers to * get null event arguments. Read the bug for more details, including a workaround. * * @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. */ var element = this.page().findElement(locator); var clientXY = getClientXY(element, coordString) triggerMouseEvent(element, 'mousemove', true, clientXY[0], clientXY[1]); }; Selenium.prototype.doType = function(locator, value) { /** * 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 */ // TODO fail if it can't be typed into. var element = this.page().findElement(locator); this.page().replaceText(element, value); }; Selenium.prototype.findToggleButton = function(locator) { var element = this.page().findElement(locator); if (element.checked == null) { Assert.fail("Element " + locator + " is not a toggle-button."); } return element; } Selenium.prototype.doCheck = function(locator) { /** * Check a toggle-button (checkbox/radio) * * @param locator an element locator */ this.findToggleButton(locator).checked = true; }; Selenium.prototype.doUncheck = function(locator) { /** * Uncheck a toggle-button (checkbox/radio) * * @param locator an element locator */ this.findToggleButton(locator).checked = false; }; Selenium.prototype.doSelect = function(selectLocator, optionLocator) { /** * 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.) * *
*
value=valuePattern
*
matches options based on their values. * * * *
*
id=id
* *
matches options based on their ids. * *
*
index=index
*
matches an option based on its index (offset from zero). * *
*
*

* 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) */ var element = this.page().findElement(selectLocator); if (!("options" in element)) { throw new SeleniumError("Specified element is not a Select (has no options)"); } var locator = this.optionLocatorFactory.fromLocatorString(optionLocator); var option = locator.findOption(element); this.page().selectOption(element, option); }; Selenium.prototype.doAddSelection = function(locator, optionLocator) { /** * Add a selection to the set of selected options in a multi-select element using an option locator. * * @see #doSelect for details of option locators * * @param locator an element locator identifying a multi-select box * @param optionLocator an option locator (a label by default) */ var element = this.page().findElement(locator); if (!("options" in element)) { throw new SeleniumError("Specified element is not a Select (has no options)"); } var locator = this.optionLocatorFactory.fromLocatorString(optionLocator); var option = locator.findOption(element); this.page().addSelection(element, option); }; Selenium.prototype.doRemoveSelection = function(locator, optionLocator) { /** * Remove a selection from the set of selected options in a multi-select element using an option locator. * * @see #doSelect for details of option locators * * @param locator an element locator identifying a multi-select box * @param optionLocator an option locator (a label by default) */ var element = this.page().findElement(locator); if (!("options" in element)) { throw new SeleniumError("Specified element is not a Select (has no options)"); } var locator = this.optionLocatorFactory.fromLocatorString(optionLocator); var option = locator.findOption(element); this.page().removeSelection(element, option); }; Selenium.prototype.doSubmit = function(formLocator) { /** * 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 */ var form = this.page().findElement(formLocator); var actuallySubmit = true; if (form.onsubmit) { if (browserVersion.isHTA) { // run the code in the correct window so alerts are handled correctly even in HTA mode var win = this.browserbot.getCurrentWindow(); var now = new Date().getTime(); var marker = 'marker' + now; win[marker] = form; win.setTimeout("var actuallySubmit = "+marker+".onsubmit(); if (actuallySubmit) { "+marker+".submit(); };", 0); // pause for at least 20ms for this command to run testLoop.waitForCondition = function () { return new Date().getTime() > (now + 20); } } else { actuallySubmit = form.onsubmit(); if (actuallySubmit) { form.submit(); } } } else { form.submit(); } }; Selenium.prototype.makePageLoadCondition = function(timeout) { if (timeout == null) { timeout = this.defaultTimeout; } return decorateFunctionWithTimeout(this._isNewPageLoaded.bind(this), timeout); }; Selenium.prototype.doOpen = function(url) { /** * 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 */ this.browserbot.openLocation(url); return this.makePageLoadCondition(); }; Selenium.prototype.doSelectWindow = function(windowID) { /** * Selects a popup window; once a popup window has been selected, all * commands go to that window. To select the main window again, use "null" * as the target. * * @param windowID the JavaScript window ID of the window to select */ this.browserbot.selectWindow(windowID); }; Selenium.prototype.doSelectFrame = function(locator) { /** * 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 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 */ this.browserbot.selectFrame(locator); }; Selenium.prototype.getLogMessages = function() { /** * Return the contents of the log. * *

This is a placeholder intended to make the code generator make this API * available to clients. The selenium server will intercept this call, however, * and return its recordkeeping of log messages since the last call to this API. * Thus this code in JavaScript will never be called.

* *

The reason I opted for a servercentric solution is to be able to support * multiple frames served from different domains, which would break a * centralized JavaScript logging mechanism under some conditions.

* * @return string all log messages seen since the last call to this API */ return "getLogMessages should be implemented in the selenium server"; }; Selenium.prototype.getWhetherThisFrameMatchFrameExpression = function(currentFrameString, target) { /** * 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 boolean true if the new frame is this code's window */ var isDom = false; if (target.indexOf("dom=") == 0) { target = target.substr(4); isDom = true; } var t; try { eval("t=" + currentFrameString + "." + target); } catch (e) { } var autWindow = this.browserbot.getCurrentWindow(); if (t != null) { if (t.window == autWindow) { return true; } return false; } if (isDom) { return false; } var currentFrame; eval("currentFrame=" + currentFrameString); if (target == "relative=up") { if (currentFrame.window.parent == autWindow) { return true; } return false; } if (target == "relative=top") { if (currentFrame.window.top == autWindow) { return true; } return false; } if (autWindow.name == target && currentFrame.window == autWindow.parent) { return true; } return false; }; Selenium.prototype.doWaitForPopUp = function(windowID, timeout) { /** * Waits for a popup window to appear and load up. * * @param windowID the JavaScript window ID of the window that will appear * @param timeout a timeout in milliseconds, after which the action will return with an error */ if (isNaN(timeout)) { throw new SeleniumError("Timeout is not a number: " + timeout); } var popupLoadedPredicate = function () { var targetWindow = selenium.browserbot.getWindowByName(windowID, true); if (!targetWindow) return false; if (!targetWindow.location) return false; if ("about:blank" == targetWindow.location) return false; if (browserVersion.isKonqueror) { if ("/" == targetWindow.location.href) { // apparently Konqueror uses this as the temporary location, instead of about:blank return false; } } if (browserVersion.isSafari) { if(targetWindow.location.href == selenium.browserbot.buttonWindow.location.href) { // Apparently Safari uses this as the temporary location, instead of about:blank // what a world! LOG.debug("DGF what a world!"); return false; } } if (!targetWindow.document) return false; if (!selenium.browserbot.getCurrentWindow().document.readyState) { // This is Firefox, with no readyState extension return true; } if ('complete' != targetWindow.document.readyState) return false; return true; }; return decorateFunctionWithTimeout(popupLoadedPredicate, timeout); } Selenium.prototype.doWaitForPopUp.dontCheckAlertsAndConfirms = true; Selenium.prototype.doChooseCancelOnNextConfirmation = function() { /** * 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. * */ this.browserbot.cancelNextConfirmation(); }; Selenium.prototype.doAnswerOnNextPrompt = function(answer) { /** * 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 */ this.browserbot.setNextPromptResult(answer); }; Selenium.prototype.doGoBack = function() { /** * Simulates the user clicking the "back" button on their browser. * */ this.page().goBack(); }; Selenium.prototype.doRefresh = function() { /** * Simulates the user clicking the "Refresh" button on their browser. * */ this.page().refresh(); }; Selenium.prototype.doClose = function() { /** * Simulates the user clicking the "close" button in the titlebar of a popup * window or tab. */ this.page().close(); }; Selenium.prototype.ensureNoUnhandledPopups = function() { if (this.browserbot.hasAlerts()) { throw new SeleniumError("There was an unexpected Alert! [" + this.browserbot.getNextAlert() + "]"); } if ( this.browserbot.hasConfirmations() ) { throw new SeleniumError("There was an unexpected Confirmation! [" + this.browserbot.getNextConfirmation() + "]"); } }; Selenium.prototype.isAlertPresent = function() { /** * Has an alert occurred? * *

* This function never throws an exception *

* @return boolean true if there is an alert */ return this.browserbot.hasAlerts(); }; Selenium.prototype.isPromptPresent = function() { /** * Has a prompt occurred? * *

* This function never throws an exception *

* @return boolean true if there is a pending prompt */ return this.browserbot.hasPrompts(); }; Selenium.prototype.isConfirmationPresent = function() { /** * Has confirm() been called? * *

* This function never throws an exception *

* @return boolean true if there is a pending confirmation */ return this.browserbot.hasConfirmations(); }; Selenium.prototype.getAlert = function() { /** * 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 get/verify it, the next Selenium action * will fail.

* *

NOTE: under Selenium, JavaScript alerts will NOT pop up a visible alert * dialog.

* *

NOTE: 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 string The message of the most recent JavaScript alert */ if (!this.browserbot.hasAlerts()) { Assert.fail("There were no alerts"); } return this.browserbot.getNextAlert(); }; Selenium.prototype.getAlert.dontCheckAlertsAndConfirms = true; Selenium.prototype.getConfirmation = function() { /** * 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 get/verify it, 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 string the message of the most recent JavaScript confirmation dialog */ if (!this.browserbot.hasConfirmations()) { Assert.fail("There were no confirmations"); } return this.browserbot.getNextConfirmation(); }; Selenium.prototype.getConfirmation.dontCheckAlertsAndConfirms = true; Selenium.prototype.getPrompt = function() { /** * 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 string the message of the most recent JavaScript question prompt */ if (! this.browserbot.hasPrompts()) { Assert.fail("There were no prompts"); } return this.browserbot.getNextPrompt(); }; Selenium.prototype.getLocation = function() { /** Gets the absolute URL of the current page. * * @return string the absolute URL of the current page */ return this.page().getCurrentWindow().location; }; Selenium.prototype.getTitle = function() { /** Gets the title of the current page. * * @return string the title of the current page */ return this.page().getTitle(); }; Selenium.prototype.getBodyText = function() { /** * Gets the entire text of the page. * @return string the entire text of the page */ return this.page().bodyText(); }; Selenium.prototype.getValue = function(locator) { /** * 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 string the element value, or "on/off" for checkbox/radio elements */ var element = this.page().findElement(locator) return getInputValue(element).trim(); } Selenium.prototype.getText = function(locator) { /** * 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 string the text of the element */ var element = this.page().findElement(locator); return getText(element).trim(); }; Selenium.prototype.getEval = function(script) { /** 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, and window will * refer to the top-level runner test window, not the window of your application.

* *

If you need a reference to the window of your application, you can refer * to this.browserbot.getCurrentWindow() and if you need to use * a locator to refer to a single element in your application page, you can * use this.page().findElement("foo") where "foo" is your locator.

* * @param script the JavaScript snippet to run * @return string the results of evaluating the snippet */ try { var result = eval(script); // Selenium RC doesn't allow returning null if (null == result) return "null"; return result; } catch (e) { throw new SeleniumError("Threw an exception: " + e.message); } }; Selenium.prototype.isChecked = function(locator) { /** * 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 boolean true if the checkbox is checked, false otherwise */ var element = this.page().findElement(locator); if (element.checked == null) { throw new SeleniumError("Element " + locator + " is not a toggle-button."); } return element.checked; }; Selenium.prototype.getTable = function(tableCellAddress) { /** * 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 string the text from the specified cell */ // This regular expression matches "tableName.row.column" // For example, "mytable.3.4" pattern = /(.*)\.(\d+)\.(\d+)/; if(!pattern.test(tableCellAddress)) { throw new SeleniumError("Invalid target format. Correct format is tableName.rowNum.columnNum"); } pieces = tableCellAddress.match(pattern); tableName = pieces[1]; row = pieces[2]; col = pieces[3]; var table = this.page().findElement(tableName); if (row > table.rows.length) { Assert.fail("Cannot access row " + row + " - table has " + table.rows.length + " rows"); } else if (col > table.rows[row].cells.length) { Assert.fail("Cannot access column " + col + " - table row has " + table.rows[row].cells.length + " columns"); } else { actualContent = getText(table.rows[row].cells[col]); return actualContent.trim(); } return null; }; Selenium.prototype.getSelectedLabels = function(selectLocator) { /** 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 string[] an array of all selected option labels in the specified select drop-down */ return this.findSelectedOptionProperties(selectLocator, "text").join(","); } Selenium.prototype.getSelectedLabel = function(selectLocator) { /** Gets option label (visible text) for selected option in the specified select element. * * @param selectLocator an element locator identifying a drop-down menu * @return string the selected option label in the specified select drop-down */ return this.findSelectedOptionProperty(selectLocator, "text"); } Selenium.prototype.getSelectedValues = function(selectLocator) { /** 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 string[] an array of all selected option values in the specified select drop-down */ return this.findSelectedOptionProperties(selectLocator, "value").join(","); } Selenium.prototype.getSelectedValue = function(selectLocator) { /** Gets option value (value attribute) for selected option in the specified select element. * * @param selectLocator an element locator identifying a drop-down menu * @return string the selected option value in the specified select drop-down */ return this.findSelectedOptionProperty(selectLocator, "value"); } Selenium.prototype.getSelectedIndexes = function(selectLocator) { /** 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 string[] an array of all selected option indexes in the specified select drop-down */ return this.findSelectedOptionProperties(selectLocator, "index").join(","); } Selenium.prototype.getSelectedIndex = function(selectLocator) { /** 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 string the selected option index in the specified select drop-down */ return this.findSelectedOptionProperty(selectLocator, "index"); } Selenium.prototype.getSelectedIds = function(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 string[] an array of all selected option IDs in the specified select drop-down */ return this.findSelectedOptionProperties(selectLocator, "id").join(","); } Selenium.prototype.getSelectedId = function(selectLocator) { /** Gets option element ID for selected option in the specified select element. * * @param selectLocator an element locator identifying a drop-down menu * @return string the selected option ID in the specified select drop-down */ return this.findSelectedOptionProperty(selectLocator, "id"); } Selenium.prototype.isSomethingSelected = function(selectLocator) { /** Determines whether some option in a drop-down menu is selected. * * @param selectLocator an element locator identifying a drop-down menu * @return boolean true if some option has been selected, false otherwise */ var element = this.page().findElement(selectLocator); if (!("options" in element)) { throw new SeleniumError("Specified element is not a Select (has no options)"); } var selectedOptions = []; for (var i = 0; i < element.options.length; i++) { if (element.options[i].selected) { return true; } } return false; } Selenium.prototype.findSelectedOptionProperties = function(locator, property) { var element = this.page().findElement(locator); if (!("options" in element)) { throw new SeleniumError("Specified element is not a Select (has no options)"); } var selectedOptions = []; for (var i = 0; i < element.options.length; i++) { if (element.options[i].selected) { var propVal = element.options[i][property]; if (propVal.replace) { propVal.replace(/,/g, "\\,"); } selectedOptions.push(propVal); } } if (selectedOptions.length == 0) Assert.fail("No option selected"); return selectedOptions; } Selenium.prototype.findSelectedOptionProperty = function(locator, property) { var selectedOptions = this.findSelectedOptionProperties(locator, property); if (selectedOptions.length > 1) { Assert.fail("More than one selected option!"); } return selectedOptions[0]; } Selenium.prototype.getSelectOptions = function(selectLocator) { /** Gets all option labels in the specified select drop-down. * * @param selectLocator an element locator identifying a drop-down menu * @return string[] an array of all option labels in the specified select drop-down */ var element = this.page().findElement(selectLocator); var selectOptions = []; for (var i = 0; i < element.options.length; i++) { var option = element.options[i].text.replace(/,/g, "\\,"); selectOptions.push(option); } return selectOptions.join(","); }; Selenium.prototype.getAttribute = function(attributeLocator) { /** * Gets the value of an element attribute. * * Beware of http://jira.openqa.org/browse/SEL-280, which will lead some event handlers to * get null event arguments. Read the bug for more details, including a workaround. * * @param attributeLocator an element locator followed by an @ sign and then the name of the attribute, e.g. "foo@bar" * @return string the value of the specified attribute */ var result = this.page().findAttribute(attributeLocator); if (result == null) { throw new SeleniumError("Could not find element attribute: " + attributeLocator); } return result; }; Selenium.prototype.isTextPresent = function(pattern) { /** * 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 boolean true if the pattern matches the text, false otherwise */ var allText = this.page().bodyText(); var patternMatcher = new PatternMatcher(pattern); if (patternMatcher.strategy == PatternMatcher.strategies.glob) { patternMatcher.matcher = new PatternMatcher.strategies.globContains(pattern); } else if (patternMatcher.strategy == PatternMatcher.strategies.exact) { pattern = pattern.substring("exact:".length); // strip off "exact:" return allText.indexOf(pattern) != -1; } return patternMatcher.matches(allText); }; Selenium.prototype.isElementPresent = function(locator) { /** * Verifies that the specified element is somewhere on the page. * @param locator an element locator * @return boolean true if the element is present, false otherwise */ try { this.page().findElement(locator); } catch (e) { return false; } return true; }; Selenium.prototype.isVisible = function(locator) { /** * 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 boolean true if the specified element is visible, false otherwise */ var element; element = this.page().findElement(locator); var visibility = this.findEffectiveStyleProperty(element, "visibility"); var _isDisplayed = this._isDisplayed(element); return (visibility != "hidden" && _isDisplayed); }; Selenium.prototype.findEffectiveStyleProperty = function(element, property) { var effectiveStyle = this.findEffectiveStyle(element); var propertyValue = effectiveStyle[property]; if (propertyValue == 'inherit' && element.parentNode.style) { return this.findEffectiveStyleProperty(element.parentNode, property); } return propertyValue; }; Selenium.prototype._isDisplayed = function(element) { var display = this.findEffectiveStyleProperty(element, "display"); if (display == "none") return false; if (element.parentNode.style) { return this._isDisplayed(element.parentNode); } return true; }; Selenium.prototype.findEffectiveStyle = function(element) { if (element.style == undefined) { return undefined; // not a styled element } var window = this.browserbot.getCurrentWindow(); if (window.getComputedStyle) { // DOM-Level-2-CSS return window.getComputedStyle(element, null); } if (element.currentStyle) { // non-standard IE alternative return element.currentStyle; // TODO: this won't really work in a general sense, as // currentStyle is not identical to getComputedStyle() // ... but it's good enough for "visibility" } throw new SeleniumError("cannot determine effective stylesheet in this browser"); }; Selenium.prototype.isEditable = function(locator) { /** * 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 boolean true if the input element is editable, false otherwise */ var element = this.page().findElement(locator); if (element.value == undefined) { Assert.fail("Element " + locator + " is not an input."); } return !element.disabled; }; Selenium.prototype.getAllButtons = function() { /** Returns the IDs of all buttons on the page. * *

If a given button has no ID, it will appear as "" in this array.

* * @return string[] the IDs of all buttons on the page */ return this.page().getAllButtons(); }; Selenium.prototype.getAllLinks = function() { /** Returns the IDs of all links on the page. * *

If a given link has no ID, it will appear as "" in this array.

* * @return string[] the IDs of all links on the page */ return this.page().getAllLinks(); }; Selenium.prototype.getAllFields = function() { /** 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 string[] the IDs of all field on the page */ return this.page().getAllFields(); }; Selenium.prototype._getTestAppParentOfAllWindows = function() { /** 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 string[] the IDs of all field on the page */ if (this.browserbot.getCurrentWindow().opener!=null) { return this.browserbot.getCurrentWindow().opener; } if (this.browserbot.buttonWindow!=null) { return this.browserbot.buttonWindow; } return top; // apparently we are in proxy injection mode }; Selenium.prototype.getAttributeFromAllWindows = function(attributeName) { /** Returns every instance of some attribute from all known windows. * * @param attributeName name of an attribute on the windows * @return string[] the set of values of this attribute from all known windows. */ var attributes = new Array(); var testAppParentOfAllWindows = this._getTestAppParentOfAllWindows(); attributes.push(eval("testAppParentOfAllWindows." + attributeName)); var selenium = testAppParentOfAllWindows.selenium==null ? testAppParentOfAllWindows.parent.selenium : testAppParentOfAllWindows.selenium; for (windowName in selenium.browserbot.openedWindows) { attributes.push(eval("selenium.browserbot.openedWindows[windowName]." + attributeName)); } return attributes; }; Selenium.prototype.findWindow = function(soughtAfterWindowPropertyValue) { var testAppParentOfAllWindows = this._getTestAppParentOfAllWindows(); var targetPropertyName = "name"; if (soughtAfterWindowPropertyValue.match("^title=")) { targetPropertyName = "document.title"; soughtAfterWindowPropertyValue = soughtAfterWindowPropertyValue.replace(/^title=/, ""); } else { // matching "name": // If we are not in proxy injection mode, then the top-level test window will be named myiframe. // But as far as the interface goes, we are expected to match a blank string to this window, if // we are searching with respect to the widow name. // So make a special case so that this logic will work: if (PatternMatcher.matches(soughtAfterWindowPropertyValue, "")) { return this.browserbot.getCurrentWindow(); } } if (PatternMatcher.matches(soughtAfterWindowPropertyValue, eval("testAppParentOfAllWindows." + targetPropertyName))) { return testAppParentOfAllWindows; } for (windowName in selenium.browserbot.openedWindows) { var openedWindow = selenium.browserbot.openedWindows[windowName]; if (PatternMatcher.matches(soughtAfterWindowPropertyValue, eval("openedWindow." + targetPropertyName))) { return openedWindow; } } throw new SeleniumError("could not find window with property " + targetPropertyName + " matching " + soughtAfterWindowPropertyValue); }; Selenium.prototype.doDragdrop = function(locator, movementsString) { /** Drags an element a certain distance and then drops it * Beware of http://jira.openqa.org/browse/SEL-280, which will lead some event handlers to * get null event arguments. Read the bug for more details, including a workaround. * * @param movementsString offset in pixels from the current location to which the element should be moved, e.g., "+70,-300" * @param locator an element locator */ var element = this.page().findElement(locator); var clientStartXY = getClientXY(element) var clientStartX = clientStartXY[0]; var clientStartY = clientStartXY[1]; var movements = movementsString.split(/,/); var movementX = Number(movements[0]); var movementY = Number(movements[1]); var clientFinishX = ((clientStartX + movementX) < 0) ? 0 : (clientStartX + movementX); var clientFinishY = ((clientStartY + movementY) < 0) ? 0 : (clientStartY + movementY); var movementXincrement = (movementX > 0) ? 1 : -1; var movementYincrement = (movementY > 0) ? 1 : -1; triggerMouseEvent(element, 'mousedown', true, clientStartX, clientStartY); var clientX = clientStartX; var clientY = clientStartY; while ((clientX != clientFinishX) || (clientY != clientFinishY)) { if (clientX != clientFinishX) { clientX += movementXincrement; } if (clientY != clientFinishY) { clientY += movementYincrement; } triggerMouseEvent(element, 'mousemove', true, clientX, clientY); } triggerMouseEvent(element, 'mouseup', true, clientFinishX, clientFinishY); }; Selenium.prototype.doWindowFocus = function(windowName) { /** Gives focus to a window * * @param windowName name of the window to be given focus */ this.findWindow(windowName).focus(); }; Selenium.prototype.doWindowMaximize = function(windowName) { /** Resize window to take up the entire screen * * @param windowName name of the window to be enlarged */ var window = this.findWindow(windowName); if (window!=null && window.screen) { window.moveTo(0,0); window.outerHeight = screen.availHeight; window.outerWidth = screen.availWidth; } }; Selenium.prototype.getAllWindowIds = function() { /** Returns the IDs of all windows that the browser knows about. * * @return string[] the IDs of all windows that the browser knows about. */ return this.getAttributeFromAllWindows("id"); }; Selenium.prototype.getAllWindowNames = function() { /** Returns the names of all windows that the browser knows about. * * @return string[] the names of all windows that the browser knows about. */ return this.getAttributeFromAllWindows("name"); }; Selenium.prototype.getAllWindowTitles = function() { /** Returns the titles of all windows that the browser knows about. * * @return string[] the titles of all windows that the browser knows about. */ return this.getAttributeFromAllWindows("document.title"); }; Selenium.prototype.getHtmlSource = function() { /** Returns the entire HTML source between the opening and * closing "html" tags. * * @return string the entire HTML source */ return this.page().document().getElementsByTagName("html")[0].innerHTML; }; Selenium.prototype.doSetCursorPosition = function(locator, position) { /** * 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. */ var element = this.page().findElement(locator); if (element.value == undefined) { Assert.fail("Element " + locator + " is not an input."); } if (position == -1) { position = element.value.length; } if( element.setSelectionRange && !browserVersion.isOpera) { element.focus(); element.setSelectionRange(/*start*/position,/*end*/position); } else if( element.createTextRange ) { triggerEvent(element, 'focus', false); var range = element.createTextRange(); range.collapse(true); range.moveEnd('character',position); range.moveStart('character',position); range.select(); } } Selenium.prototype.getElementIndex = function(locator) { /** * 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 number of relative index of the element to its parent (starting from 0) */ var element = this.page().findElement(locator); var previousSibling; var index = 0; while ((previousSibling = element.previousSibling) != null) { if (!this._isCommentOrEmptyTextNode(previousSibling)) { index++; } element = previousSibling; } return index; } Selenium.prototype.isOrdered = function(locator1, locator2) { /** * Check if these two elements have same parent and are ordered. 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 boolean true if two elements are ordered and have same parent, false otherwise */ var element1 = this.page().findElement(locator1); var element2 = this.page().findElement(locator2); if (element1 === element2) return false; var previousSibling; while ((previousSibling = element2.previousSibling) != null) { if (previousSibling === element1) { return true; } element2 = previousSibling; } return false; } Selenium.prototype._isCommentOrEmptyTextNode = function(node) { return node.nodeType == 8 || ((node.nodeType == 3) && !(/[^\t\n\r ]/.test(node.data))); } Selenium.prototype.getElementPositionLeft = function(locator) { /** * Retrieves the horizontal position of an element * * @param locator an element locator pointing to an element OR an element itself * @return number of pixels from the edge of the frame. */ var element; if ("string"==typeof locator) { element = this.page().findElement(locator); } else { element = locator; } var x = element.offsetLeft; var elementParent = element.offsetParent; while (elementParent != null) { if(document.all) { if( (elementParent.tagName != "TABLE") && (elementParent.tagName != "BODY") ) { x += elementParent.clientLeft; } } else // Netscape/DOM { if(elementParent.tagName == "TABLE") { var parentBorder = parseInt(elementParent.border); if(isNaN(parentBorder)) { var parentFrame = elementParent.getAttribute('frame'); if(parentFrame != null) { x += 1; } } else if(parentBorder > 0) { x += parentBorder; } } } x += elementParent.offsetLeft; elementParent = elementParent.offsetParent; } return x; }; Selenium.prototype.getElementPositionTop = function(locator) { /** * Retrieves the vertical position of an element * * @param locator an element locator pointing to an element OR an element itself * @return number of pixels from the edge of the frame. */ var element; if ("string"==typeof locator) { element = this.page().findElement(locator); } else { element = locator; } var y = 0; while (element != null) { if(document.all) { if( (element.tagName != "TABLE") && (element.tagName != "BODY") ) { y += element.clientTop; } } else // Netscape/DOM { if(element.tagName == "TABLE") { var parentBorder = parseInt(element.border); if(isNaN(parentBorder)) { var parentFrame = element.getAttribute('frame'); if(parentFrame != null) { y += 1; } } else if(parentBorder > 0) { y += parentBorder; } } } y += element.offsetTop; // Netscape can get confused in some cases, such that the height of the parent is smaller // than that of the element (which it shouldn't really be). If this is the case, we need to // exclude this element, since it will result in too large a 'top' return value. if (element.offsetParent && element.offsetParent.offsetHeight && element.offsetParent.offsetHeight < element.offsetHeight) { // skip the parent that's too small element = element.offsetParent.offsetParent; } else { // Next up... element = element.offsetParent; } } return y; }; Selenium.prototype.getElementWidth = function(locator) { /** * Retrieves the width of an element * * @param locator an element locator pointing to an element * @return number width of an element in pixels */ var element = this.page().findElement(locator); return element.offsetWidth; }; Selenium.prototype.getElementHeight = function(locator) { /** * Retrieves the height of an element * * @param locator an element locator pointing to an element * @return number height of an element in pixels */ var element = this.page().findElement(locator); return element.offsetHeight; }; Selenium.prototype.getCursorPosition = function(locator) { /** * 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 number the numerical position of the cursor in the field */ var element = this.page().findElement(locator); var doc = this.page().getDocument(); var win = this.browserbot.getCurrentWindow(); if( doc.selection && !browserVersion.isOpera){ var selectRange = doc.selection.createRange().duplicate(); var elementRange = element.createTextRange(); selectRange.move("character",0); elementRange.move("character",0); var inRange1 = selectRange.inRange(elementRange); var inRange2 = elementRange.inRange(selectRange); try { elementRange.setEndPoint("EndToEnd", selectRange); } catch (e) { Assert.fail("There is no cursor on this page!"); } var answer = String(elementRange.text).replace(/\r/g,"").length; return answer; } else { if (typeof(element.selectionStart) != "undefined") { if (win.getSelection && typeof(win.getSelection().rangeCount) != undefined && win.getSelection().rangeCount == 0) { Assert.fail("There is no cursor on this page!"); } return element.selectionStart; } } throw new Error("Couldn't detect cursor position on this browser!"); } Selenium.prototype.doSetContext = function(context, logLevelThreshold) { /** * Writes a message to the status bar and adds a note to the browser-side * log. * *

If logLevelThreshold is specified, set the threshold for logging * to that level (debug, info, warn, error).

* *

(Note that the browser-side logs will not be sent back to the * server, and are invisible to the Client Driver.)

* * @param context * the message to be sent to the browser * @param logLevelThreshold one of "debug", "info", "warn", "error", sets the threshold for browser-side logging */ if (logLevelThreshold==null || logLevelThreshold=="") { return this.page().setContext(context); } return this.page().setContext(context, logLevelThreshold); }; Selenium.prototype.getExpression = function(expression) { /** * 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 string the value passed in */ return expression; } Selenium.prototype.doWaitForCondition = function(script, timeout) { /** * 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 */ if (isNaN(timeout)) { throw new SeleniumError("Timeout is not a number: " + timeout); } return decorateFunctionWithTimeout(function () { return eval(script); }, timeout); }; Selenium.prototype.doWaitForCondition.dontCheckAlertsAndConfirms = true; Selenium.prototype.doSetTimeout = function(timeout) { /** * 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 */ this.defaultTimeout = parseInt(timeout); } Selenium.prototype.doWaitForPageToLoad = function(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 */ if (isNaN(timeout)) { throw new SeleniumError("Timeout is not a number: " + timeout); } // in pi-mode, the test and the harness share the window; thus if we are executing this code, then we have loaded if (window["proxyInjectionMode"] == null || !window["proxyInjectionMode"]) { return this.makePageLoadCondition(timeout); } }; Selenium.prototype._isNewPageLoaded = function() { return this.browserbot.isNewPageLoaded(); }; Selenium.prototype.doWaitForPageToLoad.dontCheckAlertsAndConfirms = true; /** * Evaluate a parameter, performing JavaScript evaluation and variable substitution. * If the string matches the pattern "javascript{ ... }", evaluate the string between the braces. */ Selenium.prototype.preprocessParameter = function(value) { var match = value.match(/^javascript\{((.|\r?\n)+)\}$/); if (match && match[1]) { return eval(match[1]).toString(); } return this.replaceVariables(value); }; /* * Search through str and replace all variable references ${varName} with their * value in storedVars. */ Selenium.prototype.replaceVariables = function(str) { var stringResult = str; // Find all of the matching variable references var match = stringResult.match(/\$\{\w+\}/g); if (!match) { return stringResult; } // For each match, lookup the variable value, and replace if found for (var i = 0; match && i < match.length; i++) { var variable = match[i]; // The replacement variable, with ${} var name = variable.substring(2, variable.length - 1); // The replacement variable without ${} var replacement = storedVars[name]; if (replacement != undefined) { stringResult = stringResult.replace(variable, replacement); } } return stringResult; }; Selenium.prototype.getCookie = function() { /** * Return all cookies of the current page under test. * * @return string all cookies of the current page under test */ var doc = this.page().document(); return doc.cookie; }; Selenium.prototype.doCreateCookie = function(nameValuePair, optionsString) { /** * 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' and 'max_age'. * the optionsString's format is "path=/path/, max_age=60". The order of options are irrelevant, the unit * of the value of 'max_age' is second. */ var results = /[^\s=\[\]\(\),"\/\?@:;]+=[^\s=\[\]\(\),"\/\?@:;]*/.test(nameValuePair); if (!results) { throw new SeleniumError("Invalid parameter."); } var cookie = nameValuePair.trim(); results = /max_age=(\d+)/.exec(optionsString); if (results) { var expireDateInMilliseconds = (new Date()).getTime() + results[1] * 1000; cookie += "; expires=" + new Date(expireDateInMilliseconds).toGMTString(); } results = /path=([^\s,]+)[,]?/.exec(optionsString); if (results) { cookie += "; path=" + results[1]; } this.page().document().cookie = cookie; } Selenium.prototype.doDeleteCookie = function(name,path) { /** * Delete a named cookie with specified path. * * @param name the name of the cookie to be deleted * @param path the path property of the cookie to be deleted */ // set the expire time of the cookie to be deleted to one minute before now. var expireDateInMilliseconds = (new Date()).getTime() + (-1 * 1000); this.page().document().cookie = name.trim() + "=deleted; path=" + path.trim() + "; expires=" + new Date(expireDateInMilliseconds).toGMTString(); } /** * Factory for creating "Option Locators". * An OptionLocator is an object for dealing with Select options (e.g. for * finding a specified option, or asserting that the selected option of * Select element matches some condition. * The type of locator returned by the factory depends on the locator string: * label= (OptionLocatorByLabel) * value= (OptionLocatorByValue) * index= (OptionLocatorByIndex) * id= (OptionLocatorById) * (default is OptionLocatorByLabel). */ function OptionLocatorFactory() { } OptionLocatorFactory.prototype.fromLocatorString = function(locatorString) { var locatorType = 'label'; var locatorValue = locatorString; // If there is a locator prefix, use the specified strategy var result = locatorString.match(/^([a-zA-Z]+)=(.*)/); if (result) { locatorType = result[1]; locatorValue = result[2]; } if (this.optionLocators == undefined) { this.registerOptionLocators(); } if (this.optionLocators[locatorType]) { return new this.optionLocators[locatorType](locatorValue); } throw new SeleniumError("Unkown option locator type: " + locatorType); }; /** * To allow for easy extension, all of the option locators are found by * searching for all methods of OptionLocatorFactory.prototype that start * with "OptionLocatorBy". * TODO: Consider using the term "Option Specifier" instead of "Option Locator". */ OptionLocatorFactory.prototype.registerOptionLocators = function() { this.optionLocators={}; for (var functionName in this) { var result = /OptionLocatorBy([A-Z].+)$/.exec(functionName); if (result != null) { var locatorName = result[1].lcfirst(); this.optionLocators[locatorName] = this[functionName]; } } }; /** * OptionLocator for options identified by their labels. */ OptionLocatorFactory.prototype.OptionLocatorByLabel = function(label) { this.label = label; this.labelMatcher = new PatternMatcher(this.label); this.findOption = function(element) { for (var i = 0; i < element.options.length; i++) { if (this.labelMatcher.matches(element.options[i].text)) { return element.options[i]; } } throw new SeleniumError("Option with label '" + this.label + "' not found"); }; this.assertSelected = function(element) { var selectedLabel = element.options[element.selectedIndex].text; Assert.matches(this.label, selectedLabel) }; }; /** * OptionLocator for options identified by their values. */ OptionLocatorFactory.prototype.OptionLocatorByValue = function(value) { this.value = value; this.valueMatcher = new PatternMatcher(this.value); this.findOption = function(element) { for (var i = 0; i < element.options.length; i++) { if (this.valueMatcher.matches(element.options[i].value)) { return element.options[i]; } } throw new SeleniumError("Option with value '" + this.value + "' not found"); }; this.assertSelected = function(element) { var selectedValue = element.options[element.selectedIndex].value; Assert.matches(this.value, selectedValue) }; }; /** * OptionLocator for options identified by their index. */ OptionLocatorFactory.prototype.OptionLocatorByIndex = function(index) { this.index = Number(index); if (isNaN(this.index) || this.index < 0) { throw new SeleniumError("Illegal Index: " + index); } this.findOption = function(element) { if (element.options.length <= this.index) { throw new SeleniumError("Index out of range. Only " + element.options.length + " options available"); } return element.options[this.index]; }; this.assertSelected = function(element) { Assert.equals(this.index, element.selectedIndex); }; }; /** * OptionLocator for options identified by their id. */ OptionLocatorFactory.prototype.OptionLocatorById = function(id) { this.id = id; this.idMatcher = new PatternMatcher(this.id); this.findOption = function(element) { for (var i = 0; i < element.options.length; i++) { if (this.idMatcher.matches(element.options[i].id)) { return element.options[i]; } } throw new SeleniumError("Option with id '" + this.id + "' not found"); }; this.assertSelected = function(element) { var selectedId = element.options[element.selectedIndex].id; Assert.matches(this.id, selectedId) }; };