JSPM – @codeceptjs/configure@0.3.0

Package Exports

@codeceptjs/configure

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@codeceptjs/configure) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

CodeceptJS Configuration Hooks

Configuration hook is a function that is updates CodeceptJS configuration.

Those hooks are expected to simplify configuration for common use cases.

setHeadlessWhen

Toggle headless mode for Puppeteer, WebDriver, TestCafe, and Nightmare on condition.

Usage:

// in codecept.conf.js
const { setHeadlessWhen } = require('@codeceptjs/configure');

// enable headless only if environment variable HEADLESS exist
// Use it like:
//
// HEADLESS=true npx codeceptjs run
setHeadlessWhen(process.env.HEADLESS); 

exports.config = {
  helpers: {
    // standard config goes here
    WebDriver: {} 
    // or Puppeteer
    // or TestCafe
  }
}

For Puppeteer, TestCafe, Nigthmare it enables show: true.
For WebDriver with Chrome browser adds --headless option to chrome options inside desiredCapabilities.

setSharedCookies

Shares cookies between browser and REST/GraphQL helpers.

This hooks sets onRequest function for REST, GraphQL, ApiDataFactory, GraphQLDataFactory. This function obtains cookies from an active session in WebDriver or Puppeteer helpers.

// in codecept.conf.js
const { setSharedCookies } = require('@codeceptjs/configure');

// share cookies between browser helpers and REST/GraphQL
setSharedCookies();

exports.config = {
  helpers: {
    WebDriver: {
      // standard config goes here      
    } 
    // or Puppeteer
    // or TestCafe,
    REST: {
      // standard config goes here      
      // onRequest: <= will be set by hook
    },
    ApiDataFactory: {
      // standard config goes here
      // onRequest: <= will be set by hook
    }
  }
}

setWindowSize

Universal way to set a browser window size. For Puppeteer this launches Chrome browser with a specified width and height dimensions without changing viewport size.

Usage: setWindowSize(width, height).

// in codecept.conf.js
const { setWindowSize } = require('@codeceptjs/configure');

setWindowSize(1600, 1200);

exports.config = {
  helpers: {
    Puppeteer: {}
  }
}

Contributing

Please send your config hooks!

If you feel that codecept.conf.js becomes too complicated and you know how to make it simpler, send a pull request with a config hook to solve your case.

Good ideas for config hooks:

Setting the same window size for all browser helpers.
Configuring run-multiple
Changing browser in WebDriver or Protractor depending on environment variable.

To create a custom hook follow this rules.

Create a file starting with prefix use in hooks directory.
Create a js module that exports a function.
Require config object from codeceptjs package.
Use config.addHook((config) => {}) to set a hook for configuration
Add a test to index_test.js
Run mocha index_test.js

See current hooks as examples.