Browser console log capture in Selenium Python - Framework Patterns

Framework Mode - Browser console log capture

Folder Structure

selenium-python-project/
├── src/
│   ├── pages/
│   │   └── login_page.py
│   ├── tests/
│   │   └── test_login.py
│   ├── utils/
│   │   └── log_capture.py
│   └── config/
│       └── config.yaml
├── requirements.txt
└── pytest.ini

Test Framework Layers

• Driver Layer: Manages Selenium WebDriver setup and teardown, including browser options to enable log capturing.
• Page Objects: Classes representing web pages, encapsulating locators and actions.
• Tests: Test scripts using pytest that perform actions and assertions, and call log capture utilities.
• Utilities: Helper functions for capturing and processing browser console logs.
• Configuration: Environment settings like browser type, URLs, and log preferences stored in config files.

Configuration Patterns

Use a config.yaml file to store environment variables such as:

• Browser type (e.g., Chrome)
• Base URL
• Log level preferences

Load these settings in test setup to configure WebDriver options, including enabling loggingPrefs for capturing browser console logs.

Example snippet to enable console log capture in Chrome options:

from selenium import webdriver
from selenium.webdriver.chrome.service import Service
from selenium.webdriver.chrome.options import Options

options = Options()
options.set_capability('goog:loggingPrefs', {'browser': 'ALL'})
driver = webdriver.Chrome(service=Service(), options=options)

Test Reporting and CI/CD Integration

• Capture browser console logs during test execution and attach them to test reports.
• Use pytest hooks or fixtures to collect logs after each test.
• Integrate with CI/CD pipelines (e.g., GitHub Actions, Jenkins) to run tests and archive logs for debugging.
• Generate HTML or XML reports that include console log summaries for failed tests.

Best Practices

1. Enable only necessary log levels to avoid large log files and improve performance.
2. Use utility functions to abstract log retrieval and filtering for reuse.
3. Capture logs immediately after test steps to correlate logs with actions.
4. Store logs per test case to simplify debugging and traceability.
5. Integrate log capture with test failure handling to automatically save logs on errors.

Self Check

Where in this folder structure would you add a new utility function to filter and save browser console logs?

Key Result

Organize Selenium Python tests with clear layers and utilities to capture and report browser console logs effectively.

Practice

1. What is the main purpose of capturing browser console logs in Selenium tests?

easy

A. To find hidden errors and warnings during test execution

B. To speed up the browser loading time

C. To change the browser's user interface

D. To increase the test execution timeout

Solution

1. Step 1: Understand browser console logs

   Browser console logs contain errors, warnings, and info messages from the browser during page load and interaction.

2. Step 2: Purpose of capturing logs in tests

   Capturing these logs helps testers find hidden errors or warnings that are not visible on the page but affect test results.

3. Final Answer:

   To find hidden errors and warnings during test execution -> Option A

4. Quick Check:

   Browser logs = find hidden errors [OK]

Hint: Browser logs reveal hidden errors during tests [OK]

Common Mistakes:

• Thinking logs speed up browser loading
• Confusing logs with UI changes
• Assuming logs affect timeout settings

2. Which of the following is the correct syntax to capture browser console logs in Selenium with Python?

easy

A. logs = driver.fetch_log('browser')

B. logs = driver.getLogs('console')

C. logs = driver.get_log('browser')

D. logs = driver.retrieve_log('console')

Solution

1. Step 1: Recall Selenium Python API for logs

   The correct method to get browser console logs is driver.get_log('browser').

2. Step 2: Check each option syntax

   Only logs = driver.get_log('browser') uses the exact correct method name and parameter. Others use incorrect method names or parameters.

3. Final Answer:

   logs = driver.get_log('browser') -> Option C

4. Quick Check:

   Correct method = get_log('browser') [OK]

Hint: Use driver.get_log('browser') to capture logs [OK]

Common Mistakes:

• Using incorrect method names like getLogs or fetch_log
• Passing wrong parameter like 'console' instead of 'browser'
• Confusing log capture with other driver methods

3. Given the following code snippet, what will be the output if the browser console has one error and one info message?

logs = driver.get_log('browser')
for entry in logs:
    print(entry['level'])

medium

A. []

B. ["INFO", "ERROR"]

C. ["WARNING", "ERROR"]

D. ["ERROR", "INFO"]

Solution

1. Step 1: Understand the code behavior

   The code fetches all browser logs and prints the 'level' field of each log entry in order.

2. Step 2: Analyze given log messages

   Since the console has one error and one info message, the output will list their levels in the order they appear: "ERROR" then "INFO".

3. Final Answer:

   ["ERROR", "INFO"] -> Option D

4. Quick Check:

   Print log levels = ["ERROR", "INFO"] [OK]

Hint: Print log['level'] to see message types in order [OK]

Common Mistakes:

• Assuming logs are sorted differently
• Confusing log levels with messages
• Expecting empty list if logs exist

4. Identify the error in this code snippet that tries to capture browser console logs:

logs = driver.get_log('console')
for log in logs:
    print(log['message'])

medium

A. Using 'log' as variable name causes conflict

B. Incorrect log type parameter; should be 'browser' instead of 'console'

C. Missing parentheses in print statement

D. No error; code is correct

Solution

1. Step 1: Check the parameter for get_log()

   The correct parameter to get browser console logs is 'browser', not 'console'.

2. Step 2: Verify other code parts

   Print statement syntax is correct, and variable name 'log' is valid. So no other errors.

3. Final Answer:

   Incorrect log type parameter; should be 'browser' instead of 'console' -> Option B

4. Quick Check:

   get_log parameter = 'browser' [OK]

Hint: Use 'browser' as parameter in get_log() [OK]

Common Mistakes:

• Using 'console' instead of 'browser' parameter
• Thinking print syntax is wrong in Python 3
• Worrying about variable names unnecessarily

5. You want to capture only error-level messages from the browser console logs in Selenium Python. Which code snippet correctly filters these logs?

hard

A. logs = [entry for entry in driver.get_log('browser') if entry['level'] == 'ERROR']

B. logs = driver.get_log('browser').filter(level='ERROR')

C. logs = driver.get_log('browser').select(entry => entry.level == 'ERROR')

D. logs = driver.get_log('browser').where(entry['level'] = 'ERROR')

Solution

1. Step 1: Understand filtering logs in Python

   Python list comprehension is used to filter logs by checking if entry['level'] equals 'ERROR'.

2. Step 2: Analyze each option's correctness

   logs = [entry for entry in driver.get_log('browser') if entry['level'] == 'ERROR'] uses valid Python syntax. Options A, B, and C use invalid or non-Python methods like filter(), select(), or where() which do not exist on lists.

3. Final Answer:

   logs = [entry for entry in driver.get_log('browser') if entry['level'] == 'ERROR'] -> Option A

4. Quick Check:

   Filter logs with list comprehension [OK]

Hint: Use list comprehension to filter logs by level [OK]

Common Mistakes:

• Using non-Python methods like filter or select on lists
• Using single equals '=' instead of '==' in conditions
• Trying to chain unsupported methods on get_log() result