Fix "sb" fixture issue that occurs with "--pdb" on failures

Author: mdmintz

seleniumbase/fixtures/base_case.py

@@ -11173,6 +11173,8 @@ def setUp(self, masterqa_mode=False):
             self.test_id = test_id
             if hasattr(self, "_using_sb_fixture"):
                 self.test_id = sb_config._test_id
+                if hasattr(sb_config, "_sb_pdb_driver"):
+                    sb_config._sb_pdb_driver = None
             self.browser = sb_config.browser
             self.account = sb_config.account
             self.data = sb_config.data
@@ -11685,6 +11687,21 @@ def __add_pytest_html_extra(self):
             except Exception:
                 pass
 
+    def __delay_driver_quit(self):
+        delay_driver_quit = False
+        if (
+            hasattr(self, "_using_sb_fixture")
+            and self._using_sb_fixture
+            and "--pdb" in sys.argv
+            and self.__has_exception()
+            and len(self._drivers_list) == 1
+            and self.driver == self._default_driver
+        ):
+            # Special case: Using sb fixture, --pdb, and has error.
+            # Keep the driver open for debugging and quit it later.
+            delay_driver_quit = True
+        return delay_driver_quit
+
     def __quit_all_drivers(self):
         if self._reuse_session and sb_config.shared_driver:
             if len(self._drivers_list) > 0:
@@ -11698,20 +11715,25 @@ def __quit_all_drivers(self):
                 self._drivers_list = self._drivers_list[1:]
             else:
                 self._drivers_list = []
-
         # Close all open browser windows
+        delay_driver_quit = self.__delay_driver_quit()
         self._drivers_list.reverse()  # Last In, First Out
         for driver in self._drivers_list:
             try:
                 if not is_windows or driver.service.process:
-                    driver.quit()
+                    if not delay_driver_quit:
+                        driver.quit()
+                    else:
+                        # Save it for later to quit it later.
+                        sb_config._sb_pdb_driver = driver
             except AttributeError:
                 pass
             except Exception:
                 pass
-        self.driver = None
-        self._default_driver = None
-        self._drivers_list = []
+        if not delay_driver_quit:
+            self.driver = None
+            self._default_driver = None
+            self._drivers_list = []
 
     def __has_exception(self):
         has_exception = False

seleniumbase/plugins/pytest_plugin.py

@@ -1345,17 +1345,32 @@ def pytest_runtest_teardown(item):
     Make sure that webdriver and headless displays have exited.
     (Has zero effect on tests using --reuse-session / --rs)"""
     try:
-        self = item._testcase
-        try:
-            if (
-                hasattr(self, "driver")
-                and self.driver
-                and "--pdb" not in sys.argv
+        if hasattr(item, "_testcase") or hasattr(sb_config, "_sb_pdb_driver"):
+            if hasattr(item, "_testcase"):
+                self = item._testcase
+                try:
+                    if (
+                        hasattr(self, "driver")
+                        and self.driver
+                        and "--pdb" not in sys.argv
+                    ):
+                        if not is_windows or self.driver.service.process:
+                            self.driver.quit()
+                except Exception:
+                    pass
+            elif (
+                hasattr(sb_config, "_sb_pdb_driver")
+                and sb_config._sb_pdb_driver
             ):
-                if not is_windows or self.driver.service.process:
-                    self.driver.quit()
-        except Exception:
-            pass
+                try:
+                    if (
+                        not is_windows
+                        or sb_config._sb_pdb_driver.service.process
+                    ):
+                        sb_config._sb_pdb_driver.quit()
+                        sb_config._sb_pdb_driver = None
+                except Exception:
+                    pass
         try:
             if hasattr(self, "xvfb") and self.xvfb:
                 if self.headless_active and "--pdb" not in sys.argv: