Merge pull request #1281 from seleniumbase/sbase-commander

New feature: SeleniumBase Commander / GUI for pytest

Author: mdmintz

README.md

@@ -5,7 +5,7 @@
 <meta property="og:image" content="https://seleniumbase.io/cdn/img/mac_sb_logo_5.png" />
 <link rel="icon" href="https://seleniumbase.io/img/green_logo.png" />
 
-<h3 align="center"><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.io/cdn/img/mac_sb_logo_5.png" alt="SeleniumBase" title="SeleniumBase" width="300" /></a></h3>
+<h3 align="center"><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.io/cdn/img/mac_sb_logo_3.png" alt="SeleniumBase" title="SeleniumBase" width="300" /></a></h3>
 <!-- View on GitHub -->
 <h4 align="center">Better web testing with <a href="https://www.selenium.dev/documentation/" target="_blank">Selenium</a> and <a href="https://docs.pytest.org/en/stable/" target="_blank">pytest</a>.</h4>
 <p align="center">

examples/ReadMe.md

@@ -135,6 +135,16 @@ pytest upload_file_test.py
 
 --------
 
+Try the new SeleniumBase Commander! A GUI for pytest:
+
+```bash
+sbase gui
+```
+
+<img src="https://seleniumbase.io/cdn/img/sbase_commander.png" title="SeleniumBase Commander / GUI for pytest" /><br />
+
+--------
+
 <b>SeleniumBase tests can also be run with ``nosetests``:</b>
 
 Run an example test with nosetests:

examples/test_agent.py

@@ -8,17 +8,17 @@ def test_user_agent(self):
         original_user_agent = user_agent_detected
         if not self.user_agent:
             # Using the built-in user-agent string
-            print("\n\nUser-Agent:\n%s\n" % user_agent_detected)
+            self._print("\n\nUser-Agent: %s" % user_agent_detected)
         else:
             # User-agent was overridden using: --agent=STRING
-            print("\n\nUser-Agent override:\n%s\n" % user_agent_detected)
-        print(self.get_text(".ip-address p"))
+            self._print("\n\nUser-Agent override: %s" % user_agent_detected)
+        print("\n" + self.get_text(".ip-address p"))
         self.sleep(3)
 
         # Now change the user-agent using "execute_cdp_cmd()"
         if not self.is_chromium():
             msg = "\n* execute_cdp_cmd() is only for Chromium browsers"
-            print(msg)
+            self._print(msg)
             self.skip(msg)
         print("\n--------------------------")
         try:
@@ -33,8 +33,8 @@ def test_user_agent(self):
             )
             self.open("http://whatsmyuseragent.org/")
             user_agent_detected = self.get_text(".user-agent p")
-            print("\nUser-Agent (after override):\n%s\n" % user_agent_detected)
-            print(self.get_text(".ip-address p"))
+            self._print("\nUser-Agent override: %s" % user_agent_detected)
+            print("\n" + self.get_text(".ip-address p") + "\n")
             self.sleep(3)
         finally:
             # Reset the user-agent back to the original

examples/test_chinese_pdf.py

@@ -8,7 +8,7 @@ def test_chinese_pdf(self):
 
         # Get and print PDF text
         pdf_text = self.get_pdf_text(pdf, page=2)
-        self._print("\n" + pdf_text)
+        print("\n" + pdf_text)
 
         # Assert PDF contains the expected text on Page 2
         self.assert_pdf_text(pdf, "个测试类", page=2)

examples/test_get_pdf_text.py

@@ -8,4 +8,4 @@ def test_get_pdf_text(self):
             "Automate_the_Boring_Stuff_sample_ch17.pdf"
         )
         pdf_text = self.get_pdf_text(pdf, page=1)
-        self._print("\n" + pdf_text)
+        print("\n" + pdf_text)

examples/user_agent_test.py

@@ -8,16 +8,16 @@ def test_user_agent(self):
         original_user_agent = user_agent_detected
         if not self.user_agent:
             # Using the built-in user-agent string
-            print("\n\nUser-Agent = %s\n" % user_agent_detected)
+            self._print("\n\nUser-Agent = %s\n" % user_agent_detected)
         else:
             # User-agent was overridden using: --agent=STRING
-            print("\n\nUser-Agent override = %s\n" % user_agent_detected)
+            self._print("\n\nUser-Agent override = %s\n" % user_agent_detected)
         self.sleep(3)
 
         if not self.is_chromium():
             # Skip the rest of the test if not using a Chromium browser
             msg = "\n* execute_cdp_cmd() is only for Chromium browsers"
-            print(msg)
+            self._print(msg)
             self.skip(msg)
         try:
             # Now change the user-agent using "execute_cdp_cmd()"
@@ -33,7 +33,7 @@ def test_user_agent(self):
             )
             self.open("https://www.whatsmyua.info/")
             user_agent_detected = self.get_text("#custom-ua-string")
-            print("\nUser-Agent (after override) = %s" % user_agent_detected)
+            self._print("\nUser-Agent override = %s\n" % user_agent_detected)
             self.sleep(3)
         finally:
             # Reset the user-agent back to the original

seleniumbase/__version__.py

@@ -1,2 +1,2 @@
 # seleniumbase package
-__version__ = "2.4.35"
+__version__ = "2.5.0"

seleniumbase/console_scripts/ReadMe.md

@@ -17,6 +17,7 @@ COMMANDS:
       install          [DRIVER] [OPTIONS]
       methods          (List common Python methods)
       options          (List common pytest options)
+      commander / gui  [OPTIONAL PATH or TEST FILE]
       mkdir            [DIRECTORY] [OPTIONS]
       mkfile           [FILE.py] [OPTIONS]
       mkrec / codegen  [FILE.py] [OPTIONS]
@@ -143,6 +144,21 @@ that are available when using SeleniumBase.
 For the full list of command-line options, type: "pytest --help".
 ```
 
+<h3>commander / gui</h3>
+
+* Usage:
+``sbase commander [OPTIONAL PATH or TEST FILE]``
+``sbase gui [OPTIONAL PATH or TEST FILE]``
+
+* Examples:
+``sbase gui``
+``sbase gui -k agent``
+``sbase gui examples/``
+``sbase gui test_suite.py``
+
+* Output:
+Launches SeleniumBase Commander | GUI for pytest.
+
 <h3>mkdir</h3>
 
 * Usage:

seleniumbase/console_scripts/run.py

@@ -9,6 +9,7 @@
 sbase install chromedriver
 sbase methods
 sbase options
+sbase commander
 sbase mkdir ui_tests
 sbase mkfile new_test.py
 sbase mkrec new_test.py
@@ -78,6 +79,7 @@ def show_basic_usage():
     sc += "      install          [DRIVER] [OPTIONS]\n"
     sc += "      methods          (List common Python methods)\n"
     sc += "      options          (List common pytest options)\n"
+    sc += "      commander / gui  [OPTIONAL PATH or TEST FILE]\n"
     sc += "      mkdir            [DIRECTORY] [OPTIONS]\n"
     sc += "      mkfile           [FILE.py] [OPTIONS]\n"
     sc += "      mkrec / codegen  [FILE.py] [OPTIONS]\n"
@@ -146,6 +148,28 @@ def show_install_usage():
     print("")
 
 
+def show_commander_usage():
+    c2 = colorama.Fore.BLUE + colorama.Back.LIGHTGREEN_EX
+    c3 = colorama.Fore.BLUE + colorama.Back.LIGHTYELLOW_EX
+    cr = colorama.Style.RESET_ALL
+    sc = "  " + c2 + "** " + c3 + "commander" + c2 + " **" + cr
+    print(sc)
+    print("")
+    print("  Usage:")
+    print("           seleniumbase commander [OPTIONAL PATH or TEST FILE]")
+    print("           OR:    sbase commander [OPTIONAL PATH or TEST FILE]")
+    print("           OR:   seleniumbase gui [OPTIONAL PATH or TEST FILE]")
+    print("           OR:          sbase gui [OPTIONAL PATH or TEST FILE]")
+    print("  Examples:")
+    print("           sbase gui")
+    print("           sbase gui -k agent")
+    print("           sbase gui examples/")
+    print("           sbase gui test_suite.py")
+    print("  Output:")
+    print("           Launches SeleniumBase Commander | GUI for pytest.")
+    print("")
+
+
 def show_mkdir_usage():
     c2 = colorama.Fore.BLUE + colorama.Back.LIGHTGREEN_EX
     c3 = colorama.Fore.BLUE + colorama.Back.LIGHTYELLOW_EX
@@ -250,6 +274,21 @@ def show_codegen_usage():
     print("")
 
 
+def show_recorder_usage():
+    c2 = colorama.Fore.BLUE + colorama.Back.LIGHTGREEN_EX
+    c3 = colorama.Fore.BLUE + colorama.Back.LIGHTYELLOW_EX
+    cr = colorama.Style.RESET_ALL
+    sc = "  " + c2 + "** " + c3 + "recorder" + c2 + " **" + cr
+    print(sc)
+    print("")
+    print("  Usage:")
+    print("           seleniumbase recorder")
+    print("           OR:    sbase recorder")
+    print("  Output:")
+    print("           Launches the SeleniumBase Recorder Desktop App.")
+    print("")
+
+
 def show_mkpres_usage():
     c2 = colorama.Fore.BLUE + colorama.Back.LIGHTGREEN_EX
     c3 = colorama.Fore.BLUE + colorama.Back.LIGHTYELLOW_EX
@@ -629,7 +668,8 @@ def show_methods():
     sbm += "*.get_attribute(selector, attribute) => Get element attribute.\n"
     sbm += "*.get_title() => Get the title of the current page.\n"
     sbm += "*.switch_to_frame(frame) => Switch into the iframe container.\n"
-    sbm += "*.switch_to_default_content() => Leave the iframe container.\n"
+    sbm += "*.switch_to_default_content() => Exit all iframe containers.\n"
+    sbm += "*.switch_to_parent_frame() => Exit from the current iframe.\n"
     sbm += "*.open_new_window() => Open a new window in the same browser.\n"
     sbm += "*.switch_to_window(window) => Switch to the browser window.\n"
     sbm += "*.switch_to_default_window() => Switch to the original window.\n"
@@ -735,10 +775,12 @@ def show_detailed_help():
     print(c6 + "            " + c2 + "  Commands:  " + c6 + "            ")
     print(cr)
     show_install_usage()
+    show_commander_usage()
     show_mkdir_usage()
     show_mkfile_usage()
     show_mkrec_usage()
     show_codegen_usage()
+    show_recorder_usage()
     show_mkpres_usage()
     show_mkchart_usage()
     show_convert_usage()
@@ -779,6 +821,10 @@ def main():
         else:
             show_basic_usage()
             show_install_usage()
+    elif command == "commander" or command == "gui":
+        from seleniumbase.console_scripts import sb_commander
+
+        sb_commander.main()
     elif (
         command == "recorder"
         or (command == "record" and len(command_args) == 0)
@@ -960,6 +1006,14 @@ def main():
                 print("")
                 show_install_usage()
                 return
+            elif command_args[0] == "commander":
+                print("")
+                show_commander_usage()
+                return
+            elif command_args[0] == "gui":
+                print("")
+                show_commander_usage()
+                return
             elif command_args[0] == "mkdir":
                 print("")
                 show_mkdir_usage()
@@ -976,6 +1030,10 @@ def main():
                 print("")
                 show_codegen_usage()
                 return
+            elif command_args[0] == "recorder":
+                print("")
+                show_recorder_usage()
+                return
             elif command_args[0] == "mkpres":
                 print("")
                 show_mkpres_usage()