Update the documentation
This commit is contained in:
Michael Mintz
parent
602c864d51
commit
38addcd18f
48
README.md
48
README.md
|
|
@ -1,15 +1,15 @@
|
|||
<meta property="og:site_name" content="SeleniumBase">
|
||||
<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:keywords" content="Python, pytest, selenium, webdriver, testing, automation, seleniumbase, framework, RPA, behave, BDD, nosetests, dashboard, recorder, reports, gui, screenshots">
|
||||
<meta property="og:keywords" content="Python, pytest, selenium, webdriver, testing, automation, seleniumbase, framework, dashboard, recorder, reports, screenshots">
|
||||
<meta property="og:image" content="https://seleniumbase.github.io/cdn/img/mac_sb_logo_5b.png" />
|
||||
<link rel="icon" href="https://seleniumbase.github.io/img/logo3b.png" />
|
||||
|
||||
<h1>SeleniumBase</h1>
|
||||
<p align="center"><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.github.io/cdn/img/sb_logo_p3.png" alt="SeleniumBase" title="SeleniumBase" width="406" /></a></p>
|
||||
|
||||
<p align="center"><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.github.io/cdn/img/logo_base_3.png" alt="SeleniumBase" title="SeleniumBase" width="234" /></a></p>
|
||||
<h3 align="center"><b>All-in-one Test Automation Framework</b></h3>
|
||||
|
||||
<h3 align="center"><b>All-in-one test automation framework</b></h3>
|
||||
<h4 align="center"><img src="https://seleniumbase.github.io/cdn/img/python_logo.png" title="SeleniumBase" width="29" /> <b>For Python enthusiasts and enterprise developers</b> <img src="https://seleniumbase.github.io/cdn/img/python_logo.png" title="SeleniumBase" width="29" /></h4>
|
||||
|
||||
<p align="center"><a href="https://pypi.python.org/pypi/seleniumbase" target="_blank"><img src="https://img.shields.io/pypi/v/seleniumbase.svg?color=3399EE" alt="PyPI version" /></a> <a href="https://github.com/seleniumbase/SeleniumBase/releases" target="_blank"><img src="https://img.shields.io/github/v/release/seleniumbase/SeleniumBase.svg?color=22AAEE" alt="GitHub version" /></a> <a href="https://seleniumbase.io"><img src="https://img.shields.io/badge/docs-seleniumbase.io-11BBAA.svg" alt="SeleniumBase Docs" /></a> <a href="https://github.com/seleniumbase/SeleniumBase/actions" target="_blank"><img src="https://github.com/seleniumbase/SeleniumBase/workflows/CI%20build/badge.svg" alt="SeleniumBase GitHub Actions" /></a> <a href="https://gitter.im/seleniumbase/SeleniumBase" target="_blank"><img src="https://badges.gitter.im/seleniumbase/SeleniumBase.svg" alt="SeleniumBase" /></a></p>
|
||||
|
||||
|
|
@ -960,21 +960,23 @@ self.assert_text("Tea. Earl Grey. Hot.", "div#trek div.picard div.quotes", timeo
|
|||
🔵 Asserting Anything:
|
||||
|
||||
```python
|
||||
self.assert_true(myvar1 == something)
|
||||
self.assert_true(var1 == var2)
|
||||
|
||||
self.assert_false(var1 == var2)
|
||||
|
||||
self.assert_equal(var1, var2)
|
||||
```
|
||||
|
||||
🔵 Useful Conditional Statements: (with creative examples)
|
||||
|
||||
* ``is_element_visible(selector)`` (visible on the page)
|
||||
❓ ``is_element_visible(selector):`` (visible on the page)
|
||||
|
||||
```python
|
||||
if self.is_element_visible('div#warning'):
|
||||
print("Red Alert: Something bad might be happening!")
|
||||
```
|
||||
|
||||
* ``is_element_present(selector)`` (present in the HTML)
|
||||
❓ ``is_element_present(selector):`` (present in the HTML)
|
||||
|
||||
```python
|
||||
if self.is_element_present('div#top_secret img.tracking_cookie'):
|
||||
|
|
@ -984,8 +986,6 @@ else:
|
|||
self.contact_the_nsa(url=current_url, message="Dark Zone Found") # Not a real SeleniumBase method
|
||||
```
|
||||
|
||||
Another example:
|
||||
|
||||
```python
|
||||
def is_there_a_cloaked_klingon_ship_on_this_page():
|
||||
if self.is_element_present("div.ships div.klingon"):
|
||||
|
|
@ -993,7 +993,16 @@ def is_there_a_cloaked_klingon_ship_on_this_page():
|
|||
return False
|
||||
```
|
||||
|
||||
* ``is_text_visible(text, selector)`` (text visible on element)
|
||||
❓ ``is_text_visible(text, selector):`` (text visible on element)
|
||||
|
||||
```python
|
||||
if self.is_text_visible("You Shall Not Pass!", "h1"):
|
||||
self.open("https://www.youtube.com/watch?v=3xYXUeSmb-Y")
|
||||
```
|
||||
|
||||
<div></div>
|
||||
<details>
|
||||
<summary> ▶️ Click for a longer example of <code>is_text_visible():</code></summary>
|
||||
|
||||
```python
|
||||
def get_mirror_universe_captain_picard_superbowl_ad(superbowl_year):
|
||||
|
|
@ -1022,6 +1031,15 @@ def get_mirror_universe_captain_picard_superbowl_ad(superbowl_year):
|
|||
raise Exception("Reports of my assimilation are greatly exaggerated.")
|
||||
```
|
||||
|
||||
</details>
|
||||
|
||||
❓ ``is_link_text_visible(link_text):``
|
||||
|
||||
```python
|
||||
if self.is_link_text_visible("Stop! Hammer time!"):
|
||||
self.click_link("Stop! Hammer time!")
|
||||
```
|
||||
|
||||
🔵 Switching Tabs:
|
||||
|
||||
<p>If your test opens up a new tab/window, you can switch to it. (SeleniumBase automatically switches to new tabs that don't open to <code>about:blank</code> URLs.)</p>
|
||||
|
|
@ -1164,15 +1182,15 @@ pytest --reruns=1 --reruns-delay=1
|
|||
</p>
|
||||
<p><div><a href="https://github.com/mdmintz">https://github.com/mdmintz</a></div></p>
|
||||
|
||||
<div><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.github.io/cdn/img/fancy_logo_14.png" title="SeleniumBase" width="200" /></a></div> <div><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-22BBCC.svg" title="SeleniumBase" /></a> <a href="https://gitter.im/seleniumbase/SeleniumBase" target="_blank"><img src="https://badges.gitter.im/seleniumbase/SeleniumBase.svg" title="SeleniumBase" alt="Join the chat!" /></a></div> <div><a href="https://github.com/seleniumbase/SeleniumBase"><img src="https://img.shields.io/badge/tested%20with-SeleniumBase-04C38E.svg" alt="Tested with SeleniumBase" /></a></div> <div><a href="https://seleniumbase.io"><img src="https://img.shields.io/badge/docs-seleniumbase.io-11BBAA.svg" alt="SeleniumBase 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>
|
||||
<div><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.github.io/cdn/img/fancy_logo_14.png" title="SeleniumBase" width="220" /></a></div> <div><a href="https://github.com/seleniumbase/SeleniumBase/blob/master/LICENSE"><img src="https://img.shields.io/badge/license-MIT-22BBCC.svg" title="SeleniumBase" /></a> <a href="https://gitter.im/seleniumbase/SeleniumBase" target="_blank"><img src="https://badges.gitter.im/seleniumbase/SeleniumBase.svg" title="SeleniumBase" alt="Join the chat!" /></a></div> <div><a href="https://github.com/seleniumbase/SeleniumBase"><img src="https://img.shields.io/badge/tested%20with-SeleniumBase-04C38E.svg" alt="Tested with SeleniumBase" /></a></div> <div><a href="https://seleniumbase.io"><img src="https://img.shields.io/badge/docs-seleniumbase.io-11BBAA.svg" alt="SeleniumBase 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>
|
||||
<span><a href="https://github.com/seleniumbase/SeleniumBase"><img src="https://seleniumbase.github.io/img/social/share_github.svg" title="SeleniumBase on GitHub" alt="SeleniumBase on GitHub" width="40" /></a></span>
|
||||
<span><a href="https://github.com/seleniumbase/SeleniumBase"><img src="https://seleniumbase.github.io/img/social/share_github.svg" title="SeleniumBase on GitHub" alt="SeleniumBase on GitHub" width="43" /></a></span>
|
||||
<span><a href="https://www.facebook.com/SeleniumBase" target="_blank"><img src="https://seleniumbase.github.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.github.io/img/social/share_gitter.svg" title="SeleniumBase on Gitter" alt="SeleniumBase on Gitter" width="32" /></a></span>
|
||||
<span><a href="https://gitter.im/seleniumbase/SeleniumBase" target="_blank"><img src="https://seleniumbase.github.io/img/social/share_gitter.svg" title="SeleniumBase on Gitter" alt="SeleniumBase on Gitter" width="35" /></a></span>
|
||||
<span><a href="https://instagram.com/seleniumbase" target="_blank"><img src="https://seleniumbase.github.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.github.io/img/social/share_twitter.svg" title="SeleniumBase on Twitter" alt="SeleniumBase on Twitter" width="40" /></a></span>
|
||||
<span><a href="https://twitter.com/seleniumbase" target="_blank"><img src="https://seleniumbase.github.io/img/social/share_twitter.svg" title="SeleniumBase on Twitter" alt="SeleniumBase on Twitter" width="39" /></a></span>
|
||||
</div></p>
|
||||
|
||||
<p><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.github.io/cdn/img/super_logo_sb.png" alt="SeleniumBase" title="SeleniumBase" width="200" /></a></p>
|
||||
<p><a href="https://github.com/seleniumbase/SeleniumBase/"><img src="https://seleniumbase.github.io/cdn/img/sb_logo_i2.png" alt="SeleniumBase" title="SeleniumBase" width="240" /></a></p>
|
||||
<p><a href="https://www.python.org/downloads/" target="_blank"><img src="https://img.shields.io/pypi/pyversions/seleniumbase.svg?color=22AAEE&logo=python" title="Supported Python Versions" /></a></p>
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
<a id="syntax_formats"></a>
|
||||
|
||||
## [<img src="https://seleniumbase.github.io/img/logo6.png" title="SeleniumBase" width="32">](https://github.com/seleniumbase/SeleniumBase/) The 23 Syntax Formats
|
||||
## [<img src="https://seleniumbase.github.io/img/logo3b.png" title="SeleniumBase" width="40">](https://github.com/seleniumbase/SeleniumBase/) The 23 Syntax Formats
|
||||
|
||||
<b>SeleniumBase</b> currently supports 23 different syntax formats (AKA "design patterns") for structuring tests.
|
||||
<b>SeleniumBase</b> currently supports 23 unique syntax formats (AKA "design patterns") for structuring tests.
|
||||
|
||||
--------
|
||||
|
||||
|
|
@ -38,7 +38,7 @@
|
|||
--------
|
||||
|
||||
<a id="sb_sf_01"></a>
|
||||
<h3><img src="https://seleniumbase.github.io/img/green_logo.png" title="SeleniumBase" width="32" /> 1. BaseCase direct class inheritance</h3>
|
||||
<h3><img src="https://seleniumbase.github.io/img/logo3b.png" title="SeleniumBase" width="32" /> 1. BaseCase direct class inheritance</h3>
|
||||
|
||||
This format is used by most of the examples in the <a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples">SeleniumBase examples folder</a>. It's a great starting point for anyone learning SeleniumBase, and it follows good object-oriented programming principles. In this format, <code>BaseCase</code> is imported at the top of a Python file, followed by a Python class inheriting <code>BaseCase</code>. Then, any test method defined in that class automatically gains access to SeleniumBase methods, including the <code>setUp()</code> and <code>tearDown()</code> methods that are automatically called to spin up and spin down web browsers at the beginning and end of test methods. Here's an example of that:
|
||||
|
||||
|
|
@ -60,7 +60,7 @@ class MyTestClass(BaseCase):
|
|||
(See <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_demo_site.py">examples/test_demo_site.py</a> for the full test.)
|
||||
|
||||
<a id="sb_sf_02"></a>
|
||||
<h3><img src="https://seleniumbase.github.io/img/green_logo.png" title="SeleniumBase" width="32" /> 2. BaseCase subclass inheritance</h3>
|
||||
<h3><img src="https://seleniumbase.github.io/img/logo3b.png" title="SeleniumBase" width="32" /> 2. BaseCase subclass inheritance</h3>
|
||||
|
||||
There are situations where you may want to customize the <code>setUp</code> and <code>tearDown</code> of your tests. Maybe you want to have all your tests login to a specific web site first, or maybe you want to have your tests report results through an API call depending on whether a test passed or failed. <b>This can be done by creating a subclass of <code>BaseCase</code> and then carefully creating custom <code>setUp()</code> and <code>tearDown()</code> methods that don't overwrite the critical functionality of the default SeleniumBase <code>setUp()</code> and <code>tearDown()</code> methods.</b> Afterwards, your test classes will inherit the subclass of <code>BaseCase</code> with the added functionality, rather than directly inheriting <code>BaseCase</code> itself. Here's an example of that:
|
||||
|
||||
|
|
@ -106,7 +106,7 @@ class MyTests(BaseTestCase):
|
|||
(See <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/boilerplates/base_test_case.py">examples/boilerplates/base_test_case.py</a> for more info.)
|
||||
|
||||
<a id="sb_sf_03"></a>
|
||||
<h3><img src="https://seleniumbase.github.io/img/green_logo.png" title="SeleniumBase" width="32" /> 3. The "sb" pytest fixture (no class)</h3>
|
||||
<h3><img src="https://seleniumbase.github.io/img/logo3b.png" title="SeleniumBase" width="32" /> 3. The "sb" pytest fixture (no class)</h3>
|
||||
|
||||
The pytest framework comes with a unique system called fixtures, which replaces import statements at the top of Python files by importing libraries directly into test definitions. More than just being an import, a pytest fixture can also automatically call predefined <code>setUp()</code> and <code>tearDown()</code> methods at the beginning and end of test methods. To work, <code>sb</code> is added as an argument to each test method definition that needs SeleniumBase functionality. This means you no longer need import statements in your Python files to use SeleniumBase. <b>If using other pytest fixtures in your tests, you may need to use the SeleniumBase fixture (instead of <code>BaseCase</code> class inheritance) for compatibility reasons.</b> Here's an example of the <code>sb</code> fixture in a test that does not use Python classes:
|
||||
|
||||
|
|
@ -121,7 +121,7 @@ def test_sb_fixture_with_no_class(sb):
|
|||
(See the top of <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_sb_fixture.py">examples/test_sb_fixture.py</a> for the test.)
|
||||
|
||||
<a id="sb_sf_04"></a>
|
||||
<h3><img src="https://seleniumbase.github.io/img/green_logo.png" title="SeleniumBase" width="32" /> 4. The "sb" pytest fixture (in class)</h3>
|
||||
<h3><img src="https://seleniumbase.github.io/img/logo3b.png" title="SeleniumBase" width="32" /> 4. The "sb" pytest fixture (in class)</h3>
|
||||
|
||||
The <code>sb</code> pytest fixture can also be used inside of a class. There is a slight change to the syntax because that means test methods must also include <code>self</code> in their argument definitions when test methods are defined. (The <code>self</code> argument represents the class object, and is used in every test method that lives inside of a class.) Once again, no import statements are needed in your Python files for this to work. Here's an example of using the <code>sb</code> fixture in a test method that lives inside of a Python class:
|
||||
|
||||
|
|
@ -137,7 +137,7 @@ class Test_SB_Fixture:
|
|||
(See the bottom of <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_sb_fixture.py">examples/test_sb_fixture.py</a> for the test.)
|
||||
|
||||
<a id="sb_sf_05"></a>
|
||||
<h3><img src="https://seleniumbase.github.io/img/green_logo.png" title="SeleniumBase" width="32" /> 5. Page Object Model with BaseCase</h3>
|
||||
<h3><img src="https://seleniumbase.github.io/img/logo3b.png" title="SeleniumBase" width="32" /> 5. Page Object Model with BaseCase</h3>
|
||||
|
||||
With SeleniumBase, you can use Page Objects to break out code from tests, but remember, the <code>self</code> variable (from test methods that inherit <code>BaseCase</code>) contains the driver and all other framework-specific variable definitions. Therefore, that <code>self</code> must be passed as an arg into any outside class method in order to call SeleniumBase methods from there. In the example below, the <code>self</code> variable from the test method is passed into the <code>sb</code> arg of the Page Object class method because the <code>self</code> arg of the Page Object class method is already being used for its own class. Every Python class method definition must include the <code>self</code> as the first arg.
|
||||
|
||||
|
|
@ -161,7 +161,7 @@ class MyTests(BaseCase):
|
|||
(See <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/boilerplates/samples/swag_labs_test.py">examples/boilerplates/samples/swag_labs_test.py</a> for the full test.)
|
||||
|
||||
<a id="sb_sf_06"></a>
|
||||
<h3><img src="https://seleniumbase.github.io/img/green_logo.png" title="SeleniumBase" width="32" /> 6. Page Object Model with the "sb" fixture</h3>
|
||||
<h3><img src="https://seleniumbase.github.io/img/logo3b.png" title="SeleniumBase" width="32" /> 6. Page Object Model with the "sb" fixture</h3>
|
||||
|
||||
This is similar to the classic Page Object Model with <code>BaseCase</code> inheritance, except that this time we pass the <code>sb</code> pytest fixture from the test into the <code>sb</code> arg of the page object class method, (instead of passing <code>self</code>). Now that you're using <code>sb</code> as a pytest fixture, you no longer need to import <code>BaseCase</code> anywhere in your code. See the example below:
|
||||
|
||||
|
|
@ -183,7 +183,7 @@ class MyTests:
|
|||
(See <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/boilerplates/samples/sb_swag_test.py">examples/boilerplates/samples/sb_swag_test.py</a> for the full test.)
|
||||
|
||||
<a id="sb_sf_07"></a>
|
||||
<h3><img src="https://seleniumbase.github.io/img/green_logo.png" title="SeleniumBase" width="32" /> 7. Using "request" to get "sb" (no class)</h3>
|
||||
<h3><img src="https://seleniumbase.github.io/img/logo3b.png" title="SeleniumBase" width="32" /> 7. Using "request" to get "sb" (no class)</h3>
|
||||
|
||||
The pytest <code>request</code> fixture can be used to retrieve other pytest fixtures from within tests, such as the <code>sb</code> fixture. This allows you to have more control over when fixtures get initialized because the fixture no longer needs to be loaded at the very beginning of test methods. This is done by calling <code>request.getfixturevalue('sb')</code> from the test. Here's an example of using the pytest <code>request</code> fixture to load the <code>sb</code> fixture in a test method that does not use Python classes:
|
||||
|
||||
|
|
@ -201,7 +201,7 @@ def test_request_sb_fixture(request):
|
|||
(See the top of <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_request_sb_fixture.py">examples/test_request_sb_fixture.py</a> for the test.)
|
||||
|
||||
<a id="sb_sf_08"></a>
|
||||
<h3><img src="https://seleniumbase.github.io/img/green_logo.png" title="SeleniumBase" width="32" /> 8. Using "request" to get "sb" (in class)</h3>
|
||||
<h3><img src="https://seleniumbase.github.io/img/logo3b.png" title="SeleniumBase" width="32" /> 8. Using "request" to get "sb" (in class)</h3>
|
||||
|
||||
The pytest <code>request</code> fixture can also be used to get the <code>sb</code> fixture from inside a Python class. Here's an example of that:
|
||||
|
||||
|
|
@ -221,7 +221,7 @@ class Test_Request_Fixture:
|
|||
(See the bottom of <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/test_request_sb_fixture.py">examples/test_request_sb_fixture.py</a> for the test.)
|
||||
|
||||
<a id="sb_sf_09"></a>
|
||||
<h3><img src="https://seleniumbase.github.io/img/green_logo.png" title="SeleniumBase" width="32" /> 9. Overriding the driver via BaseCase</h3>
|
||||
<h3><img src="https://seleniumbase.github.io/img/logo3b.png" title="SeleniumBase" width="32" /> 9. Overriding the driver via BaseCase</h3>
|
||||
|
||||
When you want to use SeleniumBase methods via <code>BaseCase</code>, but you want total freedom to control how you spin up your web browsers, this is the format you want. Although SeleniumBase gives you plenty of command-line options to change how your browsers are launched, this format gives you more control when the existing options aren't enough. Here's an example of that:
|
||||
|
||||
|
|
@ -278,7 +278,7 @@ class WireTestCase(BaseCase):
|
|||
```
|
||||
|
||||
<a id="sb_sf_10"></a>
|
||||
<h3><img src="https://seleniumbase.github.io/img/green_logo.png" title="SeleniumBase" width="32" /> 10. Overriding the driver via "sb" fixture</h3>
|
||||
<h3><img src="https://seleniumbase.github.io/img/logo3b.png" title="SeleniumBase" width="32" /> 10. Overriding the driver via "sb" fixture</h3>
|
||||
|
||||
When you want to use SeleniumBase methods via the ``sb`` pytest fixture, but you want total freedom to control how you spin up your web browsers, this is the format you want. Although SeleniumBase gives you plenty of command-line options to change how your browsers are launched, this format gives you more control when the existing options aren't enough.
|
||||
|
||||
|
|
@ -391,7 +391,7 @@ class TestWire:
|
|||
```
|
||||
|
||||
<a id="sb_sf_11"></a>
|
||||
<h3><img src="https://seleniumbase.github.io/img/green_logo.png" title="SeleniumBase" width="32" /> 11. BaseCase with Chinese translations</h3>
|
||||
<h3><img src="https://seleniumbase.github.io/img/logo3b.png" title="SeleniumBase" width="32" /> 11. BaseCase with Chinese translations</h3>
|
||||
|
||||
This format is similar to the English version with <code>BaseCase</code> inheritance, but there's a different import statement, and method names have been translated into Chinese. Here's an example of that:
|
||||
|
||||
|
|
@ -421,7 +421,7 @@ class 我的测试类(硒测试用例):
|
|||
(See <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/translations/chinese_test_1.py">examples/translations/chinese_test_1.py</a> for the Chinese test.)
|
||||
|
||||
<a id="sb_sf_12"></a>
|
||||
<h3><img src="https://seleniumbase.github.io/img/green_logo.png" title="SeleniumBase" width="32" /> 12. BaseCase with Dutch translations</h3>
|
||||
<h3><img src="https://seleniumbase.github.io/img/logo3b.png" title="SeleniumBase" width="32" /> 12. BaseCase with Dutch translations</h3>
|
||||
|
||||
This format is similar to the English version with <code>BaseCase</code> inheritance, but there's a different import statement, and method names have been translated into Dutch. Here's an example of that:
|
||||
|
||||
|
|
@ -450,7 +450,7 @@ class MijnTestklasse(Testgeval):
|
|||
(See <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/translations/dutch_test_1.py">examples/translations/dutch_test_1.py</a> for the Dutch test.)
|
||||
|
||||
<a id="sb_sf_13"></a>
|
||||
<h3><img src="https://seleniumbase.github.io/img/green_logo.png" title="SeleniumBase" width="32" /> 13. BaseCase with French translations</h3>
|
||||
<h3><img src="https://seleniumbase.github.io/img/logo3b.png" title="SeleniumBase" width="32" /> 13. BaseCase with French translations</h3>
|
||||
|
||||
This format is similar to the English version with <code>BaseCase</code> inheritance, but there's a different import statement, and method names have been translated into French. Here's an example of that:
|
||||
|
||||
|
|
@ -479,7 +479,7 @@ class MaClasseDeTest(CasDeBase):
|
|||
(See <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/translations/french_test_1.py">examples/translations/french_test_1.py</a> for the French test.)
|
||||
|
||||
<a id="sb_sf_14"></a>
|
||||
<h3><img src="https://seleniumbase.github.io/img/green_logo.png" title="SeleniumBase" width="32" /> 14. BaseCase with Italian translations</h3>
|
||||
<h3><img src="https://seleniumbase.github.io/img/logo3b.png" title="SeleniumBase" width="32" /> 14. BaseCase with Italian translations</h3>
|
||||
|
||||
This format is similar to the English version with <code>BaseCase</code> inheritance, but there's a different import statement, and method names have been translated into Italian. Here's an example of that:
|
||||
|
||||
|
|
@ -508,7 +508,7 @@ class MiaClasseDiTest(CasoDiProva):
|
|||
(See <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/translations/italian_test_1.py">examples/translations/italian_test_1.py</a> for the Italian test.)
|
||||
|
||||
<a id="sb_sf_15"></a>
|
||||
<h3><img src="https://seleniumbase.github.io/img/green_logo.png" title="SeleniumBase" width="32" /> 15. BaseCase with Japanese translations</h3>
|
||||
<h3><img src="https://seleniumbase.github.io/img/logo3b.png" title="SeleniumBase" width="32" /> 15. BaseCase with Japanese translations</h3>
|
||||
|
||||
This format is similar to the English version with <code>BaseCase</code> inheritance, but there's a different import statement, and method names have been translated into Japanese. Here's an example of that:
|
||||
|
||||
|
|
@ -538,7 +538,7 @@ class 私のテストクラス(セレニウムテストケース):
|
|||
(See <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/translations/japanese_test_1.py">examples/translations/japanese_test_1.py</a> for the Japanese test.)
|
||||
|
||||
<a id="sb_sf_16"></a>
|
||||
<h3><img src="https://seleniumbase.github.io/img/green_logo.png" title="SeleniumBase" width="32" /> 16. BaseCase with Korean translations</h3>
|
||||
<h3><img src="https://seleniumbase.github.io/img/logo3b.png" title="SeleniumBase" width="32" /> 16. BaseCase with Korean translations</h3>
|
||||
|
||||
This format is similar to the English version with <code>BaseCase</code> inheritance, but there's a different import statement, and method names have been translated into Korean. Here's an example of that:
|
||||
|
||||
|
|
@ -566,7 +566,7 @@ class 테스트_클래스(셀레늄_테스트_케이스):
|
|||
(See <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/translations/korean_test_1.py">examples/translations/korean_test_1.py</a> for the Korean test.)
|
||||
|
||||
<a id="sb_sf_17"></a>
|
||||
<h3><img src="https://seleniumbase.github.io/img/green_logo.png" title="SeleniumBase" width="32" /> 17. BaseCase with Portuguese translations</h3>
|
||||
<h3><img src="https://seleniumbase.github.io/img/logo3b.png" title="SeleniumBase" width="32" /> 17. BaseCase with Portuguese translations</h3>
|
||||
|
||||
This format is similar to the English version with <code>BaseCase</code> inheritance, but there's a different import statement, and method names have been translated into Portuguese. Here's an example of that:
|
||||
|
||||
|
|
@ -598,7 +598,7 @@ class MinhaClasseDeTeste(CasoDeTeste):
|
|||
(See <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/translations/portuguese_test_1.py">examples/translations/portuguese_test_1.py</a> for the Portuguese test.)
|
||||
|
||||
<a id="sb_sf_18"></a>
|
||||
<h3><img src="https://seleniumbase.github.io/img/green_logo.png" title="SeleniumBase" width="32" /> 18. BaseCase with Russian translations</h3>
|
||||
<h3><img src="https://seleniumbase.github.io/img/logo3b.png" title="SeleniumBase" width="32" /> 18. BaseCase with Russian translations</h3>
|
||||
|
||||
This format is similar to the English version with <code>BaseCase</code> inheritance, but there's a different import statement, and method names have been translated into Russian. Here's an example of that:
|
||||
|
||||
|
|
@ -627,7 +627,7 @@ class МойТестовыйКласс(ТестНаСелен):
|
|||
(See <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/translations/russian_test_1.py">examples/translations/russian_test_1.py</a> for the Russian test.)
|
||||
|
||||
<a id="sb_sf_19"></a>
|
||||
<h3><img src="https://seleniumbase.github.io/img/green_logo.png" title="SeleniumBase" width="32" /> 19. BaseCase with Spanish translations</h3>
|
||||
<h3><img src="https://seleniumbase.github.io/img/logo3b.png" title="SeleniumBase" width="32" /> 19. BaseCase with Spanish translations</h3>
|
||||
|
||||
This format is similar to the English version with <code>BaseCase</code> inheritance, but there's a different import statement, and method names have been translated into Spanish. Here's an example of that:
|
||||
|
||||
|
|
@ -656,7 +656,7 @@ class MiClaseDePrueba(CasoDePrueba):
|
|||
(See <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/translations/spanish_test_1.py">examples/translations/spanish_test_1.py</a> for the Spanish test.)
|
||||
|
||||
<a id="sb_sf_20"></a>
|
||||
<h3><img src="https://seleniumbase.github.io/img/green_logo.png" title="SeleniumBase" width="32" /> 20. Gherkin syntax with "behave" BDD runner</h3>
|
||||
<h3><img src="https://seleniumbase.github.io/img/logo3b.png" title="SeleniumBase" width="32" /> 20. Gherkin syntax with "behave" BDD runner</h3>
|
||||
|
||||
With [Behave's BDD Gherkin format](https://behave.readthedocs.io/en/stable/gherkin.html), you can use natural language to write tests that work with SeleniumBase methods. Behave tests are run by calling ``behave`` on the command-line. This requires some special files in a specific directory structure. Here's an example of that structure:
|
||||
|
||||
|
|
@ -758,7 +758,7 @@ def login_to_swag_labs(context, user):
|
|||
(For more information, see the <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/behave_bdd/ReadMe.md">SeleniumBase Behave BDD ReadMe</a>.)
|
||||
|
||||
<a id="sb_sf_21"></a>
|
||||
<h3><img src="https://seleniumbase.github.io/img/green_logo.png" title="SeleniumBase" width="32" /> 21. SeleniumBase SB (Python context manager)</h3>
|
||||
<h3><img src="https://seleniumbase.github.io/img/logo3b.png" title="SeleniumBase" width="32" /> 21. SeleniumBase SB (Python context manager)</h3>
|
||||
|
||||
This format provides a pure Python way of using SeleniumBase without a test runner. Options can be passed via method instantiation or from the command-line. When setting the <code>test</code> option to <code>True</code> (or calling <code>python --test</code>), then standard test logging will occur, such as screenshots and reports for failing tests. All the usual SeleniumBase options are available, such as customizing the browser settings, etc. Here are some examples:
|
||||
|
||||
|
|
@ -809,7 +809,7 @@ with SB(test=True, rtf=True, demo=True) as sb:
|
|||
(See <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/raw_test_scripts.py">examples/raw_test_scripts.py</a> for the test.)
|
||||
|
||||
<a id="sb_sf_22"></a>
|
||||
<h3><img src="https://seleniumbase.github.io/img/green_logo.png" title="SeleniumBase" width="32" /> 22. The driver manager (via context manager)</h3>
|
||||
<h3><img src="https://seleniumbase.github.io/img/logo3b.png" title="SeleniumBase" width="32" /> 22. The driver manager (via context manager)</h3>
|
||||
|
||||
This pure Python format gives you a raw <code>webdriver</code> instance in a <code>with</code> block. The SeleniumBase Driver Manager will automatically make sure that your driver is compatible with your browser version. It gives you full access to customize driver options via method args or via the command-line. The driver will automatically call <code>quit()</code> after the code leaves the <code>with</code> block. Here are some examples:
|
||||
|
||||
|
|
@ -822,15 +822,15 @@ from seleniumbase import Driver
|
|||
# Python Context Manager
|
||||
with Driver() as driver: # By default, browser="chrome"
|
||||
driver.get("https://google.com/ncr")
|
||||
js_utils.highlight_with_js(driver, 'img[alt="Google"]', 6, "")
|
||||
js_utils.highlight_with_js(driver, 'img[alt="Google"]', loops=6)
|
||||
|
||||
with Driver() as driver: # Also accepts command-line options
|
||||
driver.get("https://seleniumbase.github.io/demo_page")
|
||||
js_utils.highlight_with_js(driver, "h2", 5, "")
|
||||
js_utils.highlight_with_js(driver, "h2", loops=5)
|
||||
by_css = "css selector"
|
||||
driver.find_element(by_css, "#myTextInput").send_keys("Automation")
|
||||
driver.find_element(by_css, "#checkBox1").click()
|
||||
js_utils.highlight_with_js(driver, "img", 5, "")
|
||||
js_utils.highlight_with_js(driver, "img", loops=5)
|
||||
|
||||
# Python Context Manager (with options given)
|
||||
with Driver(browser="chrome", incognito=True) as driver:
|
||||
|
|
@ -838,13 +838,13 @@ with Driver(browser="chrome", incognito=True) as driver:
|
|||
page_actions.wait_for_element(driver, "4", "id").click()
|
||||
page_actions.wait_for_element(driver, "2", "id").click()
|
||||
page_actions.wait_for_text(driver, "42", "output", "id")
|
||||
js_utils.highlight_with_js(driver, "#output", 6, "")
|
||||
js_utils.highlight_with_js(driver, "#output", loops=6)
|
||||
```
|
||||
|
||||
(See <a href="https://github.com/seleniumbase/SeleniumBase/blob/master/examples/raw_driver.py">examples/raw_driver.py</a> for an example.)
|
||||
|
||||
<a id="sb_sf_23"></a>
|
||||
<h3><img src="https://seleniumbase.github.io/img/green_logo.png" title="SeleniumBase" width="32" /> 23. The driver manager (via direct import)</h3>
|
||||
<h3><img src="https://seleniumbase.github.io/img/logo3b.png" title="SeleniumBase" width="32" /> 23. The driver manager (via direct import)</h3>
|
||||
|
||||
Another way of running Selenium tests with pure ``python`` (as opposed to using ``pytest`` or ``nosetests``) is by using this format, which bypasses [BaseCase](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/fixtures/base_case.py) methods while still giving you a flexible driver with a manager. SeleniumBase includes helper files such as [page_actions.py](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/fixtures/page_actions.py), which may help you get around some of the limitations of bypassing ``BaseCase``. Here's an example:
|
||||
|
||||
|
|
@ -861,18 +861,18 @@ try:
|
|||
page_actions.wait_for_element(driver, "4", "id").click()
|
||||
page_actions.wait_for_element(driver, "2", "id").click()
|
||||
page_actions.wait_for_text(driver, "42", "output", "id")
|
||||
js_utils.highlight_with_js(driver, "#output", 6, "")
|
||||
js_utils.highlight_with_js(driver, "#output", loops=6)
|
||||
finally:
|
||||
driver.quit()
|
||||
|
||||
# Example 2 using default args or command-line options
|
||||
driver = Driver()
|
||||
driver.get("https://seleniumbase.github.io/demo_page")
|
||||
js_utils.highlight_with_js(driver, "h2", 5, "")
|
||||
js_utils.highlight_with_js(driver, "h2", loops=5)
|
||||
by_css = "css selector"
|
||||
driver.find_element(by_css, "#myTextInput").send_keys("Automation")
|
||||
driver.find_element(by_css, "#checkBox1").click()
|
||||
js_utils.highlight_with_js(driver, "img", 5, "")
|
||||
js_utils.highlight_with_js(driver, "img", loops=5)
|
||||
driver.quit() # If the script fails early, the driver still quits
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -33,4 +33,4 @@ mkdocs-material==8.5.6
|
|||
mkdocs-exclude-search==0.6.4
|
||||
mkdocs-simple-hooks==0.1.5
|
||||
mkdocs-material-extensions==1.0.3
|
||||
mkdocs-minify-plugin==0.5.0
|
||||
mkdocs-minify-plugin==0.6.0
|
||||
|
|
|
|||
Loading…
Reference in New Issue