Using mocha programmatically

Mike Samuel edited this page May 16, 2018 · 32 revisions

There are a lot of reasons why you might want to automate running the tests using mocha. Using the command-line can run into some problems if you want to load specific files, for example.

Here is an example of using mocha programmatically:

var Mocha = require('mocha'),
    fs = require('fs'),
    path = require('path');

// Instantiate a Mocha instance.
var mocha = new Mocha();

var testDir = 'some/dir/test'

// Add each .js file to the mocha instance
fs.readdirSync(testDir).filter(function(file){
    // Only keep the .js files
    return file.substr(-3) === '.js';

}).forEach(function(file){
    mocha.addFile(
        path.join(testDir, file)
    );
});

// Run the tests.
mocha.run(function(failures){
  process.exitCode = failures ? -1 : 0;  // exit with non-zero status if there were failures
});

mocha.run() returns a Runner instance which emits many events of interest.

Note that run (via loadFiles, which it calls) relies on Node's require to execute the test interface functions. Thus, files loaded by mocha will be stored in Node's require cache and therefore tests in these files will not be re-run if mocha.run() is called again. If you want to run tests multiple times, you may need to clear Node's require cache before subsequent calls in whichever manner best suits your needs.

Set options

There are two ways to set the options to run the tests.

Firstly, you can set these options in the constructor object:

var mocha = new Mocha({
    ui: 'tdd',
    reporter: 'list'
});

Here is the list of these options:

  • grep
  • ui
  • reporter
  • timeout
  • bail
  • useColors
  • retries
  • slow
  • ignoreLeaks
  • fullTrace

Secondly, on the mocha object, there are some chainable methods allowing you to change some more options.

Here is an example:

// Change the reporter to "list" before running the tests
mocha.reporter('list').run();

// Change the UI to "tdd" before running the tests
mocha.ui('tdd').run();

// Or do both changes before running the tests
mocha.reporter('list').ui('tdd').run();

Here is the list of all these chainable methods:

  • reporter(): set the reporter.
  • ui(): set the ui.
  • grep(): add regex to grep. Unlike the command line parameter, grep() requires a RegExp() object for regular expressions. Everything else is escaped.
  • invert(): invert the grep.
  • ignoreLeaks(): ignore global leaks.
  • growl(): enable growl support.
  • globals(): ignore globals.
You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.