Why evidence collection supports debugging in Selenium Python - Framework Benefits

Framework Mode - Why evidence collection supports debugging

Folder Structure

selenium-python-framework/
├── tests/
│   ├── test_login.py
│   └── test_checkout.py
├── pages/
│   ├── login_page.py
│   └── checkout_page.py
├── utils/
│   ├── logger.py
│   ├── screenshot_helper.py
│   └── evidence_collector.py
├── config/
│   ├── config.yaml
│   └── env.py
├── reports/
│   └── test_report.html
├── conftest.py
└── requirements.txt

Test Framework Layers

• Driver Layer: Manages Selenium WebDriver setup and teardown (in conftest.py).
• Page Objects: Classes in pages/ that represent web pages with locators and actions.
• Tests: Test scripts in tests/ that use page objects and assertions.
• Utilities: Helper modules in utils/ for logging, screenshots, and evidence collection.
• Configuration: Files in config/ for environment settings, credentials, and browser options.
• Reports: Generated test reports stored in reports/ for test results and evidence.

Configuration Patterns

• Environment Settings: Use config/config.yaml to define URLs, timeouts, and environment-specific data.
• Browser Options: Configure browser type and headless mode in env.py or via command line arguments.
• Credentials: Store sensitive data securely, e.g., environment variables or encrypted files, accessed in config/env.py.
• Evidence Settings: Configure when to capture screenshots or logs (e.g., on failure) in config.yaml.

Test Reporting and CI/CD Integration

• Test Reports: Generate HTML reports with embedded screenshots and logs for failed tests.
• Evidence Collection: Automatically save screenshots and logs during test failures to reports/evidence/.
• CI/CD Integration: Integrate with pipelines (e.g., GitHub Actions, Jenkins) to run tests and publish reports.
• Notifications: Configure alerts with links to evidence for quick debugging.

Best Practices for Evidence Collection Supporting Debugging

1. Capture Screenshots on Failure: Automatically take screenshots when a test fails to see the exact page state.
2. Save Browser Logs: Collect console logs to detect JavaScript errors or warnings.
3. Use Clear Naming Conventions: Name evidence files with test name and timestamp for easy identification.
4. Keep Evidence Organized: Store evidence in structured folders by date and test suite.
5. Integrate Evidence in Reports: Embed screenshots and logs in test reports for quick access during debugging.

Self Check

Where in this framework structure would you add a new utility to capture browser console logs during test failures?

Key Result

Collecting screenshots and logs automatically during test failures helps quickly find and fix bugs.

Practice

1. Why is collecting evidence like screenshots and logs important when debugging database tests in Selenium Python?

easy

A. It automatically fixes errors in the database.

B. It helps quickly find and fix problems by showing what happened during tests.

C. It replaces the need to write test cases.

D. It slows down the test execution and should be avoided.

Solution

1. Step 1: Understand the role of evidence collection

   Evidence like screenshots and logs capture the state and actions during tests, providing clues about failures.

2. Step 2: Connect evidence to debugging efficiency

   Having this information helps developers quickly identify where and why a problem happened, speeding up fixes.

3. Final Answer:

   It helps quickly find and fix problems by showing what happened during tests. -> Option B

4. Quick Check:

   Evidence collection = faster debugging [OK]

Hint: Remember: evidence shows what happened to fix issues fast [OK]

Common Mistakes:

• Thinking evidence slows tests
• Believing evidence replaces test cases
• Assuming evidence fixes errors automatically

2. Which of the following is the correct way to save a screenshot in Selenium Python during a database test?

easy

A. driver.capture('image.png')

B. driver.take_screenshot('image.png')

C. driver.screenshot_save('image.png')

D. driver.save_screenshot('image.png')

Solution

1. Step 1: Recall Selenium Python screenshot method

   The correct method to save a screenshot is save_screenshot on the driver object.

2. Step 2: Verify method names

   Other options like take_screenshot, capture, or screenshot_save are not valid Selenium methods.

3. Final Answer:

   driver.save_screenshot('image.png') -> Option D

4. Quick Check:

   Correct method = save_screenshot [OK]

Hint: Use driver.save_screenshot() to capture images [OK]

Common Mistakes:

• Using incorrect method names
• Confusing screenshot with capture
• Misspelling method names

3. Given this Selenium Python code snippet during a database test:

logs = driver.get_log('browser')
print(len(logs))

What does the output represent?

medium

A. The number of database rows returned by the query.

B. The number of screenshots taken.

C. The number of browser log entries collected during the test.

D. The number of errors fixed automatically.

Solution

1. Step 1: Understand driver.get_log('browser')

   This command fetches browser console logs collected during the test run.

2. Step 2: Interpret len(logs)

   Counting the logs with len(logs) gives how many log entries were captured.

3. Final Answer:

   The number of browser log entries collected during the test. -> Option C

4. Quick Check:

   len(logs) = count of browser logs [OK]

Hint: get_log('browser') returns browser console logs list [OK]

Common Mistakes:

• Confusing logs with database rows
• Thinking logs count screenshots
• Assuming logs fix errors

4. You wrote this code to save a screenshot during a database test:

driver.screenshot('test.png')

But it raises an error. What is the problem?

medium

A. The method name is incorrect; it should be save_screenshot.

B. The file extension .png is not supported.

C. Screenshots cannot be saved during database tests.

D. The driver object is missing a required argument.

Solution

1. Step 1: Check the method name used

   The method screenshot does not exist; the correct method is save_screenshot.

2. Step 2: Confirm file extension and usage

   PNG is a valid format and screenshots can be saved during tests; no missing arguments needed here.

3. Final Answer:

   The method name is incorrect; it should be save_screenshot. -> Option A

4. Quick Check:

   Correct method = save_screenshot [OK]

Hint: Use save_screenshot, not screenshot, to save images [OK]

Common Mistakes:

• Using wrong method name
• Thinking .png is invalid
• Assuming screenshots not allowed in DB tests

5. In a Selenium Python test for a database-driven web app, you want to collect evidence only when a test fails. Which approach best supports this?

hard

A. Use a try-except block to catch errors and save screenshots and logs only on failure.

B. Always save screenshots and logs regardless of test result to save time.

C. Skip evidence collection to speed up tests and rely on console messages.

D. Manually check the database after tests instead of collecting evidence.

Solution

1. Step 1: Understand conditional evidence collection

   Collecting evidence only on failure saves storage and focuses debugging efforts.

2. Step 2: Use try-except to detect failures

   A try-except block can catch exceptions during tests and trigger evidence saving only when errors occur.

3. Step 3: Evaluate other options

   Always saving wastes resources, skipping evidence loses info, and manual DB checks are slow and error-prone.

4. Final Answer:

   Use a try-except block to catch errors and save screenshots and logs only on failure. -> Option A

5. Quick Check:

   Try-except for conditional evidence = best practice [OK]

Hint: Save evidence only on failure using try-except [OK]

Common Mistakes:

• Saving evidence always wastes resources
• Skipping evidence loses debugging info
• Relying on manual DB checks is slow