minitest-junit_formatter 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6187bdbdbb70fedb0f8ae74880f5dc52be2b5fcd1dbbf8c2c33d1d45ec50951c
-  data.tar.gz: d6f6d37a483382f086aae7257bfd11b5c4df6bdcfb8e95223ffdb3388e89bdd1
+  metadata.gz: 48efdf67a0c1a27752128640d319129d3575a5212d5a74def0ae6dfecb27b58f
+  data.tar.gz: 66bca0a2dd39f15b4d2b9e24bca3baca67e51ef019857b1675e94b1b84961d07
 SHA512:
-  metadata.gz: ef3ec5092642cd0a897e94710e959090f6745ec02a659bba65fa4ffda7159f9ed3a25c0c787eb17f0e27b0f37f2327322cb391d9718005f3841e03498f600c00
-  data.tar.gz: 85257d6d9755ba2829b0d83e6ce3132768b8ab3c287b177059e37f123996cec7ba93d80ce525f94c5a6d315b13d2518eb4995dbba541bc7d612a5a6c4942b9fe
+  metadata.gz: 58548caa1d3bc7b99cad7d3a5bb834aea49cb1f47770dde967146fc524589bf9c4ae1e172f234f6b8629880b3fbd14992413f5721ed0e55b649d5389c9405e8f
+  data.tar.gz: ac6d1f4c2c04bab8574acedc4020b4f2c6b20f5ef198b87be0ecbbb4a326fac3fea0fb1e5402db5bfa915f70a95ef9381a893df98f633cfcff670c9ef7999937

data/.github/workflows/main.yml

@@ -1,18 +1,21 @@
 name: Main
 on:
   push:
-    branches: [release]
+    branches: [main, release]
   pull_request:
-    types: [opened, synchronize]
+  workflow_dispatch:
 
 jobs:
   tests:
-    name: Tests
+    name: Ruby ${{ matrix.ruby }} / Minitest ${{ matrix.minitest }}
     runs-on: ubuntu-latest
     strategy:
       fail-fast: false
       matrix:
-        ruby: ["2.7", "3.0", "3.1", "3.2"]
+        ruby: ["3.2", "3.3", "3.4", "jruby-10.0", "jruby-10.1"]
+        minitest: ["5", "6"]
+    env:
+      MINITEST_VERSION: ${{ matrix.minitest }}
 
     steps:
       - name: Checkout code
@@ -23,12 +26,8 @@ jobs:
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
-
-      - name: Generate lockfile
-        run: bundle lock
-
-      - name: Bundle
-        run: bundle check || bundle install
+          # Separate gem caches per Minitest major version.
+          cache-version: minitest-${{ matrix.minitest }}
 
       - name: Run tests
         run: bundle exec rake test

data/.gitignore

@@ -20,3 +20,5 @@ tmp
 *.o
 *.a
 mkmf.log
+pik.sh
+report.xml

data/Gemfile

@@ -2,3 +2,11 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in minitest-junit.gemspec
 gemspec
+
+# Test against a specific Minitest major version, e.g. MINITEST_VERSION=5
+# Minitest 6 requires Ruby 3.2+.
+minitest_version = ENV.fetch('MINITEST_VERSION') { RUBY_VERSION >= '3.2' ? '6' : '5' }
+gem 'minitest', "~> #{minitest_version}.0"
+
+# Minitest 6 extracted minitest/mock into its own gem.
+gem 'minitest-mock' if minitest_version.to_i >= 6

data/README.md

@@ -14,7 +14,7 @@ And then execute:
 
 Or install it yourself as:
 
-    $ gem install minitest-junit
+    $ gem install minitest-junit_formatter
 
 ## Usage
 
@@ -27,10 +27,9 @@ Or install it yourself as:
             --junit-jenkins              Sanitize test names for Jenkins display
     ...
 
-## Contributing
+## Acknowledgment
+
+This project is based on
+
+https://github.com/aespinosa/minitest-junit
 
-1. Fork it ( https://github.com/aespinosa/minitest-junit/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request

data/lib/minitest/junit_formatter/version.rb

@@ -1,6 +1,6 @@
 module Minitest
   # :nodoc:
   module JunitFormatter
-    VERSION = "0.1.0"
+    VERSION = "0.3.0"
   end
 end

data/lib/minitest/junit_formatter/xml_nokogiri.rb

@@ -0,0 +1,34 @@
+module Minitest
+  module JunitFormatter
+    class NokogiriDocument
+      def initialize
+        @doc = Nokogiri::XML::Document.new
+        @doc.encoding = 'UTF-8'
+      end
+
+      def document
+        @doc
+      end
+
+      def element(name)
+        Nokogiri::XML::Node.new(name, @doc)
+      end
+
+      def set_attr(el, name, value)
+        el[name.to_s] = value.to_s
+      end
+
+      def add_child(parent, child)
+        parent << child
+      end
+
+      def add_text(el, text)
+        el.content = text.to_s
+      end
+
+      def dump(doc)
+        doc.to_xml(indent: 2)
+      end
+    end
+  end
+end

data/lib/minitest/junit_formatter/xml_rexml.rb

@@ -0,0 +1,38 @@
+module Minitest
+  module JunitFormatter
+    class RexmlDocument
+      # Emit double-quoted attributes, matching the Nokogiri backend.
+      CONTEXT = { attribute_quote: :quote }.freeze
+
+      def document
+        doc = REXML::Document.new
+        doc << REXML::XMLDecl.new('1.0', 'UTF-8')
+        doc
+      end
+
+      def element(name)
+        REXML::Element.new(name, nil, CONTEXT)
+      end
+
+      def set_attr(el, name, value)
+        el.add_attribute(name, value.to_s)
+      end
+
+      def add_child(parent, child)
+        parent << child
+      end
+
+      def add_text(el, text)
+        el.add_text(text.to_s)
+      end
+
+      def dump(doc)
+        output = String.new
+        formatter = REXML::Formatters::Pretty.new(2)
+        formatter.compact = true
+        formatter.write(doc, output)
+        output + "\n"
+      end
+    end
+  end
+end

data/lib/minitest/junit_formatter.rb

@@ -1,9 +1,17 @@
 require "minitest/junit_formatter/version"
 require 'minitest'
-require 'ox'
 require 'socket'
 require 'time'
 
+# XML backend: Nokogiri (fast) > REXML (stdlib fallback).
+begin
+  require 'nokogiri'
+  require "minitest/junit_formatter/xml_nokogiri"
+rescue LoadError
+  require 'rexml/document'
+  require "minitest/junit_formatter/xml_rexml"
+end
+
 # :nodoc:
 module Minitest
   module JunitFormatter
@@ -15,6 +23,15 @@ module Minitest
         @options = options
         @options[:timestamp] = options.fetch(:timestamp, Time.now.iso8601)
         @options[:hostname] = options.fetch(:hostname, Socket.gethostname)
+
+        @doc = document_factory.new
+      end
+
+      def prerecord(klass, name)
+        return unless @options[:verbose]
+
+        io.print "%s#%s = " % [klass.name, name]
+        io.flush
       end
 
       def passed?
@@ -28,52 +45,47 @@ module Minitest
       end
 
       def report
-        doc = Ox::Document.new(version: '1.0', encoding: 'UTF-8')
-        instruct = Ox::Instruct.new(:xml)
-        instruct[:version] = '1.0'
-        instruct[:encoding] = 'UTF-8'
-        doc << instruct
-
-        testsuite = Ox::Element.new('testsuite')
-        testsuite['name'] = @options[:name] || 'minitest'
-        testsuite['timestamp'] = @options[:timestamp]
-        testsuite['hostname'] = @options[:hostname]
-        testsuite['tests'] = @results.size
-        testsuite['skipped'] = @results.count(&:skipped?)
-        testsuite['failures'] = @results.count { |result| !result.error? && result.failure }
-        testsuite['errors'] = @results.count(&:error?)
-        testsuite['time'] = format_time(@results.map(&:time).inject(0, :+))
+        doc = @doc.document
+
+        testsuites = @doc.element('testsuites')
+        testsuite = @doc.element('testsuite')
+        @doc.set_attr(testsuite, 'name', @options[:name] || 'minitest')
+        @doc.set_attr(testsuite, 'timestamp', @options[:timestamp])
+        @doc.set_attr(testsuite, 'hostname', @options[:hostname])
+        @doc.set_attr(testsuite, 'tests', @results.size)
+        @doc.set_attr(testsuite, 'skipped', @results.count(&:skipped?))
+        @doc.set_attr(testsuite, 'failures', @results.count { |result| !result.error? && result.failure })
+        @doc.set_attr(testsuite, 'errors', @results.count(&:error?))
+        @doc.set_attr(testsuite, 'time', format_time(@results.map(&:time).inject(0, :+)))
         @results.each do |result|
-          testsuite << format(result)
+          @doc.add_child(testsuite, format(result))
         end
 
-        testsuites = Ox::Element.new('testsuites')
-        testsuites << testsuite
-
-        doc << testsuites
-        @io << Ox.dump(doc)
+        @doc.add_child(testsuites, testsuite)
+        @doc.add_child(doc, testsuites)
+        @io << @doc.dump(doc)
       end
 
       def format(result, parent = nil)
-        testcase = Ox::Element.new('testcase')
-        testcase['classname'] = format_class(result)
-        testcase['name'] = format_name(result)
-        testcase['time'] = format_time(result.time)
-        testcase['file'] = relative_to_cwd(result.source_location.first)
-        testcase['line'] = result.source_location.last
-        testcase['assertions'] = result.assertions
+        testcase = @doc.element('testcase')
+        @doc.set_attr(testcase, 'classname', format_class(result))
+        @doc.set_attr(testcase, 'name', format_name(result))
+        @doc.set_attr(testcase, 'time', format_time(result.time))
+        @doc.set_attr(testcase, 'file', relative_to_cwd(result.source_location.first))
+        @doc.set_attr(testcase, 'line', result.source_location.last)
+        @doc.set_attr(testcase, 'assertions', result.assertions)
 
         if result.skipped?
-          skipped = Ox::Element.new('skipped')
-          skipped['message'] = result
-          skipped << ""
-          testcase << skipped
+          skipped = @doc.element('skipped')
+          @doc.set_attr(skipped, 'message', result)
+          @doc.add_text(skipped, '')
+          @doc.add_child(testcase, skipped)
         else
           result.failures.each do |failure|
-            failure_tag = Ox::Element.new(classify(failure))
-            failure_tag['message'] = result
-            failure_tag << format_backtrace(failure)
-            testcase << failure_tag
+            failure_tag = @doc.element(classify(failure))
+            @doc.set_attr(failure_tag, 'message', result)
+            @doc.add_text(failure_tag, format_backtrace(failure))
+            @doc.add_child(testcase, failure_tag)
           end
         end
 
@@ -82,9 +94,9 @@ module Minitest
         # Output according to Gitlab format
         # https://docs.gitlab.com/ee/ci/testing/unit_test_reports.html#view-junit-screenshots-on-gitlab
         if result.respond_to?("metadata") && result.metadata[:failure_screenshot_path]
-          screenshot = Ox::Element.new("system-out")
-          screenshot << "[[ATTACHMENT|#{result.metadata[:failure_screenshot_path]}]]"
-          testcase << screenshot
+          screenshot = @doc.element("system-out")
+          @doc.add_text(screenshot, "[[ATTACHMENT|#{result.metadata[:failure_screenshot_path]}]]")
+          @doc.add_child(testcase, screenshot)
         end
 
         testcase
@@ -92,6 +104,14 @@ module Minitest
 
       private
 
+      def document_factory
+        if defined?(Nokogiri)
+          NokogiriDocument
+        else
+          RexmlDocument
+        end
+      end
+
       def classify(failure)
         if failure.instance_of? UnexpectedError
           'error'

data/minitest-junit_formatter.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Minitest::JunitFormatter::VERSION
   spec.authors       = ["Jesse Chavez", "Allan Espinosa"]
   spec.email         = ["jesse.chavez.jp@gmail.com"]
-  spec.summary       = "Junit report formatter for Minitest ~> 5.0"
-  spec.description   = "Junit report formatter for Minitest ~> 5.0"
+  spec.summary       = "Junit report formatter for Minitest 5 and 6"
+  spec.description   = "Junit report formatter for Minitest 5 and 6"
   spec.homepage      = "https://github.com/JesseChavez/minitest-junit_formatter"
   spec.license       = "MIT"
 
@@ -18,11 +18,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(/^(test)\//)
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'minitest', '~> 5.11'
-  spec.add_dependency 'ox', '~> 2', '>= 2.14.2'
+  spec.add_dependency 'minitest', '>= 5.11', '< 7'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'nokogiri'
   spec.add_development_dependency 'rake', '~> 13'
+  spec.add_development_dependency 'rexml'
   spec.add_development_dependency 'rubocop', '~> 1'
 end

data/test/junit_plugin_test.rb

@@ -1,5 +1,4 @@
-require 'minitest/autorun'
-require 'minitest/mock'
+require_relative 'test_helper'
 require "minitest/junit_formatter_plugin"
 
 class PluginTest < Minitest::Test

data/test/reporter_test.rb

@@ -1,4 +1,4 @@
-require 'minitest/autorun'
+require_relative 'test_helper'
 require 'stringio'
 require 'time'
 require 'nokogiri'
@@ -13,10 +13,22 @@ class ReporterTest < Minitest::Test
 
     reporter.report
 
-    assert_match(
-      %r{<?xml version="1.0" encoding="UTF-8"\?>\n<testsuites>\n  <testsuite name="minitest" timestamp="[^"]+" hostname="[^"]+" tests="0" skipped="0" failures="0" errors="0" time="0.000000"\/>\n<\/testsuites>\n},
-      reporter.output
+    assert_match(/\A<\?xml version="1.0" encoding="UTF-8"\?>\n/, reporter.output)
+
+    # Parse rather than match text: JRuby's Nokogiri orders attributes and whitespace differently
+    parsed_report = Nokogiri::XML(reporter.output)
+    assert_equal 'testsuites', parsed_report.root.name
+    testsuites = parsed_report.root.element_children
+    assert_equal ['testsuite'], testsuites.map(&:name)
+
+    testsuite = testsuites.first
+    assert_empty testsuite.children
+    assert_equal(
+      { 'name' => 'minitest', 'tests' => '0', 'skipped' => '0', 'failures' => '0', 'errors' => '0', 'time' => '0.000000' },
+      testsuite.to_h.reject { |key, _| %w[timestamp hostname].include?(key) }
     )
+    refute_empty testsuite['timestamp']
+    refute_empty testsuite['hostname']
   end
 
   # NOTE: This test will generate a temp file: "test/tmp/report.xml"
@@ -35,9 +47,11 @@ class ReporterTest < Minitest::Test
     reporter = create_reporter
 
     results = do_formatting_test(reporter, count: rand(100), cause_failures: 0)
+    parsed_report = Nokogiri::XML(reporter.output)
 
     results.each do |result|
-      assert_match("<testcase classname=\"FakeTestName\" name=\"#{result.name}\"", reporter.output)
+      assert parsed_report.at_xpath("//testcase[@classname='FakeTestName' and @name='#{result.name}']"),
+             "expected a testcase for #{result.name}"
     end
   end
 

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+require 'minitest/autorun'
+require 'minitest/mock'
+
+# Minitest 6 made plugin loading opt-in.
+Minitest.load :junit_formatter if Minitest::VERSION.to_i >= 6

data/test/testcase_formatter_test.rb

@@ -1,4 +1,4 @@
-require 'minitest/autorun'
+require_relative 'test_helper'
 require 'stringio'
 require 'time'
 
@@ -31,7 +31,7 @@ class TestCaseFormatter < Minitest::Test
 
     reporter.report
 
-    assert_match(/<skipped message="[^<>]+"\><\/skipped>\n\s+<\/testcase>\n\s*<\/testsuite>\n/, reporter.output)
+    assert_match(/<skipped message="[^<>]+"(\/>|><\/skipped>)\n\s+<\/testcase>\n\s*<\/testsuite>\n/, reporter.output)
   end
 
   def test_failing_tests_creates_failure_tag

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minitest-junit_formatter
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Jesse Chavez
@@ -14,36 +14,22 @@ dependencies:
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.11'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '5.11'
-- !ruby/object:Gem::Dependency
-  name: ox
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
-    - - ">="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 2.14.2
+        version: '7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '2'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 2.14.2
+        version: '5.11'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -86,6 +72,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13'
+- !ruby/object:Gem::Dependency
+  name: rexml
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -100,7 +100,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
-description: Junit report formatter for Minitest ~> 5.0
+description: Junit report formatter for Minitest 5 and 6
 email:
 - jesse.chavez.jp@gmail.com
 executables: []
@@ -115,11 +115,14 @@ files:
 - Rakefile
 - lib/minitest/junit_formatter.rb
 - lib/minitest/junit_formatter/version.rb
+- lib/minitest/junit_formatter/xml_nokogiri.rb
+- lib/minitest/junit_formatter/xml_rexml.rb
 - lib/minitest/junit_formatter_plugin.rb
 - minitest-junit_formatter.gemspec
 - test/.rubocop.yml
 - test/junit_plugin_test.rb
 - test/reporter_test.rb
+- test/test_helper.rb
 - test/testcase_formatter_test.rb
 - test/tmp/.keep
 homepage: https://github.com/JesseChavez/minitest-junit_formatter
@@ -140,12 +143,13 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.7.2
 specification_version: 4
-summary: Junit report formatter for Minitest ~> 5.0
+summary: Junit report formatter for Minitest 5 and 6
 test_files:
 - test/.rubocop.yml
 - test/junit_plugin_test.rb
 - test/reporter_test.rb
+- test/test_helper.rb
 - test/testcase_formatter_test.rb
 - test/tmp/.keep