Merge pull request #1265 from seleniumbase/fix-issue-with-sb-pdb-during-failures

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

Author: mdmintz

README.md

@@ -78,6 +78,13 @@ pip install -e .  # Editable install
 
 > (When using a virtual env, the Editable install is faster.)
 
+To upgrade an existing install from a GitHub clone:
+
+```bash
+git pull  # To pull the latest version
+pip install -e .  # Or "pip install ."
+```
+
 🔵 Installing ``seleniumbase`` from PyPI:
 
 ```bash
@@ -88,6 +95,12 @@ pip install seleniumbase
 > (Add ``--force-reinstall`` to also install the latest dependencies.)
 > (Use ``pip3`` if multiple versions of Python are installed.)
 
+To upgrade an existing install from PyPI:
+
+```bash
+pip install -U seleniumbase
+```
+
 🔵 Type ``seleniumbase`` or ``sbase`` to verify that SeleniumBase was installed successfully:
 
 ```bash

examples/xpath_test.py

@@ -7,4 +7,5 @@ def test_xpath(self):
         self.assert_element('//h1[(text()="Demo Page")]')
         self.type('//*[@id="myTextInput"]', "XPath Test!")
         self.click('//button[starts-with(text(),"Click Me")]')
+        self.assert_element('//button[contains(., "Purple")]')
         self.assert_text("SeleniumBase", '//table/tbody/tr[1]/td[2]/h2')

help_docs/install.md

@@ -8,6 +8,12 @@
 pip install seleniumbase
 ```
 
+To upgrade an existing ``seleniumbase`` install from PyPI:
+
+```bash
+pip install -U seleniumbase
+```
+
 <h4>If installing SeleniumBase from a Git clone, use:</h4>
 
 ```bash
@@ -24,6 +30,13 @@ cd SeleniumBase/
 pip install -e .
 ```
 
+To upgrade an existing ``seleniumbase`` install from GitHub:
+
+```bash
+git pull  # To pull the latest version
+pip install -e .  # Or "pip install ."
+```
+
 <h4>If installing SeleniumBase from a <a href="https://github.com/seleniumbase/SeleniumBase">GitHub branch</a>, use:</h4>
 
 ```bash

mkdocs_build/requirements.txt

@@ -13,7 +13,7 @@ pyparsing==3.0.7
 keyring==23.5.0
 pkginfo==1.8.2
 Jinja2==3.1.1
-click==8.0.4
+click==8.1.2
 zipp==3.7.0
 readme-renderer==34.0
 pymdown-extensions==9.3

requirements.txt

@@ -6,7 +6,7 @@ packaging>=21.3;python_version>="3.6"
 setuptools>=44.1.1;python_version<"3.5"
 setuptools>=50.3.2;python_version>="3.5" and python_version<"3.6"
 setuptools>=59.6.0;python_version>="3.6" and python_version<"3.7"
-setuptools>=61.1.1;python_version>="3.7"
+setuptools>=61.3.0;python_version>="3.7"
 setuptools-scm>=5.0.2;python_version<"3.6"
 setuptools-scm>=6.4.2;python_version>="3.6"
 tomli>=1.2.3;python_version>="3.6" and python_version<"3.7"

seleniumbase/__version__.py

@@ -1,2 +1,2 @@
 # seleniumbase package
-__version__ = "2.4.27"
+__version__ = "2.4.28"

seleniumbase/console_scripts/sb_mkdir.py

@@ -274,6 +274,7 @@ def main():
     data.append("saved_cookies")
     data.append("recordings")
     data.append("visual_baseline")
+    data.append(".DS_Store")
     data.append("selenium-server-standalone.jar")
     data.append("proxy.zip")
     data.append("proxy.lock")

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:

setup.py

@@ -49,7 +49,7 @@
         print("\n*** Installing build: *** (Required for PyPI uploads)\n")
         os.system("python -m pip install --upgrade 'build>=0.7.0'")
         print("\n*** Installing twine: *** (Required for PyPI uploads)\n")
-        os.system("python -m pip install --upgrade 'twine>=3.8.0'")
+        os.system("python -m pip install --upgrade 'twine>=4.0.0'")
         print("\n*** Installing tqdm: *** (Required for PyPI uploads)\n")
         os.system("python -m pip install --upgrade 'tqdm>=4.63.1'")
         print("\n*** Rebuilding distribution packages: ***\n")
@@ -131,7 +131,7 @@
         'setuptools>=44.1.1;python_version<"3.5"',
         'setuptools>=50.3.2;python_version>="3.5" and python_version<"3.6"',
         'setuptools>=59.6.0;python_version>="3.6" and python_version<"3.7"',
-        'setuptools>=61.1.1;python_version>="3.7"',
+        'setuptools>=61.3.0;python_version>="3.7"',
         'setuptools-scm>=5.0.2;python_version<"3.6"',
         'setuptools-scm>=6.4.2;python_version>="3.6"',
         'tomli>=1.2.3;python_version>="3.6" and python_version<"3.7"',