Update help_docs

This commit is contained in:
Michael Mintz 2023-02-03 01:06:11 -05:00
parent 8feb097996
commit f0fb390dd6
29 changed files with 11 additions and 14 deletions

0
help_docs/ReadMe.md Executable file → Normal file
View File

0
help_docs/behave_gui.md Executable file → Normal file
View File

0
help_docs/case_plans.md Executable file → Normal file
View File

0
help_docs/commander.md Executable file → Normal file
View File

0
help_docs/customizing_test_runs.md Executable file → Normal file
View File

0
help_docs/demo_mode.md Executable file → Normal file
View File

0
help_docs/desired_capabilities.md Executable file → Normal file
View File

4
help_docs/features_list.md Executable file → Normal file
View File

@ -18,7 +18,7 @@
* Can run tests in Headless Mode to hide the browser. (``--headless``)
* Can run tests multithreaded from parallel browsers. (``-n NUM_THREADS``)
* Can run tests from a shared browser session. (``--reuse-session``/``--rs``)
* Can run tests using Chromium's mobile device emulator. (``--mobile``)
* Can run tests using [Chromium's mobile device emulator](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/mobile_testing.md). (``--mobile``)
* Can run tests through a proxy server. (``--proxy=IP_ADDRESS:PORT``)
* Can run tests with proxy settings via PAC URL. (``--proxy-pac-url=URL.pac``)
* Can run tests through an authenticated proxy server. (``--proxy=USER:PASS@HOST:PORT``)
@ -44,7 +44,7 @@
* Can inspect HTML to find issues and points of interest with the [HTML Inspector](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/html_inspector.md).
* Is backwards-compatible with Python [WebDriver](https://www.selenium.dev/projects/) methods. (Use: ``self.driver``)
* Can execute JavaScript code from Python calls. (Use: ``self.execute_script()``)
* Can pierce through Shadow DOM selectors. (Add ``::shadow`` to CSS fragments.)
* Can pierce through [Shadow DOM selectors](https://github.com/seleniumbase/SeleniumBase/blob/master/help_docs/shadow_dom.md). (Add ``::shadow`` to CSS fragments.)
* Includes a hybrid-automation solution, [MasterQA](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/masterqa/ReadMe.md), to speed up manual testing.
* Includes useful [Python decorators and password obfuscation methods](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/common/ReadMe.md).

12
help_docs/happy_customers.md Executable file → Normal file
View File

@ -2,7 +2,7 @@
<h3 align="left"><img src="https://seleniumbase.github.io/cdn/img/sb_logo_b.png" alt="SeleniumBase" width="300" /></h3>
### Organizations that have grown their automation with SeleniumBase:
### Some organizations who have used SeleniumBase for automation:
* [MIT](https://web.mit.edu/)
* [iboss](https://www.iboss.com/)
@ -15,8 +15,8 @@
* [FortressIQ](https://www.fortressiq.com/)
* [Thoma Bravo](https://www.thomabravo.com/)
* [ASICS Digital](https://www.asicsdigital.com/)
* [Expedia Group](https://lifeatexpediagroup.com/)
* [Texture Health](https://www.texturehealth.com/)
* [Expedia Group](https://lifeatexpediagroup.com/)
* [The Very Group](https://www.theverygroup.com/)
* [ActiveCampaign](https://www.activecampaign.com/)
* [Blue Trail Software](https://www.bluetrail.software/)
@ -28,14 +28,14 @@
* [Queen's University](https://www.queensu.ca/)
* [L1NNA Laboratory](https://l1nna.com/)
* [Thomson Reuters](https://www.thomsonreuters.com/)
* [Optum Financial](https://www.optum.com/financial-services.html)
* [CA Technologies](https://tinyurl.com/ca-technologies)
* [Optum Financial](https://www.optum.com/financial-services.html)
* [ActiveCampaign](https://www.activecampaign.com/)
* [Raid The Room](https://raidtheroom.com/)
* [First American](https://www.firstam.com/)
* [Origin Energy](https://www.originenergy.com.au/)
* [Develop Soft](https://www.developsoft.com/)
* [InterSystems](https://www.intersystems.com/)
* [Develop Soft](https://www.developsoft.com/)
* [Ping Identity](https://www.pingidentity.com/)
* [StreamSets](https://streamsets.com/)
* [Betterteem](https://www.betterteem.com/)
@ -49,15 +49,17 @@
* [Streamlit](https://streamlit.io/)
* [SunCorp](https://www.suncorpgroup.com.au/)
* [Logitech](https://www.logitech.com/)
* [Modulos](https://www.modulos.ai/)
* [VMware](https://www.vmware.com/)
* [Rakuten](https://global.rakuten.com/corp/about/)
* [Nagarro](https://www.nagarro.com/en)
* [Ark PES](https://www.arkpes.com/)
* [Evereve](https://evereve.com/)
* [Yandex](https://yandex.ru/)
* [WPILib](https://wpilib.org/)
* [QBurst](https://www.qburst.com/)
* [Yandex](https://yandex.ru/)
* [Kinetik](https://kinetik.care/)
* [Exadel](https://exadel.com/)
* [netLex](https://netlex.io/en/)
* [Alokin](https://alokin.in/)
* [Cubic](https://www.cubic.com/)

0
help_docs/hidden_files_info.md Executable file → Normal file
View File

0
help_docs/how_it_works.md Executable file → Normal file
View File

0
help_docs/html_inspector.md Executable file → Normal file
View File

0
help_docs/install.md Executable file → Normal file
View File

0
help_docs/install_python_pip_git.md Executable file → Normal file
View File

0
help_docs/js_package_manager.md Executable file → Normal file
View File

0
help_docs/locale_codes.md Executable file → Normal file
View File

0
help_docs/method_summary.md Executable file → Normal file
View File

0
help_docs/mobile_testing.md Executable file → Normal file
View File

0
help_docs/mysql_installation.md Executable file → Normal file
View File

0
help_docs/recorder_mode.md Executable file → Normal file
View File

0
help_docs/shadow_dom.md Executable file → Normal file
View File

9
help_docs/syntax_formats.md Executable file → Normal file
View File

@ -44,10 +44,11 @@
In this format, (which is used by most of the tests in the <a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples">SeleniumBase examples folder</a>), <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 for opening and closing web browsers at the start and end of tests.
To run a test of this format, use **``pytest``** or ``nosetests``. If you add: ``if __name__ == "__main__":`` ``pytest.main([__file__])`` to a file, you can also use ``python`` as a test runner, which invokes ``pytest``. Here's an example:
To run a test of this format, use **``pytest``** or ``nosetests``. Adding ``BaseCase.main(__name__, __file__)`` enables ``python`` to run ``pytest`` on your file indirectly. Here's an example:
```python
from seleniumbase import BaseCase
BaseCase.main(__name__, __file__)
class MyTestClass(BaseCase):
def test_demo_site(self):
@ -59,16 +60,10 @@ class MyTestClass(BaseCase):
self.click_link("SeleniumBase Demo Page")
self.assert_exact_text("Demo Page", "h1")
self.assert_no_js_errors()
if __name__ == "__main__":
from pytest import main
main([__file__, "-s"])
```
(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.)
Starting with ``seleniumbase`` ``4.11.0``, you can also include ``BaseCase.main(__name__, __file__)`` in your script to invoke ``pytest`` via ``python``. (Eg. [coffee_cart_tests.py](https://github.com/seleniumbase/SeleniumBase/blob/master/examples/coffee_cart_tests.py))
Using ``BaseCase`` inheritance is a great starting point for anyone learning SeleniumBase, and it follows good object-oriented programming principles.
<a id="sb_sf_02"></a>

0
help_docs/thank_you.md Executable file → Normal file
View File

0
help_docs/translations.md Executable file → Normal file
View File

0
help_docs/useful_grep_commands.md Executable file → Normal file
View File

0
help_docs/using_safari_driver.md Executable file → Normal file
View File

0
help_docs/verify_webdriver.md Executable file → Normal file
View File

0
help_docs/virtualenv_instructions.md Executable file → Normal file
View File

0
help_docs/webdriver_installation.md Executable file → Normal file
View File