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

Update the docs

This commit is contained in:
Michael Mintz 2020-10-22 09:37:35 -04:00
parent 14604b3176
commit 7f77e34458
5 changed files with 39 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@ -1,15 +1,15 @@
<meta property="og:site_name" content="SeleniumBase | Docs">
<meta property="og:title" content="SeleniumBase | Python Web Testing" />
<meta property="og:site_name" content="SeleniumBase">
<meta property="og:title" content="SeleniumBase: Python Web Automation and E2E Testing" />
<meta property="og:description" content="Build fast, reliable, end-to-end tests." />
<meta property="og:keywords" content="Python, pytest, selenium, webdriver, test automation, testing, seleniumbase, test framework, RPA, reports, website tours, presentations">
<meta property="og:image" content="https://seleniumbase.io/cdn/img/sb_logo_dh.png" />
<link rel="icon" href="https://seleniumbase.io/img/logo3a.png" />
<p align="center"><a href="https://github.com/seleniumbase/SeleniumBase/">
<img src="https://seleniumbase.io/cdn/img/fancy_logo_14.png" alt="SeleniumBase" width="300" />
<img src="https://seleniumbase.io/cdn/img/fancy_logo_14.png" alt="SeleniumBase" title="SeleniumBase" width="300" />
</a></p>
<p align="center"><b>A complete end-to-end testing experience.</b></p>
<p align="center">Extends <a href="https://www.w3.org/TR/webdriver/">Selenium/WebDriver</a> and <a href="https://docs.pytest.org/en/latest/index.html">pytest</a>.</p>
<p align="center"><b>The complete web automation library.</b></p>
<p align="center">Powered by WebDriver APIs and pytest.</p>
<!-- View on GitHub -->
<p align="center">
<a href="https://github.com/seleniumbase/SeleniumBase/releases">
@ -22,8 +22,8 @@
</p>
<p>
<b>SeleniumBase</b> is an all-in-one framework for reliable browser automation, end-to-end testing, reports, charts, presentations, and website tours.
Tests are run with <b>pytest</b>. Browsers are controlled by <b>WebDriver</b>.
<b>SeleniumBase</b> is an all-in-one framework for reliable browser automation, end-to-end testing, reports, charts, presentations, website tours, and visual testing.
Tests are run with <a href="https://docs.pytest.org/en/latest/index.html">pytest</a>. Browsers are controlled by <a href="https://www.w3.org/TR/webdriver2/#endpoints">WebDriver</a>.
</p>
<p align="center">
@ -57,7 +57,7 @@ Tests are run with <b>pytest</b>. Browsers are controlled by <b>WebDriver</b>.
--------
<p align="center"><img src="https://cdn2.hubspot.net/hubfs/100006/images/swag_mobile.gif" width="450" alt="SeleniumBase Mobile Mode" title="SeleniumBase Mobile Mode" /></p>
<p align="center"><img src="https://seleniumbase.io/cdn/gif/swag_mobile.gif" width="450" alt="SeleniumBase Mobile Mode" title="SeleniumBase Mobile Mode" /></p>
```bash
pytest test_swag_labs.py --mobile
@ -414,8 +414,9 @@ 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.)
--disable-csp # (This disables the Content Security Policy of websites.)
--enable-ws # (Enable Web Security on Chrome.)
--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.)
--enable-sync # (Enable "Chrome Sync".)
--use-auto-ext # (Use Chrome's automation extension.)
--swiftshader # (Use Chrome's "--use-gl=swiftshader" feature.)

1
help_docs/ReadMe.md
View File

@ -70,6 +70,7 @@
<div><a href="https://seleniumbase.io/demo_page"><b>Demo Page / Demo Site</b></a></div>
<div><a href="https://seleniumbase.io/other/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/presenter.html"><b>Presenter Demo</b></a></div>
<div><a href="https://seleniumbase.io/other/core_presentation.html"><b>Core Presentation</b></a></div>

5
help_docs/customizing_test_runs.md
View File

@ -126,8 +126,9 @@ 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.)
--disable-csp # (This disables the Content Security Policy of websites.)
--enable-ws # (Enable Web Security on Chrome.)
--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.)
--enable-sync # (Enable "Chrome Sync".)
--use-auto-ext # (Use Chrome's automation extension.)
--swiftshader # (Use Chrome's "--use-gl=swiftshader" feature.)

20
help_docs/mobile_testing.md
View File

@ -11,27 +11,42 @@ Use ``--mobile`` to run SeleniumBase tests using Chrome's mobile device emulator
```bash
pytest test_skype_site.py --mobile
```
[<img src="https://cdn2.hubspot.net/hubfs/100006/images/skype_mobile_test_2.gif" title="SeleniumBase Mobile Testing">](https://cdn2.hubspot.net/hubfs/100006/images/skype_mobile_test_2.gif)
[<img src="https://seleniumbase.io/cdn/gif/skype_mobile_test_2.gif" title="SeleniumBase Mobile Testing">](https://seleniumbase.io/cdn/gif/skype_mobile_test_2.gif)
To configure Device Metrics, use:
```bash
--metrics="CSS_Width,CSS_Height,Pixel_Ratio"
```
To configure the User-Agent, use:
```bash
--agent="USER-AGENT-STRING"
```
To find real values for Device Metrics, see:
* [Device Metrics List](https://gist.github.com/sidferreira/3f5fad525e99b395d8bd882ee0fd9d00)
To find real User-Agent strings, see:
* [User Agent Strings List](https://developers.whatismybrowser.com/useragents/explore/)
--------
Here's another example of running a mobile test ([SeleniumBase/examples/test_swag_labs.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_swag_labs.py)), which demonstrates using ``--metrics`` and ``--agent`` with ``--mobile``:
<b>Here's another example of a mobile test:</b>
[SeleniumBase/examples/test_swag_labs.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_swag_labs.py)
```bash
pytest test_swag_labs.py --mobile
```
[<img src="https://seleniumbase.io/cdn/gif/swag_mobile.gif" title="SeleniumBase Mobile Testing">](https://seleniumbase.io/cdn/gif/swag_mobile.gif)
<b>Here's an example of configuring mobile settings for that test:</b>
```bash
# Run tests using Chrome's mobile device emulator (default settings)
@ -43,7 +58,6 @@ pytest test_swag_labs.py --mobile --metrics="411,731,3"
# Run mobile tests specifying the user agent
pytest test_swag_labs.py --mobile --agent="Mozilla/5.0 (Linux; Android 9; Pixel 3 XL)"
```
[<img src="https://cdn2.hubspot.net/hubfs/100006/images/swag_mobile.gif" title="SeleniumBase Mobile Testing">](https://cdn2.hubspot.net/hubfs/100006/images/swag_mobile.gif)
--------

13
mkdocs.yml
View File

@ -1,8 +1,8 @@
# Project information
site_name: SeleniumBase | Docs
site_name: Docs - seleniumbase.io
site_url: https://seleniumbase.io
site_author: Michael Mintz
site_description: Fast, reliable, end-to-end testing
site_description: The world's most powerful all-in-one web automation platform. Build fast, reliable, end-to-end tests with Python.
# Repository information
repo_name: seleniumbase/SeleniumBase
repo_url: https://github.com/seleniumbase/SeleniumBase
@ -33,7 +33,7 @@ theme:
search_index_only: true
features:
- tabs
# - instant
- instant
palette:
scheme: default
primary: blue
@ -47,13 +47,13 @@ theme:
plugins:
- search
- minify:
minify_html: false
minify_html: true
- mkdocs-simple-hooks:
hooks:
on_pre_build: docs.prepare:main
# Page tree
nav:
- SeleniumBase | Docs: README.md
- SeleniumBase Docs: README.md
- Features List: help_docs/features_list.md
- Running Example Tests: examples/ReadMe.md
- Command Line Options: help_docs/customizing_test_runs.md
@ -98,13 +98,14 @@ nav:
- Docker Help: integrations/docker/ReadMe.md
- MySQL Help: help_docs/mysql_installation.md
- Case Studies: help_docs/happy_customers.md
- Thank You: help_docs/thank_you.md
- Demo Pages:
- Demo Page / Demo Site: https://seleniumbase.io/demo_page
- TinyMCE Demo Page: https://seleniumbase.io/other/tinymce
- Virtual Device Farm: https://seleniumbase.io/devices/
- Error Demo Page: https://seleniumbase.io/error_page/
- Presenter Demo: https://seleniumbase.io/other/presenter.html
- Core Presentation: https://seleniumbase.io/other/core_presentation.html
- Chart Maker Demo: https://seleniumbase.io/other/chart_presentation.html
- Thank You: help_docs/thank_you.md
# Google Analytics
google_analytics: ['UA-167313767-1', 'seleniumbase.io']