SeleniumLibrary Reference/en

Aus expecco Wiki (Version 2.x)
(Weitergeleitet von SeleniumLibrary Reference)
Wechseln zu: Navigation, Suche

Back to Selenium Web Test Plugin.
Back to Online Documentation.

Inhaltsverzeichnis

Blocks for Selenium Commands

For every Selenium command, a corresponding block exists in the Selenium Library.

There is a distinction drawn between the following command prefixes:

  • Is - Commands beginning with "Is" return TRUE or FALSE. Example: "isTextPresent"
  • Get - commands beginning with "Get" return a STRING containing the requested value. Example: "getTitle"
  • Assertion - commands beginning with "Assert" compare against an expected value and report an error in the negative case. Unless handled as an exception, this leads into the abortion of the test with a failed status. Example: "assertElementHeight" or "assertTextPresent"
  • Verification - commands beginning with "Verify" compare against an expected value and create a log entry in the negative case. The test execution continues. Example: "verifyElementHeight"

For all Is/Get commands corresponding Assert/Verify commands are available.


Assertions

Assertions Not

Get

getAlert

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

getAllButtons

Returns the IDs of all buttons on the page.

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

getAllFields

Returns the IDs of all input fields on the page.

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

getAllLinks

Returns the IDs of all links on the page.

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

getAllWindowIds

Returns the IDs of all windows that the browser knows about.

getAllWindowNames

Returns the names of all windows that the browser knows about.

getAllWindowTitles

Returns the titles of all windows that the browser knows about.

getAttribute

Gets the value of an element attribute. The value of the attribute may differ across browsers (this is the case for the "style" attribute, for example).

Arguments:

  • attributeLocator
    an element locator followed by an @ sign and then the name of the attribute, e.g. "foo@bar"

Returns: the value of the specified attribute

getAttributeFromAllWindows

Returns every instance of some attribute from all known windows.

Arguments:

  • attributeName
    name of an attribute on the windows

getBodyText

Gets the entire text of the page.

Returns: the entire text of the page

getConfirmation

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

getCookie

Return all cookies of the current page under test.

getCookieByName

Returns the value of the cookie with the specified name, or throws an error if the cookie is not present.

Arguments:

  • name
    the name of the cookie

getCursorPosition

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 is not 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

Returns: the numerical position of the cursor in the field

getElementHeight

Retrieves the height of an element

Arguments:

  • locator
    an element locator pointing to an element

Returns: height of an element in pixels

getElementIndex

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

Returns: relative index of the element to its parent (starting from 0)

getElementPositionLeft

Retrieves the horizontal position of an element

Arguments:

  • locator
    an element locator pointing to an element OR an element itself

Returns: nr of pixels from the edge of the frame.

getElementPositionTop

Retrieves the vertical position of an element

Arguments:

  • locator
    an element locator pointing to an element OR an element itself

Returns: nr of pixels from the edge of the frame.

getElementWidth

Retrieves the width of an element

Arguments:

  • locator
    an element locator pointing to an element

Returns: width of an element in pixels

getEval

Gets the result of evaluating the specified JavaScript snippet. The snippet may have multiple lines, but only the result of the last line will be returned.

Note that, by default, the snippet will run in the context of the "selenium" object itself, so this will refer to the Selenium object. Use window to refer to the window of your application, e.g. window.document.getElementById('foo')

If you need to use a locator to refer to a single element in your application page, you can use this.browserbot.findElement("id=foo") where "id=foo" is your locator.

Arguments:

  • script
    the JavaScript snippet to run

Returns: the results of evaluating the snippet

getExpression

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

Returns: the value passed in

getHtmlSource

Returns the entire HTML source between the opening and closing "html" tags.

Returns: the entire HTML source

getLocation

Gets the absolute URL of the current page.

Returns: the absolute URL of the current page

getLogMessages

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 server-centric solution is to be able to support multiple frames served from different domains, which would break a centralized JavaScript logging mechanism under some conditions.

getMouseSpeed

Returns the number of pixels between "mousemove" events during dragAndDrop commands (default=10).

Returns: the number of pixels between "mousemove" events during dragAndDrop commands (default=10)

getPrompt

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

getSelectOptions

Gets all option labels in the specified select drop-down.

Arguments:

  • selectLocator
    an element locator identifying a drop-down menu

Returns: an array of all option labels in the specified select drop-down

getSelectedId

Gets option element ID for selected option in the specified select element.

Arguments:


selectLocator
an element locator identifying a drop-down menu

Returns: the selected option ID in the specified select drop-down

getSelectedIds

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

Returns: an array of all selected option IDs in the specified select drop-down

getSelectedIndex

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

Returns: the selected option index in the specified select drop-down

getSelectedIndexes

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

Returns: an array of all selected option indexes in the specified select drop-down

getSelectedLabel

Gets option label (visible text) for selected option in the specified select element.

Arguments:

  • selectLocator
    an element locator identifying a drop-down menu

Returns: the selected option label in the specified select drop-down

getSelectedLabels

Gets all option labels (visible text) for selected options in the specified select or multi-select element.

Arguments:

  • selectLocator
    an element locator identifying a drop-down menu

Returns: an array of all selected option labels in the specified select drop-down

getSelectedValue

Gets option value (value attribute) for selected option in the specified select element.

Arguments:

  • selectLocator
    an element locator identifying a drop-down menu

Returns: the selected option value in the specified select drop-down

getSelectedValues

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

Returns: an array of all selected option values in the specified select drop-down

getSpeed

Get execution speed (i.e., get the millisecond length of the delay following each selenium operation). By default, there is no such delay, i.e., the delay is 0 milliseconds.

See also setSpeed.

Returns: the execution speed in milliseconds.

getTable

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"

Returns: the text from the specified cell

getText

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

Returns: the text of the element

getTitle

Gets the title of the current page.

Returns: the title of the current page

getValue

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

Returns: the element value, or "on/off" for checkbox/radio elements

getWhetherThisFrameMatchFrameExpression

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)

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

getWhetherThisWindowMatchWindowExpression

Determine whether currentWindowString plus target identify the window containing this running code.

This is useful in proxy injection mode, where this code runs in every browser frame and window, and sometimes the selenium server needs to identify the "current" window. In this case, when the test calls selectWindow, this routine is called for each window to figure out which one has been selected. The selected window will return true, while all others will return false.

Arguments:

  • currentWindowString
    starting window
  • target
    new window (which might be relative to the current one, e.g. "_parent")

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

getXpathCount

Returns the number of nodes that match the specified XPath, e.g. "//table" would give the number of tables.

Arguments:

  • xpath
    the XPath expression to evaluate. do NOT wrap this expression in a 'count()' function; we will do that for you.

Returns: the number of nodes that match the specified XPath

Actions

addLocationStrategy

Defines a new function for Selenium to locate elements on the page. For example, if you define the strategy "foo", and someone runs click("foo=blah"), we will run your function, passing you the string "blah", and click on the element that your function returns, or throw an "Element not found" error if your function returns null.

We'll pass three arguments to your function:

  • locator: the string the user passed in
  • inWindow: the currently selected window
  • inDocument: the currently selected document

The function must return null if the element can not be found.

Arguments:

  • strategyName
    the name of the strategy to define; this should use only letters [a-zA-Z] with no spaces or other punctuation.
  • functionDefinition
    a string defining the body of a function in JavaScript.
    For example: return inDocument.getElementById(locator);

addSelection

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)

allowNativeXpath

Specifies whether Selenium should use the native in-browser implementation of XPath (if any native version is available); if you pass "false" to this function, we will always use our pure-JavaScript XPath library. Using the pure-JS XPath library can improve the consistency of XPath element locators between different browser vendors, but the pure-JS version is much slower than the native implementations.

Arguments:

  • allow
    boolean, true means we will prefer to use native XPath; false means we will only use JS XPath

altKeyDown

Press the alt key and hold it down until doAltUp() is called or a new page is loaded.

altKeyUp

Release the alt key.

answerOnNextPrompt

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

assignId

Temporarily sets the "id" attribute of the specified element, so you can locate it in the future using its ID rather than a slow/complicated XPath. This ID will disappear once the page is reloaded.

Arguments:

  • locator
    an element locator pointing to an element
  • identifier
    a string to be used as the ID of the specified element

attachFile

Sets a file input (upload) field to the file listed in fileLocator

Arguments:

  • fieldLocator
    an element locator
  • fileLocator
    a URL pointing to the specified file. Before the file can be set in the input field (fieldLocator), Selenium RC may need to transfer the file to the local machine before attaching the file in a web page form. This is common in selenium grid configurations where the RC server driving the browser is not the same machine that started the test.
    Supported Browsers: Firefox ("*chrome") only.

captureEntirePageScreenshot

Saves the entire contents of the current window canvas to a PNG file. Currently this only works in Mozilla and when running in chrome mode. Contrast this with the captureScreenshot command, which captures the contents of the OS viewport (i.e. whatever is currently being displayed on the monitor), and is implemented in the RC only. Implementation mostly borrowed from the Screengrab! Firefox extension. Please see http://www.screengrab.org for details.

Arguments:

  • filename
    the path to the file to persist the screenshot as. No filename extension will be appended by default. Directories will not be created if they do not exist, and an exception will be thrown, possibly by native code.

captureScreenshot

Captures a PNG screenshot to the specified file.

Arguments:

  • filename
    the absolute path to the file to be written, e.g. "c:\foo\screenshot.png"

check

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. Selenium will then resume using the default behavior for future confirmations, automatically returning true (OK) unless/until you explicitly call this command for each confirmation.

chooseOkOnNextConfirmation

Undo the effect of calling chooseCancelOnNextConfirmation. Note that Selenium's overridden window.confirm() function will normally automatically return true, as if the user had manually clicked OK, so you should not need to use this command unless for some reason you need to change your mind prior to the next confirmation. After any confirmation, Selenium will resume using the default behavior for future confirmations, automatically returning true (OK) unless/until you explicitly call chooseCancelOnNextConfirmation for each confirmation.

click

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

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
  • 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.

contextMenu

Simulates opening the context menu for the specified element (as might happen if the user "right-clicked" on the element).

Arguments:

  • locator
    an element locator

contextMenuAt

Simulates opening the context menu for the specified element (as might happen if the user "right-clicked" on the element).

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.

controlKeyDown

Press the control key and hold it down until doControlUp() is called or a new page is loaded.

controlKeyUp

Release the control key.

createCookie

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', 'max_age' and 'domain'. The optionsString's format is "path=/path/, max_age=60, domain=.foo.com". The order of options are irrelevant, the unit of the value of 'max_age' is second. Note that specifying a domain that is not a subset of the current domain will usually fail.

deleteAllVisibleCookies

Calls deleteCookie with recurse=true on all cookies visible to the current page. As noted on the documentation for deleteCookie, recurse=true can be much slower than simply deleting the cookies using a known domain/path.

deleteCookie

Delete a named cookie with specified path and domain. Be careful; to delete a cookie, you need to delete it using the exact same path and domain that were used to create the cookie. If the path is wrong, or the domain is wrong, the cookie simply will not be deleted. Also note that specifying a domain that is not a subset of the current domain will usually fail.

Since there's no way to discover at runtime the original path and domain of a given cookie, we have added an option called 'recurse' to try all sub-domains of the current domain with all paths that are a subset of the current path. Beware; this option can be slow. In big-O notation, it operates in O(n*m) time, where n is the number of dots in the domain name and m is the number of slashes in the path.

Arguments:

  • name
    the name of the cookie to be deleted
  • optionsString
    options for the cookie. Currently supported options include 'path', 'domain' and 'recurse.' The optionsString's format is "path=/path/, domain=.foo.com, recurse=true". The order of options are irrelevant. Note that specifying a domain that is not a subset of the current domain will usually fail.

doubleClick

Double clicks on a link, button, checkbox or radio button. If the double click action causes a new page to load (like a link usually does), call waitForPageToLoad.

Arguments:

  • locator
    an element locator

doubleClickAt

Doubleclicks on a link, button, checkbox or radio button. If the action causes a new page to load (like a link usually does), call waitForPageToLoad.

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.

dragAndDrop

Drags an element a certain distance and then drops it

Arguments:

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

dragAndDropToObject

Drags an element and drops it on another element

Arguments:

  • locatorOfObjectToBeDragged
    an element to be dragged
  • locatorOfDragDestinationObject
    an element whose location (i.e., whose center-most pixel) will be the point where locatorOfObjectToBeDragged is dropped

dragdrop

deprecated - use dragAndDrop instead

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

Explicitly simulate an event, to trigger the corresponding "onevent" handler.

Arguments:

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

focus

Move the focus to the specified element; for example, if the element is an input field, move the cursor to that field.

Arguments:

  • locator
    an element locator

goBack

Simulates the user clicking the "back" button on their browser.

highlight

Briefly changes the backgroundColor of the specified element yellow. Useful for debugging.

Arguments:

  • locator
    an element locator

ignoreAttributesWithoutValue

Specifies whether Selenium will ignore XPath attributes that have no value, i.e. are the empty string, when using the non-native XPath evaluation engine. You'd want to do this for performance reasons in IE. However, this could break certain XPaths, for example an XPath that looks for an attribute whose value is NOT the empty string.

The hope is that such XPaths are relatively rare, but the user should have the option of using them. Note that this only influences XPath evaluation when using the ajaxslt engine (i.e. not "javascript-xpath").

Arguments:

  • ignore
    boolean, true means we will ignore attributes without value at the expense of XPath "correctness"; false means we will sacrifice speed for correctness.

keyDown

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".

keyDownNative

Simulates a user pressing a key (without releasing it yet) by sending a native operating system keystroke. This function uses the java.awt.Robot class to send a keystroke; this more accurately simulates typing a key on the keyboard. It does not honor settings from the shiftKeyDown, controlKeyDown, altKeyDown and metaKeyDown commands, and does not target any particular HTML element. To send a keystroke to a particular element, focus on the element first before running this command.

Arguments:

  • keycode
    an integer keycode number corresponding to a java.awt.event.KeyEvent; note that Java keycodes are NOT the same thing as JavaScript keycodes!

keyPress

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".

keyPressNative

Simulates a user pressing and releasing a key by sending a native operating system keystroke. This function uses the java.awt.Robot class to send a keystroke; this more accurately simulates typing a key on the keyboard. It does not honor settings from the shiftKeyDown, controlKeyDown, altKeyDown and metaKeyDown commands, and does not target any particular HTML element. To send a keystroke to a particular element, focus on the element first before running this command.

Arguments:

  • keycode
    an integer keycode number corresponding to a java.awt.event.KeyEvent; note that Java keycodes are NOT the same thing as JavaScript keycodes!

keyUp

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".

keyUpNative

Simulates a user releasing a key by sending a native operating system keystroke. This function uses the java.awt.Robot class to send a keystroke; this more accurately simulates typing a key on the keyboard. It does not honor settings from the shiftKeyDown, controlKeyDown, altKeyDown and metaKeyDown commands, and does not target any particular HTML element. To send a keystroke to a particular element, focus on the element first before running this command.

Arguments:

  • keycode
    an integer keycode number corresponding to a java.awt.event.KeyEvent; note that Java keycodes are NOT the same thing as JavaScript keycodes!

metaKeyDown

Press the meta key and hold it down until doMetaUp() is called or a new page is loaded.

metaKeyUp

Release the meta key.

mouseDown

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

Arguments:

  • locator
    an element locator

mouseDownAt

Simulates a user pressing the mouse button (without releasing it yet) at the specified location.

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

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

Arguments:

  • locator
    an element locator

mouseMoveAt

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

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

Simulates a user moving the mouse pointer away from the specified element.

Arguments:

  • locator
    an element locator

mouseOver

Simulates a user hovering a mouse over the specified element.

Arguments:

  • locator
    an element locator

mouseUp

Simulates the event that occurs when the user releases the mouse button (i.e., stops holding the button down) on the specified element.

Arguments:

  • locator
    an element locator

mouseUpAt

Simulates the event that occurs when the user releases the mouse button (i.e., stops holding the button down) at the specified location.

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

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 a 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

openWindow

Opens a popup window (if a window with that ID is not already open). After opening the window, you'll need to select it using the selectWindow command.

This command can also be a useful workaround for bug SEL-339. In some cases, Selenium will be unable to intercept a call to window.open (if the call occurs during or before the "onLoad" event, for example). In those cases, you can force Selenium to notice the open window's name by using the Selenium openWindow command, using an empty (blank) URL, like this: openWindow("", "myFunnyWindow").

Arguments:

  • url
    the URL to open, which can be blank
  • windowID
    the JavaScript window ID of the window to select

refresh

Simulates the user clicking the "Refresh" button on their browser.

removeAllSelections

Unselects all of the selected options in a multi-select element.

Arguments:

  • locator
    an element locator identifying a multi-select box

removeSelection

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)

runScript

Creates a new "script" tag in the body of the current test window, and adds the specified text into the body of the command. Scripts run in this way can often be debugged more easily than scripts executed using Selenium's "getEval" command. Beware that JS exceptions thrown in these script tags are not managed by Selenium, so you should probably wrap your script in try/catch blocks if there is any chance that the script will throw an exception.

Arguments:

  • script
    the JavaScript snippet to run

select

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: a regular expression; for example "^[Oo]ther"

value=valuePattern: matches options based on their values.

value=id=id: matches options based on their ids.

index=index: matches an option based on its index (offset from zero).


If no option locator prefix is provided, the default behaviour is to match on label.


Arguments:

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

selectFrame

Selects a frame within the current window. (You may invoke this command multiple times to select nested frames.) To select the parent frame, use "relative=parent" as a locator; to select the top frame, use "relative=top". You can also select a frame by its 0-based index number; select the first frame with "index=0", or the third frame with "index=2".

You may also use a DOM expression to identify the frame you want directly, like this: dom=frames["main"].frames["subframe"]

Arguments:

  • locator
    an element locator identifying a frame or iframe

selectWindow

Selects a popup window using a window locator; once a popup window has been selected, all commands go to that window. To select the main window again, use null as the target.

Window locators provide different ways of specifying the window object: by title, by internal JavaScript "name," or by JavaScript variable.

title=My Special Window: Finds the window using the text that appears in the title bar. Be careful; two windows can share the same title. If that happens, this locator will just pick one.

name=myWindow: Finds the window using its internal JavaScript "name" property. This is the second parameter "windowName" passed to the JavaScript method window.open(url, windowName, windowFeatures, replaceFlag) (which Selenium intercepts).

var=variableName: Some pop-up windows are unnamed (anonymous), but are associated with a JavaScript variable name in the current application window, e.g. "window.foo = window.open(url);". In those cases, you can open the window using "var=foo".

If no window locator prefix is provided, we will try to guess what you mean like this: 1.) if windowID is null, (or the string "null") then it is assumed the user is referring to the original window instantiated by the browser). 2.) if the value of the "windowID" parameter is a JavaScript variable name in the current application window, then it is assumed that this variable contains the return value from a call to the JavaScript window.open() method. 3.) Otherwise, selenium looks in a hash it maintains that maps string names to window "names". 4.) If that fails, we will try looping over all of the known windows to try to find the appropriate "title". Since "title" is not necessarily unique, this may have unexpected behavior.

If you're having trouble figuring out the name of a window that you want to manipulate, look at the Selenium log messages which identify the names of windows created via window.open (and therefore intercepted by Selenium). You will see messages like the following for each window as it is opened:

debug: window.open call intercepted; window ID (which you can use with selectWindow()) is "myNewWindow"

In some cases, Selenium will be unable to intercept a call to window.open (if the call occurs during or before the "onLoad" event, for example). (This is bug SEL-339.) In those cases, you can force Selenium to notice the open window's name by using the Selenium openWindow command, using an empty (blank) URL, like this: openWindow("", "myFunnyWindow").

Arguments:

  • windowID
    the JavaScript window ID of the window to select

setBrowserLogLevel

Sets the threshold for browser-side logging messages; log messages beneath this threshold will be discarded. Valid logLevel strings are: "debug", "info", "warn", "error" or "off". To see the browser logs, you need to either show the log window in GUI mode, or enable browser-side logging in Selenium RC.

Arguments:

  • logLevel
    one of the following: "debug", "info", "warn", "error" or "off"

setContext

Writes a message to the status bar and adds a note to the browser-side log.

Arguments:

  • context
    the message to be sent to the browser

setCursorPosition

Moves the text cursor to the specified position in the given input element or textarea. This method will fail if the specified element is not 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.

setMouseSpeed

Configure the number of pixels between "mousemove" events during dragAndDrop commands (default=10). Setting this value to 0 means that we will send a "mousemove" event to every single pixel in between the start location and the end location; that can be very slow, and may cause some browsers to force the JavaScript to timeout.

If the mouse speed is greater than the distance between the two dragged objects, we will just send one "mousemove" at the start location and then one final one at the end location.

Arguments:

  • pixels
    the number of pixels between "mousemove" events

setSpeed

Set execution speed (i.e., set the millisecond length of a delay which will follow each selenium operation). By default, there is no such delay, i.e., the delay is 0 milliseconds.

Arguments:

  • value
    the number of milliseconds to pause after operation

setTimeout

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

shiftKeyDown

Press the shift key and hold it down until doShiftUp() is called or a new page is loaded.

shiftKeyUp

Release the shift key.

shutDownSeleniumServer

Kills the running Selenium Server and all browser sessions. After you run this command, you will no longer be able to send commands to the server; you can not remotely start the server once it has been stopped. Normally you should prefer to run the "stop" command, which terminates the current browser session, rather than shutting down the entire server.

submit

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

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

typeKeys

Simulates keystroke events on the specified element, as though you typed the value key-by-key.

This is a convenience method for calling keyDown, keyUp, keyPress for every character in the specified string; this is useful for dynamic UI widgets (like auto-completing combo boxes) that require explicit key events.

Unlike the simple "type" command, which forces the specified value into the page directly, this command may or may not have any visible effect, even in cases where typing keys would normally have a visible effect. For example, if you use "typeKeys" on a form element, you may or may not see the results of what you typed in the field. In some cases, you may need to use the simple "type" command to set the value of the field and then the "typeKeys" command to send the keystroke events corresponding to what you just typed.

Arguments:

  • locator
    an element locator
  • value
    the value to type

uncheck

Uncheck a toggle-button (checkbox/radio)

Arguments:

  • locator
    an element locator

waitForCondition

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

waitForFrameToLoad

Waits for a new frame to load.

Selenium constantly keeps track of new pages and frames loading, and sets a "newPageLoaded" flag when it first notices a page load.

See waitForPageToLoad for more information.

Arguments:

  • frameAddress
    FrameAddress from the server side
  • timeout
    a timeout in milliseconds, after which this command will return with an error

waitForPageToLoad

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

Waits for a popup window to appear and load up.

Arguments:

  • windowID
    the JavaScript window "name" of the window that will appear (not the text of the title bar)
  • timeout
    a timeout in milliseconds, after which the action will return with an error

windowFocus

Gives focus to the currently selected window

windowMaximize

Resize currently selected window to take up the entire screen

Actions AndWait

Is

isAlertPresent

Has an alert occurred?

This function never throws an exception

Returns: true if there is an alert

isChecked

Gets whether a toggle-button (checkbox/radio) is checked. Fails if the specified element does not exist or is not a toggle-button.

Arguments:

  • locator
    an element locator pointing to a checkbox or radio button

Returns: true if the checkbox is checked, false otherwise

isConfirmationPresent

Has confirm() been called?

This function never throws an exception

Returns: true if there is a pending confirmation

isCookiePresent

Returns true if a cookie with the specified name is present, or false otherwise.

Arguments:

  • name
    the name of the cookie

Returns: true if a cookie with the specified name is present, or false otherwise.

isEditable

Determines whether the specified input element is editable, i.e. has not been disabled. This method will fail if the specified element is not an input element.

Arguments:

  • locator
    an element locator

Returns: true if the input element is editable, false otherwise

isElementPresent

Verifies that the specified element is somewhere on the page.

Arguments:

  • locator
    an element locator

Returns: true if the element is present, false otherwise

isOrdered

Check if these two elements have same parent and are ordered siblings in the DOM. 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

Returns: true if element1 is the previous sibling of element2, false otherwise

isPromptPresent

Has a prompt occurred?

This function never throws an exception

Returns: true if there is a pending prompt

isSomethingSelected

Determines whether some option in a drop-down menu is selected.

Arguments:

  • selectLocator
    an element locator identifying a drop-down menu

Returns: true if some option has been selected, false otherwise

isTextPresent

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

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

isVisible

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

Returns: true if the specified element is visible, false otherwise

Storing

Verifications

Verifications Not

WaitingFor

WaitingFor Not

Sessions

Start Selenium Session

Start a Selenium Test Session.

There are two parameters: urlToTest and browserType, which are read from the environment.

The start-session block is automatically inserted when a webtest sequence is imported from the Selenium IDE.

Stop Selenium Session

Stop a Selenium Test Session.

The Browser is closed. This block is automatically inserted when a new webtest is imported from the Selenium IDE.

Core

Types

Implementations

All of the above blocks have been implemented as compound actions, which use more low-level implementation blocks to do the actual work. This makes it easier to add additional behavior, hooks, or tracing facilities later, if a need arises. In normal operation, there is no need to use or even to care about the existence of those implementation blocks.

Implementation[Is]::Assert

no documentation yet!

Implementation[Get]::Verify

no documentation yet!

Implementation[Is]::Verify

no documentation yet!

Implementation[]::Store

no documentation yet!

Implementation[Get]

no documentation yet!

Implementation[Is]

no documentation yet!

Implementation[Get]::WaitFor

no documentation yet!

Implementation[Is]::WaitForNot

no documentation yet!

Implementation[Action]

no documentation yet!

Implementation[Get]::Assert

no documentation yet!

Implementation[Get]::VerifyNot

no documentation yet!

Implementation[Is]::WaitFor

no documentation yet!

Implementation[Action]::AndWait

no documentation yet!

Implementation[Is]::AssertNot

no documentation yet!

Implementation[Is]::VerifyNot

no documentation yet!

Implementation[Get]::WaitForNot

no documentation yet!

Implementation[Get]::AssertNot

no documentation yet!

::assert or verify

no documentation yet!

SendSeleniumCommand

no documentation yet!

checkOK::Action

Check if a Selenium action block executed successfully. Raise an Expecco::SeleniumCommandError exception, if not.

checkOK::Get

Check if a Selenium get block executed successfully. Raise an Expecco::SeleniumCommandError exception, if not. Copy the result without the (success-)status code to the _responseOutPin on success.

checkOK::Is

Check if a Selenium is- block executed successfully and its condition is fulfilled. Send a true to the triggerYES output, if this is the case. Send a false to the triggerNO output, if this is not the case.

Sessions_Core

Start Selenium Session::Core

Create a new Selenium session and store it in the environment (of our callers caller).

Stop Selenium Session::Core

Stop the currently running selenium session

Parameters

Parameter::Setup

Setup the environment that is used to supply values for WebTest input fields.

Input field values may be supplied by:

   1. Directly connected pins. No environment is needed in this case
   2. Pins frozen to environment variables.
   3. Implicit fetch from a ParamSet.

If the dictionary input pin is connected, set the environment of our surrounding block from this dictionary. This is used, to supply values to a WebTest step using method 2.

Otherwise create a dictionary containing the whole environment of our surrounding block. This is used to supply values to a WebTest step using method 3.

Set the $ParamSet environment variable in our surrounding block to the dictionary.

TypeValueAdapter

Get a value for an input field. The value may be either connected directly, or fetched from the environment.

If the value input pin is connected, it will be copied to the _value output pin. Otherwise the _value output pin will be fetched from the dictionary in the $ParamSet environment variable. In this case the key into the dictionary will be either the accessKey input pin, or the locator input pin, if accessKey is not connected.

See also Parameter::Setup.


Back to Online Documentation.



Copyright © 2014-2016 eXept Software AG