Understanding Assertions in Selenium with Python

by

💡 Problem Formulation: When conducting automated web testing using Selenium with Python, it is often necessary to validate the state of a web page or the properties of its elements. Assertions provide a means to verify if the conditions of the test are met, leading to either passing or failing outcomes. This article illustrates practical ways of implementing assertions to ensure your test results are accurate and reliable.

Method 1: Using the assert Statement

The assert statement is a simple yet effective way to perform assertions in Python. It throws an AssertionError exception if a given condition evaluates to False. In the context of Selenium testing, you can use this to check properties such as page titles, element presence, or text content.

Here’s an example:

from selenium import webdriver

driver = webdriver.Chrome()
driver.get("https://www.example.com")

assert "Example Domain" in driver.title
driver.quit()

The assertion passes if the title contains “Example Domain”.

In this code snippet, an instance of Chrome WebDriver is created and navigates to “https://www.example.com”. The assert statement then checks if the string “Example Domain” is part of the page title. If it’s not, an AssertionError is raised, indicating a failed test case. Otherwise, the test passes and the browser closes.

Method 2: Using the unittest Framework

The unittest framework comes with a set of assertion methods that are meant for testing. These methods will provide more informative messages and are preferable when you’re writing numerous tests. You can use these methods to check for equality, truthiness, or even exceptions.

Here’s an example:

import unittest
from selenium import webdriver

class ExampleTest(unittest.TestCase):
    def setUp(self):
        self.driver = webdriver.Chrome()

    def test_example(self):
        self.driver.get("https://www.example.com")
        self.assertIn("Example Domain", self.driver.title)
    
    def tearDown(self):
        self.driver.quit()

if __name__ == "__main__":
    unittest.main()

Output: A test report with passed or failed states.

In this snippet, we have a test case that is a class inheriting from unittest.TestCase. It includes a test method test_example where the webpage title is checked against “Example Domain”. Using self.assertIn, the test will either pass if the title is correct, or fail with an error message showing the discrepancy.

Method 3: Using pytest Assertions

pytest supports the use of native Python assertions and improves on the output messages by providing detailed information about assert expressions and involved variables. This can be particularly useful for complex test cases involving numerous variables and conditions.

Here’s an example:

from selenium import webdriver

def test_example():
    driver = webdriver.Chrome()
    driver.get("https://www.example.com")
    assert "Example Domain" in driver.title
    driver.quit()

The output will be detailed concerning the assertion failure if it occurs.

In this example, a test function is defined without the need for a class structure. The webpage is loaded, and a simple assertion is made regarding the page title. If the assertion fails, pytest will explain why the failure occurred, which can help diagnose problems quickly.

Method 4: Using Selenium’s WebDriverWait for Assertions

In dynamic environments, immediate assertions may not be adequate because the expected conditions may not be met instantly. Using WebDriverWait in combination with expected_conditions can help assert conditions that require some wait time.

Here’s an example:

from selenium import webdriver
from selenium.webdriver.common.by import By
from selenium.webdriver.support.ui import WebDriverWait
from selenium.webdriver.support import expected_conditions as EC

driver = webdriver.Chrome()
driver.get("https://www.example.com")

element = WebDriverWait(driver, 10).until(
    EC.presence_of_element_located((By.ID, "myElement"))
)
assert element is not None
driver.quit()

The presence of the element with ID “myElement” is confirmed.

Here, Selenium waits up to 10 seconds for an element with the specified ID to be present before performing the assertion. This method is particularly powerful for AJAX-heavy sites where elements may appear or change state after some client-side processing.

Bonus One-Liner Method 5: Quick and Dirty Assertion

For a very straightforward test, you might want to just perform an assertion in a one-liner. This is less common but can be handy for very simple conditions that you expect to rarely fail.

Here’s an example:

(lambda x: 1 if x is not None else raise AssertionError)(driver.find_element_by_id('myElement'))

Raises an AssertionError if element with ID “myElement” is not present.

This lambda function immediately invokes itself with the result of the find_element_by_id method, asserting the element’s presence. As it’s all done in one line, it’s concise but not necessarily best for readability or complex logic.

Summary/Discussion

  • Method 1: Assert Statement. Simple and quick. Limited information on failure. Not the best for complex comparisons.
  • Method 2: Unittest Framework. Informative messages. Good for structured tests. Requires more boilerplate code.
  • Method 3: Pytest Assertions. Detailed failure reports. Simplified syntax. Ideal for more involved testing scenarios.
  • Method 4: WebDriverWait. Works in dynamic conditions. Allows for precise timing. More complex to set up.
  • Bonus Method 5: One-Liner Assertion. Quick for one-offs. Not recommended for regular use due to lack of legibility and limited applicability.