Merge pull request #1794 from seleniumbase/better-commander

Improvements to SB Commander & More

Author: mdmintz

examples/list_assert_test.py examples/test_assert_elements.pyexamples/list_assert_test.py renamed to examples/test_assert_elements.py

@@ -1,14 +1,14 @@
-""" * Asserting that multiple elements are present or visible:
+"""Assert that multiple elements are present or visible:
 HTML Presence: assert_elements_present()
 HTML Visibility: assert_elements() <> assert_elements_visible()"""
 from seleniumbase import BaseCase
 BaseCase.main(__name__, __file__)
 
 
-class MyTestClass(BaseCase):
+class ListAssertTests(BaseCase):
     def test_assert_list_of_elements(self):
         self.open("https://seleniumbase.io/demo_page")
         self.assert_elements_present("head", "style", "script")
         self.assert_elements("h1", "h2", "h3")
-        my_list = ["#myDropdown", "#myButton", "#svgRect"]
+        my_list = ["#myDropdown", "#myButton", "#mySlider"]
         self.assert_elements(my_list)

examples/test_override_driver.py

@@ -22,6 +22,6 @@ def get_new_driver(self, *args, **kwargs):
         options.add_experimental_option("prefs", prefs)
         return webdriver.Chrome(options=options)
 
-    def test_simple(self):
+    def test_driver_override(self):
         self.open("https://seleniumbase.io/demo_page")
         self.assert_text("Demo Page", "h1")

requirements.txt

@@ -1,9 +1,9 @@
 pip>=21.3.1;python_version<"3.7"
-pip>=22.3.1;python_version>="3.7"
+pip>=23.0.1;python_version>="3.7"
 packaging>=21.3;python_version<"3.7"
 packaging>=23.0;python_version>="3.7"
 setuptools>=59.6.0;python_version<"3.7"
-setuptools>=65.7.0;python_version>="3.7"
+setuptools>=67.6.0;python_version>="3.7"
 keyring>=23.4.1;python_version<"3.8"
 keyring>=23.13.1;python_version>="3.8"
 tomli>=1.2.3;python_version<"3.7"

seleniumbase/__version__.py

@@ -1,2 +1,2 @@
 # seleniumbase package
-__version__ = "4.13.8"
+__version__ = "4.13.9"

seleniumbase/behave/behave_sb.py

@@ -72,16 +72,17 @@
 -D enable-ws  (Enable Web Security on Chromium-based browsers.)
 -D enable-sync  (Enable "Chrome Sync".)
 -D uc | -D undetected  (Use undetected-chromedriver to evade bot-detection)
--D uc-cdp-events  (Capture CDP events when running in "--undetected" mode.)
+-D uc-cdp-events  (Capture CDP events when running in "-D undetected" mode)
 -D remote-debug  (Sync to Chrome Remote Debugger chrome://inspect/#devices)
 -D dashboard  (Enable the SeleniumBase Dashboard. Saved at: dashboard.html)
 -D dash-title=STRING  (Set the title shown for the generated dashboard.)
 -D enable-3d-apis  (Enables WebGL and 3D APIs.)
--D swiftshader  (Use Chrome's "--use-gl=swiftshader" feature.)
+-D swiftshader  (Use Chrome's SwiftShader Graphics Library.)
 -D incognito  (Enable Chrome's Incognito mode.)
 -D guest  (Enable Chrome's Guest mode.)
 -D devtools  (Open Chrome's DevTools when the browser opens.)
--D reuse-session | -D rs  (Reuse browser session between tests.)
+-D reuse-session | -D rs  (Reuse browser session for all tests.)
+-D reuse-class-session | -D rcs  (Reuse session for tests in class/feature)
 -D crumbs  (Delete all cookies between tests reusing a session.)
 -D disable-beforeunload  (Disable the "beforeunload" event on Chrome.)
 -D window-size=WIDTH,HEIGHT  (Set the browser's starting window size.)
@@ -103,6 +104,7 @@
 from seleniumbase.core import log_helper
 from seleniumbase.core import download_helper
 from seleniumbase.core import proxy_helper
+from seleniumbase.core import session_helper
 from seleniumbase.fixtures import constants
 from seleniumbase import config as sb_config
 
@@ -179,6 +181,7 @@ def get_configured_sb(context):
     sb.disable_gpu = False
     sb._multithreaded = False
     sb._reuse_session = False
+    sb._reuse_class_session = False
     sb._crumbs = False
     sb._disable_beforeunload = False
     sb.visual_baseline = False
@@ -234,6 +237,7 @@ def get_configured_sb(context):
     sb_config._has_logs = None
     sb_config._has_exception = None
     sb_config.save_screenshot = None
+    sb_config.reuse_class_session = None
 
     browsers = set()  # To error if selecting more than one
     valid_browsers = constants.ValidBrowsers.valid_browsers
@@ -541,6 +545,13 @@ def get_configured_sb(context):
         if low_key in ["rs", "reuse-session", "reuse_session"]:
             sb._reuse_session = True
             continue
+        # Handle: -D rcs / rfs / reuse-class-session / reuse-feature-session
+        if low_key in [
+            "rcs", "rfs", "reuse-class-session", "reuse-feature-session"
+        ]:
+            sb._reuse_session = True
+            sb._reuse_class_session = True
+            continue
         # Handle: -D crumbs
         if low_key == "crumbs":
             sb._crumbs = True
@@ -870,6 +881,7 @@ def get_configured_sb(context):
     sb_config.window_size = sb.window_size
     sb_config.maximize_option = sb.maximize_option
     sb_config.xvfb = sb.xvfb
+    sb_config.reuse_class_session = sb._reuse_class_session
     sb_config.save_screenshot = sb.save_screenshot_after_test
     sb_config.no_screenshot = sb.no_screenshot_after_test
     sb_config._has_logs = False
@@ -1256,6 +1268,7 @@ def before_all(context):
 
 def before_feature(context, feature):
     sb_config.behave_feature = feature
+    session_helper.end_reused_class_session_as_needed()
 
 
 def before_scenario(context, scenario):
@@ -1290,6 +1303,7 @@ def after_scenario(context, scenario):
 
 def after_feature(context, feature):
     sb_config.feature = feature
+    session_helper.end_reused_class_session_as_needed()
 
 
 def after_all(context):

seleniumbase/console_scripts/sb_behave_gui.py

@@ -91,8 +91,8 @@ def do_behave_run(
             if selected_tests[test_number].get():
                 full_run_command += " "
                 test_to_run = test
-                if test.startswith("(GROUP) "):
-                    test_to_run = test.split("(GROUP) ")[1]
+                if test.startswith("(GROUP)  "):
+                    test_to_run = test.split("(GROUP)  ")[1]
                     full_run_command += test_to_run.split(" => ")[0]
                 else:
                     full_run_command += test.split(" => ")[0]
@@ -108,6 +108,10 @@ def do_behave_run(
         full_run_command += " -D rs"
     elif "(-D rs -D crumbs)" in rs_string:
         full_run_command += " -D rs -D crumbs"
+    elif "(-D rcs)" in rs_string:
+        full_run_command += " -D rcs"
+    elif "(-D rcs -D crumbs)" in rs_string:
+        full_run_command += " -D rcs -D crumbs"
 
     if quiet_mode:
         full_run_command += " --quiet"
@@ -173,7 +177,7 @@ def do_behave_run(
     send_window_to_front(root)
 
 
-def create_tkinter_gui(tests, command_string):
+def create_tkinter_gui(tests, command_string, t_count, f_count, s_tests):
     root = tk.Tk()
     root.title("SeleniumBase Behave Commander | GUI for Behave")
     root.minsize(820, 656)
@@ -193,8 +197,10 @@ def create_tkinter_gui(tests, command_string):
 
     options_list = [
         "New Session Per Test  (Default)",
-        "Reuse Session for all tests  (-D rs)",
-        "Reuse Session / clear cookies  (-D rs -D crumbs)",
+        "Reuse Session for ALL the tests  (-D rs)",
+        "Reuse Session and clear cookies  (-D rs -D crumbs)",
+        "Reuse Session in the SAME class/feature  (-D rcs)",
+        "Reuse Session in class and clear cookies  (-D rcs -D crumbs)",
     ]
     rsx = tk.StringVar(root)
     rsx.set(options_list[2])
@@ -239,13 +245,17 @@ def create_tkinter_gui(tests, command_string):
     chk.pack()
 
     tk.Label(root, text="").pack()
+    plural = "s"
+    if f_count == 1:
+        plural = ""
     run_display = (
-        "Select from %s tests:  "
-        "(If NO TESTS are selected, then ALL TESTS will run)"
-        % len(tests)
+        "Select from %s rows (%s feature%s with %s scenarios):  "
+        "(All tests will run if none are selected)"
+        % (len(tests), f_count, plural, t_count)
     )
-    if len(tests) == 1:
-        run_display = "Only ONE TEST was found:  (Will run automatically)"
+    if t_count == 1:
+        run_display = "Only ONE TEST was found and will be run:"
+        tests = s_tests
     tk.Label(root, text=run_display, fg="blue").pack()
     text_area = ScrolledText(
         root, width=100, height=12, wrap="word", state=tk.DISABLED
@@ -399,6 +409,7 @@ def main():
     file_scenario_count = {}
     f_count = 0
     s_count = 0
+    t_count = 0
     if is_windows:
         output = output.decode("latin1")
     else:
@@ -436,13 +447,14 @@ def main():
                 feature_name = feature_name.split(" # ")[-1]
             s_count = file_scenario_count[str(f_count)]
             filename = filename.strip()
-            t_name = "(GROUP) %s => %s" % (filename, feature_name)
-            t_name += " <> (%s Total)" % s_count
+            t_name = "(GROUP)  %s => %s" % (filename, feature_name)
+            t_name += "  <>  (%s Total)" % s_count
             f_tests.append(t_name)
         elif (
             row.startswith("  Scenario: ")
             or row.startswith("  Scenario Outline: ")
         ):
+            t_count += 1
             line_num = row.split(":")[-1]
             scenario_name = None
             if row.startswith("  Scenario: "):
@@ -470,7 +482,7 @@ def main():
         print(error_msg)
         return
 
-    create_tkinter_gui(tests, command_string)
+    create_tkinter_gui(tests, command_string, t_count, f_count, s_tests)
 
 
 if __name__ == "__main__":

seleniumbase/console_scripts/sb_commander.py

@@ -18,6 +18,7 @@
       Launches SeleniumBase Commander | GUI for pytest.
 """
 import colorama
+import os
 import subprocess
 import sys
 
@@ -78,6 +79,14 @@ def do_pytest_run(
     save_screenshots,
     additional_options,
 ):
+    cleaned_tests = []
+    for test in tests:
+        if test.startswith("(FILE)  "):
+            clean_test = test.split("(FILE)  ")[1].split("  =>  ")[0]
+            cleaned_tests.append(clean_test)
+        else:
+            cleaned_tests.append(test)
+    tests = cleaned_tests
     total_tests = len(tests)
     total_selected_tests = 0
     for selected_test in selected_tests:
@@ -111,13 +120,25 @@ def do_pytest_run(
         full_run_command += " --rs"
     elif "(--rs --crumbs)" in rs_string:
         full_run_command += " --rs --crumbs"
+    elif "(--rcs)" in rs_string:
+        full_run_command += " --rcs"
+    elif "(--rcs --crumbs)" in rs_string:
+        full_run_command += " --rcs --crumbs"
 
     if "(-n=2)" in thread_string:
         full_run_command += " -n=2"
     elif "(-n=3)" in thread_string:
         full_run_command += " -n=3"
     elif "(-n=4)" in thread_string:
         full_run_command += " -n=4"
+    elif "(-n=5)" in thread_string:
+        full_run_command += " -n=5"
+    elif "(-n=6)" in thread_string:
+        full_run_command += " -n=6"
+    elif "(-n=7)" in thread_string:
+        full_run_command += " -n=7"
+    elif "(-n=8)" in thread_string:
+        full_run_command += " -n=8"
 
     if demo_mode:
         full_run_command += " --demo"
@@ -159,7 +180,7 @@ def do_pytest_run(
     send_window_to_front(root)
 
 
-def create_tkinter_gui(tests, command_string):
+def create_tkinter_gui(tests, command_string, files, solo_tests):
     root = tk.Tk()
     root.title("SeleniumBase Commander | GUI for pytest")
     root.minsize(820, 658)
@@ -179,8 +200,10 @@ def create_tkinter_gui(tests, command_string):
 
     options_list = [
         "New Session Per Test  (Default)",
-        "Reuse Session for all tests in thread  (--rs)",
-        "Reuse Session / clear cookies  (--rs --crumbs)",
+        "Reuse Session for ALL tests in thread  (--rs)",
+        "Reuse Session and also clear cookies  (--rs --crumbs)",
+        "Reuse Session for tests with same CLASS  (--rcs)",
+        "Reuse Session for class and clear cookies  (--rcs --crumbs)",
     ]
     rsx = tk.StringVar(root)
     rsx.set(options_list[2])
@@ -193,6 +216,15 @@ def create_tkinter_gui(tests, command_string):
         "Number of Threads: 3  (-n=3)",
         "Number of Threads: 4  (-n=4)",
     ]
+    try:
+        if int(os.cpu_count()) >= 8:
+            options_list.append("Number of Threads: 5  (-n=5)")
+            options_list.append("Number of Threads: 6  (-n=6)")
+            options_list.append("Number of Threads: 7  (-n=7)")
+            options_list.append("Number of Threads: 8  (-n=8)")
+    except Exception:
+        pass
+
     ntx = tk.StringVar(root)
     ntx.set(options_list[0])
     question_menu = tk.OptionMenu(root, ntx, *options_list)
@@ -244,13 +276,17 @@ def create_tkinter_gui(tests, command_string):
     chk.pack()
 
     tk.Label(root, text="").pack()
+    plural = "s"
+    if len(files) == 1:
+        plural = ""
     run_display = (
-        "Select from %s tests:  "
-        "(If NO TESTS are selected, then ALL TESTS will run)"
-        % len(tests)
+        "Select from %s rows (%s file%s with %s tests):  "
+        "(All tests will run if none are selected)"
+        % (len(tests), len(files), plural, len(solo_tests))
     )
-    if len(tests) == 1:
-        run_display = "Only ONE TEST was found:  (Will run automatically)"
+    if len(solo_tests) == 1:
+        run_display = "Only ONE TEST was found and will be run:"
+        tests = solo_tests
     tk.Label(root, text=run_display, fg="blue").pack()
     text_area = ScrolledText(
         root, width=100, height=12, wrap="word", state=tk.DISABLED
@@ -403,8 +439,25 @@ def main():
         error_msg = c5 + "ERROR: " + error_msg + cr
         print(error_msg)
         return
-
-    create_tkinter_gui(tests, command_string)
+    groups = []
+    for row in tests:
+        if row.count("::") >= 1:
+            g_name = "(FILE)  %s" % row.split("::")[0]
+            groups.append(g_name)
+    files = []
+    used_files = []
+    for row in groups:
+        if row not in used_files:
+            used_files.append(row)
+            plural = "s"
+            if groups.count(row) == 1:
+                plural = ""
+            f_row = "%s  =>  (%s Test%s)" % (row, groups.count(row), plural)
+            files.append(f_row)
+    solo_tests = tests
+    tests = [*files, *tests]
+
+    create_tkinter_gui(tests, command_string, files, solo_tests)
 
 
 if __name__ == "__main__":