Methods summary
public
|
|
public
|
|
public
|
#
execute( )
Overwrite this function in subclasses and do add your tests in this
function.
Overwrite this function in subclasses and do add your tests in this
function.
|
public
|
#
setUp( )
Overwrite this function in subclasses to perform preparations for the
tests.
Overwrite this function in subclasses to perform preparations for the
tests.
|
public
|
|
public
|
#
title( )
Outputs the title of the test case.
Outputs the title of the test case.
|
public
|
#
call__( mixed $method, mixed $params )
|
public
|
#
addSelection( locator $locator, optionLocator $optionLocator )
Add a selection to the set of selected options in a multi-select element
using an option locator.
Add a selection to the set of selected options in a multi-select element
using an option locator.
Parameters
- $locator
locator an element locator identifying a multi-select box
- $optionLocator
optionLocator an option locator (a label by default)
Since
0.7
|
public
|
#
altKeyDown( )
Press the alt key and hold it down until doAltUp() is called or a new page is
loaded.
Press the alt key and hold it down until doAltUp() is called or a new page is
loaded.
Since
0.8.1
|
public
|
#
altKeyUp( )
Release the alt key.
Since
0.8.1
|
public
|
#
answerOnNextPrompt( answer $answer )
Instructs Selenium to return the specified answer string in response to the
next JavaScript prompt [window.prompt()].
Instructs Selenium to return the specified answer string in response to the
next JavaScript prompt [window.prompt()].
Parameters
- $answer
answer the answer to give in response to the prompt pop-up
Since
0.6
|
public
|
#
doBreak( )
Halt the currently running test, and wait for the user to press the Continue
button. This command is useful for debugging, but be careful when using it,
because it will force automated tests to hang until a user intervenes
manually.
Halt the currently running test, and wait for the user to press the Continue
button. This command is useful for debugging, but be careful when using it,
because it will force automated tests to hang until a user intervenes
manually.
Please notice that "doBreak" is a workaround to avoid "break" as function
name, because "break" is a PHP keyword.
Since
0.8.1
|
public
|
#
check( locator $locator )
Check a toggle-button (checkbox/radio)
Check a toggle-button (checkbox/radio)
Parameters
- $locator
locator an element locator
Since
0.7
|
public
|
#
chooseCancelOnNextConfirmation( )
By default, Selenium's overridden window.confirm() function will return true,
as if the user had manually clicked OK. After running this command, the next
call to confirm() will return false, as if the user had clicked Cancel.
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.
Since
0.6
|
public
|
#
click( locator $locator )
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.
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.
Parameters
- $locator
locator an element locator
Since
0.6
|
public
|
#
clickAt( locator $locator, coordString $coordString )
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.
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.
Parameters
- $locator
locator an element locator
- $coordString
coordString specifies the x,y position (i.e. - 10,20) of the mouse event relative to the
element returned by the locator.
Since
0.8
|
public
|
#
close( )
Simulates the user clicking the "close" button in the titlebar of a popup
window or tab.
Simulates the user clicking the "close" button in the titlebar of a popup
window or tab.
Since
0.6
|
public
|
#
controlKeyDown( )
Press the control key and hold it down until doControlUp() is called or a new
page is loaded.
Press the control key and hold it down until doControlUp() is called or a new
page is loaded.
Since
0.8.1
|
public
|
|
public
|
#
createCookie( nameValuePair $nameValuePair, optionsString $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.
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.
Parameters
- $nameValuePair
nameValuePair name and value of the cookie in a format "name=value"
- $optionsString
optionsString options for the cookie. Currently supported options include 'path' and
'max_age'. the optionsString's format is "path=/path/, max_age=60". The order of
options are irrelevant, the unit of the value of 'max_age' is second.
Since
0.8
|
public
|
#
deleteCookie( name $name, path $path )
Delete a named cookie with specified path.
Delete a named cookie with specified path.
Parameters
- $name
name the name of the cookie to be deleted
- $path
path the path property of the cookie to be deleted
Since
0.8
|
public
|
#
doubleClick( locator $locator )
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.
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.
Parameters
- $locator
locator an element locator
Since
0.8.1
|
public
|
#
doubleClickAt( locator $locator, coordString $coordString )
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.
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.
Parameters
- $locator
locator an element locator
- $coordString
coordString specifies the x,y position (i.e. - 10,20) of the mouse event relative to the
element returned by the locator.
Since
0.8.1
|
public
|
#
dragAndDrop( locator $locator, movementsString $movementsString )
Drags an element a certain distance and then drops it.
Drags an element a certain distance and then drops it.
Parameters
- $locator
locator an element locator
- $movementsString
movementsString offset in pixels from the current location to which the element should be moved,
e.g., "+70,-300"
Since
0.8.1
|
public
|
#
dragAndDropToObject( locatorOfObjectToBeDragged $locatorOfObjectToBeDragged, locatorOfDragDestinationObject $locatorOfDragDestinationObject )
Drags an element and drops it on another element.
Drags an element and drops it on another element.
Parameters
- $locatorOfObjectToBeDragged
locatorOfObjectToBeDragged an element to be dragged
- $locatorOfDragDestinationObject
locatorOfDragDestinationObject - an element whose location (i.e., whose top left corner) will be the point
where locatorOfObjectToBeDragged is dropped
Since
0.8.1
|
public
|
#
doEcho( message $message )
Prints the specified message into the third table cell in your Selenese
tables. Useful for debugging.
Prints the specified message into the third table cell in your Selenese
tables. Useful for debugging.
Parameters
- $message
message the message to print Please notice that "doEcho" is a workaround to avoid using
"echo" as function name as "echo" is a PHP keyword.
Since
0.8.1
|
public
|
#
fireEvent( locator $locator, eventName $eventName )
Explicitly simulate an event, to trigger the corresponding "onevent"
handler.
Explicitly simulate an event, to trigger the corresponding "onevent"
handler.
Parameters
- $locator
locator an element locator
- $eventName
eventName the event name, e.g. "focus" or "blur"
Since
0.6
|
public
|
#
getSpeed( )
Get execution speed (i.e., get the millisecond length of the delay following
each selenium operation). By default, there is no such delay, i.e., the delay is
0 milliseconds. See also setSpeed.
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.
Since
0.8.1
|
public
|
#
goBack( )
Simulates the user clicking the "back" button on their browser.
Simulates the user clicking the "back" button on their browser.
Since
0.6
|
public
|
#
highlight( locator $locator )
Briefly changes the backgroundColor of the specified element yellow. Useful
for debugging.
Briefly changes the backgroundColor of the specified element yellow. Useful
for debugging.
Parameters
- $locator
locator an element locator
Since
0.8.2
|
public
|
#
keyDown( locator $locator, keySequence $keySequence )
Simulates a user pressing a key (without releasing it yet).
Simulates a user pressing a key (without releasing it yet).
Parameters
- $locator
locator an element locator
- $keySequence
keySequence Either be a string("\" followed by the numeric keycode of the key to be pressed,
normally the ASCII value of that key), or a single character. For example: "w",
"\119".
Since
0.7
|
public
|
#
keyPress( locator $locator, keySequence $keySequence )
Simulates a user pressing and releasing a key.
Simulates a user pressing and releasing a key.
Parameters
- $locator
locator an element locator
- $keySequence
keySequence Either be a string("\" followed by the numeric keycode of the key to be pressed,
normally the ASCII value of that key), or a single character. For example: "w",
"\119".
Since
0.7
|
public
|
#
keyUp( locator $locator, keySequence $keySequence )
Simulates a user releasing a key.
Simulates a user releasing a key.
Parameters
- $locator
locator an element locator
- $keySequence
keySequence Either be a string("\" followed by the numeric keycode of the key to be pressed,
normally the ASCII value of that key), or a single character. For example: "w",
"\119".
Since
0.7
|
public
|
#
metaKeyDown( )
Press the meta key and hold it down until doMetaUp() is called or a new page
is loaded.
Press the meta key and hold it down until doMetaUp() is called or a new page
is loaded.
Since
0.8.1
|
public
|
|
public
|
#
mouseDown( locator $locator )
Simulates a user pressing the mouse button (without releasing it yet) on the
specified element.
Simulates a user pressing the mouse button (without releasing it yet) on the
specified element.
Parameters
- $locator
locator an element locator
Since
0.7
|
public
|
#
mouseDownAt( locator $locator, coordString $coordString )
Simulates a user pressing the mouse button (without releasing it yet) on the
specified element.
Simulates a user pressing the mouse button (without releasing it yet) on the
specified element.
Parameters
- $locator
locator an element locator
- $coordString
coordString specifies the x,y position (i.e. - 10,20) of the mouse event relative to the
element returned by the locator.
Since
0.8
|
public
|
#
mouseMove( locator $locator )
Simulates a user pressing the mouse button (without releasing it yet) on the
specified element.
Simulates a user pressing the mouse button (without releasing it yet) on the
specified element.
Parameters
- $locator
locator an element locator
Since
0.8
|
public
|
#
mouseMoveAt( locator $locator, coordString $coordString )
Simulates a user pressing the mouse button (without releasing it yet) on the
specified element.
Simulates a user pressing the mouse button (without releasing it yet) on the
specified element.
Parameters
- $locator
locator an element locator
- $coordString
coordString specifies the x,y position (i.e. - 10,20) of the mouse event relative to the
element returned by the locator.
Since
0.8
|
public
|
#
mouseOut( locator $locator )
Simulates a user moving the mouse pointer away from the specified
element.
Simulates a user moving the mouse pointer away from the specified
element.
Parameters
- $locator
locator an element locator
Since
0.8
|
public
|
#
mouseOver( locator $locator )
Simulates a user hovering a mouse over the specified element.
Simulates a user hovering a mouse over the specified element.
Parameters
- $locator
locator an element locator
Since
0.7
|
public
|
#
mouseUp( locator $locator )
Simulates a user pressing the mouse button (without releasing it yet) on the
specified element.
Simulates a user pressing the mouse button (without releasing it yet) on the
specified element.
Parameters
- $locator
locator an element locator
Since
0.8
|
public
|
#
mouseUpAt( locator $locator, coordString $coordString )
Simulates a user pressing the mouse button (without releasing it yet) on the
specified element.
Simulates a user pressing the mouse button (without releasing it yet) on the
specified element.
Parameters
- $locator
locator an element locator
- $coordString
coordString specifies the x,y position (i.e. - 10,20) of the mouse event relative to the
element returned by the locator.
Since
0.8
|
public
|
#
open( mixed $url )
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.
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.
Parameters
- $url
mixed $url the URL to open; may be relative or absolute
Since
0.6
|
public
|
#
openWindow( url() $url, windowID $windowID )
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.
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").
Parameters
- $url
url()
the URL to open, which can be blank
- $windowID
windowID the JavaScript window ID of the window to select
Since
0.8.1
|
public
|
#
pause( waitTime $waitTime )
Wait for the specified amount of time (in milliseconds)
Wait for the specified amount of time (in milliseconds)
Parameters
- $waitTime
waitTime the amount of time to sleep (in milliseconds)
Since
0.8.1
|
public
|
#
refresh( )
Simulates the user clicking the "Refresh" button on their browser.
Simulates the user clicking the "Refresh" button on their browser.
Since
0.7
|
public
|
#
removeAllSelections( locator $locator )
Unselects all of the selected options in a multi-select element.
Unselects all of the selected options in a multi-select element.
Parameters
- $locator
locator am element locator identifying a multi-select box
Since
0.8.2
|
public
|
#
removeSelection( locator $locator, optionLocator $optionLocator )
Remove a selection from the set of selected options in a multi-select element
using an option locator.
Remove a selection from the set of selected options in a multi-select element
using an option locator.
Parameters
- $locator
locator an element locator identifying a multi-select box
- $optionLocator
optionLocator an option locator (a label by default)
Since
0.7
|
public
|
#
select( selectLocator $selectLocator, optionLocator $optionLocator )
Select an option from a drop-down using an option locator.
Select an option from a drop-down using an option locator.
Parameters
- $selectLocator
selectLocator an element locator identifying a drop-down menu
- $optionLocator
optionLocator an option locator (a label by default)
Since
0.6
|
public
|
#
selectFrame( locator $locator )
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".
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 may also use a DOM expression to identify the frame you want directly,
like this: dom=frames["main"].frames["subframe"]
Parameters
- $locator
locator an element locator identifying a frame or iframe
Since
0.8
|
public
|
#
selectWindow( windowID $windowID )
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.
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.
Parameters
- $windowID
windowID the JavaScript window ID of the window to select
Since
0.6
|
public
|
#
setContext( context $context, logLevelThreshold $logLevelThreshold )
Writes a message to the status bar and adds a note to the browser-side log.
If logLevelThreshold is specified, set the threshold for logging to that level
(debug, info, warn, error). (Note that the browser-side logs will not be sent
back to the server, and are invisible to the Client Driver.)
Writes a message to the status bar and adds a note to the browser-side log.
If logLevelThreshold is specified, set the threshold for logging to that level
(debug, info, warn, error). (Note that the browser-side logs will not be sent
back to the server, and are invisible to the Client Driver.)
Parameters
- $context
context the message to be sent to the browser
- $logLevelThreshold
logLevelThreshold one of "debug", "info", "warn", "error", sets the threshold for browser-side
logging
Since
0.7
|
public
|
#
setCursorPosition( locator $locator, position $position )
Moves the text cursor to the specified position in the given input element or
textarea. This method will fail if the specified element isn't an input element
or textarea.
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.
Parameters
- $locator
locator an element locator pointing to an input element or textarea
- $position
position the numerical position of the cursor in the field; position should be 0 to move
the position to the beginning of the field. You can also set the cursor to -1 to
move it to the end of the field.
Since
0.8
|
public
|
#
setMouseSpeed( pixels $pixels )
Configure the number of pixels between "mousemove" events during dragAndDrop
commands (default=10).
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.
Parameters
- $pixels
pixels the number of pixels between "mousemove" events
Since
0.8.2
|
public
|
#
setSpeed( value $value )
Set execution speed (i.e., set the millisecond length of a delay which will
follow each selenium operation). By default, there is no such delay, i.e., the
delay is 0 milliseconds.
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.
Parameters
- $value
value the number of milliseconds to pause after operation
Since
0.8.1
|
public
|
#
setTimeout( timeout $timeout )
Specifies the amount of time that Selenium will wait for actions to complete.
Actions that require waiting include "open" and the "waitFor*" actions. The
default timeout is 30 seconds.
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.
Parameters
- $timeout
timeout a timeout in milliseconds, after which the action will return with an error
Since
0.7
|
public
|
#
shiftKeyDown( )
Press the shift key and hold it down until doShiftUp() is called or a new
page is loaded.
Press the shift key and hold it down until doShiftUp() is called or a new
page is loaded.
Since
0.8.1
|
public
|
|
public
|
#
store( expression $expression, variableName $variableName )
This command is a synonym for storeExpression.
This command is a synonym for storeExpression.
Parameters
- $expression
expression the value to store
- $variableName
variableName the name of a variable in which the result is to be stored.
Since
0.8.1
|
public
|
#
submit( formLocator $formLocator )
Submit the specified form. This is particularly useful for forms without
submit buttons, e.g. single-input "Search" forms.
Submit the specified form. This is particularly useful for forms without
submit buttons, e.g. single-input "Search" forms.
Parameters
- $formLocator
formLocator an element locator for the form you want to submit
Since
0.7
|
public
|
#
type( locator $locator, value $value )
Sets the value of an input field, as though you typed it in. Can also be used
to set the value of combo boxes, check boxes, etc. In these cases, value should
be the value of the option selected, not the visible text.
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.
Parameters
- $locator
locator an element locator
- $value
value the value to type
Since
0.6
|
public
|
#
typeKeys( locator $locator, value $value )
Simulates keystroke events on the specified element, as though you typed the
value key-by-key.
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.
Parameters
- $locator
locator an element locator
- $value
value the value to type
Since
0.8.2
|
public
|
#
uncheck( locator $locator )
Uncheck a toggle-button (checkbox/radio)
Uncheck a toggle-button (checkbox/radio)
Parameters
- $locator
locator an element locator
Since
0.7
|
public
|
#
waitForCondition( script $script, timeout $timeout )
Runs the specified JavaScript snippet repeatedly until it evaluates to
"true". The snippet may have multiple lines, but only the result of the last
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
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
Parameters
- $script
script the JavaScript snippet to run
- $timeout
timeout a timeout in milliseconds, after which this command will return with an error
Since
0.7
|
public
|
#
waitForPageToLoad( timeout $timeout )
Waits for a new page to load. You can use this command instead of the
"AndWait" suffixes, "clickAndWait", "selectAndWait", "typeAndWait" etc. (which
are only available in the JS API). Selenium constantly keeps track of new pages
loading, and sets a "newPageLoaded" flag when it first notices a page load.
Running any other Selenium command 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.
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.
Parameters
- $timeout
timeout a timeout in milliseconds, after which this command will return with an error
Since
0.7
|
public
|
#
windowFocus( windowName $windowName )
Gives focus to a window.
Parameters
- $windowName
windowName name of the window to be given focus
Since
0.8
|
public
|
#
windowMaximize( windowName $windowName )
Resize window to take up the entire screen.
Resize window to take up the entire screen.
Parameters
- $windowName
windowName name of the window to be enlarged
|
public
|
#
clickAndWait( locator $locator )
Clicks on a link, button, checkbox or radio button. If the click action
causes a new page to load (like a link usually does), use "clickAndWait".
Clicks on a link, button, checkbox or radio button. If the click action
causes a new page to load (like a link usually does), use "clickAndWait".
Parameters
- $locator
locator an element locator
Since
0.6
|
public
|
#
typeAndWait( locator $locator, value $value )
Sets the value of an input field, as though you typed it in. Can also be used
to set the value of combo boxes, check boxes, etc. In these cases, value should
be the value of the option selected, not the visible text.
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.
Parameters
- $locator
locator an element locator
- $value
value the value to type
Since
0.6
|
public
|
#
selectAndWait( locator $locator, optionLocator $optionLocator )
Select an option from a drop-down using an option locator.
Select an option from a drop-down using an option locator.
Parameters
- $locator
locator an element locator identifying a drop-down menu
- $optionLocator
optionLocator an option locator (a label by default)
Since
0.6
|
public
|
#
assertErrorOnNext( message $message )
Tell Selenium to expect an error on the next command execution.
Tell Selenium to expect an error on the next command execution.
Parameters
- $message
message the error message we should expect. This command will fail if the wrong error
message appears.
Since
0.8.1 Related Assertions: assertNotErrorOnNext($message)
verifyErrorOnNext($message) verifyNotErrorOnNext($message)
waitForErrorOnNext($message) waitForNotErrorOnNext($message)
|
public
|
#
assertFailureOnNext( message $message )
Tell Selenium to expect a failure on the next command execution.
Tell Selenium to expect a failure on the next command execution.
Parameters
- $message
message the failure message we should expect. This command will fail if the wrong
failure message appears.
Since
0.8.1 Related Assertions: assertNotFailureOnNext($message)
verifyFailureOnNext($message) verifyNotFailureOnNext($message)
waitForFailureOnNext($message) waitForNotFailureOnNext($message)
|
public
the
|
#
storeAlert( mixed $variableName )
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.
Retrieves the message of a JavaScript alert generated during the previous
action, or fail if there were no alerts. Getting an alert has the same effect as
manually clicking OK. If an alert is generated but you do not get/verify it, the
next Selenium action will fail. NOTE: under Selenium, JavaScript alerts will NOT
pop up a visible alert dialog. NOTE: Selenium does NOT support JavaScript alerts
that are generated in a page's onload() event handler. In this case a visible
dialog WILL be generated and Selenium will hang until someone manually clicks
OK.
Returns
the message of the most recent JavaScript alert
Since
0.7 Related Assertions: assertAlert($pattern) assertNotAlert($pattern)
verifyAlert($pattern) verifyNotAlert($pattern) waitForAlert($pattern)
waitForNotAlert($pattern)
|
public
the
|
#
storeAllButtons( mixed $variableName )
Returns the IDs of all buttons on the page. If a given button has no ID, it
will appear as "" in this array.
Returns the IDs of all buttons on the page. If a given button has no ID, it
will appear as "" in this array.
Returns
the IDs of all buttons on the page
Since
0.7 Related Assertions: assertAllButtons($pattern) assertNotAllButtons($pattern)
verifyAllButtons($pattern) verifyNotAllButtons($pattern)
waitForAllButtons($pattern) waitForNotAllButtons($pattern)
|
public
the
|
#
storeAllFields( mixed $variableName )
Returns the IDs of all input fields on the page. If a given field has no ID,
it will appear as "" in this array.
Returns the IDs of all input fields on the page. If a given field has no ID,
it will appear as "" in this array.
Returns
the IDs of all fields on the page
Since
0.7 Related Assertions: assertAllFields($pattern) assertNotAllFields($pattern)
verifyAllFields($pattern) verifyNotAllFields($pattern)
waitForAllFields($pattern) waitForNotAllFields($pattern)
|
public
the
|
#
storeAllLinks( mixed $variableName )
Returns the IDs of all links on the page. If a given link has no ID, it will
appear as "" in this array.
Returns the IDs of all links on the page. If a given link has no ID, it will
appear as "" in this array.
Returns
the IDs of all links on the page
Since
0.7 Related Assertions: assertAllLinks($pattern) assertNotAllLinks($pattern)
verifyAllLinks($pattern) verifyNotAllLinks($pattern) waitForAllLinks($pattern)
waitForNotAllLinks($pattern)
|
public
the
|
#
storeAllWindowIds( mixed $variableName )
Returns the IDs of all windows that the browser knows about.
Returns the IDs of all windows that the browser knows about.
Returns
the IDs of all windows that the browser knows about
Since
0.8 Related Assertions: assertAllWindowIds($pattern)
assertNotAllWindowIds($pattern) verifyAllWindowIds($pattern)
verifyNotAllWindowIds($pattern) waitForAllWindowIds($pattern)
waitForNotAllWindowIds($pattern)
|
public
the
|
#
storeAllWindowNames( mixed $variableName )
Returns the names of all windows that the browser knows about.
Returns the names of all windows that the browser knows about.
Returns
the names of all windows that the browser knows about
Since
0.8 Related Assertions: assertAllWindowNames($pattern)
assertNotAllWindowNames($pattern) verifyAllWindowNames($pattern)
verifyNotAllWindowNames($pattern) waitForAllWindowNames($pattern)
waitForNotAllWindowNames($pattern)
|
public
the
|
#
storeAllWindowTitles( mixed $variableName )
Returns the titles of all windows that the browser knows about.
Returns the titles of all windows that the browser knows about.
Returns
the titles of all windows that the browser knows about
Since
0.8 Related Assertions: assertAllWindowTitles($pattern)
assertNotAllWindowTitles($pattern) verifyAllWindowTitles($pattern)
verifyNotAllWindowTitles($pattern) waitForAllWindowTitles($pattern)
waitForNotAllWindowTitles($pattern)
|
public
the
|
#
storeAttribute( attributeLocator $attributeLocator, variableName $variableName )
Gets the value of an element attribute.
Gets the value of an element attribute.
Parameters
- $attributeLocator
attributeLocator an element locator
- $variableName
variableName the name of a variable in which the result is to be stored.
Returns
the value of the specified attribute
Since
0.6 Related Assertions: assertAttribute($attributeLocator, $pattern)
assertNotAttribute($attributeLocator, $pattern)
verifyAttribute($attributeLocator, $pattern)
verifyNotAttribute($attributeLocator, $pattern)
waitForAttribute($attributeLocator, $pattern)
waitForNotAttribute($attributeLocator, $pattern)
|
public
the
|
#
storeAttributeFromAllWindows( attributeName $attributeName, variableName $variableName )
Returns every instance of some attribute from all known windows.
Returns every instance of some attribute from all known windows.
Parameters
- $attributeName
attributeName name of an attribute on the windows
- $variableName
variableName the name of a variable in which the result is to be stored.
Returns
the set of values of this attribute from all known windows
Since
0.8 Related Assertions: assertAttributeFromAllWindows($attributeName, $pattern)
assertNotAttributeFromAllWindows($attributeName, $pattern)
verifyAttributeFromAllWindows($attributeName, $pattern)
verifyNotAttributeFromAllWindows($attributeName, $pattern)
waitForAttributeFromAllWindows($attributeName, $pattern)
waitForNotAttributeFromAllWindows($attributeName, $pattern)
|
public
the
|
#
storeBodyText( mixed $variableName )
Gets the entire text of the page.
Gets the entire text of the page.
Returns
the entire text of the page
Since
0.7 Related Assertions: assertBodyText($pattern) assertNotBodyText($pattern)
verifyBodyText($pattern) verifyNotBodyText($pattern) waitForBodyText($pattern)
waitForNotBodyText($pattern)
|
public
the
|
#
storeConfirmation( mixed $variableName )
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.
Retrieves the message of a JavaScript confirmation dialog generated during
the previous action. By default, the confirm function will return true, having
the same effect as manually clicking OK. This can be changed by prior execution
of the chooseCancelOnNextConfirmation command. If an confirmation is generated
but you do not get/verify it, the next Selenium action will fail. NOTE: under
Selenium, JavaScript confirmations will NOT pop up a visible dialog. NOTE:
Selenium does NOT support JavaScript confirmations that are generated in a
page's onload() event handler. In this case a visible dialog WILL be generated
and Selenium will hang until you manually click OK.
Returns
the message of the most recent JavaScript confirmation dialog
Since
0.7 Related Assertions: assertConfirmation($pattern)
assertNotConfirmation($pattern) verifyConfirmation($pattern)
verifyNotConfirmation($pattern) waitForConfirmation($pattern)
waitForNotConfirmation($pattern)
|
public
all
|
#
storeCookie( mixed $variableName )
Return all cookies of the current page under test.
Return all cookies of the current page under test.
Returns
all cookies of the current page under test
Since
0.8 Related Assertions: assertCookie($pattern) assertNotCookie($pattern)
verifyCookie($pattern) verifyNotCookie($pattern) waitForCookie($pattern)
waitForNotCookie($pattern)
|
public
the
|
#
storeCursorPosition( locator $locator, variableName $variableName )
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.
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.
Parameters
- $locator
locator an element locator pointing to an input element or textarea
- $variableName
variableName the name of a variable in which the result is to be stored
Returns
the numerical position of the cursor in the field
Since
0.8 Related Assertions: assertCursorPosition($locator, $pattern)
assertNotCursorPosition($locator, $pattern) verifyCursorPosition($locator,
$pattern) verifyNotCursorPosition($locator, $pattern)
waitForCursorPosition($locator, $pattern) waitForNotCursorPosition($locator,
$pattern)
|
public
height
|
#
storeElementHeight( locator $locator, variableName $variableName )
Retrieves the height of an element.
Retrieves the height of an element.
Parameters
- $locator
locator an element locator pointing to an element
- $variableName
variableName the name of a variable in which the result is to be stored
Returns
height of an element in pixels
Since
0.8 Related Assertions: assertElementHeight($locator, $pattern)
assertNotElementHeight($locator, $pattern) verifyElementHeight($locator,
$pattern) verifyNotElementHeight($locator, $pattern)
waitForElementHeight($locator, $pattern) waitForNotElementHeight($locator,
$pattern)
|
public
relative
|
#
storeElementIndex( locator $locator, variableName $variableName )
Get the relative index of an element to its parent (starting from 0). The
comment node and empty text node will be ignored.
Get the relative index of an element to its parent (starting from 0). The
comment node and empty text node will be ignored.
Parameters
- $locator
locator an element locator pointing to an element
- $variableName
variableName the name of a variable in which the result is to be stored
Returns
relative index of the element to its parent (starting from 0)
Since
0.8 Related Assertions: assertElementIndex($locator, $pattern)
assertNotElementIndex($locator, $pattern) verifyElementIndex($locator, $pattern)
verifyNotElementIndex($locator, $pattern) waitForElementIndex($locator,
$pattern) waitForNotElementIndex($locator, $pattern)
|
public
pixels
|
#
storeElementPositionLeft( locator $locator, variableName $variableName )
Retrieves the horizontal position of an element.
Retrieves the horizontal position of an element.
Parameters
- $locator
locator an element locator pointing to an element OR an element itself
- $variableName
variableName the name of a variable in which the result is to be stored
Returns
pixels from the edge of the frame
Since
0.8 Related Assertions: assertElementPositionLeft($locator, $pattern)
assertNotElementPositionLeft($locator, $pattern)
verifyElementPositionLeft($locator, $pattern)
verifyNotElementPositionLeft($locator, $pattern)
waitForElementPositionLeft($locator, $pattern)
waitForNotElementPositionLeft($locator, $pattern)
|
public
pixels
|
#
storeElementPositionTop( locator $locator, variableName $variableName )
Retrieves the vertical position of an element.
Retrieves the vertical position of an element.
Parameters
- $locator
locator an element locator pointing to an element OR an element itself
- $variableName
variableName the name of a variable in which the result is to be stored
Returns
pixels from the edge of the frame
Since
0.8 Related Assertions: assertElementPositionTop($locator, $pattern)
assertNotElementPositionTop($locator, $pattern)
verifyElementPositionTop($locator, $pattern)
verifyNotElementPositionTop($locator, $pattern)
waitForElementPositionTop($locator, $pattern)
waitForNotElementPositionTop($locator, $pattern)
|
public
width
|
#
storeElementWidth( locator $locator, variableName $variableName )
Retrieves the width of an element.
Retrieves the width of an element.
Parameters
- $locator
locator an element locator pointing to an element
- $variableName
variableName the name of a variable in which the result is to be stored
Returns
width of an element in pixels
Since
0.8 Related Assertions: assertElementWidth($locator, $pattern)
assertNotElementWidth($locator, $pattern) verifyElementWidth($locator, $pattern)
verifyNotElementWidth($locator, $pattern) waitForElementWidth($locator,
$pattern) waitForNotElementWidth($locator, $pattern)
|
public
the
|
#
storeEval( script $script, variableName $variableName )
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, and window will refer
to the top-level runner test window, not the window of your application. If you
need a reference to the window of your application, you can refer to
this.browserbot.getCurrentWindow() and if you need to use a locator to refer to
a single element in your application page, you can use
this.page().findElement("foo") where "foo" is your locator.
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, and window will refer
to the top-level runner test window, not the window of your application. If you
need a reference to the window of your application, you can refer to
this.browserbot.getCurrentWindow() and if you need to use a locator to refer to
a single element in your application page, you can use
this.page().findElement("foo") where "foo" is your locator.
Parameters
- $script
script the JavaScript snippet to run
- $variableName
variableName the name of a variable in which the result is to be stored.
Returns
the results of evaluating the snippet
Since
0.7 Related Assertions: assertEval($script, $pattern) assertNotEval($script,
$pattern) verifyEval($script, $pattern) verifyNotEval($script, $pattern)
waitForEval($script, $pattern) waitForNotEval($script, $pattern)
|
public
the
|
#
storeExpression( expression $expression, variableName $variableName )
Returns the specified expression. This is useful because of JavaScript
preprocessing. It is used to generate commands like assertExpression and
waitForExpression.
Returns the specified expression. This is useful because of JavaScript
preprocessing. It is used to generate commands like assertExpression and
waitForExpression.
Parameters
- $expression
expression the value to return
- $variableName
variableName the name of a variable in which the result is to be stored.
Returns
the value passed in
Since
0.7 Related Assertions: assertExpression($expression, $pattern)
assertNotExpression($expression, $pattern) verifyExpression($expression,
$pattern) verifyNotExpression($expression, $pattern)
waitForExpression($expression, $pattern) waitForNotExpression($expression,
$pattern)
|
public
the
|
#
storeHtmlSource( mixed $variableName )
Returns the entire HTML source between the opening and closing "html"
tags.
Returns the entire HTML source between the opening and closing "html"
tags.
Returns
the entire HTML source
Since
0.7 Related Assertions: assertHtmlSource($pattern) assertNotHtmlSource($pattern)
verifyHtmlSource($pattern) verifyNotHtmlSource($pattern)
waitForHtmlSource($pattern) waitForNotHtmlSource($pattern)
|
public
the
|
#
storeLocation( mixed $variableName )
Gets the absolute URL of the current page.
Gets the absolute URL of the current page.
Returns
the absolute URL of the current page
Since
0.7 Related Assertions: assertLocation($pattern) assertNotLocation($pattern)
verifyLocation($pattern) verifyNotLocation($pattern) waitForLocation($pattern)
waitForNotLocation($pattern)
|
public
all
|
#
storeLogMessages( mixed $variableName )
Return the contents of the log. This is a placeholder intended to make the
code generator make this API available to clients. The selenium server will
intercept this call, however, and return its recordkeeping of log messages since
the last call to this API. Thus this code in JavaScript will never be called.
The reason I opted for a servercentric solution is to be able to support
multiple frames served from different domains, which would break a centralized
JavaScript logging mechanism under some conditions.
Return the contents of the log. This is a placeholder intended to make the
code generator make this API available to clients. The selenium server will
intercept this call, however, and return its recordkeeping of log messages since
the last call to this API. Thus this code in JavaScript will never be called.
The reason I opted for a servercentric solution is to be able to support
multiple frames served from different domains, which would break a centralized
JavaScript logging mechanism under some conditions.
Returns
all log messages seen since the last call to this API
Since
0.8 Related Assertions: assertLogMessages($pattern)
assertNotLogMessages($pattern) verifyLogMessages($pattern)
verifyNotLogMessages($pattern) waitForLogMessages($pattern)
waitForNotLogMessages($pattern)
|
public
the
|
#
storeMouseSpeed( mixed $variableName )
Returns the number of pixels between "mousemove" events during dragAndDrop
commands (default=10).
Returns the number of pixels between "mousemove" events during dragAndDrop
commands (default=10).
Returns
the number of pixels between "mousemove" events during dragAndDrop commands
(default=10)
Since
0.8.2 Related Assertions: assertMouseSpeed($pattern)
assertNotMouseSpeed($pattern) verifyMouseSpeed($pattern)
verifyNotMouseSpeed($pattern) waitForMouseSpeed($pattern)
waitForNotMouseSpeed($pattern)
|
public
the
|
#
storePrompt( mixed $variableName )
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.
Retrieves the message of a JavaScript question prompt dialog generated during
the previous action. Successful handling of the prompt requires prior execution
of the answerOnNextPrompt command. If a prompt is generated but you do not
get/verify it, the next Selenium action will fail. NOTE: under Selenium,
JavaScript prompts will NOT pop up a visible dialog. NOTE: Selenium does NOT
support JavaScript prompts that are generated in a page's onload() event
handler. In this case a visible dialog WILL be generated and Selenium will hang
until someone manually clicks OK.
Returns
the message of the most recent JavaScript question prompt
Since
0.7 Related Assertions: assertPrompt($pattern) assertNotPrompt($pattern)
verifyPrompt($pattern) verifyNotPrompt($pattern) waitForPrompt($pattern)
waitForNotPrompt($pattern)
|
public
the
|
#
storeSelectedId( selectLocator $selectLocator, variableName $variableName )
Gets option element ID for selected option in the specified select
element.
Gets option element ID for selected option in the specified select
element.
Parameters
- $selectLocator
selectLocator an element locator identifying a drop-down menu
- $variableName
variableName the name of a variable in which the result is to be stored
Returns
the selected option ID in the specified select drop-down
Since
0.8 Related Assertions: assertSelectedId($selectLocator, $pattern)
assertNotSelectedId($selectLocator, $pattern) verifySelectedId($selectLocator,
$pattern) verifyNotSelectedId($selectLocator, $pattern)
waitForSelectedId($selectLocator, $pattern) waitForNotSelectedId($selectLocator,
$pattern)
|
public
an
|
#
storeSelectedIds( selectLocator $selectLocator, variableName $variableName )
Gets all option element IDs for selected options in the specified select or
multi-select element.
Gets all option element IDs for selected options in the specified select or
multi-select element.
Parameters
- $selectLocator
selectLocator an element locator identifying a drop-down menu
- $variableName
variableName the name of a variable in which the result is to be stored
Returns
an array of all selected option IDs in the specified select drop-down
Since
0.8 Related Assertions: assertSelectedIds($selectLocator, $pattern)
assertNotSelectedIds($selectLocator, $pattern) verifySelectedIds($selectLocator,
$pattern) verifyNotSelectedIds($selectLocator, $pattern)
waitForSelectedIds($selectLocator, $pattern)
waitForNotSelectedIds($selectLocator, $pattern)
|
public
the
|
#
storeSelectedIndex( selectLocator $selectLocator, variableName $variableName )
Gets option index (option number, starting at 0) for selected option in the
specified select element.
Gets option index (option number, starting at 0) for selected option in the
specified select element.
Parameters
- $selectLocator
selectLocator an element locator identifying a drop-down menu
- $variableName
variableName the name of a variable in which the result is to be stored
Returns
the selected option index in the specified select drop-down
Since
0.8 Related Assertions: assertSelectedIndex($selectLocator, $pattern)
assertNotSelectedIndex($selectLocator, $pattern)
verifySelectedIndex($selectLocator, $pattern)
verifyNotSelectedIndex($selectLocator, $pattern)
waitForSelectedIndex($selectLocator, $pattern)
waitForNotSelectedIndex($selectLocator, $pattern)
|
public
an
|
#
storeSelectedIndexes( selectLocator $selectLocator, variableName $variableName )
Gets all option indexes (option number, starting at 0) for selected options
in the specified select or multi-select element.
Gets all option indexes (option number, starting at 0) for selected options
in the specified select or multi-select element.
Parameters
- $selectLocator
selectLocator an element locator identifying a drop-down menu
- $variableName
variableName the name of a variable in which the result is to be stored
Returns
an array of all selected option indexes in the specified select drop-down
Since
0.8 Related Assertions: assertSelectedIndexes($selectLocator, $pattern)
assertNotSelectedIndexes($selectLocator, $pattern)
verifySelectedIndexes($selectLocator, $pattern)
verifyNotSelectedIndexes($selectLocator, $pattern)
waitForSelectedIndexes($selectLocator, $pattern)
waitForNotSelectedIndexes($selectLocator, $pattern)
|
public
the
|
#
storeSelectedLabel( selectLocator $selectLocator, variableName $variableName )
Gets option label (visible text) for selected option in the specified select
element.
Gets option label (visible text) for selected option in the specified select
element.
Parameters
- $selectLocator
selectLocator an element locator identifying a drop-down menu
- $variableName
variableName the name of a variable in which the result is to be stored
Returns
the selected option label in the specified select drop-down
Since
0.8 Related Assertions: assertSelectedLabel($selectLocator, $pattern)
assertNotSelectedLabel($selectLocator, $pattern)
verifySelectedLabel($selectLocator, $pattern)
verifyNotSelectedLabel($selectLocator, $pattern)
waitForSelectedLabel($selectLocator, $pattern)
waitForNotSelectedLabel($selectLocator, $pattern)
|
public
an
|
#
storeSelectedLabels( selectLocator $selectLocator, variableName $variableName )
Gets all option labels (visible text) for selected options in the specified
select or multi-select element.
Gets all option labels (visible text) for selected options in the specified
select or multi-select element.
Parameters
- $selectLocator
selectLocator an element locator identifying a drop-down menu
- $variableName
variableName the name of a variable in which the result is to be stored
Returns
an array of all selected option labels in the specified select drop-down
Since
0.8 Related Assertions: assertSelectedLabels($selectLocator, $pattern)
assertNotSelectedLabels($selectLocator, $pattern)
verifySelectedLabels($selectLocator, $pattern)
verifyNotSelectedLabels($selectLocator, $pattern)
waitForSelectedLabels($selectLocator, $pattern)
waitForNotSelectedLabels($selectLocator, $pattern)
|
public
the
|
#
storeSelectedValue( selectLocator $selectLocator, variableName $variableName )
Gets option value (value attribute) for selected option in the specified
select element.
Gets option value (value attribute) for selected option in the specified
select element.
Parameters
- $selectLocator
selectLocator an element locator identifying a drop-down menu
- $variableName
variableName the name of a variable in which the result is to be stored
Returns
the selected option value in the specified select drop-down
Since
0.8 Related Assertions: assertSelectedValue($selectLocator, $pattern)
assertNotSelectedValue($selectLocator, $pattern)
verifySelectedValue($selectLocator, $pattern)
verifyNotSelectedValue($selectLocator, $pattern)
waitForSelectedValue($selectLocator, $pattern)
waitForNotSelectedValue($selectLocator, $pattern)
|
public
an
|
#
storeSelectedValues( selectLocator $selectLocator, variableName $variableName )
Gets all option values (value attributes) for selected options in the
specified select or multi-select element.
Gets all option values (value attributes) for selected options in the
specified select or multi-select element.
Parameters
- $selectLocator
selectLocator an element locator identifying a drop-down menu
- $variableName
variableName the name of a variable in which the result is to be stored
Returns
an array of all selected option values in the specified select drop-down
Since
0.8 Related Assertions: assertSelectedValues($selectLocator, $pattern)
assertNotSelectedValues($selectLocator, $pattern)
verifySelectedValues($selectLocator, $pattern)
verifyNotSelectedValues($selectLocator, $pattern)
waitForSelectedValues($selectLocator, $pattern)
waitForNotSelectedValues($selectLocator, $pattern)
|
public
an
|
#
storeSelectOptions( selectLocator $selectLocator, variableName $variableName )
Gets all option labels in the specified select drop-down.
Gets all option labels in the specified select drop-down.
Parameters
- $selectLocator
selectLocator an element locator identifying a drop-down menu
- $variableName
variableName the name of a variable in which the result is to be stored.
Returns
an array of all option labels in the specified select drop-down
Since
0.7 Related Assertions: assertSelectOptions($selectLocator, $pattern)
assertNotSelectOptions($selectLocator, $pattern)
verifySelectOptions($selectLocator, $pattern)
verifyNotSelectOptions($selectLocator, $pattern)
waitForSelectOptions($selectLocator, $pattern)
waitForNotSelectOptions($selectLocator, $pattern)
|
public
the
|
#
storeTable( tableCellAddress $tableCellAddress, variableName $variableName )
Gets the text from a cell of a table. The cellAddress syntax
tableLocator.row.column, where row and column start at 0.
Gets the text from a cell of a table. The cellAddress syntax
tableLocator.row.column, where row and column start at 0.
Parameters
- $tableCellAddress
tableCellAddress a cell address, e.g. "foo.1.4"
- $variableName
variableName the name of a variable in which the result is to be stored.
Returns
the text from the specified cell
Since
0.7 Related Assertions: assertTable($tableCellAddress, $pattern)
assertNotTable($tableCellAddress, $pattern) verifyTable($tableCellAddress,
$pattern) verifyNotTable($tableCellAddress, $pattern)
waitForTable($tableCellAddress, $pattern) waitForNotTable($tableCellAddress,
$pattern)
|
public
the
|
#
storeText( locator $locator, variableName $variableName )
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.
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.
Parameters
- $locator
locator an element locator
- $variableName
variableName the name of a variable in which the result is to be stored.
Returns
the text of the element
Since
0.6 Related Assertions: assertText($locator, $pattern) assertNotText($locator,
$pattern) verifyText($locator, $pattern) verifyNotText($locator, $pattern)
waitForText($locator, $pattern) waitForNotText($locator, $pattern)
|
public
the
|
#
storeTitle( mixed $variableName )
Gets the title of the current page.
Gets the title of the current page.
Returns
the title of the current page
Since
0.7 Related Assertions: assertTitle($pattern) assertNotTitle($pattern)
verifyTitle($pattern) verifyNotTitle($pattern) waitForTitle($pattern)
waitForNotTitle($pattern)
|
public
the
|
#
storeValue( locator $locator, variableName $variableName )
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.
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.
Parameters
- $locator
locator an element locator
- $variableName
variableName the name of a variable in which the result is to be stored.
Returns
the element value, or "on/off" for checkbox/radio elements
Since
0.6 Related Assertions: assertValue($locator, $pattern) assertNotValue($locator,
$pattern) verifyValue($locator, $pattern) verifyNotValue($locator, $pattern)
waitForValue($locator, $pattern) waitForNotValue($locator, $pattern)
|
public
true
|
#
storeWhetherThisFrameMatchFrameExpression( currentFrameString $currentFrameString, target $target, variableName $variableName )
Determine whether current/locator identify the frame containing this running
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.
Parameters
- $currentFrameString
currentFrameString starting frame
- $target
target new frame (which might be relative to the current one)
- $variableName
variableName the name of a variable in which the result is to be stored.
Returns
true if the new frame is this code's window
Since
0.8.1 assertWhetherThisFrameMatchFrameExpression($currentFrameString, $target)
assertNotWhetherThisFrameMatchFrameExpression($currentFrameString, $target)
verifyWhetherThisFrameMatchFrameExpression($currentFrameString, $target)
verifyNotWhetherThisFrameMatchFrameExpression($currentFrameString, $target)
waitForWhetherThisFrameMatchFrameExpression($currentFrameString, $target)
waitForWhetherThisFrameMatchFrameExpression($currentFrameString, $target)
|
public
true
|
#
storeWhetherThisWindowMatchWindowExpression( currentWindowString $currentWindowString, target $target, variableName $variableName )
Determine whether currentWindowString plus target identify the window
containing this running 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.
Parameters
- $currentWindowString
currentWindowString starting window
- $target
target new window (which might be relative to the current one, e.g. "_parent")
- $variableName
variableName the name of a variable in which the result is to be stored
Returns
true if the new window is this code's window
Since
0.8.1 assertWhetherThisWindowMatchWindowExpression($currentWindowString,
$target) assertNotWhetherThisWindowMatchWindowExpression($currentWindowString,
$target) verifyWhetherThisWindowMatchWindowExpression($currentWindowString,
$target) verifyNotWhetherThisWindowMatchWindowExpression($currentWindowString,
$target) waitForWhetherThisWindowMatchWindowExpression($currentWindowString,
$target) waitForWhetherThisWindowMatchWindowExpression($currentWindowString,
$target)
|
public
true
|
#
storeAlertPresent( mixed $variableName )
Has an alert occurred? This function never throws an exception
Has an alert occurred? This function never throws an exception
Returns
true if there is an alert
Since
0.7 Related Assertions: assertAlertPresent() assertAlertNotPresent()
verifyAlertPresent() verifyAlertNotPresent() waitForAlertPresent()
waitForAlertNotPresent()
|
public
true
|
#
storeChecked( locator $locator, variableName $variableName )
Gets whether a toggle-button (checkbox/radio) is checked. Fails if the
specified element doesn't exist or isn't a toggle-button.
Gets whether a toggle-button (checkbox/radio) is checked. Fails if the
specified element doesn't exist or isn't a toggle-button.
Parameters
- $locator
locator an element locator pointing to a checkbox or radio button
- $variableName
variableName the name of a variable in which the result is to be stored.
Returns
true if the checkbox is checked, false otherwise
Since
0.7 Related Assertions: assertChecked($locator) assertNotChecked($locator)
verifyChecked($locator) verifyNotChecked($locator) waitForChecked($locator)
waitForNotChecked($locator)
|
public
true
|
#
storeConfirmationPresent( mixed $variableName )
Has confirm() been called? This function never throws an exception
Has confirm() been called? This function never throws an exception
Returns
true if there is a pending confirmation
Since
0.7 Related Assertions: assertConfirmationPresent()
assertConfirmationNotPresent() verifyConfirmationPresent()
verifyConfirmationNotPresent() waitForConfirmationPresent()
waitForConfirmationNotPresent()
|
public
true
|
#
storeEditable( locator $locator, variableName $variableName )
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.
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.
Parameters
- $locator
locator an element locator
- $variableName
variableName the name of a variable in which the result is to be stored.
Returns
true if the input element is editable, false otherwise
Since
0.7 Related Assertions: assertEditable($locator) assertNotEditable($locator)
verifyEditable($locator) verifyNotEditable($locator) waitForEditable($locator)
waitForNotEditable($locator)
|
public
true
|
#
storeElementPresent( locator $locator, variableName $variableName )
Verifies that the specified element is somewhere on the page.
Verifies that the specified element is somewhere on the page.
Parameters
- $locator
locator an element locator
- $variableName
variableName the name of a variable in which the result is to be stored.
Returns
true if the element is present, false otherwise
Since
0.7 Related Assertions: assertElementPresent($locator)
assertElementNotPresent($locator) verifyElementPresent($locator)
verifyElementNotPresent($locator) waitForElementPresent($locator)
waitForElementNotPresent($locator)
|
public
true
|
#
storeOrdered( locator1 $locator1, locator2 $locator2, the $variableName )
Check if these two elements have same parent and are ordered. Two same
elements will not be considered ordered.
Check if these two elements have same parent and are ordered. Two same
elements will not be considered ordered.
Parameters
- $locator1
locator1 an element locator pointing to the first element
- $locator2
locator2 an element locator pointing to the second element
- $variableName
the name of a variable in which the result is to be stored.
Returns
true if two elements are ordered and have same parent, false otherwise
Since
0.8.1 Related Assertions: assertOrdered($locator1, $locator2)
assertNotOrdered($locator1, $locator2) verifyOrdered($locator1, $locator2)
verifyNotOrdered($locator1, $locator2) waitForOrdered($locator1, $locator2)
waitForNotOrdered($locator1, $locator2)
|
public
true
|
#
storePromptPresent( mixed $variableName )
Has a prompt occurred? This function never throws an exception
Has a prompt occurred? This function never throws an exception
Returns
true if there is a pending prompt
Since
0.7 Related Assertions: assertPromptPresent() assertPromptNotPresent()
verifyPromptPresent() verifyPromptNotPresent() waitForPromptPresent()
waitForPromptNotPresent()
|
public
true
|
#
storeSomethingSelected( selectLocator $selectLocator, variableName $variableName )
Determines whether some option in a drop-down menu is selected.
Determines whether some option in a drop-down menu is selected.
Parameters
- $selectLocator
selectLocator an element locator identifying a drop-down menu
- $variableName
variableName the name of a variable in which the result is to be stored
Returns
true if some option has been selected, false otherwise
Since
0.8 Related Assertions: assertSomethingSelected($selectLocator)
assertNotSomethingSelected($selectLocator)
verifySomethingSelected($selectLocator)
verifyNotSomethingSelected($selectLocator)
waitForSomethingSelected($selectLocator)
waitForNotSomethingSelected($selectLocator)
|
public
true
|
#
storeTextPresent( pattern $pattern, variableName $variableName )
Verifies that the specified text pattern appears somewhere on the rendered
page shown to the user.
Verifies that the specified text pattern appears somewhere on the rendered
page shown to the user.
Parameters
- $pattern
pattern a pattern to match with the text of the page
- $variableName
variableName the name of a variable in which the result is to be stored.
Returns
true if the pattern matches the text, false otherwise
Since
0.7 Related Assertions: assertTextPresent($pattern)
assertTextNotPresent($pattern) verifyTextPresent($pattern)
verifyTextNotPresent($pattern) waitForTextPresent($pattern)
waitForTextNotPresent($pattern)
|
public
true
|
#
storeVisible( locator $locator, variableName $variableName )
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.
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.
Parameters
- $locator
locator an element locator
- $variableName
variableName the name of a variable in which the result is to be stored.
Returns
true if the specified element is visible, false otherwise
Since
0.7 Related Assertions: assertVisible($locator) assertNotVisible($locator)
verifyVisible($locator) verifyNotVisible($locator) waitForVisible($locator)
waitForNotVisible($locator)
|
public
|
|
public
|
|
public
|
#
__getRow( mixed $value1, mixed $value2 = ' ', mixed $value3 = ' ' )
|
public
|
|


{{! Blocks out the same height of the header at the end of the page. Useful for centering stuff}} {{#pagination}}


Isaac has been involved in the computer science field since high-school where he and friends entered mathematics and coding competitions. As the head presenter and team organizer of the projects, Isaac and his friends gained titles such as first place at an SDSU programming competition. With these skills established, Isaac took on undergraduate research on Knot Theory at the University of St. Thomas where he learned scripting with Perl, C and creating custom directory trees. He then presented the results of knots under tight confinement at the Joint Mathematics Meeting in San Diego. These experiences add to his classwork knowledge in Java, SQL, C#, and R to supply him with a strong technical background.
Isaac thrives when learning new coding languages and applying knowledge towards projects and competitions. His ability to adapt to a group promotes team synergy to its maximum. When it comes to presenting he has confidence and can convey team objectives clearly.
Chase is a CS student at the University of St. Thomas. He has experience with working in business professional tech roles.
Node, Splunk, Dev-ops, C, IT consulting.
Sqlite3 is great for getting a full functioning database to communicate with a server.
Node allows for easy installation of modules and hosting data on a server.
Pug was made to be a high quality HTML templating engine focusing on introducing space/indentation sensitive syntax for HTML.


Docker Engine¶
Foo…
Installation¶
Install the docker-engine via Docker-provided repositories, the ones provided with Debian are not recommended, so go ahread with the following:
#Ensure old versions are gone
sudo apt-get remove \
docker \
docker-engine \
docker.io \
containerd \
runc
# Install prerequisites
sudo apt-get install \
ca-certificates \
curl \
gnupg \
lsb-release
# Setup docker repos
curl -fsSL https://download.docker.com/linux/debian/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
echo \
"deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/debian \
$(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
sudo apt-get update
# Now install it
sudo apt-get install docker-ce docker-ce-cli containerd.io
Non-root usage¶
We want to be able to run docker as a non-root user, this is achieved by simply adding the non-root user to docker, for example:
sudo usermod -aG docker $USER
Now log out and log back in again, this is to refresh group-membership, then verify that it is working by starting the docker image:
docker run hello-world
Privileged containers¶
…


{{+bindTo:partials.standard_nacl_api}}
| struct PP_Var(* | Create )(uint32_t size_in_bytes) |
| PP_Bool(* | ByteLength )(struct PP_Var array, uint32_t *byte_length) |
| void *(* | Map )(struct PP_Var array) |
| void(* | Unmap )(struct PP_Var array) |
The PPB_VarArrayBuffer
interface provides a way to interact with JavaScript ArrayBuffers, which represent a contiguous sequence of bytes.
Use PPB_Var
to manage the reference count for a VarArrayBuffer
. Note that these Vars are not part of the embedding page's DOM, and can only be shared with JavaScript using the PostMessage
and HandleMessage
functions of pp::Instance
.
| PP_Bool(* PPB_VarArrayBuffer::ByteLength)(struct PP_Var array, uint32_t *byte_length) |
ByteLength() retrieves the length of the VarArrayBuffer
in bytes.
On success, byte_length
is set to the length of the given ArrayBuffer
var. On failure, byte_length
is unchanged (this could happen, for instance, if the given PP_Var
is not of type PP_VARTYPE_ARRAY_BUFFER
). Note that ByteLength() will successfully retrieve the size of an ArrayBuffer
even if the ArrayBuffer
is not currently mapped.
| [in] | array | The ArrayBuffer whose length should be returned. |
| [out] | byte_length | A variable which is set to the length of the given ArrayBuffer on success. |
PP_TRUE
on success, PP_FALSE
on failure. struct PP_Var(* PPB_VarArrayBuffer::Create)(uint32_t size_in_bytes) [read] |
| void*(* PPB_VarArrayBuffer::Map)(struct PP_Var array) |
Map() maps the ArrayBuffer
in to the module's address space and returns a pointer to the beginning of the buffer for the given ArrayBuffer PP_Var
.
ArrayBuffers are copied when transmitted, so changes to the underlying memory are not automatically available to the embedding page.
Note that calling Map() can be a relatively expensive operation. Use care when calling it in performance-critical code. For example, you should call it only once when looping over an ArrayBuffer
.
Example:
char* data = (char*)(array_buffer_if.Map(array_buffer_var)); uint32_t byte_length = 0; PP_Bool ok = array_buffer_if.ByteLength(array_buffer_var, &byte_length); if (!ok) return DoSomethingBecauseMyVarIsNotAnArrayBuffer(); for (uint32_t i = 0; i < byte_length; ++i) data[i] = 'A';
| [in] | array | The ArrayBuffer whose internal buffer should be returned. |
ArrayBuffer
. Returns NULL
if the given PP_Var
is not of type PP_VARTYPE_ARRAY_BUFFER
. | void(* PPB_VarArrayBuffer::Unmap)(struct PP_Var array) |
Unmap() unmaps the given ArrayBuffer
var from the module address space.
Use this if you want to save memory but might want to call Map() to map the buffer again later. The PP_Var
remains valid and should still be released using PPB_Var
when you are done with the ArrayBuffer
.
| [in] | array | The ArrayBuffer to be released. |