minitest-ci 2.4.0 → 3.0.0

data/History.txt

@@ -1,3 +1,22 @@
+=== 3.0.0 / 2013-07-03
+
+* 1 major enhancement:
+
+  * Retool to support minitest 5.
+
+* 1 bug fix:
+
+  * Use inspect to correctly escape test/class names. (eentzel) Fixes #8
+
+* 5 unknowns:
+
+  * Add autotest plugin.
+  * Add notes to autotest plugin.
+  * Update readme to reflect changes.
+  * Use Isolate file.
+  * Use error label.
+
+
 === 2.4.0 / 2012-11-10
 This release let's people use either 3.x or 4.x as 4.x doesn't break the
 needed api

data/Isolate

@@ -0,0 +1,9 @@
+gem 'minitest', '~> 5.0'
+
+env :development do
+  gem 'nokogiri', '~> 1.5.0'
+  gem 'rdoc', '>= 2.4.2'
+  gem 'ZenTest'
+end
+
+# vim: ft=ruby

data/Manifest.txt

@@ -1,7 +1,10 @@
 .autotest
 History.txt
+Isolate
 Manifest.txt
 README.txt
 Rakefile
+lib/autotest/minitest_ci.rb
 lib/minitest/ci.rb
-test/test_minitest_ci.rb
+lib/minitest/ci_plugin.rb
+test/minitest/test_ci.rb

data/README.txt

@@ -4,13 +4,13 @@
 
 == DESCRIPTION:
 
-CI reporter plugin for MiniTest
+CI reporter plugin for Minitest
 
-This gem was made possible by ATT Interactive.
+This gem was made possible by YP.com
 
 == FEATURES/PROBLEMS:
 
-* Uses MiniTest::Unit#record which is only available since version 2.12.0
+* Uses Minitest::Reporter which is only available since version 5
 
 == SYNOPSIS:
 
@@ -21,12 +21,12 @@ for example) at the end of the test run. The report directory is cleaned
 between test runs. To disable:
 
   # test/helper.rb
-  MiniTest::Ci.auto_clean = false
+  Minitest::Ci.clean = false
 
   # Rakefile (optional, but recommended!)
   task :ci_cleanup do
     require 'minitest/ci'
-    MiniTest::Ci.clean
+    Minitest::Ci.new.start
   end
   task :test => %w[ci_cleanup test:one test:two]
 

data/Rakefile

@@ -2,6 +2,7 @@
 
 require 'rubygems'
 require 'hoe'
+require 'isolate/rake'
 
 Hoe.plugin :isolate
 Hoe.plugin :version, :git
@@ -10,11 +11,6 @@ Hoe.spec 'minitest-ci' do
   developer 'Brian Henderson', 'bhenderson@attinteractive.com'
 
   self.testlib = :none
-
-  extra_deps << ['minitest', '>= 3.0', '< 5.0']
-  extra_dev_deps << ['nokogiri', '~> 1.5.0']
-  extra_dev_deps << ['rdoc',     '>= 2.4.2']
-  extra_dev_deps << ['ZenTest']
 end
 
 # vim: syntax=ruby

data/lib/autotest/minitest_ci.rb

@@ -0,0 +1,26 @@
+##
+# Plugin for Autotest to ignore MiniTest::Ci report directory.
+#
+# in your .autotest file:
+#
+# require 'autotest/minitest_ci'
+#
+# # optionally:
+# Autotest::MiniTestCI.report_dir = 'some/other/path/to/reports'
+#
+# I think this plugin can do more than what it does now, but not sure yet.
+# Leaving here to think about it more.
+module Autotest::MiniTestCI
+  class << self
+    attr_accessor :report_dir
+  end
+  # MiniTest::Ci.report_dir which is configurable in your test suite is not
+  # accessible to autotest so we just have to make it duplicated here. If
+  # anyone has any good suggestions other than evaling a file etc. I'm open.
+  self.report_dir = 'test/reports'
+
+  # tell autotest to ignore the report directory.
+  Autotest.add_hook :initialize do |at|
+    at.add_exception Autotest::MiniTestCI.report_dir
+  end
+end

data/lib/minitest/ci.rb

@@ -1,118 +1,121 @@
-gem 'minitest'
-require 'minitest/unit'
-#unless MiniTest::Unit::VERSION >= '2.12.0'
-unless MiniTest::Unit.public_method_defined? :record
-  abort 'you are running an unsupported version of MiniTest. try upgrading.'
-end
-
 require 'fileutils'
 require 'cgi'
 
-module MiniTest
-  module Ci
-
-    VERSION = '2.4.0'
+module Minitest
+  class Ci < Reporter
 
-    @suites = Hash.new {|h,k| h[k] = []}
+    VERSION = '3.0.0'
 
     class << self
+
+      ##
       # Accessor method to change the report dir if you don't like the
       # defaults.
+
       attr_accessor :report_dir
 
+      ##
       # Clean the report_dir between test runs? (defaults to true)
-      attr_accessor :auto_clean
+
+      attr_accessor :clean
     end
+
     self.report_dir = 'test/reports'
-    self.auto_clean = true
+    self.clean      = true
+
+    def initialize *args
+      super
 
-    def push suite, method, num_assertions, time, error
-      @suites[suite] << [method, num_assertions, time, error]
+      self.results = Hash.new {|h,k| h[k] = []}
     end
 
-    def finish io
+    def passed?
+      true # don't care?
+    end
+
+    def start # clean
+      FileUtils.rm_rf   report_dir if clean?
+      FileUtils.mkdir_p report_dir
+    end
+
+    def record result
+      results[result.class] << result
+    end
+
+    def report
       io.puts
       io.puts 'generating ci files'
 
-      clean
-
       Dir.chdir report_dir do
-        @suites.each do |name, suite|
-          generate_suite name, suite
+        results.each do |name, resultz|
+          File.open "TEST-#{CGI.escape(name.to_s)}.xml", "w" do |f|
+            f.puts generate_results name, resultz
+          end
         end
       end
     end
 
-    def clean verbose = false
-      FileUtils.rm_rf report_dir, :verbose => verbose if auto_clean
-      FileUtils.mkdir_p report_dir, :verbose => verbose
-    end
-
     private
 
     def escape o
       CGI.escapeHTML(o.to_s)
     end
 
-    def generate_suite name, suite
+    def generate_results name, results
       total_time = assertions = errors = failures = skips = 0
-      suite.each do |_, a, t, e|
-        total_time += t
-        assertions += a
-        case e
-        when MiniTest::Skip
+      results.each do |result|
+        total_time += result.time
+        assertions += result.assertions
+        # p result.failure.class
+        case result.failure
+        when Skip
           skips += 1
-        when MiniTest::Assertion
-          failures += 1
-        when Exception
+        when UnexpectedError
           errors += 1
+        when Assertion
+          failures += 1
         end
       end
 
-      File.open "TEST-#{CGI.escape(name.to_s)}.xml", "w" do |f|
-        f.puts '<?xml version="1.0" encoding="UTF-8"?>'
-        f.puts "<testsuite time='#{"%6f" % total_time}' skipped='#{skips}' failures='#{failures}' errors='#{errors}' name='#{name}' assertions='#{assertions}' tests='#{suite.count}'>"
-
-        suite.each do |method, asserts, time, error|
-          f.puts "  <testcase time='#{"%6f" % time}' name='#{method}' assertions='#{asserts}'>"
-          if error
-            bt = MiniTest::filter_backtrace error.backtrace
-            f.write "    <#{type error} type='#{escape error.class}' message=#{escape( error.message ).inspect}>"
-            f.puts escape bt.join "\n"
-            f.puts "    </#{type error}>"
+      xml = []
+
+      xml << '<?xml version="1.0" encoding="UTF-8"?>'
+      xml << "<testsuite time='%6f' skipped='%d' failures='%d' errors='%d' name=%p assertions='%d' tests='%d'>" %
+        [total_time, skips, failures, errors, name.to_s, assertions, results.count]
+
+      results.each do |result|
+        xml << "  <testcase time='%6f' name=%p assertions='%s'>" %
+          [result.time, result.name, result.assertions]
+        if failure = result.failure
+          label = failure.result_label.downcase
+
+          if failure.is_a?(UnexpectedError)
+            failure = failure.error
           end
-          f.puts "  </testcase>"
-        end
 
-        f.puts "</testsuite>"
-      end
-    end
+          klass = failure.class
+          msg   = failure.message
+          bt    = Minitest::filter_backtrace failure.backtrace
 
-    def type e
-      case e
-      when MiniTest::Skip
-        'skipped'
-      else
-        'failure'
+          xml << "    <%s type='%s' message=%s>%s" %
+            [label, escape(klass), escape(msg).inspect, escape(bt.join("\n"))]
+          xml << "    </%s>" % label
+        end
+        xml << "  </testcase>"
       end
-    end
 
-    extend self
-  end
+      xml << "</testsuite>"
 
-  class CiUnit < Unit
+      xml
+    end
 
-    after_tests do
-      MiniTest::Ci.finish self.output
+    def report_dir
+      options.fetch(:ci_dir, self.class.report_dir)
     end
 
-    def record suite, method, assertions, time, error
-      MiniTest::Ci.push suite, method, assertions, time, error
-      super
+    def clean?
+      options.fetch(:ci_clean, self.class.clean)
     end
 
   end
 end
-
-# use
-MiniTest::Unit.runner = MiniTest::CiUnit.new

data/lib/minitest/ci_plugin.rb

@@ -0,0 +1,19 @@
+require 'minitest/ci'
+
+module Minitest
+
+  def self.plugin_ci_init options
+    self.reporter << Ci.new(options[:io], options)
+  end
+
+  def self.plugin_ci_options opts, options
+    opts.on "--ci-dir", "Set the CI report dir. Default to #{Ci.report_dir}" do |dir|
+      options[:ci_dir] = dir
+    end
+
+    opts.on "--[no-]ci-clean", "Clean the CI report dir in between test runs. Default #{Ci.clean}" do |clean|
+      options[:ci_clean] = clean
+    end
+  end
+
+end

data/test/{test_minitest_ci.rb → minitest/test_ci.rb}

@@ -1,10 +1,11 @@
-require "minitest/ci"
-require "minitest/spec"
+gem 'minitest'
 require "minitest/autorun"
+require "minitest/ci"
+
 require 'stringio'
 require 'nokogiri'
 
-class MockTestSuite < MiniTest::Unit::TestCase
+class MockTestSuite < Minitest::Test
   def test_raise_error
     raise 'raise an error'
   end
@@ -34,36 +35,33 @@ class MockTestSuite < MiniTest::Unit::TestCase
   end
 end
 
-SpecWithPunctuation = describe "spec/with::punctuation" do
+SpecWithPunctuation = describe "spec/with::'punctuation'" do
  it "passes" do
    pass
  end
 end
 
-class TestMinitest
-end
+# better way?
+$ci_io = StringIO.new
+Minitest::Ci.clean = false
 
-class TestMinitest::TestCi < MiniTest::Unit::TestCase
-  @output = StringIO.new
-  old_out, MiniTest::Unit.output = MiniTest::Unit.output, @output
-  begin
-    runner = MiniTest::CiUnit.new
+# setup test files
+reporter = Minitest::Ci.new $ci_io
+reporter.run_and_report do
+  Minitest.__run reporter, {}
+end
 
-    runner._run_suite MockTestSuite, :test
-    runner._run_suite SpecWithPunctuation, :test
+Minitest::Runnable.reset
 
-    @@test_suites.delete MockTestSuite
-    MiniTest::Ci.finish runner.output
-  ensure
-    MiniTest::Unit.output = old_out
-  end
+class TestMinitest; end
+class TestMinitest::TestCi < Minitest::Test
 
-  def self.output
-    @output
+  def output
+    $ci_io
   end
 
   def setup
-    file = "#{MiniTest::Ci.report_dir}/TEST-MockTestSuite.xml"
+    file = "test/reports/TEST-MockTestSuite.xml"
     @file = File.read file
     @doc = Nokogiri.parse @file
     @doc = @doc.at_xpath('/testsuite')
@@ -78,37 +76,51 @@ class TestMinitest::TestCi < MiniTest::Unit::TestCase
     assert_equal "MockTestSuite", @doc['name']
   end
 
-  def test_testcase
+  def test_testcase_count
     assert_equal 7, @doc.children.count {|c| Nokogiri::XML::Element === c}
     @doc.children.each do |c|
       next unless Nokogiri::XML::Element === c
       assert_equal 'testcase', c.name
     end
+  end
 
+  def test_testcase_passed
     passed = @doc.at_xpath('/testsuite/testcase[@name="test_pass"]')
     assert_equal 0, passed.children.count {|c| Nokogiri::XML::Element === c}
     assert_equal '1', passed['assertions']
+  end
 
+  def test_testcase_skipped
     skipped = @doc.at_xpath('/testsuite/testcase[@name="test_skip_assertion"]')
     assert_equal 'skip assertion', skipped.at_xpath('skipped')['message']
     assert_equal '0', skipped['assertions']
+  end
 
+  def test_testcase_failures
     failure = @doc.at_xpath('/testsuite/testcase[@name="test_fail_assertion"]')
     assert_equal 'fail assertion', failure.at_xpath('failure')['message']
     assert_equal '1', failure['assertions']
+  end
 
+  def test_testcase_errors
     error = @doc.at_xpath('/testsuite/testcase[@name="test_raise_error"]')
-    assert_equal 'raise an error', error.at_xpath('failure')['message']
+    assert_equal 'raise an error', error.at_xpath('error')['message']
     assert_equal '0', error['assertions']
+  end
 
+  def test_testcase_error_with_invalid_chars
     error = @doc.at_xpath('/testsuite/testcase[@name="test_invalid_characters_in_message"]')
-    assert_match( /^#<Object/, error.at_xpath('failure')['message'] )
+    assert_match( /^#<Object/, error.at_xpath('error')['message'] )
     assert_equal '0', error['assertions']
+  end
 
+  def test_testcase_error_with_invalid_name
     error = @doc.at_xpath('/testsuite/testcase[@name="test_invalid_error_name"]')
-    assert_match( /^#<Class/, error.at_xpath('failure')['message'] )
+    assert_match( /^#<Class/, error.at_xpath('error')['message'] )
     assert_equal '0', error['assertions']
+  end
 
+  def test_testcase_error_with_bad_chars
     error = @doc.at_xpath('/testsuite/testcase[@name="test_escaping_failure_message"]')
     msg = "failed: doesn't like single or \"double\" quotes or symbols such as <"
     assert_equal msg, error.at_xpath('failure')['message']
@@ -116,8 +128,9 @@ class TestMinitest::TestCi < MiniTest::Unit::TestCase
   end
 
   def test_output
-    self.class.output.rewind
-    assert_match( /generating ci files/, self.class.output.read )
+    output.rewind
+    expected = "\ngenerating ci files\n"
+    assert_equal expected, output.read
   end
 
   def test_filtering_backtraces
@@ -125,8 +138,9 @@ class TestMinitest::TestCi < MiniTest::Unit::TestCase
     refute_match( /lib\/minitest/, error.inner_text )
   end
 
-  def test_testname
-    assert File.file?(File.join(MiniTest::Ci.report_dir,
-                      "TEST-spec%2Fwith%3A%3Apunctuation.xml"))
+  def test_suitename
+    file = File.read "test/reports/TEST-spec%2Fwith%3A%3A%27punctuation%27.xml"
+    suite = Nokogiri.parse(file).at_xpath('/testsuite')
+    assert_equal "spec/with::'punctuation'", suite['name']
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: minitest-ci
 version: !ruby/object:Gem::Version
-  version: 2.4.0
+  version: 3.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,17 +9,14 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-11 00:00:00.000000000 Z
+date: 2013-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '3.0'
-    - - <
+    - - ~>
       - !ruby/object:Gem::Version
         version: '5.0'
   type: :runtime
@@ -27,20 +24,17 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '3.0'
-    - - <
+    - - ~>
       - !ruby/object:Gem::Version
         version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: rdoc
+  name: nokogiri
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: 1.5.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -48,23 +42,23 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.10'
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
-  name: nokogiri
+  name: rdoc
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 2.4.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.5.0
+        version: 2.4.2
 - !ruby/object:Gem::Dependency
   name: ZenTest
   requirement: !ruby/object:Gem::Requirement
@@ -88,7 +82,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -96,11 +90,11 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.0'
-description: ! 'CI reporter plugin for MiniTest
+        version: '3.5'
+description: ! 'CI reporter plugin for Minitest
 
 
-  This gem was made possible by ATT Interactive.'
+  This gem was made possible by YP.com'
 email:
 - bhenderson@attinteractive.com
 executables: []
@@ -112,11 +106,14 @@ extra_rdoc_files:
 files:
 - .autotest
 - History.txt
+- Isolate
 - Manifest.txt
 - README.txt
 - Rakefile
+- lib/autotest/minitest_ci.rb
 - lib/minitest/ci.rb
-- test/test_minitest_ci.rb
+- lib/minitest/ci_plugin.rb
+- test/minitest/test_ci.rb
 - .gemtest
 homepage: https://github.com/bhenderson/minitest-ci
 licenses: []
@@ -140,9 +137,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: minitest-ci
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
-summary: CI reporter plugin for MiniTest  This gem was made possible by ATT Interactive.
+summary: CI reporter plugin for Minitest  This gem was made possible by YP.com
 test_files:
-- test/test_minitest_ci.rb
+- test/minitest/test_ci.rb