Selenium2Library 英文api

最新推荐文章于 2023-02-06 11:37:54 发布

超级大neo

最新推荐文章于 2023-02-06 11:37:54 发布

阅读量1.9k

点赞数 1

分类专栏： Selenium2Library 文章标签： RobotFramework Selenium2Library

本文链接：https://blog.csdn.net/xyh421/article/details/53432572

版权

Selenium2Library 专栏收录该内容

5 篇文章 0 订阅

订阅专栏

Opening library documentation failed

Verify that you have JavaScript enabled in your browser.
Make sure you are using a modern enough browser. Firefox 3.5, IE 8, or equivalent is required, newer browsers are recommended.
Check are there messages in your browser's JavaScript error log. Please report the problem if you suspect you have encountered a bug.

Selenium2Library

Library version:	1.8.0
Library scope:	global
Named arguments:	supported

Introduction

Selenium2Library is a web testing library for Robot Framework.

It uses the Selenium 2 (WebDriver) libraries internally to control a web browser. Seehttp://seleniumhq.org/docs/03_webdriver.html for more information on Selenium 2 and WebDriver.

Selenium2Library runs tests in a real browser instance. It should work in most modern browsers and can be used with both Python and Jython interpreters.

Before running tests

Prior to running test cases using Selenium2Library, Selenium2Library must be imported into your Robot test suite (seeimporting section), and the Open Browser keyword must be used to open a browser to the desired location.

--- Note important change starting with Version 1.7.0 release ---

Locating or specifying elements

All keywords in Selenium2Library that need to find an element on the page take an argument, either alocator or now a webelement. locator is a string that describes how to locate an element using a syntax specifying different location strategies.webelement is a variable that holds a WebElement instance, which is a representation of the element.

Using locators

By default, when a locator value is provided, it is matched against the key attributes of the particular element type. For example,id and name are key attributes to all elements, and locating elements is easy using just theid as a locator. For example:

Click Element    my_element

It is also possible to specify the approach Selenium2Library should take to find an element by specifying a lookup 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 with arbitrary XPath expression
dom	Click Element \| dom=document.images[56]	Matches with arbitrary DOM express
link	Click Element \| link=My Link	Matches anchor elements by their link text
partial link	Click Element \| partial link=y Lin	Matches anchor elements by their partial 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
default*	Click Link \| default=page?a=b	Matches key attributes with value after first '='

* Explicitly specifying the default strategy is only necessary if locating elements by matching key attributes is desired and an attribute value contains a '='. The following would fail because it appears as ifpage?a is the specified lookup strategy:

Click Link    page?a=b

This can be fixed by changing the locator to:

Click Link    default=page?a=b

Using webelements

Starting with version 1.7 of the Selenium2Library, one can pass an argument that contains a WebElement instead of a string locator. To get a WebElement, use the newGet WebElements keyword. For example:

${elem} =	Get WebElement	id=my_element
Click Element	${elem}

Locating Tables, Table Rows, Columns, etc.

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 specifiedid attribute. For example:

Table Should Contain    my_table    text

More complex table lookup strategies are also supported:

Strategy	Example	Description
css	Table Should Contain \| css=table.my_class \| text	Matches by @id or @name attribute
xpath	Table Should Contain \| xpath=//table/[@name="my_table"]\| text	Matches by @id or @name attribute

Custom Locators

If more complex lookups are required than what is provided through the default locators, custom lookup strategies can be created. Using custom locators is a two part process. First, create a keyword that returns the WebElement that should be acted on.

Custom Locator Strategy	[Arguments]	${browser}	${criteria}	${tag}	${constraints}
	${retVal}=	Execute Javascript	return window.document.getElementById('${criteria}');
	[Return]	${retVal}

This keyword is a reimplementation of the basic functionality of the id locator where ${browser} is a reference to the WebDriver instance and${criteria} is the text of the locator (i.e. everything that comes after the = sign). To use this locator it must first be registered withAdd Location Strategy.

Add Location Strategy    custom    Custom Locator Strategy

The first argument of Add Location Strategy specifies the name of the lookup strategy (which must be unique). After registration of the lookup strategy, the usage is the same as other locators. SeeAdd Location Strategy for more details.

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 theSet Selenium Timeout keyword. The same timeout also applies to Execute Async Javascript.

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'). For more information about the time syntax see:http://robotframework.googlecode.com/svn/trunk/doc/userguide/RobotFrameworkUserGuide.html#time-format.

Importing

Arguments

Documentation

timeout=5.0, implicit_wait=0.0, run_on_failure=Capture Page Screenshot, screenshot_root_directory=None

Selenium2Library can be imported with optional arguments.

timeout is the default timeout used to wait for all waiting actions. It can be later set withSet Selenium Timeout.

'implicit_wait' is the implicit timeout that Selenium waits when looking for elements. It can be later set withSet Selenium Implicit Wait. See WebDriver: Advanced Usage__ section of the SeleniumHQ documentation for more information about WebDriver's implicit wait functionality.

__ http://seleniumhq.org/docs/04_webdriver_advanced.html#explicit-and-implicit-waits

run_on_failure specifies the name of a keyword (from any available libraries) to execute when a Selenium2Library keyword fails. By defaultCapture Page Screenshot will be used to take a screenshot of the current page. Using the value "Nothing" will disable this feature altogether. SeeRegister Keyword To Run On Failure keyword for more information about this functionality.

screenshot_root_directory specifies the default root directory that screenshots should be stored in. If not provided the default directory will be where robotframework places its logfile.

Examples:

Library \| Selenium2Library \| 15	# Sets default timeout to 15 seconds
Library \| Selenium2Library \| 0\| 5	# Sets default timeout to 0 seconds and default implicit_wait to 5 seconds
Library \| Selenium2Library \| 5\| run_on_failure=Log Source	# Sets default timeout to 5 seconds and runs Log Source on failure
Library \| Selenium2Library \| implicit_wait=5\| run_on_failure=Log Source	# Sets default implicit_wait to 5 seconds and runs Log Source on failure
Library \| Selenium2Library \| timeout=10\| run_on_failure=Nothing	# Sets default timeout to 10 seconds and does nothing on failure

Shortcuts

Keywords

Keyword Arguments Documentation

Add Cookie

name, value, path=None, domain=None, secure=None, expiry=None

Adds a cookie to your current session. "name" and "value" are required, "path", "domain" and "secure" are optional

Add Location Strategy

strategy_name, strategy_keyword, persist=False

Adds a custom location strategy based on a user keyword. Location strategies are automatically removed after leaving the current scope by default. Settingpersist to any non-empty string will cause the location strategy to stay registered throughout the life of the test.

Trying to add a custom location strategy with the same name as one that already exists will cause the keyword to fail.

Custom locator keyword example:

Custom Locator Strategy	[Arguments]	${browser}	${criteria}	${tag}	${constraints}
	${retVal}=	Execute Javascript	return window.document.getElementById('${criteria}');
	[Return]	${retVal}

Usage example:

Add Location Strategy	custom	Custom Locator Strategy
Page Should Contain Element	custom=my_id

See Remove Location Strategy for details about removing a custom location strategy.

Alert Should Be Present

text=

Verifies an alert is present and dismisses it.

If text is a non-empty string, then it is also verified that the message of the alert equals totext.

Will fail if no alert is present. Note that following keywords will fail unless the alert is dismissed by this keyword or another likeGet Alert Message.

Assign Id To Element

locator, id

Assigns a temporary identifier to element specified by locator.

This is mainly useful if the locator is complicated/slow XPath expression. Identifier expires when the page is reloaded.

Example:

Assign ID to Element	xpath=//div[@id="first_div"]	my id
Page Should Contain Element	my id

Capture Page Screenshot

filename=selenium-screenshot-{index}.png

Takes a screenshot of the current page and embeds it into the log.

filename argument specifies the name of the file to write the screenshot into. If nofilename is given, the screenshot is saved into file selenium-screenshot-{index}.png under the directory where the Robot Framework log file is written into. Thefilename is also considered relative to the same directory, if it is not given in absolute format. If an absolute or relative path is given but the path does not exist it will be created.

Starting from Selenium2Library 1.8 if filename contains {index} characters, it will be automatically replaced with running index. The running index is unique for each different filename. The absolute path of the saved screenshot is always returned and it does not depend does the filename contain {index}. See example 1 and 2 for more details.

The {index} is replaced with the actual index by using Python's str.format method, and it can be formatted using the standard format string syntax. The example 3 shows this by setting the width and the fill character.

If there is a need to write literal {index} or if filename contains{ or } characters, then the braces must be doubled.

Example 1:

${file1} =	Capture Page Screenshot
File Should Exist	${OUTPUTDIR}${/}selenium-screenshot-1.png
Should Be Equal	${file1}	${OUTPUTDIR}${/}selenium-screenshot-1.png
${file2} =	Capture Page Screenshot
File Should Exist	${OUTPUTDIR}${/}selenium-screenshot-2.png
Should Be Equal	${file2}	${OUTPUTDIR}${/}selenium-screenshot-2.png

Example 2:

${file1} =	Capture Page Screenshot	${OTHER_DIR}${/}other-{index}-name.png
${file2} =	Capture Page Screenshot	${OTHER_DIR}${/}some-other-name-{index}.png
${file3} =	Capture Page Screenshot	${OTHER_DIR}${/}other-{index}-name.png
File Should Exist	${OTHER_DIR}${/}other-1-name.png
Should Be Equal	${file1}	${OTHER_DIR}${/}other-1-name.png
File Should Exist	${OTHER_DIR}${/}some-other-name-1.png
Should Be Equal	${file2}	${OTHER_DIR}${/}some-other-name-1.png
File Should Exist	${OTHER_DIR}${/}other-2-name.png
Should Be Equal	${file3}	${OTHER_DIR}${/}other-2-name.png

Example 3:

Capture Page Screenshot	${OTHER_DIR}${/}sc-{index:06}.png
File Should Exist	${OTHER_DIR}${/}sc-000001.png

Checkbox Should Be Selected

locator

Verifies checkbox identified by locator is selected/checked.

Key attributes for checkboxes are id and name. See introduction for details about locating elements.

Checkbox Should Not Be Selected

locator

Verifies checkbox identified by locator is not selected/checked.

Key attributes for checkboxes are id and name. See introduction for details about locating elements.

Choose Cancel On Next Confirmation

Cancel will be selected the next time Confirm Action is used.

Choose File

locator, file_path

Inputs the file_path into file input field found by locator.

This keyword is most often used to input files into upload forms. The file specified withfile_path must be available on the same host where the Selenium Server is running.

Example:

Choose File

my_upload_field

/home/user/files/trades.csv

Choose Ok On Next Confirmation

Undo the effect of using keywords Choose Cancel On Next Confirmation. Note that Selenium's overridden window.confirm() function will normally automatically return true, as if the user had manually clicked OK, so you shouldn't need to use this command unless for some reason you need to change your mind prior to the next confirmation. After any confirmation, Selenium will resume using the default behavior for future confirmations, automatically returning true (OK) unless/until you explicitly useChoose Cancel On Next Confirmation for each confirmation.

Note that every time a confirmation comes up, you must consume it by using a keywords such asGet Alert Message, or else the following selenium operations will fail.

Clear Element Text

locator

Clears the text value of text entry element identified by locator.

See introduction for details about locating elements.

Click Button

locator

Clicks a button identified by locator.

Key attributes for buttons are id, name and value. See introduction for details about locating elements.

Click Element

locator

Click element identified by locator.

Key attributes for arbitrary elements are id and name. See introduction for details about locating elements.

Click Element At Coordinates

locator, xoffset, yoffset

Click element identified by locator at x/y coordinates of the element. Cursor is moved and the center of the element and x/y coordinates are calculted from that point.

Key attributes for arbitrary elements are id and name. See introduction for details about locating elements.

Click Image

locator

Clicks an image found by locator.

Key attributes for images are id, src and alt. See introduction for details about locating elements.

Click Link

locator

Clicks a link identified by locator.

Key attributes for links are id, name, href and link text. See introduction for details about locating elements.

Close All Browsers

Closes all open browsers 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.

Close Browser

Closes the current browser.

Close Window

Closes currently opened pop-up window.

Confirm Action

Dismisses currently shown confirmation dialog and returns it's message.

By default, this keyword chooses 'OK' option from the dialog. If 'Cancel' needs to be chosen, keywordChoose Cancel On Next Confirmation must be called before the action that causes the confirmation dialog to be shown.

Examples:

Click Button	Send	# Shows a confirmation dialog
${message}=	Confirm Action	# Chooses Ok
Should Be Equal	${message}	Are your sure?

Choose Cancel On Next Confirmation
Click Button	Send	# Shows a confirmation dialog
Confirm Action		# Chooses Cancel

Create Webdriver

driver_name, alias=None, kwargs={}, **init_kwargs

Creates an instance of a WebDriver.

Like Open Browser, but allows passing arguments to a WebDriver's __init__. Open Browser is preferred overCreate Webdriver when feasible.

Returns the index of this browser instance which can be used later to switch back to it. Index starts from 1 and is reset back to it whenClose All Browsers keyword is used. See Switch Browser for example.

driver_name must be the exact name of a WebDriver inselenium.webdriver to use. WebDriver names include: Firefox, Chrome, Ie, Opera, Safari, PhantomJS, and Remote.

Use keyword arguments to specify the arguments you want to pass to the WebDriver's __init__. The values of the arguments are not processed in any way before being passed on. For Robot Framework < 2.8, which does not support keyword arguments, create a keyword dictionary and pass it in as argument kwargs. See the Selenium API Documentation for information about argument names and appropriate argument values.

Examples:

# use proxy for Firefox
${proxy}=	Evaluate	sys.modules['selenium.webdriver'].Proxy()	sys, selenium.webdriver
${proxy.http_proxy}=	Set Variable	localhost:8888
Create Webdriver	Firefox	proxy=${proxy}
# use a proxy for PhantomJS
${service args}=	Create List	--proxy=192.168.132.104:8888
Create Webdriver	PhantomJS	service_args=${service args}

Example for Robot Framework < 2.8:

# debug IE driver
${kwargs}=	Create Dictionary	log_level=DEBUG	log_file=%{HOMEPATH}${/}ie.log
Create Webdriver	Ie	kwargs=${kwargs}

Current Frame Contains

text, loglevel=INFO

Verifies that current frame contains text.

See Page Should Contain for explanation about loglevel argument.

Current Frame Should Not Contain

text, loglevel=INFO

Verifies that current frame contains text.

See Page Should Contain for explanation about loglevel argument.

Delete All Cookies

Deletes all cookies.

Delete Cookie

name

Deletes cookie matching name.

If the cookie is not found, nothing happens.

Dismiss Alert

accept=True

Returns true if alert was confirmed, false if it was dismissed

This keyword will fail if no alert is present. Note that following keywords will fail unless the alert is dismissed by this keyword or another likeGet Alert Message.

Double Click Element

locator

Double click element identified by locator.

Key attributes for arbitrary elements are id and name. See introduction for details about locating elements.

Drag And Drop

source, target

Drags element identified with source which is a locator.

Element can be moved on top of another element with target argument.

target is a locator of the element where the dragged object is dropped.

Examples:

Drag And Drop

elem1

elem2

# Move elem1 over elem2.

Drag And Drop By Offset

source, xoffset, yoffset

Drags element identified with source which is a locator.

Element will be moved by xoffset and yoffset, each of which is a negative or positive number specify the offset.

Examples:

Drag And Drop By Offset

myElem

-35

# Move myElem 50px right and 35px down.

Element Should Be Disabled

locator

Verifies that element identified with locator is disabled.

Key attributes for arbitrary elements are id and name. See introduction for details about locating elements.

Element Should Be Enabled

locator

Verifies that element identified with locator is enabled.

Key attributes for arbitrary elements are id and name. See introduction for details about locating elements.

Element Should Be Visible

locator, message=

Verifies that the element identified by locator is visible.

Herein, visible means that the element is logically visible, not optically visible in the current browser viewport. For example, an element that carries display:none is not logically visible, so using this keyword on that element would fail.

message can be used to override the default error message.

Key attributes for arbitrary elements are id and name. See introduction for details about locating elements.

Element Should Contain

locator, expected, message=

Verifies element identified by locator contains textexpected.

If you wish to assert an exact (not a substring) match on the text of the element, useElement Text Should Be.

message can be used to override the default error message.

Key attributes for arbitrary elements are id and name. See introduction for details about locating elements.

Element Should Not Be Visible

locator, message=

Verifies that the element identified by locator is NOT visible.

This is the opposite of Element Should Be Visible.

message can be used to override the default error message.

Key attributes for arbitrary elements are id and name. See introduction for details about locating elements.

Element Should Not Contain

locator, expected, message=

Verifies element identified by locator does not contain textexpected.

message can be used to override the default error message.

Key attributes for arbitrary elements are id and name. See Element Should Contain for more details.

Element Text Should Be

locator, expected, message=

Verifies element identified by locator exactly contains textexpected.

In contrast to Element Should Contain, this keyword does not try a substring match but an exact match on the element identified bylocator.

message can be used to override the default error message.

Key attributes for arbitrary elements are id and name. See introduction for details about locating elements.

Execute Async Javascript

*code

Executes asynchronous JavaScript code.

Similar to Execute Javascript except that scripts executed with this keyword must explicitly signal they are finished by invoking the provided callback. This callback is always injected into the executed function as the last argument.

Scripts must complete within the script timeout or this keyword will fail. See theTimeouts section for more information.

Examples:

Execute Async JavaScript	var callback = arguments[arguments.length - 1];	window.setTimeout(callback, 2000);
Execute Async JavaScript	${CURDIR}/async_js_to_execute.js
${retval}=	Execute Async JavaScript
...	var callback = arguments[arguments.length - 1];
...	function answer(){callback("text");};
...	window.setTimeout(answer, 2000);
Should Be Equal	${retval}	text

Execute Javascript

*code

Executes the given JavaScript code.

code may contain multiple lines of code and may be divided into multiple cells in the test data. In that case, the parts are catenated together without adding spaces.

If code is an absolute path to an existing file, the JavaScript to execute will be read from that file. Forward slashes work as a path separator on all operating systems.

The JavaScript executes in the context of the currently selected frame or window as the body of an anonymous function. Usewindow to refer to the window of your application and document to refer to the document object of the current frame or window, e.g.document.getElementById('foo').

This keyword returns None unless there is a return statement in the JavaScript. Return values are converted to the appropriate type in Python, including WebElements.

Examples:

Execute JavaScript	window.my_js_function('arg1', 'arg2')
Execute JavaScript	${CURDIR}/js_to_execute.js
${sum}=	Execute JavaScript	return 1 + 1;
Should Be Equal	${sum}	${2}

Focus

locator

Sets focus to element identified by locator.

Frame Should Contain

locator, text, loglevel=INFO

Verifies frame identified by locator contains text.

See Page Should Contain for explanation about loglevel argument.

Key attributes for frames are id and name. See introduction for details about locating elements.

Get Alert Message

dismiss=True

Returns the text of current JavaScript alert.

By default the current JavaScript alert will be dismissed. This keyword will fail if no alert is present. Note that following keywords will fail unless the alert is dismissed by this keyword or another likeGet Alert Message.

Get All Links

Returns a list containing ids of all links found in current page.

If a link has no id, an empty string will be in the list instead.

Get Cookie Value

name

Returns value of cookie found with name.

If no cookie is found with name, this keyword fails.

Get Cookies

Returns all cookies of the current page.

Get Element Attribute

attribute_locator

Return value of element attribute.

attribute_locator consists of element locator followed by an @ sign and attribute name, for example "element_id@class".

Get Element Size

locator

Returns width and height of element identified by locator.

The element width and height is returned. Fails if a matching element is not found.

Get Horizontal Position

locator

Returns horizontal position of element identified by locator.

The position is returned in pixels off the left side of the page, as an integer. Fails if a matching element is not found.

See also Get Horizontal Position.

Get Webelement

locator

Returns the first WebElement matching the given locator.

See introduction for details about locating elements.

Get Webelements

locator

Returns list of WebElement objects matching locator.

See introduction for details about locating elements.

Get Window Identifiers

Returns and logs id attributes of all windows known to the browser.

Get Window Names

Returns and logs names of all windows known to the browser.

Get Window Position

Returns current window position as x then y.

Example:

${x}

${y}=

Get Window Position

Get Window Size

Returns current window size as width then height.

Example:

${width}

${height}=

Get Window Size

Get Window Titles

Returns and logs titles of all windows known to the browser.

Go Back

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

Go To

url

Navigates the active browser instance to the provided URL.

Input Password

locator, text

Types the given password into text field identified by locator.

Difference between this keyword and Input Text is that this keyword does not log the given password. See introduction for details about locating elements.

Input Text

locator, text

Types the given text into text field identified by locator.

See introduction for details about locating elements.

Input Text Into Prompt

text

Types the given text into alert box.

List Selection Should Be

locator, *items

Verifies the selection of select list identified by locator is exactly*items.

If you want to test that no option is selected, simply give no items.

Select list keywords work on both lists and combo boxes. Key attributes for select lists areid and name. See introduction for details about locating elements.

List Should Have No Selections

locator

Verifies select list identified by locator has no selections.

Select list keywords work on both lists and combo boxes. Key attributes for select lists areid and name. See introduction for details about locating elements.

List Windows

Return all current window handles as a list

Location Should Be

url

Verifies that current URL is exactly url.

Location Should Contain

expected

Verifies that current URL contains expected.

Locator Should Match X Times

locator, expected_locator_count, message=, loglevel=INFO

Verifies that the page contains the given number of elements located by the givenlocator.

See introduction for details about locating elements.

See Page Should Contain Element for explanation about message andloglevel arguments.

Log Location

Logs and returns the current location.

Log Source

loglevel=INFO

Logs and returns the entire html source of the current page or frame.

The loglevel argument defines the used log level. Valid log levels are WARN, INFO (default), DEBUG, and NONE (no logging).

Log Title

Logs and returns the title of current page.

Maximize Browser Window

Maximizes current browser window.

Mouse Down

locator

Simulates pressing the left mouse button on the element specified by locator.

The element is pressed without releasing the mouse button.

Key attributes for arbitrary elements are id and name. See introduction for details about locating elements.

See also the more specific keywords Mouse Down On Image and Mouse Down On Link.

Mouse Down On Image

locator

Simulates a mouse down event on an image.

Key attributes for images are id, src and alt. See introduction for details about locating elements.

Mouse Down On Link

locator

Simulates a mouse down event on a link.

Key attributes for links are id, name, href and link text. See introduction for details about locating elements.

Mouse Out

locator

Simulates moving mouse away from the element specified by locator.

Key attributes for arbitrary elements are id and name. See introduction for details about locating elements.

Mouse Over

locator

Simulates hovering mouse over the element specified by locator.

Key attributes for arbitrary elements are id and name. See introduction for details about locating elements.

Mouse Up

locator

Simulates releasing the left mouse button on the element specified by locator.

Key attributes for arbitrary elements are id and name. See introduction for details about locating elements.

Open Browser

url, browser=firefox, alias=None, remote_url=False, desired_capabilities=None, ff_profile_dir=None

Opens a new browser instance to given URL.

Optional alias is an alias for the browser instance and it can be used for switching between browsers (just as index can be used). SeeSwitch Browser for more details.

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
htmlunit	HTMLUnit
htmlunitwithjs	HTMLUnit with Javascipt support
android	Android
iphone	Iphone
safari	Safari
edge	Edge

Note, that you will encounter strange behavior, if you open multiple Internet Explorer browser instances. That is also whySwitch Browser only works with one IE browser at most. For more information see:http://selenium-grid.seleniumhq.org/faq.html#i_get_some_strange_errors_when_i_run_multiple_internet_explorer_instances_on_the_same_machine

Optional 'remote_url' is the url for a remote selenium server for example http://127.0.0.1:4444/wd/hub. If you specify a value for remote you can also specify 'desired_capabilities' which is a string in the form key1:val1,key2:val2 that will be used to specify desired_capabilities to the remote server. This is useful for doing things like specify a proxy server for internet explorer or for specify browser and os if your using saucelabs.com. 'desired_capabilities' can also be a dictonary (created with 'Create Dictionary') to allow for more complex configurations.

Optional 'ff_profile_dir' is the path to the firefox profile dir if you wish to overwrite the default.

Open Context Menu

locator

Opens context menu on element identified by locator.

Page Should Contain

text, loglevel=INFO

Verifies that current page contains text.

If this keyword fails, it automatically logs the page source using the log level specified with the optionalloglevel argument. Valid log levels are DEBUG, INFO (default), WARN, and NONE. If the log level is NONE or below the current active log level the source will not be logged.

Page Should Contain Button

locator, message=, loglevel=INFO

Verifies button identified by locator is found from current page.

This keyword searches for buttons created with either input orbutton tag.

See Page Should Contain Element for explanation about message andloglevel arguments.

Key attributes for buttons are id, name and value. See introduction for details about locating elements.

Page Should Contain Checkbox

locator, message=, loglevel=INFO

Verifies checkbox identified by locator is found from current page.

See Page Should Contain Element for explanation about message andloglevel arguments.

Key attributes for checkboxes are id and name. See introduction for details about locating elements.

Page Should Contain Element

locator, message=, loglevel=INFO

Verifies element identified by locator is found on the current page.

message can be used to override default error message.

See Page Should Contain for explanation about loglevel argument.

Key attributes for arbitrary elements are id and name. See introduction for details about locating elements.

Page Should Contain Image

locator, message=, loglevel=INFO

Verifies image identified by locator is found from current page.

See Page Should Contain Element for explanation about message andloglevel arguments.

Key attributes for images are id, src and alt. See introduction for details about locating elements.

Page Should Contain Link

locator, message=, loglevel=INFO

Verifies link identified by locator is found from current page.

See Page Should Contain Element for explanation about message andloglevel arguments.

Key attributes for links are id, name, href and link text. See introduction for details about locating elements.

Page Should Contain List

locator, message=, loglevel=INFO

Verifies select list identified by locator is found from current page.

See Page Should Contain Element for explanation about message andloglevel arguments.

Key attributes for lists are id and name. See introduction for details about locating elements.

Page Should Contain Radio Button

locator, message=, loglevel=INFO

Verifies radio button identified by locator is found from current page.

See Page Should Contain Element for explanation about message andloglevel arguments.

Key attributes for radio buttons are id, name and value. See introduction for details about locating elements.

Page Should Contain Textfield

locator, message=, loglevel=INFO

Verifies text field identified by locator is found from current page.

See Page Should Contain Element for explanation about message andloglevel arguments.

Key attributes for text fields are id and name. See introduction for details about locating elements.

Page Should Not Contain

text, loglevel=INFO

Verifies the current page does not contain text.

See Page Should Contain for explanation about loglevel argument.

Page Should Not Contain Button

locator, message=, loglevel=INFO

Verifies button identified by locator is not found from current page.

This keyword searches for buttons created with either input orbutton tag.

See Page Should Contain Element for explanation about message andloglevel arguments.

Key attributes for buttons are id, name and value. See introduction for details about locating elements.

Page Should Not Contain Checkbox

locator, message=, loglevel=INFO

Verifies checkbox identified by locator is not found from current page.

See Page Should Contain Element for explanation about message andloglevel arguments.

Key attributes for checkboxes are id and name. See introduction for details about locating elements.

Page Should Not Contain Element

locator, message=, loglevel=INFO

Verifies element identified by locator is not found on the current page.

message can be used to override the default error message.

See Page Should Contain for explanation about loglevel argument.

Key attributes for arbitrary elements are id and name. See introduction for details about locating elements.

Page Should Not Contain Image

locator, message=, loglevel=INFO

Verifies image identified by locator is found from current page.

See Page Should Contain Element for explanation about message andloglevel arguments.

Key attributes for images are id, src and alt. See introduction for details about locating elements.

Page Should Not Contain Link

locator, message=, loglevel=INFO

Verifies image identified by locator is not found from current page.

See Page Should Contain Element for explanation about message andloglevel arguments.

Key attributes for images are id, src and alt. See introduction for details about locating elements.

Page Should Not Contain List

locator, message=, loglevel=INFO

Verifies select list identified by locator is not found from current page.

See Page Should Contain Element for explanation about message andloglevel arguments.

Key attributes for lists are id and name. See introduction for details about locating elements.

Page Should Not Contain Radio Button

locator, message=, loglevel=INFO

Verifies radio button identified by locator is not found from current page.

See Page Should Contain Element for explanation about message andloglevel arguments.

Key attributes for radio buttons are id, name and value. See introduction for details about locating elements.

Page Should Not Contain Textfield

locator, message=, loglevel=INFO

Verifies text field identified by locator is not found from current page.

See Page Should Contain Element for explanation about message andloglevel arguments.

Key attributes for text fields are id and name. See introduction for details about locating elements.

Press Key

locator, key

Simulates user pressing key on element identified by locator.key is either a single character, a string, or a numerical ASCII code of the key lead by '\\'. Examples:

Press Key	text_field	q
Press Key	text_field	abcde
Press Key	login_button	\\13	# ASCII code for enter key

Radio Button Should Be Set To

group_name, value

Verifies radio button group identified by group_name has its selection set tovalue.

See Select Radio Button for information about how radio buttons are located.

Radio Button Should Not Be Selected

group_name

Verifies radio button group identified by group_name has no selection.

See Select Radio Button for information about how radio buttons are located.

keyword

Sets the keyword to execute when a Selenium2Library keyword fails.

keyword_name is the name of a keyword (from any available libraries) that will be executed if a Selenium2Library keyword fails. It is not possible to use a keyword that requires arguments. Using the value "Nothing" will disable this feature altogether.

The initial keyword to use is set in importing, and the keyword that is used by default is Capture Page Screenshot. Taking a screenshot when something failed is a very useful feature, but notice that it can slow down the execution.

This keyword returns the name of the previously registered failure keyword. It can be used to restore the original value later.

Example:

Register Keyword To Run On Failure	Log Source	# Run Log Source on failure.
${previous kw}=	Register Keyword To Run On Failure	Nothing	# Disables run-on-failure functionality and stores the previous kw name in a variable.
Register Keyword To Run On Failure	${previous kw}	# Restore to the previous keyword.

This run-on-failure functionality only works when running tests on Python/Jython 2.4 or newer and it does not work on IronPython at all.

Reload Page

Simulates user reloading page.

Remove Location Strategy

strategy_name

Removes a previously added custom location strategy. Will fail if a default strategy is specified.

See Add Location Strategy for details about adding a custom location strategy.

Select All From List

locator

Selects all values from multi-select list identified by id.

Key attributes for lists are id and name. See introduction for details about locating elements.

Select Checkbox

locator

Selects checkbox identified by locator.

Does nothing if checkbox is already selected. Key attributes for checkboxes areid and name. See introduction for details about locating elements.

Select Frame

locator

Sets frame identified by locator as current frame.

Key attributes for frames are id and name. See introduction for details about locating elements.

Select From List

locator, *items

Selects *items from list identified by locator

If more than one value is given for a single-selection list, the last value will be selected. If the target list is a multi-selection list, and*items is an empty list, all values of the list will be selected.

*items try to select by value then by label.

It's faster to use 'by index/value/label' functions.

An exception is raised for a single-selection list if the last value does not exist in the list and a warning for all other non- existing items. For a multi-selection list, an exception is raised for any and all non-existing values.

Select list keywords work on both lists and combo boxes. Key attributes for select lists areid and name. See introduction for details about locating elements.

Select From List By Index

locator, *indexes

Selects *indexes from list identified by locator

Select list keywords work on both lists and combo boxes. Key attributes for select lists areid and name. See introduction for details about locating elements.

Select From List By Label

locator, *labels

Selects *labels from list identified by locator

Select list keywords work on both lists and combo boxes. Key attributes for select lists areid and name. See introduction for details about locating elements.

Select From List By Value

locator, *values

Selects *values from list identified by locator

Select list keywords work on both lists and combo boxes. Key attributes for select lists areid and name. See introduction for details about locating elements.

Select Radio Button

group_name, value

Sets selection of radio button group identified by group_name tovalue.

The radio button to be selected is located by two arguments:

group_name is used as the name of the radio input
value is used for the value attribute or for the id attribute

The XPath used to locate the correct radio button then looks like this: //input[@type='radio' and @name='group_name' and (@value='value' or @id='value')]

Examples:

Select Radio Button	size	XL	# Matches HTML like <input type="radio" name="size" value="XL">XL</input>
Select Radio Button	size	sizeXL	# Matches HTML like <input type="radio" name="size" value="XL" id="sizeXL">XL</input>

Select Window

locator=None

Selects the window matching locator and return previous window handle.

locator: any of name, title, url, window handle, excluded handle's list, or special words. return: either current window handle before selecting, or None if no current window.

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.

There are some special locators for searching target window: string 'main' (default): select the main window; string 'self': only return current window handle; string 'new': select the last-indexed window assuming it is the newest opened window window list: select the first window not in given list (See 'List Windows' to get the list)

It is also possible to specify the approach Selenium2Library should take to find a window by specifying a locator strategy:

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

Example:

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

Set Browser Implicit Wait

seconds

Sets current browser's implicit wait in seconds.

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:

Set Browser Implicit Wait

10 seconds

See also Set Selenium Implicit Wait.

Set Screenshot Directory

path, persist=False

Sets the root output directory for captured screenshots.

path argument specifies the absolute path where the screenshots should be written to. If the specifiedpath does not exist, it will be created. Setting persist specifies that the givenpath should be used for the rest of the test execution, otherwise the path will be restored at the end of the currently executing scope.

Set Selenium Implicit Wait

seconds

Sets Selenium 2's default implicit wait in seconds and sets the implicit wait for all open browsers.

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}

Set Selenium Speed

seconds

Sets the delay in seconds that is waited after each Selenium command.

This is useful mainly in slowing down the test execution to be able to view the execution.seconds may be given in Robot Framework time format. Returns the previous speed value.

Example:

Set Selenium Speed

.5 seconds

Set Selenium Timeout

seconds

Sets the timeout in seconds used by various keywords.

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 this keyword. SeeTimeouts 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 inimporting.

Example:

${orig timeout} =	Set Selenium Timeout	15 seconds
Open page that loads slowly
Set Selenium Timeout	${orig timeout}

Set Window Position

x, y

Sets the position x and y of the current window to the specified values.

Example:

Set Window Size	${1000}	${0}
${x}	${y}=	Get Window Position
Should Be Equal	${x}	${1000}
Should Be Equal	${y}	${0}

Set Window Size

width, 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}

Simulate

locator, event

Simulates event on element identified by locator.

This keyword is useful if element has OnEvent handler that needs to be explicitly invoked.

See introduction for details about locating elements.

Submit Form

locator=None

Submits a form identified by locator.

If locator is empty, first form in the page will be submitted. Key attributes for forms areid and name. See introduction for details about locating elements.

Switch Browser

index_or_alias

Switches between active browsers using index or alias.

Index is returned from Open Browser and 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

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	*firefox
# Do something ...
Switch Browser	${id}

Table Cell Should Contain

table_locator, row, column, expected, loglevel=INFO

Verifies that a certain cell in a table contains expected.

Row and column number start from 1. This keyword passes if the specified cell contains the given content. If you want to test that the cell content matches exactly, or that it e.g. starts with some text, useGet Table Cell keyword in combination with built-in keywords such as Should Be Equal or Should Start With.

To understand how tables are identified, please take a look at the introduction.

See Page Should Contain for explanation about loglevel argument.

Table Column Should Contain

table_locator, col, expected, loglevel=INFO

Verifies that a specific column contains expected.

The first leftmost column is column number 1. A negative column number can be used to get column counting from the end of the row (end: -1). If the table contains cells that span multiple columns, those merged cells count as a single column. For example both tests below work, if in one row columns A and B are merged with colspan="2", and the logical third column contains "C".

Example:

Table Column Should Contain	tableId	3	C
Table Column Should Contain	tableId	2	C

To understand how tables are identified, please take a look at the introduction.

See Page Should Contain Element for explanation about loglevel argument.

Table Footer Should Contain

table_locator, expected, loglevel=INFO

Verifies that the table footer contains expected.

With table footer can be described as any <td>-element that is child of a <tfoot>-element. To understand how tables are identified, please take a look at theintroduction.

See Page Should Contain Element for explanation about loglevel argument.

Table Header Should Contain

table_locator, expected, loglevel=INFO

Verifies that the table header, i.e. any <th>...</th> element, contains expected.

To understand how tables are identified, please take a look at the introduction.

See Page Should Contain Element for explanation about loglevel argument.

Table Row Should Contain

table_locator, row, expected, loglevel=INFO

Verifies that a specific table row contains expected.

The uppermost row is row number 1. A negative column number can be used to get column counting from the end of the row (end: -1). For tables that are structured with thead, tbody and tfoot, only the tbody section is searched. Please useTable Header Should Contain or Table Footer Should Contain for tests against the header or footer content.

If the table contains cells that span multiple rows, a match only occurs for the uppermost row of those merged cells. To understand how tables are identified, please take a look at theintroduction.

See Page Should Contain Element for explanation about loglevel argument.

Table Should Contain

table_locator, expected, loglevel=INFO

Verifies that expected can be found somewhere in the table.

To understand how tables are identified, please take a look at the introduction.

See Page Should Contain Element for explanation about loglevel argument.

Textarea Should Contain

locator, expected, message=

Verifies text area identified by locator contains textexpected.

message can be used to override default error message.

Key attributes for text areas are id and name. See introduction for details about locating elements.

Textarea Value Should Be

locator, expected, message=

Verifies the value in text area identified by locator is exactlyexpected.

message can be used to override default error message.

Key attributes for text areas are id and name. See introduction for details about locating elements.

Textfield Should Contain

locator, expected, message=

Verifies text field identified by locator contains textexpected.

message can be used to override default error message.

Key attributes for text fields are id and name. See introduction for details about locating elements.

Textfield Value Should Be

locator, expected, message=

Verifies the value in text field identified by locator is exactlyexpected.

message can be used to override default error message.

Key attributes for text fields are id and name. See introduction for details about locating elements.

Title Should Be

title

Verifies that current page title equals title.

Unselect Checkbox

locator

Removes selection of checkbox identified by locator.

Does nothing if the checkbox is not checked. Key attributes for checkboxes areid and name. See introduction for details about locating elements.

Unselect Frame

Sets the top frame as the current frame.

Unselect From List

locator, *items

Unselects given values from select list identified by locator.

As a special case, giving empty list as *items will remove all selections.

*items try to unselect by value AND by label.

It's faster to use 'by index/value/label' functions.

Select list keywords work on both lists and combo boxes. Key attributes for select lists areid and name. See introduction for details about locating elements.

Unselect From List By Index

locator, *indexes

Unselects *indexes from list identified by locator

Select list keywords work on both lists and combo boxes. Key attributes for select lists areid and name. See introduction for details about locating elements.

Unselect From List By Label

locator, *labels

Unselects *labels from list identified by locator

Select list keywords work on both lists and combo boxes. Key attributes for select lists areid and name. See introduction for details about locating elements.

Unselect From List By Value

locator, *values

Unselects *values from list identified by locator

Select list keywords work on both lists and combo boxes. Key attributes for select lists areid and name. See introduction for details about locating elements.

Wait For Condition

condition, timeout=None, error=None

Waits until the given condition is true or timeout expires.

The condition can be arbitrary JavaScript expression but must contain a return statement (with the value to be returned) at the end. SeeExecute JavaScript for information about accessing the actual contents of the window through JavaScript.

error can be used to override the default error message.

See introduction for more information about timeout and its default value.

See also Wait Until Page Contains, Wait Until Page Contains Element, Wait Until Element Is Visible and BuiltIn keyword Wait Until Keyword Succeeds.

Wait Until Element Contains

locator, text, timeout=None, error=None

Waits until given element contains text.

Fails if timeout expires before the text appears on given element. Seeintroduction for more information about timeout and its default value.

error can be used to override the default error message.

See also Wait Until Page Contains, Wait Until Page Contains Element, Wait For Condition, Wait Until Element Is Visible and BuiltIn keyword Wait Until Keyword Succeeds.

Wait Until Element Does Not Contain

locator, text, timeout=None, error=None

Waits until given element does not contain text.

Fails if timeout expires before the text disappears from given element. Seeintroduction for more information about timeout and its default value.

error can be used to override the default error message.

See also Wait Until Page Contains, Wait Until Page Contains Element, Wait For Condition, Wait Until Element Is Visible and BuiltIn keyword Wait Until Keyword Succeeds.

Wait Until Element Is Enabled

locator, timeout=None, error=None

Waits until element specified with locator is enabled.

Fails if timeout expires before the element is enabled. Seeintroduction for more information about timeout and its default value.

error can be used to override the default error message.

See also Wait Until Page Contains, Wait Until Page Contains Element, Wait For Condition and BuiltIn keyword Wait Until Keyword Succeeds.

Wait Until Element Is Not Visible

locator, timeout=None, error=None

Waits until element specified with locator is not visible.

Fails if timeout expires before the element is not visible. Seeintroduction for more information about timeout and its default value.

error can be used to override the default error message.

See also Wait Until Page Contains, Wait Until Page Contains Element, Wait For Condition and BuiltIn keyword Wait Until Keyword Succeeds.

Wait Until Element Is Visible

locator, timeout=None, error=None

Waits until element specified with locator is visible.

Fails if timeout expires before the element is visible. Seeintroduction for more information about timeout and its default value.

error can be used to override the default error message.

See also Wait Until Page Contains, Wait Until Page Contains Element, Wait For Condition and BuiltIn keyword Wait Until Keyword Succeeds.

Wait Until Page Contains

text, timeout=None, error=None

Waits until text appears on current page.

Fails if timeout expires before the text appears. Seeintroduction for more information about timeout and its default value.

error can be used to override the default error message.

See also Wait Until Page Contains Element, Wait For Condition, Wait Until Element Is Visible and BuiltIn keyword Wait Until Keyword Succeeds.

Wait Until Page Contains Element

locator, timeout=None, error=None

Waits until element specified with locator appears on current page.

Fails if timeout expires before the element appears. Seeintroduction for more information about timeout and its default value.

error can be used to override the default error message.

See also Wait Until Page Contains, Wait For Condition, Wait Until Element Is Visible and BuiltIn keyword Wait Until Keyword Succeeds.

Wait Until Page Does Not Contain

text, timeout=None, error=None

Waits until text disappears from current page.

Fails if timeout expires before the text disappears. See introduction for more information about timeout and its default value.

error can be used to override the default error message.

See also Wait Until Page Contains, Wait For Condition, Wait Until Element Is Visible and BuiltIn keyword Wait Until Keyword Succeeds.

Wait Until Page Does Not Contain Element

locator, timeout=None, error=None

Waits until element specified with locator disappears from current page.

Fails if timeout expires before the element disappears. Seeintroduction for more information about timeout and its default value.

error can be used to override the default error message.

See also Wait Until Page Contains, Wait For Condition, Wait Until Element Is Visible and BuiltIn keyword Wait Until Keyword Succeeds.

Xpath Should Match X Times

xpath, expected_xpath_count, message=, loglevel=INFO

Verifies that the page contains the given number of elements located by the givenxpath.

One should not use the xpath= prefix for 'xpath'. XPath is assumed.

Correct:

Xpath Should Match X Times | //div[@id='sales-pop'] | 1

Incorrect:

Xpath Should Match X Times | xpath=//div[@id='sales-pop'] | 1

See Page Should Contain Element for explanation about message andloglevel arguments.

超级大neo

关注

1
点赞
踩
1

收藏

觉得还不错? 一键收藏
1
评论
Selenium2Library 英文api

Opening library documentation failedVerify that you have JavaScript enabled in your browser.Make sure you are using a modern enough browser. Firefox 3.5, IE 8, or equivalent is required, newer bro
复制链接

扫一扫