Merge pull request #1037 from seleniumbase/mostly-recorder-mode-updates

Mostly Recorder Mode updates

Author: mdmintz

README.md

@@ -108,7 +108,7 @@ COMMANDS:
       options          (List common pytest options)
       mkdir            [DIRECTORY] [OPTIONS]
       mkfile           [FILE.py] [OPTIONS]
-      mkrec / codegen  [FILE.py]
+      mkrec / codegen  [FILE.py] [OPTIONS]
       mkpres           [FILE.py] [LANG]
       mkchart          [FILE.py] [LANG]
       print            [FILE] [OPTIONS]

help_docs/recorder_mode.md

@@ -1,12 +1,12 @@
 regex>=2021.10.23
 tqdm>=4.62.3
-docutils==0.17.1
+docutils==0.18
 python-dateutil==2.8.2
 livereload==2.6.3;python_version>="3.6"
 joblib==1.1.0;python_version>="3.6"
 Markdown==3.3.4;python_version>="3.6"
 MarkupSafe==2.0.1;python_version>="3.6"
-pyparsing==3.0.1;python_version>="3.6"
+pyparsing==3.0.3;python_version>="3.6"
 keyring==23.2.1;python_version>="3.6"
 pkginfo==1.7.1;python_version>="3.6"
 Jinja2==3.0.2;python_version>="3.6"
@@ -21,7 +21,7 @@ lunr==0.6.1;python_version>="3.6"
 nltk==3.6.5;python_version>="3.6"
 watchdog==2.1.6;python_version>="3.6"
 mkdocs==1.2.3;python_version>="3.6"
-mkdocs-material==7.3.4;python_version>="3.6"
+mkdocs-material==7.3.5;python_version>="3.6"
 mkdocs-exclude-search==0.5.2;python_version>="3.6"
 mkdocs-simple-hooks==0.1.3
 mkdocs-material-extensions==1.0.3;python_version>="3.6"

mkdocs_build/requirements.txt

@@ -1,2 +1,2 @@
 # seleniumbase package
-__version__ = "2.0.7"
+__version__ = "2.0.8"

seleniumbase/__version__.py

@@ -19,7 +19,7 @@ COMMANDS:
       options          (List common pytest options)
       mkdir            [DIRECTORY] [OPTIONS]
       mkfile           [FILE.py] [OPTIONS]
-      mkrec / codegen  [FILE.py]
+      mkrec / codegen  [FILE.py] [OPTIONS]
       mkpres           [FILE.py] [LANG]
       mkchart          [FILE.py] [LANG]
       print            [FILE] [OPTIONS]
@@ -225,12 +225,18 @@ is included.
 <h3>mkrec / codegen</h3>
 
 * Usage:
-``sbase mkrec [FILE.py]``
-``sbase codegen [FILE.py]``
+``sbase mkrec [FILE.py] [OPTIONS]``
+``sbase codegen [FILE.py] [OPTIONS]``
 
 * Examples:
 ``sbase mkrec new_test.py``
+``sbase mkrec new_test.py --url=seleniumbase.io``
 ``sbase codegen new_test.py``
+``sbase codegen new_test.py --url=wikipedia.org``
+
+* Options:
+``--url=URL``  (Sets the initial start page URL.)
+``--edge``  (Use Edge browser instead of Chrome.)
 
 * Output:
 Creates a new SeleniumBase test using the Recorder.

seleniumbase/console_scripts/ReadMe.md

@@ -11,7 +11,9 @@
 sbase options
 sbase mkdir ui_tests
 sbase mkfile new_test.py
-sbase mkrec new_test.py  # Same as "sbase codegen new_test.py"
+sbase mkrec new_test.py
+sbase mkrec new_test.py --url=wikipedia.org
+sbase codegen new_test.py --url=wikipedia.org
 sbase mkpres new_presentation.py
 sbase mkchart new_chart.py
 sbase convert webdriver_unittest_file.py
@@ -75,7 +77,7 @@ def show_basic_usage():
     sc += "      options          (List common pytest options)\n"
     sc += "      mkdir            [DIRECTORY] [OPTIONS]\n"
     sc += "      mkfile           [FILE.py] [OPTIONS]\n"
-    sc += "      mkrec / codegen  [FILE.py]\n"
+    sc += "      mkrec / codegen  [FILE.py] [OPTIONS]\n"
     sc += "      mkpres           [FILE.py] [LANG]\n"
     sc += "      mkchart          [FILE.py] [LANG]\n"
     sc += "      print            [FILE] [OPTIONS]\n"
@@ -203,10 +205,14 @@ def show_mkrec_usage():
     print(sc)
     print("")
     print("  Usage:")
-    print("           seleniumbase mkrec [FILE.py]")
-    print("           OR:    sbase mkrec [FILE.py]")
-    print("  Example:")
+    print("           seleniumbase mkrec [FILE.py] [OPTIONS]")
+    print("           OR:    sbase mkrec [FILE.py] [OPTIONS]")
+    print("  Examples:")
     print("           sbase mkrec new_test.py")
+    print("           sbase mkrec new_test.py --url=wikipedia.org")
+    print("  Options:")
+    print("           --url=URL  (Sets the initial start page URL.)")
+    print("           --edge  (Use Edge browser instead of Chrome.)")
     print("  Output:")
     print("           Creates a new SeleniumBase test using the Recorder.")
     print("           If the filename already exists, an error is raised.")
@@ -221,10 +227,14 @@ def show_codegen_usage():
     print(sc)
     print("")
     print("  Usage:")
-    print("           seleniumbase codegen [FILE.py]")
-    print("           OR:    sbase codegen [FILE.py]")
-    print("  Example:")
+    print("           seleniumbase codegen [FILE.py] [OPTIONS]")
+    print("           OR:    sbase codegen [FILE.py] [OPTIONS]")
+    print("  Examples:")
     print("           sbase codegen new_test.py")
+    print("           sbase codegen new_test.py --url=wikipedia.org")
+    print("  Options:")
+    print("           --url=URL  (Sets the initial start page URL.)")
+    print("           --edge  (Use Edge browser instead of Chrome.)")
     print("  Output:")
     print("           Creates a new SeleniumBase test using the Recorder.")
     print("           If the filename already exists, an error is raised.")

seleniumbase/console_scripts/run.py

@@ -3,14 +3,20 @@
 Creates a new SeleniumBase test file using the Recorder.
 
 Usage:
-      seleniumbase mkrec [FILE.py]
-             sbase mkrec [FILE.py]
-    seleniumbase codegen [FILE.py]
-           sbase codegen [FILE.py]
+      seleniumbase mkrec [FILE.py] [OPTIONS]
+             sbase mkrec [FILE.py] [OPTIONS]
+    seleniumbase codegen [FILE.py] [OPTIONS]
+           sbase codegen [FILE.py] [OPTIONS]
 
 Examples:
     sbase mkrec new_test.py
+    sbase mkrec new_test.py --url=seleniumbase.io
     sbase codegen new_test.py
+    sbase codegen new_test.py --url=wikipedia.org
+
+Options:
+    --url=URL  (Sets the initial start page URL.)
+    --edge  (Use Edge browser instead of Chrome.)
 
 Output:
     Creates a new SeleniumBase test using the Recorder.
@@ -34,6 +40,9 @@ def invalid_run_command(msg=None):
     exp += "  Examples:\n"
     exp += "           sbase mkrec new_test.py\n"
     exp += "           sbase codegen new_test.py\n"
+    exp += "  Options:\n"
+    exp += "           --url=URL  (Sets the initial start page URL.)\n"
+    exp += "           --edge  (Use Edge browser instead of Chrome.)\n"
     exp += "  Output:\n"
     exp += "           Creates a new SeleniumBase test using the Recorder.\n"
     exp += "           If the filename already exists, an error is raised.\n"
@@ -65,6 +74,9 @@ def main():
     help_me = False
     error_msg = None
     invalid_cmd = None
+    use_edge = False
+    start_page = None
+    next_is_url = False
 
     command_args = sys.argv[2:]
     file_name = command_args[0]
@@ -87,9 +99,17 @@ def main():
     if len(command_args) >= 2:
         options = command_args[1:]
         for option in options:
-            option = option.lower()
-            if option == "-h" or option == "--help":
+            if option.lower() == "-h" or option.lower() == "--help":
                 help_me = True
+            elif option.lower() == "--edge":
+                use_edge = True
+            elif option.lower().startswith("--url="):
+                start_page = option[len("--url="):]
+            elif option.lower() == "--url":
+                next_is_url = True
+            elif next_is_url:
+                start_page = option
+                next_is_url = False
             else:
                 invalid_cmd = "\n===> INVALID OPTION: >> %s <<\n" % option
                 invalid_cmd = invalid_cmd.replace(">> ", ">>" + c5 + " ")
@@ -121,8 +141,18 @@ def main():
         "" + c1 + file_name + "" + cr + "\n"
     )
     print(success)
-    print("pytest %s --rec -q -s" % file_name)
-    os.system("pytest %s --rec -q -s" % file_name)
+    if not start_page:
+        run_cmd = "pytest %s --rec -q -s" % file_name
+        if use_edge:
+            run_cmd += " --edge"
+        print(run_cmd)
+        os.system(run_cmd)
+    else:
+        run_cmd = "pytest %s --rec -q -s --url=%s" % (file_name, start_page)
+        if use_edge:
+            run_cmd += " --edge"
+        print(run_cmd)
+        os.system(run_cmd)
     if os.path.exists(file_path):
         os.remove(file_path)
     recorded_filename = file_name[:-3] + "_rec.py"

seleniumbase/console_scripts/sb_mkrec.py

@@ -95,6 +95,7 @@ def __init__(self, *args, **kwargs):
         self.__last_page_url = None
         self.__last_page_source = None
         self.__skip_reason = None
+        self.__dont_record_open = False
         self.__dont_record_js_click = False
         self.__new_window_on_rec_open = True
         self.__overrided_default_timeouts = False
@@ -142,7 +143,7 @@ def open(self, url):
         if url.startswith("://"):
             # Convert URLs such as "://google.com" into "https://google.com"
             url = "https" + url
-        if self.recorder_mode:
+        if self.recorder_mode and not self.__dont_record_open:
             time_stamp = self.execute_script("return Date.now();")
             origin = self.get_origin()
             action = ["_url_", origin, url, time_stamp]
@@ -774,9 +775,11 @@ def open_start_page(self):
             if page_utils.is_valid_url(start_page):
                 self.open(start_page)
             else:
-                new_start_page = "http://" + start_page
+                new_start_page = "https://" + start_page
                 if page_utils.is_valid_url(new_start_page):
+                    self.__dont_record_open = True
                     self.open(new_start_page)
+                    self.__dont_record_open = False
                 else:
                     logging.info('Invalid URL: "%s"!' % start_page)
                     self.open("data:,")
@@ -2905,9 +2908,11 @@ def get_new_driver(
                 if page_utils.is_valid_url(self.start_page):
                     self.open(self.start_page)
                 else:
-                    new_start_page = "http://" + self.start_page
+                    new_start_page = "https://" + self.start_page
                     if page_utils.is_valid_url(new_start_page):
+                        self.__dont_record_open = True
                         self.open(new_start_page)
+                        self.__dont_record_open = False
         return new_driver
 
     def switch_to_driver(self, driver):
@@ -10494,10 +10499,12 @@ def setUp(self, masterqa_mode=False):
                     self.open(self.start_page)
                     self.__new_window_on_rec_open = True
                 else:
-                    new_start_page = "http://" + self.start_page
+                    new_start_page = "https://" + self.start_page
                     if page_utils.is_valid_url(new_start_page):
                         good_start_page = True
+                        self.__dont_record_open = True
                         self.open(new_start_page)
+                        self.__dont_record_open = False
             if self.recorder_ext or (self._crumbs and not good_start_page):
                 if self.get_current_url() != "data:,":
                     self.__new_window_on_rec_open = False
@@ -10822,6 +10829,7 @@ def __create_log_path_as_needed(self, test_logpath):
     def __process_dashboard(self, has_exception, init=False):
         """ SeleniumBase Dashboard Processing """
         if self._multithreaded:
+            existing_res = sb_config._results  # For recording "Skipped" tests
             abs_path = os.path.abspath(".")
             dash_json_loc = constants.Dashboard.DASH_JSON
             dash_jsonpath = os.path.join(abs_path, dash_json_loc)
@@ -10908,8 +10916,8 @@ def __process_dashboard(self, has_exception, init=False):
                 sb_config.item_count_untested -= 1
             elif (
                 self._multithreaded
-                and test_id in sb_config._results.keys()
-                and sb_config._results[test_id] == "Skipped"
+                and test_id in existing_res.keys()
+                and existing_res[test_id] == "Skipped"
             ):
                 sb_config._results[test_id] = "Skipped"
                 sb_config.item_count_skipped += 1

seleniumbase/extensions/recorder.zip

@@ -8,15 +8,15 @@
 from selenium.common.exceptions import NoSuchElementException
 from selenium.common.exceptions import NoSuchFrameException
 from selenium.common.exceptions import NoSuchWindowException
-from seleniumbase.common.exceptions import NoSuchFileException
-from seleniumbase.common.exceptions import TimeLimitExceededException
 from seleniumbase import config as sb_config
 
 
 def format_exc(exception, message):
     """
     Formats an exception message to make the output cleaner.
     """
+    from seleniumbase.common.exceptions import NoSuchFileException
+
     if exception == Exception:
         exc = Exception
         return exc, message
@@ -65,6 +65,8 @@ def _format_message(message):
 
 
 def __time_limit_exceeded(message):
+    from seleniumbase.common.exceptions import TimeLimitExceededException
+
     raise TimeLimitExceededException(message)