minitest-reporters-json_reporter 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94a1de8a674e4127f623f886a6ba0643726d5d86
-  data.tar.gz: 678bd26a89e8565ec5f1892fbf9d1c8ab65db7c7
+  metadata.gz: f5f134ca33ed222b123711da89d4d1a11e7e028a
+  data.tar.gz: fc6d7d916c7798d6e091232c382be1a439f31680
 SHA512:
-  metadata.gz: 32264e3865b0e4a3c287e96ab466d070c105e081e46847834c8c793062eae47cf45c715630d4fdca7895ec9c80688f0dbac190a186144b3d256c4774bbf5f3e7
-  data.tar.gz: a43bfb4e853845f1695b13c7877ef0020df3a0ea37bf8908704170c7d2fea69499b56f1ae560b0197afc8df4fc8136bfdc6006b8ed597a41e8a74af655140623
+  metadata.gz: 47bcd68180b082db1ba5549fc14929faa540052128b792d6d1673d663cd45e2d245e9bf598962b1645bc09456c7c17b384d4f24f879b986380d76f0fcf4c8069
+  data.tar.gz: b3c875b539c0c087ae6f7bb90adc4ebeddb77d7b8efaa38578f4d9ac660765aa09ccbc5ce870eeb4fc3119ea9bb4be608009103f28998f354b743208ecb216ab

data/.gitignore

@@ -3,7 +3,6 @@
 /Gemfile.lock
 /_yardoc/
 /coverage/
-/doc/
 /pkg/
 /spec/reports/
 /tmp/

data/.rubocop.yml

@@ -2,14 +2,21 @@
 Metrics/LineLength:
   Max: 85
   Exclude:
+    - 'test/**/*'
     - 'minitest-reporters-json_reporter.gemspec'
 
 Style/Documentation:
   Exclude:
     - 'spec/**/*'
     - 'test/**/*'
-#Style/Semicolon:
-#  Exclude:
+Style/Semicolon:
+  Exclude:
+    - 'test/**/*'
 #    - 'lib/minitest/reporters/json_reporter.rb'
+
 Metrics/ClassLength:
   Max: 120
+
+Style/GlobalVars:
+  Exclude:
+    - 'test/**/*'

data/Announcement.txt

@@ -0,0 +1,131 @@
+minitest-reporters-json_reporter version 0.2.0 has been released.
+
+Home, Code: https://github.com/edhowland/minitest-reporters-json_reporter
+Bugs: https://github.com/edhowland/minitest-reporters-json_reporter/issues
+Docs:https://github.com/edhowland/minitest-reporters-json_reporter/blob/master/doc/index.html
+
+minitest-reporters-json_reporter is an extension to the Ruby minitest-reporters gem that provides JSON output from your Minitest or MiniSpec test run.
+
+This version is the preliminary version before doing a PR to the mainline Minitest::Reporters gem.
+It includes a normal unit test in the test folder of the source repository.
+It also includes a customizable output file destination: test/report/json_report.json, some other file or stdout.
+It also includes the passed tests if the --verbose flag is passed.
+It also embeds the backtrace for error fails.
+It also adds parsed command line options to the metadata object.
+
+Abstract
+
+JSON has become the lingua franca of interprogram communications. There are several  very good output formats
+for Minitest, but no JSON format until now. If you want to hook up an IDE or some other automatic
+framework like a CI or CD tool, it is natural to send output in some parsable format like XML or JSON. This extension summarizes the result of
+a test run in  format like JSON.a test run in an easible consumable format.
+
+Anti-features:
+
+This version does not include any timing statistics.
+However, you can subclass Minitest::Reporters::JsonReporter and add to the storage accessor any object. This is just a Hash.
+ The class is derived from Minitest::StatisticsReporter wherin you can get this detail.
+
+Usage is very simple. Just require 'minitest/reporters/json_reporter' in your test_helper.rb or spec_helper.rb.
+This gem also depends on 'minitest' and 'minitest/reporters'.  Then, you should also invoke the use! method of Minitest::Reporters class with a call to Minitest::Reporters::JsonReporter.new. 
+Here is an example test_helper.rb:
+# ... Other requires
+
+require 'minitest/reporters/json_reporter'
+require 'minitest/autorun'
+
+Minitest::Reporters.use! [Minitest::Reporters::JsonReporter.new]
+# ...
+# End of test_helper.rb
+
+Here is the URLs for the dependent gems:
+
+minitest (5.7.0, 5.4.3) : https://rubygems.org/gems/minitest
+minitest-reporters (1.1.8) : https://rubygems.org/gems/minitest-reporters
+
+The JSON format is sent to stdout when you run a test or all tests.
+There are 5 (or 6)  objects contained within this output:
+The 6th object : passes is only present when --verbose or the options[:verbose] is supplied.
+
+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. This also include the parsed command line in the options object.
+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. Tests that generate an error also contain the filter backtrace.
+5. skips - Array of each skipped. Each object contains the information as a failed test, including the skip message, if any.
+6. passes: (Optional: if --verbose is passed to the test): Class name, name and location of the passed test.
+
+Here is a sample test run:
+# Pretty up JSON output with jq
+$ cd test/functional
+$ ruby report_spec.rb   | 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"
+    }
+  ]
+}
+
+You can use JSON parsing tools to get elements or subsets of this format. One such tool is JQ: https://stedolan.github.io/jq/
+
+Here is how you might view only the color of the test:
+
+$ ruby blog_test.rb  | jq -r .status.color
+green
+
+If you find this gem useful, please send me a note about how you are using it.
+I would be interested if you are hooking it up to an automated framework like CI, CD or a code editor or IDE.
+Thanks, Ed
+
+Author: Ed Howland email: ed.howland@gmail.com

data/README.md

@@ -1,12 +1,11 @@
 # 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 or IDEs or programmer's editors. An
+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](https://atom.io)
-I originally wrote this gem to interface to the Viper audible  Programmer's editor for the blind programmer community. See: [https://github.com/edhowland/viper](https://github.com/edhowland/viper)
-
-## Version 0.1.1
+I originally wrote this gem to interface to the Viper audible  code editor for the blind community. See: [https://github.com/edhowland/viper](https://github.com/edhowland/viper)
 
+## Version 0.2.0
 
 
 ## Installation
@@ -36,17 +35,86 @@ 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 ]
+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 objects contained within this output:
 
-1. metadata - General information about this test run. Includes generator name, version and the test run completion time in UTC formatted in ISO8601 format.
-2. 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.
+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.
+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
@@ -56,3 +124,6 @@ There are 5 objects contained within this output:
 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.
+

data/Rakefile

@@ -1 +1,12 @@
+# Rakefile - tasks for minitest-reporters-json_reporter gem
 require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.pattern = './test/*_spec.rb'
+end
+
+task :yard do
+  sh 'yardoc -o ./doc'
+end

data/doc/Minitest.html

@@ -0,0 +1,126 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Module: MiniTest
+  
+    &mdash; Documentation by YARD 0.8.7.6
+  
+</title>
+
+  <link rel="stylesheet" href="css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '';
+  framesUrl = "frames.html#!MiniTest.html";
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+  
+    <a href="_index.html">Index (M)</a> &raquo;
+    
+    
+    <span class="title">MiniTest</span>
+  
+
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="class_list.html">
+      Class List
+    </a>
+  
+    <a class="full_list_link" id="method_list_link"
+        href="method_list.html">
+      Method List
+    </a>
+  
+    <a class="full_list_link" id="file_list_link"
+        href="file_list.html">
+      File List
+    </a>
+  
+</div>
+      <div class="clear"></div>
+    </div>
+
+    <iframe id="search_frame"></iframe>
+
+    <div id="content"><h1>Module: MiniTest
+  
+  
+  
+</h1>
+
+<dl class="box">
+  
+  
+    
+  
+    
+  
+  
+  
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/minitest/reporters/json_reporter/skip_detail.rb</dd>
+  
+</dl>
+<div class="clear"></div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p>MiniTest Namespace for all things Minitest</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><h2>Defined Under Namespace</h2>
+<p class="children">
+  
+    
+      <strong class="modules">Modules:</strong> <span class='object_link'><a href="MiniTest/Reporters.html" title="MiniTest::Reporters (module)">Reporters</a></span>
+    
+  
+    
+  
+</p>
+
+
+
+
+
+
+
+
+
+</div>
+
+    <div id="footer">
+  Generated on Thu Apr 21 20:48:52 2016 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.6 (ruby-2.2.2).
+</div>
+
+  </body>
+</html>

data/doc/Minitest/Reporters.html

@@ -0,0 +1,126 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+  <head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
+<title>
+  Module: MiniTest::Reporters
+  
+    &mdash; Documentation by YARD 0.8.7.6
+  
+</title>
+
+  <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
+
+  <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
+
+<script type="text/javascript" charset="utf-8">
+  hasFrames = window.top.frames.main ? true : false;
+  relpath = '../';
+  framesUrl = "../frames.html#!MiniTest/Reporters.html";
+</script>
+
+
+  <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
+
+  <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
+
+
+  </head>
+  <body>
+    <div id="header">
+      <div id="menu">
+  
+    <a href="../_index.html">Index (R)</a> &raquo;
+    <span class='title'><span class='object_link'><a href="../MiniTest.html" title="MiniTest (module)">MiniTest</a></span></span>
+     &raquo; 
+    <span class="title">Reporters</span>
+  
+
+  <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
+</div>
+
+      <div id="search">
+  
+    <a class="full_list_link" id="class_list_link"
+        href="../class_list.html">
+      Class List
+    </a>
+  
+    <a class="full_list_link" id="method_list_link"
+        href="../method_list.html">
+      Method List
+    </a>
+  
+    <a class="full_list_link" id="file_list_link"
+        href="../file_list.html">
+      File List
+    </a>
+  
+</div>
+      <div class="clear"></div>
+    </div>
+
+    <iframe id="search_frame"></iframe>
+
+    <div id="content"><h1>Module: MiniTest::Reporters
+  
+  
+  
+</h1>
+
+<dl class="box">
+  
+  
+    
+  
+    
+  
+  
+  
+    <dt class="r1 last">Defined in:</dt>
+    <dd class="r1 last">lib/minitest/reporters/json_reporter/skip_detail.rb</dd>
+  
+</dl>
+<div class="clear"></div>
+
+<h2>Overview</h2><div class="docstring">
+  <div class="discussion">
+    
+<p>Reporters - Extensible reporting framework for Minitest</p>
+
+
+  </div>
+</div>
+<div class="tags">
+  
+
+</div><h2>Defined Under Namespace</h2>
+<p class="children">
+  
+    
+  
+    
+      <strong class="classes">Classes:</strong> <span class='object_link'><a href="Reporters/SkipDetail.html" title="MiniTest::Reporters::SkipDetail (class)">SkipDetail</a></span>
+    
+  
+</p>
+
+
+
+
+
+
+
+
+
+</div>
+
+    <div id="footer">
+  Generated on Thu Apr 21 20:48:52 2016 by
+  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
+  0.8.7.6 (ruby-2.2.2).
+</div>
+
+  </body>
+</html>