Test functions and classes in Selenium Python - Framework Patterns

Framework Mode - Test functions and classes

Folder Structure

tests/
├── test_login.py
├── test_search.py
├── conftest.py
page_objects/
├── login_page.py
├── search_page.py
utilities/
├── browser_factory.py
├── helpers.py
configs/
├── config.yaml
reports/
├── latest_report.html

Test Framework Layers

• Test Functions and Classes: Located in tests/. Use pytest test functions or classes to organize tests logically. Classes group related tests; functions are individual test cases.
• Page Objects: In page_objects/. Encapsulate page elements and actions as classes with methods. This keeps tests clean and readable.
• Utilities: Helper functions and browser setup in utilities/. For example, browser_factory.py manages WebDriver creation.
• Configurations: Store environment variables, URLs, credentials in configs/config.yaml. Load them in tests or fixtures.

Configuration Patterns

• Use a config.yaml file to store environment URLs, browser types, and credentials.
• Load config in conftest.py using fixtures to provide test data and browser setup.
• Allow command-line options in pytest to select browser or environment dynamically.
• Keep sensitive data out of code by using environment variables or secure vaults.

Test Reporting and CI/CD Integration

• Use pytest with plugins like pytest-html to generate readable HTML reports in reports/.
• Integrate tests into CI/CD pipelines (e.g., GitHub Actions, Jenkins) to run tests on each code push.
• Fail tests clearly when assertions fail inside test functions or classes.
• Use logs and screenshots on failure for easier debugging.

Best Practices for Test Functions and Classes

• Use descriptive test names: Name test functions and classes clearly to describe what they verify.
• Group related tests in classes: Use test classes to organize tests by feature or page.
• Keep tests independent: Each test function should run alone without relying on others.
• Use fixtures for setup/teardown: Manage browser and test data setup in conftest.py fixtures.
• Assert meaningful outcomes: Use clear assertions inside test functions to verify expected behavior.

Self Check

Where would you add a new test class for the "Checkout" feature in this framework structure?

Key Result

Organize Selenium Python tests using test functions and classes in the tests/ folder with page objects and fixtures for clean, maintainable automation.

Practice

1. What is the main purpose of using test functions and classes in Selenium Python testing?

easy

A. To organize tests clearly and run them easily

B. To make the code run faster

C. To avoid writing any assertions

D. To skip browser setup

Solution

1. Step 1: Understand test organization

   Test functions and classes help group related tests logically.

2. Step 2: Recognize ease of running tests

   Using classes and functions allows running tests easily with frameworks like unittest.

3. Final Answer:

   To organize tests clearly and run them easily -> Option A

4. Quick Check:

   Test organization = To organize tests clearly and run them easily [OK]

Hint: Tests group checks for clarity and easy running [OK]

Common Mistakes:

• Thinking tests speed up code execution
• Believing assertions are optional
• Ignoring setup and teardown roles

2. Which of the following is the correct way to define a test method inside a unittest.TestCase class in Selenium Python?

easy

A. def test_example(self):

B. def example_test():

C. def TestExample(self):

D. def _test_example(self):

Solution

1. Step 1: Recall unittest naming conventions

   Test methods must start with 'test' and accept 'self' as first parameter.

2. Step 2: Check method definitions

   Only 'def test_example(self):' follows correct naming and signature.

3. Final Answer:

   def test_example(self): -> Option A

4. Quick Check:

   Method name starts with 'test' and has 'self' [OK]

Hint: Test methods start with 'test' and include self [OK]

Common Mistakes:

• Omitting 'self' parameter
• Not starting method name with 'test'
• Using uppercase 'Test' prefix

3. What will be the output when running this test code snippet?

import unittest

class MyTest(unittest.TestCase):
    def test_pass(self):
        self.assertEqual(2 + 2, 4)

    def test_fail(self):
        self.assertTrue(False)

if __name__ == '__main__':
    unittest.main(exit=False)

medium

A. Both tests pass

B. One test passes, one test fails

C. Both tests fail

D. Syntax error occurs

Solution

1. Step 1: Analyze test_pass method

   assertEqual(2 + 2, 4) is True, so test_pass passes.

2. Step 2: Analyze test_fail method

   assertTrue(False) fails, so test_fail fails.

3. Final Answer:

   One test passes, one test fails -> Option B

4. Quick Check:

   One True, one False assertion = One test passes, one test fails [OK]

Hint: Check each assertion's truth to predict pass/fail [OK]

Common Mistakes:

• Assuming all tests pass
• Ignoring assertTrue(False) fails
• Expecting syntax errors

4. Identify the error in this Selenium Python unittest code:

import unittest
from selenium import webdriver

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

    def test_login(self):
        self.driver.get('http://example.com')
        self.assertIn('Example', self.driver.title)

    def tearDown(self):
        self.driver.quit()

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

medium

A. webdriver.Chrome() requires path argument

B. Missing call to super() in setUp and tearDown

C. No error; code is correct

D. assertIn should be assertEquals

Solution

1. Step 1: Review setup and teardown methods

   setUp creates driver; tearDown quits it properly.

2. Step 2: Check assertion and webdriver usage

   assertIn checks substring in title correctly; webdriver.Chrome() works if driver is in PATH.

3. Final Answer:

   No error; code is correct -> Option C

4. Quick Check:

   Standard unittest setup and teardown used [OK]

Hint: Check if setup/teardown and assertions follow unittest rules [OK]

Common Mistakes:

• Assuming webdriver.Chrome() always needs path
• Confusing assertIn with assertEquals
• Forgetting to quit driver in tearDown

5. You want to run multiple Selenium tests that share the same browser setup and cleanup. Which unittest structure best achieves this?

hard

A. Call unittest.main() inside each test method

B. Write separate test functions without any setup or teardown

C. Create a new webdriver instance inside each test method

D. Use a TestCase class with setUpClass and tearDownClass class methods

Solution

1. Step 1: Understand shared setup/cleanup needs

   setUpClass and tearDownClass run once for all tests in a class, ideal for shared browser setup.

2. Step 2: Evaluate other options

   Separate functions lack shared setup; new webdriver per test is inefficient; unittest.main() runs all tests, not per method.

3. Final Answer:

   Use a TestCase class with setUpClass and tearDownClass class methods -> Option D

4. Quick Check:

   Shared setup/cleanup = setUpClass/tearDownClass [OK]

Hint: Use setUpClass/tearDownClass for shared browser setup [OK]

Common Mistakes:

• Creating driver in each test wastes resources
• Calling unittest.main() multiple times causes errors
• Skipping setup causes flaky tests