minitest_reporters_github 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 33bad65ff00059d719888171a5fdad11d4b90f4ce2b8cc8722cbebd37b4a5bd7
+  data.tar.gz: 39523ba765a358fcbde5c00182df609f8173abb4a960975fc654d00befff2c1e
+SHA512:
+  metadata.gz: 79bee2463e0775101f8fbd69c302f87a4a32374edc129d8f86962c5e90a4f1b43c34dea413394265e1d4bb09733e6bd95330b975b70668bcf128ec7ee96876b3
+  data.tar.gz: d9903407d27150a1cdc618b1d2d08b73ae0f9a4e6db8916ca746407345c665bbc11770bd87e404d85238b35debe9af4f29826887fb16e8b517eb5c3774e7992f

data/Rakefile

@@ -0,0 +1,8 @@
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+  t.pattern = "test/{unit,integration}/**/*_test.rb"
+  t.verbose = true
+end
+
+task default: :test

data/lib/minitest_reporters_github.rb

@@ -0,0 +1,88 @@
+# Taken from https://github.com/minitest-reporters/minitest-reporters/pull/332
+# and adapted to be able to run as a standalone gem
+
+require 'pathname'
+require 'minitest/reporters'
+
+# Inspired by the rubocop formatter.
+# https://github.com/rubocop/rubocop/blob/2f8239f61bd41fe672a4cd9d6f24e334eba7854a/lib/rubocop/formatter/git_hub_actions_formatter.rb
+
+# Simple reporter designed for Github Actions
+class MinitestReportersGithub < Minitest::Reporters::BaseReporter
+  ESCAPE_MAP = { '%' => '%25', "\n" => '%0A', "\r" => '%0D' }.freeze
+
+  def start
+    super
+
+    print_run_options
+  end
+
+  def record(test)
+    super
+
+    print(message_for(test))
+  end
+
+  def message_for(test)
+    if test.passed? || test.skipped?
+      nil
+    elsif test.failure
+      to_annotation(test, "Failure")
+    elsif test.error?
+      to_annotation(test, "Error")
+    end
+  end
+
+  private
+
+  def to_annotation(test, failure_type)
+    message = "#{failure_type}: #{test.name}\n\n#{test.failure.message}"
+    line_number = location(test.failure).split(":").last
+
+    "\n::error file=%<file>s,line=%<line>d::%<message>s\n" % {
+      file: get_relative_path(test),
+      line: line_number,
+      message: github_escape(message.rstrip),
+    }
+  end
+
+  def github_escape(string)
+    string.gsub(Regexp.union(ESCAPE_MAP.keys), ESCAPE_MAP)
+  end
+
+  def get_source_location(result)
+    if result.respond_to? :source_location
+      result.source_location
+    else
+      result.method(result.name).source_location
+    end
+  end
+
+  def location(exception)
+    last_before_assertion = ''
+    exception.backtrace.reverse_each do |s|
+      break if s =~ /in .(assert|refute|flunk|pass|fail|raise|must|wont)/
+
+      last_before_assertion = s
+    end
+
+    last_before_assertion.sub(/:in .*$/, '')
+  end
+
+  def get_relative_path(result)
+    file_path = Pathname.new(get_source_location(result).first)
+    base_path = Pathname.new(options[:base_path] || Dir.pwd)
+
+    if file_path.absolute?
+      file_path.relative_path_from(base_path)
+    else
+      file_path
+    end
+  end
+
+  def print_run_options
+    puts
+    puts("# Running tests with run options %s:" % options[:args])
+    puts
+  end
+end

data/test/fixtures/github_actions_test.rb

@@ -0,0 +1,18 @@
+require 'bundler/setup'
+require 'minitest/autorun'
+require 'minitest/reporters'
+require 'minitest_reporters_github'
+
+Minitest::Reporters.use! MinitestReportersGithub.new
+
+class TestClass < Minitest::Test
+  def test_assertion
+    assert true
+  end
+
+  def test_fail
+    if true
+      assert false
+    end
+  end
+end

data/test/integration/github_actions_reporter_test.rb

@@ -0,0 +1,11 @@
+require_relative "../test_helper"
+
+class MinitestReportersGithubTest < Minitest::Test
+  def test_output_format
+    fixtures_directory = File.expand_path('../fixtures', __dir__)
+    test_filename = File.join(fixtures_directory, 'github_actions_test.rb')
+    output = `ruby #{test_filename} 2>&1`
+    refute_match 'test_assertion', output
+    assert_match '::error file=test/fixtures/github_actions_test.rb,line=15::Failure: test_fail', output
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require "minitest/autorun"
+require "minitest/reporters"

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: minitest_reporters_github
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ewoud Kohl van Wijngaarden
+- Earlopain
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-01-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest-reporters
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+description: A separate gem until https://github.com/minitest-reporters/minitest-reporters/pull/332
+  is merged
+email:
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Rakefile
+- lib/minitest_reporters_github.rb
+- test/fixtures/github_actions_test.rb
+- test/integration/github_actions_reporter_test.rb
+- test/test_helper.rb
+homepage: https://github.com/ekohl/minitest-reporters
+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.7'
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: '4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: The GitHub Actions reporter for minitest-reporters
+test_files: []