Retry mechanism for flaky tests in Selenium Python

Introduction

Sometimes tests fail randomly due to temporary issues. Retry mechanism helps run the test again automatically to check if it passes on retry.

When a test fails because of slow page loading or network delays.

When external services cause intermittent failures.

When UI elements take time to appear causing test failures.

When tests fail due to temporary environment glitches.

When you want to reduce false negatives in test reports.

Syntax

Selenium Python

from selenium.common.exceptions import WebDriverException
import time

def retry_test(func, retries=3, delay=2):
    for attempt in range(1, retries + 1):
        try:
            func()
            print(f"Test passed on attempt {attempt}")
            break
        except (WebDriverException, AssertionError) as e:
            print(f"Attempt {attempt} failed: {e}")
            if attempt == retries:
                raise
            time.sleep(delay)

The retry_test function takes another function func which is the test to run.

You can set how many times to retry and how long to wait between tries.

Examples

This is a simple test function to check page title.

Selenium Python

def test_example():
    # test steps here
    assert driver.title == "Home Page"

This runs test_example up to 5 times, waiting 1 second between tries if it fails.

Selenium Python

retry_test(test_example, retries=5, delay=1)

Sample Program

This script opens a browser, runs a test to check the page title, and retries up to 3 times if the test fails. It prints which attempt passed or failed. Finally, it closes the browser.

Selenium Python

from selenium import webdriver
from selenium.common.exceptions import WebDriverException
import time

# Setup WebDriver (example with Chrome)
driver = webdriver.Chrome()

def test_title():
    driver.get("https://example.com")
    assert driver.title == "Example Domain"

def retry_test(func, retries=3, delay=2):
    for attempt in range(1, retries + 1):
        try:
            func()
            print(f"Test passed on attempt {attempt}")
            break
        except (WebDriverException, AssertionError) as e:
            print(f"Attempt {attempt} failed: {e}")
            if attempt == retries:
                raise
            time.sleep(delay)

try:
    retry_test(test_title, retries=3, delay=1)
finally:
    driver.quit()

Important Notes

Use retries carefully to avoid hiding real issues.

Keep delay enough to let temporary problems clear.

Catch only expected exceptions to retry, not all errors.

Summary

Retry mechanism helps reduce false failures in flaky tests.

It runs the test multiple times with delays between tries.

Use it to handle temporary issues like slow loading or network glitches.

Practice

1. What is the main purpose of a retry mechanism in Selenium tests?

easy

A. To permanently ignore failed tests without rerunning

B. To speed up test execution by running tests in parallel

C. To rerun tests that fail due to temporary issues like slow loading

D. To generate detailed logs for every test step

Solution

1. Step 1: Understand flaky tests

   Flaky tests fail sometimes due to temporary problems like slow page loads or network delays.

2. Step 2: Purpose of retry mechanism

   Retry mechanism reruns failed tests to check if failure was temporary, reducing false failures.

3. Final Answer:

   To rerun tests that fail due to temporary issues like slow loading -> Option C

4. Quick Check:

   Retry mechanism = rerun flaky tests [OK]

Hint: Retry fixes temporary failures by rerunning tests [OK]

Common Mistakes:

• Thinking retry speeds up tests
• Assuming retry ignores failures
• Confusing retry with logging

2. Which of the following is the correct way to implement a simple retry decorator in Python for Selenium tests?

easy

A. def retry(func):
try:
func()
except Exception:
func()

B. def retry(func):
def wrapper():
for _ in range(3):
try:
return func()
except Exception:
pass
return wrapper

C. def retry(func):
while True:
func()
return func

D. def retry(func):
for _ in range(3):
func()
return func

Solution

1. Step 1: Check retry decorator structure

   def retry(func): def wrapper(): for _ in range(3): try: return func() except Exception: pass return wrapper defines a wrapper function that tries to run the test 3 times catching exceptions.

2. Step 2: Verify retry logic correctness

   def retry(func): def wrapper(): for _ in range(3): try: return func() except Exception: pass return wrapper retries on exception and returns on success, which is correct retry behavior.

3. Final Answer:

   def retry(func): def wrapper(): for _ in range(3): try: return func() except Exception: pass return wrapper -> Option B

4. Quick Check:

   Retry decorator = try 3 times with exception catch [OK]

Hint: Retry decorator wraps function with try-except loop [OK]

Common Mistakes:

• Not catching exceptions inside loop
• Infinite loops without exit
• Calling function multiple times without try-except

3. Given this retry decorator and test function, what will be printed?

def retry(func):
    def wrapper():
        for i in range(2):
            try:
                return func()
            except Exception:
                print(f"Retry {i+1} failed")
        print("All retries failed")
    return wrapper

@retry
def test():
    print("Running test")
    raise Exception("Fail")

test()

medium

A. Running test
Retry 1 failed
Running test
Retry 2 failed
All retries failed

B. Running test
All retries failed

C. Running test
Retry 1 failed
Retry 2 failed

D. Running test
Retry 1 failed
Running test
Retry 2 failed

Solution

1. Step 1: Analyze retry loop

   The wrapper tries to run test twice. Each time test() prints "Running test" then raises Exception.

2. Step 2: Trace output

   On first try, prints "Running test", then exception triggers "Retry 1 failed". Second try repeats same steps, then prints "Retry 2 failed". After loop ends, prints "All retries failed".

3. Final Answer:

   Running test Retry 1 failed Running test Retry 2 failed All retries failed -> Option A

4. Quick Check:

   Retry prints on each failure, then final failure message [OK]

Hint: Each retry prints failure message, then final failure after loop [OK]

Common Mistakes:

• Missing repeated 'Running test' print
• Ignoring final 'All retries failed' print
• Assuming retry stops after first failure

4. You wrote this retry decorator but it does not retry on failure. What is the bug?

def retry(func):
    def wrapper():
        for _ in range(3):
            try:
                func()
            except Exception:
                continue
    return wrapper

medium

A. The decorator is missing the @functools.wraps(func) call

B. The except block should raise the exception instead of continue

C. The loop should be a while loop instead of for loop

D. The function does not return the result or stop retrying on success

Solution

1. Step 1: Check retry logic

   The wrapper calls func() but never returns its result or breaks loop on success.

2. Step 2: Effect of missing return

   Without return, wrapper always completes loop and returns None, so retry never stops on success.

3. Final Answer:

   The function does not return the result or stop retrying on success -> Option D

4. Quick Check:

   Missing return causes always 3 retries even on success [OK]

Hint: Always return on success to stop retries [OK]

Common Mistakes:

• Not returning function result inside try
• Misusing continue in except block
• Ignoring decorator metadata preservation

5. You want to implement a retry mechanism in Selenium tests that retries up to 3 times with a 2-second delay between tries. Which code snippet correctly implements this?

hard

A. import time

def retry(func):
def wrapper():
for i in range(3):
try:
return func()
except Exception:
if i < 2:
time.sleep(2)
else:
raise
return wrapper

B. import time

def retry(func):
def wrapper():
for _ in range(3):
try:
func()
except Exception:
time.sleep(2)
return wrapper

C. def retry(func):
def wrapper():
try:
return func()
except Exception:
time.sleep(2)
return func()
return wrapper

D. import time

def retry(func):
def wrapper():
while True:
try:
return func()
except Exception:
time.sleep(2)
return wrapper

Solution

1. Step 1: Check retry count and delay

   import time def retry(func): def wrapper(): for i in range(3): try: return func() except Exception: if i < 2: time.sleep(2) else: raise return wrapper retries 3 times with a 2-second sleep between tries except after last attempt.

2. Step 2: Verify exception handling

   import time def retry(func): def wrapper(): for i in range(3): try: return func() except Exception: if i < 2: time.sleep(2) else: raise return wrapper raises exception after last retry, correctly stopping retries on failure.

3. Final Answer:

   import time def retry(func): def wrapper(): for i in range(3): try: return func() except Exception: if i < 2: time.sleep(2) else: raise return wrapper -> Option A

4. Quick Check:

   Retry with delay and raise after last try [OK]

Hint: Use loop with sleep and raise after last retry [OK]

Common Mistakes:

• Not raising exception after last retry
• Missing delay between retries
• Retrying infinitely without limit