minitest-rerun-failed 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2b20ea10693d44179e02baffbbc4138190df565c4a03c8d5ae53f0a933407415
+  data.tar.gz: 00136a77f31014f04d110bd21651feb2da893529bbd45b7e31302e98c2896268
+SHA512:
+  metadata.gz: 98c5ea06f7777e1ba131f46d6c16397b474e980f368074dae65dd30b6832487dceb4b03fa34ae9e12d582e76ff3735c504998101956ba9b72f45097c7d34940c
+  data.tar.gz: 46df4fdc85e2f5bc26a6dd078eb81e98d2886cabf4cd664e5bd9d194fd2570949dbde729bb3778dbd8c4f1e5d662d86481756778e1a0bc8b02c425244fcba650

data/.github/workflows/main.yml

@@ -0,0 +1,16 @@
+name: Master
+
+on: [push,pull_request]
+
+jobs:
+  rake_test:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.1
+        bundler-cache: true
+    - name: Run rake test
+      run: bundle exec rake test

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+/test_output/
+.minitest_failed_tests.txt

data/.rubocop.yml

@@ -0,0 +1,24 @@
+AllCops:
+  TargetRubyVersion: 2.7
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Enabled: true
+  Max: 200
+
+Metrics/MethodLength:
+  Enabled: false
+
+Metrics/AbcSize:
+  Max: 19
+
+Style/ConditionalAssignment:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-09-09
+
+- Initial release

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in minitest_rerun_failed.gemspec
+gemspec
+
+gem "minitest"
+gem "minitest-reporters"
+gem "rake"
+gem "rubocop"
+gem "rubocop-minitest"
+gem "rubocop-rake"

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    minitest-rerun-failed (0.1.3)
+      minitest (~> 5.14.4)
+      minitest-reporters (~> 1.4.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ansi (1.5.0)
+    ast (2.4.2)
+    builder (3.2.4)
+    minitest (5.14.4)
+    minitest-reporters (1.4.3)
+      ansi
+      builder
+      minitest (>= 5.0)
+      ruby-progressbar
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rubocop (1.20.0)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.9.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.11.0)
+      parser (>= 3.0.1.1)
+    rubocop-minitest (0.15.0)
+      rubocop (>= 0.90, < 2.0)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.0.0)
+
+PLATFORMS
+  x86_64-darwin-19
+  x86_64-linux
+
+DEPENDENCIES
+  minitest
+  minitest-reporters
+  minitest-rerun-failed!
+  rake
+  rubocop
+  rubocop-minitest
+  rubocop-rake
+
+BUNDLED WITH
+   2.2.18

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Søren Houen
+
+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,78 @@
+# minitest-rerun-failed
+![master branch CI](https://github.com/houen/minitest-rerun-failed/actions/workflows/main.yml/badge.svg?branch=master)
+
+Easy rerun of failed tests with minitest.
+
+![Example screenshot](assets/screenshot.png)
+
+## Goals
+- Outputs all failed tests in short summary at end of test run.
+  - To console and / or to file
+  - Optionally includes line numbers
+- Lists seed of run for rerun.
+- [TODO] Executable for running only failed tests
+  - Until then, use something like 
+    - `ruby $(cat .minitest_failed_tests.txt)`
+    - `bundle exec rails test $(cat .minitest_failed_tests.txt)`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'minitest_rerun_failed'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install minitest_rerun_failed
+
+## Usage
+
+Use it like any Minitest::Reporters like such:
+
+```
+Minitest::Reporters.use! [
+  Minitest::Reporters::ProgressReporter.new, # This is just my preferred reporter. Use the one(s) you like.
+  Minitest::Reporters::FailedTestsReporter.new(verbose: true, include_line_numbers: true)
+]
+```
+
+### Options
+- include_line_numbers: Include line numbers in outputs. Defaults to true
+- verbose: Output to stdout. Defaults to true
+- file_output: Output to file. Defaults to true
+- output_path: Path to place output files in. Defaults to '.'
+
+## Other
+### Why line numbers instead of test names? What if the lines change as I am fixing things?
+Line numbers were much easier to implement.
+If you find a good way to output test names instead, please open a PR with tests to add it as an option.
+
+As for if line numbers change, the most likely outcome is that the whole file will simply be run instead of a single test.
+You can also use the option `include_line_numbers: false` to always output whole files for greater safety.
+
+## 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 the created tag, 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/houen/minitest_rerun_failed.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## TODO
+- Executable for rerun? (https://stackoverflow.com/a/65707495)
+- Rerun with same seed
+- Minitest-reporters or minitest plugin?
+
+https://stackoverflow.com/questions/19910533/minitest-rerun-only-failed-tests

data/Rakefile

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/real/**/*_test.rb"]
+end
+
+Rake::TestTask.new(:tests_meant_to_fail) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/meant_to_fail/**/*_test.rb"]
+end
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "minitest/rerun/failed"
+
+# 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/lib/minitest_rerun_failed/failed_tests_reporter.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+module Minitest
+  module Reporters
+    # Source: https://www.houen.net/2021/08/23/minitest-rerun-failed-tests/
+    # License: MIT
+    #
+    # Outputs failed tests to screen and / or file
+    # Allows to rerun only failed tests with minitest if added to Minitest::Reporters.use!
+    #
+    # Example:
+    #   In test_helper.rb or similar:
+    #   Minitest::Reporters.use! [Minitest::Reporters::ProgressReporter.new, Minitest::Reporters::FailedTestsReporter.new(verbose: true, include_line_numbers: true)]
+    #
+    #   Now after a failed test run, rerun failed tests only with: `bundle exec rails test $(cat .minitest_failed_tests.txt)`
+    #
+    class FailedTestsReporter < Minitest::Reporters::BaseReporter
+      def initialize(options = {})
+        super(options)
+        @options = options
+
+        # Include line numbers? (failed_test.rb:42 or just failed_test.rb)
+        @include_line_numbers = options.fetch(:include_line_numbers, true)
+        # Output to console?
+        @verbose = options.fetch(:verbose, true)
+        # Output to file?
+        @file_output = options.fetch(:file_output, true)
+        # What path to file?
+        @output_path = options.fetch(:output_path, ".")
+        FileUtils.mkdir_p(@output_path) if @output_path
+
+        @output_file_path = File.join(@output_path, ".minitest_failed_tests.txt")
+      end
+
+      def record(test)
+        tests << test
+      end
+
+      def report
+        super
+
+        failure_paths = []
+        file_output   = []
+        curdir        = FileUtils.pwd
+
+        tests.each do |test|
+          next if test.skipped?
+          next if test.failure.nil?
+
+          # DEBUG OUTPUT STR
+          # p '============================================='
+          # p "Failure:\n#{test.class}##{test.name} [#{test.failure.location}]\n#{test.failure.class}: #{test.failure.message}"
+          # p '============================================='
+
+          failure_file_location = find_failure_location(test, curdir)
+          failure_paths << failure_file_location if failure_file_location
+        end
+
+        output_results(failure_paths, file_output)
+        File.write(@output_file_path, file_output.join("\n"), encoding: "UTF-8")
+      end
+
+      private
+
+      def find_failure_location(test, curdir)
+        # Build a haystack string from failures and errors to find test file location in
+        tmp_haystack = []
+        tmp_haystack << test.failure.location
+        tmp_haystack << test.to_s
+        # Add filtered backtrace unless it is an unexpected error, which do not have a useful trace
+        tmp_haystack << filter_backtrace(test.failure.backtrace).join unless test.failure.is_a?(MiniTest::UnexpectedError)
+
+        # Get failure location as best we can from haystack
+        if @include_line_numbers
+          failure_file_location = tmp_haystack.join[/(.+_test\.rb:[0-9]+)/, 1]
+        else
+          failure_file_location = tmp_haystack.join[/(.+_test\.rb):[0-9]+/, 1]
+        end
+
+        return unless failure_file_location
+
+        # Make path relative if absolute
+        failure_file_location.gsub!(curdir, "")
+        failure_file_location.gsub!(%r{^/}, "")
+
+        failure_file_location
+      end
+
+      def output_results(failure_paths, file_output)
+        return if failure_paths.empty?
+
+        _puts("")
+        headline = @include_line_numbers ? "Failed tests: #{failure_paths.count} (seed #{@options[:seed]}):" : "Failed test files: #{failure_paths.count} (seed #{@options[:seed]}):"
+        _puts(headline)
+        failure_paths.uniq.each do |file_path|
+          file_output << file_path.to_s
+          _puts red(file_path.strip)
+        end
+      end
+
+      def _puts(str)
+        return unless @verbose
+
+        puts(str)
+      end
+
+      def print_padded_comment(line)
+        puts "##{pad(line)}"
+      end
+
+      def color?
+        return @color if defined?(@color)
+
+        @color = @options.fetch(:color) do
+          io.tty? && (
+            ENV["TERM"] =~ /^screen|color/ ||
+              ENV["EMACS"] == "t"
+          )
+        end
+      end
+
+      def green(string)
+        color? ? ANSI::Code.green(string) : string
+      end
+
+      def yellow(string)
+        color? ? ANSI::Code.yellow(string) : string
+      end
+
+      def red(string)
+        color? ? ANSI::Code.red(string) : string
+      end
+    end
+  end
+end

data/lib/minitest_rerun_failed/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module MinitestRerunFailed
+  VERSION = "0.1.3"
+end

data/lib/minitest_rerun_failed.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "minitest/reporters"
+
+require_relative "minitest_rerun_failed/version"
+require_relative "minitest_rerun_failed/failed_tests_reporter"
+
+module MinitestRerunFailed
+  class Error < StandardError; end
+
+  # Your code goes here...
+end

data/minitest_rerun_failed.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/minitest_rerun_failed/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "minitest-rerun-failed"
+  spec.version       = MinitestRerunFailed::VERSION
+  spec.authors       = ["Søren Houen"]
+  spec.email         = ["s@houen.net"]
+
+  spec.summary       = "Easily rerun failed tests with Minitest"
+  spec.homepage      = "https://www.github.com/houen/minitest_rerun_failed"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://www.github.com/houen/minitest_rerun_failed"
+  spec.metadata["changelog_uri"] = "https://www.github.com/houen/minitest_rerun_failed/CHANGELOG.md"
+
+  # 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(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "minitest", "~> 5.14.4"
+  spec.add_dependency "minitest-reporters", "~> 1.4.3"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: minitest-rerun-failed
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Søren Houen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-09-12 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.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.14.4
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.3
+description:
+email:
+- s@houen.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- assets/screenshot.png
+- bin/console
+- bin/setup
+- lib/minitest_rerun_failed.rb
+- lib/minitest_rerun_failed/failed_tests_reporter.rb
+- lib/minitest_rerun_failed/version.rb
+- minitest_rerun_failed.gemspec
+homepage: https://www.github.com/houen/minitest_rerun_failed
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://www.github.com/houen/minitest_rerun_failed
+  source_code_uri: https://www.github.com/houen/minitest_rerun_failed
+  changelog_uri: https://www.github.com/houen/minitest_rerun_failed/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.15
+signing_key:
+specification_version: 4
+summary: Easily rerun failed tests with Minitest
+test_files: []