Refactor options

Author: mdmintz

seleniumbase/console_scripts/run.py

@@ -813,7 +813,7 @@ def show_options():
     op += "      | where / w: Show stack spot. u: Up stack. d: Down stack. |\n"
     op += "      | longlist / ll: See code. dir(): List namespace objects. |\n"
     op += "--help / -h  (Display list of all available pytest options.)\n"
-    op += "--final-debug  (Enter Final Debug Mode after each test ends.)\n"
+    op += "--ftrace / --final-trace  (Enter Debug Mode after any test.)\n"
     op += "--recorder / --rec  (Save browser actions as Python scripts.)\n"
     op += "--rec-behave / --rec-gherkin  (Save actions as Gherkin code.)\n"
     op += "--rec-print  (Display recorded scripts when they are created.)\n"

seleniumbase/plugins/base_plugin.py

@@ -17,7 +17,7 @@
 
 
 class Base(Plugin):
-    """This plugin adds the following command-line options to nosetests:
+    """This plugin adds the following command-line options to pynose:
     --env=ENV  (Set the test env. Access with "self.env" in tests.)
     --account=STR  (Set account. Access with "self.account" in tests.)
     --data=STRING  (Extra test data. Access with "self.data" in tests.)
@@ -26,6 +26,7 @@ class Base(Plugin):
     --var3=STRING  (Extra test data. Access with "self.var3" in tests.)
     --variables=DICT  (Extra test data. Access with "self.variables".)
     --settings-file=FILE  (Override default SeleniumBase settings.)
+    --ftrace | --final-trace  (Enter Debug Mode after any test ends.)
     --archive-logs  (Archive old log files instead of deleting them.)
     --archive-downloads  (Archive old downloads instead of deleting.)
     --report  (Create a fancy nosetests report after tests complete.)
@@ -128,6 +129,19 @@ def options(self, parser, env):
             help="""The file that stores key/value pairs for overriding
                     values in the SeleniumBase settings.py file.""",
         )
+        parser.addoption(
+            "--final-debug",
+            "--final-trace",
+            "--fdebug",
+            "--ftrace",
+            action="store_true",
+            dest="final_debug",
+            default=False,
+            help="""Enter Debug Mode at the end of each test.
+                    To enter Debug Mode only on failures, use "--pdb".
+                    If using both "--final-debug" and "--pdb" together,
+                    then Debug Mode will activate twice on failures.""",
+        )
         parser.addoption(
             "--log_path",
             "--log-path",
@@ -232,6 +246,7 @@ def beforeTest(self, test):
         test.test.var3 = self.options.var3
         test.test.variables = variables  # Already verified is a dictionary
         test.test.settings_file = self.options.settings_file
+        test.test._final_debug = self.options.final_debug
         test.test.log_path = self.options.log_path
         if self.options.archive_downloads:
             settings.ARCHIVE_EXISTING_DOWNLOADS = True

seleniumbase/plugins/pytest_plugin.py

@@ -90,7 +90,7 @@ def pytest_addoption(parser):
     --uc | --undetected  (Use undetected-chromedriver to evade bot-detection.)
     --uc-cdp-events  (Capture CDP events when running in "--undetected" mode.)
     --remote-debug  (Sync to Chrome Remote Debugger chrome://inspect/#devices)
-    --final-debug  (Enter Debug Mode after each test ends. Don't use with CI!)
+    --ftrace | --final-trace  (Debug Mode after each test. Don't use with CI!)
     --dashboard  (Enable the SeleniumBase Dashboard. Saved at: dashboard.html)
     --dash-title=STRING  (Set the title shown for the generated dashboard.)
     --enable-3d-apis  (Enables WebGL and 3D APIs.)

seleniumbase/plugins/selenium_plugin.py

@@ -9,7 +9,7 @@
 
 
 class SeleniumBrowser(Plugin):
-    """This plugin adds the following command-line options to nosetests:
+    """This plugin adds the following command-line options to pynose:
     --browser=BROWSER  (The web browser to use. Default: "chrome".)
     --chrome  (Shortcut for "--browser=chrome". Default.)
     --edge  (Shortcut for "--browser=edge".)
@@ -70,7 +70,6 @@ class SeleniumBrowser(Plugin):
     --uc | --undetected  (Use undetected-chromedriver to evade bot-detection.)
     --uc-cdp-events  (Capture CDP events when running in "--undetected" mode.)
     --remote-debug  (Sync to Chrome Remote Debugger chrome://inspect/#devices)
-    --final-debug  (Enter Debug Mode after each test ends. Don't use with CI!)
     --enable-3d-apis  (Enables WebGL and 3D APIs.)
     --swiftshader  (Use Chrome's "--use-gl=swiftshader" feature.)
     --incognito  (Enable Chrome's Incognito mode.)
@@ -757,19 +756,6 @@ def options(self, parser, env):
                     The previous URL was at: http://localhost:9222/
                     Info: chromedevtools.github.io/devtools-protocol/""",
         )
-        parser.addoption(
-            "--final-debug",
-            "--final-trace",
-            "--fdebug",
-            "--ftrace",
-            action="store_true",
-            dest="final_debug",
-            default=False,
-            help="""Enter Debug Mode at the end of each test.
-                    To enter Debug Mode only on failures, use "--pdb".
-                    If using both "--final-debug" and "--pdb" together,
-                    then Debug Mode will activate twice on failures.""",
-        )
         parser.addoption(
             "--enable_3d_apis",
             "--enable-3d-apis",
@@ -1125,7 +1111,6 @@ def beforeTest(self, test):
         test.test.no_sandbox = self.options.no_sandbox
         test.test.disable_gpu = self.options.disable_gpu
         test.test.remote_debug = self.options.remote_debug
-        test.test._final_debug = self.options.final_debug
         test.test.enable_3d_apis = self.options.enable_3d_apis
         test.test.swiftshader = self.options.swiftshader
         test.test.incognito = self.options.incognito