Selenium Reference

Concepts
A command is what tells Selenium what to do. Selenium commands come in three 'flavors': Actions, Accessors and Assertions. Each command call is one line in the test table of the form: command target value Actions are commands that generally manipulate the state of the application. They do things like "click this link" and "select that option". If an Action fails, or has an error, the execution of the current test is stopped. Many Actions can be called with the "AndWait" suffix, e.g. "clickAndWait". This suffix tells Selenium that the action will cause the browser to make a call to the server, and that Selenium should wait for a new page to load. Accessors examine the state of the application and store the results in variables, e.g. "storeTitle". They are also used to automatically generate Assertions. Assertions are like Accessors, but they verify that the state of the application conforms to what is expected. Examples include "make sure the page title is X" and "verify that this checkbox is checked". All Selenium Assertions can be used in 3 modes: "assert", "verify", and "waitFor". For example, you can "assertText", "verifyText" and "waitForText". When an "assert" fails, the test is aborted. When a "verify" fails, the test will continue execution, logging the failure. This allows a single "assert" to ensure that the application is on the correct page, followed by a bunch of "verify" assertions to test form field values, labels, etc. "waitFor" commands wait for some condition to become true (which can be useful for testing Ajax applications). They will succeed immediately if the condition is already true. However, they will fail and halt the test if the condition does not become true within the current timeout setting (see the setTimeout action below). Element Locators tell Selenium which HTML element a command refers to. Many commands require an Element Locator as the "target" attribute. Examples of Element Locators include "elementId" and "document.forms[0].element". These are described more clearly in the next section. Patterns are used for various reasons, e.g. to specify the expected value of an input field, or identify a select option. Selenium supports various types of pattern, including regularexpressions, all of which are described in more detail below.

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-oftype, :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:

dom, for locators starting with "document." xpath, for locators starting with "//" identifier, otherwise

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 similarlynamed 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 regularexpressions 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.

Selenium Actions
addSelection ( 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 Arguments:

locator - an element locator identifying a multi-select box optionLocator - an option locator (a label by default)

answerOnNextPrompt ( answer ) Instructs Selenium to return the specified answer string in response to the next JavaScript prompt [window.prompt()]. Arguments:

answer - the answer to give in response to the prompt pop-up

check ( locator ) Check a toggle-button (checkbox/radio) Arguments:

locator - an element locator

chooseCancelOnNextConfirmation ( ) 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.

click ( 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. Arguments:

locator - an element locator

clickAt ( 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. Arguments:

locator - an element locator coordString - specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.

close ( ) Simulates the user clicking the "close" button in the titlebar of a popup window or tab. createCookie ( 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. Arguments:

nameValuePair - name and value of the cookie in a format "name=value" 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.

deleteCookie ( name,path ) Delete a named cookie with specified path. Arguments:

name - the name of the cookie to be deleted path - the path property of the cookie to be deleted

dragdrop ( 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. Arguments:

locator - an element locator movementsString - offset in pixels from the current location to which the element should be moved, e.g., "+70,-300"

fireEvent ( locator,eventName ) Explicitly simulate an event, to trigger the corresponding "onevent" handler. Arguments:

locator - an element locator eventName - the event name, e.g. "focus" or "blur"

goBack ( ) Simulates the user clicking the "back" button on their browser. keyDown ( locator,keySequence ) Simulates a user pressing a key (without releasing it yet). Arguments:

locator - an element locator 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".

keyPress ( locator,keySequence ) Simulates a user pressing and releasing a key. Arguments:

locator - an element locator 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".

keyUp ( locator,keySequence ) Simulates a user releasing a key. Arguments:

locator - an element locator 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".

mouseDown ( locator ) Simulates a user pressing the mouse button (without releasing it yet) on the specified element. Arguments:

locator - an element locator

mouseDownAt ( 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. Arguments:

locator - an element locator coordString - specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.

mouseMove ( locator ) Simulates a user pressing the mouse button (without releasing it yet) on the specified element. Arguments:

locator - an element locator

mouseMoveAt ( 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. Arguments:

locator - an element locator coordString - specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.

mouseOut ( locator ) Simulates a user moving the mouse pointer away from the specified element. Arguments:

locator - an element locator

mouseOver ( locator ) Simulates a user hovering a mouse over the specified element. Arguments:

locator - an element locator

mouseUp ( locator ) Simulates a user pressing the mouse button (without releasing it yet) on the specified element. Arguments:

locator - an element locator

mouseUpAt ( 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. Arguments:

locator - an element locator coordString - specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.

open ( 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. Arguments:

url - the URL to open; may be relative or absolute

refresh ( ) Simulates the user clicking the "Refresh" button on their browser. removeSelection ( 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 Arguments:

locator - an element locator identifying a multi-select box optionLocator - an option locator (a label by default)

select ( 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.)

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. Arguments:

selectLocator - an element locator identifying a drop-down menu optionLocator - an option locator (a label by default)

selectFrame ( 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"]

Arguments:

locator - an element locator identifying a frame or iframe

selectWindow ( 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. Arguments:

windowID - the JavaScript window ID of the window to select

setContext ( 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.)

Arguments:

context - the message to be sent to the browser logLevelThreshold - one of "debug", "info", "warn", "error", sets the threshold for browser-side logging

setCursorPosition ( 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. Arguments:

locator - an element locator pointing to an input element or textarea 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.

setTimeout ( 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. Arguments:

timeout - a timeout in milliseconds, after which the action will return with an error

submit ( formLocator ) Submit the specified form. This is particularly useful for forms without submit buttons, e.g. single-input "Search" forms. Arguments:

formLocator - an element locator for the form you want to submit

type ( 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.

Arguments:

locator - an element locator value - the value to type

uncheck ( locator ) Uncheck a toggle-button (checkbox/radio) Arguments:

locator - an element locator

waitForCondition ( 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 Arguments:

script - the JavaScript snippet to run timeout - a timeout in milliseconds, after which this command will return with an error

waitForPageToLoad ( 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. Arguments:

timeout - a timeout in milliseconds, after which this command will return with an error

waitForPopUp ( windowID,timeout ) Waits for a popup window to appear and load up. Arguments:

windowID - the JavaScript window ID of the window that will appear timeout - a timeout in milliseconds, after which the action will return with an error

windowFocus ( windowName ) Gives focus to a window Arguments:

windowName - name of the window to be given focus

windowMaximize ( windowName ) Resize window to take up the entire screen Arguments:

windowName - name of the window to be enlarged

Selenium Accessors
storeAlert ( variableName ) 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. Returns: The message of the most recent JavaScript alert

Related Assertions, automatically generated:

assertAlert ( pattern ) assertNotAlert ( pattern ) verifyAlert ( pattern ) verifyNotAlert ( pattern ) waitForAlert ( pattern ) waitForNotAlert ( pattern )

storeAllButtons ( variableName ) Returns the IDs of all buttons on the page. If a given button has no ID, it will appear as "" in this array. Returns: the IDs of all buttons on the page Related Assertions, automatically generated:

assertAllButtons ( pattern ) assertNotAllButtons ( pattern ) verifyAllButtons ( pattern ) verifyNotAllButtons ( pattern ) waitForAllButtons ( pattern ) waitForNotAllButtons ( pattern )

storeAllFields ( variableName ) Returns the IDs of all input fields on the page. If a given field has no ID, it will appear as "" in this array. Returns: the IDs of all field on the page Related Assertions, automatically generated:

assertAllFields ( pattern ) assertNotAllFields ( pattern ) verifyAllFields ( pattern ) verifyNotAllFields ( pattern ) waitForAllFields ( pattern ) waitForNotAllFields ( pattern )

storeAllLinks ( variableName ) Returns the IDs of all links on the page. If a given link has no ID, it will appear as "" in this array. Returns: the IDs of all links on the page Related Assertions, automatically generated:

assertAllLinks ( pattern ) assertNotAllLinks ( pattern ) verifyAllLinks ( pattern ) verifyNotAllLinks ( pattern ) waitForAllLinks ( pattern ) waitForNotAllLinks ( pattern )

storeAllWindowIds ( variableName ) Returns the IDs of all windows that the browser knows about. Returns: the IDs of all windows that the browser knows about. Related Assertions, automatically generated:

assertAllWindowIds ( pattern ) assertNotAllWindowIds ( pattern ) verifyAllWindowIds ( pattern ) verifyNotAllWindowIds ( pattern ) waitForAllWindowIds ( pattern ) waitForNotAllWindowIds ( pattern )

storeAllWindowNames ( variableName ) Returns the names of all windows that the browser knows about. Returns: the names of all windows that the browser knows about. Related Assertions, automatically generated:

assertAllWindowNames ( pattern ) assertNotAllWindowNames ( pattern ) verifyAllWindowNames ( pattern ) verifyNotAllWindowNames ( pattern ) waitForAllWindowNames ( pattern ) waitForNotAllWindowNames ( pattern )

storeAllWindowTitles ( variableName ) Returns the titles of all windows that the browser knows about. Returns: the titles of all windows that the browser knows about. Related Assertions, automatically generated:

assertAllWindowTitles ( pattern ) assertNotAllWindowTitles ( pattern ) verifyAllWindowTitles ( pattern ) verifyNotAllWindowTitles ( pattern ) waitForAllWindowTitles ( pattern ) waitForNotAllWindowTitles ( pattern )

storeAttribute ( attributeLocator, variableName ) 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. Arguments:

attributeLocator - an element locator followed by an variableName - the name of a variable in which the result is to be stored.

Returns: the value of the specified attribute Related Assertions, automatically generated:

assertAttribute ( attributeLocator, pattern ) assertNotAttribute ( attributeLocator, pattern ) verifyAttribute ( attributeLocator, pattern ) verifyNotAttribute ( attributeLocator, pattern ) waitForAttribute ( attributeLocator, pattern ) waitForNotAttribute ( attributeLocator, pattern )

storeAttributeFromAllWindows ( attributeName, variableName ) Returns every instance of some attribute from all known windows. Arguments:

attributeName - name of an attribute on the windows variableName - the name of a variable in which the result is to be stored.

Returns: the set of values of this attribute from all known windows. Related Assertions, automatically generated:

assertAttributeFromAllWindows ( attributeName, pattern ) assertNotAttributeFromAllWindows ( attributeName, pattern ) verifyAttributeFromAllWindows ( attributeName, pattern ) verifyNotAttributeFromAllWindows ( attributeName, pattern ) waitForAttributeFromAllWindows ( attributeName, pattern ) waitForNotAttributeFromAllWindows ( attributeName, pattern )

storeBodyText ( variableName ) Gets the entire text of the page. Returns: the entire text of the page Related Assertions, automatically generated:

assertBodyText ( pattern ) assertNotBodyText ( pattern ) verifyBodyText ( pattern ) verifyNotBodyText ( pattern ) waitForBodyText ( pattern ) waitForNotBodyText ( pattern )

storeConfirmation ( variableName ) 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. Returns: the message of the most recent JavaScript confirmation dialog

Related Assertions, automatically generated:

assertConfirmation ( pattern ) assertNotConfirmation ( pattern ) verifyConfirmation ( pattern ) verifyNotConfirmation ( pattern ) waitForConfirmation ( pattern ) waitForNotConfirmation ( pattern )

storeCookie ( variableName ) Return all cookies of the current page under test. Returns: all cookies of the current page under test Related Assertions, automatically generated:

assertCookie ( pattern ) assertNotCookie ( pattern ) verifyCookie ( pattern ) verifyNotCookie ( pattern ) waitForCookie ( pattern ) waitForNotCookie ( pattern )

storeCursorPosition ( locator, variableName ) 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. Arguments:

locator - an element locator pointing to an input element or textarea variableName - the name of a variable in which the result is to be stored.

Returns: the numerical position of the cursor in the field Related Assertions, automatically generated:

assertCursorPosition ( locator, pattern ) assertNotCursorPosition ( locator, pattern ) verifyCursorPosition ( locator, pattern ) verifyNotCursorPosition ( locator, pattern ) waitForCursorPosition ( locator, pattern ) waitForNotCursorPosition ( locator, pattern )

storeElementHeight ( locator, variableName ) Retrieves the height of an element Arguments:

locator - an element locator pointing to an element variableName - the name of a variable in which the result is to be stored.

Returns: height of an element in pixels Related Assertions, automatically generated:

assertElementHeight ( locator, pattern ) assertNotElementHeight ( locator, pattern ) verifyElementHeight ( locator, pattern ) verifyNotElementHeight ( locator, pattern ) waitForElementHeight ( locator, pattern ) waitForNotElementHeight ( locator, pattern )

storeElementIndex ( locator, variableName ) Get the relative index of an element to its parent (starting from 0). The comment node and empty text node will be ignored. Arguments:

locator - an element locator pointing to an element variableName - the name of a variable in which the result is to be stored.

Returns: of relative index of the element to its parent (starting from 0) Related Assertions, automatically generated:

assertElementIndex ( locator, pattern ) assertNotElementIndex ( locator, pattern ) verifyElementIndex ( locator, pattern )

verifyNotElementIndex ( locator, pattern ) waitForElementIndex ( locator, pattern ) waitForNotElementIndex ( locator, pattern )

storeElementPositionLeft ( locator, variableName ) Retrieves the horizontal position of an element Arguments:

locator - an element locator pointing to an element OR an element itself variableName - the name of a variable in which the result is to be stored.

Returns: of pixels from the edge of the frame. Related Assertions, automatically generated:

assertElementPositionLeft ( locator, pattern ) assertNotElementPositionLeft ( locator, pattern ) verifyElementPositionLeft ( locator, pattern ) verifyNotElementPositionLeft ( locator, pattern ) waitForElementPositionLeft ( locator, pattern ) waitForNotElementPositionLeft ( locator, pattern )

storeElementPositionTop ( locator, variableName ) Retrieves the vertical position of an element Arguments:

locator - an element locator pointing to an element OR an element itself variableName - the name of a variable in which the result is to be stored.

Returns: of pixels from the edge of the frame. Related Assertions, automatically generated:

assertElementPositionTop ( locator, pattern ) assertNotElementPositionTop ( locator, pattern ) verifyElementPositionTop ( locator, pattern ) verifyNotElementPositionTop ( locator, pattern ) waitForElementPositionTop ( locator, pattern ) waitForNotElementPositionTop ( locator, pattern )

storeElementWidth ( locator, variableName ) Retrieves the width of an element Arguments:

locator - an element locator pointing to an element variableName - the name of a variable in which the result is to be stored.

Returns: width of an element in pixels Related Assertions, automatically generated:

assertElementWidth ( locator, pattern ) assertNotElementWidth ( locator, pattern ) verifyElementWidth ( locator, pattern ) verifyNotElementWidth ( locator, pattern ) waitForElementWidth ( locator, pattern ) waitForNotElementWidth ( locator, pattern )

storeEval ( script, variableName ) 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. Arguments:

script - the JavaScript snippet to run variableName - the name of a variable in which the result is to be stored.

Returns: the results of evaluating the snippet Related Assertions, automatically generated:

assertEval ( script, pattern )

assertNotEval ( script, pattern ) verifyEval ( script, pattern ) verifyNotEval ( script, pattern ) waitForEval ( script, pattern ) waitForNotEval ( script, pattern )

storeExpression ( expression, variableName ) Returns the specified expression. This is useful because of JavaScript preprocessing. It is used to generate commands like assertExpression and waitForExpression. Arguments:

expression - the value to return variableName - the name of a variable in which the result is to be stored.

Returns: the value passed in Related Assertions, automatically generated:

assertExpression ( expression, pattern ) assertNotExpression ( expression, pattern ) verifyExpression ( expression, pattern ) verifyNotExpression ( expression, pattern ) waitForExpression ( expression, pattern ) waitForNotExpression ( expression, pattern )

storeHtmlSource ( variableName ) Returns the entire HTML source between the opening and closing "html" tags. Returns: the entire HTML source Related Assertions, automatically generated:

assertHtmlSource ( pattern ) assertNotHtmlSource ( pattern ) verifyHtmlSource ( pattern ) verifyNotHtmlSource ( pattern ) waitForHtmlSource ( pattern ) waitForNotHtmlSource ( pattern )

storeLocation ( variableName ) Gets the absolute URL of the current page. Returns: the absolute URL of the current page Related Assertions, automatically generated:

assertLocation ( pattern ) assertNotLocation ( pattern ) verifyLocation ( pattern ) verifyNotLocation ( pattern ) waitForLocation ( pattern ) waitForNotLocation ( pattern )

storeLogMessages ( variableName ) 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. Returns: all log messages seen since the last call to this API Related Assertions, automatically generated:

assertLogMessages ( pattern ) assertNotLogMessages ( pattern ) verifyLogMessages ( pattern ) verifyNotLogMessages ( pattern ) waitForLogMessages ( pattern ) waitForNotLogMessages ( pattern )

storePrompt ( variableName ) 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. Returns: the message of the most recent JavaScript question prompt Related Assertions, automatically generated:

assertPrompt ( pattern ) assertNotPrompt ( pattern ) verifyPrompt ( pattern ) verifyNotPrompt ( pattern ) waitForPrompt ( pattern ) waitForNotPrompt ( pattern )

storeSelectedId ( selectLocator, variableName ) Gets option element ID for selected option in the specified select element. Arguments:

selectLocator - an element locator identifying a drop-down menu variableName - the name of a variable in which the result is to be stored.

Returns: the selected option ID in the specified select drop-down Related Assertions, automatically generated:

assertSelectedId ( selectLocator, pattern ) assertNotSelectedId ( selectLocator, pattern ) verifySelectedId ( selectLocator, pattern ) verifyNotSelectedId ( selectLocator, pattern ) waitForSelectedId ( selectLocator, pattern ) waitForNotSelectedId ( selectLocator, pattern )

storeSelectedIds ( selectLocator, variableName )

Gets all option element IDs for selected options in the specified select or multi-select element. Arguments:

selectLocator - an element locator identifying a drop-down menu variableName - the name of a variable in which the result is to be stored.

Returns: an array of all selected option IDs in the specified select drop-down Related Assertions, automatically generated:

assertSelectedIds ( selectLocator, pattern ) assertNotSelectedIds ( selectLocator, pattern ) verifySelectedIds ( selectLocator, pattern ) verifyNotSelectedIds ( selectLocator, pattern ) waitForSelectedIds ( selectLocator, pattern ) waitForNotSelectedIds ( selectLocator, pattern )

storeSelectedIndex ( selectLocator, variableName ) Gets option index (option number, starting at 0) for selected option in the specified select element. Arguments:

selectLocator - an element locator identifying a drop-down menu variableName - the name of a variable in which the result is to be stored.

Returns: the selected option index in the specified select drop-down Related Assertions, automatically generated:

assertSelectedIndex ( selectLocator, pattern ) assertNotSelectedIndex ( selectLocator, pattern ) verifySelectedIndex ( selectLocator, pattern ) verifyNotSelectedIndex ( selectLocator, pattern ) waitForSelectedIndex ( selectLocator, pattern ) waitForNotSelectedIndex ( selectLocator, pattern )

storeSelectedIndexes ( selectLocator, variableName ) Gets all option indexes (option number, starting at 0) for selected options in the specified select or multi-select element.

Arguments:

selectLocator - an element locator identifying a drop-down menu variableName - the name of a variable in which the result is to be stored.

Returns: an array of all selected option indexes in the specified select drop-down Related Assertions, automatically generated:

assertSelectedIndexes ( selectLocator, pattern ) assertNotSelectedIndexes ( selectLocator, pattern ) verifySelectedIndexes ( selectLocator, pattern ) verifyNotSelectedIndexes ( selectLocator, pattern ) waitForSelectedIndexes ( selectLocator, pattern ) waitForNotSelectedIndexes ( selectLocator, pattern )

storeSelectedLabel ( selectLocator, variableName ) Gets option label (visible text) for selected option in the specified select element. Arguments:

selectLocator - an element locator identifying a drop-down menu variableName - the name of a variable in which the result is to be stored.

Returns: the selected option label in the specified select drop-down Related Assertions, automatically generated:

assertSelectedLabel ( selectLocator, pattern ) assertNotSelectedLabel ( selectLocator, pattern ) verifySelectedLabel ( selectLocator, pattern ) verifyNotSelectedLabel ( selectLocator, pattern ) waitForSelectedLabel ( selectLocator, pattern ) waitForNotSelectedLabel ( selectLocator, pattern )

storeSelectedLabels ( selectLocator, variableName ) Gets all option labels (visible text) for selected options in the specified select or multiselect element. Arguments:

selectLocator - an element locator identifying a drop-down menu

variableName - the name of a variable in which the result is to be stored.

Returns: an array of all selected option labels in the specified select drop-down Related Assertions, automatically generated:

assertSelectedLabels ( selectLocator, pattern ) assertNotSelectedLabels ( selectLocator, pattern ) verifySelectedLabels ( selectLocator, pattern ) verifyNotSelectedLabels ( selectLocator, pattern ) waitForSelectedLabels ( selectLocator, pattern ) waitForNotSelectedLabels ( selectLocator, pattern )

storeSelectedValue ( selectLocator, variableName ) Gets option value (value attribute) for selected option in the specified select element. Arguments:

selectLocator - an element locator identifying a drop-down menu variableName - the name of a variable in which the result is to be stored.

Returns: the selected option value in the specified select drop-down Related Assertions, automatically generated:

assertSelectedValue ( selectLocator, pattern ) assertNotSelectedValue ( selectLocator, pattern ) verifySelectedValue ( selectLocator, pattern ) verifyNotSelectedValue ( selectLocator, pattern ) waitForSelectedValue ( selectLocator, pattern ) waitForNotSelectedValue ( selectLocator, pattern )

storeSelectedValues ( selectLocator, variableName ) Gets all option values (value attributes) for selected options in the specified select or multi-select element. Arguments:

selectLocator - an element locator identifying a drop-down menu variableName - the name of a variable in which the result is to be stored.

Returns:

an array of all selected option values in the specified select drop-down Related Assertions, automatically generated:

assertSelectedValues ( selectLocator, pattern ) assertNotSelectedValues ( selectLocator, pattern ) verifySelectedValues ( selectLocator, pattern ) verifyNotSelectedValues ( selectLocator, pattern ) waitForSelectedValues ( selectLocator, pattern ) waitForNotSelectedValues ( selectLocator, pattern )

storeSelectOptions ( selectLocator, variableName ) Gets all option labels in the specified select drop-down. Arguments:

selectLocator - an element locator identifying a drop-down menu variableName - the name of a variable in which the result is to be stored.

Returns: an array of all option labels in the specified select drop-down Related Assertions, automatically generated:

assertSelectOptions ( selectLocator, pattern ) assertNotSelectOptions ( selectLocator, pattern ) verifySelectOptions ( selectLocator, pattern ) verifyNotSelectOptions ( selectLocator, pattern ) waitForSelectOptions ( selectLocator, pattern ) waitForNotSelectOptions ( selectLocator, pattern )

storeTable ( tableCellAddress, variableName ) Gets the text from a cell of a table. The cellAddress syntax tableLocator.row.column, where row and column start at 0. Arguments:

tableCellAddress - a cell address, e.g. "foo.1.4" variableName - the name of a variable in which the result is to be stored.

Returns: the text from the specified cell Related Assertions, automatically generated:

assertTable ( tableCellAddress, pattern ) assertNotTable ( tableCellAddress, pattern ) verifyTable ( tableCellAddress, pattern ) verifyNotTable ( tableCellAddress, pattern ) waitForTable ( tableCellAddress, pattern ) waitForNotTable ( tableCellAddress, pattern )

storeText ( locator, variableName ) 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. Arguments:

locator - an element locator variableName - the name of a variable in which the result is to be stored.

Returns: the text of the element Related Assertions, automatically generated:

assertText ( locator, pattern ) assertNotText ( locator, pattern ) verifyText ( locator, pattern ) verifyNotText ( locator, pattern ) waitForText ( locator, pattern ) waitForNotText ( locator, pattern )

storeTitle ( variableName ) Gets the title of the current page. Returns: the title of the current page Related Assertions, automatically generated:

assertTitle ( pattern ) assertNotTitle ( pattern ) verifyTitle ( pattern ) verifyNotTitle ( pattern ) waitForTitle ( pattern ) waitForNotTitle ( pattern )

storeValue ( locator, variableName ) 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. Arguments:

locator - an element locator variableName - the name of a variable in which the result is to be stored.

Returns: the element value, or "on/off" for checkbox/radio elements Related Assertions, automatically generated:

assertValue ( locator, pattern ) assertNotValue ( locator, pattern ) verifyValue ( locator, pattern ) verifyNotValue ( locator, pattern ) waitForValue ( locator, pattern ) waitForNotValue ( locator, pattern )

storeWhetherThisFrameMatchFrameExpression ( currentFrameString, target, variableName ) 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. Arguments:

currentFrameString - starting frame target - new frame (which might be relative to the current one) variableName - the name of a variable in which the result is to be stored.

Returns: true if the new frame is this code's window Related Assertions, automatically generated:

assertWhetherThisFrameMatchFrameExpression ( currentFrameString, target )

assertNotWhetherThisFrameMatchFrameExpression ( currentFrameString, target ) verifyWhetherThisFrameMatchFrameExpression ( currentFrameString, target ) verifyNotWhetherThisFrameMatchFrameExpression ( currentFrameString, target ) waitForWhetherThisFrameMatchFrameExpression ( currentFrameString, target ) waitForNotWhetherThisFrameMatchFrameExpression ( currentFrameString, target )

storeAlertPresent ( variableName ) Has an alert occurred? This function never throws an exception Returns: true if there is an alert Related Assertions, automatically generated:

assertAlertPresent ( ) assertAlertNotPresent ( ) verifyAlertPresent ( ) verifyAlertNotPresent ( ) waitForAlertPresent ( ) waitForAlertNotPresent ( )

storeChecked ( locator, variableName ) Gets whether a toggle-button (checkbox/radio) is checked. Fails if the specified element doesn't exist or isn't a toggle-button. Arguments:

locator - an element locator pointing to a checkbox or radio button variableName - the name of a variable in which the result is to be stored.

Returns: true if the checkbox is checked, false otherwise Related Assertions, automatically generated:

assertChecked ( locator ) assertNotChecked ( locator ) verifyChecked ( locator ) verifyNotChecked ( locator )

waitForChecked ( locator ) waitForNotChecked ( locator )

storeConfirmationPresent ( variableName ) Has confirm() been called? This function never throws an exception Returns: true if there is a pending confirmation Related Assertions, automatically generated:

assertConfirmationPresent ( ) assertConfirmationNotPresent ( ) verifyConfirmationPresent ( ) verifyConfirmationNotPresent ( ) waitForConfirmationPresent ( ) waitForConfirmationNotPresent ( )

storeEditable ( locator, variableName ) 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. Arguments:

locator - an element locator variableName - the name of a variable in which the result is to be stored.

Returns: true if the input element is editable, false otherwise Related Assertions, automatically generated:

assertEditable ( locator ) assertNotEditable ( locator ) verifyEditable ( locator ) verifyNotEditable ( locator ) waitForEditable ( locator ) waitForNotEditable ( locator )

storeElementPresent ( locator, variableName ) Verifies that the specified element is somewhere on the page.

Arguments:

locator - an element locator variableName - the name of a variable in which the result is to be stored.

Returns: true if the element is present, false otherwise Related Assertions, automatically generated:

assertElementPresent ( locator ) assertElementNotPresent ( locator ) verifyElementPresent ( locator ) verifyElementNotPresent ( locator ) waitForElementPresent ( locator ) waitForElementNotPresent ( locator )

storeOrdered ( locator1, locator2, variableName ) Check if these two elements have same parent and are ordered. Two same elements will not be considered ordered. Arguments:

locator1 - an element locator pointing to the first element locator2 - an element locator pointing to the second element variableName - the name of a variable in which the result is to be stored.

Returns: true if two elements are ordered and have same parent, false otherwise Related Assertions, automatically generated:

assertOrdered ( locator1, locator2 ) assertNotOrdered ( locator1, locator2 ) verifyOrdered ( locator1, locator2 ) verifyNotOrdered ( locator1, locator2 ) waitForOrdered ( locator1, locator2 ) waitForNotOrdered ( locator1, locator2 )

storePromptPresent ( variableName ) Has a prompt occurred? This function never throws an exception

Returns: true if there is a pending prompt Related Assertions, automatically generated:

assertPromptPresent ( ) assertPromptNotPresent ( ) verifyPromptPresent ( ) verifyPromptNotPresent ( ) waitForPromptPresent ( ) waitForPromptNotPresent ( )

storeSomethingSelected ( selectLocator, variableName ) Determines whether some option in a drop-down menu is selected. Arguments:

selectLocator - an element locator identifying a drop-down menu variableName - the name of a variable in which the result is to be stored.

Returns: true if some option has been selected, false otherwise Related Assertions, automatically generated:

assertSomethingSelected ( selectLocator ) assertNotSomethingSelected ( selectLocator ) verifySomethingSelected ( selectLocator ) verifyNotSomethingSelected ( selectLocator ) waitForSomethingSelected ( selectLocator ) waitForNotSomethingSelected ( selectLocator )

storeTextPresent ( pattern, variableName ) Verifies that the specified text pattern appears somewhere on the rendered page shown to the user. Arguments:

pattern - a pattern to match with the text of the page variableName - the name of a variable in which the result is to be stored.

Returns: true if the pattern matches the text, false otherwise

Related Assertions, automatically generated:

assertTextPresent ( pattern ) assertTextNotPresent ( pattern ) verifyTextPresent ( pattern ) verifyTextNotPresent ( pattern ) waitForTextPresent ( pattern ) waitForTextNotPresent ( pattern )

storeVisible ( locator, variableName ) 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. Arguments:

locator - an element locator variableName - the name of a variable in which the result is to be stored.

Returns: true if the specified element is visible, false otherwise Related Assertions, automatically generated:

assertVisible ( locator ) assertNotVisible ( locator ) verifyVisible ( locator ) verifyNotVisible ( locator ) waitForVisible ( locator ) waitForNotVisible ( locator )

Parameter construction and Variables

All Selenium command parameters can be constructed using both simple variable substitution as well as full javascript. Both of these mechanisms can access previously stored variables, but do so using different syntax. Stored Variables The commands store, storeValue and storeText can be used to store a variable value for later access. Internally, these variables are stored in a map called "storedVars", with values keyed by the variable name. These commands are documented in the command reference.

Variable substitution Variable substitution provides a simple way to include a previously stored variable in a command parameter. This is a simple mechanism, by which the variable to substitute is indicated by ${variableName}. Multiple variables can be substituted, and intermixed with static text. Example: store store type Mr title surname Full name is: ${fullname}

storeValue nameField textElement

${title} ${surname} fullname

Javascript evaluation Javascript evaluation provides the full power of javascript in constructing a command parameter. To use this mechanism, the entire parameter value must be prefixed by 'javascript{' with a trailing '}'. The text inside the braces is evaluated as a javascript expression, and can access previously stored variables using the storedVars map detailed above. Note that variable substitution cannot be combined with javascript evaluation. Example: store javascript{'merchant' + (new Date()).getTime()} merchantId javascript{storedVars['merchantId'].toUpperCase()}

type textElement

Extending Selenium
It can be quite simple to extend Selenium, adding your own actions, assertions and locatorstrategies. This is done with javascript by adding methods to the Selenium object prototype, and the PageBot object prototype. On startup, Selenium will automatically look through methods on these prototypes, using name patterns to recognise which ones are actions, assertions and locators. The following examples try to give an indication of how Selenium can be extended with javascript. Actions All doFoo methods on the Selenium prototype are added as actions. For each action foo there is also an action fooAndWait registered. An action method can take up to 2 parameters, which will be passed the second and third column values in the test.

Example: Add a "typeRepeated" action to Selenium, which types the text twice into a text box.
Selenium.prototype.doTypeRepeated = function(locator, text) { // All locator-strategies are automatically handled by "findElement" var element = this.page().findElement(locator); // Create the text to type var valueToType = text + text; // Replace the element text with the new text this.page().replaceText(element, valueToType); };

Accessors/Assertions All getFoo and isFoo methods on the Selenium prototype are added as accessors (storeFoo). For each accessor there is an assertFoo, verifyFoo and waitForFoo registered. An assert method can take up to 2 parameters, which will be passed the second and third column values in the test. You can also define your own assertions literally as simple "assert" methods, which will also autogenerate "verify" and "waitFor" commands. Example: Add a valueRepeated assertion, that makes sure that the element value consists of the supplied text repeated. The 2 commands that would be available in tests would be assertValueRepeated and verifyValueRepeated.
Selenium.prototype.assertValueRepeated = function(locator, text) { // All locator-strategies are automatically handled by "findElement" var element = this.page().findElement(locator); // Create the text to verify var expectedValue = text + text; // Get the actual element value var actualValue = element.value; // Make sure the actual value matches the expected Assert.matches(expectedValue, actualValue); };

Automatic availability of storeFoo, assertFoo, assertNotFoo, waitForFoo and waitForNotFoo for every getFoo All getFoo and isFoo methods on the Selenium prototype automatically result in the availability of storeFoo, assertFoo, assertNotFoo, verifyFoo, verifyNotFoo, waitForFoo, and waitForNotFoo commands.

Example, if you add a getTextLength() method, the following commands will automatically be available: storeTextLength, assertTextLength, assertNotTextLength, verifyTextLength, verifyNotTextLength, waitForTextLength, and waitForNotTextLength commands.
Selenium.prototype.getTextLength = function(locator, text) { return this.getText(locator).length; };

Also note that the assertValueRepeated method described above could have been implemented using isValueRepeated, with the added benefit of also automatically getting assertNotValueRepeated, storeValueRepeated, waitForValueRepeated and waitForNotValueRepeated. Locator Strategies All locateElementByFoo methods on the PageBot prototype are added as locator-strategies. A locator strategy takes 2 parameters, the first being the locator string (minus the prefix), and the second being the document in which to search. Example: Add a "valuerepeated=" locator, that finds the first element a value attribute equal to the the supplied value repeated.
// The "inDocument" is a the document you are searching. PageBot.prototype.locateElementByValueRepeated = function(text, inDocument) { // Create the text to search for var expectedValue = text + text; // Loop through all elements, looking for ones that have // a value === our expected value var allElements = inDocument.getElementsByTagName("*"); for (var i = 0; i < allElements.length; i++) { var testElement = allElements[i]; if (testElement.value && testElement.value === expectedValue) { return testElement; } } return null; };

user-extensions.js By default, Selenium looks for a file called "user-extensions.js", and loads the javascript code found in that file. This file provides a convenient location for adding features to Selenium, without needing to modify the core Selenium sources.

In the standard distibution, this file does not exist. Users can create this file and place their extension code in this common location, removing the need to modify the Selenium sources, and hopefully assisting with the upgrade process. Selenium HQ Reference:

Selenium Reference
Concepts
A command is what tells Selenium what to do. Selenium commands come in three 'flavors': Actions, Accessors and Assertions. Each command call is one line in the test table of the form: command target value Actions are commands that generally manipulate the state of the application. They do things like "click this link" and "select that option". If an Action fails, or has an error, the execution of the current test is stopped. Many Actions can be called with the "AndWait" suffix, e.g. "clickAndWait". This suffix tells Selenium that the action will cause the browser to make a call to the server, and that Selenium should wait for a new page to load. Accessors examine the state of the application and store the results in variables, e.g. "storeTitle". They are also used to automatically generate Assertions. Assertions are like Accessors, but they verify that the state of the application conforms to what is expected. Examples include "make sure the page title is X" and "verify that this checkbox is checked". All Selenium Assertions can be used in 3 modes: "assert", "verify", and "waitFor". For example, you can "assertText", "verifyText" and "waitForText". When an "assert" fails, the test is aborted. When a "verify" fails, the test will continue execution, logging the failure. This allows a single "assert" to ensure that the application is on the correct page, followed by a bunch of "verify" assertions to test form field values, labels, etc. "waitFor" commands wait for some condition to become true (which can be useful for testing Ajax applications). They will succeed immediately if the condition is already true. However, they will fail and halt the test if the condition does not become true within the current timeout setting (see the setTimeout action below). Element Locators tell Selenium which HTML element a command refers to. Many commands require an Element Locator as the "target" attribute. Examples of Element Locators include

"elementId" and "document.forms[0].element". These are described more clearly in the next section. Patterns are used for various reasons, e.g. to specify the expected value of an input field, or identify a select option. Selenium supports various types of pattern, including regularexpressions, all of which are described in more detail below. 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-oftype, :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:

dom, for locators starting with "document." xpath, for locators starting with "//" identifier, otherwise

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 similarlynamed 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 regularexpressions 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.

Selenium Actions
addSelection ( 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 Arguments:

locator - an element locator identifying a multi-select box optionLocator - an option locator (a label by default)

answerOnNextPrompt ( answer ) Instructs Selenium to return the specified answer string in response to the next JavaScript prompt [window.prompt()]. Arguments:

answer - the answer to give in response to the prompt pop-up

check ( locator ) Check a toggle-button (checkbox/radio) Arguments:

locator - an element locator

chooseCancelOnNextConfirmation ( ) 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. click ( 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. Arguments:

locator - an element locator

clickAt ( 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. Arguments:

locator - an element locator coordString - specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.

close ( ) Simulates the user clicking the "close" button in the titlebar of a popup window or tab. createCookie ( 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. Arguments:

nameValuePair - name and value of the cookie in a format "name=value" 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.

deleteCookie ( name,path ) Delete a named cookie with specified path.

Arguments:

name - the name of the cookie to be deleted path - the path property of the cookie to be deleted

dragdrop ( 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. Arguments:

locator - an element locator movementsString - offset in pixels from the current location to which the element should be moved, e.g., "+70,-300"

fireEvent ( locator,eventName ) Explicitly simulate an event, to trigger the corresponding "onevent" handler. Arguments:

locator - an element locator eventName - the event name, e.g. "focus" or "blur"

goBack ( ) Simulates the user clicking the "back" button on their browser. keyDown ( locator,keySequence ) Simulates a user pressing a key (without releasing it yet). Arguments:

locator - an element locator 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".

keyPress ( locator,keySequence ) Simulates a user pressing and releasing a key. Arguments:

locator - an element locator 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".

keyUp ( locator,keySequence ) Simulates a user releasing a key. Arguments:

locator - an element locator 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".

mouseDown ( locator ) Simulates a user pressing the mouse button (without releasing it yet) on the specified element. Arguments:

locator - an element locator

mouseDownAt ( 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. Arguments:

locator - an element locator coordString - specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.

mouseMove ( locator ) Simulates a user pressing the mouse button (without releasing it yet) on the specified element. Arguments:

locator - an element locator

mouseMoveAt ( 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. Arguments:

locator - an element locator coordString - specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.

mouseOut ( locator ) Simulates a user moving the mouse pointer away from the specified element. Arguments:

locator - an element locator

mouseOver ( locator ) Simulates a user hovering a mouse over the specified element. Arguments:

locator - an element locator

mouseUp ( locator ) Simulates a user pressing the mouse button (without releasing it yet) on the specified element. Arguments:

locator - an element locator

mouseUpAt ( 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. Arguments:

locator - an element locator coordString - specifies the x,y position (i.e. - 10,20) of the mouse event relative to the element returned by the locator.

open ( 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. Arguments:

url - the URL to open; may be relative or absolute

refresh ( ) Simulates the user clicking the "Refresh" button on their browser. removeSelection ( 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 Arguments:

locator - an element locator identifying a multi-select box optionLocator - an option locator (a label by default)

select ( 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.)

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. Arguments:

selectLocator - an element locator identifying a drop-down menu optionLocator - an option locator (a label by default)

selectFrame ( 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"]

Arguments:

locator - an element locator identifying a frame or iframe

selectWindow ( 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. Arguments:

windowID - the JavaScript window ID of the window to select

setContext ( 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.) Arguments:

context - the message to be sent to the browser logLevelThreshold - one of "debug", "info", "warn", "error", sets the threshold for browser-side logging

setCursorPosition ( 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. Arguments:

locator - an element locator pointing to an input element or textarea 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.

setTimeout ( 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. Arguments:

timeout - a timeout in milliseconds, after which the action will return with an error

submit ( formLocator ) Submit the specified form. This is particularly useful for forms without submit buttons, e.g. single-input "Search" forms. Arguments:

formLocator - an element locator for the form you want to submit

type ( 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. Arguments:

locator - an element locator value - the value to type

uncheck ( locator ) Uncheck a toggle-button (checkbox/radio) Arguments:

locator - an element locator

waitForCondition ( 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 Arguments:

script - the JavaScript snippet to run timeout - a timeout in milliseconds, after which this command will return with an error

waitForPageToLoad ( 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. Arguments:

timeout - a timeout in milliseconds, after which this command will return with an error

waitForPopUp ( windowID,timeout ) Waits for a popup window to appear and load up. Arguments:

windowID - the JavaScript window ID of the window that will appear timeout - a timeout in milliseconds, after which the action will return with an error

windowFocus ( windowName ) Gives focus to a window Arguments:

windowName - name of the window to be given focus

windowMaximize ( windowName ) Resize window to take up the entire screen Arguments:

windowName - name of the window to be enlarged

Selenium Accessors
storeAlert ( variableName ) 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.

Returns: The message of the most recent JavaScript alert Related Assertions, automatically generated:

assertAlert ( pattern ) assertNotAlert ( pattern ) verifyAlert ( pattern ) verifyNotAlert ( pattern ) waitForAlert ( pattern ) waitForNotAlert ( pattern )

storeAllButtons ( variableName ) Returns the IDs of all buttons on the page. If a given button has no ID, it will appear as "" in this array. Returns: the IDs of all buttons on the page Related Assertions, automatically generated:

assertAllButtons ( pattern ) assertNotAllButtons ( pattern ) verifyAllButtons ( pattern ) verifyNotAllButtons ( pattern ) waitForAllButtons ( pattern ) waitForNotAllButtons ( pattern )

storeAllFields ( variableName ) Returns the IDs of all input fields on the page. If a given field has no ID, it will appear as "" in this array. Returns: the IDs of all field on the page Related Assertions, automatically generated:

assertAllFields ( pattern ) assertNotAllFields ( pattern ) verifyAllFields ( pattern ) verifyNotAllFields ( pattern ) waitForAllFields ( pattern )

waitForNotAllFields ( pattern )

storeAllLinks ( variableName ) Returns the IDs of all links on the page. If a given link has no ID, it will appear as "" in this array. Returns: the IDs of all links on the page Related Assertions, automatically generated:

assertAllLinks ( pattern ) assertNotAllLinks ( pattern ) verifyAllLinks ( pattern ) verifyNotAllLinks ( pattern ) waitForAllLinks ( pattern ) waitForNotAllLinks ( pattern )

storeAllWindowIds ( variableName ) Returns the IDs of all windows that the browser knows about. Returns: the IDs of all windows that the browser knows about. Related Assertions, automatically generated:

assertAllWindowIds ( pattern ) assertNotAllWindowIds ( pattern ) verifyAllWindowIds ( pattern ) verifyNotAllWindowIds ( pattern ) waitForAllWindowIds ( pattern ) waitForNotAllWindowIds ( pattern )

storeAllWindowNames ( variableName ) Returns the names of all windows that the browser knows about. Returns: the names of all windows that the browser knows about. Related Assertions, automatically generated:

assertAllWindowNames ( pattern ) assertNotAllWindowNames ( pattern ) verifyAllWindowNames ( pattern )

verifyNotAllWindowNames ( pattern ) waitForAllWindowNames ( pattern ) waitForNotAllWindowNames ( pattern )

storeAllWindowTitles ( variableName ) Returns the titles of all windows that the browser knows about. Returns: the titles of all windows that the browser knows about. Related Assertions, automatically generated:

assertAllWindowTitles ( pattern ) assertNotAllWindowTitles ( pattern ) verifyAllWindowTitles ( pattern ) verifyNotAllWindowTitles ( pattern ) waitForAllWindowTitles ( pattern ) waitForNotAllWindowTitles ( pattern )

storeAttribute ( attributeLocator, variableName ) 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. Arguments:

attributeLocator - an element locator followed by an variableName - the name of a variable in which the result is to be stored.

Returns: the value of the specified attribute Related Assertions, automatically generated:

assertAttribute ( attributeLocator, pattern ) assertNotAttribute ( attributeLocator, pattern ) verifyAttribute ( attributeLocator, pattern ) verifyNotAttribute ( attributeLocator, pattern ) waitForAttribute ( attributeLocator, pattern ) waitForNotAttribute ( attributeLocator, pattern )

storeAttributeFromAllWindows ( attributeName, variableName ) Returns every instance of some attribute from all known windows.

Arguments:

attributeName - name of an attribute on the windows variableName - the name of a variable in which the result is to be stored.

Returns: the set of values of this attribute from all known windows. Related Assertions, automatically generated:

assertAttributeFromAllWindows ( attributeName, pattern ) assertNotAttributeFromAllWindows ( attributeName, pattern ) verifyAttributeFromAllWindows ( attributeName, pattern ) verifyNotAttributeFromAllWindows ( attributeName, pattern ) waitForAttributeFromAllWindows ( attributeName, pattern ) waitForNotAttributeFromAllWindows ( attributeName, pattern )

storeBodyText ( variableName ) Gets the entire text of the page. Returns: the entire text of the page Related Assertions, automatically generated:

assertBodyText ( pattern ) assertNotBodyText ( pattern ) verifyBodyText ( pattern ) verifyNotBodyText ( pattern ) waitForBodyText ( pattern ) waitForNotBodyText ( pattern )

storeConfirmation ( variableName ) 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. Returns: the message of the most recent JavaScript confirmation dialog Related Assertions, automatically generated:

assertConfirmation ( pattern ) assertNotConfirmation ( pattern ) verifyConfirmation ( pattern ) verifyNotConfirmation ( pattern ) waitForConfirmation ( pattern ) waitForNotConfirmation ( pattern )

storeCookie ( variableName ) Return all cookies of the current page under test. Returns: all cookies of the current page under test Related Assertions, automatically generated:

assertCookie ( pattern ) assertNotCookie ( pattern ) verifyCookie ( pattern ) verifyNotCookie ( pattern ) waitForCookie ( pattern ) waitForNotCookie ( pattern )

storeCursorPosition ( locator, variableName ) 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. Arguments:

locator - an element locator pointing to an input element or textarea

variableName - the name of a variable in which the result is to be stored.

Returns: the numerical position of the cursor in the field Related Assertions, automatically generated:

assertCursorPosition ( locator, pattern ) assertNotCursorPosition ( locator, pattern ) verifyCursorPosition ( locator, pattern ) verifyNotCursorPosition ( locator, pattern ) waitForCursorPosition ( locator, pattern ) waitForNotCursorPosition ( locator, pattern )

storeElementHeight ( locator, variableName ) Retrieves the height of an element Arguments:

locator - an element locator pointing to an element variableName - the name of a variable in which the result is to be stored.

Returns: height of an element in pixels Related Assertions, automatically generated:

assertElementHeight ( locator, pattern ) assertNotElementHeight ( locator, pattern ) verifyElementHeight ( locator, pattern ) verifyNotElementHeight ( locator, pattern ) waitForElementHeight ( locator, pattern ) waitForNotElementHeight ( locator, pattern )

storeElementIndex ( locator, variableName ) Get the relative index of an element to its parent (starting from 0). The comment node and empty text node will be ignored. Arguments:

locator - an element locator pointing to an element variableName - the name of a variable in which the result is to be stored.

Returns:

of relative index of the element to its parent (starting from 0) Related Assertions, automatically generated:

assertElementIndex ( locator, pattern ) assertNotElementIndex ( locator, pattern ) verifyElementIndex ( locator, pattern ) verifyNotElementIndex ( locator, pattern ) waitForElementIndex ( locator, pattern ) waitForNotElementIndex ( locator, pattern )

storeElementPositionLeft ( locator, variableName ) Retrieves the horizontal position of an element Arguments:

locator - an element locator pointing to an element OR an element itself variableName - the name of a variable in which the result is to be stored.

Returns: of pixels from the edge of the frame. Related Assertions, automatically generated:

assertElementPositionLeft ( locator, pattern ) assertNotElementPositionLeft ( locator, pattern ) verifyElementPositionLeft ( locator, pattern ) verifyNotElementPositionLeft ( locator, pattern ) waitForElementPositionLeft ( locator, pattern ) waitForNotElementPositionLeft ( locator, pattern )

storeElementPositionTop ( locator, variableName ) Retrieves the vertical position of an element Arguments:

locator - an element locator pointing to an element OR an element itself variableName - the name of a variable in which the result is to be stored.

Returns: of pixels from the edge of the frame. Related Assertions, automatically generated:

assertElementPositionTop ( locator, pattern ) assertNotElementPositionTop ( locator, pattern ) verifyElementPositionTop ( locator, pattern ) verifyNotElementPositionTop ( locator, pattern ) waitForElementPositionTop ( locator, pattern ) waitForNotElementPositionTop ( locator, pattern )

storeElementWidth ( locator, variableName ) Retrieves the width of an element Arguments:

locator - an element locator pointing to an element variableName - the name of a variable in which the result is to be stored.

Returns: width of an element in pixels Related Assertions, automatically generated:

assertElementWidth ( locator, pattern ) assertNotElementWidth ( locator, pattern ) verifyElementWidth ( locator, pattern ) verifyNotElementWidth ( locator, pattern ) waitForElementWidth ( locator, pattern ) waitForNotElementWidth ( locator, pattern )

storeEval ( script, variableName ) 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. Arguments:

script - the JavaScript snippet to run variableName - the name of a variable in which the result is to be stored.

Returns: the results of evaluating the snippet Related Assertions, automatically generated:

assertEval ( script, pattern ) assertNotEval ( script, pattern ) verifyEval ( script, pattern ) verifyNotEval ( script, pattern ) waitForEval ( script, pattern ) waitForNotEval ( script, pattern )

storeExpression ( expression, variableName ) Returns the specified expression. This is useful because of JavaScript preprocessing. It is used to generate commands like assertExpression and waitForExpression. Arguments:

expression - the value to return variableName - the name of a variable in which the result is to be stored.

Returns: the value passed in Related Assertions, automatically generated:

assertExpression ( expression, pattern ) assertNotExpression ( expression, pattern ) verifyExpression ( expression, pattern ) verifyNotExpression ( expression, pattern ) waitForExpression ( expression, pattern ) waitForNotExpression ( expression, pattern )

storeHtmlSource ( variableName ) Returns the entire HTML source between the opening and closing "html" tags. Returns: the entire HTML source Related Assertions, automatically generated:

assertHtmlSource ( pattern ) assertNotHtmlSource ( pattern )

verifyHtmlSource ( pattern ) verifyNotHtmlSource ( pattern ) waitForHtmlSource ( pattern ) waitForNotHtmlSource ( pattern )

storeLocation ( variableName ) Gets the absolute URL of the current page. Returns: the absolute URL of the current page Related Assertions, automatically generated:

assertLocation ( pattern ) assertNotLocation ( pattern ) verifyLocation ( pattern ) verifyNotLocation ( pattern ) waitForLocation ( pattern ) waitForNotLocation ( pattern )

storeLogMessages ( variableName ) 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. Returns: all log messages seen since the last call to this API Related Assertions, automatically generated:

assertLogMessages ( pattern ) assertNotLogMessages ( pattern ) verifyLogMessages ( pattern ) verifyNotLogMessages ( pattern ) waitForLogMessages ( pattern ) waitForNotLogMessages ( pattern )

storePrompt ( variableName ) 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. Returns: the message of the most recent JavaScript question prompt Related Assertions, automatically generated:

assertPrompt ( pattern ) assertNotPrompt ( pattern ) verifyPrompt ( pattern ) verifyNotPrompt ( pattern ) waitForPrompt ( pattern ) waitForNotPrompt ( pattern )

storeSelectedId ( selectLocator, variableName ) Gets option element ID for selected option in the specified select element. Arguments:

selectLocator - an element locator identifying a drop-down menu variableName - the name of a variable in which the result is to be stored.

Returns: the selected option ID in the specified select drop-down Related Assertions, automatically generated:

assertSelectedId ( selectLocator, pattern ) assertNotSelectedId ( selectLocator, pattern ) verifySelectedId ( selectLocator, pattern ) verifyNotSelectedId ( selectLocator, pattern ) waitForSelectedId ( selectLocator, pattern ) waitForNotSelectedId ( selectLocator, pattern )

storeSelectedIds ( selectLocator, variableName ) Gets all option element IDs for selected options in the specified select or multi-select element. Arguments:

selectLocator - an element locator identifying a drop-down menu variableName - the name of a variable in which the result is to be stored.

Returns: an array of all selected option IDs in the specified select drop-down Related Assertions, automatically generated:

assertSelectedIds ( selectLocator, pattern ) assertNotSelectedIds ( selectLocator, pattern ) verifySelectedIds ( selectLocator, pattern ) verifyNotSelectedIds ( selectLocator, pattern ) waitForSelectedIds ( selectLocator, pattern ) waitForNotSelectedIds ( selectLocator, pattern )

storeSelectedIndex ( selectLocator, variableName ) Gets option index (option number, starting at 0) for selected option in the specified select element. Arguments:

selectLocator - an element locator identifying a drop-down menu variableName - the name of a variable in which the result is to be stored.

Returns: the selected option index in the specified select drop-down Related Assertions, automatically generated:

assertSelectedIndex ( selectLocator, pattern ) assertNotSelectedIndex ( selectLocator, pattern ) verifySelectedIndex ( selectLocator, pattern ) verifyNotSelectedIndex ( selectLocator, pattern ) waitForSelectedIndex ( selectLocator, pattern ) waitForNotSelectedIndex ( selectLocator, pattern )

storeSelectedIndexes ( selectLocator, variableName )

Gets all option indexes (option number, starting at 0) for selected options in the specified select or multi-select element. Arguments:

selectLocator - an element locator identifying a drop-down menu variableName - the name of a variable in which the result is to be stored.

Returns: an array of all selected option indexes in the specified select drop-down Related Assertions, automatically generated:

assertSelectedIndexes ( selectLocator, pattern ) assertNotSelectedIndexes ( selectLocator, pattern ) verifySelectedIndexes ( selectLocator, pattern ) verifyNotSelectedIndexes ( selectLocator, pattern ) waitForSelectedIndexes ( selectLocator, pattern ) waitForNotSelectedIndexes ( selectLocator, pattern )

storeSelectedLabel ( selectLocator, variableName ) Gets option label (visible text) for selected option in the specified select element. Arguments:

selectLocator - an element locator identifying a drop-down menu variableName - the name of a variable in which the result is to be stored.

Returns: the selected option label in the specified select drop-down Related Assertions, automatically generated:

assertSelectedLabel ( selectLocator, pattern ) assertNotSelectedLabel ( selectLocator, pattern ) verifySelectedLabel ( selectLocator, pattern ) verifyNotSelectedLabel ( selectLocator, pattern ) waitForSelectedLabel ( selectLocator, pattern ) waitForNotSelectedLabel ( selectLocator, pattern )

storeSelectedLabels ( selectLocator, variableName ) Gets all option labels (visible text) for selected options in the specified select or multiselect element.

Arguments:

selectLocator - an element locator identifying a drop-down menu variableName - the name of a variable in which the result is to be stored.

Returns: an array of all selected option labels in the specified select drop-down Related Assertions, automatically generated:

assertSelectedLabels ( selectLocator, pattern ) assertNotSelectedLabels ( selectLocator, pattern ) verifySelectedLabels ( selectLocator, pattern ) verifyNotSelectedLabels ( selectLocator, pattern ) waitForSelectedLabels ( selectLocator, pattern ) waitForNotSelectedLabels ( selectLocator, pattern )

storeSelectedValue ( selectLocator, variableName ) Gets option value (value attribute) for selected option in the specified select element. Arguments:

selectLocator - an element locator identifying a drop-down menu variableName - the name of a variable in which the result is to be stored.

Returns: the selected option value in the specified select drop-down Related Assertions, automatically generated:

assertSelectedValue ( selectLocator, pattern ) assertNotSelectedValue ( selectLocator, pattern ) verifySelectedValue ( selectLocator, pattern ) verifyNotSelectedValue ( selectLocator, pattern ) waitForSelectedValue ( selectLocator, pattern ) waitForNotSelectedValue ( selectLocator, pattern )

storeSelectedValues ( selectLocator, variableName ) Gets all option values (value attributes) for selected options in the specified select or multi-select element. Arguments:

selectLocator - an element locator identifying a drop-down menu

variableName - the name of a variable in which the result is to be stored.

Returns: an array of all selected option values in the specified select drop-down Related Assertions, automatically generated:

assertSelectedValues ( selectLocator, pattern ) assertNotSelectedValues ( selectLocator, pattern ) verifySelectedValues ( selectLocator, pattern ) verifyNotSelectedValues ( selectLocator, pattern ) waitForSelectedValues ( selectLocator, pattern ) waitForNotSelectedValues ( selectLocator, pattern )

storeSelectOptions ( selectLocator, variableName ) Gets all option labels in the specified select drop-down. Arguments:

selectLocator - an element locator identifying a drop-down menu variableName - the name of a variable in which the result is to be stored.

Returns: an array of all option labels in the specified select drop-down Related Assertions, automatically generated:

assertSelectOptions ( selectLocator, pattern ) assertNotSelectOptions ( selectLocator, pattern ) verifySelectOptions ( selectLocator, pattern ) verifyNotSelectOptions ( selectLocator, pattern ) waitForSelectOptions ( selectLocator, pattern ) waitForNotSelectOptions ( selectLocator, pattern )

storeTable ( tableCellAddress, variableName ) Gets the text from a cell of a table. The cellAddress syntax tableLocator.row.column, where row and column start at 0. Arguments:

tableCellAddress - a cell address, e.g. "foo.1.4" variableName - the name of a variable in which the result is to be stored.

Returns:

the text from the specified cell Related Assertions, automatically generated:

assertTable ( tableCellAddress, pattern ) assertNotTable ( tableCellAddress, pattern ) verifyTable ( tableCellAddress, pattern ) verifyNotTable ( tableCellAddress, pattern ) waitForTable ( tableCellAddress, pattern ) waitForNotTable ( tableCellAddress, pattern )

storeText ( locator, variableName ) 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. Arguments:

locator - an element locator variableName - the name of a variable in which the result is to be stored.

Returns: the text of the element Related Assertions, automatically generated:

assertText ( locator, pattern ) assertNotText ( locator, pattern ) verifyText ( locator, pattern ) verifyNotText ( locator, pattern ) waitForText ( locator, pattern ) waitForNotText ( locator, pattern )

storeTitle ( variableName ) Gets the title of the current page. Returns: the title of the current page Related Assertions, automatically generated:

assertTitle ( pattern ) assertNotTitle ( pattern ) verifyTitle ( pattern ) verifyNotTitle ( pattern )

waitForTitle ( pattern ) waitForNotTitle ( pattern )

storeValue ( locator, variableName ) 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. Arguments:

locator - an element locator variableName - the name of a variable in which the result is to be stored.

Returns: the element value, or "on/off" for checkbox/radio elements Related Assertions, automatically generated:

assertValue ( locator, pattern ) assertNotValue ( locator, pattern ) verifyValue ( locator, pattern ) verifyNotValue ( locator, pattern ) waitForValue ( locator, pattern ) waitForNotValue ( locator, pattern )

storeWhetherThisFrameMatchFrameExpression ( currentFrameString, target, variableName ) 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. Arguments:

currentFrameString - starting frame target - new frame (which might be relative to the current one) variableName - the name of a variable in which the result is to be stored.

Returns: true if the new frame is this code's window

Related Assertions, automatically generated:

assertWhetherThisFrameMatchFrameExpression ( currentFrameString, target ) assertNotWhetherThisFrameMatchFrameExpression ( currentFrameString, target ) verifyWhetherThisFrameMatchFrameExpression ( currentFrameString, target ) verifyNotWhetherThisFrameMatchFrameExpression ( currentFrameString, target ) waitForWhetherThisFrameMatchFrameExpression ( currentFrameString, target ) waitForNotWhetherThisFrameMatchFrameExpression ( currentFrameString, target )

storeAlertPresent ( variableName ) Has an alert occurred? This function never throws an exception Returns: true if there is an alert Related Assertions, automatically generated:

assertAlertPresent ( ) assertAlertNotPresent ( ) verifyAlertPresent ( ) verifyAlertNotPresent ( ) waitForAlertPresent ( ) waitForAlertNotPresent ( )

storeChecked ( locator, variableName ) Gets whether a toggle-button (checkbox/radio) is checked. Fails if the specified element doesn't exist or isn't a toggle-button. Arguments:

locator - an element locator pointing to a checkbox or radio button variableName - the name of a variable in which the result is to be stored.

Returns: true if the checkbox is checked, false otherwise Related Assertions, automatically generated:

assertChecked ( locator )

assertNotChecked ( locator ) verifyChecked ( locator ) verifyNotChecked ( locator ) waitForChecked ( locator ) waitForNotChecked ( locator )

storeConfirmationPresent ( variableName ) Has confirm() been called? This function never throws an exception Returns: true if there is a pending confirmation Related Assertions, automatically generated:

assertConfirmationPresent ( ) assertConfirmationNotPresent ( ) verifyConfirmationPresent ( ) verifyConfirmationNotPresent ( ) waitForConfirmationPresent ( ) waitForConfirmationNotPresent ( )

storeEditable ( locator, variableName ) 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. Arguments:

locator - an element locator variableName - the name of a variable in which the result is to be stored.

Returns: true if the input element is editable, false otherwise Related Assertions, automatically generated:

assertEditable ( locator ) assertNotEditable ( locator ) verifyEditable ( locator ) verifyNotEditable ( locator ) waitForEditable ( locator ) waitForNotEditable ( locator )

storeElementPresent ( locator, variableName ) Verifies that the specified element is somewhere on the page. Arguments:

locator - an element locator variableName - the name of a variable in which the result is to be stored.

Returns: true if the element is present, false otherwise Related Assertions, automatically generated:

assertElementPresent ( locator ) assertElementNotPresent ( locator ) verifyElementPresent ( locator ) verifyElementNotPresent ( locator ) waitForElementPresent ( locator ) waitForElementNotPresent ( locator )

storeOrdered ( locator1, locator2, variableName ) Check if these two elements have same parent and are ordered. Two same elements will not be considered ordered. Arguments:

locator1 - an element locator pointing to the first element locator2 - an element locator pointing to the second element variableName - the name of a variable in which the result is to be stored.

Returns: true if two elements are ordered and have same parent, false otherwise Related Assertions, automatically generated:

assertOrdered ( locator1, locator2 ) assertNotOrdered ( locator1, locator2 ) verifyOrdered ( locator1, locator2 ) verifyNotOrdered ( locator1, locator2 ) waitForOrdered ( locator1, locator2 ) waitForNotOrdered ( locator1, locator2 )

storePromptPresent ( variableName )

Has a prompt occurred? This function never throws an exception Returns: true if there is a pending prompt Related Assertions, automatically generated:

assertPromptPresent ( ) assertPromptNotPresent ( ) verifyPromptPresent ( ) verifyPromptNotPresent ( ) waitForPromptPresent ( ) waitForPromptNotPresent ( )

storeSomethingSelected ( selectLocator, variableName ) Determines whether some option in a drop-down menu is selected. Arguments:

selectLocator - an element locator identifying a drop-down menu variableName - the name of a variable in which the result is to be stored.

Returns: true if some option has been selected, false otherwise Related Assertions, automatically generated:

assertSomethingSelected ( selectLocator ) assertNotSomethingSelected ( selectLocator ) verifySomethingSelected ( selectLocator ) verifyNotSomethingSelected ( selectLocator ) waitForSomethingSelected ( selectLocator ) waitForNotSomethingSelected ( selectLocator )

storeTextPresent ( pattern, variableName ) Verifies that the specified text pattern appears somewhere on the rendered page shown to the user. Arguments:

pattern - a pattern to match with the text of the page variableName - the name of a variable in which the result is to be stored.

Returns: true if the pattern matches the text, false otherwise Related Assertions, automatically generated:

assertTextPresent ( pattern ) assertTextNotPresent ( pattern ) verifyTextPresent ( pattern ) verifyTextNotPresent ( pattern ) waitForTextPresent ( pattern ) waitForTextNotPresent ( pattern )

storeVisible ( locator, variableName ) 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. Arguments:

locator - an element locator variableName - the name of a variable in which the result is to be stored.

Returns: true if the specified element is visible, false otherwise Related Assertions, automatically generated:

assertVisible ( locator ) assertNotVisible ( locator ) verifyVisible ( locator ) verifyNotVisible ( locator ) waitForVisible ( locator ) waitForNotVisible ( locator )

Parameter construction and Variables

All Selenium command parameters can be constructed using both simple variable substitution as well as full javascript. Both of these mechanisms can access previously stored variables, but do so using different syntax. Stored Variables

The commands store, storeValue and storeText can be used to store a variable value for later access. Internally, these variables are stored in a map called "storedVars", with values keyed by the variable name. These commands are documented in the command reference. Variable substitution Variable substitution provides a simple way to include a previously stored variable in a command parameter. This is a simple mechanism, by which the variable to substitute is indicated by ${variableName}. Multiple variables can be substituted, and intermixed with static text. Example: store store type Mr title surname Full name is: ${fullname}

storeValue nameField textElement

${title} ${surname} fullname

Javascript evaluation Javascript evaluation provides the full power of javascript in constructing a command parameter. To use this mechanism, the entire parameter value must be prefixed by 'javascript{' with a trailing '}'. The text inside the braces is evaluated as a javascript expression, and can access previously stored variables using the storedVars map detailed above. Note that variable substitution cannot be combined with javascript evaluation. Example: store javascript{'merchant' + (new Date()).getTime()} merchantId javascript{storedVars['merchantId'].toUpperCase()}

type textElement

Extending Selenium
It can be quite simple to extend Selenium, adding your own actions, assertions and locatorstrategies. This is done with javascript by adding methods to the Selenium object prototype, and the PageBot object prototype. On startup, Selenium will automatically look through methods on these prototypes, using name patterns to recognise which ones are actions, assertions and locators. The following examples try to give an indication of how Selenium can be extended with javascript. Actions

All doFoo methods on the Selenium prototype are added as actions. For each action foo there is also an action fooAndWait registered. An action method can take up to 2 parameters, which will be passed the second and third column values in the test. Example: Add a "typeRepeated" action to Selenium, which types the text twice into a text box.
Selenium.prototype.doTypeRepeated = function(locator, text) { // All locator-strategies are automatically handled by "findElement" var element = this.page().findElement(locator); // Create the text to type var valueToType = text + text; // Replace the element text with the new text this.page().replaceText(element, valueToType); };

Accessors/Assertions All getFoo and isFoo methods on the Selenium prototype are added as accessors (storeFoo). For each accessor there is an assertFoo, verifyFoo and waitForFoo registered. An assert method can take up to 2 parameters, which will be passed the second and third column values in the test. You can also define your own assertions literally as simple "assert" methods, which will also autogenerate "verify" and "waitFor" commands. Example: Add a valueRepeated assertion, that makes sure that the element value consists of the supplied text repeated. The 2 commands that would be available in tests would be assertValueRepeated and verifyValueRepeated.
Selenium.prototype.assertValueRepeated = function(locator, text) { // All locator-strategies are automatically handled by "findElement" var element = this.page().findElement(locator); // Create the text to verify var expectedValue = text + text; // Get the actual element value var actualValue = element.value; // Make sure the actual value matches the expected Assert.matches(expectedValue, actualValue); };

Automatic availability of storeFoo, assertFoo, assertNotFoo, waitForFoo and waitForNotFoo for every getFoo

All getFoo and isFoo methods on the Selenium prototype automatically result in the availability of storeFoo, assertFoo, assertNotFoo, verifyFoo, verifyNotFoo, waitForFoo, and waitForNotFoo commands. Example, if you add a getTextLength() method, the following commands will automatically be available: storeTextLength, assertTextLength, assertNotTextLength, verifyTextLength, verifyNotTextLength, waitForTextLength, and waitForNotTextLength commands.
Selenium.prototype.getTextLength = function(locator, text) { return this.getText(locator).length; };

Also note that the assertValueRepeated method described above could have been implemented using isValueRepeated, with the added benefit of also automatically getting assertNotValueRepeated, storeValueRepeated, waitForValueRepeated and waitForNotValueRepeated. Locator Strategies All locateElementByFoo methods on the PageBot prototype are added as locator-strategies. A locator strategy takes 2 parameters, the first being the locator string (minus the prefix), and the second being the document in which to search. Example: Add a "valuerepeated=" locator, that finds the first element a value attribute equal to the the supplied value repeated.
// The "inDocument" is a the document you are searching. PageBot.prototype.locateElementByValueRepeated = function(text, inDocument) { // Create the text to search for var expectedValue = text + text; // Loop through all elements, looking for ones that have // a value === our expected value var allElements = inDocument.getElementsByTagName("*"); for (var i = 0; i < allElements.length; i++) { var testElement = allElements[i]; if (testElement.value && testElement.value === expectedValue) { return testElement; } } return null; };

user-extensions.js

By default, Selenium looks for a file called "user-extensions.js", and loads the javascript code found in that file. This file provides a convenient location for adding features to Selenium, without needing to modify the core Selenium sources. In the standard distibution, this file does not exist. Users can create this file and place their extension code in this common location, removing the need to modify the Selenium sources, and hopefully assisting with the upgrade process.

Selenium

About Support Documentation Download Projects

search selenium:

Navigation

Selenium Documentation next previous |

Table Of Contents

Selenium-IDE o Introduction o Installing the IDE o Opening the IDE o IDE Features o Building Test Cases o Running Test Cases o Using Base URL to Run Test Cases in Different Domains o Selenium Commands Selenese o Script Syntax o Test Suites o Commonly Used Selenium Commands o Verifying Page Elements o Assertion or Verification? o Locating Elements o Matching Text Patterns o The AndWait Commands

o o o o o o o o o o o o

The waitFor Commands in AJAX applications Sequence of Evaluation and Flow Control Store Commands and Selenium Variables JavaScript and Selenese Parameters echo - The Selenese Print Command Alerts, Popups, and Multiple Windows Debugging Writing a Test Suite User Extensions Format Executing Selenium-IDE Tests on Different Browsers Troubleshooting

Previous topic

Introduction
Next topic

Selenium WebDriver
Programming Language Preference

Selenium-IDE
Introduction
The Selenium-IDE (Integrated Development Environment) is the tool you use to develop your Selenium test cases. Its an easy-to-use Firefox plug-in and is generally the most efficient way to develop test cases. It also contains a context menu that allows you to first select a UI element from the browsers currently displayed page and then select from a list of Selenium commands with parameters pre-defined according to the context of the selected UI element. This is not only a time-saver, but also an excellent way of learning Selenium script syntax. This chapter is all about the Selenium IDE and how to use it effectively.

Installing the IDE

Using Firefox, first, download the IDE from the SeleniumHQ downloads page Firefox will protect you from installing addons from unfamiliar locations, so you will need to click Allow to proceed with the installation, as shown in the following screenshot.

When downloading from Firefox, youll be presented with the following window.

Select Install Now. The Firefox Add-ons window pops up, first showing a progress bar, and when the download is complete, displays the following.

Restart Firefox. After Firefox reboots you will find the Selenium-IDE listed under the Firefox Tools menu.

Opening the IDE

To run the Selenium-IDE, simply select it from the Firefox Tools menu. It opens as follows with an empty script-editing window and a menu for loading, or creating new test cases.

IDE Features
Menu Bar
The File menu has options for Test Case and Test Suite (suite of Test Cases). Using these you can add a new Test Case, open a Test Case, save a Test Case, export Test Case in a language of your choice. You can also open the recent Test Case.All these options are also available for Test Suite. The Edit menu allows copy, paste, delete, undo, and select all operations for editing the commands in your test case. The Options menu allows the changing of settings. You can set the timeout value for certain commands, add user-defined user extensions to the base set of Selenium commands, and specify the format (language) used when saving your test cases. The Help menu is the standard Firefox Help menu; only one item on this menuUI-Element Documentationpertains to Selenium-IDE.

Toolbar
The toolbar contains buttons for controlling the execution of your test cases, including a step feature for debugging your test cases. The right-most button, the one with the red-dot, is the record button.

Speed Control: controls how fast your test case runs.

Run All: Runs the entire test suite when a test suite with multiple test cases is loaded.

Run: Runs the currently selected test. When only a single test is loaded this button and the Run All button have the same effect.

Pause/Resume: Allows stopping and re-starting of a running test case.

Step: Allows you to step through a test case by running it one command at a time. Use for debugging test cases.

TestRunner Mode: Allows you to run the test case in a browser loaded with the Selenium-Core TestRunner. The TestRunner is not commonly used now and is likely to be deprecated. This button is for evaluating test cases for backwards compatibility with the TestRunner. Most users will probably not need this button.

Apply Rollup Rules: This advanced feature allows repetitive sequences of Selenium commands to be grouped into a single action. Detailed documentation on rollup rules can be found in the UI-Element Documentation on the Help menu.

Record: Records the users browser actions.

Test Case Pane

Your script is displayed in the test case pane. It has two tabs, one for displaying the command and their parameters in a readable table format.

The other tab - Source displays the test case in the native format in which the file will be stored. By default, this is HTML although it can be changed to a programming language such as Java or

C#, or a scripting language like Python. See the Options menu for details. The Source view also allows one to edit the test case in its raw form, including copy, cut and paste operations. The Command, Target, and Value entry fields display the currently selected command along with its parameters. These are entry fields where you can modify the currently selected command. The first parameter specified for a command in the Reference tab of the bottom pane always goes in the Target field. If a second parameter is specified by the Reference tab, it always goes in the Value field.

If you start typing in the Command field, a drop-down list will be populated based on the first characters you type; you can then select your desired command from the drop-down.

Log/Reference/UI-Element/Rollup Pane
The bottom pane is used for four different functionsLog, Reference, UI-Element, and Rollup depending on which tab is selected.
Log

When you run your test case, error messages and information messages showing the progress are displayed in this pane automatically, even if you do not first select the Log tab. These messages are often useful for test case debugging. Notice the Clear button for clearing the Log. Also notice the Info button is a drop-down allowing selection of different levels of information to log.

Reference

The Reference tab is the default selection whenever you are entering or modifying Selenese commands and parameters in Table mode. In Table mode, the Reference pane will display documentation on the current command. When entering or modifying commands, whether from Table or Source mode, it is critically important to ensure that the parameters specified in the Target and Value fields match those specified in the parameter list in the Reference pane. The number of parameters provided must match the number specified, the order of parameters provided must match the order specified, and the type of parameters provided must match the type specified. If there is a mismatch in any of these three areas, the command will not run correctly.

While the Reference tab is invaluable as a quick reference, it is still often necessary to consult the Selenium Reference document.

UI-Element and Rollup

Detailed information on these two panes (which cover advanced features) can be found in the UI-Element Documentation on the Help menu of Selenium-IDE.

Building Test Cases

There are three primary methods for developing test cases. Frequently, a test developer will require all three techniques.

Recording
Many first-time users begin by recording a test case from their interactions with a website. When Selenium-IDE is first opened, the record button is ON by default. If you do not want SeleniumIDE to begin recording automatically you can turn this off by going under Options > Options... and deselecting Start recording immediately on open. During recording, Selenium-IDE will automatically insert commands into your test case based on your actions. Typically, this will include:

clicking a link - click or clickAndWait commands entering values - type command selecting options from a drop-down listbox - select command clicking checkboxes or radio buttons - click command

Here are some gotchas to be aware of:

The type command may require clicking on some other area of the web page for it to record. Following a link usually records a click command. You will often need to change this to clickAndWait to ensure your test case pauses until the new page is completely loaded. Otherwise, your test case will continue running commands before the page has loaded all its UI elements. This will cause unexpected test case failures.

Adding Verifications and Asserts With the Context Menu

Your test cases will also need to check the properties of a web-page. This requires assert and verify commands. We wont describe the specifics of these commands here; that is in the chapter on Selenium Commands Selenese. Here well simply describe how to add them to your test case. With Selenium-IDE recording, go to the browser displaying your test application and right click anywhere on the page. You will see a context menu showing verify and/or assert commands. The first time you use Selenium, there may only be one Selenium command listed. As you use the IDE however, you will find additional commands will quickly be added to this menu.

Selenium-IDE will attempt to predict what command, along with the parameters, you will need for a selected UI element on the current web-page. Lets see how this works. Open a web-page of your choosing and select a block of text on the page. A paragraph or a heading will work fine. Now, right-click the selected text. The context menu should give you a verifyTextPresent command and the suggested parameter should be the text itself. Also, notice the Show All Available Commands menu option. This shows many, many more commands, again, along with suggested parameters, for testing your currently selected UI element. Try a few more UI elements. Try right-clicking an image, or a user control like a button or a checkbox. You may need to use Show All Available Commands to see options other than verifyTextPresent. Once you select these other options, the more commonly used ones will show up on the primary context menu. For example, selecting verifyElementPresent for an image should later cause that command to be available on the primary context menu the next time you select an image and right-click. Again, these commands will be explained in detail in the chapter on Selenium commands. For now though, feel free to use the IDE to record and select commands into a test case and then run it. You can learn a lot about the Selenium commands simply by experimenting with the IDE.

Editing
Insert Command Table View

Select the point in your test case where you want to insert the command. To do this, in the Test Case Pane, left-click on the line where you want to insert a new command. Right-click and select Insert Command; the IDE will add a blank line just ahead of the line you selected. Now use the command editing text fields to enter your new command and its parameters.
Source View

Select the point in your test case where you want to insert the command. To do this, in the Test Case Pane, left-click between the commands where you want to insert a new command, and enter the HTML tags needed to create a 3-column row containing the Command, first parameter (if one is required by the Command), and second parameter (again, if one is required). Be sure to save your test before switching back to Table view.
Insert Comment

Comments may be added to make your test case more readable. These comments are ignored when the test case is run.

Comments may also be used to add vertical white space (one or more blank lines) in your tests; just create empty comments. An empty command will cause an error during execution; an empty comment wont.
Table View

Select the line in your test case where you want to insert the comment. Right-click and select Insert Comment. Now use the Command field to enter the comment. Your comment will appear in purple text.
Source View

Select the point in your test case where you want to insert the comment. Add an HTML-style comment, i.e., <!-- your comment here -->.
Edit a Command or Comment Table View

Simply select the line to be changed and edit it using the Command, Target, and Value fields.
Source View

Since Source view provides the equivalent of a WYSIWYG (What You See is What You Get) editor, simply modify which line you wishcommand, parameter, or comment.

Opening and Saving a Test Case

Like most programs, there are Save and Open commands under the File menu. However, Selenium distinguishes between test cases and test suites. To save your Selenium-IDE tests for later use you can either save the individual test cases, or save the test suite. If the test cases of your test suite have not been saved, youll be prompted to save them before saving the test suite. When you open an existing test case or suite, Selenium-IDE displays its Selenium commands in the Test Case Pane.

Running Test Cases

The IDE allows many options for running your test case. You can run a test case all at once, stop and start it, run it one line at a time, run a single command you are currently developing, and you can do a batch run of an entire test suite. Execution of test cases is very flexible in the IDE.
Run a Test Case Click the Run button to run the currently displayed test case.

Run a Test Suite Click the Run All button to run all the test cases in the currently loaded test suite. Stop and Start The Pause button can be used to stop the test case while it is running. The icon of this button then changes to indicate the Resume button. To continue click Resume. Stop in the Middle You can set a breakpoint in the test case to cause it to stop on a particular command. This is useful for debugging your test case. To set a breakpoint, select a command, right-click, and from the context menu select Toggle Breakpoint. Start from the Middle You can tell the IDE to begin running from a specific command in the middle of the test case. This also is used for debugging. To set a startpoint, select a command, right-click, and from the context menu select Set/Clear Start Point. Run Any Single Command Double-click any single command to run it by itself. This is useful when writing a single command. It lets you immediately test a command you are constructing, when you are not sure if it is correct. You can double-click it to see if it runs correctly. This is also available from the context menu.

Using Base URL to Run Test Cases in Different Domains

The Base URL field at the top of the Selenium-IDE window is very useful for allowing test cases to be run across different domains. Suppose that a site named http://news.portal.com had an inhouse beta site named http://beta.news.portal.com. Any test cases for these sites that begin with an open statement should specify a relative URL as the argument to open rather than an absolute URL (one starting with a protocol such as http: or https:). Selenium-IDE will then create an absolute URL by appending the open commands argument onto the end of the value of Base URL. For example, the test case below would be run against http://news.portal.com/about.html:

This same test case with a modified Base URL setting would be run against http://beta.news.portal.com/about.html:

Selenium Commands Selenese

Selenium commands, often called selenese, are the set of commands that run your tests. A sequence of these commands is a test script. Here we explain those commands in detail, and we present the many choices you have in testing your web application when using Selenium. Selenium provides a rich set of commands for fully testing your web-app in virtually any way you can imagine. The command set is often called selenese. These commands essentially create a testing language. In selenese, one can test the existence of UI elements based on their HTML tags, test for specific content, test for broken links, input fields, selection list options, submitting forms, and table data among other things. In addition Selenium commands support testing of window size, mouse position, alerts, Ajax functionality, pop up windows, event handling, and many other webapplication features. The Command Reference lists all the available commands. A command is what tells Selenium what to do. Selenium commands come in three flavors: Actions, Accessors, and Assertions.

Actions are commands that generally manipulate the state of the application. They do things like click this link and select that option. If an Action fails, or has an error, the execution of the current test is stopped. Many Actions can be called with the AndWait suffix, e.g. clickAndWait. This suffix tells Selenium that the action will cause the browser to make a call to the server, and that Selenium should wait for a new page to load.

Accessors examine the state of the application and store the results in variables, e.g. storeTitle. They are also used to automatically generate Assertions. Assertions are like Accessors, but they verify that the state of the application conforms to what is expected. Examples include make sure the page title is X and verify that this checkbox is checked. All Selenium Assertions can be used in 3 modes: assert, verify, and waitFor. For example, you can assertText, verifyText and waitForText. When an assert fails, the test is aborted. When a verify fails, the test will continue execution, logging the failure. This allows a single assert to ensure that the application is on the correct page, followed by a bunch of verify assertions to test form field values, labels, etc. waitFor commands wait for some condition to become true (which can be useful for testing Ajax applications). They will succeed immediately if the condition is already true. However, they will fail and halt the test if the condition does not become true within the current timeout setting (see the setTimeout action below).

Script Syntax

Selenium commands are simple, they consist of the command and two parameters. For example:
verifyText //div//a[2] Login

The parameters are not always required; it depends on the command. In some cases both are required, in others one parameter is required, and in still others the command may take no parameters at all. Here are a couple more examples:
goBackAndWait verifyTextPresent type type id=phone Welcome to My Home Page (555) 666-7066

id=address1 ${myVariableAddress}

The command reference describes the parameter requirements for each command. Parameters vary, however they are typically:

a locator for identifying a UI element within a page. a text pattern for verifying or asserting expected page content a text pattern or a selenium variable for entering text in an input field or for selecting an option from an option list.

Locators, text patterns, selenium variables, and the commands themselves are described in considerable detail in the section on Selenium Commands. Selenium scripts that will be run from Selenium-IDE will be be stored in an HTML text file format. This consists of an HTML table with three columns. The first column identifies the Selenium command, the second is a target, and the final column contains a value. The second and third columns may not require values depending on the chosen Selenium command, but they should be present. Each table row represents a new Selenium command. Here is an example of a test that opens a page, asserts the page title and then verifies some content on the page:
<table> <tr><td>open</td><td>/download/</td><td></td></tr> <tr><td>assertTitle</td><td></td><td>Downloads</td></tr> <tr><td>verifyText</td><td>//h2</td><td>Downloads</td></tr> </table>

Rendered as a table in a browser this would look like the following:

open assertTitle

/download/ Downloads Downloads

verifyText //h2

The Selenese HTML syntax can be used to write and run tests without requiring knowledge of a programming language. With a basic knowledge of selenese and Selenium-IDE you can quickly produce and run testcases.

Test Suites
A test suite is a collection of tests. Often one will run all the tests in a test suite as one continuous batch-job. When using Selenium-IDE, test suites also can be defined using a simple HTML file. The syntax again is simple. An HTML table defines a list of tests where each row defines the filesystem path to each test. An example tells it all.
<html> <head> <title>Test Suite Function Tests - Priority 1</title> </head> <body> <table> <tr><td><b>Suite Of Tests</b></td></tr> <tr><td><a href="./Login.html">Login</a></td></tr> <tr><td><a href="./SearchValues.html">Test Searching for Values</a></td></tr> <tr><td><a href="./SaveValues.html">Test Save</a></td></tr> </table> </body> </html>

A file similar to this would allow running the tests all at once, one after another, from the Selenium-IDE. Test suites can also be maintained when using Selenium-RC. This is done via programming and can be done a number of ways. Commonly Junit is used to maintain a test suite if one is using Selenium-RC with Java. Additionally, if C# is the chosen language, Nunit could be employed. If using an interpreted language like Python with Selenium-RC than some simple programming would be involved in setting up a test suite. Since the whole reason for using Selenium-RC is to make use of programming logic for your testing this usually isnt a problem.

Commonly Used Selenium Commands

To conclude our introduction of Selenium, well show you a few typical Selenium commands. These are probably the most commonly used commands for building tests.
open opens a page using a URL. click/clickAndWait performs a click operation, and optionally waits for a new page to load. verifyTitle/assertTitle verifies an expected page title. verifyTextPresent verifies expected text is somewhere on the page. verifyElementPresent verifies an expected UI element, as defined by its HTML tag, is present on the page. verifyText verifies expected text and its corresponding HTML tag are present on the page. verifyTable verifies a tables expected contents. waitForPageToLoad pauses execution until an expected new page loads. Called automatically when clickAndWait is used. waitForElementPresent pauses execution until an expected UI element, as defined by its HTML tag, is present on the page.

Verifying Page Elements

Verifying UI elements on a web page is probably the most common feature of your automated tests. Selenese allows multiple ways of checking for UI elements. It is important that you understand these different methods because these methods define what you are actually testing. For example, will you test that...

1. an element is present somewhere on the page? 2. specific text is somewhere on the page? 3. specific text is at a specific location on the page?

For example, if you are testing a text heading, the text and its position at the top of the page are probably relevant for your test. If, however, you are testing for the existence of an image on the home page, and the web designers frequently change the specific image file along with its position on the page, then you only want to test that an image (as opposed to the specific image file) exists somewhere on the page.

Assertion or Verification?
Choosing between assert and verify comes down to convenience and management of failures. Theres very little point checking that the first paragraph on the page is the correct one if your test has already failed when checking that the browser is displaying the expected page. If youre not on the correct page, youll probably want to abort your test case so that you can investigate the cause and fix the issue(s) promptly. On the other hand, you may want to check many attributes of a page without aborting the test case on the first failure as this will allow you to review all failures on the page and take the appropriate action. Effectively an assert will fail the test and abort the current test case, whereas a verify will fail the test and continue to run the test case. The best use of this feature is to logically group your test commands, and start each group with an assert followed by one or more verify test commands. An example follows:
Command open Target /download/ Value

assertTitle Downloads verifyText //h2 Downloads Selenium IDE June 3, 2008 1.0 beta 2

assertTable 1.2.1 verifyTable 1.2.2 verifyTable 1.2.3

The above example first opens a page and then asserts that the correct page is loaded by comparing the title with the expected value. Only if this passes will the following command run and verify that the text is present in the expected location. The test case then asserts the first column in the second row of the first table contains the expected value, and only if this passed will the remaining cells in that row be verified.

verifyTextPresent
The command verifyTextPresent is used to verify specific text exists somewhere on the page. It takes a single argumentthe text pattern to be verified. For example:
Command Target Value

verifyTextPresent Marketing Analysis

This would cause Selenium to search for, and verify, that the text string Marketing Analysis appears somewhere on the page currently being tested. Use verifyTextPresent when you are interested in only the text itself being present on the page. Do not use this when you also need to test where the text occurs on the page.

verifyElementPresent
Use this command when you must test for the presence of a specific UI element, rather then its content. This verification does not check the text, only the HTML tag. One common use is to check for the presence of an image.
Command Target Value

verifyElementPresent //div/p/img

This command verifies that an image, specified by the existence of an <img> HTML tag, is present on the page, and that it follows a <div> tag and a <p> tag. The first (and only) parameter is a locator for telling the Selenese command how to find the element. Locators are explained in the next section.
verifyElementPresent

can be used to check the existence of any HTML tag within the page. You can check the existence of links, paragraphs, divisions <div>, etc. Here are a few more examples.
Command verifyElementPresent //div/p verifyElementPresent //div/a verifyElementPresent id=Login Target Value

Command

Target

Value

verifyElementPresent link=Go to Marketing Research verifyElementPresent //a[2] verifyElementPresent //head/title

These examples illustrate the variety of ways a UI element may be tested. Again, locators are explained in the next section.

verifyText
Use verifyText when both the text and its UI element must be tested. verifyText must use a locator. If you choose an XPath or DOM locator, you can verify that specific text appears at a specific location on the page relative to other UI components on the page.
Command Target Value

verifyText //table/tr/td/div/p This is my text and it occurs right after the div inside the table.

Locating Elements
For many Selenium commands, a target is required. This target identifies an element in the content of the web application, and consists of the location strategy followed by the location in the format locatorType=location. The locator type can be omitted in many cases. The various locator types are explained below with examples for each.

Locating by Identifier
This is probably the most common method of locating elements and is the catch-all default when no recognized locator type is used. With this strategy, the first element with the id attribute value matching the location will be used. If no element has a matching id attribute, then the first element with a name attribute matching the location will be used. For instance, your page source could have id and name attributes as follows:
1 <html> 2 <body> 3 <form id="loginForm"> 4 <input name="username" type="text" /> 5 <input name="password" type="password" /> 6 <input name="continue" type="submit" value="Login" />

7 </form> 8 </body> 9 <html>

The following locator strategies would return the elements from the HTML snippet above indicated by line number:
identifier=loginForm (3) identifier=password (5) identifier=continue (6) continue (6)

Since the identifier type of locator is the default, the identifier= in the first three examples above is not necessary.
Locating by Id

This type of locator is more limited than the identifier locator type, but also more explicit. Use this when you know an elements id attribute.
1 <html> 2 <body> 3 <form id="loginForm"> 4 <input name="username" 5 <input name="password" 6 <input name="continue" 7 <input name="continue" 8 </form> 9 </body> 10 <html> id=loginForm (3)

type="text" /> type="password" /> type="submit" value="Login" /> type="button" value="Clear" />

Locating by Name

The name locator type will locate the first element with a matching name attribute. If multiple elements have the same value for a name attribute, then you can use filters to further refine your location strategy. The default filter type is value (matching the value attribute).
1 <html> 2 <body> 3 <form id="loginForm"> 4 <input name="username" 5 <input name="password" 6 <input name="continue" 7 <input name="continue" 8 </form> 9 </body> 10 <html>

type="text" /> type="password" /> type="submit" value="Login" /> type="button" value="Clear" />

name=username (4) name=continue value=Clear (7) name=continue Clear (7) name=continue type=button (7)

Note Unlike some types of XPath and DOM locators, the three types of locators above allow Selenium to test a UI element independent of its location on the page. So if the page structure and organization is altered, the test will still pass. You may or may not want to also test whether the page structure changes. In the case where web designers frequently alter the page, but its functionality must be regression tested, testing via id and name attributes, or really via any HTML property, becomes very important.
Locating by XPath

XPath is the language used for locating nodes in an XML document. As HTML can be an implementation of XML (XHTML), Selenium users can leverage this powerful language to target elements in their web applications. XPath extends beyond (as well as supporting) the simple methods of locating by id or name attributes, and opens up all sorts of new possibilities such as locating the third checkbox on the page. One of the main reasons for using XPath is when you dont have a suitable id or name attribute for the element you wish to locate. You can use XPath to either locate the element in absolute terms (not advised), or relative to an element that does have an id or name attribute. XPath locators can also be used to specify elements via attributes other than id and name. Absolute XPaths contain the location of all elements from the root (html) and as a result are likely to fail with only the slightest adjustment to the application. By finding a nearby element with an id or name attribute (ideally a parent element) you can locate your target element based on the relationship. This is much less likely to change and can make your tests more robust. Since only xpath locators start with //, it is not necessary to include the xpath= label when specifying an XPath locator.
1 <html> 2 <body> 3 <form id="loginForm"> 4 <input name="username" 5 <input name="password" 6 <input name="continue" 7 <input name="continue" 8 </form> 9 </body> 10 <html>

type="text" /> type="password" /> type="submit" value="Login" /> type="button" value="Clear" />

xpath=/html/body/form[1] (3) - Absolute path (would break if the HTML was changed only

slightly)

//form[1] (3) - First form element in the HTML xpath=//form[@id='loginForm'] (3) - The form element with attribute named id and the

value loginForm
xpath=//form[input/\@name='username'] (3) - First form element with an input child

element with attribute named name and the value username //input[@name='username'] (4) - First input element with attribute named name and the value username //form[@id='loginForm']/input[1] (4) - First input child element of the form element with attribute named id and the value loginForm //input[@name='continue'][@type='button'] (7) - Input with attribute named name and the value continue and attribute named type and the value button //form[@id='loginForm']/input[4] (7) - Fourth input child element of the form element with attribute named id and value loginForm

These examples cover some basics, but in order to learn more, the following references are recommended:

W3Schools XPath Tutorial W3C XPath Recommendation

There are also a couple of very useful Firefox Add-ons that can assist in discovering the XPath of an element:

XPath Checker - suggests XPath and can be used to test XPath results. Firebug - XPath suggestions are just one of the many powerful features of this very useful addon.

Locating Hyperlinks by Link Text

This is a simple method of locating a hyperlink in your web page by using the text of the link. If two links with the same text are present, then the first match will be used.
1 2 3 4 5 6 7 <html> <body> <p>Are you sure you want to do this?</p> <a href="continue.html">Continue</a> <a href="cancel.html">Cancel</a> </body> <html> link=Continue (4) link=Cancel (5)

Locating by DOM

The Document Object Model represents an HTML document and can be accessed using JavaScript. This location strategy takes JavaScript that evaluates to an element on the page, which can be simply the elements location using the hierarchical dotted notation.

Since only dom locators start with document, it is not necessary to include the dom= label when specifying a DOM locator.
1 <html> 2 <body> 3 <form id="loginForm"> 4 <input name="username" 5 <input name="password" 6 <input name="continue" 7 <input name="continue" 8 </form> 9 </body> 10 <html>

type="text" /> type="password" /> type="submit" value="Login" /> type="button" value="Clear" />

dom=document.getElementById('loginForm') (3) dom=document.forms['loginForm'] (3) dom=document.forms[0] (3) document.forms[0].username (4) document.forms[0].elements['username'] (4) document.forms[0].elements[0] (4) document.forms[0].elements[3] (7)

You can use Selenium itself as well as other sites and extensions to explore the DOM of your web application. A good reference exists on W3Schools.
Locating by CSS

CSS (Cascading Style Sheets) is a language for describing the rendering of HTML and XML documents. CSS uses Selectors for binding style properties to elements in the document. These Selectors can be used by Selenium as another locating strategy.
1 <html> 2 <body> 3 <form id="loginForm"> 4 <input class="required" name="username" type="text" /> 5 <input class="required passfield" name="password" type="password" /> 6 <input name="continue" type="submit" value="Login" /> 7 <input name="continue" type="button" value="Clear" /> 8 </form> 9 </body> 10 <html> css=form#loginForm (3) css=input[name="username"] (4) css=input.required[type="text"] (4) css=input.passfield (5) css=#loginForm input[type="button"] (4) css=#loginForm input:nth-child(2) (5)

For more information about CSS Selectors, the best place to go is the W3C publication. Youll find additional references there. Note Most experienced Selenium users recommend CSS as their locating strategy of choice as its considerably faster than XPath and can find the most complicated objects in an intrinsic HTML document.
Implicit Locators

You can choose to omit the locator type in the following situations:

Locators without an explicitly defined locator strategy will default to using the identifier locator strategy. See Locating by Identifier. Locators starting with // will use the XPath locator strategy. See Locating by XPath. Locators starting with document will use the DOM locator strategy. See Locating by DOM

Matching Text Patterns

Like locators, patterns are a type of parameter frequently required by Selenese commands. Examples of commands which require patterns are verifyTextPresent, verifyTitle, verifyAlert, assertConfirmation, verifyText, and verifyPrompt. And as has been mentioned above, link locators can utilize a pattern. Patterns allow you to describe, via the use of special characters, what text is expected rather than having to specify that text exactly. There are three types of patterns: globbing, regular expressions, and exact.

Globbing Patterns
Most people are familiar with globbing as it is utilized in filename expansion at a DOS or Unix/Linux command line such as ls *.c. In this case, globbing is used to display all the files ending with a .c extension that exist in the current directory. Globbing is fairly limited. Only two special characters are supported in the Selenium implementation: * which translates to match anything, i.e., nothing, a single character, or many characters. [ ] (character class) which translates to match any single character found inside the square brackets. A dash (hyphen) can be used as a shorthand to specify a range of characters (which are contiguous in the ASCII character set). A few examples will make the functionality of a character class clear:
[aeiou] [0-9]

matches any lowercase vowel

matches any digit

[a-zA-Z0-9]

matches any alphanumeric character

In most other contexts, globbing includes a third special character, the ?. However, Selenium globbing patterns only support the asterisk and character class. To specify a globbing pattern parameter for a Selenese command, you can prefix the pattern with a glob: label. However, because globbing patterns are the default, you can also omit the label and specify just the pattern itself. Below is an example of two commands that use globbing patterns. The actual link text on the page being tested was Film/Television Department; by using a pattern rather than the exact text, the click command will work even if the link text is changed to Film & Television Department or Film and Television Department. The glob patterns asterisk will match anything or nothing between the word Film and the word Television.
Command click Target link=glob:Film*Television Department Value

verifyTitle glob:*Film*Television*

The actual title of the page reached by clicking on the link was De Anza Film And Television Department - Menu. By using a pattern rather than the exact text, the verifyTitle will pass as long as the two words Film and Television appear (in that order) anywhere in the pages title. For example, if the pages owner should shorten the title to just Film & Television Department, the test would still pass. Using a pattern for both a link and a simple test that the link worked (such as the verifyTitle above does) can greatly reduce the maintenance for such test cases.
Regular Expression Patterns

Regular expression patterns are the most powerful of the three types of patterns that Selenese supports. Regular expressions are also supported by most high-level programming languages, many text editors, and a host of tools, including the Linux/Unix command-line utilities grep, sed, and awk. In Selenese, regular expression patterns allow a user to perform many tasks that would be very difficult otherwise. For example, suppose your test needed to ensure that a particular table cell contained nothing but a number. regexp: [0-9]+ is a simple pattern that will match a decimal number of any length. Whereas Selenese globbing patterns support only the * and [ ] (character class) features, Selenese regular expression patterns offer the same wide array of special characters that exist in JavaScript. Below are a subset of those special characters:

PATTERN . [] * + ? {1,5} | () any single character

MATCH

character class: any single character that appears inside the brackets quantifier: 0 or more of the preceding character (or group) quantifier: 1 or more of the preceding character (or group) quantifier: 0 or 1 of the preceding character (or group) quantifier: 1 through 5 of the preceding character (or group) alternation: the character/group on the left or the character/group on the right grouping: often used with alternation and/or quantifier

Regular expression patterns in Selenese need to be prefixed with either regexp: or regexpi:. The former is case-sensitive; the latter is case-insensitive. A few examples will help clarify how regular expression patterns can be used with Selenese commands. The first one uses what is probably the most commonly used regular expression pattern.* (dot star). This two-character sequence can be translated as 0 or more occurrences of any character or more simply, anything or nothing. It is the equivalent of the one-character globbing pattern * (a single asterisk).
Command click Target link=regexp:Film.*Television Department Value

verifyTitle regexp:.*Film.*Television.*

The example above is functionally equivalent to the earlier example that used globbing patterns for this same test. The only differences are the prefix (regexp: instead of glob:) and the anything or nothing pattern (.* instead of just *). The more complex example below tests that the Yahoo! Weather page for Anchorage, Alaska contains info on the sunrise time:
Command Target Value

Command open

Target http://weather.yahoo.com/forecast/USAK0012.html

Value

verifyTextPresent regexp:Sunrise: *[0-9]{1,2}:[0-9]{2} [ap]m

Lets examine the regular expression above one part at a time:

Sunrise: * The string Sunrise: followed by 0 or more spaces [0-9]{1,2} 1 or 2 digits (for the hour of the day) : [0-9]{2} [ap]m

The character : (no special characters involved) 2 digits (for the minutes) followed by a space a or p followed by m (am or pm)

Exact Patterns

The exact type of Selenium pattern is of marginal usefulness. It uses no special characters at all. So, if you needed to look for an actual asterisk character (which is special for both globbing and regular expression patterns), the exact pattern would be one way to do that. For example, if you wanted to select an item labeled Real * from a dropdown, the following code might work or it might not. The asterisk in the glob:Real * pattern will match anything or nothing. So, if there was an earlier select option labeled Real Numbers, it would be the option selected rather than the Real * option.
select //select glob:Real *

In order to ensure that the Real * item would be selected, the exact: prefix could be used to create an exact pattern as shown below:
select //select exact:Real *

But the same effect could be achieved via escaping the asterisk in a regular expression pattern:
select //select regexp:Real \*

Its rather unlikely that most testers will ever need to look for an asterisk or a set of square brackets with characters inside them (the character class for globbing patterns). Thus, globbing patterns and regular expression patterns are sufficient for the vast majority of us.

The AndWait Commands

The difference between a command and its AndWait alternative is that the regular command (e.g. click) will do the action and continue with the following command as fast as it can, while the AndWait alternative (e.g. clickAndWait) tells Selenium to wait for the page to load after the action has been done. The AndWait alternative is always used when the action causes the browser to navigate to another page or reload the present one. Be aware, if you use an AndWait command for an action that does not trigger a navigation/refresh, your test will fail. This happens because Selenium will reach the AndWaits timeout without seeing any navigation or refresh being made, causing Selenium to raise a timeout exception.

The waitFor Commands in AJAX applications

In AJAX driven web applications, data is retrieved from server without refreshing the page. Using andWait commands will not work as the page is not actually refreshed. Pausing the test execution for a certain period of time is also not a good approach as web element might appear later or earlier than the stipulated period depending on the systems responsiveness, load or other uncontrolled factors of the moment, leading to test failures. The best approach would be to wait for the needed element in a dynamic period and then continue the execution as soon as the element is found. This is done using waitFor commands, as waitForElementPresent or waitForVisible, which wait dynamically, checking for the desired condition every second and continuing to the next command in the script as soon as the condition is met.

Sequence of Evaluation and Flow Control

When a script runs, it simply runs in sequence, one command after another. Selenese, by itself, does not support condition statements (if-else, etc.) or iteration (for, while, etc.). Many useful tests can be conducted without flow control. However, for a functional test of dynamic content, possibly involving multiple pages, programming logic is often needed. When flow control is needed, there are three options:
1. Run the script using Selenium-RC and a client library such as Java or PHP to utilize the programming languages flow control features.

2. Run a small JavaScript snippet from within the script using the storeEval command. 3. Install the goto_sel_ide.js extension.

Most testers will export the test script into a programming language file that uses the SeleniumRC API (see the Selenium-IDE chapter). However, some organizations prefer to run their scripts from Selenium-IDE whenever possible (for instance, when they have many junior-level people running tests for them, or when programming skills are lacking). If this is your case, consider a JavaScript snippet or the goto_sel_ide.js extension.

Store Commands and Selenium Variables

You can use Selenium variables to store constants at the beginning of a script. Also, when combined with a data-driven test design (discussed in a later section), Selenium variables can be used to store values passed to your test program from the command-line, from another program, or from a file. The plain store command is the most basic of the many store commands and can be used to simply store a constant value in a selenium variable. It takes two parameters, the text value to be stored and a selenium variable. Use the standard variable naming conventions of only alphanumeric characters when choosing a name for your variable.
Command store Target Value

[email protected] userName

Later in your script, youll want to use the stored value of your variable. To access the value of a variable, enclose the variable in curly brackets ({}) and precede it with a dollar sign like this.
Command Target Value

verifyText //div/p ${userName}

A common use of variables is for storing input for an input field.

Command Target type Value

id=login ${userName}

Selenium variables can be used in either the first or second parameter and are interpreted by Selenium prior to any other operations performed by the command. A Selenium variable may also be used within a locator expression.

An equivalent store command exists for each verify and assert command. Here are a couple more commonly used store commands.

storeElementPresent
This corresponds to verifyElementPresent. It simply stores a boolean valuetrue or false depending on whether the UI element is found.

storeText
StoreText corresponds to verifyText. It uses a locater to identify specific page text. The text, if found, is stored in the variable. StoreText can be used to extract text from the page being tested.

storeEval
This command takes a script as its first parameter. Embedding JavaScript within Selenese is covered in the next section. StoreEval allows the test to store the result of running the script in a variable.

JavaScript and Selenese Parameters

JavaScript can be used with two types of Selenese parameters: script and non-script (usually expressions). In most cases, youll want to access and/or manipulate a test case variable inside the JavaScript snippet used as a Selenese parameter. All variables created in your test case are stored in a JavaScript associative array. An associative array has string indexes rather than sequential numeric indexes. The associative array containing your test cases variables is named storedVars. Whenever you wish to access or manipulate a variable within a JavaScript snippet, you must refer to it as storedVars[yourVariableName].

JavaScript Usage with Script Parameters

Several Selenese commands specify a script parameter including assertEval, verifyEval, storeEval, and waitForEval. These parameters require no special syntax. A Selenium-IDE user would simply place a snippet of JavaScript code into the appropriate field, normally the Target field (because a script parameter is normally the first or only parameter). The example below illustrates how a JavaScript snippet can be used to perform a simple numerical calculation:
Command store 10 Target Value hits blockquotes

storeXpathCount //blockquote

Command storeEval

Target

Value

storedVars*hits+-storedVars*blockquotes+ paragraphs

This next example illustrates how a JavaScript snippet can include calls to methods, in this case the JavaScript String objects toUpperCase method and toLowerCase method.
Command store Target Edith Wharton Value name

storeEval storedVars*name+.toUpperCase() uc storeEval storedVars*name+.toLowerCase() lc JavaScript Usage with Non-Script Parameters

JavaScript can also be used to help generate values for parameters, even when the parameter is not specified to be of type script. However, in this case, special syntax is requiredthe JavaScript snippet must be enclosed inside curly braces and preceded by the label javascript, as in javascript {*yourCodeHere*}. Below is an example in which the type commands second parameter value is generated via JavaScript code using this special syntax:
Command store type Target league of nations searchString q javascript,storedVars*searchString+.toUpperCase()Value

echo - The Selenese Print Command

Selenese has a simple command that allows you to print text to your tests output. This is useful for providing informational progress notes in your test which display on the console as your test is running. These notes also can be used to provide context within your test result reports, which can be useful for finding where a defect exists on a page in the event your test finds a problem. Finally, echo statements can be used to print the contents of Selenium variables.
Command Target Value

Command echo echo

Target Testing page footer now. Username is ${userName}

Value

Alerts, Popups, and Multiple Windows

Suppose that you are testing a page that looks like this.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 <!DOCTYPE HTML> <html> <head> <script type="text/javascript"> function output(resultText){ document.getElementById('output').childNodes[0].nodeValue=resultText; } function show_confirm(){ var confirmation=confirm("Chose an option."); if (confirmation==true){ output("Confirmed."); } else{ output("Rejected!"); } } function show_alert(){ alert("I'm blocking!"); output("Alert is gone."); } function show_prompt(){ var response = prompt("What's the best web QA tool?","Selenium"); output(response); } function open_window(windowName){ window.open("newWindow.html",windowName); } </script> </head> <body> <input type="button" id="btnConfirm" onclick="show_confirm()" value="Show confirm box" /> <input type="button" id="btnAlert" onclick="show_alert()" value="Show alert" /> <input type="button" id="btnPrompt" onclick="show_prompt()" value="Show prompt" /> <a href="newWindow.html" id="lnkNewWindow" target="_blank">New Window Link</a>

42 <input type="button" id="btnNewNamelessWindow" onclick="open_window()" 43 value="Open Nameless Window" /> 44 <input type="button" id="btnNewNamedWindow" onclick="open_window('Mike')" 45 value="Open Named Window" /> <br /> <span id="output"> </span> </body> </html>

The user must respond to alert/confirm boxes, as well as moving focus to newly opened popup windows. Fortunately, Selenium can cover JavaScript pop-ups. But before we begin covering alerts/confirms/prompts in individual detail, it is helpful to understand the commonality between them. Alerts, confirmation boxes and prompts all have variations of the following
Command assertFoo(pattern) assertFooPresent assertFooNotPresent storeFoo(variable) Description throws error if pattern doesnt match the text of the pop-up throws error if pop-up is not available throws error if any pop-up is present stores the text of the pop-up in a variable

storeFooPresent(variable) stores the text of the pop-up in a variable and returns true or false

When running under Selenium, JavaScript pop-ups will not appear. This is because the function calls are actually being overridden at runtime by Seleniums own JavaScript. However, just because you cannot see the pop-up doesnt mean you dont have to deal with it. To handle a popup, you must call its assertFoo(pattern) function. If you fail to assert the presence of a popup your next command will be blocked and you will get an error similar to the following
[error] Error: There was an unexpected Confirmation! [Chose an option.]

Alerts
Lets start with alerts because they are the simplest pop-up to handle. To begin, open the HTML sample above in a browser and click on the Show alert button. Youll notice that after you close the alert the text Alert is gone. is displayed on the page. Now run through the same steps with Selenium IDE recording, and verify the text is added after you close the alert. Your test will look something like this:

Command open click assertAlert /

Target

Value

btnAlert Im blocking!

verifyTextPresent Alert is gone.

You may be thinking Thats odd, I never tried to assert that alert. But this is Selenium-IDE handling and closing the alert for you. If you remove that step and replay the test you will get the following error [error] Error: There was an unexpected Alert! [I'm blocking!]. You must include an assertion of the alert to acknowledge its presence. If you just want to assert that an alert is present but either dont know or dont care what text it contains, you can use assertAlertPresent. This will return true or false, with false halting the test.
Confirmations

Confirmations behave in much the same way as alerts, with assertConfirmation and assertConfirmationPresent offering the same characteristics as their alert counterparts. However, by default Selenium will select OK when a confirmation pops up. Try recording clicking on the Show confirm box button in the sample page, but click on the Cancel button in the popup, then assert the output text. Your test may look something like this:
Command open click chooseCancelOnNextConfirmation assertConfirmation verifyTextPresent Choose an option. Rejected / btnConfirm Target Value

The chooseCancelOnNextConfirmation function tells Selenium that all following confirmation should return false. It can be reset by calling chooseOkOnNextConfirmation.

You may notice that you cannot replay this test, because Selenium complains that there is an unhandled confirmation. This is because the order of events Selenium-IDE records causes the click and chooseCancelOnNextConfirmation to be put in the wrong order (it makes sense if you think about it, Selenium cant know that youre cancelling before you open a confirmation) Simply switch these two commands and your test will run fine.

Debugging
Debugging means finding and fixing errors in your test case. This is a normal part of test case development. We wont teach debugging here as most new users to Selenium will already have some basic experience with debugging. If this is new to you, we recommend you ask one of the developers in your organization.

Breakpoints and Startpoints

The Sel-IDE supports the setting of breakpoints and the ability to start and stop the running of a test case, from any point within the test case. That is, one can run up to a specific command in the middle of the test case and inspect how the test case behaves at that point. To do this, set a breakpoint on the command just before the one to be examined. To set a breakpoint, select a command, right-click, and from the context menu select Toggle Breakpoint. Then click the Run button to run your test case from the beginning up to the breakpoint. It is also sometimes useful to run a test case from somewhere in the middle to the end of the test case or up to a breakpoint that follows the starting point. For example, suppose your test case first logs into the website and then performs a series of tests and you are trying to debug one of those tests. However, you only need to login once, but you need to keep rerunning your tests as you are developing them. You can login once, then run your test case from a startpoint placed after the login portion of your test case. That will prevent you from having to manually logout each time you rerun your test case. To set a startpoint, select a command, right-click, and from the context menu select Set/Clear Start Point. Then click the Run button to execute the test case beginning at that startpoint.

Stepping Through a Testcase

To execute a test case one command at a time (step through it), follow these steps:
1. Start the test case running with the Run button from the toolbar.

2. Immediately pause the executing test case with the Pause button.

3. Repeatedly select the Step button.

Find Button
The Find button is used to see which UI element on the currently displayed webpage (in the browser) is used in the currently selected Selenium command. This is useful when building a locator for a commands first parameter (see the section on locators in the Selenium Commands chapter). It can be used with any command that identifies a UI element on a webpage, i.e. click, clickAndWait, type, and certain assert and verify commands, among others. From Table view, select any command that has a locator parameter. Click the Find button. Now look on the webpage: There should be a bright green rectangle enclosing the element specified by the locator parameter.

Page Source for Debugging

Often, when debugging a test case, you simply must look at the page source (the HTML for the webpage youre trying to test) to determine a problem. Firefox makes this easy. Simply rightclick the webpage and select View->Page Source. The HTML opens in a separate window. Use its Search feature (Edit=>Find) to search for a keyword to find the HTML for the UI element youre trying to test. Alternatively, select just that portion of the webpage for which you want to see the source. Then right-click the webpage and select View Selection Source. In this case, the separate HTML window will contain just a small amount of source, with highlighting on the portion representing your selection.

Locator Assistance
Whenever Selenium-IDE records a locator-type argument, it stores additional information which allows the user to view other possible locator-type arguments that could be used instead. This feature can be very useful for learning more about locators, and is often needed to help one build a different type of locator than the type that was recorded. This locator assistance is presented on the Selenium-IDE window as a drop-down list accessible at the right end of the Target field (only when the Target field contains a recorded locator-type argument). Below is a snapshot showing the contents of this drop-down for one command. Note

that the first column of the drop-down provides alternative locators, whereas the second column indicates the type of each alternative.

Writing a Test Suite

A test suite is a collection of test cases which is displayed in the leftmost pane in the IDE. The test suite pane can be manually opened or closed via selecting a small dot halfway down the right edge of the pane (which is the left edge of the entire Selenium-IDE window if the pane is closed). The test suite pane will be automatically opened when an existing test suite is opened or when the user selects the New Test Case item from the File menu. In the latter case, the new test case will appear immediately below the previous test case. Selenium-IDE also supports loading pre-existing test cases by using the File -> Add Test Case menu option. This allows you to add existing test cases to a new test suite. A test suite file is an HTML file containing a one-column table. Each cell of each row in the <tbody> section contains a link to a test case. The example below is of a test suite containing four test cases:
<html> <head> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <title>Sample Selenium Test Suite</title> </head> <body> <table cellpadding="1" cellspacing="1" border="1"> <thead> <tr><td>Test Cases for De Anza A-Z Directory Links</td></tr> </thead> <tbody> <tr><td><a href="./a.html">A Links</a></td></tr> <tr><td><a href="./b.html">B Links</a></td></tr> <tr><td><a href="./c.html">C Links</a></td></tr> <tr><td><a href="./d.html">D Links</a></td></tr> </tbody> </table> </body> </html>

Note Test case files should not have to be co-located with the test suite file that invokes them. And on Mac OS and Linux systems, that is indeed the case. However, at the time of this writing, a bug

prevents Windows users from being able to place the test cases elsewhere than with the test suite that invokes them.

User Extensions
User extensions are JavaScript files that allow one to create his or her own customizations and features to add additional functionality. Often this is in the form of customized commands although this extensibility is not limited to additional commands. There are a number of useful extensions created by users. IMPORTANT: THIS SECTION IS OUT OF DATEWE WILL BE REVISING THIS SOON. Perhaps the most popular of all Selenium-IDE extensions is one which provides flow control in the form of while loops and primitive conditionals. This extension is the goto_sel_ide.js. For an example of how to use the functionality provided by this extension, look at the page created by its author. To install this extension, put the pathname to its location on your computer in the Selenium Core extensions field of Selenium-IDEs Options=>Options=>General tab.

After selecting the OK button, you must close and reopen Selenium-IDE in order for the extensions file to be read. Any change you make to an extension will also require you to close and reopen Selenium-IDE. Information on writing your own extensions can be found near the bottom of the Selenium Reference document.

Format
Format, under the Options menu, allows you to select a language for saving and displaying the test case. The default is HTML. If you will be using Selenium-RC to run your test cases, this feature is used to translate your test case into a programming language. Select the language, e.g. Java, PHP, you will be using with Selenium-RC for developing your test programs. Then simply save the test case using File=>Export Test Case As. Your test case will be translated into a series of functions in the language you choose. Essentially, program code supporting your test is generated for you by Selenium-IDE.

Also, note that if the generated code does not suit your needs, you can alter it by editing a configuration file which defines the generation process. Each supported language has configuration settings which are editable. This is under the Options=>Options=>Formats tab. Note At the time of this writing, this feature is not yet supported by the Selenium developers. However the author has altered the C# format in a limited manner and it has worked well.

Executing Selenium-IDE Tests on Different Browsers

While Selenium-IDE can only run tests against Firefox, tests developed with Selenium-IDE can be run against other browsers, using a simple command-line interface that invokes the SeleniumRC server. This topic is covered in the Run Selenese tests section on Selenium-RC chapter. The htmlSuite command-line option is the particular feature of interest.

Troubleshooting
Below is a list of image/explanation pairs which describe frequent sources of problems with Selenium-IDE: Table view is not available with this format. This message can be occasionally displayed in the Table tab when Selenium IDE is launched. The workaround is to close and reopen Selenium IDE. See issue 1008. for more information. If you are able to reproduce this reliably then please provide details so that we can work on a fix.

error loading test case: no command found Youve used File=>Open to try to open a test suite file. Use File=>Open Test Suite instead. An enhancement request has been raised to improve this error message. See issue 1010.

This type of error may indicate a timing problem, i.e., the element specified by a locator in your command wasnt fully loaded when the command was executed. Try putting a pause 5000 before the command to determine whether the problem is indeed related to timing. If so, investigate using an appropriate waitFor* or *AndWait command before the failing command.

Whenever your attempt to use variable substitution fails as is the case for the open command above, it indicates that you havent actually created the variable whose value youre trying to access. This is sometimes due to putting the variable in the Value field when it should be in the Target field or vice versa. In the example above, the two parameters for the store command have been erroneously placed in the reverse order of what is required. For any Selenese command, the first required parameter must go in the Target field, and the second required parameter (if one exists) must go in the Value field.

error loading test case: [Exception... Component returned failure code: 0x80520012 (NS_ERROR_FILE_NOT_FOUND) [nsIFileInputStream.init] nresult: 0x80520012 (NS_ERROR_FILE_NOT_FOUND) location: JS frame :: chrome://selenium-ide/content/fileutils.js :: anonymous :: line 48 data: no] One of the test cases in your test suite cannot be found. Make sure that the test case is indeed located where the test suite indicates it is located. Also, make sure that your actual test case files have the .html extension both in their filenames, and in the test suite file where they are referenced. An enhancement request has been raised to improve this error message. See issue 1011.

Your extension files contents have not been read by Selenium-IDE. Be sure you have specified the proper pathname to the extensions file via Options=>Options=>General in the Selenium Core extensions field. Also, Selenium-IDE must be restarted after any change to either an extensions file or to the contents of the Selenium Core extensions field.
Copyright 2008-2012, Selenium Project. Last updated on Jun 28, 2012.

Selenium Projects o Selenium IDE o Selenium Remote Control o Selenium WebDriver o Selenium Grid Documentation o Online version o Offline version (pdf)

o o

Wiki Selenium API

Support User Group Bug Tracker Commercial Support IRC About Selenium o News/Blogs o Events o Who made Selenium o Roadmap o Getting Involved OpenQA.org o Create an account o Account management o Sponsors
o o o o