minitest_reporters_github 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 33bad65ff00059d719888171a5fdad11d4b90f4ce2b8cc8722cbebd37b4a5bd7
-  data.tar.gz: 39523ba765a358fcbde5c00182df609f8173abb4a960975fc654d00befff2c1e
+  metadata.gz: 3e97df0f92108af3788508fa77e5b611fb117fb97f7f1d7a84c9f324fb68aaed
+  data.tar.gz: c1773aaf1b59cd8a9bc2d92633be27cf0675bca6473e6d0ec8c3ccbcdd0a46ff
 SHA512:
-  metadata.gz: 79bee2463e0775101f8fbd69c302f87a4a32374edc129d8f86962c5e90a4f1b43c34dea413394265e1d4bb09733e6bd95330b975b70668bcf128ec7ee96876b3
-  data.tar.gz: d9903407d27150a1cdc618b1d2d08b73ae0f9a4e6db8916ca746407345c665bbc11770bd87e404d85238b35debe9af4f29826887fb16e8b517eb5c3774e7992f
+  metadata.gz: 6b923bf033a47da11e4694b4cf0875ff17322c6c440ec7e1f5214508303a4ca30493e19fa4df7912e2f19e32fd383986439feed603dc9ec1dee62a9a068602ba
+  data.tar.gz: 25b561dfbd2b4755a1de8c5ad1eb1677d78c88f10e9bb27a84130a94607144e037d997295d02ce3d1c26da4bfc4e04738fcc1789394cc43f1ad777cdfc7d6229

data/lib/minitest_reporters_github.rb

@@ -9,7 +9,9 @@ require 'minitest/reporters'
 
 # Simple reporter designed for Github Actions
 class MinitestReportersGithub < Minitest::Reporters::BaseReporter
-  ESCAPE_MAP = { '%' => '%25', "\n" => '%0A', "\r" => '%0D' }.freeze
+  # based on https://github.com/actions/toolkit/blob/cee7d92d1d02e3107c9b1387b9690b89096b67be/packages/core/src/command.ts#L92-L105
+  ESCAPE_DATA_MAP = { '%' => '%25', "\n" => '%0A', "\r" => '%0D' }.freeze
+  ESCAPE_PROPERTY_MAP = ESCAPE_DATA_MAP.merge({ ':' => '%3A', ',' => '%2C'}).freeze
 
   def start
     super
@@ -36,18 +38,24 @@ class MinitestReportersGithub < Minitest::Reporters::BaseReporter
   private
 
   def to_annotation(test, failure_type)
-    message = "#{failure_type}: #{test.name}\n\n#{test.failure.message}"
+    title = "#{test.class_name}##{test.name}"
+    message = "#{failure_type}: #{title}\n\n#{test.failure.message}"
     line_number = location(test.failure).split(":").last
 
-    "\n::error file=%<file>s,line=%<line>d::%<message>s\n" % {
+    "\n::error file=%<file>s,line=%<line>d,title=%<title>s::%<message>s\n" % {
       file: get_relative_path(test),
       line: line_number,
-      message: github_escape(message.rstrip),
+      title: github_property_escape(title),
+      message: github_data_escape(message.rstrip),
     }
   end
 
-  def github_escape(string)
-    string.gsub(Regexp.union(ESCAPE_MAP.keys), ESCAPE_MAP)
+  def github_property_escape(string)
+    string.gsub(Regexp.union(ESCAPE_PROPERTY_MAP.keys), ESCAPE_PROPERTY_MAP)
+  end
+
+  def github_data_escape(string)
+    string.gsub(Regexp.union(ESCAPE_DATA_MAP.keys), ESCAPE_DATA_MAP)
   end
 
   def get_source_location(result)
@@ -61,7 +69,7 @@ class MinitestReportersGithub < Minitest::Reporters::BaseReporter
   def location(exception)
     last_before_assertion = ''
     exception.backtrace.reverse_each do |s|
-      break if s =~ /in .(assert|refute|flunk|pass|fail|raise|must|wont)/
+      break if s =~ /in .(Minitest::Assertions#)?(assert|refute|flunk|pass|fail|raise|must|wont)/
 
       last_before_assertion = s
     end

data/test/fixtures/github_actions_test.rb

@@ -3,6 +3,7 @@ require 'minitest/autorun'
 require 'minitest/reporters'
 require 'minitest_reporters_github'
 
+Minitest.load_plugins
 Minitest::Reporters.use! MinitestReportersGithub.new
 
 class TestClass < Minitest::Test

data/test/integration/github_actions_reporter_test.rb

@@ -6,6 +6,6 @@ class MinitestReportersGithubTest < Minitest::Test
     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
+    assert_match '::error file=test/fixtures/github_actions_test.rb,line=16,title=TestClass#test_fail::Failure: TestClass#test_fail', output
   end
 end

metadata

@@ -1,30 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: minitest_reporters_github
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Ewoud Kohl van Wijngaarden
 - Earlopain
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-23 00:00:00.000000000 Z
+date: 1980-01-02 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
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -39,9 +44,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
-description: A separate gem until https://github.com/minitest-reporters/minitest-reporters/pull/332
-  is merged
-email:
+description: A separate gem until https://github.com/minitest-reporters/minitest-reporters/issues/330
+  is resolved
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -51,11 +55,10 @@ files:
 - test/fixtures/github_actions_test.rb
 - test/integration/github_actions_reporter_test.rb
 - test/test_helper.rb
-homepage: https://github.com/ekohl/minitest-reporters
+homepage: https://github.com/theforeman/minitest_reporters_github
 licenses:
 - MIT
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -73,8 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 4.0.3
 specification_version: 4
 summary: The GitHub Actions reporter for minitest-reporters
 test_files: []