mocha-proshot

mocha-proshot

A reporter for mocha that takes a screenshot after each failed Protractor test. The filename will be derived from the name of the failed test.

Installation

npm install --save-dev mocha-proshot

Usage

Use the environment variable PROSHOT_DIR to specify the base directory for all screenshots.

Simply update your Protractor configuration file to set the screenshot path and specify mocha-proshot as your reporter:

'use strict';

process.env.PROSHOT_DIR = './reports/screenshots';

exports.config = {
	...
    framework: 'mocha',
    mochaOpts: {
        reporter: 'mocha-proshot'
    },
	...
};

You probably want to use mocha-multi to get your usual test reports alongside the screenshots:

'use strict';

process.env.PROSHOT_DIR = './reports/screenshots';
process.env.multi = 'spec=- mocha-proshot=-'; // See 'mocha-multi' for configuration details

exports.config = {
	...
    framework: 'mocha',
    mochaOpts: {
        reporter: 'mocha-multi'
    },
	...
};

Caveat: mocha-multi does not work together with Protractor's sharding feature because the latter depends on some internals of builtin mocha reporters that mocha-multi does not emulate. Use mocha-proshot directly if you depend on sharding. See issue #1 for details.