minitest-failure-reporter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6e1e7d1744ab09ea7c43e7b0917a86033a1221e2ba2363219fe5c40477db3e8f
+  data.tar.gz: fd4abe0fb346cbfbce80efbfa990f1c30b7904fa8747cc4bd7a7e089adc9cd28
+SHA512:
+  metadata.gz: c192329a14482959975d601c100107abcbfcaf2ef2f7198c29647368f640007d06cacfba82dd68970a610ab942526a84119df671f44a0e9659ade149e0a4abc4
+  data.tar.gz: 7a0ad5c78445975a264899f0a0ac00fa2a734b586a40187d9f26345d63ec0139a92767cfa24edc889afe3c75e99d188924a6f37243ef6ab6b5355e697062b3fa

data/.github/workflows/ruby.yml

@@ -0,0 +1,33 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@ec106b438a1ff6ff109590de34ddc62c540232e0
+      with:
+        ruby-version: 2.6
+    - name: Install dependencies
+      run: bundle install
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.byebug_history
+failure_file.json

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in minitest_failure-reporter.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,24 @@
+PATH
+  remote: .
+  specs:
+    minitest-failure-reporter (0.1.0)
+      minitest (~> 5.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (11.1.3)
+    minitest (5.14.1)
+    rake (12.3.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.1)
+  byebug
+  minitest-failure-reporter!
+  rake (~> 12.3)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 Frederik Dudzik
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,56 @@
+# Minitest::FailureReporter
+
+Generates a json file that includes test failures and is compatible with ci-queue's failure file.
+
+The format of the file looks as follows:
+
+```ruby
+[{
+  test_file: String,
+  test_line: Int,
+  test_and_module_name: String,
+  test_name: String,
+  test_suite: String,
+  error_class: String,
+  error_message: String,
+  output: String,
+}]
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'minitest_failure-reporter'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install minitest_failure-reporter
+
+## Usage
+
+```
+--failure-reporter # Generate a failure json report
+--failure-reporter-filename=OUT # Target output filename. Defaults to failure_file.json
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Shopify/minitest_failure-reporter.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "minitest_failure/reporter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dev.yml

@@ -0,0 +1,14 @@
+name: minitest-failure-reporter
+
+type: ruby
+
+up:
+  - ruby: 2.7.1
+  - bundler
+
+commands:
+  test:
+    syntax:
+      argument: file
+      optional: args...
+    run: rake

data/lib/minitest/failure_reporter/version.rb

@@ -0,0 +1,5 @@
+module Minitest
+  module FailureReporter
+    VERSION = "0.1.0"
+  end
+end

data/lib/minitest/failure_reporter_plugin.rb

@@ -0,0 +1,22 @@
+require "minitest/failure_reporter/version"
+require "minitest/failure_reporter_reporter"
+
+module Minitest
+  def self.plugin_failure_reporter_options(opts, options)
+    opts.on '--failure-reporter', 'Generate a failure json report' do
+      options[:failure_reporter] = true
+    end
+    opts.on '--failure-reporter-filename=OUT', 'Target output filename.'\
+                                    ' Defaults to failure_file.json' do |out|
+      options[:failure_reporter_filename] = out
+    end
+  end
+
+  def self.plugin_failure_reporter_init(options)
+    return unless options.delete :failure_reporter
+    file_klass = options.delete(:file_klass) || File
+    filename = options.delete(:failure_reporter_filename) || 'failure_file.json'
+    io = file_klass.new(filename, 'w')
+    reporter << FailureReporter::Reporter.new(io, options)
+  end
+end

data/lib/minitest/failure_reporter_reporter.rb

@@ -0,0 +1,67 @@
+require 'json'
+
+module Minitest
+  module FailureReporter
+    class Reporter
+      def initialize(io, options)
+        @io = io
+        @results = []
+        @options = options
+      end
+
+      def passed?
+        true
+      end
+
+      def start; end
+
+      def record(result)
+        if has_failures?(result)
+          @results << result
+        end
+      end
+
+      def report
+        failures = @results.map { |test| format(test) }.to_json
+        @io.puts(failures)
+      end
+
+      def format(test)
+        test_file, test_line = test.source_location
+        {
+          test_file: test_file,
+          test_line: test_line,
+          test_and_module_name: "#{test.klass}##{test.name}",
+          test_name: test.name,
+          test_suite: test.klass,
+          error_class: test.failure.exception.class.name,
+          error_message: full_error_message(test),
+          output: full_error_message(test),
+        }
+      end
+
+      private
+
+      def has_failures?(test)
+        !test.failures.empty? || test.error?
+      end
+
+      def full_error_message(test)
+        [message(test), *backtrace(test)].join("\n")
+      end
+
+      def message(test)
+        error = test.failure
+        if error.is_a?(UnexpectedError)
+          "#{error.exception.class}: #{error.exception.message}"
+        else
+          error.exception.message
+        end
+      end
+
+      def backtrace(test)
+        test.failure.backtrace.join("\n")
+      end
+    end
+  end
+end

data/minitest-failure_reporter.gemspec

@@ -0,0 +1,34 @@
+require_relative 'lib/minitest/failure_reporter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "minitest-failure-reporter"
+  spec.version       = Minitest::FailureReporter::VERSION
+  spec.authors       = ["Frederik Dudzik"]
+  spec.email         = ["frederik.dudzik@shopify.com"]
+
+  spec.summary       = "Writes a json file with all test failures to disk"
+  spec.description   = "Writes a json file with all test failures to disk"
+  spec.homepage      = "https://github.com/Shopify/minitest-failure_reporter"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'minitest', '~> 5.0'
+
+  spec.add_development_dependency("bundler", "~> 2.1")
+  spec.add_development_dependency("rake", "~> 12.3")
+  spec.add_development_dependency("byebug", "~> 11.1")
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: minitest-failure-reporter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Frederik Dudzik
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-07-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.3'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11.1'
+description: Writes a json file with all test failures to disk
+email:
+- frederik.dudzik@shopify.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- dev.yml
+- lib/minitest/failure_reporter/version.rb
+- lib/minitest/failure_reporter_plugin.rb
+- lib/minitest/failure_reporter_reporter.rb
+- minitest-failure_reporter.gemspec
+homepage: https://github.com/Shopify/minitest-failure_reporter
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/Shopify/minitest-failure_reporter
+  source_code_uri: https://github.com/Shopify/minitest-failure_reporter
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Writes a json file with all test failures to disk
+test_files: []