junit_merge 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 169f38c3ea35ae927f10d041fbad8900d4f4a6f2
+  data.tar.gz: 4a030a4641249fb436e1743f9d94af9c531e3a30
+SHA512:
+  metadata.gz: ba9ad5426d4470db02143255d8417e3b78d870be9b31b3334fbb89e77e0a19967c8fdfe7c03f853d1bee02cd083f4a4a86a07cc9cbc967c6f074998bfcd2235d
+  data.tar.gz: 8ed014fb7239a6964fa45804ac453062613d7af00c7ddbd1679b6ca1dad872164c2a9fca2d5fcc6f9fc4809c642ce984185d594b319739b8c3e793b2b59effa8

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/CHANGELOG

@@ -0,0 +1,3 @@
+== 0.0.1 2014-04-15
+
+ * Hi.

data/Gemfile

@@ -0,0 +1,9 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'temporaries'
+
+group :dev do
+  gem 'byebug'
+  gem 'looksee'
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) George Ogata
+
+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.markdown

@@ -0,0 +1,94 @@
+## JUnit Merge
+
+Merges two JUnit XML reports, such that results from one run may override those
+in the other. Reports may be single files or directory trees.
+
+## Usage
+
+Install:
+
+    gem install junit_merge
+
+Run:
+
+    junit_merge SOURCE.xml TARGET.xml
+
+Test results in SOURCE.xml will overwrite their counterparts in
+TARGET.xml. Summary statistics will be updated as necessary.
+
+## Why?
+
+The intended use case is rerunning failures in CI.
+
+Of course, your test suite *should* pass 100% of the time, be free from
+nondeterminism, never modify global state, not rely on external services, and
+all those good things.
+
+But this is real life.
+
+Sometimes you don't have a spare week to diagnose intermittent failures plaguing
+your build. Or perhaps you're dealing with a legacy suite. Or you're relying on
+tools which offer no synchronization mechanisms, making you resort to sleeps
+which don't always suffice on a cheap, underpowered CI box. Or you're dealing
+with an integration suite that legitmately hits some external service over a
+flaky network connection.
+
+This one's for you poor buggers. :beer:
+
+## Example
+
+Here's an example of how to set up an [RSpec][rspec] suite under
+[Jenkins][jenkins].
+
+First, we need to output the results to a file in JUnit format.
+
+    rspec --format progress --format RspecJunitFormatter --out reports/rspec.xml spec
+
+Next, we need to add options to dump the failed examples to a file. An easy way
+is using [respec][respec]: simply change `rspec` to `respec`. Another option
+is to use the failures logger in [parallel_tests][parallel-tests].
+
+    respec --format progress --format RspecJunitFormatter --out reports/rspec.xml spec
+
+Now, if the first build returns non-zero, we'll need to run just the
+failures. With respec, we can use the `f` specifier. We should also output the
+junit report to a different location:
+
+    respec --format progress --format RspecJunitFormatter --out reports/rspec-rerun.xml f
+
+Finally, if the rerun was required, we can merge the rerun results into the
+original results:
+
+    junit_merge reports/rspec-rerun.xml reports/rspec.xml
+
+Putting it all together:
+
+    #!/bin/sh -x
+
+    status=0
+    if ! respec --format progress --format RspecJunitFormatter --out reports/rspec.xml spec; then
+      respec --format progress --format RspecJunitFormatter --out reports/rspec-rerun.xml f
+      status=$?
+      junit_merge reports/rspec-rerun.xml reports/rspec.xml
+    fi
+    exit $status
+
+Note that if you don't specify the shebang, Jenkins will run your shell with
+`-ex`, which will stop execution after the first build failure.
+
+[rspec]: https://github.com/rspec/rspec
+[jenkins]: http://jenkins-ci.org/
+[respec]: https://github.com/oggy/respec
+[parallel-tests]: https://github.com/grosser/parallel_tests
+
+## Contributing
+
+ * [Bug reports](https://github.com/oggy/junit_merge/issues)
+ * [Source](https://github.com/oggy/junit_merge)
+ * Patches: Fork on Github, send pull request.
+   * Include tests where practical.
+   * Leave the version alone, or bump it in a separate commit.
+
+## Copyright
+
+Copyright (c) George Ogata. See LICENSE for details.

data/Rakefile

@@ -0,0 +1 @@
+require 'ritual'

data/bin/junit_merge

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'junit_merge/app'
+
+exit JunitMerge::App.new.run(*ARGV)

data/junit_merge.gemspec

@@ -0,0 +1,19 @@
+$:.unshift File.expand_path('lib', File.dirname(__FILE__))
+require 'junit_merge/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'junit_merge'
+  gem.version       = JunitMerge::VERSION
+  gem.authors       = ['George Ogata']
+  gem.email         = ['george.ogata@gmail.com']
+  gem.description   = "Tool to merge JUnit XML reports."
+  gem.summary       = ""
+  gem.homepage      = ''
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+
+  gem.add_runtime_dependency 'nokogiri', '>= 1.5', '< 2.0'
+  gem.add_development_dependency 'ritual', '~> 0.4'
+end

data/lib/junit_merge.rb

@@ -0,0 +1,4 @@
+module JunitMerge
+  autoload :App, 'junit_merge/app'
+  autoload :VERSION, 'junit_merge/version'
+end

data/lib/junit_merge/app.rb

@@ -0,0 +1,133 @@
+require 'find'
+require 'fileutils'
+require 'nokogiri'
+
+module JunitMerge
+  class App
+    Error = Class.new(RuntimeError)
+
+    def initialize(options={})
+      @stdin  = options[:stdin ] || STDIN
+      @stdout = options[:stdout] || STDOUT
+      @stderr = options[:stderr] || STDERR
+    end
+
+    attr_reader :stdin, :stdout, :stderr
+
+    def run(*args)
+      source_path, target_path = parse_args(args)
+
+      not_found = [source_path, target_path].select { |path| !File.exist?(path) }
+      not_found.empty? or
+        raise Error, "no such file: #{not_found.join(', ')}"
+
+      if File.directory?(source_path)
+        Find.find(source_path) do |source_file_path|
+          next if !File.file?(source_file_path)
+          target_file_path = source_file_path.sub(source_path, target_path)
+          if File.exist?(target_file_path)
+            merge_file(source_file_path, target_file_path)
+          else
+            FileUtils.mkdir_p(File.dirname(target_file_path))
+            FileUtils.cp(source_file_path, target_file_path)
+          end
+        end
+      elsif File.exist?(source_path)
+        merge_file(source_path, target_path)
+      else
+        raise Error, "no such file: #{source_path}"
+      end
+      0
+    rescue Error => error
+      stderr.puts error.message
+      1
+    end
+
+    private
+
+    def merge_file(source_path, target_path)
+      source_text = File.read(source_path)
+      target_text = File.read(target_path)
+
+      if target_text =~ /\A\s*\z/m
+        return
+      end
+
+      if source_text =~ /\A\s*\z/m
+        FileUtils.cp source_path, target_path
+        return
+      end
+
+      source = Nokogiri::XML::Document.parse(source_text)
+      target = Nokogiri::XML::Document.parse(target_text)
+
+      source.xpath("//testsuite/testcase").each do |node|
+        summary_diff = SummaryDiff.new
+        summary_diff.add(node, 1)
+
+        predicates = [
+          attribute_predicate('classname', node['classname']),
+          attribute_predicate('name', node['name']),
+        ].join(' and ')
+        original = target.xpath("testsuite/testcase[#{predicates}]").first
+
+        if original
+          summary_diff.add(original, -1)
+          original.replace(node)
+        else
+          testsuite = target.xpath("testsuite").first
+          testsuite.add_child(node)
+        end
+
+        node.ancestors.select { |a| a.name =~ /\Atestsuite?\z/ }.each do |suite|
+          summary_diff.apply_to(suite)
+        end
+      end
+
+      open(target_path, 'w') { |f| f.write(target.to_s) }
+    end
+
+    def attribute_predicate(name, value)
+      # XPath doesn't let you escape the delimiting quotes. Need concat() here
+      # to support the general case.
+      escaped = value.to_s.gsub('"', '", \'"\', "')
+      "@#{name}=concat('', \"#{escaped}\")"
+    end
+
+    def apply_summary_diff(diff, node)
+      summary_diff.each do |key, delta|
+      end
+    end
+
+    SummaryDiff = Struct.new(:tests, :failures, :errors, :skipped) do
+      def initialize
+        self.tests = self.failures = self.errors = self.skipped = 0
+      end
+
+      def add(test_node, delta)
+        self.tests += delta
+        self.failures += delta if !test_node.xpath('failure').empty?
+        self.errors += delta if !test_node.xpath('error').empty?
+        self.skipped += delta if !test_node.xpath('skipped').empty?
+      end
+
+      def apply_to(node)
+        %w[tests failures errors skipped].each do |attribute|
+          if (value = node[attribute])
+            node[attribute] = value.to_i + send(attribute)
+          end
+        end
+      end
+    end
+
+    def parse_args(args)
+      args.size == 2 or
+        raise Error, usage
+      args
+    end
+
+    def usage
+      "USAGE: #$0 SOURCE TARGET"
+    end
+  end
+end

data/lib/junit_merge/version.rb

@@ -0,0 +1,11 @@
+module JunitMerge
+  VERSION = [0, 0, 1]
+
+  class << VERSION
+    include Comparable
+
+    def to_s
+      join('.')
+    end
+  end
+end

data/test/junit_merge/test_app.rb

@@ -0,0 +1,194 @@
+require_relative '../test_helper'
+require 'erb'
+
+describe JunitMerge::App do
+  TEMPLATE = File.read("#{ROOT}/test/template.xml.erb")
+
+  use_temporary_directory "#{ROOT}/test/tmp"
+
+  def create_file(path, tests)
+    num_tests = tests.size
+    num_failures = tests.values.count(:fail)
+    num_errors = tests.values.count(:error)
+    num_skipped = tests.values.count(:skipped)
+
+    FileUtils.mkdir_p File.dirname(path)
+    open(path, 'w') do |file|
+      file.puts ERB.new(TEMPLATE).result(binding)
+    end
+  end
+
+  def create_directory(path)
+    FileUtils.mkdir_p path
+  end
+
+  def parse_file(path)
+    Nokogiri::XML::Document.parse(File.read(path))
+  end
+
+  def results(node)
+    results = []
+    node.xpath('//testcase').each do |testcase_node|
+      if !testcase_node.xpath('failure').empty?
+        result = :fail
+      elsif !testcase_node.xpath('error').empty?
+        result = :error
+      elsif !testcase_node.xpath('skipped').empty?
+        result = :skipped
+      else
+        result = :pass
+      end
+      class_name = testcase_node['classname']
+      test_name = testcase_node['name']
+      results << ["#{class_name}.#{test_name}", result]
+    end
+    results
+  end
+
+  def summaries(node)
+    summaries = []
+    node.xpath('//testsuite | //testsuites').each do |node|
+      summary = {}
+      %w[tests failures errors skipped].each do |attribute|
+        if (value = node[attribute])
+          summary[attribute.to_sym] = Integer(value)
+        end
+      end
+      summaries << summary
+    end
+    summaries
+  end
+
+  let(:stdin ) { StringIO.new }
+  let(:stdout) { StringIO.new }
+  let(:stderr) { StringIO.new }
+  let(:app) { JunitMerge::App.new(stdin: stdin, stdout: stdout, stderr: stderr) }
+
+  describe "when merging files" do
+    it "merges results" do
+      create_file("#{tmp}/source.xml", 'a.a' => :pass, 'a.b' => :fail, 'a.c' => :error, 'a.d' => :skipped)
+      create_file("#{tmp}/target.xml", 'a.a' => :fail, 'a.b' => :error, 'a.c' => :skipped, 'a.d' => :pass)
+      app.run("#{tmp}/source.xml", "#{tmp}/target.xml").must_equal 0
+      document = parse_file("#{tmp}/target.xml")
+      results(document).must_equal([['a.a', :pass], ['a.b', :fail], ['a.c', :error], ['a.d', :skipped]])
+      stdout.string.must_equal('')
+      stderr.string.must_equal('')
+    end
+
+    it "updates summaries" do
+      create_file("#{tmp}/source.xml", 'a.a' => :pass, 'a.b' => :skipped, 'a.c' => :fail)
+      create_file("#{tmp}/target.xml", 'a.a' => :fail, 'a.b' => :error, 'a.c' => :fail)
+      app.run("#{tmp}/source.xml", "#{tmp}/target.xml").must_equal 0
+      document = parse_file("#{tmp}/target.xml")
+      summaries(document).must_equal([{tests: 3, failures: 1, errors: 0, skipped: 1}])
+      stdout.string.must_equal('')
+      stderr.string.must_equal('')
+    end
+
+    it "does not modify nodes only in the target" do
+      create_file("#{tmp}/source.xml", 'a.b' => :pass)
+      create_file("#{tmp}/target.xml", 'a.a' => :pass, 'a.b' => :fail)
+      app.run("#{tmp}/source.xml", "#{tmp}/target.xml").must_equal 0
+      document = parse_file("#{tmp}/target.xml")
+      results(document).must_equal([['a.a', :pass], ['a.b', :pass]])
+      stdout.string.must_equal('')
+      stderr.string.must_equal('')
+    end
+
+    it "appends nodes only in the source" do
+      create_file("#{tmp}/source.xml", 'a.a' => :fail, 'a.b' => :error)
+      create_file("#{tmp}/target.xml", 'a.a' => :pass)
+      app.run("#{tmp}/source.xml", "#{tmp}/target.xml").must_equal 0
+      document = parse_file("#{tmp}/target.xml")
+      results(document).must_equal([['a.a', :fail], ['a.b', :error]])
+      summaries(document).must_equal([{tests: 2, failures: 1, errors: 1, skipped: 0}])
+      stdout.string.must_equal('')
+      stderr.string.must_equal('')
+    end
+
+    it "correctly merges tests with metacharacters in the name" do
+      create_file("#{tmp}/source.xml", 'a\'"a.b"\'b' => :pass)
+      create_file("#{tmp}/target.xml", 'a\'"a.b"\'b' => :fail)
+      app.run("#{tmp}/source.xml", "#{tmp}/target.xml").must_equal 0
+      document = parse_file("#{tmp}/target.xml")
+      results(document).must_equal([['a\'"a.b"\'b', :pass]])
+      summaries(document).must_equal([{tests: 1, failures: 0, errors: 0, skipped: 0}])
+      stdout.string.must_equal('')
+      stderr.string.must_equal('')
+    end
+
+    it "correctly merges tests with the same name in different classes" do
+      create_file("#{tmp}/source.xml", 'a.a' => :pass, 'b.a' => :fail)
+      create_file("#{tmp}/target.xml", 'a.a' => :fail, 'b.a' => :pass)
+      app.run("#{tmp}/source.xml", "#{tmp}/target.xml").must_equal 0
+      document = parse_file("#{tmp}/target.xml")
+      results(document).must_equal([['a.a', :pass], ['b.a', :fail]])
+      stdout.string.must_equal('')
+      stderr.string.must_equal('')
+    end
+  end
+
+  describe "when merging directories" do
+    it "updates target files from each file in the source directory" do
+      create_file("#{tmp}/source/a.xml", 'a.a' => :pass, 'a.b' => :fail)
+      create_file("#{tmp}/target/a.xml", 'a.a' => :fail, 'a.b' => :pass)
+      app.run("#{tmp}/source", "#{tmp}/target").must_equal 0
+      document = parse_file("#{tmp}/target/a.xml")
+      results(document).must_equal([['a.a', :pass], ['a.b', :fail]])
+      stdout.string.must_equal('')
+      stderr.string.must_equal('')
+    end
+
+    it "does not modify files only in the target" do
+      FileUtils.mkdir "#{tmp}/source"
+      create_file("#{tmp}/target/a.xml", 'a.a' => :fail, 'a.b' => :pass)
+      app.run("#{tmp}/source", "#{tmp}/target").must_equal 0
+      document = parse_file("#{tmp}/target/a.xml")
+      results(document).must_equal([['a.a', :fail], ['a.b', :pass]])
+      stdout.string.must_equal('')
+      stderr.string.must_equal('')
+    end
+
+    it "adds files only in the source" do
+      create_file("#{tmp}/source/a.xml", 'a.a' => :fail, 'a.b' => :pass)
+      create_directory("#{tmp}/target")
+      app.run("#{tmp}/source", "#{tmp}/target").must_equal 0
+      document = parse_file("#{tmp}/target/a.xml")
+      results(document).must_equal([['a.a', :fail], ['a.b', :pass]])
+      stdout.string.must_equal('')
+      stderr.string.must_equal('')
+    end
+  end
+
+  it "does not complain about empty files" do
+    FileUtils.touch "#{tmp}/source.xml"
+    FileUtils.touch "#{tmp}/target.xml"
+    app.run("#{tmp}/source.xml", "#{tmp}/target.xml").must_equal 0
+    File.read("#{tmp}/target.xml").must_equal('')
+    stdout.string.must_equal('')
+    stderr.string.must_equal('')
+  end
+
+  it "whines if the source does not exist" do
+    FileUtils.touch "#{tmp}/target.xml"
+    app.run("#{tmp}/source.xml", "#{tmp}/target.xml").must_equal 1
+    File.read("#{tmp}/target.xml").must_equal('')
+    stdout.string.must_equal('')
+    stderr.string.must_match /no such file/
+  end
+
+  it "whines if the target does not exist" do
+    FileUtils.touch "#{tmp}/source.xml"
+    app.run("#{tmp}/source.xml", "#{tmp}/target.xml").must_equal 1
+    stdout.string.must_equal('')
+    stderr.string.must_match /no such file/
+  end
+
+  it "errors with a usage message if 2 args aren't given" do
+    FileUtils.touch "#{tmp}/source.xml"
+    app.run("#{tmp}/source.xml").must_equal 1
+    File.read("#{tmp}/source.xml").must_equal('')
+    stdout.string.must_equal('')
+    stderr.string.must_match /USAGE/
+  end
+end

data/test/template.xml.erb

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<testsuite tests="<%= num_tests %>" failures="<%= num_failures %>" errors="<%= num_errors %>" skipped="<%= num_skipped %>" time="0.000001" timestamp="2014-04-10T14:29:06-04:00">
+  <properties/>
+  <% tests.each do |name, result| %>
+  <% class_name, test_name = name.gsub('"', '&quot;').split('.') %>
+    <testcase classname="<%= class_name %>" name="<%= test_name %>" time="0.000001">
+      <% if result == :fail %>
+        <failure message="MESSAGE" type="TYPE">
+          <![CDATA[BODY]]>
+        </failure>
+      <% elsif result == :error %>
+        <error message="MESSAGE" type="TYPE">
+          <![CDATA[BODY]]>
+        </error>
+      <% elsif result == :skipped %>
+        <skipped/>
+      <% end %>
+    </testcase>
+  <% end %>
+</testsuite>

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+ROOT = File.expand_path('..', File.dirname(__FILE__))
+$:.unshift "#{ROOT}/lib"
+
+require 'junit_merge'
+require 'minitest/spec'
+require 'temporaries'
+require 'byebug'
+require 'looksee'

metadata

@@ -0,0 +1,95 @@
+--- !ruby/object:Gem::Specification
+name: junit_merge
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- George Ogata
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.5'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: ritual
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+description: Tool to merge JUnit XML reports.
+email:
+- george.ogata@gmail.com
+executables:
+- junit_merge
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG
+- Gemfile
+- LICENSE
+- README.markdown
+- Rakefile
+- bin/junit_merge
+- junit_merge.gemspec
+- lib/junit_merge.rb
+- lib/junit_merge/app.rb
+- lib/junit_merge/version.rb
+- test/junit_merge/test_app.rb
+- test/template.xml.erb
+- test/test_helper.rb
+homepage: ''
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: ''
+test_files:
+- test/junit_merge/test_app.rb
+- test/template.xml.erb
+- test/test_helper.rb