Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
196 lines (151 sloc) 6.27 KB
id title
Data Management

This chapter describes data management for external sources. If you are looking for using Data Sets in tests, see Data Driven Tests section*

Managing data for tests is always a tricky issue. How isolate data between tests, how to prepare data for different tests, etc. There are different approaches to solve it:

  1. reset database completely between tests
  2. create unique non-intersecting data sets per each test
  3. create and delete data for a test

The most efficient way would be to allow test to control its data, i.e. the 3rd option. However, accessing database directly is not a good idea as database vendor, schema and data are used by application internally and are out of scope of acceptance test.

Today all modern web applications have REST API. So it is a good idea to use it to create data for a test and delete it after. API supposed to be a stable interface and it can be used by acceptance tests. CodeceptJS provides 2 helpers for Data Management via REST API.


REST helper allows sending raw HTTP requests to application. This is a tool to make shortcuts and create your data pragmatically via API. However, it doesn't provide tools for testing APIs, so it should be paired with WebDriver, Nightmare or Protractor helpers for browser testing.

Enable REST helper in the config. It is recommended to set endpoint, a base URL for all API requests. If you need some authorization you can optionally set default headers too.

See the sample config:

helpers: {
  REST: {
    endpoint: "http://localhost/api/v1/",
    defaultHeaders: {
      'Auth': '11111',
      'Content-Type': 'application/json',
      'Accept': 'application/json',
  WebDriver : {
    url: 'http://localhost',
    browser: 'chrome'

REST helper provides basic methods to send requests to application:


As well as a method for setting headers: haveRequestHeaders.

Here is a usage example:

let postId = null;

Scenario('check post page', async (I)  => {
  // valid access token
  I.haveRequestHeaders({auth: '1111111'});
  // get the first user
  let user = await I.sendGetRequest('/api/users/1');
  // create a post and save its Id
  postId = await I.sendPostRequest('/api/posts', { author:, body: 'some text' });
  // open browser page of new post
  I.see('some text', 'p.body');

// cleanup created data
After((I) => {

This can also be used to emulate Ajax requests:

I.sendPostRequest('/update-status', {}, { http_x_requested_with: 'xmlhttprequest' });

See complete reference on REST helper

Data Generation with Factories

This concept is extended by ApiDataFactory helper. It builds data according to defined rules and uses API to store them and automatically clean them up after a test, This way setting data for a test is as simple as writing:

// inside async function
let post = await I.have('post');
I.haveMultiple('comment', 5, { postId:});

Just define how many items of any kind you need and ApiDataFactory will create them for you. However, to make this work some preparations required.

At first, you need data generation libraries which are Rosie and Faker. Faker can generate random names, emails, texts, and Rosie uses them to generate objects using factories.

Install rosie and faker to create a first factory:

npm i rosie faker --save-dev

Then create a module which will export a factory for an entity.

See the example providing a factory for User generation:

// factories/post.js
var Factory = require('rosie').Factory;
var faker = require('faker');

module.exports = new Factory()
  .attr('name', () =>
  .attr('email', () =>;

Next is to configure helper to match factories with API:

 ApiDataFactory: {
   endpoint: "",
   headers: {
     'Content-Type': 'application/json',
     'Accept': 'application/json',
   factories: {
     user: {
        uri: "/users",
        factory: "./factories/user"

Then, calling I.have('user') inside a test will create a new user for you. This is done by sending POST request to /api/users URL. Response is returned and can be used in tests.

At the end of a test ApiDataFactory will clean up created record for you. This is done by collecting ids from crated records and running DELETE /api/users/{id} requests at the end of a test. This rules can be customized in helper configuration.

See complete reference on ApiDataFactory helper

API Requests Using Browser Session

Both REST and ApiDataFactory helpers allow override requests before sending. This feature can be used to fetch current browser cookies and set them to REST API client. By doing this we can make requests within the current browser session without a need of additional authentication.

Sharing browser session with ApiDataFactory can be especially useful when you test Single Page Applications

Let's see how to configure ApiDataFactory alongside with WebDriver to share cookies:

  ApiDataFactory: {
    endpoint: '',
    cleanup: true,
    headers: {
      'Content-Type': 'application/json',
      'Accept': 'application/json',
    factories: {
      user: {
          uri: "/users",
          factory: "./factories/user",
    onRequest: async (request) => {
      let cookies = await codeceptjs.container.helpers('WebDriver').grabCookie();
      request.headers = { Cookie: => `${}=${c.value}`).join('; ') };
  WebDriver: {
    url: '',
    browser: 'chrome',

In this case we are accessing WebDriver helper. However, you can replace WebDriver with any helper you use.

The order of helpers is important! ApiDataFactory will clean up created users after a test, so it needs browser to be still opened to obtain its cookies.