@telefonica/acceptance-testing 2.16.0 → 2.18.0
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.
- package/README.md +30 -1
- package/dist/acceptance-testing.cjs.development.js +765 -1305
- package/dist/acceptance-testing.cjs.development.js.map +1 -1
- package/dist/acceptance-testing.cjs.production.min.js +1 -1
- package/dist/acceptance-testing.cjs.production.min.js.map +1 -1
- package/dist/acceptance-testing.esm.js +765 -1306
- package/dist/acceptance-testing.esm.js.map +1 -1
- package/dist/index.d.ts +1 -0
- package/jest-puppeteer-config.js +10 -6
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -51,7 +51,36 @@ If you want to autostart a server before running the acceptance tests, you can c
|
|
|
51
51
|
}
|
|
52
52
|
```
|
|
53
53
|
|
|
54
|
-
|
|
54
|
+
Additionally, you can include path and protocol parameters, that will be used to check if the server is ready:
|
|
55
|
+
```json
|
|
56
|
+
{
|
|
57
|
+
"acceptanceTests": {
|
|
58
|
+
"ciServer": {
|
|
59
|
+
"command": "yarn dev",
|
|
60
|
+
"port": 3000,
|
|
61
|
+
"path": "api/health",
|
|
62
|
+
"protocol": "https"
|
|
63
|
+
}
|
|
64
|
+
}
|
|
65
|
+
}
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
#### `protocol`
|
|
69
|
+
|
|
70
|
+
Type: `string`, (`https`, `http`, `tcp`, `socket`) defaults to `tcp` or `http` if `path` is set.
|
|
71
|
+
|
|
72
|
+
To wait for an HTTP or TCP endpoint before considering the server running, include `http` or `tcp` as a protocol.
|
|
73
|
+
Must be used in conjunction with `port`.
|
|
74
|
+
|
|
75
|
+
|
|
76
|
+
#### `path`
|
|
77
|
+
|
|
78
|
+
Type: `string`, default to `null`.
|
|
79
|
+
|
|
80
|
+
Path to resource to wait for activity on before considering the server running.
|
|
81
|
+
Must be used in conjunction with `host` and `port`.
|
|
82
|
+
|
|
83
|
+
### 4. Setup your CI to run using the [web-builder docker image](https://github.com/Telefonica/js-toolbox/tree/master/packages/acceptance-testing/docker/web-builder)
|
|
55
84
|
|
|
56
85
|
Github actions example:
|
|
57
86
|
|