The selenium Reference Manual

3.1.1 selenium/selenium.asd

Source

selenium.asd.

Parent Component

selenium (system).

ASDF Systems

selenium.

Packages

selenium-system.

---

3.1.2 selenium/packages.lisp

Source

selenium.asd.

Parent Component

selenium (system).

Packages

selenium.

---

3.1.3 selenium/iedoc.lisp

Dependency

packages.lisp (file).

Source

selenium.asd.

Parent Component

selenium (system).

Public Interface

• *selenium-driver-url* (special variable).
• *selenium-session* (special variable).
• base-error (condition).
• execution-error (condition).
• http-error (condition).
• print-object (method).
• print-object (method).

Internals

• convert-function (function).
• convert-function-name (function).
• convert-parameter-name (function).
• convert-parameters (function).
• convert-result (function).
• convert-string-array (function).
• description (reader method).
• execute (function).
• iedoc-function (class).
• iedoc-function-comment (reader method).
• (setf iedoc-function-comment) (writer method).
• iedoc-function-name (reader method).
• (setf iedoc-function-name) (writer method).
• iedoc-function-parameters (reader method).
• (setf iedoc-function-parameters) (writer method).
• iedoc-parameter (class).
• iedoc-parameter-comment (reader method).
• (setf iedoc-parameter-comment) (writer method).
• iedoc-parameter-name (reader method).
• (setf iedoc-parameter-name) (writer method).
• iedoc-return-type (reader method).
• (setf iedoc-return-type) (writer method).
• make-iedoc-comment (function).
• make-iedoc-functions (function).
• make-iedoc-parameter (function).
• make-iedoc-return-type (function).
• marshall-request (function).
• normalize-comment (function).
• parse-iedoc (function).
• reason (reader method).
• starts-with (function).
• status-code (reader method).

---

3.1.4 selenium/selenium.lisp

Dependency

iedoc.lisp (file).

Source

selenium.asd.

Parent Component

selenium (system).

Public Interface

• do-add-location-strategy (function).
• do-add-selection (function).
• do-allow-native-xpath (function).
• do-alt-key-down (function).
• do-alt-key-up (function).
• do-answer-on-next-prompt (function).
• do-assign-id (function).
• do-capture-screenshot (function).
• do-check (function).
• do-choose-cancel-on-next-confirmation (function).
• do-choose-ok-on-next-confirmation (function).
• do-click (function).
• do-click-and-wait (function).
• do-click-at (function).
• do-close (function).
• do-control-key-down (function).
• do-control-key-up (function).
• do-create-cookie (function).
• do-delete-cookie (function).
• do-double-click (function).
• do-double-click-at (function).
• do-drag-and-drop (function).
• do-drag-and-drop-to-object (function).
• do-dragdrop (function).
• do-fire-event (function).
• do-get-alert (function).
• do-get-all-buttons (function).
• do-get-all-fields (function).
• do-get-all-links (function).
• do-get-all-window-ids (function).
• do-get-all-window-names (function).
• do-get-all-window-titles (function).
• do-get-attribute (function).
• do-get-attribute-from-all-windows (function).
• do-get-body-text (function).
• do-get-confirmation (function).
• do-get-cookie (function).
• do-get-cursor-position (function).
• do-get-element-height (function).
• do-get-element-index (function).
• do-get-element-position-left (function).
• do-get-element-position-top (function).
• do-get-element-width (function).
• do-get-eval (function).
• do-get-expression (function).
• do-get-html-source (function).
• do-get-location (function).
• do-get-mouse-speed (function).
• do-get-new-browser-session (function).
• do-get-prompt (function).
• do-get-select-options (function).
• do-get-selected-id (function).
• do-get-selected-ids (function).
• do-get-selected-index (function).
• do-get-selected-indexes (function).
• do-get-selected-label (function).
• do-get-selected-labels (function).
• do-get-selected-value (function).
• do-get-selected-values (function).
• do-get-speed (function).
• do-get-table (function).
• do-get-text (function).
• do-get-title (function).
• do-get-value (function).
• do-get-whether-this-frame-match-frame-expression (function).
• do-get-whether-this-window-match-window-expression (function).
• do-get-xpath-count (function).
• do-go-back (function).
• do-highlight (function).
• do-is-alert-present (function).
• do-is-checked (function).
• do-is-confirmation-present (function).
• do-is-editable (function).
• do-is-element-present (function).
• do-is-ordered (function).
• do-is-prompt-present (function).
• do-is-something-selected (function).
• do-is-text-present (function).
• do-is-visible (function).
• do-key-down (function).
• do-key-press (function).
• do-key-up (function).
• do-meta-key-down (function).
• do-meta-key-up (function).
• do-mouse-down (function).
• do-mouse-down-at (function).
• do-mouse-move (function).
• do-mouse-move-at (function).
• do-mouse-out (function).
• do-mouse-over (function).
• do-mouse-up (function).
• do-mouse-up-at (function).
• do-open (function).
• do-open-and-wait (function).
• do-open-window (function).
• do-refresh (function).
• do-remove-all-selections (function).
• do-remove-selection (function).
• do-run-script (function).
• do-select (function).
• do-select-and-wait (function).
• do-select-frame (function).
• do-select-window (function).
• do-set-browser-log-level (function).
• do-set-context (function).
• do-set-cursor-position (function).
• do-set-mouse-speed (function).
• do-set-speed (function).
• do-set-timeout (function).
• do-shift-key-down (function).
• do-shift-key-up (function).
• do-submit (function).
• do-test-complete (function).
• do-type (function).
• do-type-and-wait (function).
• do-type-keys (function).
• do-uncheck (function).
• do-wait-for-condition (function).
• do-wait-for-frame-to-load (function).
• do-wait-for-page-to-load (function).
• do-wait-for-pop-up (function).
• do-window-focus (function).
• do-window-maximize (function).
• with-selenium-session (macro).

Internals

define-iedoc (macro).

---

5.1.1 Special variables

Special Variable: *selenium-driver-url* ¶

The URL of the Selenium Remote Control server.

Package

selenium.

Source

iedoc.lisp.

Special Variable: *selenium-session* ¶

Almost all functions take an optional argument called session which defaults to this special variable. You can bind a selenium session to this variable and use those functions without providing an explicit session each time.

Package

selenium.

Source

iedoc.lisp.

---

5.1.2 Macros

Macro: with-selenium-session ((var browser url) &body body) ¶

Evaluate BODY within a Selenium RC session specified by VAR. Once the body is evaluated, the test complete command is sent which closes the session and browser.

Package

selenium.

Source

selenium.lisp.

---

5.1.3 Ordinary functions

Function: do-add-location-strategy (strategy-name function-definition &optional session) ¶

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.

Package

selenium.

Source

selenium.lisp.

Function: do-add-selection (locator option-locator &optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-allow-native-xpath (allow &optional session) ¶

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.

Package

selenium.

Source

selenium.lisp.

Function: do-alt-key-down (&optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-alt-key-up (&optional session) ¶

Release the alt key.

Package

selenium.

Source

selenium.lisp.

Function: do-answer-on-next-prompt (answer &optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-assign-id (locator identifier &optional session) ¶

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.

Package

selenium.

Source

selenium.lisp.

Function: do-capture-screenshot (filename &optional session) ¶

Captures a PNG screenshot to the specified file.

Package

selenium.

Source

selenium.lisp.

Function: do-check (locator &optional session) ¶

Check a toggle-button (checkbox/radio)

Package

selenium.

Source

selenium.lisp.

Function: do-choose-cancel-on-next-confirmation (&optional session) ¶

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.

Package

selenium.

Source

selenium.lisp.

Function: do-choose-ok-on-next-confirmation (&optional session) ¶

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.

Package

selenium.

Source

selenium.lisp.

Function: do-click (locator &optional session) ¶

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.

Package

selenium.

Source

selenium.lisp.

Function: do-click-and-wait (locator &optional session) ¶

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.

Package

selenium.

Source

selenium.lisp.

Function: do-click-at (locator coord-string &optional session) ¶

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.

Package

selenium.

Source

selenium.lisp.

Function: do-close (&optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-control-key-down (&optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-control-key-up (&optional session) ¶

Release the control key.

Package

selenium.

Source

selenium.lisp.

Function: do-create-cookie (name-value-pair options-string &optional session) ¶

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.

Package

selenium.

Source

selenium.lisp.

Function: do-delete-cookie (name path &optional session) ¶

Delete a named cookie with specified path.

Package

selenium.

Source

selenium.lisp.

Function: do-double-click (locator &optional session) ¶

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.

Package

selenium.

Source

selenium.lisp.

Function: do-double-click-at (locator coord-string &optional session) ¶

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.

Package

selenium.

Source

selenium.lisp.

Function: do-drag-and-drop (locator movements-string &optional session) ¶

Drags an element a certain distance and then drops it

Package

selenium.

Source

selenium.lisp.

Function: do-drag-and-drop-to-object (locator-of-object-to-be-dragged locator-of-drag-destination-object &optional session) ¶

Drags an element and drops it on another element

Package

selenium.

Source

selenium.lisp.

Function: do-dragdrop (locator movements-string &optional session) ¶

deprecated - use dragAndDrop instead

Package

selenium.

Source

selenium.lisp.

Function: do-fire-event (locator event-name &optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-get-alert (&optional session) ¶

Retrieves the message of a JavaScript alert generated during the previous action, or fail if there were no alerts. Getting an alert has the same effect as manually clicking OK. If an alert is generated but you do not get/verify it, the next Selenium action will fail. NOTE: under Selenium, JavaScript alerts will NOT pop up a visible alert dialog. NOTE: Selenium does NOT support JavaScript alerts that are generated in a page’s onload() event handler. In this case a visible dialog WILL be generated and Selenium will hang until someone manually clicks OK.

Package

selenium.

Source

selenium.lisp.

Function: do-get-all-buttons (&optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-get-all-fields (&optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-get-all-links (&optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-get-all-window-ids (&optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-get-all-window-names (&optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-get-all-window-titles (&optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-get-attribute (attribute-locator &optional session) ¶

Gets the value of an element attribute.

Package

selenium.

Source

selenium.lisp.

Function: do-get-attribute-from-all-windows (attribute-name &optional session) ¶

Returns every instance of some attribute from all known windows.

Package

selenium.

Source

selenium.lisp.

Function: do-get-body-text (&optional session) ¶

Gets the entire text of the page.

Package

selenium.

Source

selenium.lisp.

Function: do-get-confirmation (&optional session) ¶

Retrieves the message of a JavaScript confirmation dialog generated during the previous action. By default, the confirm function will return true, having the same effect as manually clicking OK. This can be changed by prior execution of the chooseCancelOnNextConfirmation command. If an confirmation is generated but you do not get/verify it, the next Selenium action will fail. NOTE: under Selenium, JavaScript confirmations will NOT pop up a visible dialog. NOTE: Selenium does NOT support JavaScript confirmations that are generated in a page’s onload() event handler. In this case a visible dialog WILL be generated and Selenium will hang until you manually click OK.

Package

selenium.

Source

selenium.lisp.

Function: do-get-cookie (&optional session) ¶

Return all cookies of the current page under test.

Package

selenium.

Source

selenium.lisp.

Function: do-get-cursor-position (locator &optional session) ¶

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.

Package

selenium.

Source

selenium.lisp.

Function: do-get-element-height (locator &optional session) ¶

Retrieves the height of an element

Package

selenium.

Source

selenium.lisp.

Function: do-get-element-index (locator &optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-get-element-position-left (locator &optional session) ¶

Retrieves the horizontal position of an element

Package

selenium.

Source

selenium.lisp.

Function: do-get-element-position-top (locator &optional session) ¶

Retrieves the vertical position of an element

Package

selenium.

Source

selenium.lisp.

Function: do-get-element-width (locator &optional session) ¶

Retrieves the width of an element

Package

selenium.

Source

selenium.lisp.

Function: do-get-eval (script &optional session) ¶

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.

Package

selenium.

Source

selenium.lisp.

Function: do-get-expression (expression &optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-get-html-source (&optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-get-location (&optional session) ¶

Gets the absolute URL of the current page.

Package

selenium.

Source

selenium.lisp.

Function: do-get-mouse-speed (&optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-get-new-browser-session (browser url) ¶

Create a session by using the the given browser and initial URL.

Package

selenium.

Source

selenium.lisp.

Function: do-get-prompt (&optional session) ¶

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.

Package

selenium.

Source

selenium.lisp.

Function: do-get-select-options (select-locator &optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-get-selected-id (select-locator &optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-get-selected-ids (select-locator &optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-get-selected-index (select-locator &optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-get-selected-indexes (select-locator &optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-get-selected-label (select-locator &optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-get-selected-labels (select-locator &optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-get-selected-value (select-locator &optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-get-selected-values (select-locator &optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-get-speed (&optional session) ¶

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.

Package

selenium.

Source

selenium.lisp.

Function: do-get-table (table-cell-address &optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-get-text (locator &optional session) ¶

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.

Package

selenium.

Source

selenium.lisp.

Function: do-get-title (&optional session) ¶

Gets the title of the current page.

Package

selenium.

Source

selenium.lisp.

Function: do-get-value (locator &optional session) ¶

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.

Package

selenium.

Source

selenium.lisp.

Function: do-get-whether-this-frame-match-frame-expression (current-frame-string target &optional session) ¶

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.

Package

selenium.

Source

selenium.lisp.

Function: do-get-whether-this-window-match-window-expression (current-window-string target &optional session) ¶

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.

Package

selenium.

Source

selenium.lisp.

Function: do-get-xpath-count (xpath &optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-go-back (&optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-highlight (locator &optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-is-alert-present (&optional session) ¶

Has an alert occurred? This function never throws an exception

Package

selenium.

Source

selenium.lisp.

Function: do-is-checked (locator &optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-is-confirmation-present (&optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-is-editable (locator &optional session) ¶

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.

Package

selenium.

Source

selenium.lisp.

Function: do-is-element-present (locator &optional session) ¶

Verifies that the specified element is somewhere on the page.

Package

selenium.

Source

selenium.lisp.

Function: do-is-ordered (locator1 locator2 &optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-is-prompt-present (&optional session) ¶

Has a prompt occurred? This function never throws an exception

Package

selenium.

Source

selenium.lisp.

Function: do-is-something-selected (select-locator &optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-is-text-present (pattern &optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-is-visible (locator &optional session) ¶

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.

Package

selenium.

Source

selenium.lisp.

Function: do-key-down (locator key-sequence &optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-key-press (locator key-sequence &optional session) ¶

Simulates a user pressing and releasing a key.

Package

selenium.

Source

selenium.lisp.

Function: do-key-up (locator key-sequence &optional session) ¶

Simulates a user releasing a key.

Package

selenium.

Source

selenium.lisp.

Function: do-meta-key-down (&optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-meta-key-up (&optional session) ¶

Release the meta key.

Package

selenium.

Source

selenium.lisp.

Function: do-mouse-down (locator &optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-mouse-down-at (locator coord-string &optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-mouse-move (locator &optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-mouse-move-at (locator coord-string &optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-mouse-out (locator &optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-mouse-over (locator &optional session) ¶

Simulates a user hovering a mouse over the specified element.

Package

selenium.

Source

selenium.lisp.

Function: do-mouse-up (locator &optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-mouse-up-at (locator coord-string &optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-open (url &optional session) ¶

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.

Package

selenium.

Source

selenium.lisp.

Function: do-open-and-wait (url &optional session) ¶

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.

Package

selenium.

Source

selenium.lisp.

Function: do-open-window (url window-id &optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-refresh (&optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-remove-all-selections (locator &optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-remove-selection (locator option-locator &optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-run-script (script &optional session) ¶

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.

Package

selenium.

Source

selenium.lisp.

Function: do-select (select-locator option-locator &optional session) ¶

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.

Package

selenium.

Source

selenium.lisp.

Function: do-select-and-wait (select-locator option-locator &optional session) ¶

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.

Package

selenium.

Source

selenium.lisp.

Function: do-select-frame (locator &optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-select-window (window-id &optional session) ¶

Selects a popup window; once a popup window has been selected, all commands go to that window. To select the main window again, use null as the target. Note that there is a big difference between a window’s internal JavaScript "name" property and 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 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 what is 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").

Package

selenium.

Source

selenium.lisp.

Function: do-set-browser-log-level (log-level &optional session) ¶

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.

Package

selenium.

Source

selenium.lisp.

Function: do-set-context (context &optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-set-cursor-position (locator position &optional session) ¶

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.

Package

selenium.

Source

selenium.lisp.

Function: do-set-mouse-speed (pixels &optional session) ¶

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.

Package

selenium.

Source

selenium.lisp.

Function: do-set-speed (value &optional session) ¶

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.

Package

selenium.

Source

selenium.lisp.

Function: do-set-timeout (timeout &optional session) ¶

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.

Package

selenium.

Source

selenium.lisp.

Function: do-shift-key-down (&optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-shift-key-up (&optional session) ¶

Release the shift key.

Package

selenium.

Source

selenium.lisp.

Function: do-submit (form-locator &optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-test-complete (&optional session) ¶

Destroy session, closing the browser.

Package

selenium.

Source

selenium.lisp.

Function: do-type (locator value &optional session) ¶

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.

Package

selenium.

Source

selenium.lisp.

Function: do-type-and-wait (locator value &optional session) ¶

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.

Package

selenium.

Source

selenium.lisp.

Function: do-type-keys (locator value &optional session) ¶

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.

Package

selenium.

Source

selenium.lisp.

Function: do-uncheck (locator &optional session) ¶

Uncheck a toggle-button (checkbox/radio)

Package

selenium.

Source

selenium.lisp.

Function: do-wait-for-condition (script timeout &optional session) ¶

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

Package

selenium.

Source

selenium.lisp.

Function: do-wait-for-frame-to-load (frame-address timeout &optional session) ¶

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.

Package

selenium.

Source

selenium.lisp.

Function: do-wait-for-page-to-load (timeout &optional session) ¶

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.

Package

selenium.

Source

selenium.lisp.

Function: do-wait-for-pop-up (window-id timeout &optional session) ¶

Waits for a popup window to appear and load up.

Package

selenium.

Source

selenium.lisp.

Function: do-window-focus (&optional session) ¶

Gives focus to the currently selected window

Package

selenium.

Source

selenium.lisp.

Function: do-window-maximize (&optional session) ¶

Resize currently selected window to take up the entire screen

Package

selenium.

Source

selenium.lisp.

---

5.1.4 Standalone methods

Method: print-object ((iedoc-parameter iedoc-parameter) stream) ¶

Source

iedoc.lisp.

Method: print-object ((iedoc-function iedoc-function) stream) ¶

Source

iedoc.lisp.

---

5.1.5 Conditions

Condition: base-error ¶

Package

selenium.

Source

iedoc.lisp.

Direct superclasses

error.

Direct subclasses

• execution-error.
• http-error.

Condition: execution-error ¶

Package

selenium.

Source

iedoc.lisp.

Direct superclasses

base-error.

Direct methods

description.

Direct slots

Slot: description ¶

Initargs

:description

Readers

description.

Writers

This slot is read-only.

Condition: http-error ¶

Package

selenium.

Source

iedoc.lisp.

Direct superclasses

base-error.

Direct methods

• reason.
• status-code.

Direct slots

Slot: status-code ¶

Initargs

:status-code

Readers

status-code.

Writers

This slot is read-only.

Slot: reason ¶

Initargs

:reason

Readers

reason.

Writers

This slot is read-only.

---

5.2.1 Macros

Macro: define-iedoc (pathname) ¶

Package

selenium.

Source

selenium.lisp.

---

5.2.2 Ordinary functions

Function: convert-function (iedoc-function) ¶

Package

selenium.

Source

iedoc.lisp.

Function: convert-function-name (name) ¶

Package

selenium.

Source

iedoc.lisp.

Function: convert-parameter-name (name) ¶

Package

selenium.

Source

iedoc.lisp.

Function: convert-parameters (iedoc-function-parameters) ¶

Package

selenium.

Source

iedoc.lisp.

Function: convert-result (s return-type) ¶

Package

selenium.

Source

iedoc.lisp.

Function: convert-string-array (s) ¶

Package

selenium.

Source

iedoc.lisp.

Function: execute (url parameters &optional return-type) ¶

Package

selenium.

Source

iedoc.lisp.

Function: make-iedoc-comment (e) ¶

Package

selenium.

Source

iedoc.lisp.

Function: make-iedoc-functions (e) ¶

Package

selenium.

Source

iedoc.lisp.

Function: make-iedoc-parameter (e) ¶

Package

selenium.

Source

iedoc.lisp.

Function: make-iedoc-return-type (e) ¶

Package

selenium.

Source

iedoc.lisp.

Function: marshall-request (command &rest parameters) ¶

Package

selenium.

Source

iedoc.lisp.

Function: normalize-comment (comment) ¶

Package

selenium.

Source

iedoc.lisp.

Function: parse-iedoc (pathname) ¶

Package

selenium.

Source

iedoc.lisp.

Function: starts-with (s prefix) ¶

Returns t if s starts with prefix

Package

selenium.

Source

iedoc.lisp.

---

5.2.3 Generic functions

Generic Reader: description (condition) ¶

Package

selenium.

Methods

Reader Method: description ((condition execution-error)) ¶

Source

iedoc.lisp.

Target Slot

description.

Generic Reader: iedoc-function-comment (object) ¶

Package

selenium.

Methods

Reader Method: iedoc-function-comment ((iedoc-function iedoc-function)) ¶

automatically generated reader method

Source

iedoc.lisp.

Target Slot

comment.

Generic Writer: (setf iedoc-function-comment) (object) ¶

Package

selenium.

Methods

Writer Method: (setf iedoc-function-comment) ((iedoc-function iedoc-function)) ¶

automatically generated writer method

Source

iedoc.lisp.

Target Slot

comment.

Generic Reader: iedoc-function-name (object) ¶

Package

selenium.

Methods

Reader Method: iedoc-function-name ((iedoc-function iedoc-function)) ¶

automatically generated reader method

Source

iedoc.lisp.

Target Slot

name.

Generic Writer: (setf iedoc-function-name) (object) ¶

Package

selenium.

Methods

Writer Method: (setf iedoc-function-name) ((iedoc-function iedoc-function)) ¶

automatically generated writer method

Source

iedoc.lisp.

Target Slot

name.

Generic Reader: iedoc-function-parameters (object) ¶

Package

selenium.

Methods

Reader Method: iedoc-function-parameters ((iedoc-function iedoc-function)) ¶

automatically generated reader method

Source

iedoc.lisp.

Target Slot

parameters.

Generic Writer: (setf iedoc-function-parameters) (object) ¶

Package

selenium.

Methods

Writer Method: (setf iedoc-function-parameters) ((iedoc-function iedoc-function)) ¶

automatically generated writer method

Source

iedoc.lisp.

Target Slot

parameters.

Generic Reader: iedoc-parameter-comment (object) ¶

Package

selenium.

Methods

Reader Method: iedoc-parameter-comment ((iedoc-parameter iedoc-parameter)) ¶

automatically generated reader method

Source

iedoc.lisp.

Target Slot

comment.

Generic Writer: (setf iedoc-parameter-comment) (object) ¶

Package

selenium.

Methods

Writer Method: (setf iedoc-parameter-comment) ((iedoc-parameter iedoc-parameter)) ¶

automatically generated writer method

Source

iedoc.lisp.

Target Slot

comment.

Generic Reader: iedoc-parameter-name (object) ¶

Package

selenium.

Methods

Reader Method: iedoc-parameter-name ((iedoc-parameter iedoc-parameter)) ¶

automatically generated reader method

Source

iedoc.lisp.

Target Slot

name.

Generic Writer: (setf iedoc-parameter-name) (object) ¶

Package

selenium.

Methods

Writer Method: (setf iedoc-parameter-name) ((iedoc-parameter iedoc-parameter)) ¶

automatically generated writer method

Source

iedoc.lisp.

Target Slot

name.

Generic Reader: iedoc-return-type (object) ¶

Package

selenium.

Methods

Reader Method: iedoc-return-type ((iedoc-function iedoc-function)) ¶

automatically generated reader method

Source

iedoc.lisp.

Target Slot

return-type.

Generic Writer: (setf iedoc-return-type) (object) ¶

Package

selenium.

Methods

Writer Method: (setf iedoc-return-type) ((iedoc-function iedoc-function)) ¶

automatically generated writer method

Source

iedoc.lisp.

Target Slot

return-type.

Generic Reader: reason (condition) ¶

Package

selenium.

Methods

Reader Method: reason ((condition http-error)) ¶

Source

iedoc.lisp.

Target Slot

reason.

Generic Reader: status-code (condition) ¶

Package

selenium.

Methods

Reader Method: status-code ((condition http-error)) ¶

Source

iedoc.lisp.

Target Slot

status-code.

---

5.2.4 Classes

Class: iedoc-function ¶

Package

selenium.

Source

iedoc.lisp.

Direct methods

• (setf iedoc-function-comment).
• iedoc-function-comment.
• (setf iedoc-function-name).
• iedoc-function-name.
• (setf iedoc-function-parameters).
• iedoc-function-parameters.
• (setf iedoc-return-type).
• iedoc-return-type.
• print-object.

Direct slots

Slot: name ¶

Initargs

:name

Readers

iedoc-function-name.

Writers

(setf iedoc-function-name).

Slot: parameters ¶

Initargs

:parameters

Readers

iedoc-function-parameters.

Writers

(setf iedoc-function-parameters).

Slot: comment ¶

Initargs

:comment

Readers

iedoc-function-comment.

Writers

(setf iedoc-function-comment).

Slot: return-type ¶

Initargs

:return-type

Readers

iedoc-return-type.

Writers

(setf iedoc-return-type).

Class: iedoc-parameter ¶

Package

selenium.

Source

iedoc.lisp.

Direct methods

• (setf iedoc-parameter-comment).
• iedoc-parameter-comment.
• (setf iedoc-parameter-name).
• iedoc-parameter-name.
• print-object.

Direct slots

Slot: name ¶

Initargs

:name

Readers

iedoc-parameter-name.

Writers

(setf iedoc-parameter-name).

Slot: comment ¶

Initargs

:comment

Readers

iedoc-parameter-comment.

Writers

(setf iedoc-parameter-comment).

---