Skip to content

Commit dcae21d

Browse files
mdmintzmdmintz
committed
Update the docs
1 parent a5d90ce commit dcae21d

File tree

5 files changed

+32
-32
lines changed

5 files changed

+32
-32
lines changed

‎docs/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,5 +21,5 @@ mkdocs==1.2.2;python_version>="3.6"
2121
mkdocs-material==7.1.3;python_version>="3.6"
2222
mkdocs-exclude-search==0.5.2;python_version>="3.6"
2323
mkdocs-simple-hooks==0.1.3
24-
mkdocs-material-extensions==1.0.1;python_version>="3.6"
24+
mkdocs-material-extensions==1.0.3;python_version>="3.6"
2525
mkdocs-minify-plugin==0.4.0

‎examples/capabilities/ReadMe.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,15 @@
1-
### <img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="30" /> Using Desired Capabilities
1+
### <img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="28" /> Using Desired Capabilities
22

33
You can specify browser desired capabilities for webdriver when running SeleniumBase tests on a remote SeleniumGrid server such as [BrowserStack](https://www.browserstack.com/automate/capabilities), [Sauce Labs](https://wiki.saucelabs.com/display/DOCS/Platform+Configurator#/), or [TestingBot](https://testingbot.com/support/other/test-options).
44

55
Sample run commands may look like this when run from the [SeleniumBase/examples/](https://github.com/seleniumbase/SeleniumBase/tree/master/examples) folder: (The browser is now specified in the capabilities file.)
66

77
```bash
8-
pytest my_first_test.py --browser=remote --server=USERNAME:KEY@hub.browserstack.com --port=80 --cap_file=capabilities/sample_cap_file_BS.py
8+
pytest test_demo_site.py --browser=remote --server=USERNAME:KEY@hub.browserstack.com --port=80 --cap_file=capabilities/sample_cap_file_BS.py
99
```
1010

1111
```bash
12-
pytest my_first_test.py --browser=remote --server=USERNAME:KEY@ondemand.saucelabs.com --port=80 --cap_file=capabilities/sample_cap_file_SL.py
12+
pytest test_demo_site.py --browser=remote --server=USERNAME:KEY@ondemand.us-east-1.saucelabs.com --port=443 --protocol=https --cap_file=capabilities/sample_cap_file_SL.py
1313
```
1414

1515
(Parameters: ``--browser=remote``, ``--server=SERVER``, ``--port=PORT``, and ``--cap_file=CAP_FILE.py``)

‎help_docs/customizing_test_runs.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -344,39 +344,39 @@ SeleniumBase lets you run tests on remote Selenium Grids such as [BrowserStack](
344344
Here's how to connect to a BrowserStack Selenium Grid server for running tests:
345345

346346
```bash
347-
pytest my_first_test.py --server=USERNAME:KEY@hub.browserstack.com --port=80
347+
pytest test_demo_site.py --server=USERNAME:KEY@hub.browserstack.com --port=80
348348
```
349349

350350
Here's how to connect to a Sauce Labs Selenium Grid server for running tests:
351351

352352
```bash
353-
pytest my_first_test.py --server=USERNAME:KEY@ondemand.saucelabs.com --port=80
353+
pytest test_demo_site.py --server=USERNAME:KEY@ondemand.us-east-1.saucelabs.com --port=443 --protocol=https
354354
```
355355

356356
Here's how to connect to a TestingBot Selenium Grid server for running tests:
357357

358358
```bash
359-
pytest my_first_test.py --server=USERNAME:KEY@hub.testingbot.com --port=80
359+
pytest test_demo_site.py --server=USERNAME:KEY@hub.testingbot.com --port=80
360360
```
361361

362362
Here's how to connect to a CrossBrowserTesting Selenium Grid server for running tests:
363363

364364
```bash
365-
pytest my_first_test.py --server=USERNAME:KEY@hub.crossbrowsertesting.com --port=80
365+
pytest test_demo_site.py --server=USERNAME:KEY@hub.crossbrowsertesting.com --port=80
366366
```
367367

368368
Here's how to connect to a LambdaTest Selenium Grid server for running tests:
369369

370370
```bash
371-
pytest my_first_test.py --server=USERNAME:KEY@hub.lambdatest.com --port=80
371+
pytest test_demo_site.py --server=USERNAME:KEY@hub.lambdatest.com --port=80
372372
```
373373

374374
Or you can create your own Selenium Grid for test distribution. ([See this ReadMe for details](https://github.com/seleniumbase/SeleniumBase/blob/master/seleniumbase/utilities/selenium_grid/ReadMe.md))
375375

376376
To use a server on the ``https`` protocol, add ``--protocol=https``:
377377

378378
```bash
379-
pytest test_suite.py --protocol=https --server=IP_ADDRESS --port=PORT
379+
pytest test_demo_site.py --protocol=https --server=IP_ADDRESS --port=PORT
380380
```
381381

382382
--------

‎help_docs/method_summary.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -200,16 +200,15 @@ self.switch_to_default_window()
200200
self.switch_to_newest_window()
201201

202202
self.get_new_driver(
203-
browser=None, headless=None, locale_code=None,
204-
servername=None, port=None, proxy=None, agent=None,
205-
switch_to=True, cap_file=None, cap_string=None,
206-
disable_csp=None, enable_ws=None, enable_sync=None,
207-
use_auto_ext=None, no_sandbox=None, disable_gpu=None,
208-
incognito=None, guest_mode=None,
209-
devtools=None, remote_debug=None,
210-
swiftshader=None, block_images=None, user_data_dir=None,
211-
extension_zip=None, extension_dir=None, is_mobile=None,
212-
d_width=None, d_height=None, d_p_r=None)
203+
browser=None, headless=None, locale_code=None, protocol=None,
204+
servername=None, port=None, proxy=None, agent=None, switch_to=True,
205+
cap_file=None, cap_string=None, disable_csp=None, enable_ws=None,
206+
enable_sync=None, use_auto_ext=None, no_sandbox=None, disable_gpu=None,
207+
incognito=None, guest_mode=None, devtools=None, remote_debug=None,
208+
swiftshader=None, block_images=None,
209+
chromium_arg=None, firefox_arg=None, firefox_pref=None,
210+
user_data_dir=None, extension_zip=None, extension_dir=None,
211+
is_mobile=None, d_width=None, d_height=None, d_p_r=None)
213212

214213
self.switch_to_driver(driver)
215214

‎seleniumbase/utilities/selenium_grid/ReadMe.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
[<img src="https://seleniumbase.io/cdn/img/super_logo_sb.png" title="SeleniumBase" width="290">](https://github.com/seleniumbase/SeleniumBase/blob/master/README.md)
22

3-
<h2><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="30" /> The Selenium Grid Hub:</h2>
3+
<h2><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="28" /> The Selenium Grid Hub:</h2>
44

55
The Selenium Grid Hub lets you distribute tests to run in parallel across multiple node machines. Each node machine can then run its own allocation of tests. This allows you to run a large suite of tests very quickly.
66

7-
<h3><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="30" /> Running the Selenium Grid Hub:</h3>
7+
<h3><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="28" /> Running the Selenium Grid Hub:</h3>
88

99
The following commands will work once you've installed seleniumbase.
1010

11-
<h4><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="30" /> Downloading the Selenium Server JAR file:</h4>
11+
<h4><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="28" /> Downloading the Selenium Server JAR file:</h4>
1212

1313
```bash
1414
seleniumbase download server
1515
```
1616

1717
* (Required for using your own Selenium Grid)
1818

19-
<h4><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="30" /> Grid Hub server controls:</h4>
19+
<h4><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="28" /> Grid Hub server controls:</h4>
2020

2121
```bash
2222
seleniumbase grid-hub {start|stop|restart} [OPTIONS]
@@ -28,7 +28,7 @@ seleniumbase grid-hub {start|stop|restart} [OPTIONS]
2828
<li> --timeout=TIMEOUT (Close idle browser after TIMEOUT sec.)</li>
2929
</ul>
3030

31-
<h4><img src="https://seleniumbase.io/img/sb_icon.png" title="SeleniumBase" width="30" /> Grid node server controls:</h4>
31+
<h4><img src="https://seleniumbase.io/img/logo6.png" title="SeleniumBase" width="28" /> Grid node server controls:</h4>
3232

3333
```bash
3434
seleniumbase grid-node {start|stop|restart} --hub=[HUB_IP] [OPTIONS]
@@ -45,45 +45,46 @@ When the Grid Hub Console is up and running, you'll be able to find it here: [ht
4545
Now you can run your tests on the Selenium Grid:
4646

4747
```bash
48-
pytest test_suite.py --server=IP_ADDRESS --port=4444
48+
pytest test_demo_site.py --server=IP_ADDRESS --port=4444
4949
```
5050

5151
You can also run your tests on someone else's Selenium Grid to avoid managing your own. Here are some Selenium Grids that you can use (and the run command format):
5252

5353
* [BrowserStack](https://www.browserstack.com/automate#) Selenium Grid:
5454

5555
```bash
56-
pytest my_first_test.py --server=USERNAME:KEY@hub.browserstack.com --port=80
56+
pytest test_demo_site.py --server=USERNAME:KEY@hub.browserstack.com --port=80
5757
```
5858

5959
* [Sauce Labs](https://saucelabs.com/products/open-source-frameworks/selenium) Selenium Grid:
6060

6161
```bash
62-
pytest my_first_test.py --server=USERNAME:KEY@ondemand.saucelabs.com --port=80
62+
pytest test_demo_site.py --server=USERNAME:KEY@ondemand.us-east-1.saucelabs.com --port=443 --protocol=https
6363
```
6464

6565
* [TestingBot](https://testingbot.com/features) Selenium Grid:
6666

6767
```bash
68-
pytest my_first_test.py --server=USERNAME:KEY@hub.testingbot.com --port=80
68+
pytest test_demo_site.py --server=USERNAME:KEY@hub.testingbot.com --port=80
6969
```
7070

7171
* [CrossBrowserTesting](https://help.crossbrowsertesting.com/selenium-testing/getting-started/python/) Selenium Grid:
7272

7373
```bash
74-
pytest my_first_test.py --server=USERNAME:KEY@hub.crossbrowsertesting.com --port=80
74+
pytest test_demo_site.py --server=USERNAME:KEY@hub.crossbrowsertesting.com --port=80
7575
```
7676

7777
* [LambdaTest](https://www.lambdatest.com/selenium-automation) Selenium Grid:
7878

7979
```bash
80-
pytest my_first_test.py --server=USERNAME:KEY@hub.lambdatest.com --port=80
80+
pytest test_demo_site.py --server=USERNAME:KEY@hub.lambdatest.com --port=80
8181
```
8282

8383
To use a server on the ``https`` protocol, add ``--protocol=https``:
84+
(<i>SeleniumBase 1.65.2 and newer uses ``https`` automatically for ``--port=443``.</i>)
8485

8586
```bash
86-
pytest test_suite.py --protocol=https --server=IP_ADDRESS --port=PORT
87+
pytest test_demo_site.py --protocol=https --server=IP_ADDRESS --port=PORT
8788
```
8889

8990
(For setting browser desired capabilities while running Selenium remotely, see the <a href="https://seleniumbase.io/help_docs/desired_capabilities/">desired capabilities documentation</a> and the sample files located in <a href="https://github.com/seleniumbase/SeleniumBase/tree/master/examples/capabilities">SeleniumBase/examples/capabilities</a>)

0 commit comments

Comments
 (0)