danger-junit 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fd37e7d87505b8882f61d0f5a9177d39f8990d6a
+  data.tar.gz: ef98520c2399b83cb9081bb4a84a16ef4c87d7ee
+SHA512:
+  metadata.gz: 6b102f1eb6e859468b7594d9f91ee05ffed730ac1cd30f44428704d38bc838638bf96708c4e258992566c75086fb32e94831736fdc3bebc90ae13075fa9fcb0e
+  data.tar.gz: 4f5944bc1493db882898df5bb439694c7bdfeb3f44eb3c87c20701acb28241bfe9f2e4064a1bab87f29ac0b6a07edc74370b54f560ffcbce2c4c7099eb013a87

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+pkg
+.idea/

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+cache:
+  directories:
+    - bundle
+
+rvm:
+  - 2.0
+  - 2.1.3
+  - 2.3.1
+
+script:
+    - bundle exec rake spec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in danger-junit.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,129 @@
+PATH
+  remote: .
+  specs:
+    danger-junit (0.5.0)
+      danger (~> 2.0)
+      ox (~> 2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.4.0)
+    ast (2.3.0)
+    claide (1.0.0)
+    claide-plugins (0.9.1)
+      cork
+      nap
+      open4 (~> 1.3)
+    coderay (1.1.1)
+    colored (1.2)
+    cork (0.1.0)
+      colored (~> 1.2)
+    danger (2.0.1)
+      claide (~> 1.0)
+      claide-plugins (> 0.9.0)
+      colored (~> 1.2)
+      cork (~> 0.1)
+      faraday (~> 0)
+      faraday-http-cache (~> 1.0)
+      git (~> 1)
+      octokit (~> 4.2)
+      redcarpet (~> 3.3)
+      terminal-table (~> 1)
+    diff-lcs (1.2.5)
+    faraday (0.9.2)
+      multipart-post (>= 1.2, < 3)
+    faraday-http-cache (1.3.0)
+      faraday (~> 0.8)
+    ffi (1.9.14)
+    formatador (0.2.5)
+    git (1.3.0)
+    guard (2.14.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (~> 1.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.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)
+    nap (1.1.0)
+    nenv (0.3.0)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    octokit (4.3.0)
+      sawyer (~> 0.7.0, >= 0.5.3)
+    open4 (1.3.4)
+    ox (2.4.3)
+    parser (2.3.1.2)
+      ast (~> 2.2)
+    powerpack (0.1.1)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    rainbow (2.1.0)
+    rake (10.5.0)
+    rb-fsevent (0.9.7)
+    rb-inotify (0.9.7)
+      ffi (>= 0.5.0)
+    redcarpet (3.3.4)
+    rspec (3.5.0)
+      rspec-core (~> 3.5.0)
+      rspec-expectations (~> 3.5.0)
+      rspec-mocks (~> 3.5.0)
+    rspec-core (3.5.2)
+      rspec-support (~> 3.5.0)
+    rspec-expectations (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-mocks (3.5.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.5.0)
+    rspec-support (3.5.0)
+    rubocop (0.42.0)
+      parser (>= 2.3.1.1, < 3.0)
+      powerpack (~> 0.1)
+      rainbow (>= 1.99.1, < 3.0)
+      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)
+    shellany (0.0.1)
+    slop (3.6.0)
+    terminal-table (1.6.0)
+    thor (0.19.1)
+    unicode-display_width (1.1.0)
+    yard (0.9.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  danger-junit!
+  guard (~> 2.14)
+  guard-rspec (~> 4.7)
+  listen (= 3.0.7)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.4)
+  rubocop (~> 0.41)
+  yard (~> 0.8)
+
+BUNDLED WITH
+   1.12.5

data/Guardfile

@@ -0,0 +1,19 @@
+# A guardfile for making Danger Plugins
+# For more info see https://github.com/guard/guard#readme
+
+# To run, use `bundle exec guard`.
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Orta Therox <orta.therox@gmail.com>
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,74 @@
+# danger-junit
+
+A description of danger-junit.
+
+## Installation
+
+    $ gem install danger-junit
+
+## Usage
+
+
+
+### junit
+
+Report, or inspect any JUnit XML formatted test suite report.
+
+Testing frameworks have standardized on the JUnit XML format for
+reporting results, this means that projects using Rspec, Jasmine, Mocha,
+XCTest and more - can all use the same Danger error reporting. Perfect.
+
+You can see some examples on [this page from Circle CI](https://circleci.com/docs/test-metadata/)
+about how you can add JUnit XML output for your testing projects.
+
+<blockquote>Parse the XML file, and let the plugin do your reporting
+  <pre>
+junit.parse "/path/to/output.xml"
+junit.report</pre>
+</blockquote>
+
+<blockquote>Let the plugin parse the XML file, and report yourself
+  <pre>
+junit.parse "/path/to/output.xml"
+fail("Tests failed") unless junit.fails.empty?</pre>
+</blockquote>
+
+<blockquote>Warn on a report about skipped tests
+  <pre>
+junit.parse "/path/to/output.xml"
+junit.show_skipped_tests = true
+junit.report</pre>
+</blockquote>
+
+
+
+#### Attributes
+<tr>
+`passes` - An array of XML elements that represent passed tests.
+<tr>
+`failures` - An array of XML elements that represent failed tests.
+<tr>
+`errors` - An array of XML elements that represent passed tests.
+<tr>
+`skipped` - An array of XML elements that represent skipped tests.
+<tr>
+`show_skipped_tests` - An attribute to make the plugin show a warning on skipped tests.
+
+
+
+#### Methods
+
+`parse` - Parses an XML file, which fills all the attributes
+will `raise` for errors
+
+`report` - Causes a build fail if there are test failures,
+and outputs a markdown table of the results.
+
+
+## Development
+
+1. Clone this repo
+2. Run `bundle install` to setup dependencies.
+3. Run `bundle exec rake spec` to run the tests.
+4. Use `bundle exec guard` to automatically have tests run as you make changes.
+5. Make your changes.

data/Rakefile

@@ -0,0 +1,23 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RSpec::Core::RakeTask.new(:specs)
+
+task default: :specs
+
+task :spec do
+  Rake::Task['specs'].invoke
+  Rake::Task['rubocop'].invoke
+  Rake::Task['spec_docs'].invoke
+end
+
+desc 'Run RuboCop on the lib/specs directory'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
+end
+
+desc 'Ensure that the plugin passes `danger plugins lint`'
+task :spec_docs do
+  sh 'bundle exec danger plugins lint'
+end

data/danger-junit.gemspec

@@ -0,0 +1,47 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'junit/gem_version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'danger-junit'
+  spec.version       = Junit::VERSION
+  spec.authors       = ['Orta Therox']
+  spec.email         = ['orta.therox@gmail.com']
+  spec.description   = 'Get automatic inline test reporting for JUnit-conforming XML files.'
+  spec.summary       = 'Get automatic inline test reporting for JUnit-conforming XML files'
+  spec.homepage      = 'https://github.com/orta/danger-junit'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'danger', '~> 2.0'
+  spec.add_runtime_dependency 'ox', '~> 2.0'
+
+  # General ruby development
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake', '~> 10.0'
+
+  # Testing support
+  spec.add_development_dependency 'rspec', '~> 3.4'
+
+  # Linting code and docs
+  spec.add_development_dependency 'rubocop', '~> 0.41'
+  spec.add_development_dependency 'yard', '~> 0.8'
+
+  # Makes testing easy via `bundle exec guard`
+  spec.add_development_dependency 'guard', '~> 2.14'
+  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+
+  # If you want to work on older builds of ruby
+  spec.add_development_dependency 'listen', '3.0.7'
+
+  # This gives you the chance to run a REPL inside your test
+  # via
+  #    binding.pry
+  # This will stop test execution and let you inspect the results
+  spec.add_development_dependency 'pry'
+end

data/lib/danger_junit.rb

@@ -0,0 +1 @@
+require 'junit/gem_version'

data/lib/danger_plugin.rb

@@ -0,0 +1 @@
+require 'junit/plugin'

data/lib/junit/gem_version.rb

@@ -0,0 +1,3 @@
+module Junit
+  VERSION = '0.5.0'.freeze
+end

data/lib/junit/plugin.rb

@@ -0,0 +1,108 @@
+module Danger
+  # Report, or inspect any JUnit XML formatted test suite report.
+  #
+  # Testing frameworks have standardized on the JUnit XML format for
+  # reporting results, this means that projects using Rspec, Jasmine, Mocha,
+  # XCTest and more - can all use the same Danger error reporting. Perfect.
+  #
+  # You can see some examples on [this page from Circle CI](https://circleci.com/docs/test-metadata/)
+  # about how you can add JUnit XML output for your testing projects.
+  #
+  # @example Parse the XML file, and let the plugin do your reporting
+  #
+  #          junit.parse "/path/to/output.xml"
+  #          junit.report
+  #
+  # @example Let the plugin parse the XML file, and report yourself
+  #
+  #          junit.parse "/path/to/output.xml"
+  #          fail("Tests failed") unless junit.fails.empty?
+  #
+  # @example Warn on a report about skipped tests
+  #
+  #          junit.parse "/path/to/output.xml"
+  #          junit.show_skipped_tests = true
+  #          junit.report
+  #
+  # @see  orta/danger-junit, danger/danger, artsy/eigen
+  # @tags testing, reporting, junit, rspec, jasmine, jest, xcpretty
+  #
+  class DangerJunit < Plugin
+    # An array of XML elements that represent passed tests.
+    #
+    # @return   [Array<Ox::Element>]
+    attr_accessor :passes
+
+    # An array of XML elements that represent failed tests.
+    #
+    # @return   [Array<Ox::Element>]
+    attr_accessor :failures
+
+    # An array of XML elements that represent passed tests.
+    #
+    # @return   [Array<Ox::Element>]
+    attr_accessor :errors
+
+    # An array of XML elements that represent skipped tests.
+    #
+    # @return   [Array<Ox::Element>]
+    attr_accessor :skipped
+
+    # An attribute to make the plugin show a warning on skipped tests.
+    #
+    # @return   [Bool]
+    attr_accessor :show_skipped_tests
+
+    # Parses an XML file, which fills all the attributes
+    # will `raise` for errors
+    # @return   [void]
+    def parse(file)
+      require 'ox'
+      raise "No Junit file was found at #{file}" unless File.exist? file
+
+      xml_string = File.read file
+      @doc = Ox.parse xml_string
+
+      suite_root = @doc.nodes.first.value == 'testsuites' ? @doc.nodes.first : @doc
+      tests = suite_root.nodes.map(&:nodes).flatten.select { |node| node.value == 'testcase' }
+
+      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' }
+
+      @failures = failed_tests.select { |test| test.nodes.count > 0 }.select { |test| test.nodes.first.value == 'failure' }
+
+      @errors = failed_tests.select { |test| test.nodes.count > 0 }.select { |test| test.nodes.first.value == 'error' }
+
+      @skipped = tests.select { |test| test.nodes.count > 0 }.select { |test| test.nodes.first.value == 'skipped' }
+
+      @passes = tests - @failures - @errors - @skipped
+    end
+
+    # Causes a build fail if there are test failures,
+    # and outputs a markdown table of the results.
+    #
+    # @return   [void]
+    def report
+      warn("Skipped #{skipped.count} tests.") if show_skipped_tests && skipped.count > 0
+
+      unless failures.empty? && errors.empty?
+        fail("Tests have failed, see below for more information.", sticky: false)
+        message = "### Tests: \n\n"
+
+        tests = (failures + errors)
+        keys = tests.first.attributes.keys
+        attributes = keys.map(&:to_s).map(&:capitalize)
+
+        # Create the header
+        message << attributes.join(' | ') + "|\n"
+        message << attributes.map { |_| '---' }.join(' | ') + "|\n"
+
+        tests.each do |test|
+          message << test.attributes.values.join(' | ') + "|\n"
+        end
+
+        markdown message
+      end
+    end
+  end
+end