|
1 | 1 | [](https://stand-with-ukraine.pp.ua) |
2 | 2 |
|
3 | 3 | [<img src="https://img.shields.io/badge/slack-@codeceptjs-purple.svg?logo=slack">](https://join.slack.com/t/codeceptjs/shared_invite/enQtMzA5OTM4NDM2MzA4LWE4MThhN2NmYTgxNTU5MTc4YzAyYWMwY2JkMmZlYWI5MWQ2MDM5MmRmYzZmYmNiNmY5NTAzM2EwMGIwOTNhOGQ) [<img src="https://img.shields.io/badge/discourse-codeceptjs-purple">](https://codecept.discourse.group) [![NPM version][npm-image]][npm-url] [<img src="https://img.shields.io/badge/dockerhub-images-blue.svg?logo=codeceptjs">](https://hub.docker.com/r/codeceptjs/codeceptjs) |
4 | | -[](https://github.com/codeceptjs/CodeceptJS/edit/3.x/docs/ai.md) [](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md) |
| 4 | +[](https://github.com/codeceptjs/CodeceptJS/edit/3.x/docs/ai.md) [](https://github.com/codeceptjs/CodeceptJS/blob/main/docs/mcp.md) [](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md) |
5 | 5 |
|
6 | 6 | ## Build Status |
7 | 7 |
|
@@ -233,48 +233,60 @@ Scenario('test title', () => { |
233 | 233 | }) |
234 | 234 | ``` |
235 | 235 |
|
236 | | -## HTML Reporter |
| 236 | +## HTML Reports |
237 | 237 |
|
238 | | -CodeceptJS includes a powerful built-in HTML Reporter that generates comprehensive, interactive test reports with detailed information about your test runs. The HTML reporter is **enabled by default** for all new projects and provides: |
| 238 | +Generate beautiful HTML reports using **[@testomatio/reporter](https://github.com/testomatio/reporter)** package. |
239 | 239 |
|
240 | | -### Features |
241 | | - |
242 | | -- **Interactive Dashboard**: Visual statistics, pie charts, and expandable test details |
243 | | -- **Step-by-Step Execution**: Shows individual test steps with timing and status indicators |
244 | | -- **BDD/Gherkin Support**: Full support for feature files with proper scenario formatting |
245 | | -- **System Information**: Comprehensive environment details including browser versions |
246 | | -- **Advanced Filtering**: Real-time filtering by status, tags, features, and test types |
247 | | -- **History Tracking**: Multi-run history with trend visualization |
248 | | -- **Error Details**: Clean formatting of error messages and stack traces |
249 | | -- **Artifacts Support**: Display screenshots and other test artifacts |
| 240 | +### Installation |
250 | 241 |
|
251 | | -### Visual Examples |
| 242 | +```sh |
| 243 | +npm install @testomatio/reporter --save-dev |
| 244 | +``` |
252 | 245 |
|
253 | | -#### Interactive Test Dashboard |
| 246 | +### Configuration |
254 | 247 |
|
255 | | -The main dashboard provides a complete overview with interactive statistics and pie charts: |
| 248 | +Add the `testomatio` plugin to your `codecept.conf.js`: |
256 | 249 |
|
257 | | - |
| 250 | +```js |
| 251 | +plugins: { |
| 252 | + testomatio: { |
| 253 | + enabled: true, |
| 254 | + require: '@testomatio/reporter/lib/adapter/codecept', |
| 255 | + }, |
| 256 | +} |
| 257 | +``` |
258 | 258 |
|
259 | | -#### Detailed Test Results |
| 259 | +### Usage |
260 | 260 |
|
261 | | -Each test shows comprehensive execution details with expandable step information: |
| 261 | +Generate HTML reports by setting the `TESTOMATIO_HTML_REPORT_SAVE` environment variable: |
262 | 262 |
|
263 | | - |
| 263 | +```sh |
| 264 | +TESTOMATIO_HTML_REPORT_SAVE=1 npx codeceptjs run |
| 265 | +``` |
264 | 266 |
|
265 | | -#### Advanced Filtering Capabilities |
| 267 | +The report will be saved to `html-report/testomatio-report.html`. |
266 | 268 |
|
267 | | -Real-time filtering allows quick navigation through test results: |
| 269 | +### Features |
268 | 270 |
|
269 | | - |
| 271 | +- Modern, responsive interface with real-time statistics |
| 272 | +- Detailed test information with step-by-step breakdown |
| 273 | +- Screenshots, videos, and artifacts display |
| 274 | +- BDD/Gherkin support with proper scenario formatting |
| 275 | +- Customizable output location and filename |
| 276 | +- Optional integration with [Testomat.io](https://testomat.io) cloud |
270 | 277 |
|
271 | | -#### BDD/Gherkin Support |
| 278 | +### Customization |
272 | 279 |
|
273 | | -Full support for Gherkin scenarios with proper feature formatting: |
| 280 | +```sh |
| 281 | +# Custom output folder |
| 282 | +TESTOMATIO_HTML_REPORT_SAVE=1 TESTOMATIO_HTML_REPORT_FOLDER=./reports npx codeceptjs run |
274 | 283 |
|
275 | | - |
| 284 | +# Custom filename |
| 285 | +TESTOMATIO_HTML_REPORT_SAVE=1 TESTOMATIO_HTML_FILENAME=my-report.html npx codeceptjs run |
276 | 286 |
|
277 | | -The HTML reporter generates self-contained reports that can be easily shared with your team. Learn more about configuration and features in the [HTML Reporter documentation](https://codecept.io/plugins/#htmlreporter). |
| 287 | +# Integrate with Testomat.io cloud |
| 288 | +TESTOMATIO_HTML_REPORT_SAVE=1 TESTOMATIO=your_api_key npx codeceptjs run |
| 289 | +``` |
278 | 290 |
|
279 | 291 | ## PageObjects |
280 | 292 |
|
|
0 commit comments