3.12.0.0 global yes SeleniumLibrary is a web testing library for the Robot Framework and was originally written in Python. This is the Java port of the SeleniumLibrary for Robot Framework (https://github.com/robotframework/SeleniumLibrary). It uses the Selenium libraries internally to control a web browser. See [http://seleniumhq.org/docs/03_webdriver.html|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 SeleniumLibrary, 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 SeleniumLibrary 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 SeleniumLibrary 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.<br> 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 [http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#time-format|Robot Framework User Guide] for details about the time syntax. == Log Level == There are several keywords that take ``log level`` as an argument. All of these log level arguments are optional. The default is usually INFO. | = Log Level = | = Description = | | DEBUG | | | INFO | | | HTML | Same as INFO, but message is in HTML format | | TRACE | | | WARN | | arg1= arg2= arg3= arg4= SeleniumLibrary can be imported with several optional arguments. - ``timeout``: Default value for `timeouts` used with ``Wait ...`` keywords. - ``implicit_wait``: Default value for `implicit wait` used when locating elements. - ``run_on_failure``: Default action for the `run-on-failure functionality`. - ``screenshot_root_directory``: Location where possible screenshots are created. If not given, the directory where the log file is written is used. name value path=NONE domain=NONE secure=NONE Adds a cookie to your current session. strategyName functionDefinition delimiter=NONE 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 | text=NONE Verify an alert is present and dismiss it. If ``text`` is a non-empty string, then it is also verified that the message of the alert equals to text. Will fail if no alert is present. Note that following keywords will fail unless the alert is confirmed by this keyword or another like `Confirm Action`. locator id Assigns a temporary identifier to the element identified by ``locator``. This is mainly useful, when the locator is a complicated and slow XPath expression. The 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 | filename=NONE Take a screenshot of the current page and embed it into the log. The ``filename`` argument specifies the name of the file to write the screenshot into. If no filename is given, the screenshot is saved into file selenium-screenshot-<counter>.png under the directory where the Robot Framework log file is written into. The filename is also considered relative to the same directory, if it is not given in absolute format. A CSS can be used to modify how the screenshot is taken. By default the background color is changed to avoid possible problems with background leaking when the page layout is somehow broken. locator Verify the checkbox identified by ``locator``is selected/checked. Key attributes for checkboxes are id and name. See `Introduction` for details about locators. locator Verify the checkbox identified by ``locator``is not selected/checked. Key attributes for checkboxes are id and name. See `Introduction` for details about locators. Cancel will as default be selected from now on every time a confirmation dialog appears. Note that every time a confirmation comes up, it must be confirmed by the keywords `Alert Should Be Present` or `Confirm Action`. Otherwise all following operations will fail. Cancel will be selected the next time a confirmation dialog appears. Note that every time a confirmation comes up, it must be confirmed by the keywords `Alert Should Be Present` or `Confirm Action`. Otherwise all following operations will fail. locator filePath Types the given ``filePath`` into the input field identified by ``locator``. This keyword is most often used to input files into upload forms. The file specified with filePath must be available on the same host where the Selenium Server is running. Example: | Choose File | my_upload_field | /home/user/files/trades.csv | Key attributes for input fields are id and name. See Introduction for details about locators. OK will as default be selected from now on every time a confirmation dialog appears. Note that every time a confirmation comes up, it must be confirmed by the keywords `Alert Should Be Present` or `Confirm Action`. Otherwise all following operations will fail. OK will be selected the next time a confirmation dialog appears. Note that every time a confirmation comes up, it must be confirmed by the keywords `Alert Should Be Present` or `Confirm Action`. Otherwise all following operations will fail. locator Clears the text from element identified by ``locator``. This keyword does not execute any checks on whether or not the clear method has succeeded, so if any subsequent checks are needed, they should be executed using method `Element Text Should Be`. Also, this method will use WebDriver's internal _element.clear()_ method, i.e. it will not send any keypresses, and it will not have any effect whatsoever on elements other than input textfields or input textareas. Clients relying on keypresses should implement their own methods. Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators. locator Click on the button identified by ``locator``. Key attributes for buttons are id and name. See `Introduction` for details about locators. locator Click on the element identified by ``locator``. Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators. locator xOffset yOffset Click on the element identified by locator at the coordinates ``xOffset`` and ``yOffset``. The cursor is moved at the center of the element and the to the given x/y offset from that point. Both offsets are specified as negative (left/up) or positive (right/down) number. Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators. locator Click on the image identified by ``locator``. Key attributes for images are id, src and alt. See `Introduction` for details about locators. locator Click on the link identified by ``locator``. Key attributes for links are id, name, href and link text. See `Introduction` for details about locators. 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. Closes the current browser instance. Closes the currently open pop-up window. Dismisses currently shown confirmation dialog and returns its message. By default, this keyword chooses 'OK' option from the dialog. If 'Cancel' needs to be chosen, keyword `Choose Cancel On Next Confirmation` must be called before the action that causes the confirmation dialog to be shown. Example: | Click Button | Send | | # Shows a confirmation dialog | | ${message}= | Confirm Action | | # Chooses Ok | | Should Be Equal | ${message} | Are your sure? | # Check dialog message | | Choose Cancel On Next Confirmation | | | # Choose cancel on next Confirm Action | | Click Button | Send | | # Shows a confirmation dialog | | Confirm Action | | | # Chooses Cancel | text logLevel=INFO Verify the current frame contains ``text``. See `Introduction` for details about log levels. text logLevel=INFO Verify the current frame does not contain ``text``. See `Introduction` for details about log levels. Deletes all cookies. name Deletes cookie matching ``name``. If the cookie is not found, nothing happens. locator Double-Click on the element identified by ``locator``. Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators. source target Drag the element identified by the locator ``source`` and move it on top of the element identified by the locator ``target``. Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators. Example: | Drag And Drop | elem1 | elem2 | # Move elem1 over elem2 | source xOffset yOffset Drag the element identified by the locator ``source`` and move it on top of the element identified by the locator ``target``. Both offsets are specified as negative (left/up) or positive (right/down) number. Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators. Example: | Drag And Drop By Offset | elem1 | 50 | 35 | # Move elem1 50px right and 35px down. | locator message=NONE Verify the element identified by ``locator`` is clickable. Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators. locator Verify the element identified by ``locator`` is disabled. Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators. locator Verify the element identified by ``locator`` is found on the current page Key attributes for arbitrary elements are id and name. See `Introduction` for details about log levels and locators. locator message=NONE Verify the element identified by ``locator`` is selected. Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators. locator message=NONE Verify 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. Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators. locator text message=NONE Verify the element identified by ``locator`` contains ``text``. See `Introduction` for details about locators. locator message=NONE Verify the element identified by ``locator`` is not clickable. Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators. locator message=NONE Verify the element identified by ``locator`` is not selected. Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators. locator message=NONE Verify the element identified by ``locator`` is not 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. Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators. locator text message=NONE Verify the element identified by ``locator`` does not contain ``text``. See `Introduction` for details about locators. locator text message=NONE Verify the text of the element identified by ``locator`` is exactly ``text``. In contrast to `Element Should Contain`, this keyword does not try a substring match but an exact match on the element identified by locator. Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators. locator text message=NONE Verify the text of the element identified by ``locator`` is not exactly ``text``. In contrast to `Element Should Not Contain`, this keyword does not try a substring match but an exact match on the element identified by locator. Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators. *code Execute the given JavaScript ``code`` asynchronously. The given code may contain multiple lines of code, but must contain a return statement (with the value to be returned) at the end. The given code may be divided into multiple cells in the test data. In that case, the parts are concatenated together without adding spaces. If the given 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. Note that by default the code will be executed in the context of the Selenium object itself, so *this* will refer to the Selenium object. Use *window* to refer to the window of your application, e.g. _window.document.getElementById('foo')_. Example: | Execute Async JavaScript | return window.my_js_function('arg1', 'arg2'); | # Directly execute the JavaScript | | Execute Async JavaScript | ${CURDIR}/js_to_execute.js | # Load the JavaScript to execute from file | *code Execute the given JavaScript ``code``. The given code may contain multiple lines of code, but must contain a return statement (with the value to be returned) at the end. The given code may be divided into multiple cells in the test data. In that case, the parts are concatenated together without adding spaces. If the given 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. Note that by default the code will be executed in the context of the Selenium object itself, so *this* will refer to the Selenium object. Use *window* to refer to the window of your application, e.g. _window.document.getElementById('foo')_. Example: | Execute JavaScript | return window.my_js_function('arg1', 'arg2'); | # Directly execute the JavaScript | | Execute JavaScript | ${CURDIR}/js_to_execute.js | # Load the JavaScript to execute from file | locator Set the focus to the element identified by ``locator``. Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators. locator text logLevel=INFO Verify the frame identified by ``locator`` contains ``text``. See `Introduction` for details about locators. locator text logLevel=INFO Verify the frame identified by ``locator`` does not contain ``text``. See `Introduction` for details about locators. Returns the text of current JavaScript alert. This keyword will fail if no alert is present. Note that following keywords will fail unless the alert is confirmed by the keywords `Alert Should Be Present` or `Confirm Action`. 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. name Returns value of cookie found with ``name``. If no cookie is found with name, this keyword fails. Returns all cookies of the current page. attributeLocator Returns the value of an element attribute. The ``attribute_locator`` consists of element locator followed by an @ sign and attribute name. Example: element_id@class Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators. 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 the matching element is not found. Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators. locator matchid index Returns inner element id by index```` of element identified by ``locator`` which is matched by ``matchid``. Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators. locator Returns the values in the select list identified by ``locator``. Select list keywords work on both lists and combo boxes. Key attributes for select lists are id and name. See `Introduction` for details about locators. Returns the current browser URL. Returns and logs URLs of all known browser windows. xpath Returns the number of elements located the given ``xpath``. If you wish to assert the number of located elements, use `Xpath Should Match X Times`. * 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. <b>If a session cannot support a capability that is requested in the desired capabilities, no error is thrown;</b> a read-only capabilities object is returned that indicates the capabilities the session actually supports. For more information see:[http://code.google.com/p/selenium/wiki/DesiredCapabilities|DesiredCapabilities] Returns the session id of the remote browser instance. locator Returns the visible label of the first selected element from the select list identified by ``locator``. Select list keywords work on both lists and combo boxes. Key attributes for select lists are id and name. See `Introduction` for details about locators. locator Returns the visible labels of the first selected element from the select list identified by ``locator``. Fails if there is no selection. Select list keywords work on both lists and combo boxes. Key attributes for select lists are id and name. See `Introduction` for details about locators. locator Returns the value of the first selected element from the select list identified by ``locator``. The return value is read from the value attribute of the selected element. Select list keywords work on both lists and combo boxes. Key attributes for select lists are id and name. See `Introduction` for details about locators. locator Returns the values of the first selected element as a list from the select list identified by ``locator``. Fails if there is no selection. The return values are read from the value attribute of the selected element. Select list keywords work on both lists and combo boxes. Key attributes for select lists are id and name. See `Introduction` for details about locators. Returns the implicit wait time in seconds that is used by Selenium. *(NOT IMPLEMENTED)* Returns the delay in seconds that is waited after each Selenium command. Returns the timeout in seconds that is used by various keywords. Returns the entire HTML source of the current page or frame. Returns basic system information about the execution environment. tableLocator row column logLevel=INFO Returns the content of the table cell at the coordinates ``row`` and ``column`` of the table identified by ``tableLocator``. Row and column number start from 1. Header and footer rows are included in the count. That way also cell content from header or footer rows can be obtained with this keyword. Key attributes for tables are id and name. See `Introduction` for details about locators and log levels. locator Returns the text of the element identified by ``locator``.. Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators. Returns the title of current page. locator Returns the value attribute of the element identified by ``locator``.. Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators. locator Returns vertical position of element identified by ``locator``. The position is returned in pixels off the left side of the page, as an integer. Fails if the matching element is not found. Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators. Returns the id attributes of all windows known to the current browser instance. Returns the names of all windows known to the current browser instance. Returns current window width and height as integers. See also `Set Window Size`. Example: | ${width} | ${height}= | Get Window Size | Returns the titles of all windows known to the current browser instance. Simulates the user clicking the "back" button on their browser. url Navigates the active browser instance to the provided URL. locator text Types the given ``text`` into the password field identified by ``locator``. Key attributes for input fields are id and name. See `Introduction` for details about locators. locator text Types the given ``text`` into the text field identified by ``locator``. Key attributes for input fields are id and name. See `Introduction` for details about locators. locator *items Verify the selection of the select list identified by ``locator``. If you want to verify no option is selected, simply give no items. Select list keywords work on both lists and combo boxes. Key attributes for select lists are id and name. See `Introduction` for details about locators. locator Verify the select list identified by ``locator`` has no selections. Select list keywords work on both lists and combo boxes. Key attributes for select lists are id and name. See `Introduction` for details about locators. url Verify the current page URL is exactly ``url``. url Verify the current page URL contains ``url`` logLevel=INFO Logs and returns the location of current browser instance. See `Introduction` for details about the ``logLevel``. logLevel=INFO 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: [https://github.com/SeleniumHQ/selenium/wiki/DesiredCapabilities|DesiredCapabilities] See `Introduction` for details about the ``logLevel``. logLevel=INFO Logs and returns the session id of the remote browser instance. See `Introduction` for details about the ``logLevel``. logLevel=INFO Logs and returns the entire html source of the current page or frame. See `Introduction` for details about the ``logLevel``. logLevel=INFO Logs and returns basic system information about the execution environment. See `Introduction` for details about the ``logLevel``. logLevel=INFO Logs and returns the title of current page. See `Introduction` for details about the ``logLevel``. logLevel=INFO Logs and returns the id attributes of all windows known to the current browser instance. logLevel=INFO Logs and returns the names of all windows known to the current browser instance. See `Introduction` for details about the ``logLevel``. logLevel=INFO Logs and returns the titles of all windows known to the current browser instance. See `Introduction` for details about the ``logLevel``. Maximizes current browser window. locator Simulates pressing the left mouse button on the element identified 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 locators. locator Simulates pressing the left mouse button on the image identified by ``locator``. The element is pressed without releasing the mouse button. Key attributes for images are id, src and alt. See `Introduction` for details about locators. locator Simulates pressing the left mouse button on the link identified by ``locator``. The element is pressed without releasing the mouse button. Key attributes for links are id, name, href and link text. See `Introduction` for details about locators. locator Simulates moving the mouse away from the element identified by ``locator``. Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators. locator Simulates moving the mouse over the element identified by ``locator``. Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators. locator Simulates releasing the left mouse button on the element identified by ``locator``. Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators. url browserName=firefox alias=None remoteUrl=None desiredCapabilities=None browserOptions=None Opens a new browser instance to the given ``url``. The ``browser`` argument specifies which browser to use, and the supported browser are listed in the table below. The browser names are case-insensitive and some browsers have multiple supported names. | = Browser = | = Name(s) = | | Firefox | firefox, ff | | Firefox (headless) | firefoxheadless, ffheadless | | Google Chrome | googlechrome, chrome, gc | | Google Chrome (headless) | googlechromeheadless, chromeheadless, gcheadless | | Internet Explorer | internetexplorer, ie | | Edge | edge | | Safari | safari | | Opera | opera | | Android | android | | Iphone | iphone | | PhantomJS | phantomjs | | HTMLUnit | htmlunit | | HTMLUnit with Javascript | htmlunitwithjs | | JBrowser | jbrowser | To be able to actually use one of these browsers, you need to have a matching Selenium browser driver available. See the [https://github.com/Hi-Fi/robotframework-seleniumlibrary-java#browser-drivers|project documentation] for more details. Optional ``alias`` is an alias given for this browser instance and it can be used for switching between browsers. An alternative approach for switching is using an index returned by this keyword. These indices start from 1, are incremented when new browsers are opened, and reset back to 1 when `Close All Browsers` is called. See `Switch Browser` for more information and examples. Optional ``remote_url`` is the URL for a remote Selenium server. If you specify a value for a remote, you can also specify ``desired_capabilities`` to configure, for example, a proxy server for Internet Explorer or a browser and operating system when using [http://saucelabs.com|Sauce Labs]. Desired capabilities can be given as a dictionary. [https://github.com/SeleniumHQ/selenium/wiki/Capabilities| Selenium documentation] lists possible capabilities that can be enabled. Optional ``ff_profile_dir`` is the path to the Firefox profile directory if you wish to overwrite the default profile Selenium uses. Notice that prior to SeleniumLibrary 3.0, the library contained its own profile that was used by default. Examples: | `Open Browser` | http://example.com | Chrome | | `Open Browser` | http://example.com | Firefox | alias=Firefox | | `Open Browser` | http://example.com | Edge | remote_url=http://127.0.0.1:4444/wd/hub | If the provided configuration options are not enough, it is possible to use `Create Webdriver` to customize browser initialization even more. locator Opens the context menu on the element identified by ``locator``. Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators. text logLevel=INFO Verify the current page contains ``text``. See `Introduction` for details about log levels. locator message=NONE logLevel=INFO Verify the button identified by ``locator`` is found on the current page. Key attributes for buttons are id and name. See `Introduction` for details about locators. locator message=NONE logLevel=INFO Verify the checkbox identified by ``locator``is found on the current page. Key attributes for checkboxes are id and name. See `Introduction` for details about locators. locator message=NONE logLevel=INFO Verify the element identified by ``locator`` is found on the current page Key attributes for arbitrary elements are id and name. See `Introduction` for details about log levels and locators. locator message=NONE logLevel=INFO Verify the image identified by ``locator`` is found on the current page. Key attributes for images are id, src and alt. See `Introduction` for details about log levels and locators. locator message=NONE logLevel=INFO Verify the link identified by ``locator`` is found on the current page. Key attributes for links are id, name, href and link text. See `Introduction` for details about log levels and locators. locator message=NONE logLevel=INFO Verify the select list identified by ``locator`` is found on the current page. Select list keywords work on both lists and combo boxes. Key attributes for select lists are id and name. See `Introduction` for details about locators. locator message=NONE logLevel=INFO Verify the radio button identified by ``locator``is found on the current page. Key attributes for radio buttons are id and name. See `Introduction` for details about locators. locator message=NONE logLevel=INFO Verify the text field identified by ``locator`` is found on the current page. Key attributes for input fields are id and name. See `Introduction` for details about locators. text logLevel=INFO Verify the current page does not contain ``text``. See `Introduction` for details about log levels. locator message=NONE logLevel=INFO Verify the button identified by ``locator`` is not found on the current page. Key attributes for buttons are id and name. See `Introduction` for details about locators. locator message=NONE logLevel=INFO Verify the checkbox identified by ``locator``is not found on the current page. Key attributes for checkboxes are id and name. See `Introduction` for details about locators. locator message=NONE logLevel=INFO Verify the element identified by ``locator`` is not found on the current page Key attributes for arbitrary elements are id and name. See `Introduction` for details about log levels and locators. locator message=NONE logLevel=INFO Verify the image identified by ``locator`` is not found on the current page. Key attributes for images are id, src and alt. See `Introduction` for details about log levels and locators. locator message=NONE logLevel=INFO Verify the link identified by ``locator`` is not found on the current page. Key attributes for links are id, name, href and link text. See `Introduction` for details about log levels and locators. locator message=NONE logLevel=INFO Verify the select list identified by ``locator`` is not found on the current page. Select list keywords work on both lists and combo boxes. Key attributes for select lists are id and name. See `Introduction` for details about locators. locator message=NONE logLevel=INFO Verify the radio button identified by ``locator``is not found on the current page. Key attributes for radio buttons are id and name. See `Introduction` for details about locators. locator message=NONE logLevel=INFO Verify the text field identified by ``locator`` is not found on the current page. Key attributes for input fields are id and name. See `Introduction` for details about locators. locator key Simulates pressing key on the element identified by ``locator``. Key is either a single character, or a numerical ASCII code of the key lead by '\\'. Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators. Example: | Press Key | text_field | q | # Press 'q' | | Press Key | login_button | \\13 | # ASCII code for enter key | groupName value Verify the radio button group identified by ``groupName``has its selection set to ``value``. See `Select Radio Button` for details about locating radio buttons. groupName Verify the radio button group identified by ``groupName``has no selection. See `Select Radio Button` for details about locating radio buttons. keyword Sets the actual and returns the previous keyword to execute when a SeleniumLibrary keyword fails. The keyword is the name of a keyword (from any available libraries) that will be executed, if a SeleniumLibrary 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 at importing the library 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 | # Disable run-on-failure functionality and stors the previous kw name in a variable. | | Register Keyword To Run On Failure | ${previous kw} | | # Restore to the previous keyword. | Simulates user reloading page. locator Select all values of the multi-select list identified by ``locator``. Select list keywords work on both lists and combo boxes. Key attributes for select lists are id and name. See `Introduction` for details about locators. locator Select the checkbox identified by ``locator``. Does nothing, if the checkbox is already selected. Key attributes for checkboxes are id and name. See `Introduction` for details about locators. locator Sets frame identified by ``locator`` as the current frame. See the `Locating elements` section for details about the locator syntax. Works both with frames and iframes. Use `Unselect Frame` to cancel the frame selection and return to the main frame. Example: | Select Frame | top-frame | # Select frame with id or name 'top-frame' | | Click Link | example | # Click link 'example' in the selected frame | | Unselect Frame | | # Back to main frame. | | Select Frame | //iframe[@name='xxx'] | # Select frame using xpath | locator *items Select the given ``*items`` of the multi-select list identified by ``locator``. 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 are id and name. See `Introduction` for details about locators. locator *indexes Select the given ``*indexes`` of the multi-select list identified by ``locator``. Tries to select by value AND by label. It's generally faster to use 'by index/value/label' keywords. Select list keywords work on both lists and combo boxes. Key attributes for select lists are id and name. See `Introduction` for details about locators. locator *labels Select the given ``*labels`` of the multi-select list identified by ``locator``. Select list keywords work on both lists and combo boxes. Key attributes for select lists are id and name. See `Introduction` for details about locators. locator *values Select the given ``*values`` of the multi-select list identified by ``locator``. Select list keywords work on both lists and combo boxes. Key attributes for select lists are id and name. See `Introduction` for details about locators. groupName value Sets the selection of the radio button group identified by ``groupName`` to ``value``. Example: | 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> | locator=MAIN 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 | 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 | logDirectory Set the ``logDirectory``, where captured screenshots are stored, to some custom path. Fails, if either the given path does not exist, is no directory or is not writable. host port username=None password=None domain=None workstation=None 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. path Sets the directory for captured screenshots. ``path`` argument specifies the absolute path to a directory where the screenshots should be written to. If the directory does not exist, it will be created. The directory can also be set when `importing` the library. If it is not configured anywhere, screenshots are saved to the same directory where Robot Framework's log file is written. The previous value is returned and can be used to restorethe original value later if needed. 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 | timestr *(NOT IMPLEMENTED)* Sets the delay in seconds that is waited after each Selenium command. 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 | width height Sets current windows size to given `` width`` and ``height``. Values can be given using strings containing numbers or by using actual numbers. See also `Get Window Size`. Browsers have a limit how small they can be set. Trying to set them smaller will cause the actual size to be bigger than the requested size. Example: | Set Window Size | 800 | 600 | locator event Simulates the given ``event`` on the element identified by ``locator``. This keyword is especially useful, when the element has an OnEvent handler that needs to be explicitly invoked. Key attributes for arbitrary elements are id and name. See `Introduction` for details about locators. locator=NONE Submit the form identified by ``locator``. If the locator is empty, the first form in the page will be submitted. Key attributes for forms are id and name. See `Introduction` for details about locators. 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} | tableLocator row column text logLevel=INFO Verify the content of the table cell at the coordinates ``row`` and ``column`` of the table identified by ``tableLocator`` contains ``text``. Row and column number start from 1. Header and footer rows are included in the count. That way also cell content from header or footer rows can be obtained with this keyword. Key attributes for tables are id and name. See `Introduction` for details about locators and log levels. tableLocator col text logLevel=INFO Verify the content of any table cells of the table ``column`` of the table identified by ``tableLocator`` contains ``text``. Key attributes for tables are id and name. See `Introduction` for details about locators and log levels. The first leftmost column is column number 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 | tableLocator text logLevel=INFO Verify the content of any table footer cells of the table identified by ``tableLocator`` contains ``text``. Key attributes for tables are id and name. See `Introduction` for details about locators and log levels. tableLocator text logLevel=INFO Verify the content of any table header cells of the table identified by ``tableLocator`` contains ``text``. Key attributes for tables are id and name. See `Introduction` for details about locators and log levels. tableLocator row text logLevel=INFO Verify the content of any table cells of the table ``row`` of the table identified by ``tableLocator`` contains ``text``. Key attributes for tables are id and name. See `Introduction` for details about locators and log levels. The uppermost row is row number 1. For tables that are structured with thead, tbody and tfoot, only the tbody section is searched. Please use Table 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. tableLocator text logLevel=INFO Verify the content of any table cells of the table identified by ``tableLocator`` contains ``text``. Key attributes for tables are id and name. See `Introduction` for details about locators and log levels. locator text message=NONE Verify the text area identified by ``locator`` contains ``text``. Key attributes for text areas are id and name. See `Introduction` for details about locators. locator text message=NONE Verify the text area identified by ``locator`` does not contain ``text``. Key attributes for text areas are id and name. See `Introduction` for details about locators. locator text message=NONE Verify the text area identified by ``locator`` is exactly ``text``. Key attributes for text areas are id and name. See `Introduction` for details about locators. locator text message=NONE Verify the text area identified by ``locator`` is not exactly ``text``. Key attributes for text areas are id and name. See `Introduction` for details about locators. locator text message=NONE Verify the text field identified by ``locator`` contains ``text``. Key attributes for input fields are id and name. See `Introduction` for details about locators. locator text message=NONE Verify the text field identified by ``locator`` does not contain ``text``. Key attributes for input fields are id and name. See `Introduction` for details about locators. locator text message=NONE Verify the text field identified by ``locator`` is exactly ``text``. Key attributes for input fields are id and name. See `Introduction` for details about locators. locator text message=NONE Verify the text field identified by ``locator`` is not exactly ``text``. Key attributes for input fields are id and name. See `Introduction` for details about locators. title Verify the current page title is exactly ``title`` title Verify the current page title contains ``title``. title Verify the current page title is not exactly ``title``. title Verify the current page title does not contain ``title``. locator Unselect the checkbox identified by ``locator``. Does nothing, if the checkbox is not selected. Key attributes for checkboxes are id and name. See `Introduction` for details about locators. Selects the top frame as the current frame. locator *items Unselect the given ``*items`` of the multi-select list identified by ``locator``. As a special case, giving an empty *items list will remove all selections. Tries to unselect by value AND by label. It's generally faster to use 'by index/value/label' keywords. Select list keywords work on both lists and combo boxes. Key attributes for select lists are id and name. See `Introduction` for details about locators. locator *indexes Unselect the given ``*indexes`` of the multi-select list identified by ``locator``. Select list keywords work on both lists and combo boxes. Key attributes for select lists are id and name. See `Introduction` for details about locators. locator *labels Unselect the given ``*labels`` of the multi-select list identified by ``locator``. Select list keywords work on both lists and combo boxes. Key attributes for select lists are id and name. See `Introduction` for details about locators. locator *values Unselect the given ``*values`` of the multi-select list identified by ``locator``. Select list keywords work on both lists and combo boxes. Key attributes for select lists are id and name. See `Introduction` for details about locators. condition timeout=NONE message=NONE Waits until the given JavaScript ``condition`` is true. Fails, if the timeout expires, before the condition gets true. The condition may contain multiple JavaScript statements, but the last statement must return a boolean. Otherwise this keyword will always hit the timeout. Note that by default the code will be executed in the context of the Selenium object itself, so *this* will refer to the Selenium object. Use *window* to refer to the window of your application, e.g. _window.document.getElementById('foo')_. See `Introduction` for details about timeouts. locator timeout=NONE message=NONE Waits until the element identified by ``locator`` is clickable. Fails, if the timeout expires, before the element gets clickable. See `Introduction` for details about timeouts. locator timeout=NONE message=NONE Waits until the element identified by ``locator`` is not clickable. Fails, if the timeout expires, before the element gets unclickable. See `Introduction` for details about timeouts. locator timeout=NONE message=NONE Waits until the element identified by ``locator`` is not selected. Fails, if the timeout expires, before the element gets unselected. See `Introduction` for details about timeouts. locator timeout=NONE message=NONE Waits until the element identified by ``locator`` is not visible. Fails, if the timeout expires, before the element gets invisible. See `Introduction` for details about timeouts. locator timeout=NONE message=NONE Waits until the element identified by ``locator`` is selected. Fails, if the timeout expires, before the element gets selected. See `Introduction` for details about timeouts. locator timeout=NONE message=NONE Waits until the element identified by ``locator`` is succesfully clicked on. Fails, if the timeout expires, before the element gets clicked on. See `Introduction` for details about timeouts. locator timeout=NONE message=NONE Waits until the element identified by ``locator`` is visible. Fails, if the timeout expires, before the element gets visible. See `Introduction` for details about timeouts. condition timeout=NONE message=NONE Waits until the current page contains ``text``. Fails, if the timeout expires, before the text appears. See `Introduction` for details about timeouts. locator timeout=NONE message=NONE Waits until the element identified by ``locator`` is found on the current page. Fails, if the timeout expires, before the element appears. See `Introduction` for details about timeouts. text timeout=NONE message=NONE Waits until the current page does not contain ``text``. Fails, if the timeout expires, before the text disappears. See `Introduction` for details about timeouts. locator timeout=NONE message=NONE Waits until the element identified by ``locator`` is not found on the current page. Fails, if the timeout expires, before the element disappears. See `Introduction` for details about timeouts. text timeout=NONE message=NONE Waits until the current page does not contain ``text``. Fails, if the timeout expires, before the text disappears. See `Introduction` for details about timeouts. locator timeout=NONE message=NONE Waits until the element identified by ``locator`` is not found on the current page. Fails, if the timeout expires, before the element disappears. See `Introduction` for details about timeouts. title timeout=NONE message=NONE Waits until the current page title contains ``title``. Fails, if the timeout expires, before the page title contains the given title. See `Introduction` for details about timeouts. title timeout=NONE message=NONE Waits until the current page title is exactly ``title``. Fails, if the timeout expires, before the page title matches the given title. See `Introduction` for details about timeouts. title timeout=NONE message=NONE Waits until the current page title is not exactly ``title``. Fails, if the timeout expires, before the page title does not match the given title. See `Introduction` for details about timeouts. title timeout=NONE message=NONE Waits until the current page title does not contain ``title``. Fails, if the timeout expires, before the page title does not contain the given title. See `Introduction` for details about timeouts. xpath expectedXpathCount message=NONE logLevel=INFO Verify that the page contains the ``expectedXpathCount`` of elements located by the given ``xpath``.