danger-junit 0.7.2 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 58c923a604963a4621a2ba5bd2034933df54b684
-  data.tar.gz: eddcbb189a7161a39db64ea1ee95d6c3a4303229
+SHA256:
+  metadata.gz: 7bf7c5a5328e43b8014cb99e27f27987b17a3c9562e509f71f509bba2139bf83
+  data.tar.gz: b75de0c8814196c011e44d3fd553696cf2d8c621c0bb8914c14b3dd40ebab0cc
 SHA512:
-  metadata.gz: 89f9ba58e802a44f84c1e0a5a0002ebd19d1982b09ea2c29d23a713f96016de2f227efe069dfa91a55a0fd465f2ceffad94ded81c8d757b729dcadbcb972af71
-  data.tar.gz: bb4a172c51a0277c9be1da381faba9e3ffbf7bf61afd8eb574f42db9787133b02ac2703099f4bcaca42dd53523a428475f7b38b31294dcbbb5707ad9ba01b75d
+  metadata.gz: da893811b7e22728066d62ef78c6028618c722486abb4649408cbb9ea1476f9e229ea2fc924f209bf576801372f97e6ddaddefed41847b7316b88a06dfdde9aa
+  data.tar.gz: 0dd551a5209f12bc66638ea19cc6e70660feab9b811bc5b4bcb2e5a774ae5d8973837dfab5953674762532b14fb2ba54e42fb95847dfac0fdac87e16bd8b8308

data/Gemfile.lock

@@ -1,44 +1,47 @@
 PATH
   remote: .
   specs:
-    danger-junit (0.6.4)
-      danger (~> 2.0)
+    danger-junit (1.0.1)
+      danger (> 2.0)
       ox (~> 2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.4.0)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     ast (2.3.0)
     builder (3.2.2)
-    claide (1.0.0)
-    claide-plugins (0.9.1)
+    claide (1.0.3)
+    claide-plugins (0.9.2)
       cork
       nap
       open4 (~> 1.3)
     coderay (1.1.1)
-    colored (1.2)
-    cork (0.1.0)
-      colored (~> 1.2)
-    danger (2.1.1)
+    colored2 (3.1.2)
+    cork (0.3.0)
+      colored2 (~> 3.1)
+    danger (5.9.0)
       claide (~> 1.0)
-      claide-plugins (> 0.9.0)
-      colored (~> 1.2)
+      claide-plugins (>= 0.9.2)
+      colored2 (~> 3.1)
       cork (~> 0.1)
-      faraday (~> 0)
+      faraday (~> 0.9)
       faraday-http-cache (~> 1.0)
-      git (~> 1)
+      git (~> 1.5)
       kramdown (~> 1.5)
-      octokit (~> 4.2)
+      no_proxy_fix
+      octokit (~> 4.7)
       terminal-table (~> 1)
     diff-lcs (1.2.5)
-    faraday (0.9.2)
+    faraday (0.17.3)
       multipart-post (>= 1.2, < 3)
-    faraday-http-cache (1.3.0)
+    faraday-http-cache (1.3.1)
       faraday (~> 0.8)
     ffi (1.9.14)
     formatador (0.2.5)
-    git (1.3.0)
+    git (1.7.0)
+      rchardet (~> 1.8)
     guard (2.14.0)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
@@ -53,22 +56,24 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    kramdown (1.11.1)
+    kramdown (1.17.0)
     listen (3.0.7)
       rb-fsevent (>= 0.9.3)
       rb-inotify (>= 0.9.7)
     lumberjack (1.0.10)
     method_source (0.8.2)
-    multipart-post (2.0.0)
+    multipart-post (2.1.1)
     nap (1.1.0)
     nenv (0.3.0)
+    no_proxy_fix (0.1.2)
     notiffany (0.1.1)
       nenv (~> 0.1)
       shellany (~> 0.0)
-    octokit (4.3.0)
-      sawyer (~> 0.7.0, >= 0.5.3)
+    octokit (4.16.0)
+      faraday (>= 0.9)
+      sawyer (~> 0.8.0, >= 0.5.3)
     open4 (1.3.4)
-    ox (2.4.3)
+    ox (2.13.2)
     parser (2.3.1.2)
       ast (~> 2.2)
     powerpack (0.1.1)
@@ -76,11 +81,13 @@ GEM
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)
+    public_suffix (4.0.5)
     rainbow (2.1.0)
     rake (10.5.0)
     rb-fsevent (0.9.7)
     rb-inotify (0.9.7)
       ffi (>= 0.5.0)
+    rchardet (1.8.0)
     rspec (3.5.0)
       rspec-core (~> 3.5.0)
       rspec-expectations (~> 3.5.0)
@@ -104,12 +111,13 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (~> 1.0, >= 1.0.1)
     ruby-progressbar (1.8.1)
-    sawyer (0.7.0)
-      addressable (>= 2.3.5, < 2.5)
-      faraday (~> 0.8, < 0.10)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
     shellany (0.0.1)
     slop (3.6.0)
-    terminal-table (1.6.0)
+    terminal-table (1.7.0)
+      unicode-display_width (~> 1.1)
     thor (0.19.1)
     unicode-display_width (1.1.0)
     yard (0.9.5)
@@ -131,4 +139,4 @@ DEPENDENCIES
   yard (~> 0.8)
 
 BUNDLED WITH
-   1.12.5
+   1.17.3

data/README.md

@@ -72,6 +72,7 @@ fail("Tests failed") unless junit.failures.empty?
   <pre>
 junit.parse "/path/to/output.xml"
 junit.show_skipped_tests = true
+junit.skipped_headers = [:name, :file]
 junit.report</pre>
 </blockquote>
 
@@ -109,6 +110,10 @@ message "#{slowest_test[:time]} took #{slowest_test[:time]} seconds"
 `headers` - An array of symbols that become the columns of your tests,
 if `nil`, the default, it will be all of the attributes.
 
+`skipped_headers` - An array of symbols that become the columns of your skipped tests, 
+if `nil`, the default, it will be all of the attributes for a single parse 
+or all of the common attributes between multiple files
+
 
 
 #### Methods

data/lib/junit/gem_version.rb

@@ -1,3 +1,3 @@
 module Junit
-  VERSION = '0.7.2'.freeze
+  VERSION = '1.0.2'.freeze
 end

data/lib/junit/plugin.rb

@@ -14,6 +14,16 @@ module Danger
   #          junit.parse "/path/to/output.xml"
   #          junit.report
   #
+  # @example Parse multiple XML files by passing multiple file names
+  #
+  #          junit.parse_files "/path/to/integration-tests.xml", "/path/to/unit-tests.xml"
+  #          junit.report
+  #
+  # @example Parse multiple XML files by passing an array
+  #          result_files = %w(/path/to/integration-tests.xml /path/to/unit-tests.xml)
+  #          junit.parse_files result_files
+  #          junit.report
+  #
   # @example Let the plugin parse the XML file, and report yourself
   #
   #          junit.parse "/path/to/output.xml"
@@ -76,28 +86,48 @@ module Danger
     attr_accessor :show_skipped_tests
 
     # An array of symbols that become the columns of your tests,
-    # if `nil`, the default, it will be all of the attributes.
+    # if `nil`, the default, it will be all of the attributes for a single parse
+    # or all of the common attributes between multiple files
     #
     # @return   [Array<Symbol>]
     attr_accessor :headers
 
+    # An array of symbols that become the columns of your skipped tests,
+    # if `nil`, the default, it will be all of the attributes for a single parse
+    # or all of the common attributes between multiple files
+    #
+    # @return   [Array<Symbol>]
+    attr_accessor :skipped_headers
+
     # Parses an XML file, which fills all the attributes,
     # will `raise` for errors
     # @return   [void]
     def parse(file)
+      parse_files(file)
+    end
+
+    # Parses multiple XML files, which fills all the attributes,
+    # will `raise` for errors
+    # @return   [void]
+    def parse_files(*files)
       require 'ox'
-      raise "No Junit file was found at #{file}" unless File.exist? file
+      @tests = []
+      failed_tests = []
 
-      xml_string = File.read(file)
-      @doc = Ox.parse(xml_string)
+      Array(files).flatten.each do |file|
+        raise "No JUnit file was found at #{file}" unless File.exist? file
 
-      suite_root = @doc.nodes.first.value == 'testsuites' ? @doc.nodes.first : @doc
-      @tests = suite_root.nodes.map(&:nodes).flatten.select { |node| node.value == 'testcase' }
+        xml_string = File.read(file)
+        doc = Ox.parse(xml_string)
 
-      failed_suites = suite_root.nodes.select { |suite| suite[:failures].to_i > 0 || suite[:errors].to_i > 0 }
-      failed_tests = failed_suites.map(&:nodes).flatten.select { |node| node.value == 'testcase' }
+        suite_root = doc.nodes.first.value == 'testsuites' ? doc.nodes.first : doc
+        @tests += suite_root.nodes.map(&:nodes).flatten.select { |node| node.kind_of?(Ox::Element) && node.value == 'testcase' }
 
-      @failures = failed_tests.select do |test| 
+        failed_suites = suite_root.nodes.select { |suite| suite[:failures].to_i > 0 || suite[:errors].to_i > 0 }
+        failed_tests += failed_suites.map(&:nodes).flatten.select { |node| node.kind_of?(Ox::Element) && node.value == 'testcase' }
+      end
+
+      @failures = failed_tests.select do |test|
         test.nodes.count > 0
       end.select do |test|
         node = test.nodes.first
@@ -127,32 +157,52 @@ module Danger
     # @return   [void]
     def report
       return if failures.nil? # because danger calls `report` before loading a file
-      warn("Skipped #{skipped.count} tests.") if show_skipped_tests && skipped.count > 0
+      if show_skipped_tests && skipped.count > 0
+        warn("Skipped #{skipped.count} tests.")
+
+        message = "### Skipped: \n\n"
+        message << get_report_content(skipped, skipped_headers)
+        markdown message
+
+      end
 
       unless failures.empty? && errors.empty?
         fail('Tests have failed, see below for more information.', sticky: false)
-        message = "### Tests: \n\n"
 
+        message = "### Tests: \n\n"
         tests = (failures + errors)
-        keys = headers || tests.first.attributes.keys
-        attributes = keys.map(&:to_s).map(&:capitalize)
-
-        # Create the headers
-        message << attributes.join(' | ') + "|\n"
-        message << attributes.map { |_| '---' }.join(' | ') + "|\n"
-
-        # Map out the keys to the tests
-        tests.each do |test|
-          row_values = keys.map { |key| test.attributes[key] }.map { |v| auto_link(v) }
-          message << row_values.join(' | ') + "|\n"
-        end
-
+        message << get_report_content(tests, headers)
         markdown message
       end
     end
 
     private
 
+    def get_report_content(tests, headers)
+      message = ''
+      common_attributes = tests.map{|test| test.attributes.keys }.inject(&:&)
+
+      # check the provided headers are available
+      unless headers.nil?
+        not_available_headers = headers.select { |header| not common_attributes.include?(header) }
+        raise "Some of headers provided aren't available in the JUnit report (#{not_available_headers})" unless not_available_headers.empty?
+      end
+
+      keys = headers || common_attributes
+      attributes = keys.map(&:to_s).map(&:capitalize)
+
+      # Create the headers
+      message << attributes.join(' | ') + "|\n"
+      message << attributes.map { |_| '---' }.join(' | ') + "|\n"
+
+      # Map out the keys to the tests
+      tests.each do |test|
+        row_values = keys.map { |key| test.attributes[key] }.map { |v| auto_link(v) }
+        message << row_values.join(' | ') + "|\n"
+      end
+      message
+    end
+
     def auto_link(value)
       if File.exist?(value) && defined?(@dangerfile.github)
         github.html_link(value, full_path: false)

data/spec/fixtures/fastlane_trainer.xml

@@ -1,5 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <testsuites tests="2" failures="1">
+    <testsuite name="EmptyTests" tests="0" failures="0">
+    </testsuite>
     <testsuite name="ThemojiUITests" tests="2" failures="1">
         <testcase classname="ThemojiUITests" name="testExample()">
         </testcase>
@@ -8,4 +10,4 @@
             </failure>
         </testcase>
     </testsuite>
-</testsuites>
+</testsuites>

data/spec/junit_spec.rb

@@ -55,7 +55,7 @@ module Danger
 
         output = @junit.status_report[:markdowns].first
         row = '| Danger::CISource::CircleCI validates when circle all env vars are set | ./spec/lib/danger/ci_sources/circle_spec.rb | 0.012097|'
-        expect(output).to include(row)
+        expect(output.to_s).to include(row)
       end
 
       it 'shows a known markdown row' do
@@ -65,7 +65,7 @@ module Danger
 
         output = @junit.status_report[:markdowns].first
         row = "Time|\n"
-        expect(output).to include(row)
+        expect(output.to_s).to include(row)
       end
 
       it 'shows a warning for skipped' do
@@ -78,14 +78,44 @@ module Danger
       end
 
       it 'links paths that are files' do
-        allow(@dangerfile.github).to receive(:pr_json).and_return(head: { repo: { html_url: 'https://github.com/thing/thingy' } })
+        allow(@dangerfile.github).to receive(:pr_json).and_return('head' => { 'repo' => { 'html_url' => 'https://github.com/thing/thingy' } })
         allow(@dangerfile.github).to receive(:head_commit).and_return('hello')
 
         @junit.parse 'spec/fixtures/danger-junit-fail.xml'
         @junit.report
 
         outputs = @junit.status_report[:markdowns].first
-        expect(outputs).to include('github.com/thing/thingy')
+        expect(outputs.to_s).to include('github.com/thing/thingy')
+      end
+
+      describe 'parsing multiple files' do
+        it 'gets the right results for multiple files' do
+          @junit.parse_files 'spec/fixtures/rspec_fail.xml', 'spec/fixtures/fastlane_trainer.xml'
+
+          expect(@junit.failures.count).to eq 1 + 1
+          expect(@junit.passes.count).to eq 190 + 1
+          expect(@junit.errors.count).to eq 0 + 0
+          expect(@junit.skipped.count).to eq 7 + 0
+        end
+
+        it 'gets the right results for an array of files' do
+          files = %w(spec/fixtures/rspec_fail.xml spec/fixtures/fastlane_trainer.xml)
+          @junit.parse_files files
+
+          expect(@junit.failures.count).to eq 1 + 1
+          expect(@junit.passes.count).to eq 190 + 1
+          expect(@junit.errors.count).to eq 0 + 0
+          expect(@junit.skipped.count).to eq 7 + 0
+        end
+
+        it 'defaults to reporting common attributes for multiple files' do
+          @junit.parse_files 'spec/fixtures/rspec_fail.xml', 'spec/fixtures/eigen_fail.xml'
+
+          @junit.report
+
+          outputs = @junit.status_report[:markdowns].first
+          expect(outputs.to_s).to include('Classname | Name')
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-junit
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 1.0.2
 platform: ruby
 authors:
 - Orta Therox
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-01-12 00:00:00.000000000 Z
+date: 2020-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger
@@ -225,8 +225,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
 summary: Get automatic inline test reporting for JUnit-conforming XML files