Class Selenium2Library

java.lang.Object

org.robotframework.javalib.library.KeywordFactoryBasedLibrary<org.robotframework.javalib.keyword.DocumentedKeyword>

org.robotframework.javalib.library.AnnotationLibrary

Selenium2Library

All Implemented Interfaces:

org.robotframework.javalib.library.KeywordDocumentationRepository, org.robotframework.javalib.library.RobotJavaLibrary

public class Selenium2Library
extends org.robotframework.javalib.library.AnnotationLibrary

Selenium2Library is a web testing library for the Robot Framework and was originally written in Python. This is the Java port of the Selenium 2 (WebDriver) Python library for Robot Framework. It uses the Selenium 2 (WebDriver) libraries internally to control a web browser. See WebDriver for more information on Selenium 2 and WebDriver. It runs tests in a real browser instance and should work with most modern browsers and can be used with the Jython interpreter or any other Java application.

Before running tests
Prior to running test cases using Selenium2Library, the library must be imported into your Robot Framework test suite (see importing section), and the `Open Browser` keyword must be used to open a browser to the desired location.

Locating elements
All keywords in Selenium2Library that need to find an element on the page take an locator argument.

Key attributes
By default, when a locator value is provided, it is matched against the key attributes of the particular element type. The attributes id and name are key attributes to all elements.

List of key attributes:

Element Type	Key Attributes
A	@id,@name,@href,text
IMG	@id,@name,@src,@alt
INPUT	@id,@name,@value,@src
BUTTON	@id,@name,@value,text
*	@id,@name

Example:

Click Element

my_element

Locator strategies
It is also possible to specify the approach Selenium2Library should take to find an element by specifying a locator strategy with a locator prefix.

Supported strategies are:

Strategy	Example	Description
identifier	Click Element | identifier=my_element	Matches by @id or @name attribute
id	Click Element | id=my_element	Matches by @id attribute
name	Click Element | name=my_element	Matches by @name attribute
xpath	Click Element | xpath=//div[@id='my_element']	Matches by arbitrary XPath expression
dom	Click Element | dom=document.images[56]	Matches by arbitrary DOM expression
link	Click Element | link=My Link	Matches by the link text
css	Click Element | css=div.my_class	Matches by CSS selector
jquery	Click Element | jquery=div.my_class	Matches by jQuery/sizzle selector
sizzle	Click Element | sizzle=div.my_class	Matches by jQuery/sizzle selector
tag	Click Element | tag=div	Matches by HTML tag name

Locating tables
Table related keywords, such as `Table Should Contain`, work differently. By default, when a table locator value is provided, it will search for a table with the specified id attribute.

Example:

Table Should Contain

my_table

text

More complex table locator strategies:

Strategy	Example	Description
xpath	Table Should Contain | xpath=//table/[@name="my_table"] | text	Matches by arbitrary XPath expression
css	Table Should Contain | css=table.my_class | text	Matches by CSS selector

Custom location strategies
It is also possible to register custom location strategies. See `Add Location Strategy` for details about custom location strategies.

Example:

Add Location Strategy	custom	return window.document.getElementById(arguments[0]);
Input Text	custom=firstName	Max

Timeouts
There are several Wait ... keywords that take timeout as an argument. All of these timeout arguments are optional. The timeout used by all of them can be set globally using the `Set Selenium Timeout keyword`.

All timeouts can be given as numbers considered seconds (e.g. 0.5 or 42) or in Robot Framework's time syntax (e.g. '1.5 seconds' or '1 min 30 s'). See Time Format for details about the time syntax.

Log Level
There are several keywords that take timeout as an argument. All of these timeout arguments are optional. The default is usually INFO.

List of log levels:

Log Level	Description
DEBUG
INFO
HTML	Same as INFO, but message is in HTML format
TRACE
WARN

Field Summary

Fields

Modifier and Type	Field and Description
protected BrowserManagement	browserManagement Instantiated BrowserManagement keyword bean
protected Cookie	cookie Instantiated Cookie keyword bean
protected Element	element Instantiated Element keyword bean
protected FormElement	formElement Instantiated FormElement keyword bean
static Javadoc2Libdoc	JAVADOC_2_LIBDOC The javadoc to libdoc converter
protected JavaScript	javaScript Instantiated JavaScript keyword bean
static String	KEYWORD_PATTERN The list of keyword patterns for the AnnotationLibrary
protected Logging	logging Instantiated Logging keyword bean
static String	ROBOT_LIBRARY_DOC_FORMAT The library documentation is written in HTML
static String	ROBOT_LIBRARY_SCOPE The scope of this library is global.
static String	ROBOT_LIBRARY_VERSION The actual version of this library.
protected RunOnFailure	runOnFailure Instantiated RunOnFailure keyword bean
protected Screenshot	screenshot Instantiated Screenshot keyword bean
protected SelectElement	selectElement Instantiated SelectElement keyword bean
protected TableElement	tableElement Instantiated TableElement keyword bean
protected Waiting	waiting Instantiated Waiting keyword bean

Fields inherited from class org.robotframework.javalib.library.AnnotationLibrary

beanLoaders, classFilter

Constructor Summary

Constructors

Constructor and Description
Selenium2Library()
Selenium2Library(String timeout)
Selenium2Library(String timeout, String implicitWait)
Selenium2Library(String timeout, String implicitWait, String runOnFailure) Selenium2Library can be imported with optional arguments.

Method Summary

Methods

Modifier and Type	Method and Description
BrowserManagement	getBrowserManagement()
Cookie	getCookie()
Element	getElement()
FormElement	getFormElement()
JavaScript	getJavaScript()
String	getKeywordDocumentation(String keywordName)
static Selenium2Library	getLibraryInstance()
Logging	getLogging()
RunOnFailure	getRunOnFailure()
Screenshot	getScreenshot()
SelectElement	getSelectElement()
TableElement	getTableElement()
Waiting	getWaiting()
Object	runKeyword(String keywordName, Object[] args)
protected Object[]	toStrings(Object[] args) Convert all arguments in the object array to string

Methods inherited from class org.robotframework.javalib.library.AnnotationLibrary

addKeywordPattern, autowireFields, createKeywordFactory, getKeywordArguments

Methods inherited from class org.robotframework.javalib.library.KeywordFactoryBasedLibrary

getClassLoader, getKeywordNames, setClassLoader

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

KEYWORD_PATTERN

public static final String KEYWORD_PATTERN

The list of keyword patterns for the AnnotationLibrary

See Also:

Constant Field Values

JAVADOC_2_LIBDOC

public static final Javadoc2Libdoc JAVADOC_2_LIBDOC

The javadoc to libdoc converter

ROBOT_LIBRARY_DOC_FORMAT

public static final String ROBOT_LIBRARY_DOC_FORMAT

The library documentation is written in HTML

See Also:

Constant Field Values

ROBOT_LIBRARY_SCOPE

public static final String ROBOT_LIBRARY_SCOPE

The scope of this library is global.

See Also:

Constant Field Values

ROBOT_LIBRARY_VERSION

public static final String ROBOT_LIBRARY_VERSION

The actual version of this library. Loaded from maven project.

browserManagement

protected BrowserManagement browserManagement

Instantiated BrowserManagement keyword bean

cookie

protected Cookie cookie

Instantiated Cookie keyword bean

element

protected Element element

Instantiated Element keyword bean

formElement

protected FormElement formElement

Instantiated FormElement keyword bean

javaScript

protected JavaScript javaScript

Instantiated JavaScript keyword bean

logging

protected Logging logging

Instantiated Logging keyword bean

runOnFailure

protected RunOnFailure runOnFailure

Instantiated RunOnFailure keyword bean

screenshot

protected Screenshot screenshot

Instantiated Screenshot keyword bean

selectElement

protected SelectElement selectElement

Instantiated SelectElement keyword bean

tableElement

protected TableElement tableElement

Instantiated TableElement keyword bean

waiting

protected Waiting waiting

Instantiated Waiting keyword bean

Constructor Detail

Selenium2Library

public Selenium2Library()

Selenium2Library

public Selenium2Library(String timeout)

Selenium2Library

public Selenium2Library(String timeout,
                String implicitWait)

Selenium2Library

public Selenium2Library(String timeout,
                String implicitWait,
                String runOnFailure)

Selenium2Library can be imported with optional arguments.

timeout is the default timeout used to wait for all waiting actions. It can be changed later with `Set Selenium Timeout`.

implicitWait is the implicit timeout that Selenium waits, when looking for elements. It can be changed later with `Set Selenium Implicit Wait`. See WebDriver: Advanced Usage of the SeleniumHQ documentation for details about WebDriver's implicit wait functionality.

runOnFailure specifies the name of a keyword (from any available libraries) to execute when a Selenium2Library keyword fails. By default `Capture Page Screenshot` will be used to take a screenshot of the current page. Using the value \"Nothing\" will disable this feature altogether. See `Register Keyword To Run On Failure` keyword for details about this functionality.

Examples:

Library	Selenium2Library
Library	Selenium2Library	15			# Sets timeout to 15 seconds
Library	Selenium2Library	0	5		# Sets timeout to 0 seconds and implicitWait to 5 seconds
Library	Selenium2Library	0	5	Log Source	# Sets timeout to 0 seconds, implicitWait to 5 seconds and runs `Log Source` on failure
Library	Selenium2Library	0	5	Nothing	# Sets timeout to 0 seconds, implicitWait to 5 seconds and does nothing on failure

Parameters:

timeout - Default=5.0. Optional custom timeout.

implicitWait - Default=0.0. Optional custom implicit wait time.

runOnFailure - Default=Capture Page Screenshot. Optional custom keyword to run on failure.

Method Detail

getBrowserManagement

public BrowserManagement getBrowserManagement()

getCookie

public Cookie getCookie()

getElement

public Element getElement()

getFormElement

public FormElement getFormElement()

getJavaScript

public JavaScript getJavaScript()

getLogging

public Logging getLogging()

getRunOnFailure

public RunOnFailure getRunOnFailure()

getScreenshot

public Screenshot getScreenshot()

getSelectElement

public SelectElement getSelectElement()

getTableElement

public TableElement getTableElement()

getWaiting

public Waiting getWaiting()

runKeyword

public Object runKeyword(String keywordName,
                Object[] args)

Specified by:

runKeyword in interface org.robotframework.javalib.library.RobotJavaLibrary

Overrides:

runKeyword in class org.robotframework.javalib.library.AnnotationLibrary

getKeywordDocumentation

public String getKeywordDocumentation(String keywordName)

Specified by:

getKeywordDocumentation in interface org.robotframework.javalib.library.KeywordDocumentationRepository

Overrides:

getKeywordDocumentation in class org.robotframework.javalib.library.AnnotationLibrary

getLibraryInstance

public static Selenium2Library getLibraryInstance()
                                           throws ScriptException

Throws:

ScriptException

toStrings

protected Object[] toStrings(Object[] args)

Convert all arguments in the object array to string