@wdio/sauce-service 9.12.0 → 9.12.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +7 -5
  2. package/package.json +6 -6
package/README.md CHANGED
@@ -30,7 +30,7 @@ Instructions on how to install `WebdriverIO` can be found [here.](https://webdri
30
30
 
31
31
  To use the service for the Virtual Desktop/Emulator/Simulator Machine and Real Device cloud you need to set `user` and `key` in your `wdio.conf.js` file. It will automatically use Sauce Labs to run your integration tests. If you run your tests on Sauce Labs you can specify the region you want to run your tests in via the `region` property. Available short handles for regions are `us` (default) and `eu`. These regions are used for the Sauce Labs VM cloud and the Sauce Labs Real Device Cloud. If you don't provide the region, it defaults to `us`.
32
32
 
33
- If you want WebdriverIO to automatically spin up a [Sauce Connect](https://wiki.saucelabs.com/display/DOCS/Sauce+Connect+Proxy) tunnel, you need to set `sauceConnect: true`. If you would like to change the data center to EU add `region:'eu'` as US data center is set as default.
33
+ If you want WebdriverIO to automatically spin up a [Sauce Connect](https://docs.saucelabs.com/secure-connections/#sauce-connect-proxy) tunnel, you need to set `sauceConnect: true`. If you would like to change the data center to EU add `region:'eu'` as US data center is set as default.
34
34
 
35
35
  ```js
36
36
  // wdio.conf.js
@@ -53,7 +53,6 @@ export const config = {
53
53
 
54
54
  If you want to use an existing Sauce Connect tunnel you only need to provide a `tunnelName`. If you are using a shared tunnel, and you are not the user who created the tunnel, you must identify the Sauce Labs user who did create the tunnel in order to use it for your test. Include the `tunnelOwner` in the capabilities like this:
55
55
 
56
-
57
56
  <Tabs
58
57
  defaultValue="tunnelname"
59
58
  values={[
@@ -70,7 +69,7 @@ export const config = {
70
69
  browserName: 'chrome',
71
70
  platformName: 'Windows 10',
72
71
  browserVersion: 'latest',
73
- // Sauce options can be found here https://wiki.saucelabs.com/display/DOCS/Test+Configuration+Options
72
+ // Sauce options can be found here https://docs.saucelabs.com/dev/test-configuration-options/
74
73
  'sauce:options': {
75
74
  tunnelName: 'YourTunnelName',
76
75
 
@@ -94,7 +93,7 @@ export const config = {
94
93
  browserName: 'chrome',
95
94
  platformName: 'Windows 10',
96
95
  browserVersion: 'latest',
97
- // Sauce options can be found here https://wiki.saucelabs.com/display/DOCS/Test+Configuration+Options
96
+ // Sauce options can be found here https://docs.saucelabs.com/dev/test-configuration-options/
98
97
  'sauce:options': {
99
98
  tunnelName: 'TunnelName',
100
99
  tunnelOwner: '<username of owner>,
@@ -111,25 +110,27 @@ export const config = {
111
110
 
112
111
  </TabItem>
113
112
  </Tabs>
114
- ```
115
113
 
116
114
  ## Sauce Service Options
117
115
 
118
116
  To authorize the Sauce Labs service your config needs to contain a [`user`](https://webdriver.io/docs/options#user) and [`key`](https://webdriver.io/docs/options#key) option.
119
117
 
120
118
  ### maxErrorStackLength
119
+
121
120
  This service will automatically push the error stack to Sauce Labs when a test fails. By default, it will only push the first 5 lines, but if needed this can be changed. Be aware that more lines will result in more WebDriver calls which might slow down the execution.
122
121
 
123
122
  Type: `number`<br />
124
123
  Default: `5`
125
124
 
126
125
  ### sauceConnect
126
+
127
127
  If `true` it runs Sauce Connect and opens a secure connection between a Sauce Labs virtual machine running your browser tests.
128
128
 
129
129
  Type: `Boolean`<br />
130
130
  Default: `false`
131
131
 
132
132
  ### sauceConnectOpts
133
+
133
134
  Apply Sauce Connect options (e.g. to change port number or logFile settings). See [this list](https://docs.saucelabs.com/dev/cli/sauce-connect-5/run/) for more information.
134
135
 
135
136
  NOTE: When specifying the options the `--` should be omitted. It can also be turned into camelCase (e.g. `shared-tunnel` or `sharedTunnel`).
@@ -154,6 +155,7 @@ Default: `(config, capabilities, suiteTitle) => suiteTitle`
154
155
  ----
155
156
 
156
157
  ## Overriding generated name metadata
158
+
157
159
  The service automatically generates a name for each test from the suite name, browser name and other information.
158
160
 
159
161
  You can override this by providing a value for the `name` desired capability, but this will have the side effect of giving all tests the same name.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wdio/sauce-service",
3
- "version": "9.12.0",
3
+ "version": "9.12.2",
4
4
  "description": "WebdriverIO service that provides a better integration into Sauce Labs",
5
5
  "author": "Christian Bromann <mail@bromann.dev>",
6
6
  "homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-sauce-service",
@@ -33,17 +33,17 @@
33
33
  "typeScriptVersion": "3.8.3",
34
34
  "dependencies": {
35
35
  "@wdio/logger": "9.4.4",
36
- "@wdio/types": "9.10.1",
37
- "@wdio/utils": "9.11.0",
36
+ "@wdio/types": "9.12.2",
37
+ "@wdio/utils": "9.12.2",
38
38
  "saucelabs": "^9.0.1",
39
- "webdriverio": "9.12.0"
39
+ "webdriverio": "9.12.2"
40
40
  },
41
41
  "devDependencies": {
42
42
  "@types/ip": "^1.1.0",
43
- "@wdio/globals": "9.12.0"
43
+ "@wdio/globals": "9.12.2"
44
44
  },
45
45
  "publishConfig": {
46
46
  "access": "public"
47
47
  },
48
- "gitHead": "7571cb5af89ba6119d6524001124162bb27fa8fc"
48
+ "gitHead": "dc30cc8863706e3522c78ebb75b0c4a44746aa5b"
49
49
  }