minitest-ci 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c2729a8517ac10d9febe0425d40fc263a6ec3d6c
-  data.tar.gz: 024571f398527def3e6ddcd37618b85c363bd8a6
+  metadata.gz: 7df74b27d06a7fc3c130ff4948fa7409006fffd9
+  data.tar.gz: 0f475b81387862ff375e1de9e790239c6bbcd656
 SHA512:
-  metadata.gz: 28d66efb28c6f0d529d5cb1eabc91c597d2e3d66a46dd10b3908a3f8ac299025fdd0033903919fbdd2b4a82f824e1366afc084505c83dfab422aa6ad2b767542
-  data.tar.gz: 6bea3a25b0aeb756e27c51e5b5df7e7ccadb36ddde52a6b7f355375bd39be65361ec9462a1eb4f8a8869897977d4e17c68caef9a6fd21a7f1a1946be2f9de785
+  metadata.gz: f3602c8752a1b60b63b4c403d572c6e45932d56fd8014efb578298c4df55890721baaad6bf66a94ce2f985b30eee8adee285d1464adf0bebab88b08b5b909eaf
+  data.tar.gz: faf0bbac59b3b69b0c38b917defd428fddd7189cd65aef264100d223eb55dcec9d41211c444e9233ae16d92d954eb75cde83267cdccd1e085e6b388e2cb3b84d

data/README.rdoc

@@ -6,20 +6,23 @@
 
 == DESCRIPTION:
 
-Minitest reporter plugin for CircleCI
+Minitest reporter plugin for [CircleCI](https://circleci.com/).
 
 This gem was made possible by YP.com
 
-Records test results and generates XML files (for junit hudson plugin
-for example) at the end of the test run.
+Records test results and generates XML files at the end of the test run.
+
+These results can be plugged into, for example, Hudson or Jenkins.
+This format is also the default used by CircleCI.
 
 == USAGE:
 
 In order to use this gem, add it to your Gemfile:
 
-    gem "minitest-cli"
+    gem "minitest-ci"
 
-To make integration with CircleCI easier, make sure you have a ":test" task defined. You can do simply by adding the following to your Rakefile:
+To make integration with CircleCI easier, make sure you have a ":test" task defined.
+You can do this by simply adding the following to your Rakefile:
 
     require 'rake/testtask'
 
@@ -39,13 +42,31 @@ To configure the test output folder, use the "--ci-dir=" option, setting it in
 TESTOPTS.  On CircleCI, you might want to use something like this in your
 circle.yml:
 
+    machine:
+      environment:
+        TESTOPTS: "--ci-dir=$CIRCLE_TEST_REPORTS/reports"
     test:
       override:
-        - bundle exec rake test TESTOPTS="--ci-dir=$CIRCLE_TEST_REPORTS/reports":
+        - bundle exec rake test:
             parallel: true
             files:
               - test/**/*.rb
 
+Alternatively, you can add the following code to your test runner setup:
+
+    # test/helper.rb
+    require 'minitest'
+    require 'minitest/autorun'
+    require 'minitest/ci'
+
+    if ENV["CIRCLECI"]
+      Minitest::Ci.report_dir = "#{ENV["CIRCLE_TEST_REPORTS"]}/reports"
+    end
+
+    class MiniTest::Test
+      # include other helpers, etc
+    end
+
 
 **NOTE**: The report directory is cleaned between test runs. To disable:
 

data/lib/minitest-ci.rb

@@ -0,0 +1,2 @@
+require 'minitest'
+require 'minitest/ci'

data/lib/minitest/ci.rb

@@ -2,15 +2,11 @@ require 'fileutils'
 require 'cgi'
 
 module Minitest
-  class Ci
-
-    VERSION = '3.1.0'
-
+  class Ci < Reporter
     class << self
 
       ##
-      # Accessor method to change the report dir if you don't like the
-      # defaults.
+      # Change the report directory. (defaults to "test/reports")
 
       attr_accessor :report_dir
 
@@ -18,6 +14,9 @@ module Minitest
       # Clean the report_dir between test runs? (defaults to true)
 
       attr_accessor :clean
+
+      ##
+      # Change the working directory. (defaults to `$PWD`)
       attr_accessor :working_dir
     end
 
@@ -48,14 +47,16 @@ module Minitest
       results[result.class] << result
     end
 
+    ##
+    # Generate test report
     def report
       io.puts
-      io.puts 'generating ci files'
+      io.puts '[Minitest::CI] Generating test report in JUnit XML format...'
 
       Dir.chdir report_dir do
-        results.each do |name, resultz|
-          File.open "TEST-#{CGI.escape(name.to_s)}.xml"[0, 255], "w" do |f|
-            f.puts generate_results name, resultz
+        results.each do |name, result|
+          File.open(report_name(name), "w") do |f|
+            f.puts( generate_results(name, result) )
           end
         end
       end
@@ -72,7 +73,7 @@ module Minitest
       results.each do |result|
         total_time += result.time
         assertions += result.assertions
-        # p result.failure.class
+
         case result.failure
         when Skip
           skips += 1
@@ -83,7 +84,7 @@ module Minitest
         end
       end
 
-      base = self.class.working_dir + '/'
+      base = working_dir + '/'
       xml = []
 
       xml << '<?xml version="1.0" encoding="UTF-8"?>'
@@ -116,6 +117,10 @@ module Minitest
       xml
     end
 
+    def working_dir
+      options.fetch(:working_dir, self.class.working_dir)
+    end
+
     def report_dir
       options.fetch(:ci_dir, self.class.report_dir)
     end
@@ -124,5 +129,8 @@ module Minitest
       options.fetch(:ci_clean, self.class.clean)
     end
 
+    def report_name(name)
+      "TEST-#{CGI.escape(name.to_s.gsub(/\W+/, '_'))}.xml"[0, 255]
+    end
   end
 end

data/lib/minitest/ci_plugin.rb

@@ -14,6 +14,10 @@ module Minitest
     opts.on "--[no-]ci-clean", "Clean the CI report dir in between test runs. Default #{Ci.clean}" do |clean|
       options[:ci_clean] = clean
     end
+
+    opts.on "--working-dir DIR", "Set the working dir. Default to #{Ci.working_dir}" do |dir|
+      options[:working_dir] = dir
+    end
   end
 
 end

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: minitest-ci
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
+- zzak
 - bhenderson
 - notnoop
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-23 00:00:00.000000000 Z
+date: 2017-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -18,9 +19,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.6
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -28,9 +26,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 5.0.6
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -87,6 +82,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 2.4.2
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: ZenTest
   requirement: !ruby/object:Gem::Requirement
@@ -110,6 +119,7 @@ extra_rdoc_files: []
 files:
 - README.rdoc
 - lib/autotest/minitest_ci.rb
+- lib/minitest-ci.rb
 - lib/minitest/ci.rb
 - lib/minitest/ci_plugin.rb
 homepage: https://github.com/circleci/minitest-ci
@@ -131,7 +141,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.6
+rubygems_version: 2.6.8
 signing_key: 
 specification_version: 4
 summary: Minitest JUnit XML formatter