@wdio/mocha-framework

WDIO Mocha Framework Adapter

A WebdriverIO plugin. Adapter for Mocha testing framework.

Installation

The easiest way is to keep @wdio/mocha-framework as a devDependency in your package.json, via:

npm install @wdio/mocha-framework --save-dev

Instructions on how to install WebdriverIO can be found here.

Configuration

Following code shows the default wdio test runner configuration...

// wdio.conf.js
module.exports = {
  // ...
  framework: 'mocha',

  mochaOpts: {
    ui: 'bdd'
  }
  // ...
};

Note that interfaces supported are bdd, tdd and qunit. If you want to provide a custom interface, it should expose methods compatible with them and be named ending with -bdd, -tdd or -qunit accordingly.

mochaOpts Options

Options will be passed to the Mocha instance. See the list of supported Mocha options here.

mochaOpts.require (string|string[])

The require option is useful when you want to add or extend some basic functionality.
For example, let's try to create an anonymous describe:

wdio.conf.js

{
  suites: {
    login: ['tests/login/*.js']
  },

  mochaOpts: {
    require: './hooks/mocha.js'
  }
}

./hooks/mocha.js

import path from 'path';

let { context, file, mocha, options } = module.parent.context;
let { describe } = context;

context.describe = function (name, callback) {
	if (callback) {
		return describe(...arguments);
	} else {
		callback = name;
		name = path.basename(file, '.js');

		return describe(name, callback);
	}
}

./tests/TEST-XXX.js

describe(() => {
	it('Login form', function () => {
		this.skip();
	});
});

Output

TEST-XXX
   ✓ Login form

mochaOpts.compilers (string[])

Use the given module(s) to compile files. Compilers will be included before requires.

CoffeeScript and similar transpilers may be used by mapping the file extensions and the module name.

{
  mochaOpts: {
    compilers: ['coffee:foo', './bar.js']
  }
}

For more information on WebdriverIO see the homepage.

Similar packages

Other packages similar to @wdio/mocha-framework

jest

Jest is a delightful JavaScript Testing Framework with a focus on simplicity. It works out of the box with minimal configuration and provides a rich API for writing tests. Compared to @wdio/mocha-framework, Jest is more opinionated and comes with built-in mocking, assertion, and test coverage tools.

cypress

Cypress is a next-generation front-end testing tool built for the modern web. It provides a fast, easy, and reliable testing for anything that runs in a browser. Unlike @wdio/mocha-framework, Cypress is an all-in-one testing framework that includes everything you need to write, run, and debug tests.

nightwatch

Nightwatch.js is an integrated, easy-to-use End-to-End testing solution for browser-based apps and websites, written in Node.js. It uses the W3C WebDriver API to perform commands and assertions on DOM elements. Compared to @wdio/mocha-framework, Nightwatch provides a more integrated solution with built-in test runner and assertion library.