Module selenium :: Class selenium
[hide private]
[frames] | no frames]

Class selenium
source code

Defines an object that runs Selenium commands.

Element Locators

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

locatorType=argument

We support the following strategies for locating elements:

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

Element Filters

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

Filters look much like locators, ie.

filterType=argument

Supported element-filters are:

value=valuePattern

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

index=index

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

String-match Patterns

Various Pattern syntaxes are available for matching string values:

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

For commands that return multiple values (such as verifySelectOptions), the string being matched is a comma-separated list of the return values, where both commas and backslashes in the values are backslash-escaped. When providing a pattern, the optional matching syntax (i.e. glob, regexp, etc.) is specified once, as usual, at the beginning of the pattern.



Instance Methods [hide private]
  __init__(self, host, port, browserStartCommand, browserURL)
  setExtensionJs(self, extensionJs)
  start(self)
  stop(self)
  do_command(self, verb, args)
  get_string(self, verb, args)
  get_string_array(self, verb, args)
  get_number(self, verb, args)
  get_number_array(self, verb, args)
  get_boolean(self, verb, args)
  get_boolean_array(self, verb, args)
  click(self, locator)
Clicks on a link, button, checkbox or radio button.
  double_click(self, locator)
Double clicks on a link, button, checkbox or radio button.
  context_menu(self, locator)
Simulates opening the context menu for the specified element (as might happen if the user "right-clicked" on the element).
  click_at(self, locator, coordString)
Clicks on a link, button, checkbox or radio button.
  double_click_at(self, locator, coordString)
Doubleclicks on a link, button, checkbox or radio button.
  context_menu_at(self, locator, coordString)
Simulates opening the context menu for the specified element (as might happen if the user "right-clicked" on the element).
  fire_event(self, locator, eventName)
Explicitly simulate an event, to trigger the corresponding "onevent" handler.
  focus(self, locator)
Move the focus to the specified element; for example, if the element is an input field, move the cursor to that field.
  key_press(self, locator, keySequence)
Simulates a user pressing and releasing a key.
  shift_key_down(self)
Press the shift key and hold it down until doShiftUp() is called or a new page is loaded.
  shift_key_up(self)
Release the shift key.
  meta_key_down(self)
Press the meta key and hold it down until doMetaUp() is called or a new page is loaded.
  meta_key_up(self)
Release the meta key.
  alt_key_down(self)
Press the alt key and hold it down until doAltUp() is called or a new page is loaded.
  alt_key_up(self)
Release the alt key.
  control_key_down(self)
Press the control key and hold it down until doControlUp() is called or a new page is loaded.
  control_key_up(self)
Release the control key.
  key_down(self, locator, keySequence)
Simulates a user pressing a key (without releasing it yet).
  key_up(self, locator, keySequence)
Simulates a user releasing a key.
  mouse_over(self, locator)
Simulates a user hovering a mouse over the specified element.
  mouse_out(self, locator)
Simulates a user moving the mouse pointer away from the specified element.
  mouse_down(self, locator)
Simulates a user pressing the left mouse button (without releasing it yet) on the specified element.
  mouse_down_right(self, locator)
Simulates a user pressing the right mouse button (without releasing it yet) on the specified element.
  mouse_down_at(self, locator, coordString)
Simulates a user pressing the left mouse button (without releasing it yet) at the specified location.
  mouse_down_right_at(self, locator, coordString)
Simulates a user pressing the right mouse button (without releasing it yet) at the specified location.
  mouse_up(self, locator)
Simulates the event that occurs when the user releases the mouse button (i.e., stops holding the button down) on the specified element.
  mouse_up_right(self, locator)
Simulates the event that occurs when the user releases the right mouse button (i.e., stops holding the button down) on the specified element.
  mouse_up_at(self, locator, coordString)
Simulates the event that occurs when the user releases the mouse button (i.e., stops holding the button down) at the specified location.
  mouse_up_right_at(self, locator, coordString)
Simulates the event that occurs when the user releases the right mouse button (i.e., stops holding the button down) at the specified location.
  mouse_move(self, locator)
Simulates a user pressing the mouse button (without releasing it yet) on the specified element.
  mouse_move_at(self, locator, coordString)
Simulates a user pressing the mouse button (without releasing it yet) on the specified element.
  type(self, locator, value)
Sets the value of an input field, as though you typed it in.
  type_keys(self, locator, value)
Simulates keystroke events on the specified element, as though you typed the value key-by-key.
  set_speed(self, value)
Set execution speed (i.e., set the millisecond length of a delay which will follow each selenium operation).
  get_speed(self)
Get execution speed (i.e., get the millisecond length of the delay following each selenium operation).
  check(self, locator)
Check a toggle-button (checkbox/radio)
  uncheck(self, locator)
Uncheck a toggle-button (checkbox/radio)
  select(self, selectLocator, optionLocator)
Select an option from a drop-down using an option locator.
  add_selection(self, locator, optionLocator)
Add a selection to the set of selected options in a multi-select element using an option locator.
  remove_selection(self, locator, optionLocator)
Remove a selection from the set of selected options in a multi-select element using an option locator.
  remove_all_selections(self, locator)
Unselects all of the selected options in a multi-select element.
  submit(self, formLocator)
Submit the specified form.
  open(self, url)
Opens an URL in the test frame.
  open_window(self, url, windowID)
Opens a popup window (if a window with that ID isn't already open).
  select_window(self, windowID)
Selects a popup window using a window locator; once a popup window has been selected, all commands go to that window.
  select_frame(self, locator)
Selects a frame within the current window.
  get_whether_this_frame_match_frame_expression(self, currentFrameString, target)
Determine whether current/locator identify the frame containing this running code.
  get_whether_this_window_match_window_expression(self, currentWindowString, target)
Determine whether currentWindowString plus target identify the window containing this running code.
  wait_for_pop_up(self, windowID, timeout)
Waits for a popup window to appear and load up.
  choose_cancel_on_next_confirmation(self)
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.
  choose_ok_on_next_confirmation(self)
Undo the effect of calling chooseCancelOnNextConfirmation.
  answer_on_next_prompt(self, answer)
Instructs Selenium to return the specified answer string in response to the next JavaScript prompt [window.prompt()].
  go_back(self)
Simulates the user clicking the "back" button on their browser.
  refresh(self)
Simulates the user clicking the "Refresh" button on their browser.
  close(self)
Simulates the user clicking the "close" button in the titlebar of a popup window or tab.
  is_alert_present(self)
Has an alert occurred?
  is_prompt_present(self)
Has a prompt occurred?
  is_confirmation_present(self)
Has confirm() been called?
  get_alert(self)
Retrieves the message of a JavaScript alert generated during the previous action, or fail if there were no alerts.
  get_confirmation(self)
Retrieves the message of a JavaScript confirmation dialog generated during the previous action.
  get_prompt(self)
Retrieves the message of a JavaScript question prompt dialog generated during the previous action.
  get_location(self)
Gets the absolute URL of the current page.
  get_title(self)
Gets the title of the current page.
  get_body_text(self)
Gets the entire text of the page.
  get_value(self, locator)
Gets the (whitespace-trimmed) value of an input field (or anything else with a value parameter).
  get_text(self, locator)
Gets the text of an element.
  highlight(self, locator)
Briefly changes the backgroundColor of the specified element yellow.
  get_eval(self, script)
Gets the result of evaluating the specified JavaScript snippet.
  is_checked(self, locator)
Gets whether a toggle-button (checkbox/radio) is checked.
  get_table(self, tableCellAddress)
Gets the text from a cell of a table.
  get_selected_labels(self, selectLocator)
Gets all option labels (visible text) for selected options in the specified select or multi-select element.
  get_selected_label(self, selectLocator)
Gets option label (visible text) for selected option in the specified select element.
  get_selected_values(self, selectLocator)
Gets all option values (value attributes) for selected options in the specified select or multi-select element.
  get_selected_value(self, selectLocator)
Gets option value (value attribute) for selected option in the specified select element.
  get_selected_indexes(self, selectLocator)
Gets all option indexes (option number, starting at 0) for selected options in the specified select or multi-select element.
  get_selected_index(self, selectLocator)
Gets option index (option number, starting at 0) for selected option in the specified select element.
  get_selected_ids(self, selectLocator)
Gets all option element IDs for selected options in the specified select or multi-select element.
  get_selected_id(self, selectLocator)
Gets option element ID for selected option in the specified select element.
  is_something_selected(self, selectLocator)
Determines whether some option in a drop-down menu is selected.
  get_select_options(self, selectLocator)
Gets all option labels in the specified select drop-down.
  get_attribute(self, attributeLocator)
Gets the value of an element attribute.
  is_text_present(self, pattern)
Verifies that the specified text pattern appears somewhere on the rendered page shown to the user.
  is_element_present(self, locator)
Verifies that the specified element is somewhere on the page.
  is_visible(self, locator)
Determines if the specified element is visible.
  is_editable(self, locator)
Determines whether the specified input element is editable, ie hasn't been disabled.
  get_all_buttons(self)
Returns the IDs of all buttons on the page.
  get_all_links(self)
Returns the IDs of all links on the page.
  get_all_fields(self)
Returns the IDs of all input fields on the page.
  get_attribute_from_all_windows(self, attributeName)
Returns every instance of some attribute from all known windows.
  dragdrop(self, locator, movementsString)
deprecated - use dragAndDrop instead
  set_mouse_speed(self, pixels)
Configure the number of pixels between "mousemove" events during dragAndDrop commands (default=10).
  get_mouse_speed(self)
Returns the number of pixels between "mousemove" events during dragAndDrop commands (default=10).
  drag_and_drop(self, locator, movementsString)
Drags an element a certain distance and then drops it
  drag_and_drop_to_object(self, locatorOfObjectToBeDragged, locatorOfDragDestinationObject)
Drags an element and drops it on another element
  window_focus(self)
Gives focus to the currently selected window
  window_maximize(self)
Resize currently selected window to take up the entire screen
  get_all_window_ids(self)
Returns the IDs of all windows that the browser knows about.
  get_all_window_names(self)
Returns the names of all windows that the browser knows about.
  get_all_window_titles(self)
Returns the titles of all windows that the browser knows about.
  get_html_source(self)
Returns the entire HTML source between the opening and closing "html" tags.
  set_cursor_position(self, locator, position)
Moves the text cursor to the specified position in the given input element or textarea.
  get_element_index(self, locator)
Get the relative index of an element to its parent (starting from 0).
  is_ordered(self, locator1, locator2)
Check if these two elements have same parent and are ordered siblings in the DOM.
  get_element_position_left(self, locator)
Retrieves the horizontal position of an element
  get_element_position_top(self, locator)
Retrieves the vertical position of an element
  get_element_width(self, locator)
Retrieves the width of an element
  get_element_height(self, locator)
Retrieves the height of an element
  get_cursor_position(self, locator)
Retrieves the text cursor position in the given input element or textarea; beware, this may not work perfectly on all browsers.
  get_expression(self, expression)
Returns the specified expression.
  get_xpath_count(self, xpath)
Returns the number of nodes that match the specified xpath, eg.
  assign_id(self, locator, identifier)
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.
  allow_native_xpath(self, allow)
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.
  ignore_attributes_without_value(self, ignore)
Specifies whether Selenium will ignore xpath attributes that have no value, i.e.
  wait_for_condition(self, script, timeout)
Runs the specified JavaScript snippet repeatedly until it evaluates to "true".
  set_timeout(self, timeout)
Specifies the amount of time that Selenium will wait for actions to complete.
  wait_for_page_to_load(self, timeout)
Waits for a new page to load.
  wait_for_frame_to_load(self, frameAddress, timeout)
Waits for a new frame to load.
  get_cookie(self)
Return all cookies of the current page under test.
  get_cookie_by_name(self, name)
Returns the value of the cookie with the specified name, or throws an error if the cookie is not present.
  is_cookie_present(self, name)
Returns true if a cookie with the specified name is present, or false otherwise.
  create_cookie(self, nameValuePair, optionsString)
Create a new cookie whose path and domain are same with those of current page under test, unless you specified a path for this cookie explicitly.
  delete_cookie(self, name, optionsString)
Delete a named cookie with specified path and domain.
  delete_all_visible_cookies(self)
Calls deleteCookie with recurse=true on all cookies visible to the current page.
  set_browser_log_level(self, logLevel)
Sets the threshold for browser-side logging messages; log messages beneath this threshold will be discarded.
  run_script(self, 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.
  add_location_strategy(self, strategyName, functionDefinition)
Defines a new function for Selenium to locate elements on the page.
  capture_entire_page_screenshot(self, filename, kwargs)
Saves the entire contents of the current window canvas to a PNG file.
  rollup(self, rollupName, kwargs)
Executes a command rollup, which is a series of commands with a unique name, and optionally arguments that control the generation of the set of commands.
  add_script(self, scriptContent, scriptTagId)
Loads script content into a new script tag in the Selenium document.
  remove_script(self, scriptTagId)
Removes a script tag from the Selenium document identified by the given id.
  use_xpath_library(self, libraryName)
Allows choice of one of the available libraries.
  set_context(self, context)
Writes a message to the status bar and adds a note to the browser-side log.
  attach_file(self, fieldLocator, fileLocator)
Sets a file input (upload) field to the file listed in fileLocator
  capture_screenshot(self, filename)
Captures a PNG screenshot to the specified file.
  capture_screenshot_to_string(self)
Capture a PNG screenshot.
  capture_entire_page_screenshot_to_string(self, kwargs)
Downloads a screenshot of the browser current window canvas to a based 64 encoded PNG file.
  shut_down_selenium_server(self)
Kills the running Selenium Server and all browser sessions.
  retrieve_last_remote_control_logs(self)
Retrieve the last messages logged on a specific remote control.
  key_down_native(self, keycode)
Simulates a user pressing a key (without releasing it yet) by sending a native operating system keystroke.
  key_up_native(self, keycode)
Simulates a user releasing a key by sending a native operating system keystroke.
  key_press_native(self, keycode)
Simulates a user pressing and releasing a key by sending a native operating system keystroke.

Method Details [hide private]

__init__(self, host, port, browserStartCommand, browserURL)
(Constructor)

source code 

setExtensionJs(self, extensionJs)

source code 

start(self)

source code 

stop(self)

source code 

do_command(self, verb, args)

source code 

get_string(self, verb, args)

source code 

get_string_array(self, verb, args)

source code 

get_number(self, verb, args)

source code 

get_number_array(self, verb, args)

source code 

get_boolean(self, verb, args)

source code 

get_boolean_array(self, verb, args)

source code 

click(self, locator)

source code 

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.

'locator' is an element locator

double_click(self, locator)

source code 

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.

'locator' is an element locator

context_menu(self, locator)

source code 

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

'locator' is an element locator

click_at(self, locator, coordString)

source code 

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.

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

double_click_at(self, locator, coordString)

source code 

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.

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

context_menu_at(self, locator, coordString)

source code 

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

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

fire_event(self, locator, eventName)

source code 

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

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

focus(self, locator)

source code 

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

'locator' is an element locator

key_press(self, locator, keySequence)

source code 

Simulates a user pressing and releasing a key.

'locator' is an element locator 'keySequence' 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", " 9".

shift_key_down(self)

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

shift_key_up(self)

source code 
Release the shift key.

meta_key_down(self)

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

meta_key_up(self)

source code 
Release the meta key.

alt_key_down(self)

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

alt_key_up(self)

source code 
Release the alt key.

control_key_down(self)

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

control_key_up(self)

source code 
Release the control key.

key_down(self, locator, keySequence)

source code 

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

'locator' is an element locator 'keySequence' 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", " 9".

key_up(self, locator, keySequence)

source code 

Simulates a user releasing a key.

'locator' is an element locator 'keySequence' 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", " 9".

mouse_over(self, locator)

source code 

Simulates a user hovering a mouse over the specified element.

'locator' is an element locator

mouse_out(self, locator)

source code 

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

'locator' is an element locator

mouse_down(self, locator)

source code 

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

'locator' is an element locator

mouse_down_right(self, locator)

source code 

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

'locator' is an element locator

mouse_down_at(self, locator, coordString)

source code 

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

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

mouse_down_right_at(self, locator, coordString)

source code 

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

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

mouse_up(self, locator)

source code 

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

'locator' is an element locator

mouse_up_right(self, locator)

source code 

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

'locator' is an element locator

mouse_up_at(self, locator, coordString)

source code 

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

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

mouse_up_right_at(self, locator, coordString)

source code 

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

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

mouse_move(self, locator)

source code 

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

'locator' is an element locator

mouse_move_at(self, locator, coordString)

source code 

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

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

type(self, locator, value)

source code 

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

type_keys(self, locator, value)

source code 

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.

'locator' is an element locator 'value' is the value to type

set_speed(self, value)

source code 

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

get_speed(self)

source code 

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.

check(self, locator)

source code 

Check a toggle-button (checkbox/radio)

'locator' is an element locator

uncheck(self, locator)

source code 

Uncheck a toggle-button (checkbox/radio)

'locator' is an element locator

select(self, selectLocator, optionLocator)

source code 

Select an option from a drop-down using an option locator.

Option locators provide different ways of specifying options of an HTML Select element (e.g. for selecting a specific option, or for asserting that the selected option satisfies a specification). There are several forms of Select Option Locator.

  • label=labelPattern: matches options based on their labels, i.e. the visible text. (This is the default.)

    • label=regexp:^[Oo]ther
  • value=valuePattern: matches options based on their values.

    • value=other
  • id=id:

    matches options based on their ids.

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

    • index=2

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

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

add_selection(self, locator, optionLocator)

source code 

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 'optionLocator' is an option locator (a label by default)

remove_selection(self, locator, optionLocator)

source code 

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 'optionLocator' is an option locator (a label by default)

remove_all_selections(self, locator)

source code 

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

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

submit(self, formLocator)

source code 

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

'formLocator' is an element locator for the form you want to submit

open(self, url)

source code 

Opens an URL in the test frame. This accepts both relative and absolute URLs.

The "open" command waits for the page to load before proceeding, ie. the "AndWait" suffix is implicit.

Note: The URL must be on the same domain as the runner HTML due to security restrictions in the browser (Same Origin Policy). If you need to open an URL on another domain, use the Selenium Server to start a new browser session on that domain.

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

open_window(self, url, windowID)

source code 

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

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

select_window(self, windowID)

source code 

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'll 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'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 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").

'windowID' is the JavaScript window ID of the window to select

select_frame(self, locator)

source code 

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

'locator' is an element locator identifying a frame or iframe

get_whether_this_frame_match_frame_expression(self, currentFrameString, target)

source code 

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.

'currentFrameString' is starting frame 'target' is new frame (which might be relative to the current one)

get_whether_this_window_match_window_expression(self, currentWindowString, target)

source code 

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.

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

wait_for_pop_up(self, windowID, timeout)

source code 

Waits for a popup window to appear and load up.

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

choose_cancel_on_next_confirmation(self)

source code 

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.

Take note - every time a confirmation comes up, you must consume it with a corresponding getConfirmation, or else the next selenium operation will fail.

choose_ok_on_next_confirmation(self)

source code 

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 shouldn't 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.

Take note - every time a confirmation comes up, you must consume it with a corresponding getConfirmation, or else the next selenium operation will fail.

answer_on_next_prompt(self, answer)

source code 

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

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

go_back(self)

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

refresh(self)

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

close(self)

source code 
Simulates the user clicking the "close" button in the titlebar of a popup window or tab.

is_alert_present(self)

source code 

Has an alert occurred?

This function never throws an exception

is_prompt_present(self)

source code 

Has a prompt occurred?

This function never throws an exception

is_confirmation_present(self)

source code 

Has confirm() been called?

This function never throws an exception

get_alert(self)

source code 

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 consume it with getAlert, the next Selenium action will fail.

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

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.

get_confirmation(self)

source code 

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 consume it with getConfirmation, 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.

get_prompt(self)

source code 

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.

get_location(self)

source code 
Gets the absolute URL of the current page.

get_title(self)

source code 
Gets the title of the current page.

get_body_text(self)

source code 
Gets the entire text of the page.

get_value(self, locator)

source code 

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.

'locator' is an element locator

get_text(self, locator)

source code 

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.

'locator' is an element locator

highlight(self, locator)

source code 

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

'locator' is an element locator

get_eval(self, script)

source code 

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.

'script' is the JavaScript snippet to run

is_checked(self, locator)

source code 

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

get_table(self, tableCellAddress)

source code 

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

'tableCellAddress' is a cell address, e.g. "foo.1.4"

get_selected_labels(self, selectLocator)

source code 

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

'selectLocator' is an element locator identifying a drop-down menu

get_selected_label(self, selectLocator)

source code 

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

'selectLocator' is an element locator identifying a drop-down menu

get_selected_values(self, selectLocator)

source code 

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

'selectLocator' is an element locator identifying a drop-down menu

get_selected_value(self, selectLocator)

source code 

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

'selectLocator' is an element locator identifying a drop-down menu

get_selected_indexes(self, selectLocator)

source code 

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

'selectLocator' is an element locator identifying a drop-down menu

get_selected_index(self, selectLocator)

source code 

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

'selectLocator' is an element locator identifying a drop-down menu

get_selected_ids(self, selectLocator)

source code 

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

'selectLocator' is an element locator identifying a drop-down menu

get_selected_id(self, selectLocator)

source code 

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

'selectLocator' is an element locator identifying a drop-down menu

is_something_selected(self, selectLocator)

source code 

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

'selectLocator' is an element locator identifying a drop-down menu

get_select_options(self, selectLocator)

source code 

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

'selectLocator' is an element locator identifying a drop-down menu

get_attribute(self, attributeLocator)

source code 

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

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

is_text_present(self, pattern)

source code 

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

is_element_present(self, locator)

source code 

Verifies that the specified element is somewhere on the page.

'locator' is an element locator

is_visible(self, locator)

source code 

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.

'locator' is an element locator

is_editable(self, locator)

source code 

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

get_all_buttons(self)

source code 

Returns the IDs of all buttons on the page.

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

get_all_links(self)

source code 

Returns the IDs of all links on the page.

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

get_all_fields(self)

source code 

Returns the IDs of all input fields on the page.

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

get_attribute_from_all_windows(self, attributeName)

source code 

Returns every instance of some attribute from all known windows.

'attributeName' is name of an attribute on the windows

dragdrop(self, locator, movementsString)

source code 

deprecated - use dragAndDrop instead

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

set_mouse_speed(self, pixels)

source code 

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 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'll just 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

get_mouse_speed(self)

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

drag_and_drop(self, locator, movementsString)

source code 

Drags an element a certain distance and then drops it

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

drag_and_drop_to_object(self, locatorOfObjectToBeDragged, locatorOfDragDestinationObject)

source code 

Drags an element and drops it on another element

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

window_focus(self)

source code 
Gives focus to the currently selected window

window_maximize(self)

source code 
Resize currently selected window to take up the entire screen

get_all_window_ids(self)

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

get_all_window_names(self)

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

get_all_window_titles(self)

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

get_html_source(self)

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

set_cursor_position(self, locator, position)

source code 

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.

get_element_index(self, locator)

source code 

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

'locator' is an element locator pointing to an element

is_ordered(self, locator1, locator2)

source code 

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

'locator1' is an element locator pointing to the first element 'locator2' is an element locator pointing to the second element

get_element_position_left(self, locator)

source code 

Retrieves the horizontal position of an element

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

get_element_position_top(self, locator)

source code 

Retrieves the vertical position of an element

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

get_element_width(self, locator)

source code 

Retrieves the width of an element

'locator' is an element locator pointing to an element

get_element_height(self, locator)

source code 

Retrieves the height of an element

'locator' is an element locator pointing to an element

get_cursor_position(self, locator)

source code 

Retrieves the text cursor position in the given input element or textarea; beware, this may not work perfectly on all browsers.

Specifically, if the cursor/selection has been cleared by JavaScript, this command will tend to return the position of the last location of the cursor, even though the cursor is now gone from the page. This is filed as SEL-243.

This method will fail if the specified element isn't an input element or textarea, or there is no cursor in the element.

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

get_expression(self, expression)

source code 

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

get_xpath_count(self, xpath)

source code 

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

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

assign_id(self, locator, identifier)

source code 

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.

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

allow_native_xpath(self, allow)

source code 

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.

'allow' is boolean, true means we'll prefer to use native XPath; false means we'll only use JS XPath

ignore_attributes_without_value(self, ignore)

source code 

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

'ignore' is boolean, true means we'll ignore attributes without value at the expense of xpath "correctness"; false means we'll sacrifice speed for correctness.

wait_for_condition(self, script, timeout)

source code 

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

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

set_timeout(self, timeout)

source code 

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

wait_for_page_to_load(self, timeout)

source code 

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.

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

wait_for_frame_to_load(self, frameAddress, timeout)

source code 

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.

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

get_cookie(self)

source code 
Return all cookies of the current page under test.

get_cookie_by_name(self, name)

source code 

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

'name' is the name of the cookie

is_cookie_present(self, name)

source code 

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

'name' is the name of the cookie

create_cookie(self, nameValuePair, optionsString)

source code 

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.

'nameValuePair' is name and value of the cookie in a format "name=value" 'optionsString' is 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 isn't a subset of the current domain will usually fail.

delete_cookie(self, name, optionsString)

source code 

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 won't be deleted. Also note 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 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.

'name' is the name of the cookie to be deleted 'optionsString' is 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 isn't a subset of the current domain will usually fail.

delete_all_visible_cookies(self)

source code 
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.

set_browser_log_level(self, logLevel)

source code 

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.

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

run_script(self, script)

source code 

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 aren't 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.

'script' is the JavaScript snippet to run

add_location_strategy(self, strategyName, functionDefinition)

source code 

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'll 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't be found.

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

capture_entire_page_screenshot(self, filename, kwargs)

source code 

Saves the entire contents of the current window canvas to a PNG file.
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. Currently this only
works in Firefox when running in chrome mode, and in IE non-HTA using
the EXPERIMENTAL "Snapsie" utility. The Firefox implementation is mostly
borrowed from the Screengrab! Firefox extension. Please see
http://www.screengrab.org and http://snapsie.sourceforge.net/ for
details.

'filename' is 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.
'kwargs' is a kwargs string that modifies the way the screenshot                  is captured. Example: "background=#CCFFDD" .                  Currently valid options:                  
*    background
    the background CSS for the HTML document. This                     may be useful to set for capturing screenshots of                     less-than-ideal layouts, for example where absolute                     positioning causes the calculation of the canvas                     dimension to fail and a black background is exposed                     (possibly obscuring black text).

rollup(self, rollupName, kwargs)

source code 

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

'rollupName' is the name of the rollup command 'kwargs' is keyword arguments string that influences how the rollup expands into commands

add_script(self, scriptContent, scriptTagId)

source code 

Loads script content into a new script tag in the Selenium document. This differs from the runScript command in that runScript adds the script tag to the document of the AUT, not the Selenium document. The following entities in the script content are replaced by the characters they represent:

< > &

The corresponding remove command is removeScript.

'scriptContent' is the Javascript content of the script to add 'scriptTagId' is (optional) the id of the new script tag. If specified, and an element with this id already exists, this operation will fail.

remove_script(self, scriptTagId)

source code 

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

'scriptTagId' is the id of the script element to remove.

use_xpath_library(self, libraryName)

source code 

Allows choice of one of the available libraries.

'libraryName' is name of the desired library Only the following three can be chosen: ajaxslt - Google's library javascript - Cybozu Labs' faster library default - The default library. Currently the default library is ajaxslt. If libraryName isn't one of these three, then no change will be made.

set_context(self, context)

source code 

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

'context' is the message to be sent to the browser

attach_file(self, fieldLocator, fileLocator)

source code 

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

'fieldLocator' is an element locator 'fileLocator' is 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.

capture_screenshot(self, filename)

source code 

Captures a PNG screenshot to the specified file.

'filename' is the absolute path to the file to be written, e.g. "c:lahscreenshot.png"

capture_screenshot_to_string(self)

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

capture_entire_page_screenshot_to_string(self, kwargs)

source code 

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.

'kwargs' is A kwargs string that modifies the way the screenshot is captured. Example: "background=#CCFFDD". This may be useful to set for capturing screenshots of less-than-ideal layouts, for example where absolute positioning causes the calculation of the canvas dimension to fail and a black background is exposed (possibly obscuring black text).

shut_down_selenium_server(self)

source code 
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't 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.

retrieve_last_remote_control_logs(self)

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

key_down_native(self, keycode)

source code 

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.

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

key_up_native(self, keycode)

source code 

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.

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

key_press_native(self, keycode)

source code 

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.

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