Add "--rcs" option to reuse session for tests in same class

Author: mdmintz

seleniumbase/core/session_helper.py

@@ -0,0 +1,26 @@
+import sys
+from seleniumbase import config as sb_config
+
+is_windows = False
+if sys.platform in ["win32", "win64", "x64"]:
+    is_windows = True
+
+
+def end_reused_class_session_as_needed():
+    if (
+        hasattr(sb_config, "reuse_class_session")
+        and sb_config.reuse_class_session
+        and hasattr(sb_config, "shared_driver")
+        and sb_config.shared_driver
+    ):
+        if (
+            not is_windows
+            or (
+                hasattr(sb_config.shared_driver, "service")
+                and sb_config.shared_driver.service.process
+            )
+        ):
+            try:
+                sb_config.shared_driver.quit()
+            except Exception:
+                sb_config.shared_driver = None

seleniumbase/fixtures/base_case.py

@@ -64,6 +64,7 @@ def test_anything(self):
 from seleniumbase.config import settings
 from seleniumbase.core import download_helper
 from seleniumbase.core import log_helper
+from seleniumbase.core import session_helper
 from seleniumbase.fixtures import constants
 from seleniumbase.fixtures import css_to_xpath
 from seleniumbase.fixtures import js_utils
@@ -14610,6 +14611,37 @@ def tearDown(self):
             # User forgot to call "self.process_deferred_asserts()" in test
             raise deferred_exception
 
+    def __end_reused_class_session_as_needed(self):
+        if (
+            hasattr(sb_config, "reuse_class_session")
+            and sb_config.reuse_class_session
+            and hasattr(sb_config, "shared_driver")
+            and sb_config.shared_driver
+        ):
+            if (
+                not is_windows
+                or (
+                    hasattr(sb_config.shared_driver, "service")
+                    and sb_config.shared_driver.service.process
+                )
+            ):
+                try:
+                    sb_config.shared_driver.quit()
+                except Exception:
+                    sb_config.shared_driver = None
+
+    @classmethod
+    def setUpClass(self):
+        # Only used when: "--rcs" / "--reuse-class-session"
+        # Close existing sessions before the class starts.
+        session_helper.end_reused_class_session_as_needed()
+
+    @classmethod
+    def tearDownClass(self):
+        # Only used when: "--rcs" / "--reuse-class-session"
+        # Close existing sessions after the class finishes.
+        session_helper.end_reused_class_session_as_needed()
+
 
 r"""----------------------------------------------------------------->
 |    ______     __           _                  ____                 |

seleniumbase/plugins/pytest_plugin.py

@@ -102,7 +102,8 @@ def pytest_addoption(parser):
     --incognito  (Enable Chrome's Incognito mode.)
     --guest  (Enable Chrome's Guest mode.)
     --devtools  (Open Chrome's DevTools when the browser opens.)
-    --reuse-session | --rs  (Reuse browser session between tests.)
+    --reuse-session | --rs  (Reuse browser session for all tests.)
+    --reuse-class-session | --rcs  (Reuse session for tests in class.)
     --crumbs  (Delete all cookies between tests reusing a session.)
     --disable-beforeunload  (Disable the "beforeunload" event on Chrome.)
     --window-size=WIDTH,HEIGHT  (Set the browser's starting window size.)
@@ -1039,7 +1040,17 @@ def pytest_addoption(parser):
         dest="reuse_session",
         default=False,
         help="""The option to reuse the selenium browser window
-                session between tests.""",
+                session for all tests.""",
+    )
+    parser.addoption(
+        "--rcs",
+        "--reuse_class_session",
+        "--reuse-class-session",
+        action="store_true",
+        dest="reuse_class_session",
+        default=False,
+        help="""The option to reuse the selenium browser window
+                session for all tests within the same class.""",
     )
     parser.addoption(
         "--crumbs",
@@ -1048,7 +1059,9 @@ def pytest_addoption(parser):
         default=False,
         help="""The option to delete all cookies between tests
                 that reuse the same browser session. This option
-                is only needed when using "--reuse-session".""",
+                is only useful if using "--reuse-session"/"--rs"
+                or "--reuse-class-session"/"--rcs" because tests
+                use a new clean browser if not reusing sessions.""",
     )
     parser.addoption(
         "--disable-beforeunload",
@@ -1444,6 +1457,9 @@ def pytest_configure(config):
     sb_config.guest_mode = config.getoption("guest_mode")
     sb_config.devtools = config.getoption("devtools")
     sb_config.reuse_session = config.getoption("reuse_session")
+    sb_config.reuse_class_session = config.getoption("reuse_class_session")
+    if sb_config.reuse_class_session:
+        sb_config.reuse_session = True
     sb_config.shared_driver = None  # The default driver for session reuse
     sb_config.crumbs = config.getoption("crumbs")
     sb_config._disable_beforeunload = config.getoption("_disable_beforeunload")