Merge pull request #1133 from seleniumbase/recorder-desktop-and-more

The Recorder Mode Desktop App: Deluxe Edition (and more)

Author: mdmintz

README.md

@@ -108,6 +108,7 @@ COMMANDS:
       mkdir            [DIRECTORY] [OPTIONS]
       mkfile           [FILE.py] [OPTIONS]
       mkrec / codegen  [FILE.py] [OPTIONS]
+      recorder         (Open Recorder Desktop App)
       mkpres           [FILE.py] [LANG]
       mkchart          [FILE.py] [LANG]
       print            [FILE] [OPTIONS]

examples/desktop_apps/ReadMe.md

@@ -2,4 +2,4 @@
 
 <h2><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> Desktop Apps</h2>
 
-* **Recorder** (Run using ``python recorder.py``)
+* **Recorder** (Run using ``python recorder.py`` or ``sbase recorder``)

examples/desktop_apps/recorder.py

@@ -1,63 +1,12 @@
-""" Run this file using `python recorder.py` """
+""" Run this file using ``python recorder.py`` """
 
 import os
-import sys
-from seleniumbase.fixtures import page_utils
 
-if sys.version_info[0] < 3:
-    raise Exception("This script is for Python 3 only!")
-import tkinter as tk  # noqa: E402
-from tkinter import messagebox  # noqa: E402
 
-
-def do_recording(file_name, url):
-    url = url.strip()
-    if not page_utils.is_valid_url(url):
-        if page_utils.is_valid_url("https://" + url):
-            url = "https://" + url
-    if not page_utils.is_valid_url(url):
-        messagebox.showwarning(
-            "Invalid URL", "Enter a valid URL. (Eg. https://google.com)")
-    else:
-        if os.path.exists(file_name):
-            os.remove(file_name)
-        os.system("python -m sbase mkrec %s --url=%s" % (file_name, url))
-
-
-def do_playback(file_name):
-    os.system("pytest %s --verbose --capture=no" % file_name)
-
-
-def create_tkinter_gui(file_name):
-    window = tk.Tk()
-    window.title("Recorder App")
-    window.geometry("360x175")
-    frame = tk.Frame(window)
-    frame.pack()
-
-    a = tk.StringVar()
-    tk.Label(window, text="Enter URL to start recording on:").pack()
-    entry = tk.Entry(window, textvariable=a)
-    entry.pack()
-    entry.focus()
-    entry.bind("<Return>", (lambda _: do_recording(file_name, a.get())))
-    tk.Button(
-        window, text="Record", command=lambda: do_recording(file_name, a.get())
-    ).pack()
-    tk.Label(window, text="").pack()
-    tk.Label(
-        window, text="Playback the latest recording:").pack()
-    tk.Button(
-        window, text="Playback", command=lambda: do_playback(file_name)
-    ).pack()
-
-    # Bring form to front
-    window.lift()
-    window.attributes("-topmost", True)
-    window.after_idle(window.attributes, "-topmost", False)
-    window.mainloop()
+def open_recorder_desktop_app():
+    command = "sbase recorder"
+    os.system(command)
 
 
 if __name__ == "__main__":
-    file_name = "new_recording.py"
-    create_tkinter_gui(file_name)
+    open_recorder_desktop_app()

examples/hack_the_planet.py

@@ -21,6 +21,7 @@ def test_all_your_base_are_belong_to_us(self):
         wiki = "https://en.wikipedia.org/wiki/All_your_base_are_belong_to_us"
 
         self.open(wiki)
+        self.click_if_visible('button[aria-label="Close"]')
         self.set_text_content("h1#firstHeading", aybabtu)
         self.set_text_content("#ca-history a", aybabtu)
         self.set_text_content('#n-mainpage-description a', "ALL")

help_docs/recorder_mode.md

@@ -6,7 +6,7 @@
 
 <img src="https://seleniumbase.io/cdn/img/sb_recorder_notification.png" title="SeleniumBase" width="380">
 
-(This tutorial assumes that you are using SeleniumBase version ``2.1.6`` or newer.)
+(For the latest Recorder improvements, use SeleniumBase version ``2.3.0`` or newer.)
 
 🔴 To make a new recording with Recorder Mode, you can use ``sbase mkrec`` or ``sbase codegen``):
 
@@ -38,7 +38,16 @@ ipdb> c
 *** RECORDING COPIED to: new_test.py
 ```
 
-🔴 While a recording is in progress, you can press the ``[ESC]`` key to pause the recording. To resume the recording, you can hit the ``[~`]`` key, which is located directly below the ``[ESC]`` key on most keyboards.
+🔴 You can also activate Recorder Mode from the Recorder Desktop App:
+
+```bash
+sbase recorder
+* Starting the SeleniumBase Recorder Desktop App...
+```
+
+<img src="https://seleniumbase.io/cdn/img/recorder_desktop.png" title="SeleniumBase" width="340">
+
+🔴 While a recording is in progress, you can press the ``[ESC]`` key to pause the Recorder. To resume the recording, you can hit the ``[~`]`` key, which is located directly below the ``[ESC]`` key on most keyboards.
 
 🔴 From within Recorder Mode there are two additional modes: "Assert Element Mode" and "Assert Text Mode". To switch into "Assert Element Mode", press the <code>{^}-key (SHIFT+6)</code>: The border will become purple, and you'll be able to click on elements to assert from your test. To switch into "Assert Text Mode", press the <code>{&}-key (SHIFT+7)</code>: The border will become teal, and you'll be able to click on elements for asserting text from your test. While using either of the two special Assertion Modes, certain actions such as clicking on links won't have any effect. This lets you make assertions on elements without navigating away from the page, etc. To add an assertion for a button without triggering its default behavior via a "click" action, mouse-down on the button and then mouse-up somewhere else, which prevents a detected click while still recording the assert. To return back to the original Recorder Mode, press any key other than SHIFT or BACKSPACE (Eg: Press ``CONTROL``, etc.). You can also press ESC once to leave the Assertion Modes, but if you press it again, it'll stop the Recorder.
 

mkdocs_build/requirements.txt

@@ -14,15 +14,15 @@ click==8.0.3;python_version>="3.6"
 zipp==3.6.0;python_version>="3.6"
 readme-renderer==32.0
 pymdown-extensions==9.1;python_version>="3.6"
-importlib-metadata==4.8.2;python_version>="3.6"
+importlib-metadata==4.9.0;python_version>="3.6"
 bleach==4.1.0
 jsmin==3.0.0;python_version>="3.6"
 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==8.1.1;python_version>="3.6"
+mkdocs-material==8.1.2;python_version>="3.6"
 mkdocs-exclude-search==0.5.4;python_version>="3.6"
-mkdocs-simple-hooks==0.1.3
+mkdocs-simple-hooks==0.1.4
 mkdocs-material-extensions==1.0.3;python_version>="3.6"
 mkdocs-minify-plugin==0.5.0

requirements.txt

@@ -79,7 +79,7 @@ beautifulsoup4==4.10.0;python_version>="3.5"
 cryptography==2.9.2;python_version<"3.5"
 cryptography==3.2.1;python_version>="3.5" and python_version<"3.6"
 cryptography==3.4.8;python_version>="3.6" and python_version<"3.7"
-cryptography==36.0.0;python_version>="3.7"
+cryptography==36.0.1;python_version>="3.7"
 pygments==2.5.2;python_version<"3.5"
 pygments==2.10.0;python_version>="3.5"
 prompt-toolkit==1.0.18;python_version<"3.5"
@@ -111,7 +111,7 @@ Pillow==7.2.0;python_version>="3.5" and python_version<"3.6"
 Pillow==8.4.0;python_version>="3.6"
 typing-extensions==3.10.0.2;python_version<"3.6"
 typing-extensions==4.0.0;python_version>="3.6" and python_version<"3.8"
-rich==10.16.0;python_version>="3.6" and python_version<"4.0"
+rich==10.16.1;python_version>="3.6" and python_version<"4.0"
 tornado==5.1.1;python_version<"3.5"
 tornado==6.1;python_version>="3.5"
 pdfminer.six==20191110;python_version<"3.5"

seleniumbase/__version__.py

@@ -1,2 +1,2 @@
 # seleniumbase package
-__version__ = "2.2.10"
+__version__ = "2.3.0"

seleniumbase/console_scripts/ReadMe.md

@@ -20,6 +20,7 @@ COMMANDS:
       mkdir            [DIRECTORY] [OPTIONS]
       mkfile           [FILE.py] [OPTIONS]
       mkrec / codegen  [FILE.py] [OPTIONS]
+      recorder         (Open Recorder Desktop App)
       mkpres           [FILE.py] [LANG]
       mkchart          [FILE.py] [LANG]
       print            [FILE] [OPTIONS]
@@ -243,6 +244,14 @@ is included.
 Creates a new SeleniumBase test using the Recorder.
 If the filename already exists, an error is raised.
 
+<h3>recorder</h3>
+
+* Usage:
+``sbase recorder``
+
+* Output:
+Launches the SeleniumBase Recorder Desktop App.
+
 <h3>mkpres</h3>
 
 * Usage:

seleniumbase/console_scripts/run.py

@@ -14,6 +14,7 @@
 sbase mkrec new_test.py
 sbase mkrec new_test.py --url=wikipedia.org
 sbase codegen new_test.py --url=wikipedia.org
+sbase recorder
 sbase mkpres new_presentation.py
 sbase mkchart new_chart.py
 sbase convert webdriver_unittest_file.py
@@ -78,6 +79,7 @@ def show_basic_usage():
     sc += "      mkdir            [DIRECTORY] [OPTIONS]\n"
     sc += "      mkfile           [FILE.py] [OPTIONS]\n"
     sc += "      mkrec / codegen  [FILE.py] [OPTIONS]\n"
+    sc += "      recorder         (Open Recorder Desktop App)\n"
     sc += "      mkpres           [FILE.py] [LANG]\n"
     sc += "      mkchart          [FILE.py] [LANG]\n"
     sc += "      print            [FILE] [OPTIONS]\n"
@@ -772,6 +774,10 @@ def main():
         else:
             show_basic_usage()
             show_install_usage()
+    elif command == "recorder":
+        from seleniumbase.console_scripts import sb_recorder
+
+        sb_recorder.main()
     elif command == "mkdir":
         if len(command_args) >= 1:
             from seleniumbase.console_scripts import sb_mkdir