Using of Selenium WebDriver with py.test for test automation. Part #1

This article is the second part in the series of articles that cover Selenium and Unit Testing. All configuration stuff as well as usage of different approaches for unit testing was discovered in the first part.

Structure of the article is as follows:

• Infrastructure for test development and launching
• Special tool for communication with system under test through browser. In our case it is WebDriver.
• Special design patterns that were developed for such kind of tasks.

Let’s talk about test automation system. It consists of:

• The system or application that we would like to test and it is available for us through a browser like a web-based application.
• Special driver that allows us to send special commands to the application or receive information from the browser that were required to perform our tests. In our case it is Selenium
• Tests that we can develop or record using special tools.
• Framework for test launch. It may support functionality for launching selected or pre-defined group(s) of tests. Most known systems for Python are unittest, nosetest and py.test

So, Selenium WebDriver is a library that allows to develop tests that communicate with browser. For example, it can receive required data from browser or send special commands to the browser that can change its behavior. Selenium has special IDE that allows test recording and code generation. Also Selenium package includes Selenium Server component, it is required if we would like to launch our tests remotely. Selenium supports more known browsers like FireFox, Chrome, Internet Explorer, etc. For our article we will use FireFox, but let’s download driver for browser Google Chrome to demonstrate how tests work with both FireFox and Google Chrome. Selenium WebDriver has the capability to launch tests remotely, using Remote browser; it should work the same way for both FireFox and Chrome.

In our case workflow will have the following structure: Tests ↔ FireFox Driver ↔ FireFox ↔ Application that we would like to test.

To isolate our experiment from the original installation of the Python we will use virtual environment. Detailed information how to install it, configure it and use with Eclipse you may find in this article.

Since Selenium is needed for web-based application automation, the following list of functionality should be reviewed. It consists of actions needed for test automation development:

• Launch the web-browser
• Open the web-page
• Find the required elements (with delays and without)
• Collect information from elements on the web-page
• Perform the required actions with elements
• Quit the browser.

Sometimes switching between windows and frames is required. We will look on this functionality in the end.

Selenium home page for Python could be found on official website by the following link (http://selenium.googlecode.com/git/docs/api/py/index.html). Description of Selenium API is available via this link (http://selenium.googlecode.com/git/docs/api/py/api.html). That page is also available from the home page.

Let's quickly overview the list of commands and capabilities that Selenium framework provides to us. Since we work with a browser, Selenium has commands for browser launch and quitting it. Browser is an application so we are able to work with this window too. We can open, close it, and change size or position of the window. Selenium may also work with dialogue window for file uploading. Browser’s window contains web-page. Selenium provides us with the capability to open it, both back and next navigation, and executes JS code in context of the web-page. Each page contains elements. Selenium provides API to search elements on the page. Selenium supports emulation of mouse or keyboard actions as well as shows the properties of the web-page elements.

Launching of the browser.

Launching of the browser is executed by call of constructor for required driver

from selenium import webdriver

driver = webdriver.Firefox()

driver = webdriver.Chrome()

Each browser has its own class that represents the driver. Special constructor should be called to launch an instance of the required browser. Each browser has its own settings and list of settings is different for different browsers.

All browsers has one common parameter – capabilities (link on documentation is here (https://code.google.com/p/selenium/wiki/DesiredCapabilities)). Special instructions should be passed by using this way to change browser mode.

driver = webdriver.Firefox(capabilities={'native_events': False})

Command quit is used to stop the browser. It closes all opened windows and stop the driver. It clears all temporary files too.

driver.quit()

Command close closes current browser window, if it latest window then stop the browser. In some cases Selenium cannot identify that current window is the latest one, and as a result, it can be cause of situation when temporary files presents in the system after end of work.

driver.close()

Behavior for remote launching (with Selenium Grid) are differ from local launch. The quit function clear the session (session is moved to inactive state) and session is available for launching of new browser instance. The close function only stops the browser and do not clear the session, as a result the session will be available for next launch only after timeout.

Page opening and navigation

Function get provides capability to open web-page. This function accepts full path to the required page:

driver.get("https://www.yandex.com")

This command works synchronously. It waits till the moment when page loading process is finished. It is depends on browser.

Navigation by history is supported by the following list of commands:

driver.back()

driver.refresh()

driver.forward()

A hidden problem is related when a page has completed form and during back/refresh/forward navigation dialogue window appears with question to resubmit values from the form. Selenium does not support this feature.

Search elements on page

Selenium has two commands that can be used to find element on the page:

element = driver.find_element(by, locator)

elements = driver.find_elements(by, locator)

The first command looks for first element occurrence by special condition, the second command returns list of all elements that satisfy to special condition.

Different approaches for type of search exists:

• By.ID: the element ID should be unique across the web-page, so, the By.ID is a better and faster approach to find the element on the page.
• By.XPATH: Initially XPath was developed for XML language. Description of XPath capabilities can be found here (http://www.w3schools.com/xml/xml_xpath.asp). It is more general approaches that has more features than By.CSS_SELECTOR locator.
• By.LINK_TEXT: search by text of the link. This approach works only with link elements. Keep in mind that if application supports several languages, this approach may works incorrectly.
• By.PARTIAL_LINK_TEXT: the same like for By.LINK_TEXT
• By.NAME: this approach is used with input fields and buttons, because these elements usually has attribute name.
• By.TAG_NAME: search by name of the html tag.
• By.CLASS_NAME: search by class of the elements on the page.
• By.CSS_SELECTOR: locators that described in Cascading Style Sheets (CSS) standard (http://www.w3.org/Style/CSS/)

Selenium provides functions where locator's type included into function's name.

driver.find_element_by_id(<id to search>)

driver.find_elements_by_id(<id to search>)

driver.find_element_by_xpath(<xpath to search>)

driver.find_elements_by_xpath(<xpath to search>)

driver.find_element_by_link_text(<link text to search>)

driver.find_elements_by_link_text(<link text to search>)

driver.find_element_by_partial_link_text(<partial link text to search>)

driver.find_elements_by_partial_link_text(<partial link text to search>)

driver.find_element_by_name(<name to search>)

driver.find_elements_by_name(<name to search>)

driver.find_element_by_tag_name(<tag name to search>)

driver.find_elements_by_tag_name(<tag name to search>)

driver.find_element_by_class_name(<class name to search>)

driver.find_elements_by_class_name(<class name to search>)

driver.find_element_by_css_selector(<css selector to search>)

driver.find_elements_by_css_selector(<css selector to search>)

Selenium also supports search inside web-element by surrounding search requests in chain:

element = driver.find_element_id(<id>).

                 find_element_by_xpath(<xpath>).

                 find_element_by_name(<name>)

It is equals to:

element_with_id = driver.find_element_id(<id>)

element_with_xpath = element_with_id.find_element_by_xpath(<xpath>)

element = element_with_xpath.find_element_by_name(<name>)

If find_element function does not find anything, the NoSuchElementException will be raised, but the find_elements function returns empty list in this case. The exception or empty list can be returned not at the moment when function is called - implicit wait can be used to notify WebDriver to wait required time till check element's occurrence on web-page:

driver.implicitly_wait(<time to wait>)

Selenium uses explicit wait too. It is call of function time.sleep(<small time-out: ~0.5 sec>). Selenium encapsulates such behavior into class WebDriverWait:

from selenium.webdriver.support.wait import WebDriverWait

# initialization of explicit wait object

wait = WebDriverWait(<instance of WebDriver>, <time-out to wait>)

# using explicit wait object

element = wait.until(<condition for wait something>)

With the explicit wait functionality, we can wait for special conditions that is not possible to catch by implicit wait functionality. List of expected conditions available here (http://selenium.googlecode.com/git/docs/api/py/webdriver_support/selenium.webdriver.support.expected_conditions.html) and several good examples also available here (https://blog.mozilla.org/webqa/2012/07/12/how-to-webdriverwait/). Positive conditions or events should be checked to avoid tests slowness due to using of the explicit wait mechanism. For example, if web-page should have element a1 and shouldn't have element a2, then required condition should checks presence of element a2, and does not check absence of element a1 in source code of tests.

Differences between implicit wait and explicit wait are:

• Explicit waits works on client side, in Python source code, but implicit waits works on browser side
• Explicit waits can wait for big list of different conditions, but implicit waits waits for element appearance in DOM model
• Explicit waits should be written by the developer, but implicit waits work automatically
• Explicit waits can raise the TimeoutException, but implicit waits can raise NoSuchElementException
• Explicit waits generates a lot queries across the network, but implicit waits generates only one query that will be send to the browser.

Actions with the element

Simple actions:

• Click on links, buttons, radiobuttons and checkboxes. Select an item from the list. Clicks are emulated by command click.
• Enter text and attach file (enter special text into special input item). Text input emulated by command send_keys

Complicated actions:

• Combined keyboard actions (Ctrl + something, etc.) or navigation by arrows
• Homing or put mouse on top of element without click
• Drag and drop (with keyboard interaction)
• Right mouse buttons click

Now more details about two basic operations: click and send_keys. Both commands can be executed with any visible element and events will be generated during emulation, for example for the click command it will be mouse-down -> on-click -> mouse-up, and so on. The click command sends action at center of the element. The send_keys command adds text at the end of existed text in the element. The send_keys command can process key combinations, navigation arrows, and so on.

Operations with elements like select/toggle/check/uncheck can be emulated by series of click commands. But the select operation is a complicated one and its support has been added into WebDriver as a part of support package:

from selenium.webdriver.support.select import Select

dropdown = Select(element)

dropdown.select_by_index(1)

This class supports operations select_by_value and select_by_visible_text also.

For example if text should be entered at the beginning of the string, following list of commands is required:

from selenium.webdriver.common.keys import Keys

element.click()

element.send_keys(Keys.HOME)

element.send_keys(<some text>)

Both commands click and send_keys has two implementations for each browser: native and synthetic:

• Native events works on OS level, but synthetic works inside the browser.
• Native events is implemented on C/C++ programming language, but synthetic events is implemented using the JavaScript programming language.
• Native events emulates user behavior more clearly than synthetic.
• Native events requires focus on the browser, but synthetic not.
• Not all versions of the browser supports native events, but synthetic events works in all versions of the browser.

Lets look on complicated actions. It includes both click command and send_keys command as well as following list of complicated commands:

• move_to_element command
• click_and_hold command
• release command
• key_down command
• key_up command

Execution supported by ActionChains function. Following example demonstrates element drags and drops with the Ctrl button pressed.

Webdriver.ActionChains(driver).

    move_to_element(drag).

    key_down(Keys.CONTROL).

    click_and_hold().

    move_to_element(drop).

    release().

    key_up(Keys.CONTROL).

    perform()

Collect information about the element

• text. This property contains only visible text of the element. Invisible element have empty text.
• get_attribute. This function returns value of element's attribute. Sometimes this value can be changed, for example if attribute 'href' is requested. Selenium WebDriver returns absolute link (doesn't matter what kind of link was placed into the element initially).
• boolean attributes, these attributes has two kind of values: None or True. Selenium  returns none if attribute is not set, and True if attribute exists (it doesn't matter what value is stored in this attribute)
• Selenium returns value of the property with the same name like attribute name.
• The is_displayed method
• If required element locates before left border or above top border the is_displayed method returns true
• If required element partially covered by another element, the is_displayed method returns true
• If elements is transparent or its color are the same like background color, the is_displayed method returns true

Switch between content

The WebDriver allows switch to alert message, switch between frames and switch to another browser window. In details:

• Switch to alert:
• WebDriver has special method switch_to_alert, that return the alert if it exists. The NoAlertPresentException will be generated if no alert in the system, as well as UnhandledAlertException will be generated if no alert processing is implemented. Special function accept and dismiss of the alert object to close the alert message. Additional processing of alert window is covered by unexpectedAlertBehavior capability of the driver.
• Switch to frame. This capability is covered by function switch_to_frame
• Switch to window. Major point here is the following: the WebDriver doesn't support switching between tabs!
• List of all browser's windows can be get by function driver.window_handles()
• Handle of current window can be get by function driver.current_window_handle()
• Switch to required window by its handle can be performed by function driver.switch_to_window(<handle of required window>)
• Selenium doesn't switch back to previous window if current window was closed in program. Switch to another window (or previous window) should be done in the program too, otherwise WebDriver raises special exception.

Other browser window properties.

• get_window_size
• set_window_size
• maximize_window
• get_window_position
• set_window_position

These functions can be used for screenshot creating, avoid scrolling or for special checks with scrolling. Keep in mind, that Selenium WebDriver automatically performs auto-scroll operation if required element locates outside the window.

Implementation points

Common approach with development using Selenium is related to PageObject pattern usage. More detailed description on this pattern is here (https://code.google.com/p/selenium/wiki/PageObjects) This pattern makes test development process easier and allows to reduce amount of duplicated code into project. Benefits of PageObject pattern are:

• Clear difference between source code of tests and source code that depends on page structure
• Single repository for all web-page's services and operations

Example:

As example of usage Selenium Web-Driver as well as features and patterns from above, I will prepare simple automation for creating a mailbox on www.yahoo.com.

But it is a separate case for new post.

In any case, I've prepared initial architecture with same programming logic that could be found here.