You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/plugins.md
+27-27
Original file line number
Diff line number
Diff line change
@@ -650,11 +650,9 @@ Scenario Outline: ...
650
650
651
651
## heal
652
652
653
-
Self-healing tests with OpenAI.
653
+
Self-healing tests with AI.
654
654
655
-
This plugin is experimental and requires OpenAI API key.
656
-
657
-
To use it you need to set OPENAI_API_KEY env variable and enable plugin inside the config.
655
+
Read more about heaking in [Self-Healing Tests][10]
658
656
659
657
```js
660
658
plugins: {
@@ -674,7 +672,7 @@ More config options are available:
674
672
675
673
## pauseOnFail
676
674
677
-
Automatically launches [interactive pause][10] when a test fails.
675
+
Automatically launches [interactive pause][11] when a test fails.
678
676
679
677
Useful for debugging flaky tests on local environment.
680
678
Add this plugin to config file:
@@ -857,14 +855,14 @@ Possible config options:
857
855
858
856
## selenoid
859
857
860
-
[Selenoid][11] plugin automatically starts browsers and video recording.
858
+
[Selenoid][12] plugin automatically starts browsers and video recording.
861
859
Works with WebDriver helper.
862
860
863
861
### Prerequisite
864
862
865
863
This plugin **requires Docker** to be installed.
866
864
867
-
> If you have issues starting Selenoid with this plugin consider using the official [Configuration Manager][12] tool from Selenoid
865
+
> If you have issues starting Selenoid with this plugin consider using the official [Configuration Manager][13] tool from Selenoid
868
866
869
867
### Usage
870
868
@@ -893,7 +891,7 @@ plugins: {
893
891
}
894
892
```
895
893
896
-
When `autoCreate` is enabled it will pull the [latest Selenoid from DockerHub][13] and start Selenoid automatically.
894
+
When `autoCreate` is enabled it will pull the [latest Selenoid from DockerHub][14] and start Selenoid automatically.
897
895
It will also create `browsers.json` file required by Selenoid.
898
896
899
897
In automatic mode the latest version of browser will be used for tests. It is recommended to specify exact version of each browser inside `browsers.json` file.
@@ -905,10 +903,10 @@ In automatic mode the latest version of browser will be used for tests. It is re
905
903
While this plugin can create containers for you for better control it is recommended to create and launch containers manually.
906
904
This is especially useful for Continous Integration server as you can configure scaling for Selenoid containers.
907
905
908
-
> Use [Selenoid Configuration Manager][12] to create and start containers semi-automatically.
906
+
> Use [Selenoid Configuration Manager][13] to create and start containers semi-automatically.
909
907
910
908
1. Create `browsers.json` file in the same directory `codecept.conf.js` is located
911
-
[Refer to Selenoid documentation][14] to know more about browsers.json.
909
+
[Refer to Selenoid documentation][15] to know more about browsers.json.
912
910
913
911
_Sample browsers.json_
914
912
@@ -933,7 +931,7 @@ _Sample browsers.json_
933
931
934
932
2. Create Selenoid container
935
933
936
-
Run the following command to create a container. To know more [refer here][15]
934
+
Run the following command to create a container. To know more [refer here][16]
937
935
938
936
```bash
939
937
docker create \
@@ -966,15 +964,15 @@ When `allure` plugin is enabled a video is attached to report automatically.
966
964
| enableVideo | Enable video recording and use `video` folder of output (default: false) |
967
965
| enableLog | Enable log recording and use `logs` folder of output (default: false) |
968
966
| deletePassed | Delete video and logs of passed tests (default : true) |
969
-
| additionalParams | example: `additionalParams:'--env TEST=test'` [Refer here][16] to know more |
967
+
| additionalParams | example: `additionalParams:'--env TEST=test'` [Refer here][17] to know more |
970
968
971
969
### Parameters
972
970
973
971
- `config`
974
972
975
973
## stepByStepReport
976
974
977
-
![step-by-step-report][17]
975
+
![step-by-step-report][18]
978
976
979
977
Generates step by step report for a test.
980
978
After each step in a test a screenshot is created. After test executed screenshots are combined into slideshow.
@@ -1155,7 +1153,7 @@ This plugin allows to run webdriverio services like:
1155
1153
- browserstack
1156
1154
- appium
1157
1155
1158
-
A complete list of all available services can be found on [webdriverio website][18].
1156
+
A complete list of all available services can be found on [webdriverio website][19].
1159
1157
1160
1158
#### Setup
1161
1159
@@ -1167,7 +1165,7 @@ See examples below:
1167
1165
1168
1166
#### Selenium Standalone Service
1169
1167
1170
-
Install `@wdio/selenium-standalone-service` package, as [described here][19].
1168
+
Install `@wdio/selenium-standalone-service` package, as [described here][20].
1171
1169
It is important to make sure it is compatible with current webdriverio version.
1172
1170
1173
1171
Enable `wdio` plugin in plugins list and add `selenium-standalone` service:
@@ -1184,7 +1182,7 @@ plugins: {
1184
1182
1185
1183
#### Sauce Service
1186
1184
1187
-
Install `@wdio/sauce-service` package, as [described here][20].
1185
+
Install `@wdio/sauce-service` package, as [described here][21].
1188
1186
It is important to make sure it is compatible with current webdriverio version.
1189
1187
1190
1188
Enable `wdio` plugin in plugins list and add `sauce` service:
@@ -1232,24 +1230,26 @@ In the same manner additional services from webdriverio can be installed, enable
0 commit comments