A platform independent debuggable BDD Javascript testing framework. It's simple, easy to use and not dependant to any other tool or library. It's built with nodeJs, webdriver.io (the Selenium 2.0 bindings for NodeJS) and cucumber-js complete with integrated API Testing.
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.



klassi-cucumber-js Run Status Build Status Downloads

A platform independent debuggable BDD Javascript testing framework. It's simple, easy to use and not dependant to any other tool or library. It's built with nodeJs, webdriver.io (the Selenium 2.0 bindings for NodeJS) and cucumber-js complete with integrated API Testing.


git-clone-ssh: git@github.com:larryg01/klassi-cucumber-js.git
git-clone-http: https://github.com/larryg01/klassi-cucumber-js.git
download: https://github.com/larryg01/klassi-cucumber-js/archive/development.zip
npm i klassi-cucumber-js 

# To run your test locally, you'll need a local selenium server running, you can install and
# launch a selenium standalone server with chrome, firefox and phantomjs drivers via the 
# following commands in a separate terminal:

npm install selenium-standalone@latest -g --save-dev
selenium-standalone install
selenium-standalone start


# run 'npm install' in a terminal window from within the project folder
node ./node_modules/klassi-cucumber-js/index.js -s ./step-definitions
node index.js -d -t @search


-h, --help                   output usage information
-v, --version                output the version number
-s, --steps <path>           path to step definitions. defaults to ./step-definitions
-p, --pageObjects <path>     path to page objects. defaults to ./page-objects
-o, --sharedObjects [paths]  path to shared objects - repeatable. defaults to ./shared-objects
-b, --browser <path>         name of browser to use. defaults to chrome
-r, --reports <path>         output path to save reports. defaults to ./reports
-d, --disableTestReport [optional]  disables the test report from opening after test completion
-t, --tags <tagName>         name of tag to run
-c, --context <path>        contextual root path for project-specific features, steps, objects etc
-f, --featuresPath <path>   path to feature definitions. defaults to ./features
-e, --email [optional]      sends email reports to stakeholders
-n, --environment [<path>]  name of environment to run the framework/test in. default to dev
-g, --reportName [optional] basename for report files e.g. use report for report.json
-x, --extraSettings [optional]  further piped configs split with pipes
-w, --remoteService [optional]  which remote driver service, if any, should be used e.g. browserstack

By default tests are run using Google Chrome, to run tests using another browser supply the name of that browser along with the -b switch. Available options are:

Browser Example
Chrome -b chrome
Firefox -b firefox

The following variables are available within the Given(), When() and Then() functions:

Variable Description
driver an instance of web driver (the browser)
webdriverio the raw webdriver module, providing access to static properties/methods
page collection of page objects loaded from disk and keyed by filename
shared collection of shared objects loaded from disk and keyed by filename
helpers a collection of helper methods things webdriver.io does not provide but really should!
expect instance of chai expect to expect('something').to.equal('something')
assert instance of chai assert to assert.isOk('everything', 'everything is ok')
trace handy trace method to log console output with increased visibility
fs exposes fs (file system) for use globally
dir exposes dir for getting an array of files, subdirectories or both
request exposes the request-promise for API testing
date exposes the date method for logs and reports
log exposes the log method for output to files and emailing
envConfig exposes the global environment configuration file

Visual Regression functionality with Resemble JS

Visual regression testing, gives the ability to take and compare whole page screenshots or of specific parts of the application / page under test.

// ./runtime/imageCompare.js

compareImage: async function (fileName) {
  const verify = require('./imageCompare');
  await verify.assertion(fileName);
  await verify.value();
  await verify.pass();

// usage within page-object file:

  await helpers.compareImage(fileName);

CSS Responsive functionality with webdriverCSS

CSS Responsive testing, gives the ability to take and compare screenshots of different viewPoints ({width,height}) of the application under test.

You will need to have GraphicsMagick preinstalled on your system because WebdriverCSS uses it for image processing. To install GraphicsMagick follow the instructions here .

// ./runtime/helpers.js

cssImages: async function(pageName){
  await driver.webdrivercss(pageName, {
    name: '',
    elem: ''

// usage within page-object file:

    await helpers.cssImages(pageName);

API Testing functionality with request-promise

Getting data from a JSON REST API

// ./runtime/helpers.js
 apiCall: function (endpoint) {
    let endPoint = ('http://endpoint.com');
    let options = {
        method: 'GET',
        url: endPoint,
        json: true,
        simple: false,
        resolveWithFullResponse: true,
    return request(options)
    .then(async function (response, err) {
        if (err) {
           // API call failed
        // response = API call is successful


HTML and JSON reports are automatically generated and stored in the default ./reports folder. This location can be changed by providing a new path using the -r command line switch:

Cucumber HTML report

Event handlers

You can register event handlers for the following events within the cucumber lifecycle.

const {After, Before, AfterAll, BeforeAll} = require('cucumber');

Event Example
Before Before(function() { // This hook will be executed before all scenarios})
After After(function() {// This hook will be executed after all scenarios});
BeforeAll BeforeAll(function() {// perform some shared setup});
AfterAll AfterAll(function() {// perform some shared teardown});

How to debug

Most webdriverio methods return a JavaScript Promise that is resolved when the method completes. The easiest way to step in with a debugger is to add a .then method to a selenium function and place a debugger statement within it, for example:

  When(/^I search DuckDuckGo for "([^"]*)"$/, function (searchQuery, done) {
    driver.element('#search_form_input_homepage').then(function(input) {
      debugger; // <<- your IDE should step in at this point, with the browser open
      return input;
       input.setValue(selector, searchQuery);
       input.setValue(selector, 'Enter');

       done(); // <<- let cucumber know you're done

Default directory structure

You can use the framework without any command line arguments if your application uses the following folder structure:

├── features
│   └── duckDuckGo-search.feature
├── step_definitions
│   └── duckDuckGo-search-steps.js
├── page-objects
│   └── duckDuckGoSearch.js
|__ runtime
|   |__ world.js
└── shared-objects
│   ├── test-data.js
└── reports
    ├── cucumber-report.json
    └── cucumber-report.html


Please raise bugs via the klassi-cucumber-js issue tracker and, if possible, please provide enough information to allow the bug to be reproduced.


Anyone can contribute to this project simply by opening an issue here or fork the project and issue a pull request with suggested improvements. In lieu of a formal styleguide, please take care to maintain the existing coding style.


John Doherty


MIT License © 2016 Larry Goddard