minitest-jsonapi 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 3a605159c706540c9fc0e55a01d43f681d6ff2248e0aa31548be02eff338a033
+  data.tar.gz: e904d11d84354254b9d74a18ba0f347371cb94bd1bc6f80cda94a3aa254790d9
+SHA512:
+  metadata.gz: 064fb0f5d15b40408986a66929591ec85658a5b1654deed6ee7970789446c91b1f6d006992253b97f58d63d205191c469272a0bf6d59bc518ceca41f34ff1691
+  data.tar.gz: 6764348523de1d95256090cbe57b30285a8c98b7631865849fc8a2e6b7420687482f54f0937df625057f9f5d4ef977612b31181fe1bb0046d7452daa8630d83d

data/README.md

@@ -0,0 +1,78 @@
+# Minitest::Jsonapi
+
+Sends JSON output for Minitest runs to console or to a specific URL via `POST` with a predefined API key and value.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'minitest-jsonapi', require: false
+```
+
+And then execute:
+
+	> bundle
+
+Or install it yourself as:
+
+	> gem install minitest-jsonapi
+
+## Usage
+
+### From terminal
+---
+
+To generate reports using Minitest::JsonApi, you'll need to pass `-J` or `--json` flag to Minitest on the command line.
+
+Following will produce the output on the terminal:
+
+	> ruby test/foo_test.rb -J
+
+Options to specify the URL and API keys & values:
+
+	> ruby test/foo_test.rb -J --addr=http://localhost:4567 --keyname=ABCD --keyvalue=EFGH
+
+To prettify the JSON for terminal output:
+
+	> ruby test/foo_test.rb -J --pretty
+
+All options are optional.
+
+All the options can be viewed by using `-h` for help:
+
+	> ruby test/foo_test.rb -h
+
+
+### From rakefile
+---
+
+You can set up a rake task to run all your tests by adding this to your Rakefile:
+
+```ruby
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+	t.options = '-J --addr=http://localhost:4567/ --keyname=ABCD --keyvalue=EFGH'
+	t.test_files = FileList["test/**/test_*.rb"]
+end
+
+task :default => :test
+```
+
+You can also switch on JSON output globally for every test run by putting the following in your test helper:
+
+```ruby
+Minitest::JsonApi.enable!
+```
+
+
+## Development
+
+This repository is a mirror of the public [fossil](https://fossil-scm.org) repository hosted at [fossil.abhij.it/repos/minitest-jsonapi](https://fossil.abhij.it/repos/minitest-jsonapi)
+
+No pull requests are accepted through this repository. Email mail@abhij.it to discuss features.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/minitest/jsonapi.rb

@@ -0,0 +1,4 @@
+require "minitest/jsonapi/version"
+require "minitest/jsonapi_plugin"
+
+Minitest.load_plugins

data/lib/minitest/jsonapi/version.rb

@@ -0,0 +1,5 @@
+module Minitest
+  module Jsonapi
+    VERSION = "1.2.0"
+  end
+end

data/lib/minitest/jsonapi_plugin.rb

@@ -0,0 +1,164 @@
+require 'uri'
+require 'net/http'
+require 'net/https'
+
+module Minitest
+	module JsonApi
+		class Reporter < Minitest::StatisticsReporter
+			attr_accessor :all_results, :addr, :apikeyname, :apikeyvalue, :pretty
+
+			def initialize(options = {})
+				super
+				self.all_results = []
+
+				self.addr = options[:addr]
+				self.apikeyname = options[:apikeyname]
+				self.apikeyvalue = options[:apikeyvalue]
+				self.pretty = options[:pretty] || false
+
+			end
+
+			def record(result)
+				super
+				all_results << result
+			end
+
+			def report
+				super
+
+				assertions = 0
+				skips = 0
+				errors = 0
+				fails = 0
+				passes = 0
+
+				results = all_results.collect do |result|
+					status = case result.failure
+					when Skip
+						skips += 1
+						:skip
+					when UnexpectedError
+						errors += 1
+						:error
+					when Assertion
+						fails += 1
+						:fail
+					else
+						passes += 1
+						:pass
+					end
+
+					assertions += result.assertions
+
+					result_hash = {
+						name: result.name,
+						status: status,
+						time: result.time,
+						assertions: result.assertions,
+						file: nil,
+						line: nil
+					}
+
+					if result.failure
+						result_hash.merge!({
+							file: result.source_location[0],
+							line: result.source_location[1]
+						})
+					end
+
+					result_hash
+
+				end
+
+				summary = {
+					tests: all_results.count,
+					assertions: assertions,
+					passes: passes,
+					fails: fails,
+					errors: errors,
+					skips: skips
+				}
+
+
+				full_result = {
+					summary: summary,
+					results: results
+				}
+
+				if addr.to_s.empty?
+					if self.pretty
+						io[:io].write(JSON.pretty_generate(full_result))
+					else
+						io[:io].write(JSON.dump(full_result))
+					end
+                else
+                    uri = URI.parse(self.addr)
+					header = {'Content-Type': 'text/json'}
+
+					if self.apikeyname and self.apikeyvalue
+						header[self.apikeyname] = apikeyvalue
+					end
+
+                    http = Net::HTTP.new(uri.host, uri.port)
+					request = Net::HTTP::Post.new(uri.request_uri, header)
+					request.body = full_result.to_json
+
+					http.use_ssl = true if uri.scheme == 'https'
+
+					begin
+						http.request request
+					rescue Exception => e
+						puts "ERROR - #{e.message}"
+					end
+                end
+
+			end
+		end
+
+	end
+end
+
+
+module Minitest
+	def self.plugin_jsonapi_init(options)
+		if JsonApi.enabled?
+			reporter.reporters << JsonApi::Reporter.new(options)
+		end
+	end
+
+	def self.plugin_jsonapi_options(opts, options)
+		description = "Generate JSON to send"
+		opts.on "-J", "--json", description do
+			JsonApi.enable!
+		end
+
+		opts.on "--pretty", 'pretty print (for terminal output)' do
+			options[:pretty] = true
+		end
+
+		opts.on "--addr [OPTIONAL]", String, "Full URL to send JSON to (http/https) .e.g https://api.com/test/results" do |url|
+			options[:addr] = url
+		end
+		opts.on "--keyname [OPTIONAL]", String, "API Key Name" do |apikeyname|
+			options[:apikeyname] = apikeyname
+		end
+		opts.on "--keyvalue [OPTIONAL]", String, "API Key Value" do |apikeyvalue|
+			options[:apikeyvalue] = apikeyvalue
+		end
+	end
+
+
+	module JsonApi
+		@@enabled = false
+
+		def self.enabled?
+			@@enabled
+		end
+
+		def self.enable!
+			@@enabled = true
+		end
+
+	end
+
+end

metadata

@@ -0,0 +1,105 @@
+--- !ruby/object:Gem::Specification
+name: minitest-jsonapi
+version: !ruby/object:Gem::Version
+  version: 1.2.0
+platform: ruby
+authors:
+- abhijit
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-08-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: For Minitest runs, show prettified JSON output on console or send to
+  an API
+email:
+- mail@abhij.it
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/minitest/jsonapi.rb
+- lib/minitest/jsonapi/version.rb
+- lib/minitest/jsonapi_plugin.rb
+homepage: https://fossil.abhij.it/repos/minitest-jsonapi
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.3
+signing_key: 
+specification_version: 4
+summary: Send JSON output to API for Minitest runs
+test_files: []