Custom expected conditions in Selenium Python - Framework Patterns

Framework Mode - Custom expected conditions

Folder Structure

selenium_project/
├── tests/
│   ├── test_login.py
│   └── test_dashboard.py
├── pages/
│   ├── login_page.py
│   └── dashboard_page.py
├── expected_conditions/
│   └── custom_conditions.py
├── utils/
│   ├── browser_factory.py
│   └── helpers.py
├── config/
│   ├── config.yaml
│   └── credentials.yaml
├── conftest.py
└── requirements.txt
  

Test Framework Layers

• Driver Layer: Manages browser setup and teardown (e.g., browser_factory.py).
• Page Objects: Encapsulate page elements and actions (e.g., login_page.py).
• Custom Expected Conditions: Contains reusable wait conditions beyond built-in ones (e.g., custom_conditions.py).
• Tests: Test cases using page objects and expected conditions (e.g., test_login.py).
• Utilities: Helper functions and common utilities (e.g., helpers.py).
• Configuration: Environment settings and credentials (e.g., config.yaml).

Configuration Patterns

• Environment Files: Use YAML files (config/config.yaml) to store URLs, timeouts, and browser preferences.
• Credentials: Store sensitive data separately in credentials.yaml and load securely.
• Browser Selection: Parameterize browser choice in conftest.py or browser_factory.py for flexibility.
• Timeouts: Define explicit wait times in config to use in custom expected conditions.

Test Reporting and CI/CD Integration

• Use pytest with plugins like pytest-html or allure-pytest for clear, readable reports.
• Integrate tests into CI/CD pipelines (e.g., GitHub Actions, Jenkins) to run on every code push.
• Configure reports to be saved as artifacts for easy access after test runs.
• Include screenshots on failure using hooks in conftest.py to help debug custom expected condition failures.

Framework Design Principles

1. Single Responsibility: Keep custom expected conditions focused on one clear wait condition.
2. Reusability: Write custom conditions as reusable functions or classes to avoid duplication.
3. Explicit Waits: Use custom expected conditions with Selenium's WebDriverWait for reliable synchronization.
4. Readable Naming: Name custom conditions clearly to describe what they wait for, improving test readability.
5. Parameterization: Allow custom conditions to accept parameters for flexibility (e.g., element locator, text to wait for).

Self Check

Where would you add a new custom expected condition that waits for an element's CSS class to change?

Key Result

Organize custom expected conditions in a dedicated folder to create reusable, clear, and reliable wait conditions integrated with page objects and tests.

Practice

1. What is the main purpose of creating a custom expected condition in Selenium Python?

easy

A. To change the browser window size automatically

B. To speed up the browser loading time

C. To wait for a specific condition that is not covered by built-in expected conditions

D. To generate test reports automatically

Solution

1. Step 1: Understand built-in expected conditions

   Built-in expected conditions cover common waits like element visibility or clickability.

2. Step 2: Identify the need for custom conditions

   When a specific wait is not available, custom expected conditions let you define exactly what to wait for.

3. Final Answer:

   To wait for a specific condition that is not covered by built-in expected conditions -> Option C

4. Quick Check:

   Custom expected conditions = wait for custom needs [OK]

Hint: Custom conditions handle waits built-ins can't cover [OK]

Common Mistakes:

• Thinking custom conditions speed up browser loading
• Confusing custom conditions with browser resizing
• Assuming custom conditions generate reports

2. Which of the following is the correct way to define a custom expected condition class in Selenium Python?

easy

A. class MyCondition:
def __call__(self, driver):
return driver.title == 'Home'

B. def MyCondition(driver):
return driver.title == 'Home'

C. class MyCondition:
def call(self, driver):
return driver.title == 'Home'

D. class MyCondition:
def __init__(self, driver):
return driver.title == 'Home'

Solution

1. Step 1: Recall the special method for callable classes

   The method __call__ makes an instance callable like a function.

2. Step 2: Check method signature and return

   The __call__ method takes driver and returns a boolean or element to wait for.

3. Final Answer:

   class MyCondition:\n def __call__(self, driver):\n return driver.title == 'Home' -> Option A

4. Quick Check:

   Custom condition class needs __call__ method [OK]

Hint: Use __call__ method to make class callable [OK]

Common Mistakes:

• Using call instead of __call__ method
• Defining __init__ to return a value
• Defining a function instead of a class

3. Given this custom expected condition class, what will WebDriverWait(driver, 10).until(MyCondition()) return if the page title is 'Dashboard'?

class MyCondition:
    def __call__(self, driver):
        if driver.title == 'Dashboard':
            return True
        else:
            return False

medium

A. It will raise a TimeoutException immediately

B. It will return the driver object

C. It will return False immediately without waiting

D. It will wait until the title is 'Dashboard' and then return True

Solution

1. Step 1: Understand WebDriverWait with custom condition

   WebDriverWait calls the condition repeatedly until it returns a truthy value or timeout.

2. Step 2: Analyze the condition's return value

   If the title is 'Dashboard', __call__ returns True, so wait ends and returns True.

3. Final Answer:

   It will wait until the title is 'Dashboard' and then return True -> Option D

4. Quick Check:

   Condition returns True -> wait ends successfully [OK]

Hint: Wait ends when condition returns True [OK]

Common Mistakes:

• Thinking it raises TimeoutException immediately
• Assuming it returns False immediately
• Confusing return value with driver object

4. Identify the error in this custom expected condition class:

class ElementHasText:
    def __call__(self, driver):
        element = driver.find_element(By.ID, 'msg')
        if element.text:
            return element.text
        else:
            return False

medium

A. Missing import for By from selenium.webdriver.common.by

B. The __call__ method should return True or False only, not text

C. The class should inherit from WebDriverWait

D. The find_element method should be find_elements

Solution

1. Step 1: Check usage of By.ID in the code

   The code uses By.ID but does not import By, causing a NameError.

2. Step 2: Verify other parts of the code

   Returning element.text is valid for expected conditions; inheritance from WebDriverWait is not required.

3. Final Answer:

   Missing import for By from selenium.webdriver.common.by -> Option A

4. Quick Check:

   Using By requires importing it first [OK]

Hint: Always import By before using it [OK]

Common Mistakes:

• Assuming __call__ must return only True/False
• Thinking class must inherit WebDriverWait
• Confusing find_element with find_elements

5. You want to create a custom expected condition that waits until an element with ID 'status' has text containing the word 'Complete'. Which of these implementations is correct and efficient?

hard

A. class StatusComplete:
def __call__(self, driver):
element = driver.find_element(By.ID, 'status')
return element.text.startswith('Complete')

B. class StatusComplete:
def __call__(self, driver):
element = driver.find_element(By.ID, 'status')
return 'Complete' in element.text

C. class StatusComplete:
def __call__(self, driver):
element = driver.find_element(By.ID, 'status')
if element.text == 'Complete':
return True
else:
return False

D. class StatusComplete:
def __call__(self, driver):
element = driver.find_element(By.ID, 'status')
return element.text != ''

Solution

1. Step 1: Understand the requirement

   We want to wait until the text contains the word 'Complete' anywhere inside.

2. Step 2: Analyze each option's condition

   class StatusComplete: def __call__(self, driver): element = driver.find_element(By.ID, 'status') return 'Complete' in element.text checks if 'Complete' is in element.text, which matches the requirement exactly and returns a boolean.

3. Step 3: Compare other options

   class StatusComplete: def __call__(self, driver): element = driver.find_element(By.ID, 'status') if element.text == 'Complete': return True else: return False checks exact equality, which is too strict. class StatusComplete: def __call__(self, driver): element = driver.find_element(By.ID, 'status') return element.text.startswith('Complete') checks startswith, which is partial. class StatusComplete: def __call__(self, driver): element = driver.find_element(By.ID, 'status') return element.text != '' only checks non-empty text, which is too broad.

4. Final Answer:

   class StatusComplete:\n def __call__(self, driver):\n element = driver.find_element(By.ID, 'status')\n return 'Complete' in element.text -> Option B

5. Quick Check:

   Use 'in' to check substring presence [OK]

Hint: Use 'in' operator to check substring in text [OK]

Common Mistakes:

• Checking exact equality instead of substring
• Using startswith instead of contains
• Checking only for non-empty text