Skip to content

Commit 8aa6106

Browse files
author
David Haeffner
committed
Updated runner documentation to link to capabilities docs, and include information about suite level parallel configuration
1 parent 17be44b commit 8aa6106

File tree

1 file changed

+26
-6
lines changed

1 file changed

+26
-6
lines changed

docs/introduction/command-line-runner.md

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ title: Command-line Runner
44
sidebar_label: Command-line Runner
55
---
66

7-
You can now run your tests cross-browser, in parallel, and on a Grid without needing to write any code.
7+
You can now run all of your Selenium IDE tests on any browser, in parallel, and on a Grid without needing to write any code.
88

9-
It's a simple matter of installing the Selenium IDE command line runner and launching it from a command prompt.
9+
There's just the small matter of installing the Selenium IDE command line runner, getting the necessary browser drivers (if running your tests locally), and launching the runner from a command prompt with the options you want.
1010

1111
![command-line-runner-sample](/selenium-ide/img/docs/runner.png)
1212

@@ -37,10 +37,12 @@ Once everything's installed, running your tests is a simple matter of calling `s
3737

3838
_NOTE: If you have multiple `.side` files you can use a wildcard (e.g., `/path/to/*.side`)._
3939

40-
When you run this command it will launch your tests in parallel, launching multiple browser windows spread across `n` processes (where `n` is the number of available cores on your machine).
40+
When you run this command it will launch your tests in parallel, in multiple browser windows, spread across `n` processes (where `n` is the number of available cores on your machine).
4141

4242
The number of processes is configurable (amongst other things) at run time through various arguments you can provide.
4343

44+
__NOTE: Parallel execution happens automically at the suite level. If you want the tests within a suite to be executed in parallel there is a setting you'll need to change. See [Test Parallelization In A Suite](command-line-runner.md#test-parallelization-in-a-suite) for details.__
45+
4446
## Run-time configuration
4547

4648
With the runner you have the ability to pass in different configuration arguments at run time.
@@ -53,7 +55,7 @@ The most common example of this is specifying a different browser for local test
5355
selenium-side-runner -c "browserName=firefox"
5456
```
5557

56-
__NOTE: For Firefox to work you'll need to download Mozilla's `geckodriver` and add it to your path (just like with ChromeDriver). For details, see <a href="https://firefox-source-docs.mozilla.org/testing/geckodriver/geckodriver/Usage.html" target="_blank" rel="noopener noreferrer">the `geckodriver` project page</a>.__
58+
__NOTE: For Firefox to work you'll need to download Mozilla's `geckodriver`. This can easily be installed through `npm` (e.g., `npm install geckodriver`). Or you can download the binary yourself and add it to your sytem path. For details, see <a href="https://firefox-source-docs.mozilla.org/testing/geckodriver/geckodriver/Usage.html" target="_blank" rel="noopener noreferrer">the `geckodriver` project page</a>.__
5759

5860
### Running on a remote WebDriver server
5961

@@ -63,6 +65,8 @@ To run your tests on a Grid (e.g., your own Grid or on a hosted provider like Sa
6365
selenium-side-runner --server http://localhost:4444/wd/hub -c "browser=chrome platform=MAC"
6466
```
6567

68+
You can see a full list of the available capabilities [here](https://github.com/SeleniumHQ/selenium/wiki/DesiredCapabilities).
69+
6670
### Specify the number of parallel processes
6771

6872
When running on a Grid you will likely want to control how many parallel sessions you are running. For that you can use the `-w n` command flag (where `n` is the number of processes you want).
@@ -98,6 +102,7 @@ With the ability to specify a different base URL you can easily point your tests
98102
```sh
99103
selenium-side-runner --base-url https://localhost
100104
```
105+
101106
### Filter tests
102107

103108
You also have the option to run a targeted subset of your tests with the `--filter target` command flag (where `target` is a regular expression value). Test names that contain the given search criteria will be the only ones run.
@@ -127,14 +132,29 @@ If you want to ignore the file and use command line arguments instead, use `--no
127132

128133
#### Option 2
129134

130-
As an alternative to the `.side.yml` file, you can specify your run-time parameters in a YAML file with a name and location of your choosing and specify its location when running your tests.
135+
Alternative to using a `.side.yml` file, you can specify your run-time parameters in a YAML file with a name and location of your choosing, and then specify its location when running your tests.
131136

132137
```sh
133138
selenium-side-runner --config-file "/path/to/your/config.yaml"
134139
```
135140

136-
When using the `--config-file` flag, the `.side.yml` will be ignored.
141+
__NOTE: When using the `--config-file` flag, the `.side.yml` will be ignored.__
142+
143+
## Selenium IDE Configuration
144+
145+
### Test Parallelization In A Suite
146+
147+
Out of the box, the runner executes suites in parallel, but tests within a suite are executed sequentially.
148+
149+
To run tests in a given suite in parallel, you'll need to update the settings for that suite in Selenium IDE.
150+
151+
1. Switch to the `Test Suites` view in Selenium IDE
152+
2. Click the drop-down menu next to the name of the suite you'd like to configure and click `Settings`
153+
3. Click the checkbox for `Run in parallel`
154+
4. Click `Submit`
155+
5. Save your Selenium IDE project file
137156

157+
To configure more than one suite to run this way, repeat steps 1-4 in each suite. Be sure to save the project file once you're done.
138158

139159
## Advanced Options
140160

0 commit comments

Comments
 (0)