Update console scripts

Author: mdmintz

seleniumbase/console_scripts/ReadMe.md

@@ -1,6 +1,6 @@
 <h2>🔮 Console Scripts 🔮</h2>
 
-⭐ SeleniumBase console scripts help you get things done, such as installing web drivers, creating a test directory with useful files, activating the SeleniumBase Recorder, launching the SeleniumBase Commander, translating tests into other languages, running a Selenium Grid, and more.
+⭐ SeleniumBase console scripts help you get things done, such as getting web drivers, creating a test directory with useful files, activating the SeleniumBase Recorder, launching the SeleniumBase Commander, translating tests into other languages, running a Selenium Grid, and more.
 
 * Usage: ``seleniumbase [COMMAND] [PARAMETERS]``
 
@@ -12,10 +12,11 @@
 
 ```
 COMMANDS:
-      install          [DRIVER] [OPTIONS]
+      get / install    [DRIVER] [OPTIONS]
       methods          (List common Python methods)
       options          (List common pytest options)
-      commander / gui  [OPTIONAL PATH or TEST FILE]
+      gui / commander  [OPTIONAL PATH or TEST FILE]
+      behave-gui       (SBase Commander for Behave)
       mkdir            [DIRECTORY] [OPTIONS]
       mkfile           [FILE.py] [OPTIONS]
       mkrec / codegen  [FILE.py] [OPTIONS]
@@ -35,31 +36,32 @@ COMMANDS:
       download server  (Get Selenium Grid JAR file)
       grid-hub         [start|stop] [OPTIONS]
       grid-node        [start|stop] --hub=[HOST/IP]
- * (EXAMPLE: "sbase install chromedriver latest") *
+ * (EXAMPLE: "sbase get chromedriver latest") *
 
     Type "sbase help [COMMAND]" for specific command info.
     For info on all commands, type: "seleniumbase --help".
     Use "pytest" for running tests.
 ```
 
-<h3>install</h3>
+<h3>get / install</h3>
 
 * Usage:
+``sbase get [DRIVER] [OPTIONS]``
 ``sbase install [DRIVER] [OPTIONS]``
 
 * Examples:
 
 ```bash
-sbase install chromedriver
-sbase install geckodriver
-sbase install edgedriver
-sbase install chromedriver 101
-sbase install chromedriver 101.0.4951.41
-sbase install chromedriver latest
-sbase install chromedriver latest-1  # (Latest minus one)
-sbase install chromedriver -p
-sbase install chromedriver latest -p
-sbase install edgedriver 101.0.1210.32
+sbase get chromedriver
+sbase get geckodriver
+sbase get edgedriver
+sbase get chromedriver 101
+sbase get chromedriver 101.0.4951.41
+sbase get chromedriver latest
+sbase get chromedriver latest-1  # (Latest minus one)
+sbase get chromedriver -p
+sbase get chromedriver latest -p
+sbase get edgedriver 101.0.1210.32
 ```
 
 (Drivers:  ``chromedriver``, ``geckodriver``, ``edgedriver``,
@@ -72,11 +74,11 @@ sbase install edgedriver 101.0.1210.32
            ``-p`` / ``--path``: Also copy to "/usr/local/bin".)
 
 * Output:
-Installs the specified webdriver.
+Downloads the chosen webdriver to ``seleniumbase/drivers/``.
 (``chromedriver`` is required for Google Chrome automation)
 (``geckodriver`` is required for Mozilla Firefox automation)
 (``edgedriver`` is required for Microsoft Edge automation)
-(``iedriver`` is required for Internet Explorer automation)
+(``iedriver`` is required for InternetExplorer automation)
 (``operadriver`` is required for Opera Browser automation)
 
 <h3>methods</h3>
@@ -96,23 +98,24 @@ Displays common SeleniumBase Python methods.
 Displays common pytest command-line options
 that are available when using SeleniumBase.
 
-```
+```bash
 --browser=BROWSER  (The web browser to use. Default is "chrome")
 --headless  (Run tests headlessly. Default mode on Linux OS.)
 --demo  (Slow down and visually see test actions as they occur.)
 --slow  (Slow down the automation. Faster than using Demo Mode.)
 --reuse-session / --rs  (Reuse browser session between tests.)
 --crumbs  (Clear all cookies between tests reusing a session.)
 --maximize  (Start tests with the web browser window maximized.)
---dashboard  (Enable SeleniumBase's Dashboard at dashboard.html)
---incognito  (Enable Chromium's Incognito mode.)
---guest  (Enable Chromium's Guest mode.)
+--dashboard  (Enable SeleniumBase\'s Dashboard at dashboard.html)
+--incognito  (Enable Chromium\'s Incognito mode.)
+--guest  (Enable Chromium\'s Guest mode.)
 -m=MARKER  (Run tests with the specified pytest marker.)
 -n=NUM  (Multithread the tests using that many threads.)
 -v  (Verbose mode. Print the full names of each test run.)
 --html=report.html  (Create a detailed pytest-html report.)
 --collect-only / --co  (Only show discovered tests. No run.)
 --co -q  (Only show full names of discovered tests. No run.)
+-x  (Stop running tests after the first failure is reached.)
 --pdb  (Enter the Post Mortem Debug Mode after any test fails.)
 --trace  (Enter Debug Mode immediately after starting any test.)
       | Debug Mode Commands  >>>   help / h: List all commands. |
@@ -122,12 +125,11 @@ that are available when using SeleniumBase.
       | longlist / ll: See code. dir(): List namespace objects. |
 --recorder  (Record browser actions to generate test scripts.)
 --save-screenshot  (Save a screenshot at the end of each test.)
--x  (Stop running the tests after the first failure is reached.)
 --archive-logs  (Archive old log files instead of deleting them.)
 --check-js  (Check for JavaScript errors after page loads.)
 --start-page=URL  (The browser start page when tests begin.)
---agent=STRING  (Modify the web browser's User-Agent string.)
---mobile  (Use Chromium's mobile device emulator during tests.)
+--agent=STRING  (Modify the web browser\'s User-Agent string.)
+--mobile  (Use Chromium\'s mobile device emulator during tests.)
 --metrics=STRING  (Set mobile "CSSWidth,CSSHeight,PixelRatio".)
 --ad-block  (Block some types of display ads after page loads.)
 --settings-file=FILE  (Override default SeleniumBase settings.)
@@ -142,27 +144,85 @@ that are available when using SeleniumBase.
 For the full list of command-line options, type: "pytest --help".
 ```
 
-<h3>commander / gui</h3>
+<h3>behave-options</h3>
+
+* Usage:
+``sbase behave-options``
+
+* Output:
+Displays common Behave command-line options
+that are available when using SeleniumBase.
+
+```bash
+-D browser=BROWSER  (The web browser to use. Default is "chrome")
+-D headless  (Run tests headlessly. Default mode on Linux OS.)
+-D demo  (Slow down and visually see test actions as they occur.)
+-D slow  (Slow down the automation. Faster than using Demo Mode.)
+-D reuse-session / -D rs  (Reuse browser session between tests.)
+-D crumbs  (Clear all cookies between tests reusing a session.)
+-D maximize  (Start tests with the web browser window maximized.)
+-D dashboard  (Enable SeleniumBase\'s Dashboard at dashboard.html)
+-D incognito  (Enable Chromium\'s Incognito mode.)
+-D guest  (Enable Chromium\'s Guest mode.)
+--no-snippets / -q  (Quiet mode. Don\'t print snippets.)
+--dry-run / -d  (Dry run. Only show discovered tests.)
+--stop  (Stop running tests after the first failure is reached.)
+-D pdb  (Enter the Post Mortem Debug Mode after any test fails.)
+      | Debug Mode Commands  >>>   help / h: List all commands. |
+      |   n: Next line of method. s: Step through. c: Continue. |
+      |  return / r: Run until method returns. j: Jump to line. |
+      | where / w: Show stack spot. u: Up stack. d: Down stack. |
+      | longlist / ll: See code. dir(): List namespace objects. |
+-D recorder  (Record browser actions to generate test scripts.)
+-D save-screenshot  (Save a screenshot at the end of each test.)
+-D archive-logs  (Archive old log files instead of deleting them.)
+-D check-js  (Check for JavaScript errors after page loads.)
+-D start-page=URL  (The browser start page when tests begin.)
+-D agent=STRING  (Modify the web browser\'s User-Agent string.)
+-D mobile  (Use Chromium\'s mobile device emulator during tests.)
+-D metrics=STRING  (Set mobile "CSSWidth,CSSHeight,PixelRatio".)
+-D ad-block  (Block some types of display ads after page loads.)
+-D settings-file=FILE  (Override default SeleniumBase settings.)
+-D env=ENV  (Set the test env. Access with "self.env" in tests.)
+-D data=DATA  (Extra test data. Access with "self.data" in tests.)
+-D disable-csp  (Disable the Content Security Policy of websites.)
+-D server=SERVER  (The Selenium Grid server/IP used for tests.)
+-D port=PORT  (The Selenium Grid port used by the test server.)
+-D proxy=SERVER:PORT  (Connect to a proxy server:port for tests.)
+-D proxy=USER:PASS@SERVER:PORT  (Use authenticated proxy server.)
+
+For the full list of command-line options, type: "behave --help".
+```
+
+<h3>gui / commander</h3>
 
 * Usage:
 
 ```bash
-sbase commander [OPTIONAL PATH or TEST FILE]
 sbase gui [OPTIONAL PATH or TEST FILE]
+sbase commander [OPTIONAL PATH or TEST FILE]
+```
+
+<h3>behave-gui</h3>
+
+* Usage:
+
+```bash
+sbase behave-gui [OPTIONAL PATH or TEST FILE]
+sbase gui-behave [OPTIONAL PATH or TEST FILE]
 ```
 
 * Examples:
 
 ```bash
-sbase gui
-sbase gui -k agent
-sbase gui -m marker2
-sbase gui test_suite.py
-sbase gui offline_examples/
+sbase behave-gui
+sbase behave-gui -i=calculator
+sbase behave-gui features/
+sbase behave-gui features/calculator.feature
 ```
 
 * Output:
-Launches SeleniumBase Commander | GUI for pytest.
+Launches SeleniumBase Commander | GUI for Behave.
 
 <h3>mkdir</h3>
 

seleniumbase/console_scripts/objectify.py

@@ -31,7 +31,7 @@ def invalid_run_command(shell_command):
 
 
 def invalid_objectify_run_command():
-    exp = "  ** objectify**\n\n"
+    exp = "  ** objectify **\n\n"
     exp += "  Usage:\n"
     exp += "         seleniumbase objectify [SELENIUMBASE_PYTHON_FILE]\n"
     exp += "  Options:\n"
@@ -48,7 +48,7 @@ def invalid_objectify_run_command():
 
 
 def invalid_inject_objects_run_command():
-    exp = "  ** inject-objects**\n\n"
+    exp = "  ** inject-objects **\n\n"
     exp += "  Usage:\n"
     exp += "         seleniumbase inject-objects [SELENIUMBASE_PYTHON_FILE]\n"
     exp += "  Options:\n"
@@ -62,7 +62,7 @@ def invalid_inject_objects_run_command():
 
 
 def invalid_extract_objects_run_command():
-    exp = "  ** extract-objects**\n\n"
+    exp = "  ** extract-objects **\n\n"
     exp += "  Usage:\n"
     exp += "         seleniumbase extract-objects [SELENIUMBASE_PYTHON_FILE]\n"
     exp += "  Output:\n"
@@ -73,7 +73,7 @@ def invalid_extract_objects_run_command():
 
 
 def invalid_revert_objects_run_command():
-    exp = "  ** revert-objects**\n\n"
+    exp = "  ** revert-objects **\n\n"
     exp += "  Usage:\n"
     exp += "         seleniumbase revert-objects [SELENIUMBASE_PYTHON_FILE]\n"
     exp += "  Options:\n"

seleniumbase/console_scripts/run.py

@@ -6,10 +6,11 @@
   OR   sbase [COMMAND] [PARAMETERS]
 
 Examples:
-sbase install chromedriver
+sbase get chromedriver
 sbase methods
 sbase options
 sbase commander
+sbase behave-gui
 sbase mkdir ui_tests
 sbase mkfile new_test.py
 sbase mkrec new_test.py
@@ -76,10 +77,12 @@ def show_basic_usage():
     sc += ' *    OR:        "sbase [COMMAND] [PARAMETERS]"\n'
     sc += "\n"
     sc += "COMMANDS:\n"
-    sc += "      install          [DRIVER] [OPTIONS]\n"
+    sc += "      get / 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 += "      behave-options   (List common Behave options)\n"
+    sc += "      gui / commander  [OPTIONAL PATH or TEST FILE]\n"
+    sc += "      behave-gui       (SBase Commander for Behave)\n"
     sc += "      mkdir            [DIRECTORY] [OPTIONS]\n"
     sc += "      mkfile           [FILE.py] [OPTIONS]\n"
     sc += "      mkrec / codegen  [FILE.py] [OPTIONS]\n"
@@ -99,7 +102,7 @@ def show_basic_usage():
     sc += "      download server  (Get Selenium Grid JAR file)\n"
     sc += "      grid-hub         [start|stop] [OPTIONS]\n"
     sc += "      grid-node        [start|stop] --hub=[HOST/IP]\n"
-    sc += ' * (EXAMPLE: "sbase install chromedriver latest") *\n'
+    sc += ' * (EXAMPLE: "sbase get chromedriver latest") *\n'
     sc += ""
     if "linux" not in sys.platform:
         c1 = colorama.Fore.BLUE + colorama.Back.LIGHTCYAN_EX
@@ -114,32 +117,37 @@ def show_install_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 + "install" + c2 + " **" + cr
+    sc = "  " + c2 + "** " + c3 + "get / install" + c2 + " **" + cr
     print(sc)
     print("")
     print("  Usage:")
     print("           seleniumbase install [DRIVER_NAME] [OPTIONS]")
+    print("           OR: seleniumbase get [DRIVER_NAME] [OPTIONS]")
     print("           OR:    sbase install [DRIVER_NAME] [OPTIONS]")
+    print("           OR:        sbase get [DRIVER_NAME] [OPTIONS]")
     print("                 (Drivers: chromedriver, geckodriver, edgedriver")
     print("                           iedriver, operadriver)")
     print("  Options:")
-    print("           VERSION         Specify the version.")
-    print("                           (Default Chromedriver version = 2.44)")
-    print('                           Use "latest" for the latest version.')
+    print("           VERSION         Specify the version to download.")
+    print("                            (Default Chromedriver version = 2.44.")
+    print('                             Use "latest" for the latest version.')
+    print("                             For chromedriver, you can also use")
+    print("                             the major version integer")
+    print('                             or "latest-1" for 1 less than that.)')
     print("           -p OR --path    Also copy the driver to /usr/local/bin")
-    print("  Example:")
-    print("           sbase install chromedriver")
-    print("           sbase install geckodriver")
-    print("           sbase install edgedriver")
-    print("           sbase install chromedriver 101")
-    print("           sbase install chromedriver 101.0.4951.41")
-    print("           sbase install chromedriver latest")
-    print("           sbase install chromedriver latest-1")
-    print("           sbase install chromedriver -p")
-    print("           sbase install chromedriver latest -p")
-    print("           sbase install edgedriver 101.0.1210.32")
+    print("  Examples:")
+    print("           sbase get chromedriver")
+    print("           sbase get geckodriver")
+    print("           sbase get edgedriver")
+    print("           sbase get chromedriver 101")
+    print("           sbase get chromedriver 101.0.4951.41")
+    print("           sbase get chromedriver latest")
+    print("           sbase get chromedriver latest-1")
+    print("           sbase get chromedriver -p")
+    print("           sbase get chromedriver latest -p")
+    print("           sbase get edgedriver 101.0.1210.32")
     print("  Output:")
-    print("           Installs the chosen webdriver to seleniumbase/drivers/")
+    print("           Downloads the chosen webdriver to seleniumbase/drivers")
     print("           (chromedriver is required for Chrome automation)")
     print("           (geckodriver is required for Firefox automation)")
     print("           (edgedriver is required for Microsoft Edge automation)")
@@ -748,6 +756,7 @@ def show_options():
     op += "--html=report.html  (Create a detailed pytest-html report.)\n"
     op += "--collect-only / --co  (Only show discovered tests. No run.)\n"
     op += "--co -q  (Only show full names of discovered tests. No run.)\n"
+    op += "-x  (Stop running tests after the first failure is reached.)\n"
     op += "--pdb  (Enter the Post Mortem Debug Mode after any test fails.)\n"
     op += "--trace  (Enter Debug Mode immediately after starting any test.)\n"
     op += "      | Debug Mode Commands  >>>   help / h: List all commands. |\n"
@@ -757,7 +766,6 @@ def show_options():
     op += "      | longlist / ll: See code. dir(): List namespace objects. |\n"
     op += "--recorder  (Record browser actions to generate test scripts.)\n"
     op += "--save-screenshot  (Save a screenshot at the end of each test.)\n"
-    op += "-x  (Stop running the tests after the first failure is reached.)\n"
     op += "--archive-logs  (Archive old log files instead of deleting them.)\n"
     op += "--check-js  (Check for JavaScript errors after page loads.)\n"
     op += "--start-page=URL  (The browser start page when tests begin.)\n"
@@ -903,7 +911,7 @@ def main():
         command_args = sys.argv[2:]
     command = command.lower()
 
-    if command == "install":
+    if command == "get" or command == "install":
         if len(command_args) >= 1:
             from seleniumbase.console_scripts import sb_install
 

seleniumbase/console_scripts/sb_commander.py

@@ -158,7 +158,7 @@ def do_pytest_run(
 def create_tkinter_gui(tests, command_string):
     root = tk.Tk()
     root.title("SeleniumBase Commander | GUI for pytest")
-    root.minsize(720, 640)
+    root.minsize(820, 645)
     tk.Label(root, text="").pack()
 
     options_list = [
@@ -179,7 +179,7 @@ def create_tkinter_gui(tests, command_string):
         "Reuse Session / clear cookies  (--rs --crumbs)",
     ]
     rsx = tk.StringVar(root)
-    rsx.set(options_list[0])
+    rsx.set(options_list[2])
     question_menu = tk.OptionMenu(root, rsx, *options_list)
     question_menu.pack()