NAME¶

VERSION¶

SYNOPSIS¶

    use WWW::Selenium;
    my $sel = WWW::Selenium->new( host => "localhost",
                                  port => 4444,
                                  browser => "*iexplore",
                                  browser_url => "http://www.google.com",
                                );
    $sel->start;
    $sel->open("http://www.google.com");
    $sel->type("q", "hello world");
    $sel->click("btnG");
    $sel->wait_for_page_to_load(5000);
    print $sel->get_title;
    $sel->stop;

DESCRIPTION¶

Element Locators¶

locatorType=argument

•

identifier=id: Select the element with the specified @id attribute. If no match isfound, 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.

•

dom=javascriptExpression: Find an element by evaluating the specified string. This allows you to traverse the HTML Document ObjectModel using JavaScript. Note that you must not return a value in this string; simply make it the last expression in the block.

•

xpath=xpathExpression: Locate an element using an XPath expression.

•

link=textPattern:Select the link (anchor) element which contains text matching thespecified pattern.

•

css=cssSelectorSyntax:Select the element using css selectors. Please refer to http://www.w3.org/TR/REC-CSS2/selector.html (CSS2 selectors), http://www.w3.org/TR/2001/CR-css3-selectors-20011113/ (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.

•

ui=uiSpecifierString:Locate an element by resolving the UI specifier string to another locator, and evaluating it. See the http://svn.openqa.org/fisheye/browse/~raw,r=trunk/selenium/trunk/src/main/resources/core/scripts/ui-doc.html (Selenium UI-Element Reference) for more details.

•

dom, for locators starting with "document."

•

xpath, for locators starting with "//"

•

identifier, otherwise

Element Filters¶

filterType=argument

value=valuePattern

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

index=index

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

String-match Patterns¶

•

glob:pattern:Match a string against a "glob" (aka "wildmat") pattern. "Glob" is akind of limited regular-expression syntax typically used in command-lineshells. In a glob pattern, "*" represents any sequence of characters, and "?"represents any single character. Glob patterns match against the entirestring.

•

regexp:regexp:Match a string using a regular-expression. The full power of JavaScriptregular-expressions is available.

•

regexpi:regexpi:Match a string using a case-insensitive regular-expression.

•

exact:string:Match a string exactly, verbatim, without any of that fancy wildcardstuff.

METHODS¶

$sel = WWW::Selenium->new( %args )

Constructs a new "WWW::Selenium" object, specifying a Selenium Server host/port, a command to launch the browser, and a starting URL for the browser.

 

Options:

$sel->pause($timeout)

Waits $timeout milliseconds (default: 1 second)

$sel->click($locator)

Clicks on a link, button, checkbox or radio button. If the click actioncauses a new page to load (like a link usually does), callwaitForPageToLoad.

$sel->double_click($locator)

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

$sel->context_menu($locator)

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

$sel->click_at($locator, $coord_string)

Clicks on a link, button, checkbox or radio button. If the click actioncauses a new page to load (like a link usually does), callwaitForPageToLoad.

$sel->double_click_at($locator, $coord_string)

Doubleclicks on a link, button, checkbox or radio button. If the actioncauses a new page to load (like a link usually does), callwaitForPageToLoad.

$sel->context_menu_at($locator, $coord_string)

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

$sel->fire_event($locator, $event_name)

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

$sel->focus($locator)

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

$sel->key_press($locator, $key_sequence)

Simulates a user pressing and releasing a key.

$sel->shift_key_down()

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

$sel->shift_key_up()

Release the shift key.

$sel->meta_key_down()

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

$sel->meta_key_up()

Release the meta key.

$sel->alt_key_down()

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

$sel->alt_key_up()

Release the alt key.

$sel->control_key_down()

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

$sel->control_key_up()

Release the control key.

$sel->key_down($locator, $key_sequence)

Simulates a user pressing a key (without releasing it yet).

$sel->key_up($locator, $key_sequence)

Simulates a user releasing a key.

$sel->mouse_over($locator)

Simulates a user hovering a mouse over the specified element.

$sel->mouse_out($locator)

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

$sel->mouse_down($locator)

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

$sel->mouse_down_right($locator)

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

$sel->mouse_down_at($locator, $coord_string)

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

$sel->mouse_down_right_at($locator, $coord_string)

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

$sel->mouse_up($locator)

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

$sel->mouse_up_right($locator)

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

$sel->mouse_up_at($locator, $coord_string)

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

$sel->mouse_up_right_at($locator, $coord_string)

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

$sel->mouse_move($locator)

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

$sel->mouse_move_at($locator, $coord_string)

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

$sel->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.

$sel->type_keys($locator, $value)

Simulates keystroke events on the specified element, as though you typed the value key-by-key. This is a convenience method for calling keyDown, keyUp, keyPress for every character in the specified string;this is useful for dynamic UI widgets (like auto-completing combo boxes) that require explicit key events.

 

Unlike the simple "type" command, which forces the specified value into the page directly, this commandmay 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 inthe 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 tosend the keystroke events corresponding to what you just typed.

$sel->set_speed($value)

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

$sel->get_speed()

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.

$sel->check($locator)

Check a toggle-button (checkbox/radio)

$sel->uncheck($locator)

Uncheck a toggle-button (checkbox/radio)

$sel->select($select_locator, $option_locator)

Select an option from a drop-down using an option locator. Option locators provide different ways of specifying options of an HTMLSelect element (e.g. for selecting a specific option, or for assertingthat the selected option satisfies a specification). There are severalforms of Select Option Locator.

$sel->add_selection($locator, $option_locator)

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

$sel->remove_selection($locator, $option_locator)

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

$sel->remove_all_selections($locator)

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

$sel->submit($form_locator)

Submit the specified form. This is particularly useful for forms withoutsubmit buttons, e.g. single-input "Search" forms.

$sel->open($url)

Opens an URL in the test frame. This accepts both relative and absoluteURLs.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 HTMLdue to security restrictions in the browser (Same Origin Policy). If youneed to open an URL on another domain, use the Selenium Server to start anew browser session on that domain.

$sel->open_window($url, $window_id)

Opens a popup window (if a window with that ID isn't already open).After opening the window, you'll need to select it using the selectWindowcommand. 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, usingan empty (blank) url, like this: openWindow("", "myFunnyWindow").

$sel->select_window($window_id)

Selects a popup window using a window locator; once a popup window has been selected, allcommands go to that window. To select the main window again, use nullas the target. Window locators provide different ways of specifying the window object:by title, by internal JavaScript "name," or by JavaScript variable.

$sel->select_pop_up($window_id)

Simplifies the process of selecting a popup window (and does not offerfunctionality beyond what "selectWindow()" already provides).

$sel->deselect_pop_up()

Selects the main window. Functionally equivalent to using"selectWindow()" and specifying no value for"windowID".

$sel->select_frame($locator)

Selects a frame within the current window. (You may invoke this commandmultiple 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"]"

$sel->get_whether_this_frame_match_frame_expression($current_frame_string, $target)

Determine whether current/locator identify the frame containing this running code. This is useful in proxy injection mode, where this code runs in everybrowser frame and window, and sometimes the selenium server needs to identifythe "current" frame. In this case, when the test calls selectFrame, thisroutine 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.

$sel->get_whether_this_window_match_window_expression($current_window_string, $target)

Determine whether currentWindowString plus target identify the window containing this running code. This is useful in proxy injection mode, where this code runs in everybrowser frame and window, and sometimes the selenium server needs to identifythe "current" window. In this case, when the test calls selectWindow, thisroutine 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.

$sel->wait_for_pop_up($window_id, $timeout)

Waits for a popup window to appear and load up.

$sel->choose_cancel_on_next_confirmation()

By default, Selenium's overridden window.confirm() function willreturn true, as if the user had manually clicked OK; after runningthis command, the next call to confirm() will return false, as ifthe user had clicked Cancel. Selenium will then resume using thedefault behavior for future confirmations, automatically returning true (OK) unless/until you explicitly call this command for eachconfirmation.

 

Take note - every time a confirmation comes up, you mustconsume it with a corresponding getConfirmation, or elsethe next selenium operation will fail.

$sel->choose_ok_on_next_confirmation()

Undo the effect of calling chooseCancelOnNextConfirmation. Notethat Selenium's overridden window. confirm() function will normally automaticallyreturn true, as if the user had manually clicked OK, so you shouldn'tneed to use this command unless for some reason you need to changeyour mind prior to the next confirmation. After any confirmation, Selenium will resume using thedefault behavior for future confirmations, automatically returning true (OK) unless/until you explicitly call chooseCancelOnNextConfirmation for eachconfirmation.

 

Take note - every time a confirmation comes up, you mustconsume it with a corresponding getConfirmation, or elsethe next selenium operation will fail.

$sel->answer_on_next_prompt($answer)

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

$sel->go_back()

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

$sel->refresh()

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

$sel->close()

Simulates the user clicking the "close" button in the titlebar of a popupwindow or tab.

$sel->is_alert_present()

Has an alert occurred? This function never throws an exception

$sel->is_prompt_present()

Has a prompt occurred? This function never throws an exception

$sel->is_confirmation_present()

Has confirm() been called? This function never throws an exception

$sel->get_alert()

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 analert is generated but you do not consume it with getAlert, the next Selenium actionwill fail.

 

Under Selenium, JavaScript alerts will NOT pop up a visible alertdialog.

 

Selenium does NOT support JavaScript alerts that are generated in apage's onload() event handler. In this case a visible dialog WILL begenerated and Selenium will hang until someone manually clicks OK.

$sel->get_confirmation()

Retrieves the message of a JavaScript confirmation dialog generated duringthe previous action. By default, the confirm function will return true, having the same effectas manually clicking OK. This can be changed by prior execution of thechooseCancelOnNextConfirmation command.

 

If an confirmation is generated but you do not consume it with getConfirmation,the next Selenium action will fail.

 

NOTE: under Selenium, JavaScript confirmations will NOT pop up a visibledialog.

 

NOTE: Selenium does NOT support JavaScript confirmations that aregenerated in a page's onload() event handler. In this case a visibledialog WILL be generated and Selenium will hang until you manually clickOK.

$sel->get_prompt()

Retrieves the message of a JavaScript question prompt dialog generated duringthe previous action. Successful handling of the prompt requires prior execution of theanswerOnNextPrompt command. If a prompt is generated but youdo not get/verify it, the next Selenium action will fail.

 

NOTE: under Selenium, JavaScript prompts will NOT pop up a visibledialog.

 

NOTE: Selenium does NOT support JavaScript prompts that are generated in apage's onload() event handler. In this case a visible dialog WILL begenerated and Selenium will hang until someone manually clicks OK.

$sel->get_location()

Gets the absolute URL of the current page.

$sel->get_title()

Gets the title of the current page.

$sel->get_body_text()

Gets the entire text of the page.

$sel->get_value($locator)

Gets the (whitespace-trimmed) value of an input field (or anything else with a value parameter).For checkbox/radio elements, the value will be "on" or "off" depending onwhether the element is checked or not.

$sel->get_text($locator)

Gets the text of an element. This works for any element that containstext. This command uses either the textContent (Mozilla-like browsers) orthe innerText (IE-like browsers) of the element, which is the renderedtext shown to the user.

$sel->highlight($locator)

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

$sel->get_eval($script)

Gets the result of evaluating the specified JavaScript snippet. The snippet mayhave 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" torefer to the window of your application, e.g. "window.document.getElementById('foo')"

 

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

$sel->is_checked($locator)

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

$sel->get_table($table_cell_address)

Gets the text from a cell of a table. The cellAddress syntaxtableLocator.row.column, where row and column start at 0.

$sel->get_selected_labels($select_locator)

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

$sel->get_selected_label($select_locator)

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

$sel->get_selected_values($select_locator)

Gets all option values (value attributes) for selected options in the specified select or multi-select element.

$sel->get_selected_value($select_locator)

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

$sel->get_selected_indexes($select_locator)

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

$sel->get_selected_index($select_locator)

Gets option index (option number, starting at 0) for selected option in the specified select element.

$sel->get_selected_ids($select_locator)

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

$sel->get_selected_id($select_locator)

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

$sel->is_something_selected($select_locator)

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

$sel->get_select_options($select_locator)

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

$sel->get_attribute($attribute_locator)

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

$sel->is_text_present($pattern)

Verifies that the specified text pattern appears somewhere on the rendered page shown to the user.

$sel->is_element_present($locator)

Verifies that the specified element is somewhere on the page.

$sel->is_visible($locator)

Determines if the specified element is visible. Anelement can be rendered invisible by setting the CSS "visibility"property to "hidden", or the "display" property to "none", either for theelement itself or one if its ancestors. This method will fail ifthe element is not present.

$sel->is_editable($locator)

Determines whether the specified input element is editable, ie hasn't been disabled.This method will fail if the specified element isn't an input element.

$sel->get_all_buttons()

Returns the IDs of all buttons on the page. If a given button has no ID, it will appear as "" in this array.

$sel->get_all_links()

Returns the IDs of all links on the page. If a given link has no ID, it will appear as "" in this array.

$sel->get_all_fields()

Returns the IDs of all input fields on the page. If a given field has no ID, it will appear as "" in this array.

$sel->get_attribute_from_all_windows($attribute_name)

Returns an array of JavaScript property values from all known windows having one.

$sel->dragdrop($locator, $movements_string)

deprecated - use dragAndDrop instead

$sel->set_mouse_speed($pixels)

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

 

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

$sel->get_mouse_speed()

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

$sel->drag_and_drop($locator, $movements_string)

Drags an element a certain distance and then drops it

$sel->drag_and_drop_to_object($locator_of_object_to_be_dragged, $locator_of_drag_destination_object)

Drags an element and drops it on another element

$sel->window_focus()

Gives focus to the currently selected window

$sel->window_maximize()

Resize currently selected window to take up the entire screen

$sel->get_all_window_ids()

Returns the IDs of all windows that the browser knows about in an array.

$sel->get_all_window_names()

Returns the names of all windows that the browser knows about in an array.

$sel->get_all_window_titles()

Returns the titles of all windows that the browser knows about in an array.

$sel->get_html_source()

Returns the entire HTML source between the opening andclosing "html" tags.

$sel->set_cursor_position($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.

$sel->get_element_index($locator)

Get the relative index of an element to its parent (starting from 0). The comment node and empty text nodewill be ignored.

$sel->is_ordered($locator1, $locator2)

Check if these two elements have same parent and are ordered siblings in the DOM. Two same elements willnot be considered ordered.

$sel->get_element_position_left($locator)

Retrieves the horizontal position of an element

$sel->get_element_position_top($locator)

Retrieves the vertical position of an element

$sel->get_element_width($locator)

Retrieves the width of an element

$sel->get_element_height($locator)

Retrieves the height of an element

$sel->get_cursor_position($locator)

Retrieves the text cursor position in the given input element or textarea; beware, this may not work perfectly on all browsers. Specifically, if the cursor/selection has been cleared by JavaScript, this command will tend toreturn the position of the last location of the cursor, even though the cursor is now gone from the page. This is filed as http://jira.openqa.org/browse/SEL-243 (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.

$sel->get_expression($expression)

Returns the specified expression. This is useful because of JavaScript preprocessing.It is used to generate commands like assertExpression and waitForExpression.

$sel->get_xpath_count($xpath)

Returns the number of nodes that match the specified xpath, eg. "//table" would givethe number of tables.

$sel->assign_id($locator, $identifier)

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

$sel->allow_native_xpath($allow)

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

$sel->ignore_attributes_without_value($ignore)

Specifies whether Selenium will ignore xpath attributes that have novalue, i.e. are the empty string, when using the non-native xpathevaluation engine. You'd want to do this for performance reasons in IE.However, this could break certain xpaths, for example an xpath that looksfor an attribute whose value is NOT the empty string.The hope is that such xpaths are relatively rare, but the user shouldhave the option of using them. Note that this only influences xpathevaluation when using the ajaxslt engine (i.e. not "javascript-xpath").

$sel->wait_for_condition($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 linewill be considered. Note that, by default, the snippet will be run in the runner's test window, not in the windowof your application. To get the window of your application, you can usethe JavaScript snippet "selenium.browserbot.getCurrentWindow()", and thenrun your JavaScript in there

$sel->set_timeout($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.

$sel->wait_for_page_to_load($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 afterturns the flag to false. Hence, if you want to wait for a page to load, you mustwait immediately after a Selenium command that caused a page-load.

$sel->wait_for_frame_to_load($frame_address, $timeout)

Waits for a new frame to load. Selenium constantly keeps track of new pages and frames loading, and sets a "newPageLoaded" flag when it first notices a page load. See waitForPageToLoad for more information.

$sel->get_cookie()

Return all cookies of the current page under test.

$sel->get_cookie_by_name($name)

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

$sel->is_cookie_present($name)

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

$sel->create_cookie($name_value_pair, $options_string)

Create a new cookie whose path and domain are same with those of current pageunder test, unless you specified a path for this cookie explicitly.

$sel->delete_cookie($name, $options_string)

Delete a named cookie with specified path and domain. Be careful; to delete a cookie, youneed to delete it using the exact same path and domain that were used to create the cookie.If the path is wrong, or the domain is wrong, the cookie simply won't be deleted. Alsonote that specifying a domain that isn't a subset of the current domain will usually fail.Since there's no way to discover at runtime the original path and domain of a given cookie,we've added an option called 'recurse' to try all sub-domains of the current domain withall paths that are a subset of the current path. Beware; this option can be slow. Inbig-O notation, it operates in O(n*m) time, where n is the number of dots in the domainname and m is the number of slashes in the path.

$sel->delete_all_visible_cookies()

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 slowerthan simply deleting the cookies using a known domain/path.

$sel->set_browser_log_level($log_level)

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 toeither show the log window in GUI mode, or enable browser-side logging in Selenium RC.

$sel->run_script($script)

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 inthis way can often be debugged more easily than scripts executed usingSelenium's "getEval" command. Beware that JS exceptions thrown in these scripttags aren't managed by Selenium, so you should probably wrap your scriptin try/catch blocks if there is any chance that the script will throwan exception.

$sel->add_location_strategy($strategy_name)

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'llrun your function, passing you the string "blah", and click on the element that your functionreturns, or throw an "Element not found" error if your function returns null.We'll pass three arguments to your function:

$sel->capture_entire_page_screenshot($filename, $kwargs)

Saves the entire contents of the current window canvas to a PNG file.Contrast this with the captureScreenshot command, which captures thecontents of the OS viewport (i.e. whatever is currently being displayedon the monitor), and is implemented in the RC only. Currently this onlyworks in Firefox when running in chrome mode, and in IE non-HTA usingthe EXPERIMENTAL "Snapsie" utility. The Firefox implementation is mostlyborrowed from the Screengrab! Firefox extension. Please seehttp://www.screengrab.org and http://snapsie.sourceforge.net/ fordetails.

$sel->rollup($rollup_name, $kwargs)

Executes a command rollup, which is a series of commands with a uniquename, and optionally arguments that control the generation of the set ofcommands. If any one of the rolled-up commands fails, the rollup isconsidered to have failed. Rollups may also contain nested rollups.

$sel->add_script($script_content, $script_tag_id)

Loads script content into a new script tag in the Selenium document. Thisdiffers from the runScript command in that runScript adds the script tagto the document of the AUT, not the Selenium document. The followingentities in the script content are replaced by the characters they represent: < > &The corresponding remove command is removeScript.

$sel->remove_script($script_tag_id)

Removes a script tag from the Selenium document identified by the givenid. Does nothing if the referenced tag doesn't exist.

$sel->use_xpath_library($library_name)

Allows choice of one of the available libraries.

 If libraryName isn't one of these three, then  no change will be made.

$sel->set_context($context)

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

$sel->attach_file($field_locator, $file_locator)

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

$sel->capture_screenshot($filename)

Captures a PNG screenshot to the specified file.

$sel->capture_screenshot_to_string()

Capture a PNG screenshot. It then returns the file as a base 64 encoded string.

$sel->capture_entire_page_screenshot_to_string($kwargs)

Downloads a screenshot of the browser current window canvas to a based 64 encoded PNG file. The entire windows canvas is captured,including parts rendered outside of the current view port.Currently this only works in Mozilla and when running in chrome mode.

$sel->shut_down_selenium_server()

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

$sel->retrieve_last_remote_control_logs()

Retrieve the last messages logged on a specific remote control. Useful for error reports, especiallywhen running multiple remote controls in a distributed environment. The maximum number of log messagesthat can be retrieve is configured on remote control startup.

$sel->key_down_native($keycode)

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 typinga key on the keyboard. It does not honor settings from the shiftKeyDown, controlKeyDown, altKeyDown andmetaKeyDown commands, and does not target any particular HTML element. To send a keystroke to a particularelement, focus on the element first before running this command.

$sel->key_up_native($keycode)

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 typinga key on the keyboard. It does not honor settings from the shiftKeyDown, controlKeyDown, altKeyDown andmetaKeyDown commands, and does not target any particular HTML element. To send a keystroke to a particularelement, focus on the element first before running this command.

$sel->key_press_native($keycode)

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 typinga key on the keyboard. It does not honor settings from the shiftKeyDown, controlKeyDown, altKeyDown andmetaKeyDown commands, and does not target any particular HTML element. To send a keystroke to a particularelement, focus on the element first before running this command.

$sel->wait_for_text_present($text, $timeout)

Waits until $text is present in the html source

$sel->wait_for_element_present($locator, $timeout)

Waits until $locator is present

$sel->is_location($expected_location)

Verify the location of the current page ends with the expected location. If an URL querystring is provided, this is checked as well.

$sel->get_checked($locator)

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

$sel->is_selected($locator, $option_locator)

Verifies that the selected option of a drop-down satisfies the optionSpecifier.

 

See the select command for more information about option locators.

$sel->get_selected_options($locator)

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

$sel->get_absolute_location()

Gets the absolute URL of the current page.

 

Note: This function is deprecated, use get_location() instead.

NAME¶

SEE ALSO¶

BUGS¶

AUTHORS¶

•

Maintained by: Matt Phillips <mattp@cpan.org>, Luke Closs <lukec@cpan.org>

•

Originally by Mattia Barbon <mbarbon@cpan.org>

COPYRIGHT AND LICENSE¶

  The Apache License, Version 2.0, January 2004