summaryrefslogtreecommitdiffstats
path: root/remote/test/puppeteer/json-mocha-reporter.js
blob: 47fc74a9c5a4b859e7e3be8ec7f509da0c924f92 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
const mocha = require('mocha');
module.exports = JSONExtra;

const constants = mocha.Runner.constants;

/*

This is a copy of
https://github.com/mochajs/mocha/blob/master/lib/reporters/json-stream.js
with more event hooks. mocha does not support extending reporters or using
multiple reporters so a custom reporter is needed and it must be local
to the project.

*/

function JSONExtra(runner, options) {
  mocha.reporters.Base.call(this, runner, options);
  const self = this;

  runner.once(constants.EVENT_RUN_BEGIN, function () {
    writeEvent(['start', { total: runner.total }]);
  });

  runner.on(constants.EVENT_TEST_PASS, function (test) {
    writeEvent(['pass', clean(test)]);
  });

  runner.on(constants.EVENT_TEST_FAIL, function (test, err) {
    test = clean(test);
    test.err = err.message;
    test.stack = err.stack || null;
    writeEvent(['fail', test]);
  });

  runner.once(constants.EVENT_RUN_END, function () {
    writeEvent(['end', self.stats]);
  });

  runner.on(constants.EVENT_TEST_BEGIN, function (test) {
    writeEvent(['test-start', clean(test)]);
  });

  runner.on(constants.EVENT_TEST_PENDING, function (test) {
    writeEvent(['pending', clean(test)]);
  });
}

function writeEvent(event) {
  process.stdout.write(JSON.stringify(event) + '\n');
}

/**
 * Returns an object literal representation of `test`
 * free of cyclic properties, etc.
 *
 * @private
 * @param {Object} test - Instance used as data source.
 * @return {Object} object containing pared-down test instance data
 */
function clean(test) {
  return {
    title: test.title,
    fullTitle: test.fullTitle(),
    file: test.file,
    duration: test.duration,
    currentRetry: test.currentRetry(),
  };
}