Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

move cloud service documentation to the options page #3909

Merged
merged 2 commits into from
May 1, 2019
Merged

move cloud service documentation to the options page #3909

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c8ab356
move cloud service documentation to the options page
christian-bromann May 1, 2019
4012aa7
add minor note
christian-bromann May 1, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
34 changes: 33 additions & 1 deletion docs/Options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,11 +197,43 @@ reporters: [
```

### execArgv
Node arguments to specify when launching child processes
Node arguments to specify when launching child processes.

Type: `String[]`
Default: `null`

### user
Your cloud service username (only works for [Sauce Labs](https://saucelabs.com/), [Browserstack](https://www.browserstack.com/) or [TestingBot](https://testingbot.com/) accounts). If set, WebdriverIO will automatically set connection options for you.

Type: `String`
Default: `null`

### key
Your cloud service access key or secret key (only works for [Sauce Labs](https://saucelabs.com/), [Browserstack](https://www.browserstack.com/) or [TestingBot](https://testingbot.com/) accounts). If set, WebdriverIO will automatically set connection options for you.

Type: `String`
Default: `null`

### region
If running on Saue Labs you can choose to run tests between different datacenters: US or EU. To change your region to EU add `region: 'eu'` to your config.

__Note:__ This only has an effect if you provide `user` and `key` options that are connected to your Sauce Labs account.

Type: `String`<br>
Default: `us`

*(only for vm and or em/simulators)*

### headless
Sauce Labs provides an [headless offering](https://saucelabs.com/products/web-testing/sauce-headless-testing) that allows you to run Chrome and Firefox tests headless.

__Note:__ This only has an effect if you provide `user` and `key` options that are connected to your Sauce Labs account.

Type: `Boolean`<br>
Default: `false`

*(only for vm and or em/simulators)*

## Hooks

WebdriverIO allows you to set hooks to interfere into the test lifecycle in order to e.g. take screenshot if a test fails. Every hook has as parameter specific information about the lifecycle (e.g. information about the test suite or test). The following hooks are available: `onPrepare`, `beforeSession`, `before`, `beforeSuite`, `beforeHook`, `afterHook`, `beforeTest`, `beforeCommand`, `afterCommand`, `afterTest`, `afterSuite`, `after`, `afterSession`, `onComplete`, `onReload`, `beforeFeature`, `beforeScenario`, `beforeStep`, `afterStep`, `afterScenario`, `afterFeature`.
Expand Down
24 changes: 1 addition & 23 deletions packages/wdio-sauce-service/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,21 +60,7 @@ capabilities = [
]
```

## Options

### user
Your Sauce Labs username.

Type: `String`

*(only for vm and or em/simulators)*

### key
Your Sauce Labs access key.

Type: `String`

*(only for vm and or em/simulators)*
## Sauce Service Options

### sauceConnect
If true it runs Sauce Connect and opens a secure connection between a Sauce Labs virtual machine running your browser tests.
Expand All @@ -84,14 +70,6 @@ Default: `false`

*(only for vm and or em/simulators)*

### region
Currently there is 2 Sauce Labs regions to choose: US and EU. To change your region to EU add `region:'eu'` to Sauce Labs config.

Type: `String`<br>
Default: `us`

*(only for vm and or em/simulators)*

### sauceConnectOpts
Apply Sauce Connect options (e.g. to change port number or logFile settings). See [this list](https://github.com/bermi/sauce-connect-launcher#advanced-usage) for more information.

Expand Down