Configuration

# Configuration

CodeceptJS configuration is set in codecept.conf.js file.

After running codeceptjs init it should be saved in test root.

Name Type Description
bootstrap? () => Promise<void> | boolean | string Execute code before (opens new window) tests are run. Can be either JS module file or async function: bootstrap: async () => server.launch(), or bootstrap: 'bootstrap.js',
bootstrapAll? () => Promise<void> | boolean | string Execute code before launching tests in parallel mode (opens new window)
gherkin? { features: string | string[] ; steps: string[] } Enable BDD features (opens new window). Sample configuration: gherkin: { features: "./features/*.feature", steps: ["./step_definitions/steps.js"] }
gherkin.features string | string[] load feature files by pattern. Multiple patterns can be specified as array
gherkin.steps string[] load step definitions from JS files
grep? string Pattern to filter tests by name. This option is useful if you plan to use multiple configs for different environments. To execute only tests with @firefox tag use grep: '@firefox'
helpers? {} Enable and configure helpers: helpers: { Playwright: { url: 'https://mysite.com', browser: 'firefox' } }
include? any Include page objects to access them via dependency injection I: "./custom_steps.js", loginPage: "./pages/Login.js", User: "./pages/User.js", Configured modules can be injected by name in a Scenario: Scenario('test', { I, loginPage, User })
mocha? any Mocha test runner options (opens new window), additional reporters (opens new window) can be configured here. Example: mocha: { "mocha-junit-reporter": { stdout: "./output/console.log", options: { mochaFile: "./output/result.xml", attachments: true //add screenshot for a failed test } } }
noGlobals? boolean Disable registering global functions (Before, Scenario, etc). Not recommended
output string Where to store failure screenshots, artifacts, etc output: './output'
plugins? any Enable CodeceptJS plugins. Example: plugins: { autoDelay: { enabled: true } }
require? string[] Require additional JS modules (opens new window) Example: require: ["should"]
teardown? () => Promise<void> | boolean | string Execute code after tests (opens new window) finished. Can be either JS module file or async function: teardown: async () => server.stop(), or teardown: 'teardown.js',
teardownAll? () => Promise<void> | boolean | string Execute JS code after finishing tests in parallel mode (opens new window)
tests string Pattern to locate CodeceptJS tests. Allows to enter glob pattern or an Array of patterns to match tests / test file names. For tests in JavaScript: tests: 'tests/**.test.js' For tests in TypeScript: tests: 'tests/**.test.ts'
timeout? number Set default tests timeout in seconds. Tests will be killed on no response after timeout. timeout: 20,
translation? string Enable localized test commands (opens new window)

# Require

Requires described module before run. This option is useful for assertion libraries, so you may --require should instead of manually invoking require('should') within each test file. It can be used with relative paths, e.g. "require": ["/lib/somemodule"], and installed packages.

You can register ts-node, so you can use Typescript in tests with ts-node package

exports.config = {
  tests: './*_test.js',
  timeout: 10000,
  output: '',
  helpers: {},
  include: {},
  bootstrap: false,
  mocha: {},
  // require modules
  require: ["ts-node/register", "should"]
}

For array of test pattern

exports.config = {
  tests: ['./*_test.js','./sampleTest.js'],
  timeout: 10000,
  output: '',
  helpers: {},
  include: {},
  bootstrap: false,
  mocha: {},
  // require modules
  require: ["ts-node/register", "should"]
}

# Dynamic Configuration

By default codecept.json is used for configuration. You can override its values in runtime by using --override or -o option in command line, passing valid JSON as a value:

codeceptjs run -o '{ "helpers": {"WebDriver": {"browser": "firefox"}}}'

You can also switch to JS configuration format for more dynamic options. Create codecept.conf.js file and make it export config property.

See the config example:

exports.config = {
  helpers: {
    WebDriver: {
      // load variables from the environment and provide defaults
      url: process.env.CODECEPT_URL || 'http://localhost:3000',

      user: process.env.CLOUDSERVICE_USER,
      key: process.env.CLOUDSERVICE_KEY,

      coloredLogs: true,
      waitForTimeout: 10000
    }
  },

  // don't build monolithic configs
  mocha: require('./mocha.conf.js') || {},
  include: {
    I: './src/steps_file.js',
    loginPage: './src/pages/login_page',
    dashboardPage: new DashboardPage()
  }

  // here goes config as it was in codecept.json
  // ....
};

(Don't copy-paste this config, it's just demo)

If you prefer to store your configuration files in a different location, or with a different name, you can do that with --config or `-c:

codeceptjs run --config=./path/to/my/config.js

# Common Configuration Patterns

πŸ“Ί Watch this material (opens new window) on YouTube

@codeceptjs/configure package (opens new window) contains shared recipes for common configuration patterns. This allows to set meta-configuration, independent from a current helper enabled.

Install it and enable to easily switch to headless/window mode, change window size, etc.

const { setHeadlessWhen, setWindowSize } = require('@codeceptjs/configure');

setHeadlessWhen(process.env.CI);
setWindowSize(1600, 1200);

exports.config = {
  // ...
}

# Profile

Using process.env.profile you can change the config dynamically. It provides value of --profile option passed to runner. Use its value to change config value on the fly.

For instance, with the config above we can change browser value using profile option

codeceptjs run --profile firefox
exports.config = {
  helpers: {
    WebDriver: {
      url: 'http://localhost:3000',
      // load value from `profile`
      browser: process.env.profile || 'firefox'

    }
  }
};
Last Updated: 8/23/2022, 2:23:09 AM