Minitest::Reporters::JsonReporter

This is an extension gem for the minitest-reporters gem. It adds JSON output as an output format. You can use this gem to interface Minitest output into automated tools like CI, CD or IDEs or code editors. An example interface might be to the Atom editor: https://atom.io I originally wrote this gem to interface to the Viper audible code editor for the blind community. See: https://github.com/edhowland/viper

Version 0.2.0

Installation

Add this line to your application's Gemfile:

gem 'minitest-reporters-json_reporter'

And then execute:

$ bundle

Or install it yourself as:

$ gem install minitest-reporters-json_reporter

Usage

Add this line to your 'spec_helper.rb' or 'test_helper.rb':

require 'minitest/reporters/json_reporter'

In that same file, add something like this near the bottom of the file:

Minitest::Reporters.use! [ Minitest::Reporters::JsonReporter.new ]

Then run your tests as normal. You will get a JSON formatted string in stdout.

There are 5 or 6 objects contained within this output: The 6th object: passes is only included if the --verbose option was passed to the test or set in the options parameter to the constructor.

1. status - Status of the overall test run. Can be 'Success', 'Passed with skipped tests' or 'Failed'. There also a color attribute: green, yellow or red - respectfully.
2. metadata - General information about this test run. Includes generator name, version and the test run completion time in UTC formatted in ISO8601 format. Also include options object computed by super classes including command line arguments.
3. statistics - Contains counts of the status of test cases. Includes: Total, Skipped, Failed Errored and Passed.
4. fails - Array of failed or errored tests. Each object herein contains the information of each test, its name, class, error message and location of the test and the filtered backtrace array if an error type.
5. skips - Array of each skipped. Each object contains the information as a failed test, including the skip message, if any.
6. passes - Array of passing tests if the --verbose option was set . This object is normally absent otherwise.

Here is a sample output:

# Use jq to pretty print the JSON output
$  cd test/functional/
$ ruby report_spec.rb  --verbose | jq .
{
  "status": {
    "code": "Failed",
    "color": "red"
  },
  "metadata": {
    "generated_by": "Minitest::Reporters::JsonReporter",
    "version": "0.2.0",
    "time": "2016-04-21T19:09:34Z",
    "options": {
      "io": "STDOUT",
      "seed": 2579,
      "args": "--seed 2579"
    }
  },
  "statistics": {
    "total": 5,
    "failed": 2,
    "errored": 1,
    "skipped": 1,
    "passed": 1
  },
  "fails": [
    {
      "type": "failure",
      "class": "failure",
      "name": "test_0001_anonymous",
      "message": "Expected: 2\n  Actual: 1",
      "location": "report_spec.rb:14"
    },
    {
      "type": "failure",
      "class": "second failure",
      "name": "test_0001_anonymous",
      "message": "Expected: 9\n  Actual: 3",
      "location": "report_spec.rb:20"
    },
    {
      "type": "error",
      "class": "Error",
      "name": "test_0001_anonymous",
      "message": "RuntimeError: should fail\n    report_spec.rb:6:in `block (2 levels) in <main>'",
      "location": "report_spec.rb:6",
      "backtrace": [
        "report_spec.rb:6:in `block (2 levels) in <main>'"
      ]
    }
  ],
  "skips": [
    {
      "type": "skipped",
      "class": "skipped test",
      "name": "test_0001_anonymous",
      "message": "what a layabout",
      "location": "report_spec.rb:32"
    }
  ]
}

Contributing

1. Fork it ( https://github.com/edhowland/minitest-reporters-json_reporter/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

Note: Extra credit if git flow feature branching was used.