test_framework
/
SeleniumBase
mirror of https://github.com/seleniumbase/SeleniumBase.git
3
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update documentation

This commit is contained in:
Michael Mintz 2022-05-17 15:09:43 -04:00
parent ef0223eeff
commit 7d9095d6d3
4 changed files with 32 additions and 26 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
README.md
View File

@ -1,14 +1,14 @@
<meta property="og:site_name" content="SeleniumBase"> <meta property="og:site_name" content="SeleniumBase">
<meta property="og:title" content="SeleniumBase: Python Web Automation and E2E Testing" /> <meta property="og:title" content="SeleniumBase: Python Web Automation and E2E Testing" />
<meta property="og:description" content="Fast, easy, and reliable Web/UI testing with Python." /> <meta property="og:description" content="Fast, easy, and reliable Web/UI testing with Python." />
<meta property="og:keywords" content="Python, pytest, selenium, webdriver, testing, automation, seleniumbase, framework, RPA, behave, nosetests, dashboard, recorder, reports, gui"> <meta property="og:keywords" content="Python, pytest, selenium, webdriver, testing, automation, seleniumbase, framework, RPA, behave, BDD, nosetests, dashboard, recorder, reports, gui, screenshots">
<meta property="og:image" content="https://seleniumbase.io/cdn/img/mac_sb_logo_5.png" /> <meta property="og:image" content="https://seleniumbase.io/cdn/img/mac_sb_logo_5.png" />
<link rel="icon" href="https://seleniumbase.io/img/green_logo.png" /> <link rel="icon" href="https://seleniumbase.io/img/green_logo.png" />
<h3 align="center"><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.io/cdn/img/mac_sb_logo_9.png" alt="SeleniumBase" title="SeleniumBase" width="340" /></a></h3> <h3 align="center"><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.io/cdn/img/nice_logo_4t.png" alt="SeleniumBase" title="SeleniumBase" width="260" /></a></h3>
<!-- View on GitHub --> <!-- View on GitHub -->
<p align="center"><div align="center">Python framework for <a href="https://www.selenium.dev/documentation/" target="_blank">Selenium</a>. Supports <a href="https://docs.pytest.org/en/stable/" target="_blank">pytest</a> and <a href="https://behave.readthedocs.io/en/stable/index.html" target="_blank">behave-BDD</a>.</div></p> <p align="center"><div align="center">A Python ecosystem for <a href="https://www.selenium.dev/documentation/" target="_blank">Selenium</a> that extends <a href="https://docs.pytest.org/en/stable/" target="_blank">Pytest</a> and <a href="https://behave.readthedocs.io/en/stable/index.html" target="_blank">Behave</a>.</div></p>
<p align="center"> <p align="center">
<a href="https://github.com/seleniumbase/SeleniumBase/releases"> <a href="https://github.com/seleniumbase/SeleniumBase/releases">
@ -47,7 +47,7 @@
-------- --------
<p align="left">↘️ Example test with the <b>BaseCase</b> class. Runs with <code>pytest</code> or <code>nosetests</code>. (<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/ReadMe.md">Learn more</a>)</p> <p align="left">🌱 An example with <b>BaseCase</b>, a subclass of <code>unittest.TestCase</code>. Runs with <code>pytest</code> or <code>nosetests</code>. (<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/ReadMe.md">Learn more</a>)</p>
```python ```python
from seleniumbase import BaseCase from seleniumbase import BaseCase
@ -64,7 +64,7 @@ class TestMFALogin(BaseCase):
self.save_screenshot_to_logs() self.save_screenshot_to_logs()
``` ```
<p align="left">↘️ Example test with the <b>sb</b> pytest fixture. Runs with <code>pytest</code>.</p> <p align="left">🌱 An example with <b>sb</b>, a <code>pytest</code> fixture. Runs with <code>pytest</code>.</p>
```python ```python
def test_mfa_login(sb): def test_mfa_login(sb):
@ -78,7 +78,7 @@ def test_mfa_login(sb):
sb.save_screenshot_to_logs() sb.save_screenshot_to_logs()
``` ```
<p align="left">↘️ Example test with <b>behave-BDD</b> <a href="https://behave.readthedocs.io/en/stable/gherkin.html">Gherkin</a> structure. Runs with <code>behave</code>. (<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/behave_bdd/ReadMe.md">Learn more</a>)</p> <p align="left">🌱 An example with <b>behave-BDD</b> <a href="https://behave.readthedocs.io/en/stable/gherkin.html">Gherkin</a> structure. Runs with <code>behave</code>. (<a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/behave_bdd/ReadMe.md">Learn more</a>)</p>
```gherkin ```gherkin
Feature: SeleniumBase scenarios for the RealWorld App Feature: SeleniumBase scenarios for the RealWorld App
@ -431,6 +431,8 @@ The code above will leave your browser window open in case there's a failure. (i
--block-images # (Block images from loading during tests.) --block-images # (Block images from loading during tests.)
--verify-delay=SECONDS # (The delay before MasterQA verification checks.) --verify-delay=SECONDS # (The delay before MasterQA verification checks.)
--recorder # (Enables the Recorder for turning browser actions into code.) --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.)
--disable-csp # (Disable the Content Security Policy of websites.) --disable-csp # (Disable the Content Security Policy of websites.)
--disable-ws # (Disable Web Security on Chromium-based browsers.) --disable-ws # (Disable Web Security on Chromium-based browsers.)
--enable-ws # (Enable Web Security on Chromium-based browsers.) --enable-ws # (Enable Web Security on Chromium-based browsers.)
@ -1022,11 +1024,13 @@ pytest --reruns=1 --reruns-delay=1
<img src="https://img.shields.io/badge/docs-%20%20SeleniumBase.io-11BBDD.svg" alt="SeleniumBase.io Docs" /></a></div> <div><a href="https://pepy.tech/project/seleniumbase" target="_blank"><img src="https://pepy.tech/badge/seleniumbase" alt="SeleniumBase PyPI downloads" /></a></div> <img src="https://img.shields.io/badge/docs-%20%20SeleniumBase.io-11BBDD.svg" alt="SeleniumBase.io Docs" /></a></div> <div><a href="https://pepy.tech/project/seleniumbase" target="_blank"><img src="https://pepy.tech/badge/seleniumbase" alt="SeleniumBase PyPI downloads" /></a></div>
<p><div> <p><div>
<span><a href="https://github.com/seleniumbase/SeleniumBase"><img src="https://seleniumbase.io/img/social/share_github.svg" title="SeleniumBase on GitHub" alt="SeleniumBase on GitHub" width="38" /></a></span> <span><a href="https://github.com/seleniumbase/SeleniumBase"><img src="https://seleniumbase.io/img/social/share_github.svg" title="SeleniumBase on GitHub" alt="SeleniumBase on GitHub" width="40" /></a></span>
<span><a href="https://www.facebook.com/SeleniumBase" target="_blank"><img src="https://seleniumbase.io/img/social/share_facebook.svg" title="SeleniumBase on Facebook" alt="SeleniumBase on Facebook" width="36" /></a></span> <span><a href="https://www.facebook.com/SeleniumBase" target="_blank"><img src="https://seleniumbase.io/img/social/share_facebook.svg" title="SeleniumBase on Facebook" alt="SeleniumBase on Facebook" width="37" /></a></span>
<span><a href="https://gitter.im/seleniumbase/SeleniumBase" target="_blank"><img src="https://seleniumbase.io/img/social/share_gitter.svg" title="SeleniumBase on Gitter" alt="SeleniumBase on Gitter" width="30" /></a></span> <span><a href="https://gitter.im/seleniumbase/SeleniumBase" target="_blank"><img src="https://seleniumbase.io/img/social/share_gitter.svg" title="SeleniumBase on Gitter" alt="SeleniumBase on Gitter" width="32" /></a></span>
<span><a href="https://instagram.com/seleniumbase" target="_blank"><img src="https://seleniumbase.io/img/social/share_instagram.svg" title="SeleniumBase on Instagram" alt="SeleniumBase on Instagram" width="32" /></a></span> <span><a href="https://instagram.com/seleniumbase" target="_blank"><img src="https://seleniumbase.io/img/social/share_instagram.svg" title="SeleniumBase on Instagram" alt="SeleniumBase on Instagram" width="33" /></a></span>
<span><a href="https://twitter.com/seleniumbase" target="_blank"><img src="https://seleniumbase.io/img/social/share_twitter.svg" title="SeleniumBase on Twitter" alt="SeleniumBase on Twitter" width="39" /></a></span> <span><a href="https://twitter.com/seleniumbase" target="_blank"><img src="https://seleniumbase.io/img/social/share_twitter.svg" title="SeleniumBase on Twitter" alt="SeleniumBase on Twitter" width="40" /></a></span>
</div></p> </div></p>
<a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.io/cdn/img/super_logo_sb.png" alt="SeleniumBase" title="SeleniumBase" width="200" /></a> <a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.io/cdn/img/super_logo_sb.png" alt="SeleniumBase" title="SeleniumBase" width="200" /></a>
<p><b>Build all the automation you want, with SeleniumBase.</b></p>

2
examples/example_logs/ReadMe.md
View File

@ -102,7 +102,7 @@ nosetests test_suite.py --report
-------- --------
<h3><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> 🔵🐝⚪ Behave Dashboard & Reports:</h3> <h3><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="32" /> 🐝⚪ Behave Dashboard & Reports:</h3>
(The [behave_bdd/](https://github.com/seleniumbase/SeleniumBase/tree/master/examples/behave_bdd) folder can be found in the [examples/](https://github.com/seleniumbase/SeleniumBase/tree/master/examples) folder.) (The [behave_bdd/](https://github.com/seleniumbase/SeleniumBase/tree/master/examples/behave_bdd) folder can be found in the [examples/](https://github.com/seleniumbase/SeleniumBase/tree/master/examples) folder.)

2
help_docs/customizing_test_runs.md
View File

@ -148,6 +148,8 @@ pytest my_first_test.py --settings-file=custom_settings.py
--block-images # (Block images from loading during tests.) --block-images # (Block images from loading during tests.)
--verify-delay=SECONDS # (The delay before MasterQA verification checks.) --verify-delay=SECONDS # (The delay before MasterQA verification checks.)
--recorder # (Enables the Recorder for turning browser actions into code.) --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.)
--disable-csp # (Disable the Content Security Policy of websites.) --disable-csp # (Disable the Content Security Policy of websites.)
--disable-ws # (Disable Web Security on Chromium-based browsers.) --disable-ws # (Disable Web Security on Chromium-based browsers.)
--enable-ws # (Enable Web Security on Chromium-based browsers.) --enable-ws # (Enable Web Security on Chromium-based browsers.)

10
mkdocs.yml
View File

@ -2,7 +2,7 @@
site_name: SeleniumBase Docs site_name: SeleniumBase Docs
site_url: https://seleniumbase.io site_url: https://seleniumbase.io
site_author: Michael Mintz site_author: Michael Mintz
site_description: A complete framework for end-to-end testing with Python, pytest, and WebDriver. site_description: A complete framework for end-to-end testing with Python, pytest, behave-BDD, and WebDriver.
# Repository information # Repository information
repo_name: seleniumbase/SeleniumBase repo_name: seleniumbase/SeleniumBase
repo_url: https://github.com/seleniumbase/SeleniumBase repo_url: https://github.com/seleniumbase/SeleniumBase
@ -82,7 +82,7 @@ nav:
- Running Example Tests: examples/ReadMe.md - Running Example Tests: examples/ReadMe.md
- Command Line Options: help_docs/customizing_test_runs.md - Command Line Options: help_docs/customizing_test_runs.md
- Dashboard / Reports: examples/example_logs/ReadMe.md - Dashboard / Reports: examples/example_logs/ReadMe.md
- SeleniumBase Commander: help_docs/commander.md - GUI / Commander: help_docs/commander.md
- Console Scripts: seleniumbase/console_scripts/ReadMe.md - Console Scripts: seleniumbase/console_scripts/ReadMe.md
- Syntax Formats: help_docs/syntax_formats.md - Syntax Formats: help_docs/syntax_formats.md
- Recorder Mode: help_docs/recorder_mode.md - Recorder Mode: help_docs/recorder_mode.md
@ -94,9 +94,9 @@ nav:
- WebDriver Installation: help_docs/webdriver_installation.md - WebDriver Installation: help_docs/webdriver_installation.md
- Verifying WebDriver: help_docs/verify_webdriver.md - Verifying WebDriver: help_docs/verify_webdriver.md
- How it Works: help_docs/how_it_works.md - How it Works: help_docs/how_it_works.md
- Behave-BDD: - Behave-BDD Integration:
- SBase Behave-BDD ReadMe: examples/behave_bdd/ReadMe.md - Behave-BDD ReadMe: examples/behave_bdd/ReadMe.md
- SBase Behave-BDD GUI App: help_docs/behave_gui.md - Behave-BDD GUI App: help_docs/behave_gui.md
- Languages: - Languages:
- Translations: help_docs/translations.md - Translations: help_docs/translations.md
- Chinese Docs: help_docs/chinese.md - Chinese Docs: help_docs/chinese.md