+ ${contributor.login} + +
](https://join.slack.com/t/codeceptjs/shared_invite/enQtMzA5OTM4NDM2MzA4LWE4MThhN2NmYTgxNTU5MTc4YzAyYWMwY2JkMmZlYWI5MWQ2MDM5MmRmYzZmYmNiNmY5NTAzM2EwMGIwOTNhOGQ) [
](https://codecept.discourse.group) [![NPM version][npm-image]][npm-url] [
](https://hub.docker.com/r/codeceptjs/codeceptjs)
-[](https://github.com/codeceptjs/CodeceptJS/edit/3.x/docs/ai.md) [](https://github.com/vshymanskyy/StandWithUkraine/blob/main/docs/README.md)
+[](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)
## Build Status
@@ -10,7 +10,6 @@
| 🌐 Web | Playwright | [](https://github.com/codeceptjs/CodeceptJS/actions/workflows/playwright.yml) |
| 🌐 Web | Puppeteer | [](https://github.com/codeceptjs/CodeceptJS/actions/workflows/puppeteer.yml) |
| 🌐 Web | WebDriver | [](https://github.com/codeceptjs/CodeceptJS/actions/workflows/webdriver.yml) |
-| 🌐 Web | TestCafe | [](https://github.com/codeceptjs/CodeceptJS/actions/workflows/testcafe.yml) |
| 📱 Mobile | Appium | [](https://github.com/codeceptjs/CodeceptJS/actions/workflows/appium_Android.yml) |
# CodeceptJS [](https://stand-with-ukraine.pp.ua)
@@ -43,7 +42,6 @@ CodeceptJS uses **Helper** modules to provide actions to `I` object. Currently,
- [**Playwright**](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/Playwright.md) - is a Node library to automate the Chromium, WebKit and Firefox browsers with a single API.
- [**Puppeteer**](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/Puppeteer.md) - uses Google Chrome's Puppeteer for fast headless testing.
- [**WebDriver**](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/WebDriver.md) - uses [webdriverio](http://webdriver.io/) to run tests via WebDriver or Devtools protocol.
-- [**TestCafe**](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/TestCafe.md) - cheap and fast cross-browser test automation.
- [**Appium**](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/Appium.md) - for **mobile testing** with Appium
- [**Detox**](https://github.com/codeceptjs/CodeceptJS/blob/master/docs/helpers/Detox.md) - This is a wrapper on top of Detox library, aimed to unify testing experience for CodeceptJS framework. Detox provides a grey box testing for mobile applications, playing especially well for React Native apps.
@@ -53,7 +51,7 @@ And more to come...
CodeceptJS is a successor of [Codeception](http://codeception.com), a popular full-stack testing framework for PHP.
With CodeceptJS your scenario-driven functional and acceptance tests will be as simple and clean as they can be.
-You don't need to worry about asynchronous nature of NodeJS or about various APIs of Playwright, Selenium, Puppeteer, TestCafe, etc. as CodeceptJS unifies them and makes them work as they are synchronous.
+You don't need to worry about asynchronous nature of NodeJS or about various APIs of Playwright, Selenium, Puppeteer, etc. as CodeceptJS unifies them and makes them work as they are synchronous.
## Features
@@ -64,6 +62,8 @@ You don't need to worry about asynchronous nature of NodeJS or about various API
- Also plays nice with TypeScript.
- Smart locators: use names, labels, matching text, CSS or XPath to locate elements.
- 🌐 Interactive debugging shell: pause test at any point and try different commands in a browser.
+- ⚡ **Parallel testing** with dynamic test pooling for optimal load balancing and performance.
+- 📊 **Built-in HTML Reporter** with interactive dashboard, step-by-step execution details, and comprehensive test analytics.
- Easily create tests, pageobjects, stepobjects with CLI generators.
## Installation
@@ -233,6 +233,60 @@ Scenario('test title', () => {
})
```
+## HTML Reports
+
+Generate beautiful HTML reports using **[@testomatio/reporter](https://github.com/testomatio/reporter)** package.
+
+### Installation
+
+```sh
+npm install @testomatio/reporter --save-dev
+```
+
+### Configuration
+
+Add the `testomatio` plugin to your `codecept.conf.js`:
+
+```js
+plugins: {
+ testomatio: {
+ enabled: true,
+ require: '@testomatio/reporter/codecept',
+ html: true,
+ reportDir: 'output/report',
+ },
+}
+```
+
+### Usage
+
+Run tests normally:
+
+```sh
+npx codeceptjs run
+```
+
+The report will be saved to `output/report/testomatio-report.html` by default. You can also keep using `TESTOMATIO_HTML_REPORT_SAVE=1` and related environment variables if you prefer env-based setup.
+
+### Features
+
+- Modern, responsive interface with real-time statistics
+- Detailed test information with step-by-step breakdown
+- Screenshots, videos, and artifacts display
+- BDD/Gherkin support with proper scenario formatting
+- Customizable output location and filename
+- Optional integration with [Testomat.io](https://testomat.io) cloud
+
+### Customization
+
+```sh
+# Custom output folder in codecept.conf.js
+# reportDir: './reports'
+
+# Integrate with Testomat.io cloud
+TESTOMATIO=your_api_key npx codeceptjs run
+```
+
## PageObjects
CodeceptJS provides the most simple way to create and use page objects in your test.
diff --git a/bin/codecept.js b/bin/codecept.js
index 5a4752129..cf83b4434 100755
--- a/bin/codecept.js
+++ b/bin/codecept.js
@@ -1,8 +1,10 @@
#!/usr/bin/env node
-const program = require('commander')
-const Codecept = require('../lib/codecept')
-const { print, error } = require('../lib/output')
-const { printError } = require('../lib/command/utils')
+import { Command } from 'commander'
+const program = new Command()
+import Codecept from '../lib/codecept.js'
+import output from '../lib/output.js'
+const { print, error } = output
+import { printError } from '../lib/command/utils.js'
const commandFlags = {
ai: {
@@ -42,6 +44,23 @@ const errorHandler =
}
}
+const dynamicImport = async modulePath => {
+ const module = await import(modulePath)
+ return module.default || module
+}
+
+const commandHandler = modulePath =>
+ errorHandler(async (...args) => {
+ const handler = await dynamicImport(modulePath)
+ return handler(...args)
+ })
+
+const commandHandlerWithProperty = (modulePath, property) =>
+ errorHandler(async (...args) => {
+ const module = await dynamicImport(modulePath)
+ return module[property](...args)
+ })
+
if (process.versions.node && process.versions.node.split('.') && process.versions.node.split('.')[0] < 12) {
error('NodeJS >= 12 is required to run.')
print()
@@ -56,19 +75,17 @@ program.version(Codecept.version())
program
.command('init [path]')
.description('Creates dummy config in current dir or [path]')
- .action(errorHandler(require('../lib/command/init')))
+ .option('-y, --yes', 'skip prompts and use defaults (Playwright + chromium, BASE_URL env for url)')
+ .action(commandHandler('../lib/command/init.js'))
program
.command('check')
.option(commandFlags.config.flag, commandFlags.config.description)
.description('Checks configuration and environment before running tests')
.option('-t, --timeout [ms]', 'timeout for checks in ms, 50000 by default')
- .action(errorHandler(require('../lib/command/check')))
+ .action(commandHandler('../lib/command/check.js'))
-program
- .command('migrate [path]')
- .description('Migrate json config to js config in current dir or [path]')
- .action(errorHandler(require('../lib/command/configMigrate')))
+program.command('migrate [path]').description('Migrate json config to js config in current dir or [path]').action(commandHandler('../lib/command/configMigrate.js'))
program
.command('shell [path]')
@@ -78,34 +95,37 @@ program
.option(commandFlags.profile.flag, commandFlags.profile.description)
.option(commandFlags.ai.flag, commandFlags.ai.description)
.option(commandFlags.config.flag, commandFlags.config.description)
- .action(errorHandler(require('../lib/command/interactive')))
+ .action(commandHandler('../lib/command/interactive.js'))
program
.command('list [path]')
.alias('l')
.description('List all actions for I.')
- .action(errorHandler(require('../lib/command/list')))
+ .option(commandFlags.config.flag, commandFlags.config.description)
+ .option('--docs', 'show documentation for each action')
+ .option('--action