Merge pull request #804 from seleniumbase/plugin-compatibility-and-more

Plugin compatibility, Firefox add-ons, and more

Author: mdmintz

README.md

@@ -50,20 +50,19 @@ Tests are run with "pytest". Browsers are controlled by WebDriver.
 <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/master_qa/ReadMe.md">🛂 MasterQA</a>
 </p>
 
-✅ Has a [complete API](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md) for Web-UI testing.<br />
-✅ Expands pytest [command-line options](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/customizing_test_runs.md).<br />
-✅ Includes [scripts](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/console_scripts/ReadMe.md) for driver management.<br />
-✅ Includes tools for [dashboards & reports](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/ReadMe.md).<br />
+✅ Get set up in minutes. Deploy anywhere.<br />
+✅ Build Web-UI tests with a [complete API](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/method_summary.md).<br />
+✅ Generate [test reports and dashboards](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/example_logs/ReadMe.md).<br />
 
 --------
 
-<p align="center">(Example: <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_swag_labs.py">test_swag_labs.py</a> in Demo Mode.)</p>
+<p align="left">(Example: <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py">my_first_test.py</a> in Demo Mode.)</p>
 
 ```bash
-pytest test_swag_labs.py --demo
+pytest my_first_test.py --demo
 ```
 
-<p align="center"><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_swag_labs.py"><img src="https://seleniumbase.io/cdn/gif/swag_demo_2.gif" alt="SeleniumBase Demo Mode" title="SeleniumBase Demo Mode" /></a></p>
+<p align="left"><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_swag_labs.py"><img src="https://seleniumbase.io/cdn/gif/my_first_test_4.gif" alt="SeleniumBase Demo Mode" title="SeleniumBase Demo Mode" width="400" /></a></p>
 
 <a id="python_installation"></a>
 <h2><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> Python Setup:</h2>
@@ -181,7 +180,7 @@ pytest test_swag_labs.py
 pytest my_first_test.py --demo
 ```
 
-<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py"><img src="https://seleniumbase.io/cdn/gif/my_first_test_1.gif" title="SeleniumBase" /></a>
+<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py"><img src="https://seleniumbase.io/cdn/gif/my_first_test_4.gif" title="SeleniumBase" /></a>
 
 <b>Here's the code for [my_first_test.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/my_first_test.py):</b>
 
@@ -382,7 +381,7 @@ The code above will leave your browser window open in case there's a failure. (i
 --incognito  #  (Enable Chrome's Incognito mode.)
 --guest  # (Enable Chrome's Guest mode.)
 --devtools  # (Open Chrome's DevTools when the browser opens.)
---reuse-session  # (Reuse the browser session between tests.)
+--reuse-session | --rs  # (Reuse browser session between tests.)
 --crumbs  # (Delete all cookies between tests reusing a session.)
 --maximize-window  # (Start tests with the web browser window maximized.)
 --save-screenshot  # (Save a screenshot at the end of each test.)

docs/requirements.txt

@@ -6,7 +6,7 @@ Jinja2==2.11.3
 readme-renderer==28.0
 pymdown-extensions==8.1.1
 mkdocs==1.1.2
-mkdocs-material==6.2.7
+mkdocs-material==6.2.8
 mkdocs-simple-hooks==0.1.2
 mkdocs-material-extensions==1.0.1
 mkdocs-minify-plugin==0.4.0

examples/ReadMe.md

@@ -33,7 +33,7 @@ Run an example test in Demo Mode: (highlight assertions)
 pytest my_first_test.py --demo
 ```
 
-<img src="https://seleniumbase.io/cdn/gif/my_first_test_1.gif" title="SeleniumBase Demo Mode" /><br />
+<img src="https://seleniumbase.io/cdn/gif/my_first_test_4.gif" title="SeleniumBase Demo Mode" /><br />
 
 Run a different example in Demo Mode:
 

help_docs/method_summary.md

@@ -208,6 +208,8 @@ self.wait_for_angularjs(timeout=None)
 self.sleep(seconds)
 # Duplicates: self.wait(seconds)
 
+self.install_addon(xpi_file)
+
 self.activate_design_mode()
 
 self.deactivate_design_mode()

requirements.txt

@@ -71,7 +71,7 @@ pymysql==0.10.1;python_version<"3.6"
 pymysql==1.0.2;python_version>="3.6"
 coverage==5.4
 brython==3.9.1
-pyotp==2.5.1
+pyotp==2.6.0
 boto==2.49.0
 cffi==1.14.4
 toml==0.10.2
@@ -86,6 +86,6 @@ pyflakes==2.2.0;python_version>="3.5"
 tornado==5.1.1;python_version<"3.5"
 tornado==6.1;python_version>="3.5"
 allure-pytest==2.8.22;python_version<"3.5"
-allure-pytest==2.8.32;python_version>="3.5"
+allure-pytest==2.8.33;python_version>="3.5"
 pdfminer.six==20191110;python_version<"3.5"
 pdfminer.six==20201018;python_version>="3.5"

seleniumbase/__version__.py

@@ -1,2 +1,2 @@
 # seleniumbase package
-__version__ = "1.55.0"
+__version__ = "1.55.1"

seleniumbase/console_scripts/run.py

@@ -575,7 +575,7 @@ def show_options():
     print('--headless  (Run tests headlessly. Default mode on Linux OS.)')
     print('--demo  (Slow down and visually see test actions as they occur.)')
     print('--slow  (Slow down the automation. Faster than using Demo Mode.)')
-    print('--reuse-session / --rs  (Reuse the browser session between tests.)')
+    print('--reuse-session / --rs  (Reuse browser session between tests.)')
     print('--crumbs  (Delete all cookies between tests reusing a session.)')
     print('--maximize  (Start tests with the web browser window maximized.)')
     print('--dashboard (Enable the SeleniumBase Dashboard at dashboard.html)')

seleniumbase/fixtures/base_case.py

@@ -2184,6 +2184,18 @@ def sleep(self, seconds):
                     break
                 time.sleep(0.2)
 
+    def install_addon(self, xpi_file):
+        """ Installs a Firefox add-on instantly at run-time.
+            @Params
+            xpi_file - A file archive in .xpi format. """
+        if self.browser != "firefox":
+            raise Exception(
+                "install_addon(xpi_file) is for Firefox ONLY!\n"
+                "To load a Chrome extension, use the comamnd-line:\n"
+                "--extension_zip=CRX_FILE  OR  --extension_dir=DIR")
+        xpi_path = os.path.abspath(xpi_file)
+        self.driver.install_addon(xpi_path, temporary=True)
+
     def activate_design_mode(self):
         # Activate Chrome's Design Mode, which lets you edit a site directly.
         # See: https://twitter.com/sulco/status/1177559150563344384

seleniumbase/plugins/pytest_plugin.py

@@ -67,7 +67,7 @@ def pytest_addoption(parser):
     --incognito  (Enable Chrome's Incognito mode.)
     --guest  (Enable Chrome's Guest mode.)
     --devtools  (Open Chrome's DevTools when the browser opens.)
-    --reuse-session / --rs  (Reuse the browser session between tests.)
+    --reuse-session | --rs  (Reuse browser session between tests.)
     --crumbs  (Delete all cookies between tests reusing a session.)
     --maximize  (Start tests with the web browser window maximized.)
     --save-screenshot  (Save a screenshot at the end of each test.)
@@ -856,7 +856,7 @@ def pytest_terminal_summary(terminalreporter):
 def pytest_unconfigure():
     """ This runs after all tests have completed with pytest. """
     proxy_helper.remove_proxy_zip_if_present()
-    if sb_config.reuse_session:
+    if hasattr(sb_config, 'reuse_session') and sb_config.reuse_session:
         # Close the shared browser session
         if sb_config.shared_driver:
             try:
@@ -866,10 +866,13 @@ def pytest_unconfigure():
             except Exception:
                 pass
         sb_config.shared_driver = None
-    log_helper.archive_logs_if_set(sb_config.log_path, sb_config.archive_logs)
+    if hasattr(sb_config, 'log_path'):
+        log_helper.archive_logs_if_set(
+            sb_config.log_path, sb_config.archive_logs)
 
     # Dashboard post-processing: Disable time-based refresh and stamp complete
-    if sb_config.dashboard and not sb_config._only_unittest:
+    if hasattr(sb_config, 'dashboard') and (
+            sb_config.dashboard and not sb_config._only_unittest):
         stamp = ""
         if sb_config._dash_is_html_report:
             # (If the Dashboard URL is the same as the HTML Report URL:)
@@ -985,7 +988,8 @@ def pytest_runtest_makereport(item, call):
     pytest_html = item.config.pluginmanager.getplugin('html')
     outcome = yield
     report = outcome.get_result()
-    if pytest_html and report.when == 'call':
+    if pytest_html and report.when == 'call' and (
+            hasattr(sb_config, 'dashboard')):
         if sb_config.dashboard and not sb_config._sbase_detected:
             test_id, display_id = _get_test_ids_(item)
             r_outcome = report.outcome

setup.py

@@ -175,7 +175,7 @@
         'pymysql==1.0.2;python_version>="3.6"',
         'coverage==5.4',
         'brython==3.9.1',
-        'pyotp==2.5.1',
+        'pyotp==2.6.0',
         'boto==2.49.0',
         'cffi==1.14.4',
         'toml==0.10.2',
@@ -190,7 +190,7 @@
         'tornado==5.1.1;python_version<"3.5"',
         'tornado==6.1;python_version>="3.5"',
         'allure-pytest==2.8.22;python_version<"3.5"',
-        'allure-pytest==2.8.32;python_version>="3.5"',
+        'allure-pytest==2.8.33;python_version>="3.5"',
         'pdfminer.six==20191110;python_version<"3.5"',
         'pdfminer.six==20201018;python_version>="3.5"',
     ],