Luke Closs > Test-WWW-Selenium-1.13 > WWW::Selenium

Download:
Test-WWW-Selenium-1.13.tar.gz

Dependencies

Annotate this POD (5)

CPAN RT

New  3
Open  3
View/Report Bugs
Module Version: 0.911   Source   Latest Release: Test-WWW-Selenium-1.36

NAME ^

WWW::Selenium - Perl Client for the Selenium Remote Control test tool

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 ^

Selenium Remote Control (SRC) is a test tool that allows you to write automated web application UI tests in any programming language against any HTTP website using any mainstream JavaScript-enabled browser. SRC provides a Selenium Server, which can automatically start/stop/control any supported browser. It works by using Selenium Core, a pure-HTML+JS library that performs automated tasks in JavaScript; the Selenium Server communicates directly with the browser using AJAX (XmlHttpRequest).

http://www.openqa.org/selenium-rc/

This module sends commands directly to the Server using simple HTTP GET/POST requests. Using this module together with the Selenium Server, you can automatically control any supported browser.

To use this module, you need to have already downloaded and started the Selenium Server. (The Selenium Server is a Java application.)

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:

Without an explicit locator prefix, Selenium uses the following defaultstrategies:

Element Filters

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

Filters look much like locators, ie.

filterType=argument

Supported element-filters are:

value=valuePattern

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

index=index

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

String-match Patterns

Various Pattern syntaxes are available for matching string values:

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

METHODS

The following methods are available:

$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:

  • host

    host is the host name on which the Selenium Server resides.

  • port

    port is the port on which the Selenium Server is listening.

  • browser_url

    browser_url is the starting URL including just a domain name. We'll start the browser pointing at the Selenium resources on this URL, e.g. "http://www.google.com" would send the browser to "http://www.google.com/selenium-server/SeleneseRunner.html"

  • browser or browser_start_command

    This is the command string used to launch the browser, e.g. "*firefox", "*iexplore" or "/usr/bin/firefox"

    This option may be any one of the following:

    • *firefox [absolute path]

      Automatically launch a new Firefox process using a custom Firefox profile. This profile will be automatically configured to use the Selenium Server as a proxy and to have all annoying prompts ("save your password?" "forms are insecure" "make Firefox your default browser?" disabled. You may optionally specify an absolute path to your firefox executable, or just say "*firefox". If no absolute path is specified, we'll look for firefox.exe in a default location (normally c:\program files\mozilla firefox\firefox.exe), which you can override by setting the Java system property firefoxDefaultPath to the correct path to Firefox.

    • *iexplore [absolute path]

      Automatically launch a new Internet Explorer process using custom Windows registry settings. This process will be automatically configured to use the Selenium Server as a proxy and to have all annoying prompts ("save your password?" "forms are insecure" "make Firefox your default browser?" disabled. You may optionally specify an absolute path to your iexplore executable, or just say "*iexplore". If no absolute path is specified, we'll look for iexplore.exe in a default location (normally c:\program files\internet explorer\iexplore.exe), which you can override by setting the Java system property iexploreDefaultPath to the correct path to Internet Explorer.

    • /path/to/my/browser [other arguments]

      You may also simply specify the absolute path to your browser executable, or use a relative path to your executable (which we'll try to find on your path). Warning: If you specify your own custom browser, it's up to you to configure it correctly. At a minimum, you'll need to configure your browser to use the Selenium Server as a proxy, and disable all browser-specific prompting.

  • auto_stop

    Defaults to true, and will attempt to close the browser if the object goes out of scope and stop hasn't been called.

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

$locator is an element locator

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

$locator is an element locator

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

$locator is an element locator

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

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

$locator is an element locator

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

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

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

$locator is an element locator

$event_name is the event name, e.g. "focus" or "blur"

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

Simulates a user pressing and releasing a key.

$locator is an element locator

$key_sequence is 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".

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

$locator is an element locator

$key_sequence is 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".

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

Simulates a user releasing a key.

$locator is an element locator

$key_sequence is 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".

$sel->mouse_over($locator)

Simulates a user hovering a mouse over the specified element.

$locator is an element locator

$sel->mouse_out($locator)

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

$locator is an element locator

$sel->mouse_down($locator)

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

$locator is an element locator

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

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

$locator is an element locator

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

$sel->mouse_up($locator)

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

$locator is an element locator

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

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

$locator is an element locator

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

$sel->mouse_move($locator)

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

$locator is an element locator

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

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

$locator is an element locator

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

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

$locator is an element locator

$value is the value to type

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

$locator is an element locator

$value is the value to type

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

$value is the number of milliseconds to pause after operation

$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)

$locator is an element locator

$sel->uncheck($locator)

Uncheck a toggle-button (checkbox/radio)

$locator is an element locator

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

  • label=labelPattern:matches options based on their labels, i.e. the visible text. (Thisis 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.

$select_locator is an element locator identifying a drop-down menu

$option_locator is an option locator (a label by default)

$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

$locator is an element locator identifying a multi-select box

$option_locator is an option locator (a label by default)

$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

$locator is an element locator identifying a multi-select box

$option_locator is an option locator (a label by default)

$sel->remove_all_selections($locator)

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

$locator is an element locator identifying a multi-select box

$sel->submit($form_locator)

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

$form_locator is an element locator for the form you want to submit

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

$url is the URL to open; may be relative or absolute

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

$url is the URL to open, which can be blank

$window_id is the JavaScript window ID of the window to select

$sel->select_window($window_id)

Selects a popup window; once a popup window has been selected, allcommands go to that window. To select the main window again, use nullas the target. Note that there is a big difference between a window's internal JavaScript "name" propertyand the "title" of a given window's document (which is normally what you actually see, as an end user,in the title bar of the window). The "name" is normally invisible to the end-user; it's the second parameter "windowName" passed to the JavaScript method window.open(url, windowName, windowFeatures, replaceFlag)(which selenium intercepts).

Selenium has several strategies for finding the window object referred to by the "windowID" parameter.

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 assumedthat 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 <i>that</i> fails, we'll 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 what is the name of a window that you want to manipulate, look at the selenium log messageswhich identify the names of windows created via window.open (and therefore intercepted by selenium). You will see messageslike 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, usingan empty (blank) url, like this: openWindow("", "myFunnyWindow").

$window_id is the JavaScript window ID of the window to select

$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 may also use a DOM expression to identify the frame you want directly,like this: dom=frames["main"].frames["subframe"]

$locator is an element locator identifying a frame or iframe

$sel->get_log_messages()

Return the contents of the log. This is a placeholder intended to make the code generator make this APIavailable 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 supportmultiple frames served from different domains, which would break acentralized JavaScript logging mechanism under some conditions.

Returns all log messages seen since the last call to this API

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

$current_frame_string is starting frame

$target is new frame (which might be relative to the current one)

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

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

$current_window_string is starting window

$target is new window (which might be relative to the current one, e.g., "_parent")

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

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

Waits for a popup window to appear and load up.

$window_id is the JavaScript window ID of the window that will appear

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

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

$sel->answer_on_next_prompt($answer)

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

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

$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

Returns true if there is an alert

$sel->is_prompt_present()

Has a prompt occurred? This function never throws an exception

Returns true if there is a pending prompt

$sel->is_confirmation_present()

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

Returns true if there is a pending confirmation

$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 get/verify it, the next Selenium actionwill fail.

NOTE: under Selenium, JavaScript alerts will NOT pop up a visible alertdialog.

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

Returns The message of the most recent JavaScript alert

$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 generatedbut you do not get/verify it, 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.

Returns the message of the most recent JavaScript confirmation dialog

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

Returns the message of the most recent JavaScript question prompt

$sel->get_location()

Gets the absolute URL of the current page.

Returns the absolute URL of the current page

$sel->get_title()

Gets the title of the current page.

Returns the title of the current page

$sel->get_body_text()

Gets the entire text of the page.

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

$locator is an element locator

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

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

$locator is an element locator

Returns the text of the element

$sel->highlight($locator)

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

$locator is an element locator

$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, and window willrefer 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 referto this.browserbot.getCurrentWindow() and if you need to usea locator to refer to a single element in your application page, you canuse this.browserbot.findElement("foo") where "foo" is your locator.

$script is the JavaScript snippet to run

Returns the results of evaluating the snippet

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

$locator is an element locator pointing to a checkbox or radio button

Returns true if the checkbox is checked, false otherwise

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

$table_cell_address is a cell address, e.g. "foo.1.4"

Returns the text from the specified cell

$sel->get_selected_labels($select_locator)

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

$select_locator is an element locator identifying a drop-down menu

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

$sel->get_selected_label($select_locator)

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

$select_locator is an element locator identifying a drop-down menu

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

$sel->get_selected_values($select_locator)

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

$select_locator is an element locator identifying a drop-down menu

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

$sel->get_selected_value($select_locator)

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

$select_locator is an element locator identifying a drop-down menu

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

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

$select_locator is an element locator identifying a drop-down menu

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

$sel->get_selected_index($select_locator)

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

$select_locator is an element locator identifying a drop-down menu

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

$sel->get_selected_ids($select_locator)

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

$select_locator is an element locator identifying a drop-down menu

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

$sel->get_selected_id($select_locator)

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

$select_locator is an element locator identifying a drop-down menu

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

$sel->is_something_selected($select_locator)

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

$select_locator is an element locator identifying a drop-down menu

Returns true if some option has been selected, false otherwise

$sel->get_select_options($select_locator)

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

$select_locator is an element locator identifying a drop-down menu

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

$sel->get_attribute($attribute_locator)

Gets the value of an element attribute.

$attribute_locator is 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

$sel->is_text_present($pattern)

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

$pattern is a pattern to match with the text of the page

Returns true if the pattern matches the text, false otherwise

$sel->is_element_present($locator)

Verifies that the specified element is somewhere on the page.

$locator is an element locator

Returns true if the element is present, false otherwise

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

$locator is an element locator

Returns true if the specified element is visible, false otherwise

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

$locator is an element locator

Returns true if the input element is editable, false otherwise

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

Returns the IDs of all buttons on the page

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

Returns the IDs of all links on the page

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

Returns the IDs of all field on the page

$sel->get_attribute_from_all_windows($attribute_name)

Returns every instance of some attribute from all known windows.

$attribute_name is name of an attribute on the windows

Returns the set of values of this attribute from all known windows.

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

deprecated - use dragAndDrop instead

$locator is an element locator

$movements_string is offset in pixels from the current location to which the element should be moved, e.g., "+70,-300"

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

$pixels is the number of pixels between "mousemove" events

$sel->get_mouse_speed()

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)

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

Drags an element a certain distance and then drops it

$locator is an element locator

$movements_string is offset in pixels from the current location to which the element should be moved, e.g., "+70,-300"

$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

$locator_of_object_to_be_dragged is an element to be dragged

$locator_of_drag_destination_object is an element whose location (i.e., whose center-most pixel) will be the point where locatorOfObjectToBeDragged is dropped

$sel->window_focus($window_name)

Gives focus to a window

$window_name is name of the window to be given focus

$sel->window_maximize($window_name)

Resize window to take up the entire screen

$window_name is name of the window to be enlarged

$sel->get_all_window_ids()

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

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

$sel->get_all_window_names()

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

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

$sel->get_all_window_titles()

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

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

$sel->get_html_source()

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

Returns the entire HTML source

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

$locator is an element locator pointing to an input element or textarea

$position is 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.

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

$locator is an element locator pointing to an element

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

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

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

$locator1 is an element locator pointing to the first element

$locator2 is an element locator pointing to the second element

Returns true if two elements are ordered and have same parent, false otherwise

$sel->get_element_position_left($locator)

Retrieves the horizontal position of an element

$locator is an element locator pointing to an element OR an element itself

Returns of pixels from the edge of the frame.

$sel->get_element_position_top($locator)

Retrieves the vertical position of an element

$locator is an element locator pointing to an element OR an element itself

Returns of pixels from the edge of the frame.

$sel->get_element_width($locator)

Retrieves the width of an element

$locator is an element locator pointing to an element

Returns width of an element in pixels

$sel->get_element_height($locator)

Retrieves the height of an element

$locator is an element locator pointing to an element

Returns height of an element in pixels

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

$locator is an element locator pointing to an input element or textarea

Returns the numerical position of the cursor in the field

$sel->set_context($context, $log_level_threshold)

Writes a message to the status bar and adds a note to the browser-sidelog. If logLevelThreshold is specified, set the threshold for loggingto that level (debug, info, warn, error).

(Note that the browser-side logs will <i>not</i> be sent back to theserver, and are invisible to the Client Driver.)

$context is the message to be sent to the browser

$log_level_threshold is one of "debug", "info", "warn", "error", sets the threshold for browser-side logging

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

$expression is the value to return

Returns the value passed in

$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

$script is the JavaScript snippet to run

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

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

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

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

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

$sel->get_cookie()

Return all cookies of the current page under test.

Returns all cookies of the current page under test

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

$name_value_pair is name and value of the cookie in a format "name=value"

$options_string is 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.

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

Delete a named cookie with specified path.

$name is the name of the cookie to be deleted

$path is the path property of the cookie to be deleted

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

$expected_location is the location to match.

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

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

$locator is an element locator pointing to a checkbox or radio button.

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

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

$locator is an element locator. $option_locator is an option locator, typically just an option label (e.g. "John Smith").

Note: This function is deprecated, use the get_selected_*() methods instead.

* $sel->get_selected_options($locator)

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

$locator is an element locator.

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

* $sel->get_absolute_location()

Gets the absolute URL of the current page.

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

SEE ALSO ^

For more information about Selenium Remote Control, visit the website at http://www.openqa.org/selenium-rc/.

BUGS ^

The Selenium Remote Control JIRA issue tracking system is available online at http://jira.openqa.org/browse/SRC.

AUTHOR ^

Perl driver maintained by Luke Closs <selenium-rc@awesnob.com>

Selenium Remote Control maintained by Dan Fabulich <dfabulich@warpmail.net>

LICENSE ^

Copyright (c) 2006 ThoughtWorks, Inc

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

syntax highlighting: