Merge pull request #983 from seleniumbase/recorder-mode

Add SeleniumBase "Recorder Mode"

Author: mdmintz

.gitignore

@@ -124,6 +124,9 @@ images_exported
 # Cookies
 saved_cookies
 
+# Recordings
+recordings
+
 # Automated Visual Testing
 visual_baseline
 

README.md

@@ -31,11 +31,11 @@
 <br />
 <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md">📚 API</a> |
 <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/ReadMe.md">📊 Reports</a> |
-<a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/boilerplates">♻️ Boilerplates</a> |
+<a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/boilerplates">♻️ Boilerplate</a> |
 <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/syntax_formats.md">🔠 Syntaxes</a> |
-<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/locale_codes.md">🗾 Locales</a> |
-<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_grid/ReadMe.md">🌐 Grid</a> |
-<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_ide/ReadMe.md">⏺️ Record</a>
+<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/recorder_mode.md">⏺️ Recorder</a> |
+<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/locale_codes.md">🗾 Locale</a> |
+<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_grid/ReadMe.md">🌐 Grid</a>
 <br />
 <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/integrations/github/workflows/ReadMe.md">🤖 CI</a> |
 <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/translations.md">🌏 Translate</a> |
@@ -108,7 +108,7 @@ pip install -e .  # Editable install
 
 > (When using a virtual env, the Editable install is faster.)
 
-🔵 You can also install ``seleniumbase`` from [pypi](https://pypi.python.org/pypi/seleniumbase):
+🔵 You can also install ``seleniumbase`` from [pypi](https://pypi.org/project/seleniumbase/):
 
 ```bash
 pip install seleniumbase
@@ -379,6 +379,7 @@ The code above will leave your browser window open in case there's a failure. (i
 --ad-block  # (Block some types of display ads after page loads.)
 --block-images  # (Block images from loading during tests.)
 --verify-delay=SECONDS  # (The delay before MasterQA verification checks.)
+--recorder  # (Enables the Recorder for turning browser actions into code.)
 --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.)

docs/requirements.txt

@@ -4,8 +4,10 @@ livereload==2.6.3;python_version>="3.6"
 joblib==1.0.1;python_version>="3.6"
 Markdown==3.3.4;python_version>="3.6"
 MarkupSafe==2.0.1;python_version>="3.6"
+jsmin==3.0.0;python_version>="3.6"
 docutils==0.17.1
 python-dateutil==2.8.2
+keyring==23.2.1;python_version>="3.6"
 pkginfo==1.7.1;python_version>="3.6"
 Jinja2==3.0.1;python_version>="3.6"
 click==8.0.1;python_version>="3.6"
@@ -15,10 +17,10 @@ pymdown-extensions==8.2;python_version>="3.6"
 importlib-metadata==4.8.1;python_version>="3.6"
 bleach==4.1.0
 lunr==0.6.0;python_version>="3.6"
-nltk==3.6.2;python_version>="3.6"
+nltk==3.6.3;python_version>="3.6"
 watchdog==2.1.5;python_version>="3.6"
 mkdocs==1.2.2;python_version>="3.6"
-mkdocs-material==7.1.3;python_version>="3.6"
+mkdocs-material==7.2.7;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"

examples/hack_the_planet.py

@@ -137,12 +137,14 @@ def test_all_your_base_are_belong_to_us(self):
         self.highlight("h1", loops=8, scroll=False)
 
         self.open("https://dev.to/top/infinity")
+        self.click_if_visible('button[aria-label="Close campaign banner"]')
         self.set_text_content('nav a[data-text="Feed"]', "ALL")
-        self.set_text_content('nav a[data-text="Week"]', "YOUR")
-        self.set_text_content('nav a[data-text="Month"]', "BASE")
-        self.set_text_content('nav a[data-text="Year"]', "ARE")
-        self.set_text_content('nav a[data-text="Infinity"]', "BELONG")
-        self.set_text_content('nav a[data-text="Latest"]', "TO_US")
+        self.set_text_content('nav a[data-text="Latest"]', "YOUR")
+        self.set_text_content('nav a[data-text="Top"]', "BASE")
+        self.set_text_content('nav a[data-text="Week"]', "ARE")
+        self.set_text_content('nav a[data-text="Month"]', "BELONG")
+        self.set_text_content('nav a[data-text="Year"]', "TO")
+        self.set_text_content('nav a[data-text="Infinity"]', "US")
         self.set_text_content('aside a[class*="tful"]', aybabtu)
         self.set_text_content('aside a[aria-label="Create new account"]', ayb)
         self.set_text_content('aside a[aria-label="Log in"]', abtu)
@@ -156,13 +158,13 @@ def test_all_your_base_are_belong_to_us(self):
         self.type('input[name="q"]', aybabtu)
         self.highlight('input[name="q"]', loops=4, scroll=False)
         self.highlight('[aria-label="Primary sidebar"] div div', scroll=False)
-        self.highlight('nav.crayons-tabs', loops=3, scroll=False)
         self.highlight('nav a[data-text="Feed"]', loops=1, scroll=False)
+        self.highlight('nav a[data-text="Latest"]', loops=1, scroll=False)
+        self.highlight('nav a[data-text="Top"]', loops=2, scroll=False)
         self.highlight('nav a[data-text="Week"]', loops=1, scroll=False)
-        self.highlight('nav a[data-text="Month"]', loops=2, scroll=False)
+        self.highlight('nav a[data-text="Month"]', loops=1, scroll=False)
         self.highlight('nav a[data-text="Year"]', loops=1, scroll=False)
-        self.highlight('nav a[data-text="Infinity"]', loops=1, scroll=False)
-        self.highlight('nav a[data-text="Latest"]', loops=2, scroll=False)
+        self.highlight('nav a[data-text="Infinity"]', loops=2, scroll=False)
         self.highlight('aside[id*="sidebar"] section', loops=5, scroll=False)
         self.highlight("div.crayons-story__body", loops=7, scroll=False)
 

examples/raw_parameter_script.py

@@ -70,6 +70,8 @@
     sb.with_db_reporting = False
     sb.with_s3_logging = False
     sb.js_checking_on = False
+    sb.recorder_mode = False
+    sb.recorder_ext = False
     sb.report_on = False
     sb.is_pytest = False
     sb.slow_mode = False

examples/setup.cfg

@@ -1,6 +1,9 @@
+[flake8]
+exclude=recordings,temp
+
 [nosetests]
 # This is the config file for default values used during nosetest runs
 # nocapture=1 displays print statements from output. Undo this by using: --nologcapture
 # logging-level=INFO keeps the logs much cleaner than using DEBUG
 nocapture=1
-logging-level=INFO
+logging-level=INFO

examples/test_demo_site.py

@@ -60,9 +60,11 @@ def test_demo_site(self):
         self.assert_true(self.is_selected("#radioButton2"))
 
         # Verify that clicking a checkbox makes it selected
+        self.assert_element_not_visible("img#logo")
         self.assert_false(self.is_selected("#checkBox1"))
         self.click("#checkBox1")
         self.assert_true(self.is_selected("#checkBox1"))
+        self.assert_element("img#logo")
 
         # Verify clicking on multiple elements with one call
         self.assert_false(self.is_selected("#checkBox2"))
@@ -82,6 +84,11 @@ def test_demo_site(self):
         self.assert_true(self.is_selected(".fBox"))
         self.switch_to_default_content()
 
+        # Verify Drag and Drop
+        self.assert_element_not_visible("div#drop2 img#logo")
+        self.drag_and_drop("img#logo", "div#drop2")
+        self.assert_element("div#drop2 img#logo")
+
         # Assert link text
         self.assert_link_text("seleniumbase.com")
         self.assert_link_text("SeleniumBase on GitHub")

examples/test_drag_and_drop.py

@@ -1,17 +1,23 @@
 """
-Testing Drag & Drop
+Testing Drag & Drop on different pages.
 """
-
 from seleniumbase import BaseCase
 
 
 class DragAndDropTests(BaseCase):
     def test_drag_and_drop(self):
+        self.open("https://seleniumbase.io/other/drag_and_drop")
+        self.assert_element_not_visible("#div1 img#drag1")
+        self.drag_and_drop("#drag1", "#div1")
+        self.assert_element("#div1 img#drag1")
+        self.sleep(0.8)
+
+    def test_w3schools_drag_and_drop(self):
         url = "://w3schools.com/html/tryit.asp?filename=tryhtml5_draganddrop"
         self.open(url)
         self.remove_elements("#tryitLeaderboard")
         self.switch_to_frame("iframeResult")
         self.assert_element_not_visible("#div1 img#drag1")
         self.drag_and_drop("#drag1", "#div1")
         self.assert_element("#div1 img#drag1")
-        self.sleep(1)
+        self.sleep(0.8)

help_docs/ReadMe.md

@@ -29,7 +29,7 @@
 <a href="https://seleniumbase.io/help_docs/translations/">🌏 Translate</a> |
 <a href="https://seleniumbase.io/examples/dialog_boxes/ReadMe/">🛂 DialogBoxes</a>
 <br />
-<a href="https://seleniumbase.io/seleniumbase/utilities/selenium_ide/ReadMe/">⏺️ Recorder</a> |
+<a href="https://seleniumbase.io/help_docs/recorder_mode.md">⏺️ Recorder</a> |
 <a href="https://github.com/seleniumbase/SeleniumBase/tree/master/integrations/node_js">🏃 NodeRunner</a>
 <br />
 <a href="https://seleniumbase.io/examples/presenter/ReadMe/">📰 Presenter</a> |
@@ -75,6 +75,7 @@
 <div><a href="https://seleniumbase.io/tinymce/"><b>TinyMCE Demo Page</b></a></div>
 <div><a href="https://seleniumbase.io/devices/"><b>Virtual Device Farm</b></a></div>
 <div><a href="https://seleniumbase.io/error_page/"><b>Error Page for Tests</b></a></div>
+<div><a href="https://seleniumbase.io/other/drag_and_drop"><b>Drag-&-Drop Test Page</b></a></div>
 <div><a href="https://seleniumbase.io/other/presenter.html"><b>Presenter Demo</b></a></div>
 <div><a href="https://seleniumbase.io/other/core_presentation.html"><b>Core Presentation</b></a></div>
 <div><a href="https://seleniumbase.io/other/chart_presentation.html"><b>Chart Maker Demo</b></a></div>

help_docs/customizing_test_runs.md

@@ -140,6 +140,7 @@ SeleniumBase provides additional ``pytest`` command-line options for tests:
 --ad-block  # (Block some types of display ads after page loads.)
 --block-images  # (Block images from loading during tests.)
 --verify-delay=SECONDS  # (The delay before MasterQA verification checks.)
+--recorder  # (Enables the Recorder for turning browser actions into code.)
 --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.)