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-05-24 02:38:50 -04:00
parent fdeafddea1
commit 2b84777b6e
3 changed files with 29 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
docs/img/sb_logo_7.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 74 KiB

After

Width:  |  Height:  |  Size: 61 KiB

10
help_docs/method_summary.md
View File

@ -9,7 +9,7 @@ For backwards compatibility, older versions of method names have remained to kee
```python
self.open(url)
# Duplicates: self.open_url(url), self.get(url)
# self.visit(url), self.goto(url), self.go_to(url)
# self.visit(url), visit_url(url), self.goto(url), self.go_to(url)
self.click(selector, by=By.CSS_SELECTOR, timeout=None, delay=0)
@ -29,8 +29,8 @@ self.add_text(selector, text, by=By.CSS_SELECTOR, timeout=None)
self.submit(selector, by=By.CSS_SELECTOR)
self.refresh()
# Duplicates: self.refresh_page()
self.refresh_page()
# Duplicates: self.refresh(), self.reload(), self.reload_page()
self.get_current_url()
@ -62,8 +62,8 @@ self.get_link_attribute(link_text, attribute, hard_fail=True)
self.get_partial_link_text_attribute(link_text, attribute, hard_fail=True)
self.click_link(link_text, timeout=None)
# Duplicates: self.click_link_text(link_text, timeout=None)
self.click_link_text(link_text, timeout=None)
# Duplicates: self.click_link(link_text, timeout=None)
self.click_partial_link_text(partial_link_text, timeout=None)

31
help_docs/mobile_testing.md
View File

@ -1,15 +1,30 @@
[<img src="https://cdn2.hubspot.net/hubfs/100006/images/SeleniumBaseText_F.png" title="SeleniumBase" align="center" width="290">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
<p align="center"><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/README.md"><img src="https://cdn2.hubspot.net/hubfs/100006/images/SeleniumBaseText_F.png" alt="SeleniumBase" title="SeleniumBase" width="290" /></a></p>
<h2><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="30" /> Mobile Testing</h2>
Use ``--mobile`` to run your SeleniumBase tests using Chrome's (or Edge's) mobile device emulator with default values for device metrics (CSS Width, CSS Height, Pixel-Ratio) and user agent.
Use ``--mobile`` to run your SeleniumBase tests using Chromium's mobile device emulator with default values for device metrics (CSS Width, CSS Height, Pixel-Ratio) and user agent.
To configure the mobile device metrics, use ``--metrics="CSS_Width,CSS_Height,Pixel_Ratio"``. To configure the user agent, use ``--agent="USER-AGENT-STRING"``.
To configure the mobile device metrics, use:
```bash
--metrics="CSS_Width,CSS_Height,Pixel_Ratio"
```
To find real values for device metrics, [see this GitHub Gist](https://gist.github.com/sidferreira/3f5fad525e99b395d8bd882ee0fd9d00). For a list of available user agent strings, [check out this page](https://developers.whatismybrowser.com/useragents/explore/).
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)
For a list of available user agent strings, see:
* [User Agent Strings List](https://developers.whatismybrowser.com/useragents/explore/)
--------
Here's an example of running a mobile test (See https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_skype_site.py):
Here's an example of running a mobile test:
* [SeleniumBase/examples/test_skype_site.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_skype_site.py)
```bash
pytest test_skype_site.py --mobile
@ -18,7 +33,7 @@ pytest test_skype_site.py --mobile
--------
Here's another example of running a mobile test (https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_swag_labs.py), which demonstrates using ``--metrics`` and ``--agent`` with ``--mobile``:
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``:
```bash
# Run tests using Chrome's mobile device emulator (default settings)
@ -34,4 +49,6 @@ pytest test_swag_labs.py --mobile --agent="Mozilla/5.0 (Linux; Android 9; Pixel
--------
If you're new to SeleniumBase, read https://github.com/seleniumbase/SeleniumBase to help you get started.
<p align="center"><div align="center"><a href="https://seleniumbase.io">
<img src="https://img.shields.io/badge/docs-%20📓📖📚-11BBDD.svg" alt="SeleniumBase.io Docs" />
</a> <a href="https://github.com/seleniumbase/SeleniumBase"><img src="https://img.shields.io/badge/✅%20💛%20View%20Code-on%20GitHub%20🌎%20🚀-02A79E.svg" alt="SeleniumBase.io Docs" /></a></div></p>