[![NPM version][npm-image]][npm-url]
 

Build Status

| Type | Engine | Status |
| --------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| 🌐 Web | Playwright |  |
| 🌐 Web | Puppeteer |  |
| 🌐 Web | WebDriver |  |
| 🌐 Web | TestCafe |  |
| 📱 Mobile | Appium |  |

CodeceptJS 

Reference: Helpers API

Supercharged E2E Testing

CodeceptJS is a new testing framework for end-to-end testing with WebDriver (or others).
It abstracts browser interaction to simple steps that are written from a user's perspective.
A simple test that verifies the "Welcome" text is present on a main page of a site will look like:

``js
Feature('CodeceptJS demo')

Scenario('check Welcome page on site', ({ I }) => {
I.amOnPage('/')
I.see('Welcome')
})
`

CodeceptJS tests are:

- Synchronous. You don't need to care about callbacks or promises or test scenarios which are linear. But, your tests should be linear.
- Written from user's perspective. Every action is a method of I. That makes test easy to read, write and maintain even for non-tech persons.
- Backend API agnostic. We don't know which WebDriver implementation is running this test.

CodeceptJS uses Helper modules to provide actions to I object. Currently, CodeceptJS has these helpers:

- Playwright - is a Node library to automate the Chromium, WebKit and Firefox browsers with a single API.
- Puppeteer - uses Google Chrome's Puppeteer for fast headless testing.
- WebDriver - uses webdriverio to run tests via WebDriver or Devtools protocol.
- TestCafe - cheap and fast cross-browser test automation.
- Appium - for mobile testing with Appium
- Detox - 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.

And more to come...

Why CodeceptJS?

CodeceptJS is a successor of Codeception, 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.

Features

- 🪄 AI-powered with GPT features to assist and heal failing tests.
- ☕ Based on Mocha testing framework.
- 💼 Designed for scenario driven acceptance testing in BDD-style.
- 💻 Uses ES6 natively without transpiler.
- 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

`sh
npm i codeceptjs --save
`

Move to directory where you'd like to have your tests (and CodeceptJS config) stored, and execute:

`sh
npx codeceptjs init
`

to create and configure test environment. It is recommended to select WebDriver from the list of helpers, if you need to write Selenium WebDriver tests.

After that create your first test by executing:

`sh
npx codeceptjs generate:test
`

Now test is created and can be executed with

`sh
npx codeceptjs run
`

If you want to write your tests using TypeScript just generate standard Type Definitions by executing:

`sh
npx codeceptjs def .
`

Later you can even automagically update Type Definitions to include your own custom helpers methods.

Note:

- CodeceptJS requires Node.js version 12+ or later.

Usage

Learn CodeceptJS by examples. Let's assume we have CodeceptJS installed and WebDriver helper enabled.

$3

Let's see how we can handle basic form testing:

`js
Feature('CodeceptJS Demonstration')

Scenario('test some forms', ({ I }) => {
I.amOnPage('http://simple-form-bootstrap.plataformatec.com.br/documentation')
I.fillField('Email', 'hello@world.com')
I.fillField('Password', secret('123456'))
I.checkOption('Active')
I.checkOption('Male')
I.click('Create User')
I.see('User is valid')
I.dontSeeInCurrentUrl('/documentation')
})
`

All actions are performed by I object; assertions functions start with see function.
In these examples all methods of I are taken from WebDriver helper, see reference to learn how to use them.

Let's execute this test with run command. Additional option --steps will show us the running process. We recommend use --steps or --debug during development.

`sh
npx codeceptjs run --steps
`

This will produce an output:

`sh
CodeceptJS Demonstration --
test some forms
• I am on page "http://simple-form-bootstrap.plataformatec.com.br/documentation"
• I fill field "Email", "hello@world.com"
• I fill field "Password", "**"
• I check option "Active"
• I check option "Male"
• I click "Create User"
• I see "User is valid"
• I dont see in current url "/documentation"
✓ OK in 17752ms
`

CodeceptJS has an ultimate feature to help you develop and debug your test.
You can pause execution of test in any place and use interactive shell to try different actions and locators.
Just add pause() call at any place in a test and run it.

Interactive shell can be started outside test context by running:

`sh
npx codeceptjs shell
`

$3

We filled form with fillField methods, which located form elements by their label.
The same way you can locate element by name, CSS or XPath locators in tests:

`js
// by name
I.fillField('user_basic[email]', 'hello@world.com')
// by CSS
I.fillField('#user_basic_email', 'hello@world.com')
// don't make us guess locator type, specify it
I.fillField({ css: '#user_basic_email' }, 'hello@world.com')
`

Other methods like checkOption, and click work in a similar manner. They can take labels or CSS or XPath locators to find elements to interact.

$3

Assertions start with see or dontSee prefix. In our case we are asserting that string 'User is valid' is somewhere in a webpage.
However, we can narrow the search to particular element by providing a second parameter:

`js
I.see('User is valid')
// better to specify context:
I.see('User is valid', '.alert-success')
`

In this case 'User is valid' string will be searched only inside elements located by CSS .alert-success.

$3

In case you need to return a value from a webpage and use it directly in test, you should use methods with grab prefix.
They are expected to be used inside async/await functions, and their results will be available in test:

`js
Feature('CodeceptJS Demonstration')

Scenario('test page title', async ({ I }) => {
I.amOnPage('http://simple-form-bootstrap.plataformatec.com.br/documentation')
const title = await I.grabTitle()
I.expectEqual(title, 'Example application with SimpleForm and Twitter Bootstrap') // Avaiable with Expect helper. -> https://codecept.io/helpers/Expect/
})
`

The same way you can grab text, attributes, or form values and use them in next test steps.

$3

Common preparation steps like opening a web page, logging in a user, can be placed in Before or Background:

`js
const { I } = inject()

Feature('CodeceptJS Demonstration')

Before(() => {
// or Background
I.amOnPage('http://simple-form-bootstrap.plataformatec.com.br/documentation')
})

Scenario('test some forms', () => {
I.click('Create User')
I.see('User is valid')
I.dontSeeInCurrentUrl('/documentation')
})

Scenario('test title', () => {
I.seeInTitle('Example application')
})
`

HTML Reporter

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:

$3

- Interactive Dashboard: Visual statistics, pie charts, and expandable test details
- Step-by-Step Execution: Shows individual test steps with timing and status indicators
- BDD/Gherkin Support: Full support for feature files with proper scenario formatting
- System Information: Comprehensive environment details including browser versions
- Advanced Filtering: Real-time filtering by status, tags, features, and test types
- History Tracking: Multi-run history with trend visualization
- Error Details: Clean formatting of error messages and stack traces
- Artifacts Support: Display screenshots and other test artifacts

$3

#### Interactive Test Dashboard

The main dashboard provides a complete overview with interactive statistics and pie charts:

!HTML Reporter Dashboard

#### Detailed Test Results

Each test shows comprehensive execution details with expandable step information:

!HTML Reporter Test Details

#### Advanced Filtering Capabilities

Real-time filtering allows quick navigation through test results:

!HTML Reporter Filtering

#### BDD/Gherkin Support

Full support for Gherkin scenarios with proper feature formatting:

!HTML Reporter BDD Details

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.

PageObjects

CodeceptJS provides the most simple way to create and use page objects in your test.
You can create one by running

`sh
npx codeceptjs generate pageobject
`

It will create a page object file for you and add it to the config.
Let's assume we created one named docsPage:

`js
const { I } = inject()

module.exports = {
fields: {
email: '#user_basic_email',
password: '#user_basic_password',
},
submitButton: { css: '#new_user_basic input[type=submit]' },

sendForm(email, password) {
I.fillField(this.fields.email, email)
I.fillField(this.fields.password, password)
I.click(this.submitButton)
},
}
`

You can easily inject it to test by providing its name in test arguments:

`js
Feature('CodeceptJS Demonstration')

Before(({ I }) => {
// or Background
I.amOnPage('http://simple-form-bootstrap.plataformatec.com.br/documentation')
})

Scenario('test some forms', ({ I, docsPage }) => {
docsPage.sendForm('hello@world.com', '123456')
I.see('User is valid')
I.dontSeeInCurrentUrl('/documentation')
})
`

When using Typescript, replace module.exports with export` for autocompletion.

Contributing

- ### Contributing Guide
- ### Code of conduct

Contributors

Thanks to our awesome contributors! 🎉

Made with contrib.rocks.

License

MIT © CodeceptJS Team

[npm-image]: https://badge.fury.io/js/codeceptjs.svg
[npm-url]: https://npmjs.org/package/codeceptjs
[travis-image]: https://travis-ci.org/Codeception/codeceptjs.svg?branch=master
[travis-url]: https://travis-ci.org/Codeception/codeceptjs
[daviddm-image]: https://david-dm.org/Codeception/codeceptjs.svg?theme=shields.io
[daviddm-url]: https://david-dm.org/Codeception/codeceptjs
[coveralls-image]: https://coveralls.io/repos/Codeception/codeceptjs/badge.svg
[coveralls-url]: https://coveralls.io/r/Codeception/codeceptjs