Prevent ChromeDriver from generating backtrace logs in cases of Selenium test failures

Question

Prevent ChromeDriver from generating backtrace logs in cases of Selenium test failures

I am facing an issue with excessive logging by the ChromeDriver

Whenever a Selenium test fails, in addition to the regular error logs in the terminal, I receive backtrace messages like:

Stacktrace:
Backtrace:
    Ordinal0 [0x00B378B3+2193587]
    Ordinal0 [0x00AD0681+1771137]
    Ordinal0 [0x009E41A8+803240]
    ...

Is there a way to disable this backtrace? (preferably in Python :)

My configuration:

Windows 10    
Python 3.8.3    
Selenium 4.4.3    
Chrome: 105.0.5195.127 
ChromeDriver: 105.0.5195.52

I have already gone through the following discussions but haven't found a clear solution:
https://github.com/SeleniumHQ/selenium/issues/9977
https://bugs.chromium.org/p/chromedriver/issues/detail?id=3944

Checked options:

   service.log_file = -1
   opts.add_argument('--incognito')
   opts.add_argument('--log-level=0')
   opts.add_experimental_option('excludeSwitches', ['enable-logging'])
   driver = Chrome(service=service, options=opts, service_log_path='NUL')

Sample code snippet

from unittest import TestCase

from selenium import webdriver
from selenium.webdriver.common.by import By
from selenium.webdriver.support import expected_conditions
from selenium.webdriver.support.wait import WebDriverWait
from selenium.webdriver.chrome.service import Service as ChromeService
from webdriver_manager.chrome import ChromeDriverManager


class SelBacktrace(TestCase):
    def setUp(self):
        service = ChromeService(ChromeDriverManager().install())
        service.log_file = -1
        opts = webdriver.ChromeOptions()
        opts.add_argument("--log-level=0")
        opts.add_experimental_option('excludeSwitches', ['enable-logging'])
        self.driver = webdriver.Chrome(service=service, options=opts, service_log_path='NUL')
        self.driver.get('https://httpbin.org/anything/')

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

    def test_backtrace(self):
        element_located = expected_conditions.visibility_of_element_located((By.CSS_SELECTOR, '.unexisting'))
        WebDriverWait(self.driver, 1).until(element_located)

Output example

Error
Traceback (most recent call last):
  File "C:\backtrace\test.py", line 27, in test_backtrace
    WebDriverWait(self.driver, 1).until(element_located)
  File "C:\backtrace\venv\lib\site-packages\selenium\webdriver\support\wait.py", line 90, in until
    raise TimeoutException(message, screen, stacktrace)
selenium.common.exceptions.TimeoutException: Message: 
Stacktrace:
Backtrace:
    Ordinal0 [0x0023DF13+2219795]
    Ordinal0 [0x001D2841+1779777]
    Ordinal0 [0x000E423D+803389]
    ...
    (No symbol) [0x00000000]

Process finished with exit code 1

python selenium selenium-chromedriver stack-trace

Answer 1

Answer №1

To enhance the readability of basic selenium calls, you can implement a cleaner error output mechanism. Below is a comprehensive example that can be executed using pytest or pythom -m unittest (the file is named refined_raw.py):

import sys
from selenium import webdriver
from selenium.webdriver.support import expected_conditions as EC
from selenium.webdriver.support.ui import WebDriverWait
from unittest import TestCase

class RefinedRawSelenium(TestCase):
    # Setup method to initialize driver and configure options
    def setUp(self):
        self.driver = None
        options = webdriver.ChromeOptions()
        options.add_argument("--disable-notifications")
        if "linux" in sys.platform:
            options.add_argument("--headless")
        options.add_experimental_option(
            "excludeSwitches", ["enable-automation", "enable-logging"],
        )
        prefs = {
            "credentials_enable_service": False,
            "profile.password_manager_enabled": False,
        }
        options.add_experimental_option("prefs", prefs)
        self.driver = webdriver.Chrome(options=options)

  	# Teardown method to quit the driver
    def tearDown(self):
        if self.driver:
            try:
                if self.driver.service.process:
                    self.driver.quit()
            except Exception:
                pass

  	# Method to wait for element visibility
    def wait_for_element_visible(
        self, selector, by="css selector", timeout=5
    ):
        try:
            return WebDriverWait(self.driver, timeout).until(
                EC.visibility_of_element_located((by, selector))
            )
        except Exception:
            raise Exception(
                f"Selector {selector} was not visible after {timeout} seconds!"
            )

  	# Methods for interacting with elements
    def open(self, url):
        self.driver.get(url)

    def click(self, selector, by="css selector", timeout=5):
        el = self.wait_for_element_visible(selector, by=by, timeout=timeout)
        el.click()

    def type(self, selector, text, by="css selector", timeout=5):
        el = self.wait_for_element_visible(selector, by=by, timeout=timeout)
        el.clear()
        if not text.endswith("\n"):
            el.send_keys(text)
        else:
            el.send_keys(text[:-1])
            el.submit()

    # Assertion methods for verifying element presence and text
    def assert_element(self, selector, by="css selector", timeout=5):
        self.wait_for_element_visible(selector, by=by, timeout=timeout)

    def assert_text(self, text, selector="html", by="css selector", timeout=5):
        el = self.wait_for_element_visible(selector, by=by, timeout=timeout)
        self.assertIn(text, el.text)

    def assert_exact_text(self, text, selector, by="css selector", timeout=5):
        el = self.wait_for_element_visible(selector, by=by, timeout=timeout)
        self.assertEqual(text, el.text)

    # Test case for adding an item to the cart
    def test_add_item_to_cart(self):
        self.open("https://www.saucedemo.com")
        self.type("#user-name", "standard_user")
        self.type("#password", "secret_sauce\n")
        self.assert_element("div.inventory_list")
        self.assert_text("PRODUCTS", "span.title")
        self.click('button[name*="backpack"]')
        self.click("#shopping_cart_container a")
        self.assert_exact_text("YOUR CART", "span.title")
        self.assert_text("Backpack", "div.cart_item")
        self.click("#react-burger-menu-btn")
        self.click("a#logout_sidebar_link")
        self.assert_element("input#login-button")

When running the test with pytest, the output looks like this:

$ pytest refined_raw.py 
======================================= test session starts
platform darwin -- Python 3.10.5, pytest-7.1.3, pluggy-1.0.0
collected 1 item                                                                                   

refined_raw.py .

======================================== 1 passed in 4.62s

Running the test with python -m unittest produces the following result:

$ python -m unittest refined_raw.py 
.
----------------------------------------------------------------------
Ran 1 test in 4.199s
OK

In case you deliberately introduce a fake selector to fail the test on purpose, the output will indicate:

Exception: Selector {fake.element} was not visible after 5 seconds!

Before diving into wrapping all your selenium methods for specific outputs, consider exploring https://github.com/seleniumbase/SeleniumBase, a framework that automates these functionalities and more. (Full disclosure: This framework was developed by me over multiple years for Python and Selenium.)

Answer 2

To enhance the readability of basic selenium calls, you can implement a cleaner error output mechanism. Below is a comprehensive example that can be executed using pytest or pythom -m unittest (the file is named refined_raw.py):

import sys
from selenium import webdriver
from selenium.webdriver.support import expected_conditions as EC
from selenium.webdriver.support.ui import WebDriverWait
from unittest import TestCase

class RefinedRawSelenium(TestCase):
    # Setup method to initialize driver and configure options
    def setUp(self):
        self.driver = None
        options = webdriver.ChromeOptions()
        options.add_argument("--disable-notifications")
        if "linux" in sys.platform:
            options.add_argument("--headless")
        options.add_experimental_option(
            "excludeSwitches", ["enable-automation", "enable-logging"],
        )
        prefs = {
            "credentials_enable_service": False,
            "profile.password_manager_enabled": False,
        }
        options.add_experimental_option("prefs", prefs)
        self.driver = webdriver.Chrome(options=options)

  	# Teardown method to quit the driver
    def tearDown(self):
        if self.driver:
            try:
                if self.driver.service.process:
                    self.driver.quit()
            except Exception:
                pass

  	# Method to wait for element visibility
    def wait_for_element_visible(
        self, selector, by="css selector", timeout=5
    ):
        try:
            return WebDriverWait(self.driver, timeout).until(
                EC.visibility_of_element_located((by, selector))
            )
        except Exception:
            raise Exception(
                f"Selector {selector} was not visible after {timeout} seconds!"
            )

  	# Methods for interacting with elements
    def open(self, url):
        self.driver.get(url)

    def click(self, selector, by="css selector", timeout=5):
        el = self.wait_for_element_visible(selector, by=by, timeout=timeout)
        el.click()

    def type(self, selector, text, by="css selector", timeout=5):
        el = self.wait_for_element_visible(selector, by=by, timeout=timeout)
        el.clear()
        if not text.endswith("\n"):
            el.send_keys(text)
        else:
            el.send_keys(text[:-1])
            el.submit()

    # Assertion methods for verifying element presence and text
    def assert_element(self, selector, by="css selector", timeout=5):
        self.wait_for_element_visible(selector, by=by, timeout=timeout)

    def assert_text(self, text, selector="html", by="css selector", timeout=5):
        el = self.wait_for_element_visible(selector, by=by, timeout=timeout)
        self.assertIn(text, el.text)

    def assert_exact_text(self, text, selector, by="css selector", timeout=5):
        el = self.wait_for_element_visible(selector, by=by, timeout=timeout)
        self.assertEqual(text, el.text)

    # Test case for adding an item to the cart
    def test_add_item_to_cart(self):
        self.open("https://www.saucedemo.com")
        self.type("#user-name", "standard_user")
        self.type("#password", "secret_sauce\n")
        self.assert_element("div.inventory_list")
        self.assert_text("PRODUCTS", "span.title")
        self.click('button[name*="backpack"]')
        self.click("#shopping_cart_container a")
        self.assert_exact_text("YOUR CART", "span.title")
        self.assert_text("Backpack", "div.cart_item")
        self.click("#react-burger-menu-btn")
        self.click("a#logout_sidebar_link")
        self.assert_element("input#login-button")

When running the test with pytest, the output looks like this:

$ pytest refined_raw.py 
======================================= test session starts
platform darwin -- Python 3.10.5, pytest-7.1.3, pluggy-1.0.0
collected 1 item                                                                                   

refined_raw.py .

======================================== 1 passed in 4.62s

Running the test with python -m unittest produces the following result:

$ python -m unittest refined_raw.py 
.
----------------------------------------------------------------------
Ran 1 test in 4.199s
OK

In case you deliberately introduce a fake selector to fail the test on purpose, the output will indicate:

Exception: Selector {fake.element} was not visible after 5 seconds!

Before diving into wrapping all your selenium methods for specific outputs, consider exploring https://github.com/seleniumbase/SeleniumBase, a framework that automates these functionalities and more. (Full disclosure: This framework was developed by me over multiple years for Python and Selenium.)

Prevent ChromeDriver from generating backtrace logs in cases of Selenium test failures

Answer №1

Similar questions

What is the method to verify open transactions on a psycopg2 connection?

What is the process for connecting the data from one instance of object A to the matching instance of object B?

Is there a way to ensure that the Selenium Chromedriver waits for the window to be maximized before proceeding?

Encountered a NoReverseMatch error in Django 1.10.2 stating that the reverse for 'django.contrib.auth.views.login' with empty arguments and keyword arguments was not found

The interpolation range has been exceeded by a value in x_new, resulting in a ValueError

Deducing characteristics of Azure virtual machines from text with Python Software Development Kit

Divide a sequence of size N into smaller subsequences so that the total sum of each subarray is below a given value M. Ensure that the cut made minimizes the sum of the maximum element

How to retrieve webpage data using Python's "login with Google" authentication

Is Selenium's Expected Conditions checking if an element is ready to be interacted with?

I'm struggling to understand the issue with my global variables in my Python project

Utilizing Selenium to pinpoint an HTML element through xpath

What is the best way to find an onmouseover element with Selenium in Python?

Encountered ElementNotInteractableException while trying to interact with a Twitter comment

Django could not locate the designated URL

Perplexing dilemma with connecting Python to MySQL

Tips for retaining the request.referer value during a redirect following an unsuccessful login attempt

What causes a blank page to appear in Firefox upon initial execution with Selenium?

Transformation of Python try-except (or try-catch) code block into VBA for a simple Excel-Selenium workflow

Shuffling the way integers behave

Encountering a TCP connection timeout error (110: Connection timed out) on AWS when utilizing Scrapy