123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498 |
- 'use strict';
- /**
- * Module dependencies.
- */
- var tty = require('tty');
- var diff = require('diff');
- var ms = require('../ms');
- var utils = require('../utils');
- var supportsColor = process.browser ? null : require('supports-color');
- /**
- * Expose `Base`.
- */
- exports = module.exports = Base;
- /**
- * Save timer references to avoid Sinon interfering.
- * See: https://github.com/mochajs/mocha/issues/237
- */
- /* eslint-disable no-unused-vars, no-native-reassign */
- var Date = global.Date;
- var setTimeout = global.setTimeout;
- var setInterval = global.setInterval;
- var clearTimeout = global.clearTimeout;
- var clearInterval = global.clearInterval;
- /* eslint-enable no-unused-vars, no-native-reassign */
- /**
- * Check if both stdio streams are associated with a tty.
- */
- var isatty = tty.isatty(1) && tty.isatty(2);
- /**
- * Enable coloring by default, except in the browser interface.
- */
- exports.useColors = !process.browser && (supportsColor || (process.env.MOCHA_COLORS !== undefined));
- /**
- * Inline diffs instead of +/-
- */
- exports.inlineDiffs = false;
- /**
- * Default color map.
- */
- exports.colors = {
- pass: 90,
- fail: 31,
- 'bright pass': 92,
- 'bright fail': 91,
- 'bright yellow': 93,
- pending: 36,
- suite: 0,
- 'error title': 0,
- 'error message': 31,
- 'error stack': 90,
- checkmark: 32,
- fast: 90,
- medium: 33,
- slow: 31,
- green: 32,
- light: 90,
- 'diff gutter': 90,
- 'diff added': 32,
- 'diff removed': 31
- };
- /**
- * Default symbol map.
- */
- exports.symbols = {
- ok: '✓',
- err: '✖',
- dot: '․',
- comma: ',',
- bang: '!'
- };
- // With node.js on Windows: use symbols available in terminal default fonts
- if (process.platform === 'win32') {
- exports.symbols.ok = '\u221A';
- exports.symbols.err = '\u00D7';
- exports.symbols.dot = '.';
- }
- /**
- * Color `str` with the given `type`,
- * allowing colors to be disabled,
- * as well as user-defined color
- * schemes.
- *
- * @param {string} type
- * @param {string} str
- * @return {string}
- * @api private
- */
- var color = exports.color = function (type, str) {
- if (!exports.useColors) {
- return String(str);
- }
- return '\u001b[' + exports.colors[type] + 'm' + str + '\u001b[0m';
- };
- /**
- * Expose term window size, with some defaults for when stderr is not a tty.
- */
- exports.window = {
- width: 75
- };
- if (isatty) {
- exports.window.width = process.stdout.getWindowSize
- ? process.stdout.getWindowSize(1)[0]
- : tty.getWindowSize()[1];
- }
- /**
- * Expose some basic cursor interactions that are common among reporters.
- */
- exports.cursor = {
- hide: function () {
- isatty && process.stdout.write('\u001b[?25l');
- },
- show: function () {
- isatty && process.stdout.write('\u001b[?25h');
- },
- deleteLine: function () {
- isatty && process.stdout.write('\u001b[2K');
- },
- beginningOfLine: function () {
- isatty && process.stdout.write('\u001b[0G');
- },
- CR: function () {
- if (isatty) {
- exports.cursor.deleteLine();
- exports.cursor.beginningOfLine();
- } else {
- process.stdout.write('\r');
- }
- }
- };
- function showDiff (err) {
- return err && err.showDiff !== false && sameType(err.actual, err.expected) && err.expected !== undefined;
- }
- function stringifyDiffObjs (err) {
- if (!utils.isString(err.actual) || !utils.isString(err.expected)) {
- err.actual = utils.stringify(err.actual);
- err.expected = utils.stringify(err.expected);
- }
- }
- /**
- * Output the given `failures` as a list.
- *
- * @param {Array} failures
- * @api public
- */
- exports.list = function (failures) {
- console.log();
- failures.forEach(function (test, i) {
- // format
- var fmt = color('error title', ' %s) %s:\n') +
- color('error message', ' %s') +
- color('error stack', '\n%s\n');
- // msg
- var msg;
- var err = test.err;
- var message;
- if (err.message && typeof err.message.toString === 'function') {
- message = err.message + '';
- } else if (typeof err.inspect === 'function') {
- message = err.inspect() + '';
- } else {
- message = '';
- }
- var stack = err.stack || message;
- var index = message ? stack.indexOf(message) : -1;
- if (index === -1) {
- msg = message;
- } else {
- index += message.length;
- msg = stack.slice(0, index);
- // remove msg from stack
- stack = stack.slice(index + 1);
- }
- // uncaught
- if (err.uncaught) {
- msg = 'Uncaught ' + msg;
- }
- // explicitly show diff
- <<<<<<< HEAD
- if (showDiff(err)) {
- stringifyDiffObjs(err);
- =======
- if (exports.hideDiff !== true && err.showDiff !== false && sameType(actual, expected) && expected !== undefined) {
- escape = false;
- if (!(utils.isString(actual) && utils.isString(expected))) {
- err.actual = actual = utils.stringify(actual);
- err.expected = expected = utils.stringify(expected);
- }
- >>>>>>> Add --no-diff option (fixes mochajs/mocha#2514)
- fmt = color('error title', ' %s) %s:\n%s') + color('error stack', '\n%s\n');
- var match = message.match(/^([^:]+): expected/);
- msg = '\n ' + color('error message', match ? match[1] : msg);
- if (exports.inlineDiffs) {
- msg += inlineDiff(err);
- } else {
- msg += unifiedDiff(err);
- }
- }
- // indent stack trace
- stack = stack.replace(/^/gm, ' ');
- // indented test title
- var testTitle = '';
- test.titlePath().forEach(function (str, index) {
- if (index !== 0) {
- testTitle += '\n ';
- }
- for (var i = 0; i < index; i++) {
- testTitle += ' ';
- }
- testTitle += str;
- });
- console.log(fmt, (i + 1), testTitle, msg, stack);
- });
- };
- /**
- * Initialize a new `Base` reporter.
- *
- * All other reporters generally
- * inherit from this reporter, providing
- * stats such as test duration, number
- * of tests passed / failed etc.
- *
- * @param {Runner} runner
- * @api public
- */
- function Base (runner) {
- var stats = this.stats = { suites: 0, tests: 0, passes: 0, pending: 0, failures: 0 };
- var failures = this.failures = [];
- if (!runner) {
- return;
- }
- this.runner = runner;
- runner.stats = stats;
- runner.on('start', function () {
- stats.start = new Date();
- });
- runner.on('suite', function (suite) {
- stats.suites = stats.suites || 0;
- suite.root || stats.suites++;
- });
- runner.on('test end', function () {
- stats.tests = stats.tests || 0;
- stats.tests++;
- });
- runner.on('pass', function (test) {
- stats.passes = stats.passes || 0;
- if (test.duration > test.slow()) {
- test.speed = 'slow';
- } else if (test.duration > test.slow() / 2) {
- test.speed = 'medium';
- } else {
- test.speed = 'fast';
- }
- stats.passes++;
- });
- runner.on('fail', function (test, err) {
- stats.failures = stats.failures || 0;
- stats.failures++;
- if (showDiff(err)) {
- stringifyDiffObjs(err);
- }
- test.err = err;
- failures.push(test);
- });
- runner.on('end', function () {
- stats.end = new Date();
- stats.duration = new Date() - stats.start;
- });
- runner.on('pending', function () {
- stats.pending++;
- });
- }
- /**
- * Output common epilogue used by many of
- * the bundled reporters.
- *
- * @api public
- */
- Base.prototype.epilogue = function () {
- var stats = this.stats;
- var fmt;
- console.log();
- // passes
- fmt = color('bright pass', ' ') +
- color('green', ' %d passing') +
- color('light', ' (%s)');
- console.log(fmt,
- stats.passes || 0,
- ms(stats.duration));
- // pending
- if (stats.pending) {
- fmt = color('pending', ' ') +
- color('pending', ' %d pending');
- console.log(fmt, stats.pending);
- }
- // failures
- if (stats.failures) {
- fmt = color('fail', ' %d failing');
- console.log(fmt, stats.failures);
- Base.list(this.failures);
- console.log();
- }
- console.log();
- };
- /**
- * Pad the given `str` to `len`.
- *
- * @api private
- * @param {string} str
- * @param {string} len
- * @return {string}
- */
- function pad (str, len) {
- str = String(str);
- return Array(len - str.length + 1).join(' ') + str;
- }
- /**
- * Returns an inline diff between 2 strings with coloured ANSI output
- *
- * @api private
- * @param {Error} err with actual/expected
- * @return {string} Diff
- */
- function inlineDiff (err) {
- var msg = errorDiff(err);
- // linenos
- var lines = msg.split('\n');
- if (lines.length > 4) {
- var width = String(lines.length).length;
- msg = lines.map(function (str, i) {
- return pad(++i, width) + ' |' + ' ' + str;
- }).join('\n');
- }
- // legend
- msg = '\n' +
- color('diff removed', 'actual') +
- ' ' +
- color('diff added', 'expected') +
- '\n\n' +
- msg +
- '\n';
- // indent
- msg = msg.replace(/^/gm, ' ');
- return msg;
- }
- /**
- * Returns a unified diff between two strings.
- *
- * @api private
- * @param {Error} err with actual/expected
- * @return {string} The diff.
- */
- function unifiedDiff (err) {
- var indent = ' ';
- function cleanUp (line) {
- if (line[0] === '+') {
- return indent + colorLines('diff added', line);
- }
- if (line[0] === '-') {
- return indent + colorLines('diff removed', line);
- }
- if (line.match(/@@/)) {
- return '--';
- }
- if (line.match(/\\ No newline/)) {
- return null;
- }
- return indent + line;
- }
- function notBlank (line) {
- return typeof line !== 'undefined' && line !== null;
- }
- var msg = diff.createPatch('string', err.actual, err.expected);
- var lines = msg.split('\n').splice(5);
- return '\n ' +
- colorLines('diff added', '+ expected') + ' ' +
- colorLines('diff removed', '- actual') +
- '\n\n' +
- lines.map(cleanUp).filter(notBlank).join('\n');
- }
- /**
- * Return a character diff for `err`.
- *
- * @api private
- * @param {Error} err
- * @return {string}
- */
- function errorDiff (err) {
- return diff.diffWordsWithSpace(err.actual, err.expected).map(function (str) {
- if (str.added) {
- return colorLines('diff added', str.value);
- }
- if (str.removed) {
- return colorLines('diff removed', str.value);
- }
- return str.value;
- }).join('');
- }
- /**
- * Color lines for `str`, using the color `name`.
- *
- * @api private
- * @param {string} name
- * @param {string} str
- * @return {string}
- */
- function colorLines (name, str) {
- return str.split('\n').map(function (str) {
- return color(name, str);
- }).join('\n');
- }
- /**
- * Object#toString reference.
- */
- var objToString = Object.prototype.toString;
- /**
- * Check that a / b have the same type.
- *
- * @api private
- * @param {Object} a
- * @param {Object} b
- * @return {boolean}
- */
- function sameType (a, b) {
- return objToString.call(a) === objToString.call(b);
- }
|