Add "--rec-print" option to print recordings after tests

Author: mdmintz

examples/raw_parameter_script.py

@@ -81,6 +81,7 @@
     sb.recorder_ext = False
     sb.record_sleep = False
     sb.rec_behave = False
+    sb.rec_print = False
     sb.report_on = False
     sb.is_pytest = False
     sb.slow_mode = False

seleniumbase/behave/behave_sb.py

@@ -61,6 +61,7 @@
 -D recorder  (Enables the Recorder for turning browser actions into code.)
 -D rec-behave  (Same as Recorder Mode, but also generates behave-gherkin.)
 -D rec-sleep  (If the Recorder is enabled, also records self.sleep calls.)
+-D rec-print  (If the Recorder is enabled, prints output after tests end.)
 -D disable-csp  (Disable the Content Security Policy of websites.)
 -D disable-ws  (Disable Web Security on Chromium-based browsers.)
 -D enable-ws  (Enable Web Security on Chromium-based browsers.)
@@ -173,6 +174,7 @@ def get_configured_sb(context):
     sb.recorder_ext = False
     sb.record_sleep = False
     sb.rec_behave = False
+    sb.rec_print = False
     sb.report_on = False
     sb.is_pytest = False
     sb.slow_mode = False
@@ -517,10 +519,20 @@ def get_configured_sb(context):
         # Handle: -D rec-behave / rec-gherkin
         if low_key in ["rec-behave", "rec-gherkin"]:
             sb.rec_behave = True
+            sb.recorder_mode = True
+            sb.recorder_ext = True
             continue
         # Handle: -D record-sleep / record_sleep / rec-sleep / rec_sleep
         if low_key in ["record-sleep", "rec-sleep"]:
             sb.record_sleep = True
+            sb.recorder_mode = True
+            sb.recorder_ext = True
+            continue
+        # Handle: -D rec-print
+        if low_key in ["rec-print"]:
+            sb.rec_print = True
+            sb.recorder_mode = True
+            sb.recorder_ext = True
             continue
         # Handle: -D slow / slowmo / slow-mode / slow_mode
         if low_key in ["slow", "slowmo", "slow-mode", "slow_mode"]:
@@ -741,6 +753,7 @@ def get_configured_sb(context):
     sb_config.dash_title = sb.dash_title
     sb_config.pdb_option = sb.pdb_option
     sb_config.rec_behave = sb.rec_behave
+    sb_config.rec_print = sb.rec_print
     sb_config.record_sleep = sb.record_sleep
     sb_config._is_timeout_changed = False
     sb_config._SMALL_TIMEOUT = settings.SMALL_TIMEOUT

seleniumbase/fixtures/base_case.py

@@ -4266,6 +4266,16 @@ def __process_recorded_actions(self):
                 star_len = terminal_size
         except Exception:
             pass
+        spc = "\n\n"
+        if hasattr(self, "rec_print") and self.rec_print:
+            spc = ""
+            print()
+            if " " not in file_path:
+                os.system("sbase print %s -n" % file_path)
+            elif '"' not in file_path:
+                os.system('sbase print "%s" -n' % file_path)
+            else:
+                os.system("sbase print '%s' -n" % file_path)
         stars = "*" * star_len
         c1 = ""
         c2 = ""
@@ -4276,7 +4286,7 @@ def __process_recorded_actions(self):
             c2 = colorama.Fore.LIGHTRED_EX + colorama.Back.LIGHTYELLOW_EX
             cr = colorama.Style.RESET_ALL
             rec_message = rec_message.replace(">>>", c2 + ">>>" + cr)
-        print("\n\n%s%s%s%s\n%s" % (rec_message, c1, file_path, cr, stars))
+        print("%s%s%s%s%s\n%s" % (spc, rec_message, c1, file_path, cr, stars))
         if hasattr(self, "rec_behave") and self.rec_behave:
             # Also generate necessary behave-gherkin files.
             self.__process_recorded_behave_actions(srt_actions, colorama)
@@ -4356,6 +4366,16 @@ def __process_recorded_behave_actions(self, srt_actions, colorama):
                 star_len = terminal_size
         except Exception:
             pass
+        spc = "\n"
+        if hasattr(self, "rec_print") and self.rec_print:
+            spc = ""
+            print()
+            if " " not in file_path:
+                os.system("sbase print %s -n" % file_path)
+            elif '"' not in file_path:
+                os.system('sbase print "%s" -n' % file_path)
+            else:
+                os.system("sbase print '%s' -n" % file_path)
         stars = "*" * star_len
         c1 = ""
         c2 = ""
@@ -4366,7 +4386,7 @@ def __process_recorded_behave_actions(self, srt_actions, colorama):
             c2 = colorama.Fore.LIGHTRED_EX + colorama.Back.LIGHTYELLOW_EX
             cr = colorama.Style.RESET_ALL
             rec_message = rec_message.replace(">>>", c2 + ">>>" + cr)
-        print("\n%s%s%s%s\n%s" % (rec_message, c1, file_path, cr, stars))
+        print("%s%s%s%s%s\n%s" % (spc, rec_message, c1, file_path, cr, stars))
 
         data = []
         data.append("")
@@ -11937,9 +11957,16 @@ def setUp(self, masterqa_mode=False):
             self.verify_delay = sb_config.verify_delay
             self.recorder_mode = sb_config.recorder_mode
             self.recorder_ext = sb_config.recorder_mode
+            self.rec_print = sb_config.rec_print
             self.rec_behave = sb_config.rec_behave
             self.record_sleep = sb_config.record_sleep
-            if self.rec_behave and not self.recorder_mode:
+            if self.rec_print and not self.recorder_mode:
+                self.recorder_mode = True
+                self.recorder_ext = True
+            elif self.rec_behave and not self.recorder_mode:
+                self.recorder_mode = True
+                self.recorder_ext = True
+            elif self.record_sleep and not self.recorder_mode:
                 self.recorder_mode = True
                 self.recorder_ext = True
             self.disable_csp = sb_config.disable_csp

seleniumbase/plugins/pytest_plugin.py

@@ -72,6 +72,7 @@ def pytest_addoption(parser):
     --recorder  (Enables the Recorder for turning browser actions into code.)
     --rec-behave  (Same as Recorder Mode, but also generates behave-gherkin.)
     --rec-sleep  (If the Recorder is enabled, also records self.sleep calls.)
+    --rec-print  (If the Recorder is enabled, prints output after tests end.)
     --disable-csp  (Disable the Content Security Policy of websites.)
     --disable-ws  (Disable Web Security on Chromium-based browsers.)
     --enable-ws  (Enable Web Security on Chromium-based browsers.)
@@ -737,6 +738,14 @@ def pytest_addoption(parser):
         help="""If Recorder Mode is enabled,
                 records sleep(seconds) calls.""",
     )
+    parser.addoption(
+        "--rec-print",
+        action="store_true",
+        dest="rec_print",
+        default=False,
+        help="""If Recorder Mode is enabled,
+                prints output after tests end.""",
+    )
     parser.addoption(
         "--disable_csp",
         "--disable-csp",
@@ -1179,10 +1188,17 @@ def pytest_configure(config):
     sb_config.recorder_mode = config.getoption("recorder_mode")
     sb_config.recorder_ext = config.getoption("recorder_mode")  # Again
     sb_config.rec_behave = config.getoption("rec_behave")
-    if sb_config.rec_behave and not sb_config.recorder_mode:
+    sb_config.rec_print = config.getoption("rec_print")
+    sb_config.record_sleep = config.getoption("record_sleep")
+    if sb_config.rec_print and not sb_config.recorder_mode:
+        sb_config.recorder_mode = True
+        sb_config.recorder_ext = True
+    elif sb_config.rec_behave and not sb_config.recorder_mode:
+        sb_config.recorder_mode = True
+        sb_config.recorder_ext = True
+    elif sb_config.record_sleep and not sb_config.recorder_mode:
         sb_config.recorder_mode = True
         sb_config.recorder_ext = True
-    sb_config.record_sleep = config.getoption("record_sleep")
     sb_config.disable_csp = config.getoption("disable_csp")
     sb_config.disable_ws = config.getoption("disable_ws")
     sb_config.enable_ws = config.getoption("enable_ws")

seleniumbase/plugins/selenium_plugin.py

@@ -53,6 +53,7 @@ class SeleniumBrowser(Plugin):
     --recorder  (Enables the Recorder for turning browser actions into code.)
     --rec-behave  (Same as Recorder Mode, but also generates behave-gherkin.)
     --rec-sleep  (If the Recorder is enabled, also records self.sleep calls.)
+    --rec-print  (If the Recorder is enabled, prints output after tests end.)
     --disable-csp  (Disable the Content Security Policy of websites.)
     --disable-ws  (Disable Web Security on Chromium-based browsers.)
     --enable-ws  (Enable Web Security on Chromium-based browsers.)
@@ -478,6 +479,14 @@ def options(self, parser, env):
             help="""If Recorder Mode is enabled,
                     records sleep(seconds) calls.""",
         )
+        parser.add_option(
+            "--rec-print",
+            action="store_true",
+            dest="rec_print",
+            default=False,
+            help="""If Recorder Mode is enabled,
+                    prints output after tests end.""",
+        )
         parser.add_option(
             "--disable_csp",
             "--disable-csp",
@@ -739,10 +748,17 @@ def beforeTest(self, test):
         test.test.recorder_mode = self.options.recorder_mode
         test.test.recorder_ext = self.options.recorder_mode  # Again
         test.test.rec_behave = self.options.rec_behave
-        if self.options.rec_behave:
+        test.test.rec_print = self.options.rec_print
+        test.test.record_sleep = self.options.record_sleep
+        if self.options.rec_print:
+            test.test.recorder_mode = True
+            test.test.recorder_ext = True
+        elif self.options.rec_behave:
+            test.test.recorder_mode = True
+            test.test.recorder_ext = True
+        elif self.options.rec_sleep:
             test.test.recorder_mode = True
             test.test.recorder_ext = True
-        test.test.record_sleep = self.options.record_sleep
         test.test.disable_csp = self.options.disable_csp
         test.test.disable_ws = self.options.disable_ws
         test.test.enable_ws = self.options.enable_ws