Skip to content

Commit ea61c9c

Browse files
mdmintzmdmintz
authored
Tidy up the docs
* Tidy up the docs
1 parent 9424062 commit ea61c9c

File tree

9 files changed

+49
-43
lines changed

9 files changed

+49
-43
lines changed

‎.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,6 +138,9 @@ mkdocs_build/*/*.md
138138
mkdocs_build/*/*/*.md
139139
mkdocs_build/*/*/*/*.md
140140

141+
# macOS system files
142+
.DS_Store
143+
141144
# Other
142145
selenium-server-standalone.jar
143146
proxy.zip
@@ -151,4 +154,3 @@ assets
151154
temp
152155
temp_*/
153156
node_modules
154-
.DS_Store

‎examples/capabilities/ReadMe.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
<h3><img src="https://seleniumbase.io/img/green_logo.png" title="SeleniumBase" width="32" /> Using Desired Capabilities</h3>
22

3-
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) or [LambdaTest] (https://www.lambdatest.com/capabilities-generator/) or [Sauce Labs](https://wiki.saucelabs.com/display/DOCS/Platform+Configurator#/).
3+
You can specify browser desired capabilities for webdriver when running SeleniumBase tests on a remote Selenium Grid server such as [BrowserStack](https://www.browserstack.com/automate/capabilities), [LambdaTest](https://www.lambdatest.com/capabilities-generator/), or [Sauce Labs](https://wiki.saucelabs.com/display/DOCS/Platform+Configurator#/).
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

@@ -26,16 +26,17 @@ desired_cap = {
2626
"browserstack.selenium_version": "3.141.59",
2727
}
2828
```
29+
2930
Here's an example desired capabilities file for LambdaTest:
3031

3132
```python
3233
capabilities = {
33-
"build" : "your build name",
34-
"name" : "your test name",
35-
"platform" : "Windows 11",
36-
"browserName" : "Chrome",
37-
"version" : "100.0"
38-
}
34+
"build" : "your build name",
35+
"name" : "your test name",
36+
"platform" : "Windows 11",
37+
"browserName" : "Chrome",
38+
"version" : "100.0",
39+
}
3940
```
4041

4142
Here's an example desired capabilities file for Sauce Labs:

‎help_docs/customizing_test_runs.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -347,7 +347,7 @@ Here's the command-line option to add to tests: (See [examples/custom_settings.p
347347

348348
<h3><img src="https://seleniumbase.io/img/green_logo.png" title="SeleniumBase" width="32" /> Running tests on a remote Selenium Grid:</h3>
349349

350-
SeleniumBase lets you run tests on remote Selenium Grids such as [BrowserStack](https://www.browserstack.com/automate#)'s Selenium Grid, [LambdaTest](https://www.lambdatest.com/selenium-automation)'s Selenium Grid,[Sauce Labs](https://saucelabs.com/products/open-source-frameworks/selenium)'s Selenium Grid, other Grids, and even your own Grid:
350+
SeleniumBase lets you run tests on remote Selenium Grids such as [BrowserStack](https://www.browserstack.com/automate#)'s Selenium Grid, [LambdaTest](https://www.lambdatest.com/selenium-automation)'s Selenium Grid, [Sauce Labs](https://saucelabs.com/products/open-source-frameworks/selenium)'s Selenium Grid, other Grids, and even your own Grid:
351351

352352
(For setting browser desired capabilities while running Selenium remotely, see the ReadMe located here: https://github.com/seleniumbase/SeleniumBase/tree/master/examples/capabilities)
353353

@@ -363,7 +363,7 @@ Here's how to connect to a Sauce Labs Selenium Grid server for running tests:
363363
pytest test_demo_site.py --server=USERNAME:KEY@ondemand.us-east-1.saucelabs.com --port=443 --protocol=https
364364
```
365365

366-
Here's how to connect to a Perfecto Mobile Selenium Grid server for running tests:
366+
Here's how to connect to a Perfecto Selenium Grid server for running tests:
367367

368368
```bash
369369
pytest test_demo_site.py --server=USERNAME:KEY@demo.perfectomobile.com/nexperience/perfectomobile --port=443
@@ -378,7 +378,7 @@ pytest test_demo_site.py --server=USERNAME:KEY@hub.testingbot.com --port=80
378378
Here's how to connect to a LambdaTest Selenium Grid server for running tests:
379379

380380
```bash
381-
pytest test_demo_site.py --server=USERNAME:KEY@hub.lambdatest.com/wd/hub --port=80
381+
pytest test_demo_site.py --server=USERNAME:KEY@hub.lambdatest.com --port=80
382382
```
383383

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

‎help_docs/desired_capabilities.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
<h3><img src="https://seleniumbase.io/img/green_logo.png" title="SeleniumBase" width="32" /> Using Desired Capabilities</h3>
22

3-
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) or [LambdaTest](https://www.lambdatest.com/selenium-automation) or [Sauce Labs](https://wiki.saucelabs.com/display/DOCS/Platform+Configurator#/).
3+
You can specify browser desired capabilities for webdriver when running SeleniumBase tests on a remote Selenium Grid server such as [BrowserStack](https://www.browserstack.com/automate/capabilities), [LambdaTest](https://www.lambdatest.com/selenium-automation), or [Sauce Labs](https://wiki.saucelabs.com/display/DOCS/Platform+Configurator#/).
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
88
pytest test_demo_site.py --browser=remote --server=USERNAME:KEY@hub.browserstack.com --port=80 --cap_file=capabilities/sample_cap_file_BS.py
99
```
10+
1011
```bash
11-
pytest test_demo_site.py --browser=remote --server=USERNAME:KEY@https://@hub.lambdatest.com/wd/hub --port=80 --protocol=https --cap_file=capabilities/sample_cap_file_LT.py
12+
pytest test_demo_site.py --browser=remote --server=USERNAME:KEY@https://@hub.lambdatest.com --port=80 --protocol=https --cap_file=capabilities/sample_cap_file_LT.py
1213
```
1314

1415
```bash
@@ -29,16 +30,17 @@ desired_cap = {
2930
"browserstack.selenium_version": "3.141.59",
3031
}
3132
```
33+
3234
Here's an example desired capabilities file for LambdaTest:
3335

3436
```python
3537
capabilities = {
36-
"build" : "your build name",
37-
"name" : "your test name",
38-
"platform" : "Windows 11",
39-
"browserName" : "Chrome",
40-
"version" : "100.0"
41-
}
38+
"build" : "your build name",
39+
"name" : "your test name",
40+
"platform" : "Windows 11",
41+
"browserName" : "Chrome",
42+
"version" : "100.0",
43+
}
4244
```
4345

4446
Here's an example desired capabilities file for Sauce Labs:
@@ -58,7 +60,7 @@ capabilities = {
5860

5961
<ul>
6062
<li><a href="https://www.browserstack.com/automate/capabilities">BrowserStack desired capabilities</a></li>
61-
<li><a href="https://www.lambdatest.com/capabilities-generator/">LambdaTest desired capabilities</a></li>
63+
<li><a href="https://www.lambdatest.com/capabilities-generator/">LambdaTest desired capabilities</a></li>
6264
<li><a href="https://wiki.saucelabs.com/display/DOCS/Platform+Configurator#/">Sauce Labs desired capabilities</a></li>
6365
</ul>
6466

‎integrations/google_cloud/ReadMe.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
### Building a browser-based test automation server on the [Google Cloud Platform](https://cloud.google.com/) by using [SeleniumBase](https://github.com/seleniumbase/SeleniumBase)
22

3-
(This tutorial, [from a previous Google Cloud Meetup](https://www.meetup.com/Boston-Google-Cloud-Meetup/events/230839686/?showDescription=true), will teach you how to setup a Linux server for running automated browser tests. The cost of running this server is about [$13.61/month on Google Cloud](https://console.cloud.google.com/launcher/details/bitnami-launchpad/jenkins) (enough to handle **5 parallel tests**). This is less expensive than using other platforms such as [BrowserStack](https://www.browserstack.com/pricing) ,[LambdaTest](https://www.lambdatest.com/pricing) or [Sauce Labs](https://saucelabs.com/pricing).)
3+
(This tutorial, [from a previous Google Cloud Meetup](https://www.meetup.com/Boston-Google-Cloud-Meetup/events/230839686/?showDescription=true), will teach you how to setup a Linux server for running automated browser tests. The cost of running this server is about [$13.61/month on Google Cloud](https://console.cloud.google.com/launcher/details/bitnami-launchpad/jenkins) (enough to handle **5 parallel tests**). This is less expensive than using other platforms such as [BrowserStack](https://www.browserstack.com/pricing), [LambdaTest](https://www.lambdatest.com/pricing), or [Sauce Labs](https://saucelabs.com/pricing).)
44

55
<!-- YouTube View --><a href="https://www.youtube.com/watch?v=n-sno20R9P0"><img src="https://seleniumbase.io/other/gcp_video_thumb.png" title="SeleniumBase on YouTube" width="285" /></a>
66
<!-- GitHub Only --><p>(<b><a href="https://www.youtube.com/watch?v=n-sno20R9P0">SeleniumBase Google Cloud Video</a></b>)</p>

‎seleniumbase/fixtures/base_case.py

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2862,8 +2862,8 @@ def get_new_driver(
28622862
raise Exception(
28632863
'Cannot use "remote" browser driver on localhost!'
28642864
" Did you mean to connect to a remote Grid server"
2865-
" such as BrowserStack ,LambdaTest or Sauce Labs? In that"
2866-
' case, you must specify the "server" and "port"'
2865+
" such as BrowserStack, LambdaTest, or Sauce Labs?"
2866+
' If so, you must specify the "server" and "port"'
28672867
" parameters on the command line! "
28682868
"Example: "
28692869
"--server=user:key@hub.browserstack.com --port=80"
@@ -2878,12 +2878,12 @@ def get_new_driver(
28782878
"Need to specify a desired capabilities file when "
28792879
'using "--browser=remote". Add "--cap_file=FILE". '
28802880
"File should be in the Python format used by: "
2881-
"%s OR "
2882-
"%s OR "
2881+
"%s, "
2882+
"%s, OR "
28832883
"%s "
2884-
"See SeleniumBase/examples/capabilities/sample_cap_file_BS.py "
2885-
"See SeleniumBase/examples/capabilities/sample_cap_file_LT.py "
2886-
"and SeleniumBase/examples/capabilities/sample_cap_file_SL.py"
2884+
"See SeleniumBase/examples/capabilities/sample_cap_file_BS.py,"
2885+
" SeleniumBase/examples/capabilities/sample_cap_file_LT.py,"
2886+
" and SeleniumBase/examples/capabilities/sample_cap_file_SL.py"
28872887
% (browserstack_ref, lambdatest_ref, sauce_labs_ref)
28882888
)
28892889
if browser is None:

‎seleniumbase/plugins/pytest_plugin.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -223,16 +223,16 @@ def pytest_addoption(parser):
223223
dest="cap_file",
224224
default=None,
225225
help="""The file that stores browser desired capabilities
226-
for BrowserStack, LambdaTest,Sauce Labs, and other
227-
remote web drivers to use.""",
226+
for BrowserStack, LambdaTest, Sauce Labs,
227+
and other remote web drivers to use.""",
228228
)
229229
parser.addoption(
230230
"--cap_string",
231231
"--cap-string",
232232
dest="cap_string",
233233
default=None,
234-
help="""The string that stores browser desired
235-
capabilities for BrowserStack, LambdaTest, Sauce Labs,
234+
help="""The string that stores browser desired capabilities
235+
for BrowserStack, LambdaTest, Sauce Labs,
236236
and other remote web drivers to use.
237237
Enclose cap-string in single quotes.
238238
Enclose parameter keys in double quotes.

‎seleniumbase/plugins/selenium_plugin.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,15 +99,16 @@ def options(self, parser, env):
9999
dest="cap_file",
100100
default=None,
101101
help="""The file that stores browser desired capabilities
102-
for BrowserStack ,LambdaTest or Sauce Labs web drivers.""",
102+
for BrowserStack, LambdaTest, Sauce Labs,
103+
and other remote web drivers to use.""",
103104
)
104105
parser.add_option(
105106
"--cap_string",
106107
"--cap-string",
107108
dest="cap_string",
108109
default=None,
109-
help="""The string that stores browser desired
110-
capabilities for BrowserStack, LambdaTest,Sauce Labs,
110+
help="""The string that stores browser desired capabilities
111+
for BrowserStack, LambdaTest, Sauce Labs,
111112
and other remote web drivers to use.
112113
Enclose cap-string in single quotes.
113114
Enclose parameter keys in double quotes.

‎seleniumbase/utilities/selenium_grid/ReadMe.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -56,16 +56,16 @@ You can also run your tests on someone else's Selenium Grid to avoid managing yo
5656
pytest test_demo_site.py --server=USERNAME:KEY@hub.browserstack.com --port=80
5757
```
5858

59-
* [LambdaTest](https://www.lambdatest.com/selenium-automation) Selenium Grid:
59+
* [Sauce Labs](https://saucelabs.com/products/open-source-frameworks/selenium) Selenium Grid:
6060

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

65-
* [Sauce Labs](https://saucelabs.com/products/open-source-frameworks/selenium) Selenium Grid:
65+
* [Perfecto](https://www.perfecto.io/integrations/selenium) Selenium Grid:
6666

6767
```bash
68-
pytest test_demo_site.py --server=USERNAME:KEY@ondemand.us-east-1.saucelabs.com --port=443 --protocol=https
68+
pytest test_demo_site.py --server=USERNAME:KEY@demo.perfectomobile.com/nexperience/perfectomobile --port=443
6969
```
7070

7171
* [TestingBot](https://testingbot.com/features) Selenium Grid:
@@ -74,16 +74,16 @@ pytest test_demo_site.py --server=USERNAME:KEY@ondemand.us-east-1.saucelabs.com
7474
pytest test_demo_site.py --server=USERNAME:KEY@hub.testingbot.com --port=80
7575
```
7676

77-
* [CrossBrowserTesting](https://help.crossbrowsertesting.com/selenium-testing/getting-started/python/) Selenium Grid:
77+
* [LambdaTest](https://www.lambdatest.com/selenium-automation) Selenium Grid:
7878

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

83-
* [LambdaTest](https://www.lambdatest.com/selenium-automation) Selenium Grid:
83+
* [CrossBrowserTesting](https://help.crossbrowsertesting.com/selenium-testing/getting-started/python/) Selenium Grid:
8484

8585
```bash
86-
pytest test_demo_site.py --server=USERNAME:KEY@hub.lambdatest.com --port=80
86+
pytest test_demo_site.py --server=USERNAME:KEY@hub.crossbrowsertesting.com --port=80
8787
```
8888

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

0 commit comments

Comments
 (0)