Skip to content

Commit 5bdcd05

Browse files
committed
Merge branch '4.x' of https://github.com/codeceptjs/CodeceptJS into bugfix/fix-workers
2 parents a1e579b + 27eea12 commit 5bdcd05

52 files changed

Lines changed: 3592 additions & 6536 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

README.md

Lines changed: 39 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[![Stand With Ukraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner-direct-single.svg)](https://stand-with-ukraine.pp.ua)
22

33
[<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-
[![AI features](https://img.shields.io/badge/AI-features?logo=openai&logoColor=white)](https://github.com/codeceptjs/CodeceptJS/edit/3.x/docs/ai.md) [![StandWithUkraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md)
4+
[![AI features](https://img.shields.io/badge/AI-features?logo=openai&logoColor=white)](https://github.com/codeceptjs/CodeceptJS/edit/3.x/docs/ai.md) [![MCP Server](https://img.shields.io/badge/MCP-server?logo=anthropic&logoColor=white)](https://github.com/codeceptjs/CodeceptJS/blob/main/docs/mcp.md) [![StandWithUkraine](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/badges/StandWithUkraine.svg)](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md)
55

66
## Build Status
77

@@ -233,48 +233,60 @@ Scenario('test title', () => {
233233
})
234234
```
235235

236-
## HTML Reporter
236+
## HTML Reports
237237

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.
239239

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
250241

251-
### Visual Examples
242+
```sh
243+
npm install @testomatio/reporter --save-dev
244+
```
252245

253-
#### Interactive Test Dashboard
246+
### Configuration
254247

255-
The main dashboard provides a complete overview with interactive statistics and pie charts:
248+
Add the `testomatio` plugin to your `codecept.conf.js`:
256249

257-
![HTML Reporter Dashboard](docs/shared/html-reporter-main-dashboard.png)
250+
```js
251+
plugins: {
252+
testomatio: {
253+
enabled: true,
254+
require: '@testomatio/reporter/lib/adapter/codecept',
255+
},
256+
}
257+
```
258258

259-
#### Detailed Test Results
259+
### Usage
260260

261-
Each test shows comprehensive execution details with expandable step information:
261+
Generate HTML reports by setting the `TESTOMATIO_HTML_REPORT_SAVE` environment variable:
262262

263-
![HTML Reporter Test Details](docs/shared/html-reporter-test-details.png)
263+
```sh
264+
TESTOMATIO_HTML_REPORT_SAVE=1 npx codeceptjs run
265+
```
264266

265-
#### Advanced Filtering Capabilities
267+
The report will be saved to `html-report/testomatio-report.html`.
266268

267-
Real-time filtering allows quick navigation through test results:
269+
### Features
268270

269-
![HTML Reporter Filtering](docs/shared/html-reporter-filtering.png)
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
270277

271-
#### BDD/Gherkin Support
278+
### Customization
272279

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
274283

275-
![HTML Reporter BDD Details](docs/shared/html-reporter-bdd-details.png)
284+
# Custom filename
285+
TESTOMATIO_HTML_REPORT_SAVE=1 TESTOMATIO_HTML_FILENAME=my-report.html npx codeceptjs run
276286

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+
```
278290

279291
## PageObjects
280292

0 commit comments

Comments
 (0)