CodeceptJS
💖 Support Us    
🇺🇦 CodeceptJS was created in Ukraine. #StandWithUkraine

Plugins

# analyze

Uses AI to analyze test failures and provide insights.

This plugin analyzes failed tests using AI to provide detailed explanations and group similar failures. When enabled with --ai flag, it generates reports after test execution.

# Usage

// in codecept.conf.js
exports.config = {
  plugins: {
    analyze: {
      enabled: true,
      clusterize: 5,
      analyze: 2,
      vision: false,
    },
  },
}

# Configuration

  • clusterize (number) - minimum number of failures to trigger clustering analysis. Default: 5
  • analyze (number) - maximum number of individual test failures to analyze in detail. Default: 2
  • vision (boolean) - enables visual analysis of test screenshots. Default: false
  • categories (array) - list of failure categories for classification. Defaults to:
    • Browser connection error / browser crash
    • Network errors (server error, timeout, etc)
    • HTML / page elements (not found, not visible, etc)
    • Navigation errors (404, etc)
    • Code errors (syntax error, JS errors, etc)
    • Library & framework errors
    • Data errors (password incorrect, invalid format, etc)
    • Assertion failures
    • Other errors
  • prompts (object) - customize AI prompts for analysis
    • clusterize - prompt for clustering analysis
    • analyze - prompt for individual test analysis

# Features

  • Groups similar failures when number of failures >= clusterize value
  • Provides detailed analysis of individual failures
  • Analyzes screenshots if vision=true and screenshots are available
  • Classifies failures into predefined categories
  • Suggests possible causes and solutions

# Parameters

# authLogs user in for the first test and reuses session for next tests.

Works by saving cookies into memory or file. If a session expires automatically logs in again.

For better development experience cookies can be saved into file, so a session can be reused while writing tests.

# Usage

  1. Enable this plugin and configure as described below
  2. Define user session names (example: user, editor, admin, etc).
  3. Define how users are logged in and how to check that user is logged in
  4. Use login object inside your tests to log in:
// inside a test file
// use login to inject auto-login function
Feature('Login')

Before(({ login }) => {
  login('user') // login using user session
})

// Alternatively log in for one scenario.
Scenario('log me in', ({ I, login }) => {
  login('admin')
  I.see('I am logged in')
})

# Configuration

  • saveToFile (default: false) - save cookies to file. Allows to reuse session between execution.
  • inject (default: login) - name of the login function to use
  • users - an array containing different session names and functions to:
    • login - sign in into the system
    • check - check that user is logged in
    • fetch - to get current cookies (by default I.grabCookie())
    • restore - to set cookies (by default I.amOnPage('/'); I.setCookie(cookie))

# How It Works

  1. restore method is executed. It should open a page and set credentials.
  2. check method is executed. It should reload a page (so cookies are applied) and check that this page belongs to logged-in user. When you pass the second args session, you could perform the validation using passed session.
  3. If restore and check were not successful, login is executed
  4. login should fill in login form
  5. After successful login, fetch is executed to save cookies into memory or file.

# Example: Simple login

auth: {
  enabled: true,
  saveToFile: true,
  inject: 'login',
  users: {
    admin: {
      // loginAdmin function is defined in `steps_file.js`
      login: (I) => I.loginAdmin(),
      // if we see `Admin` on page, we assume we are logged in
      check: (I) => {
         I.amOnPage('/');
         I.see('Admin');
      }
    }
  }
}

# Example: Multiple users

auth: {
  enabled: true,
  saveToFile: true,
  inject: 'loginAs', // use `loginAs` instead of login
  users: {
    user: {
      login: (I) => {
         I.amOnPage('/login');
         I.fillField('email', '[email protected]');
         I.fillField('password', '123456');
         I.click('Login');
      },
      check: (I) => {
         I.amOnPage('/');
         I.see('User', '.navbar');
      },
    },
    admin: {
      login: (I) => {
         I.amOnPage('/login');
         I.fillField('email', '[email protected]');
         I.fillField('password', '123456');
         I.click('Login');
      },
      check: (I) => {
         I.amOnPage('/');
         I.see('Admin', '.navbar');
      },
    },
  }
}

# Example: Keep cookies between tests

If you decide to keep cookies between tests you don't need to save/retrieve cookies between tests. But you need to login once work until session expires. For this case, disable fetch and restore methods.

helpers: {
   WebDriver: {
     // config goes here
     keepCookies: true; // keep cookies for all tests
   }
},
plugins: {
   auth: {
     users: {
       admin: {
         login: (I) => {
           I.amOnPage('/login');
           I.fillField('email', '[email protected]');
           I.fillField('password', '123456');
           I.click('Login');
         },
         check: (I) => {
           I.amOnPage('/dashboard');
           I.see('Admin', '.navbar');
         },
         fetch: () => {}, // empty function
         restore: () => {}, // empty funciton
       }
    }
  }
}

# Example: Getting sessions from local storage

If your session is stored in local storage instead of cookies you still can obtain sessions.

plugins: {
   auth: {
    admin: {
      login: (I) => I.loginAsAdmin(),
      check: (I) => I.see('Admin', '.navbar'),
      fetch: (I) => {
        return I.executeScript(() => localStorage.getItem('session_id'));
      },
      restore: (I, session) => {
        I.amOnPage('/');
        I.executeScript((session) => localStorage.setItem('session_id', session), session);
      },
    }
  }
}

# Tips: Using async function in the auth

If you use async functions in the auth plugin, login function should be used with await keyword.

auth: {
  enabled: true,
  saveToFile: true,
  inject: 'login',
  users: {
    admin: {
      login: async (I) => {  // If you use async function in the auth plugin
         const phrase = await I.grabTextFrom('#phrase')
         I.fillField('username', 'admin'),
         I.fillField('password', 'password')
         I.fillField('phrase', phrase)
      },
      check: (I) => {
         I.amOnPage('/');
         I.see('Admin');
      },
    }
  }
}

Scenario('login', async ({ I, login }) => {
  await login('admin') // you should use `await`
})

# Tips: Using session to validate user

Instead of asserting on page elements for the current user in check, you can use the session you saved in fetch

auth: {
  enabled: true,
  saveToFile: true,
  inject: 'login',
  users: {
    admin: {
      login: async (I) => {  // If you use async function in the auth plugin
         const phrase = await I.grabTextFrom('#phrase')
         I.fillField('username', 'admin'),
         I.fillField('password', 'password')
         I.fillField('phrase', phrase)
      },
      check: (I, session) => {
         // Throwing an error in `check` will make CodeceptJS perform the login step for the user
         if (session.profile.email !== the.email.you.expect@some-mail.com) {
              throw new Error ('Wrong user signed in');
        }
      },
    }
  }
}

Scenario('login', async ({ I, login }) => {
  await login('admin') // you should use `await`
})

# Parameters

  • config

# autoDelaySometimes it takes some time for a page to respond to user's actions.

Depending on app's performance this can be either slow or fast. For instance, if you click a button and nothing happens - probably JS event is not attached to this button yet Also, if you fill field and input validation doesn't accept your input - maybe because you typed value too fast. This plugin allows to slow down tests execution when a test running too fast. It puts a tiny delay for before and after action commands. Commands affected (by default):

  • click
  • fillField
  • checkOption
  • pressKey
  • doubleClick
  • rightClick

# Configuration

plugins: {
  autoDelay: {
    enabled: true
  }
}

Possible config options:

  • methods: list of affected commands. Can be overridden
  • delayBefore: put a delay before a command. 100ms by default
  • delayAfter: put a delay after a command. 200ms by default

# Parameters

  • config

# commentStep

# Parameters

  • config

Meta

  • deprecated: Add descriptive nested steps for your tests:

    Scenario('project update test', async I => {
  __`Given`
  const projectId = await I.have('project')

  __`When`
  projectPage.update(projectId, { title: 'new title' })

  __`Then`
  projectPage.open(projectId)
  I.see('new title', 'h1')
})

    Steps prefixed with __ will be printed as nested steps in --steps output:

      Given
    I have "project"
  When
    projectPage update
  Then
    projectPage open
    I see "new title", "h1"

    Also those steps will be exported to allure reports.

    This plugin can be used

    # Config

    • enabled - (default: false) enable a plugin
    • registerGlobal - (default: false) register __ template literal function globally. You can override function global name by providing a name as a value.

    # Examples

    Registering __ globally:

    plugins: {
  commentStep: {
    enabled: true,
    registerGlobal: true
  }
}

    Registering Step globally:

    plugins: {
  commentStep: {
    enabled: true,
    registerGlobal: 'Step'
  }
}

    Using only local function names:

    plugins: {
  commentStep: {
    enabled: true
  }
}

    Then inside a test import a comment function from a plugin. For instance, you can prepare Given/When/Then functions to use them inside tests:

    // inside a test
const step = codeceptjs.container.plugins('commentStep')

const Given = () => step`Given`
const When = () => step`When`
const Then = () => step`Then`

    Scenario('project update test', async (I) => { Given(); const projectId = await I.have('project');

    When(); projectPage.update(projectId, { title: 'new title' });

    Then(); projectPage.open(projectId); I.see('new title', 'h1'); });

# coverageDumps code coverage from Playwright/Puppeteer after every test.

# Configuration

plugins: {
   coverage: {
     enabled: true,
     debug: true,
     name: 'CodeceptJS Coverage Report',
     outputDir: 'output/coverage'
   }
}

Possible config options, More could be found at monocart-coverage-reports (opens new window)

  • debug: debug info. By default, false.
  • name: coverage report name.
  • outputDir: path to coverage report.
  • sourceFilter: filter the source files.
  • sourcePath: option to resolve a custom path.

# Parameters

  • config

# customLocatorCreates a custom locator (opens new window) by using special attributes in HTML.

If you have a convention to use data-test-id or data-qa attributes to mark active elements for e2e tests, you can enable this plugin to simplify matching elements with these attributes:

// replace this:
I.click({ css: '[data-test-id=register_button]');
// with this:
I.click('$register_button');

This plugin will create a valid XPath locator for you.

# Configuration

  • enabled (default: false) should a locator be enabled
  • prefix (default: $) sets a prefix for a custom locator.
  • attribute (default: data-test-id) to set an attribute to be matched.
  • strategy (default: xpath) actual locator strategy to use in query (css or xpath).
  • showActual (default: false) show in the output actually produced XPath or CSS locator. By default shows custom locator value.

# Examples:

Using data-test attribute with $ prefix:

// in codecept.conf.js
plugins: {
 customLocator: {
   enabled: true,
   attribute: 'data-test'
 }
}

In a test:

I.seeElement('$user') // matches => [data-test=user]
I.click('$sign-up') // matches => [data-test=sign-up]

Using data-qa attribute with = prefix:

// in codecept.conf.js
plugins: {
 customLocator: {
   enabled: true,
   prefix: '=',
   attribute: 'data-qa'
 }
}

In a test:

I.seeElement('=user') // matches => [data-qa=user]
I.click('=sign-up') // matches => [data-qa=sign-up]

Using data-qa OR data-test attribute with = prefix:

// in codecept.conf.js
plugins: {
 customLocator: {
   enabled: true,
   prefix: '=',
   attribute: ['data-qa', 'data-test'],
   strategy: 'xpath'
 }
}

In a test:

I.seeElement('=user') // matches => //*[@data-qa=user or @data-test=user]
I.click('=sign-up') // matches => //*[data-qa=sign-up or @data-test=sign-up]

// in codecept.conf.js
plugins: {
 customLocator: {
   enabled: true,
   prefix: '=',
   attribute: ['data-qa', 'data-test'],
   strategy: 'css'
 }
}

In a test:

I.seeElement('=user') // matches => [data-qa=user],[data-test=user]
I.click('=sign-up') // matches => [data-qa=sign-up],[data-test=sign-up]

# Parameters

  • config

# customReporterSample custom reporter for CodeceptJS.

# Parameters

  • config

# eachElementProvides eachElement global function to iterate over found elements to perform actions on them.

eachElement takes following args:

  • purpose - the goal of an action. A comment text that will be displayed in output.
  • locator - a CSS/XPath locator to match elements
  • fn(element, index) - asynchronous function which will be executed for each matched element. Example of usage:
// this example works with Playwright and Puppeteer helper
await eachElement('click all checkboxes', 'form input[type=checkbox]', async el => {
  await el.click()
})

Click odd elements:

// this example works with Playwright and Puppeteer helper
await eachElement('click odd buttons', '.button-select', async (el, index) => {
  if (index % 2) await el.click()
})

Check all elements for visibility:

// this example works with Playwright and Puppeteer helper
const assert = require('assert')
await eachElement('check all items are visible', '.item', async el => {
  assert(await el.isVisible())
})

This method works with WebDriver, Playwright, Puppeteer, Appium helpers. Function parameter el represents a matched element. Depending on a helper API of el can be different. Refer to API of corresponding browser testing engine for a complete API list:

# Configuration

  • registerGlobal - to register eachElement function globally, true by default If registerGlobal is false you can use eachElement from the plugin:
const eachElement = codeceptjs.container.plugins('eachElement')

# Parameters

# fakerTransformUse the @faker-js/faker package to generate fake data inside examples on your gherkin tests

# Usage

To start please install @faker-js/faker package npm install -D @faker-js/faker yarn add -D @faker-js/faker Add this plugin to config file:

plugins: {
  fakerTransform: {
    enabled: true
  }
}

Add the faker API using a mustache string format inside examples tables in your gherkin scenario outline

Scenario Outline: ...
            Given ...
             When ...
             Then ...
        Examples:
  | productName          | customer              | email              | anythingMore |
  | {{commerce.product}} | Dr. {{name.findName}} | {{internet.email}} | staticData   |

# Parameters

  • config

# healSelf-healing tests with AI.

Read more about heaking in Self-Healing Tests (opens new window)

plugins: {
  heal: {
   enabled: true,
  }
}

More config options are available:

  • healLimit - how many steps can be healed in a single test (default: 2)

# Parameters

  • config (optional, default {})

# pageInfoCollects information from web page after each failed test and adds it to the test as an artifact.

It is suggested to enable this plugin if you run tests on CI and you need to debug failed tests. This plugin can be paired with analyze plugin to provide more context. It collects URL, HTML errors (by classes), and browser logs. Enable this plugin in config:

plugins: {
 pageInfo: {
  enabled: true,
}

Additional config options:

  • errorClasses - list of classes to search for errors (default: ['error', 'warning', 'alert', 'danger'])
  • browserLogs - list of types of errors to search for in browser logs (default: ['error'])

# Parameters

  • config (optional, default {})

# pauseOnFailAutomatically launches interactive pause when a test fails.

Useful for debugging flaky tests on local environment. Add this plugin to config file:

plugins: {
  pauseOnFail: {},
}

Unlike other plugins, pauseOnFail is not recommended to be enabled by default. Enable it manually on each run via -p option: npx codeceptjs run -p pauseOnFail

# retryFailedStepRetries each failed step in a test.

Add this plugin to config file:

plugins: {
  retryFailedStep: {
    enabled: true
  }
}

Run tests with plugin enabled: npx codeceptjs run --plugins retryFailedStep

# Configuration:

  • retries - number of retries (by default 3),
  • when - function, when to perform a retry (accepts error as parameter)
  • factor - The exponential factor to use. Default is 1.5.
  • minTimeout - The number of milliseconds before starting the first retry. Default is 1000.
  • maxTimeout - The maximum number of milliseconds between two retries. Default is Infinity.
  • randomize - Randomizes the timeouts by multiplying with a factor from 1 to 2. Default is false.
  • defaultIgnoredSteps - an array of steps to be ignored for retry. Includes:
    • amOnPage
    • wait*
    • send*
    • execute*
    • run*
    • have*
  • ignoredSteps - an array for custom steps to ignore on retry. Use it to append custom steps to ignored list. You can use step names or step prefixes ending with *. As such, wait* will match all steps starting with wait. To append your own steps to ignore list - copy and paste a default steps list. Regexp values are accepted as well.

# Example

plugins: {
    retryFailedStep: {
        enabled: true,
        ignoredSteps: [
          'scroll*', // ignore all scroll steps
          /Cookie/, // ignore all steps with a Cookie in it (by regexp)
        ]
    }
}

# Disable Per TestThis plugin can be disabled per test. In this case you will need to stet I.retry() to all flaky steps:

Use scenario configuration to disable plugin for a test

Scenario('scenario tite', { disableRetryFailedStep: true }, () => {
  // test goes here
})

# Parameters

  • config

# screenshotOnFailCreates screenshot on failure. Screenshot is saved into output directory.

Initially this functionality was part of corresponding helper but has been moved into plugin since 1.4 This plugin is enabled by default.

# Configuration

Configuration can either be taken from a corresponding helper (deprecated) or a from plugin config (recommended).

plugins: {
  screenshotOnFail: {
    enabled: true
  }
}

Possible config options:

  • uniqueScreenshotNames: use unique names for screenshot. Default: false.
  • fullPageScreenshots: make full page screenshots. Default: false.

# Parameters

  • config

# selenoidSelenoid (opens new window) plugin automatically starts browsers and video recording.

Works with WebDriver helper.

# Prerequisite

This plugin requires Docker to be installed.

If you have issues starting Selenoid with this plugin consider using the official Configuration Manager (opens new window) tool from Selenoid

# Usage

Selenoid plugin can be started in two ways:

  1. Automatic - this plugin will create and manage selenoid container for you.
  2. Manual - you create the conatainer and configure it with a plugin (recommended).

# Automatic

If you are new to Selenoid and you want plug and play setup use automatic mode. Add plugin configuration in codecept.conf.js:

plugins: {
    selenoid: {
      enabled: true,
      deletePassed: true,
      autoCreate: true,
      autoStart: true,
      sessionTimeout: '30m',
      enableVideo: true,
      enableLog: true,
    },
  }

When autoCreate is enabled it will pull the latest Selenoid from DockerHub (opens new window) and start Selenoid automatically. It will also create browsers.json file required by Selenoid. 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.

If you are using Windows machine or if autoCreate does not work properly, create container manually

# Manual

While this plugin can create containers for you for better control it is recommended to create and launch containers manually. This is especially useful for Continous Integration server as you can configure scaling for Selenoid containers.

Use Selenoid Configuration Manager (opens new window) to create and start containers semi-automatically.

  1. Create browsers.json file in the same directory codecept.conf.js is located Refer to Selenoid documentation (opens new window) to know more about browsers.json. Sample browsers.json
{
 "chrome": {
   "default": "latest",
   "versions": {
     "latest": {
       "image": "selenoid/chrome:latest",
       "port": "4444",
       "path": "/"
     }
   }
 }
}

It is recommended to use specific versions of browsers in browsers.json instead of latest. This will prevent tests fail when browsers will be updated. ⚠ At first launch selenoid plugin takes extra time to download all Docker images before tests starts. 2. Create Selenoid container Run the following command to create a container. To know more refer here (opens new window)

docker create                                    \
--name selenoid                                  \
-p 4444:4444                                     \
-v /var/run/docker.sock:/var/run/docker.sock     \
-v `pwd`/:/etc/selenoid/:ro                      \
-v `pwd`/output/video/:/opt/selenoid/video/      \
-e OVERRIDE_VIDEO_OUTPUT_DIR=`pwd`/output/video/ \
aerokube/selenoid:latest-release

# Video Recording

This plugin allows to record and save video per each executed tests. When enableVideo is true this plugin saves video in output/videos directory with each test by name To save space videos for all succesful tests are deleted. This can be changed by deletePassed option. When allure plugin is enabled a video is attached to report automatically.

# Options:

Param Description
name Name of the container (default : selenoid)
port Port of selenium server (default : 4444)
autoCreate Will automatically create container (Linux only) (default : true)
autoStart If disabled start the container manually before running tests (default : true)
enableVideo Enable video recording and use video folder of output (default: false)
enableLog Enable log recording and use logs folder of output (default: false)
deletePassed Delete video and logs of passed tests (default : true)
additionalParams example: additionalParams: '--env TEST=test' Refer here (opens new window) to know more

# Parameters

  • config

# stepByStepReportstep-by-step-report

Generates step by step report for a test. After each step in a test a screenshot is created. After test executed screenshots are combined into slideshow. By default, reports are generated only for failed tests. Run tests with plugin enabled: npx codeceptjs run --plugins stepByStepReport

# Configuration

"plugins": {
   "stepByStepReport": {
     "enabled": true
   }
}

Possible config options:

  • deleteSuccessful: do not save screenshots for successfully executed tests. Default: true.
  • animateSlides: should animation for slides to be used. Default: true.
  • ignoreSteps: steps to ignore in report. Array of RegExps is expected. Recommended to skip grab* and wait* steps.
  • fullPageScreenshots: should full page screenshots be used. Default: false.
  • output: a directory where reports should be stored. Default: output.
  • screenshotsForAllureReport: If Allure plugin is enabled this plugin attaches each saved screenshot to allure report. Default: false.
  • `disableScreenshotOnFail : Disables the capturing of screeshots after the failed step. Default: true.

# Parameters

  • config any

# stepTimeoutSet timeout for test steps globally.

Add this plugin to config file:

plugins: {
  stepTimeout: {
    enabled: true
  }
}

Run tests with plugin enabled: npx codeceptjs run --plugins stepTimeout

# Configuration:

  • timeout - global step timeout, default 150 seconds

  • overrideStepLimits - whether to use timeouts set in plugin config to override step timeouts set in code with I.limitTime(x).action(...), default false

  • noTimeoutSteps - an array of steps with no timeout. Default:

    • amOnPage
    • wait*

    you could set your own noTimeoutSteps which would replace the default one.

  • customTimeoutSteps - an array of step actions with custom timeout. Use it to override or extend noTimeoutSteps. You can use step names or step prefixes ending with *. As such, wait* will match all steps starting with wait.

# Example

plugins: {
    stepTimeout: {
        enabled: true,
        overrideStepLimits: true,
        noTimeoutSteps: [
          'scroll*', // ignore all scroll steps
          /Cookie/, // ignore all steps with a Cookie in it (by regexp)
        ],
        customTimeoutSteps: [
          ['myFlakyStep*', 1],
          ['scrollWhichRequiresTimeout', 5],
        ]
    }
}

# Parameters

  • config

# subtitlesAutomatically captures steps as subtitle, and saves it as an artifact when a video is found for a failed test

# Configuration

plugins: {
  subtitles: {
    enabled: true
  }
}

# wdioWebdriverio services runner.

This plugin allows to run webdriverio services like:

# Setup

  1. Install a webdriverio service
  2. Enable wdio plugin in config
  3. Add service name to services array inside wdio plugin config. See examples below:

# Selenium Standalone Service

Install @wdio/selenium-standalone-service package, as described here (opens new window). It is important to make sure it is compatible with current webdriverio version. Enable wdio plugin in plugins list and add selenium-standalone service:

plugins: {
   wdio: {
       enabled: true,
       services: ['selenium-standalone']
       // additional config for service can be passed here
   }
}

# Sauce Service

Install @wdio/sauce-service package, as described here (opens new window). It is important to make sure it is compatible with current webdriverio version. Enable wdio plugin in plugins list and add sauce service:

plugins: {
   wdio: {
       enabled: true,
       services: ['sauce'],
       user: ... ,// saucelabs username
       key: ... // saucelabs api key
       // additional config, from sauce service
   }
}

***In the same manner additional services from webdriverio can be installed, enabled, and configured.

# Configuration

  • services - list of enabled services
  • ... - additional configuration passed into services.

# Parameters

  • config
Help us improve this page! (opens new window)
Last Updated: 2/10/2025, 5:03:46 AM

More Information

Videos

Books & Posts

Examples

Cookbook →

Commercial Services →

Trainings →

Testomat.io →
Plan your end 2 end tests, collaborate, synchronize with code & get reports!
Join Testomat.io while it is in beta and get a huge discount!

Support us via OpenCollective!