Mocha.js JSON Serialize Reporter

☕️ A comprehensive JSON reporter for Mocha.js ☕️

Output can be used with mocha-json-runner to "replay" test results using another mocha reporter.

Differs from the built-in Mocha JSON reporter:

• includes suite level details
• includes nearly all internal details about tests and suites

Usage

1. Add to your project: npm install --save-dev mocha-json-serialize-reporter or globally: npm install --global mocha-json-serialize-reporter

2. Tell mocha to use it: mocha test_file.js --reporter mocha-json-serialize-reporter

3. If using mocha programmatically:

var mocha = new Mocha({
  reporter: 'mocha-json-serialize-reporter',
});

Running in Browser

See browser-test-console.html and browser-test-div.html for examples.

Options

• stats [boolean] [default: true] include stats in output.
• space [number] [default: 2] JSON.stringify space parameter.
• replacer [Function] [default: null] JSON.stringify replacer function. This is only usable programmatically, not via command line.
• callback [Function] [default: null] Function called with JSON results after mocha completes. If specified results will not be output to stdout. This is only usable programmatically or in browser, not via command line.

Example:

mocha testfile.js --reporter mocha-json-serialize-reporter -O stats=false -O space=0

Output

{
  "stats": {
    "suites": 1,
    "tests": 4,
    "passes": 2,
    "pending": 1,
    "failures": 1,
    "start": "2019-12-22T18:44:52.229Z",
    "end": "2019-12-22T18:44:52.233Z",
    "duration": 4
  },
  "suite": {
    "title": "",
    "pending": false,
    "root": true,
    "timeout": 2000,
    "slow": 75,
    "retries": -1,
    "tests": [
      {
        "title": "passing test in the root suite",
        "body": "function() {}",
        "timedOut": false,
        "pending": false,
        "type": "test",
        "file": "/fixtures/mocha-test-simple.fixture.js",
        "duration": 0,
        "state": "passed",
        "speed": "fast",
        "timeout": 2000,
        "slow": 75,
        "retries": -1,
        "currentRetry": 0
      }
    ],
    "suites": [
      {
        "title": "suite one",
        "pending": false,
        "root": false,
        "file": "/fixtures/mocha-test-simple.fixture.js",
        "timeout": 2000,
        "slow": 75,
        "retries": -1,
        "tests": [
          {
            "title": "passing test",
            "body": "function() {}",
            "timedOut": false,
            "pending": false,
            "type": "test",
            "file": "/fixtures/mocha-test-simple.fixture.js",
            "duration": 0,
            "state": "passed",
            "speed": "fast",
            "timeout": 2000,
            "slow": 75,
            "retries": -1,
            "currentRetry": 0
          },
          {
            "title": "failing test",
            "body": "function() {\n    throw new Error('FAIL');\n  }",
            "timedOut": false,
            "pending": false,
            "type": "test",
            "file": "/fixtures/mocha-test-simple.fixture.js",
            "duration": 0,
            "state": "failed",
            "timeout": 2000,
            "slow": 75,
            "retries": -1,
            "currentRetry": 0,
            "err": {
              "stack": "Error: FAIL\n    at Context.<anonymous> (test/fixtures/mocha-test-simple.fixture.js:7:11)\n    at processImmediate (internal/timers.js:439:21)",
              "message": "FAIL",
              "constructorName": "Error"
            }
          },
          {
            "title": "skipped test",
            "body": "function() {\n    this.skip();\n  }",
            "timedOut": false,
            "pending": true,
            "type": "test",
            "file": "/fixtures/mocha-test-simple.fixture.js",
            "duration": 0,
            "timeout": 2000,
            "slow": 75,
            "retries": -1,
            "currentRetry": 0
          }
        ]
      }
    ]
  }
}

License

MIT