com.github.markusbernhardt.selenium2library.keywords

Class BrowserManagement

java.lang.Object

com.github.markusbernhardt.selenium2library.RunOnFailureKeywordsAdapter

com.github.markusbernhardt.selenium2library.keywords.BrowserManagement

All Implemented Interfaces:

RunOnFailureKeywords

public class BrowserManagement
extends RunOnFailureKeywordsAdapter

Field Summary

Fields

Modifier and Type	Field and Description
protected Element	element Instantiated Element keyword bean
protected double	implicitWait Implicit wait in milliseconds
protected Logging	logging Instantiated Logging keyword bean
String	remoteWebDriverProxyDomain
String	remoteWebDriverProxyHost
String	remoteWebDriverProxyPassword
String	remoteWebDriverProxyPort
String	remoteWebDriverProxyUser
String	remoteWebDriverProxyWorkstation
protected double	timeout Timeout in milliseconds
protected WebDriverCache	webDriverCache Cache for all open browsers.

Constructor Summary

Constructors

Constructor and Description
BrowserManagement()

Method Summary

Modifier and Type	Method and Description
void	addLocationStrategy(String strategyName, String functionDefinition)
void	addLocationStrategy(String strategyName, String functionDefinition, String delimiter) Registers a JavaScript function as locator with the specified strategy name.
void	closeAllBrowsers() Closes all open browser instances and resets the browser cache.
void	closeBrowser() Closes the current browser instance.
void	closeWindow() Closes the currently open pop-up window.
protected org.openqa.selenium.remote.DesiredCapabilities	createDesiredCapabilities(String browserName, String desiredCapabilitiesString, String browserOptions)
protected org.openqa.selenium.WebDriver	createLocalWebDriver(String browserName, org.openqa.selenium.remote.DesiredCapabilities desiredCapabilities)
protected org.openqa.selenium.WebDriver	createRemoteWebDriver(org.openqa.selenium.remote.DesiredCapabilities desiredCapabilities, URL remoteUrl)
protected org.openqa.selenium.WebDriver	createWebDriver(String browserName, String desiredCapabilitiesString, String remoteUrlString, String browserOptions)
org.openqa.selenium.WebDriver	getCurrentWebDriver()
String	getLocation() Returns the current location.
protected String	getPasswordFromURL(URL url)
String	getRemoteCapabilities() Returns the actually supported capabilities of the remote browser instance.
String	getRemoteSessionId() Returns the session id of the remote browser instance.
String	getSeleniumImplicitWait() Returns the implicit wait time in seconds that is used by Selenium.
String	getSeleniumSpeed() (NOT IMPLEMENTED) Returns the delay in seconds that is waited after each Selenium command.
String	getSeleniumTimeout() Returns the timeout in seconds that is used by various keywords.
String	getSource() Returns the entire HTML source of the current page or frame.
String	getSystemInfo() Returns basic system information about the execution environment.
double	getTimeout()
String	getTitle() Returns the title of current page.
protected String	getUserFromURL(URL url)
WebDriverCache	getWebDriverCache()
List<String>	getWindowIdentifiers() Returns the id attributes of all windows known to the current browser instance.
List<String>	getWindowNames() Returns the names of all windows known to the current browser instance.
Object[]	getWindowSize() Returns current window size as width then height.
List<String>	getWindowTitles() Returns the titles of all windows known to the current browser instance.
void	goBack() Simulates the user clicking the "back" button on their browser.
void	goTo(String url) Navigates the active browser instance to the provided URL.
void	locationShouldBe(String url) Verify the current page URL is exactly url.
void	locationShouldContain(String url) Verify the current page URL contains url.
void	maximizeBrowserWindow() Maximizes current browser window.
String	openBrowser(String url)
String	openBrowser(String url, String browserName)
String	openBrowser(String url, String browserName, String alias)
String	openBrowser(String url, String browserName, String alias, String remoteUrl)
String	openBrowser(String url, String browserName, String alias, String remoteUrl, String desiredCapabilities)
String	openBrowser(String url, String browserName, String alias, String remoteUrl, String desiredCapabilities, String browserOptions) Opens a new browser instance to given URL.
protected void	parseBrowserOptionsFirefox(String browserOptions, org.openqa.selenium.remote.DesiredCapabilities desiredCapabilities)
void	reloadPage() Simulates user reloading page.
void	selectFrame(String locator) Selects the frame identified by locator as current frame.
void	selectWindow()
void	selectWindow(String locator) Selects the window identified by locator as the context of actions.
String	setBrowserImplicitWait(String timestr) Sets and returns the implicit wait time in seconds that is used by the current Selenium 2 WebDriver instance.
protected void	setRemoteWebDriverProxy(org.openqa.selenium.remote.HttpCommandExecutor httpCommandExecutor)
void	setRemoteWebDriverProxy(String host, String port)
void	setRemoteWebDriverProxy(String host, String port, String user)
void	setRemoteWebDriverProxy(String host, String port, String user, String password)
void	setRemoteWebDriverProxy(String host, String port, String user, String password, String domain)
void	setRemoteWebDriverProxy(String host, String port, String username, String password, String domain, String workstation) Configures proxy handling for remote WebDriver instances.
String	setSeleniumImplicitWait(String timestr) Sets and returns the implicit wait time in seconds that is used by all Selenium 2 WebDriver instances.
String	setSeleniumSpeed(String timestr) (NOT IMPLEMENTED) Sets and returns the delay in seconds that is waited after each Selenium command.
String	setSeleniumTimeout(String timestr) Sets and returns the timeout in seconds that is used by various keywords.
void	setWindowSize(String width, String height) Sets the width and height of the current window to the specified values.
void	switchBrowser(String indexOrAlias) "Switches between active browser instances using an index or an alias.
void	titleShouldBe(String title) Verify the current page title is exactly title.
void	titleShouldContain(String title) Verify the current page title contains title.
void	titleShouldNotBe(String title) Verify the current page title is not exactly title.
void	titleShouldNotContain(String title) Verify the current page title does not contain title.
protected List<String>	toList(List<String> items)
protected List<String>	toList(List<String> items, String what)
void	unselectFrame() Selects the top frame as the current frame.

Methods inherited from class com.github.markusbernhardt.selenium2library.RunOnFailureKeywordsAdapter

runOnFailureByAspectJ

Methods inherited from class java.lang.Object

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

Field Detail

remoteWebDriverProxyHost

public String remoteWebDriverProxyHost

remoteWebDriverProxyPort

public String remoteWebDriverProxyPort

remoteWebDriverProxyUser

public String remoteWebDriverProxyUser

remoteWebDriverProxyPassword

public String remoteWebDriverProxyPassword

remoteWebDriverProxyDomain

public String remoteWebDriverProxyDomain

remoteWebDriverProxyWorkstation

public String remoteWebDriverProxyWorkstation

webDriverCache

protected WebDriverCache webDriverCache

Cache for all open browsers.

timeout

protected double timeout

Timeout in milliseconds

implicitWait

protected double implicitWait

Implicit wait in milliseconds

logging

protected Logging logging

Instantiated Logging keyword bean

element

protected Element element

Instantiated Element keyword bean

Constructor Detail

BrowserManagement

public BrowserManagement()

Method Detail

getWebDriverCache

public WebDriverCache getWebDriverCache()

getCurrentWebDriver

public org.openqa.selenium.WebDriver getCurrentWebDriver()

getTimeout

public double getTimeout()

addLocationStrategy

public void addLocationStrategy(String strategyName,
                                String functionDefinition)

addLocationStrategy

public void addLocationStrategy(String strategyName,
                                String functionDefinition,
                                String delimiter)

Registers a JavaScript function as locator with the specified strategy name.

The registered function has to return a WebElement, a List of WebElements or null. Optionally a delimiter can be given to split the value of the locator in multiple arguments when executing the JavaScript function.

Example:

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

Example with delimiter:

Add Location Strategy	byClassname	return window.document.getElementsByClassName(arguments[0])[arguments[1]];	,
Input Text	byClassname=input,3	Max

Parameters:

strategyName - Name of the location strategy.

functionDefinition - The JavaScript function to register.

delimiter - Default=NONE. The delimiter to split the given locator value

closeBrowser

public void closeBrowser()

Closes the current browser instance.

See Also:

closeAllBrowsers(), openBrowser(java.lang.String), switchBrowser(java.lang.String)

openBrowser

public String openBrowser(String url)
                   throws Throwable

Throws:

Throwable

openBrowser

public String openBrowser(String url,
                          String browserName)
                   throws Throwable

Throws:

Throwable

openBrowser

public String openBrowser(String url,
                          String browserName,
                          String alias)
                   throws Throwable

Throws:

Throwable

openBrowser

public String openBrowser(String url,
                          String browserName,
                          String alias,
                          String remoteUrl)
                   throws Throwable

Throws:

Throwable

openBrowser

public String openBrowser(String url,
                          String browserName,
                          String alias,
                          String remoteUrl,
                          String desiredCapabilities)
                   throws Throwable

Throws:

Throwable

openBrowser

public String openBrowser(String url,
                          String browserName,
                          String alias,
                          String remoteUrl,
                          String desiredCapabilities,
                          String browserOptions)
                   throws Throwable

Opens a new browser instance to given URL.

Possible values for browser are as follows:

firefox	FireFox
ff	FireFox
internetexplorer	Internet Explorer
ie	Internet Explorer
googlechrome	Google Chrome
gc	Google Chrome
chrome	Google Chrome
opera	Opera
phantomjs	PhantomJS
htmlunitwithjs	HTMLUnit with Javascipt support
safari	Safari
ipad	iPad
iphone	iPhone
android	Android
htmlunit	HTMLUnit

Returns the index of the newly created browser instance which can be used later to switch back to it. Index starts from 1 and is reset back to it when the `Close All Browsers` keyword is used.

DesiredCapabilities
The DesiredCapabilities can be specified in a simple key:value format or as a JSON object. With the JSON format more complex parameters, like the proxy, can be configured.

Example of desiredCapabilities as simple string:

platform:Windows 8,browserName:firefox,version:25

Example of desiredCapabilities as JSON object:

{  "platform":"Windows 8",  "browserName":"firefox",  "version":"25",  "proxy":  {   "proxyType":"manual",   "httpProxy":"localhost:8118"  } }

BrowserOptions
The BrowserOptions can be specified as JSON object to set more complex browser specific parameters. At the moment only the following browsers with the listed options are implemented.

Firefox:

{  "preferences":  {   "extensions.firebug.currentVersion":"1.8.1",   "extensions.firebug.addonBarOpened":true,   "extensions.firebug.enableSites":true  }  "extensions":  [   "firebug-1.8.1.xpi",   "modify_headers-0.7.1.1-fx.xpi"  ] }

Internet Explorer
Note, that you will encounter strange behavior, if you open multiple Internet Explorer browser instances. That is also why `Switch Browser` only works with one IE browser at most. For more information see: Strange errors with multiple IE instances

Parameters:

url - The URL to open in the newly created browser instance.

browserName - Default=firefox. Optional name of the browser to start.

alias - Default=NONE. Optional alias for the newly created browser instance. The alias can be used later for switching between browsers instances, just as returned index.

remoteUrl - Default=False. Optional remote grid URL. When specified no local WebDriver instance is created, but a network connection to a Selenium 2 WebDriver Grid Hub at the given URL is opened.

desiredCapabilities - Default=NONE. Optional desired capabilities of the newly created remote browser instances can be specified in a simple key1:val1,key2:val2 format or as a JSON object (see examples above). Used to communicate to the remote grid, which kind of browser, etc. should be used. For more information see: DesiredCapabilities

browserOptions - Default=NONE. Extended browser options as JSON structure.

Returns:

The index of the newly created browser instance.

Throws:

Throwable - - if anything goes wrong

See Also:

closeAllBrowsers(), closeBrowser(), switchBrowser(java.lang.String)

switchBrowser

public void switchBrowser(String indexOrAlias)

"Switches between active browser instances using an index or an alias.

The index is returned from `Open Browser` and an alias can be given to it.

Example:

Open Browser	http://google.com	ff
Location Should Be	http://google.com
Open Browser	http://yahoo.com	ie	2nd conn
Location Should Be	http://yahoo.com
Switch Browser	1	# index
Page Should Contain	I'm feeling lucky
Switch Browser	2nd conn	# alias
Page Should Contain	More Yahoo!
Close All Browsers

The above example expects that there was no other open browsers when opening the first one because it used index '1' when switching to it later. If you aren't sure about that you can store the index into a variable as below.

${id} =	Open Browser	http://google.com
# Do something ...
Switch Browser	${id}

Parameters:

indexOrAlias - the index or alias of the browser instance to switch to

See Also:

closeAllBrowsers(), closeBrowser(), openBrowser(java.lang.String)

closeAllBrowsers

public void closeAllBrowsers()

Closes all open browser instances and resets the browser cache.

After this keyword new indexes returned from `Open Browser` keyword are reset to 1. This keyword should be used in test or suite teardown to make sure all browsers are closed.

See Also:

closeBrowser(), openBrowser(java.lang.String), switchBrowser(java.lang.String)

closeWindow

public void closeWindow()

Closes the currently open pop-up window.

getWindowIdentifiers

public List<String> getWindowIdentifiers()

Returns the id attributes of all windows known to the current browser instance.

Returns:

List of window id attributes

See Also:

Logging.logWindowIdentifiers()

getWindowNames

public List<String> getWindowNames()

Returns the names of all windows known to the current browser instance.

Returns:

List of window names

See Also:

Logging.logWindowNames()

getWindowTitles

public List<String> getWindowTitles()

Returns the titles of all windows known to the current browser instance.

Returns:

List of window titles

See Also:

Logging.logWindowTitles()

maximizeBrowserWindow

public void maximizeBrowserWindow()

Maximizes current browser window.

getWindowSize

public Object[] getWindowSize()

Returns current window size as width then height.

Example:

${width}

${height}=

Get Window Size

Returns:

The window width and height in px.

setWindowSize

public void setWindowSize(String width,
                          String height)

Sets the width and height of the current window to the specified values.

Example:

Set Window Size	800	600
${width}	${height}=	Get Window Size
Should Be Equal	${width}	800
Should Be Equal	${height}	600

Parameters:

width - The window width to set in px.

height - The window height to set in px.

selectFrame

public void selectFrame(String locator)

Selects the frame identified by locator as current frame.

Key attributes for frames are id and name. See `Introduction` for details about locators.

Parameters:

locator - The locator to locate the frame

selectWindow

public void selectWindow()

selectWindow

public void selectWindow(String locator)

Selects the window identified by locator as the context of actions.

If the window is found, all subsequent commands use that window, until this keyword is used again. If the window is not found, this keyword fails.

By default, when a locator value is provided, it is matched against the title of the window and the javascript name of the window. If multiple windows with same identifier are found, the first one is selected.

The special locator main (default) can be used to select the main window.

Example:

Click Link	popup_link	# opens new window
Select Window	popupName
Title Should Be	Popup Title
Select Window		# Chooses the main window again

It is also possible to specify the approach Selenium2Library should take to find a window by specifying a locator strategy. See `Introduction` for details about locators:

Strategy	Example	Description
title	Select Window | title=My Document	Matches by window title
name	Select Window | name=${name}	Matches by window javascript name
url	Select Window | url=http://google.com	Matches by window's current URL

Parameters:

locator - The locator to locate the window

unselectFrame

public void unselectFrame()

Selects the top frame as the current frame.

getLocation

public String getLocation()

Returns the current location.

Returns:

The current location.

See Also:

Logging.logLocation()

getSource

public String getSource()

Returns the entire HTML source of the current page or frame.

Returns:

The HTML source.

See Also:

Logging.logSource()

getTitle

public String getTitle()

Returns the title of current page.

Returns:

The title.

See Also:

Logging.logTitle()

getRemoteCapabilities

public String getRemoteCapabilities()

Returns the actually supported capabilities of the remote browser instance.

Not all server implementations will support every WebDriver feature. Therefore, the client and server should use JSON objects with the properties listed below when describing which features a user requests that a session support. If a session cannot support a capability that is requested in the desired capabilities, no error is thrown; a read-only capabilities object is returned that indicates the capabilities the session actually supports. For more information see: DesiredCapabilities

Returns:

The capabilities of the remote node.

See Also:

Logging.logRemoteCapabilities()

getRemoteSessionId

public String getRemoteSessionId()

Returns the session id of the remote browser instance.

Returns:

The remote session id.

See Also:

Logging.logRemoteSessionId()

getSystemInfo

public String getSystemInfo()

Returns basic system information about the execution environment.

Returns:

System information.

See Also:

Logging.logSystemInfo()

locationShouldBe

public void locationShouldBe(String url)

Verify the current page URL is exactly url.

Parameters:

url - The URL to verify.

See Also:

locationShouldContain(java.lang.String)

locationShouldContain

public void locationShouldContain(String url)

Verify the current page URL contains url.

Parameters:

url - The URL to verify.

See Also:

locationShouldBe(java.lang.String)

titleShouldBe

public void titleShouldBe(String title)

Verify the current page title is exactly title.

Parameters:

title - The title to verify.

See Also:

titleShouldNotBe(java.lang.String), titleShouldContain(java.lang.String), titleShouldNotContain(java.lang.String)

titleShouldNotBe

public void titleShouldNotBe(String title)

Verify the current page title is not exactly title.

Parameters:

title - The title to verify.

See Also:

titleShouldBe(java.lang.String), titleShouldContain(java.lang.String), titleShouldNotContain(java.lang.String)

titleShouldContain

public void titleShouldContain(String title)

Verify the current page title contains title.

Parameters:

title - The title to verify.

See Also:

titleShouldBe(java.lang.String), titleShouldNotBe(java.lang.String), titleShouldNotContain(java.lang.String)

titleShouldNotContain

public void titleShouldNotContain(String title)

Verify the current page title does not contain title.

Parameters:

title - The title to verify.

See Also:

titleShouldBe(java.lang.String), titleShouldNotBe(java.lang.String), titleShouldContain(java.lang.String)

goBack

public void goBack()

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

goTo

public void goTo(String url)

Navigates the active browser instance to the provided URL.

Parameters:

url - The URL to open.

reloadPage

public void reloadPage()

Simulates user reloading page.

getSeleniumSpeed

public String getSeleniumSpeed()

(NOT IMPLEMENTED) Returns the delay in seconds that is waited after each Selenium command.

Returns:

The delay in seconds.

See Also:

setSeleniumSpeed(java.lang.String)

setSeleniumSpeed

public String setSeleniumSpeed(String timestr)

(NOT IMPLEMENTED) Sets and returns the delay in seconds that is waited after each Selenium command.

Parameters:

timestr - The delay in seconds.

Returns:

The previous delay in seconds.

See Also:

getSeleniumSpeed()

getSeleniumTimeout

public String getSeleniumTimeout()

Returns the timeout in seconds that is used by various keywords.

Returns:

The timeout in seconds.

See Also:

setSeleniumTimeout(java.lang.String)

setSeleniumTimeout

public String setSeleniumTimeout(String timestr)

Sets and returns the timeout in seconds that is used by various keywords.

There are several Wait ... keywords that take a timeout as an argument. All of these timeout arguments are optional. The timeout used by all of them can be set globally using this keyword. See `Introduction` for more information about timeouts.

The previous timeout value is returned by this keyword and can be used to set the old value back later. The default timeout is 5 seconds, but it can be altered in importing the library.

Example:

${orig timeout} =	Set Selenium Timeout	15 seconds
# Open page that loads slowly
Set Selenium Timeout	${orig timeout}	# Reset to old value

Parameters:

timestr - The timeout in seconds.

Returns:

The previous timeout in seconds.

See Also:

getSeleniumTimeout()

getSeleniumImplicitWait

public String getSeleniumImplicitWait()

Returns the implicit wait time in seconds that is used by Selenium.

Returns:

The implicit wait time in seconds.

See Also:

setSeleniumImplicitWait(java.lang.String)

setSeleniumImplicitWait

public String setSeleniumImplicitWait(String timestr)

Sets and returns the implicit wait time in seconds that is used by all Selenium 2 WebDriver instances. This affects all currently open and from now on opened instances.

From selenium 2 function: Sets a sticky timeout to implicitly wait for an element to be found, or a command to complete. This method only needs to be called one time per session.

Example:

${orig wait} =	Set Selenium Implicit Wait	10 seconds
# Perform AJAX call that is slow
Set Selenium Implicit Wait	${orig wait}	# Reset to old value

Parameters:

timestr - The implicit wait time in seconds.

Returns:

The previous implicit wait time in seconds.

See Also:

setBrowserImplicitWait(java.lang.String), getSeleniumImplicitWait()

setBrowserImplicitWait

public String setBrowserImplicitWait(String timestr)

Sets and returns the implicit wait time in seconds that is used by the current Selenium 2 WebDriver instance.

From selenium 2 function: Sets a sticky timeout to implicitly wait for an element to be found, or a command to complete. This method only needs to be called one time per session.

Example:

${orig wait} =	Set Browser Implicit Wait	10 seconds
# Perform AJAX call that is slow
Set Browser Implicit Wait	${orig wait}	# Reset to old value

Parameters:

timestr - The implicit wait time in seconds.

Returns:

The previous implicit wait time in seconds.

See Also:

setSeleniumImplicitWait(java.lang.String)

setRemoteWebDriverProxy

public void setRemoteWebDriverProxy(String host,
                                    String port)

setRemoteWebDriverProxy

public void setRemoteWebDriverProxy(String host,
                                    String port,
                                    String user)

setRemoteWebDriverProxy

public void setRemoteWebDriverProxy(String host,
                                    String port,
                                    String user,
                                    String password)

setRemoteWebDriverProxy

public void setRemoteWebDriverProxy(String host,
                                    String port,
                                    String user,
                                    String password,
                                    String domain)

setRemoteWebDriverProxy

public void setRemoteWebDriverProxy(String host,
                                    String port,
                                    String username,
                                    String password,
                                    String domain,
                                    String workstation)

Configures proxy handling for remote WebDriver instances.

This is needed to connect to an external Selenium 2 WebDriver rid through a local HTTP proxy. This implementation handles BASIC, DIGEST and NTLM based authentication schemes correctly.

The given configuration will be used for all subsequent calls of `Open Browser`. To remove the proxy call:
Set Remote Web Driver Proxy | ${EMPTY} | ${EMPTY}

Some additional info:

• If no username is provided, it looks for a username at the Java property http.proxyUser and the environment variables HTTP_PROXY and http_proxy. If a username is found, it is only used, if the host and port also match.
• If no password is provided, it looks for a password at the Java property http.proxyUser and the environment variables HTTP_PROXY and http_proxy. If a password is found, it is only used, if the host, port and username also match.
• If a domain is provided, NTLM based authentication is used
• If no workstation is provided and NTLM based authentication is used, the hostname is used as workstation name.

Parameters:

host - The hostname of the proxy

port - The port of the proxy

username - Default=NONE. The usename

password - Default=NONE. The password of the user

domain - Default=NONE. The NTLM domain name

workstation - Default=NONE. The name of the workstation

getUserFromURL

protected String getUserFromURL(URL url)

getPasswordFromURL

protected String getPasswordFromURL(URL url)

createWebDriver

protected org.openqa.selenium.WebDriver createWebDriver(String browserName,
                                                        String desiredCapabilitiesString,
                                                        String remoteUrlString,
                                                        String browserOptions)
                                                 throws MalformedURLException

Throws:

MalformedURLException

createLocalWebDriver

protected org.openqa.selenium.WebDriver createLocalWebDriver(String browserName,
                                                             org.openqa.selenium.remote.DesiredCapabilities desiredCapabilities)

createRemoteWebDriver

protected org.openqa.selenium.WebDriver createRemoteWebDriver(org.openqa.selenium.remote.DesiredCapabilities desiredCapabilities,
                                                              URL remoteUrl)

createDesiredCapabilities

protected org.openqa.selenium.remote.DesiredCapabilities createDesiredCapabilities(String browserName,
                                                                                   String desiredCapabilitiesString,
                                                                                   String browserOptions)

parseBrowserOptionsFirefox

protected void parseBrowserOptionsFirefox(String browserOptions,
                                          org.openqa.selenium.remote.DesiredCapabilities desiredCapabilities)

setRemoteWebDriverProxy

protected void setRemoteWebDriverProxy(org.openqa.selenium.remote.HttpCommandExecutor httpCommandExecutor)

toList

protected List<String> toList(List<String> items)

toList

protected List<String> toList(List<String> items,
                              String what)