junit_model 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7b7bf4f754ab21c30fc0557d1c32eefc872cbe31
+  data.tar.gz: b5c44f1bce90ccc586e827e5ed7a94fc8653f959
+SHA512:
+  metadata.gz: 050f4db4c9449661f95545bccbf210f1322027c65d08d2f1765015685110b4ebd0baa56081d19c39a0587aab3f69ec225e894846ac07c54257ae5b565032cba8
+  data.tar.gz: c5e8ed9dc9d34b4ba76a1fffd1039dff776466b2e636fcdb8f728c3c27f44877f3bcb817928c0b061514636c3c11bdb931205fe264b5c8ac5d57e0817a095f22

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.vscode
+.tags*

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,9 @@
+AllCops:
+  Exclude:
+    - 'junit_model.gemspec'
+    - 'Guardfile'
+    - 'bin/console'
+    - 'bin/setup'
+    - 'Rakefile'
+    - 'lib/junit_model/xml.rb'
+    - 'lib/junit_model/version.rb'

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at iain@mountain23.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,26 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+group :go, halt_on_fail: true do
+  guard :rspec, cmd: "bundle exec rspec", notification: true do
+    require "guard/rspec/dsl"
+    dsl = Guard::RSpec::Dsl.new(self)
+
+    # Feel free to open issues for suggestions and improvements
+
+    # 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
+
+  guard :rubocop do
+    watch(%r{.+\.rb$})
+    watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Iain
+
+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,58 @@
+# JunitModel
+
+A nicer way to interact with JUnit xml files.
+
+[![Build Status](https://travis-ci.org/iainsmith/junit_model.svg?branch=master)](https://travis-ci.org/iainsmith/junit_model)
+
+# Features
+
+* Merge multiple JUnit files.
+* Convert back to XML
+* A great interface to build other tools.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'junit_model'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install junit_model
+
+## Usage
+
+``` ruby
+file_path = './tests.xml'
+test_group = JunitModel::Parser.read_path(file_path) => JunitModel::TestGroup
+test_group.passed? => true
+test_group.test_count => 34
+test_group.failure_count => 0
+test_group.test_suites => [JunitModel::TestSuite]
+
+merged_test_group = JunitModel::Merger.merge(test_group, other_test_group) => JunitModel::TestGroup
+merged_test_group.test_count => 50
+merged_test_group.passed? = false
+merged_test_group.to_xml => String
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/iainsmith/junit_model. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "junit_model"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/junit_model.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'junit_model/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "junit_model"
+  spec.version       = JunitModel::VERSION
+  spec.authors       = ["Iain Smith"]
+  spec.email         = ["iain@mountain23.com"]
+
+  spec.summary       = "A nicer way to deal with JUnit style xml"
+  spec.homepage      = "https://www.github.com/iainsmith/junit_model"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "xml-simple", "1.1.5"
+  spec.add_dependency "builder"
+
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "terminal-notifier"
+  spec.add_development_dependency "terminal-notifier-guard"
+  spec.add_development_dependency "pry-remote"
+  spec.add_development_dependency "guard-rubocop"
+end

data/lib/junit_model/merger.rb

@@ -0,0 +1,84 @@
+require 'junit_model/parser'
+
+module JunitModel
+  # Merges two Junit::TestGroup into a single TestGroup
+  class Merger
+    # Optermistically merge two test_groups into one.
+    #
+    # @param test_group_a [Junit::TestGroup] a test group to be merged
+    # @param test_group_b [Junit::TestGroup] a test group to be merged
+    # @return [Junit::TestGroup] the merge test group.
+    def self.merge(test_group_a, test_group_b)
+      final_suites = merge_suite_a_into_suite_b(test_group_a, test_group_b)
+      final_suites += merge_suite_a_into_suite_b(test_group_b, test_group_a)
+      result_from_array(final_suites)
+    end
+
+    def self.merge_suite_a_into_suite_b(suite_a, result_b)
+      merged_suites = []
+      suites_grouped_by_name = suites_keyed_by_name(result_b)
+      suite_a.test_suites.each do |test_suite_a|
+        suite = suites_grouped_by_name[test_suite_a.name]
+        if suite.nil?
+          merged_suites << test_suite_a
+          next
+        end
+
+        test_suite_b = suite.first
+        merged_suite = merge_suite(test_suite_a, test_suite_b)
+        merged_suites << merged_suite unless merged_suite.nil?
+        suites_grouped_by_name.delete test_suite_a.name
+      end
+      result_b.test_suites = suites_grouped_by_name.values.flatten
+      merged_suites
+    end
+
+    def self.suites_keyed_by_name(suite)
+      suite.test_suites.group_by(&:name)
+    end
+
+    def self.merge_suite(suite_a, suite_b)
+      return suite_a if suite_b.nil?
+      return suite_b if suite_a.nil?
+      merged_test_cases = merged_test_cases(suite_a, suite_b)
+      failed_count = merged_test_cases.reject(&:passed?).count
+      JunitModel::TestSuite.new(
+        classname: suite_a.name,
+        tests: merged_test_cases.count.to_s,
+        failures: failed_count.to_s,
+        test_cases: merged_test_cases
+      )
+    end
+
+    def self.merged_test_cases(suite_a, suite_b)
+      test_cases = []
+
+      suite_b_test_cases = suite_b.test_cases.group_by(&:name)
+      suite_a.test_cases.each do |test_case|
+        test_case_b = suite_b_test_cases[test_case.name].first
+        test_cases << merge_case(test_case, test_case_b)
+      end
+      test_cases
+    end
+
+    def self.merge_case(case_a, case_b)
+      return case_a if case_a.passed? || case_b.nil?
+      case_b
+    end
+
+    def self.result_from_array(merged_suites)
+      merged_suites.reject!(&:nil?)
+      test_count = merged_suites.inject(0) { |a, e| a + e.test_count }
+      failure_count = merged_suites.inject(0) { |a, e| a + e.failures_count }
+      JunitModel::TestGroup.new(
+        tests: test_count.to_s,
+        failures: failure_count.to_s,
+        test_suites: merged_suites
+      )
+    end
+
+    private_class_method :result_from_array, :merge_case, :merge_suite
+    private_class_method :merge_suite_a_into_suite_b, :suites_keyed_by_name
+    private_class_method :merged_test_cases
+  end
+end

data/lib/junit_model/models.rb

@@ -0,0 +1,66 @@
+require 'ostruct'
+
+module JunitModel
+  # A TestGroup is the top level object in a Junit tree.
+  class TestGroup < OpenStruct
+    def test_count
+      tests.to_i
+    end
+
+    def failures_count
+      failures.to_i
+    end
+
+    def passed?
+      failures_count == 0
+    end
+
+    def to_xml
+      XMLBuilder.xml_for_result(self)
+    end
+
+    alias failure_count failures_count
+    alias passed passed?
+  end
+end
+
+module JunitModel
+  # A TestSuite belongs to a TestGroup and has an array of TestCase
+  class TestSuite < OpenStruct
+    def test_count
+      tests.to_i
+    end
+
+    def failures_count
+      failures.to_i
+    end
+
+    def passed?
+      failures == '0'
+    end
+
+    def test_cases
+      testcase
+    end
+
+    def failed_test_cases
+      test_cases.reject(&:passed?)
+    end
+
+    def passed_test_cases
+      test_cases.select(&:passed?)
+    end
+
+    alias failure_count failures_count
+    alias passed passed?
+  end
+end
+
+module JunitModel
+  # A TestCase is the atomic unit of a Junit file
+  class TestCase < OpenStruct
+    def passed?
+      failure.nil?
+    end
+  end
+end

data/lib/junit_model/parser.rb

@@ -0,0 +1,49 @@
+require 'ostruct'
+require 'junit_model/models'
+require 'xmlsimple'
+
+module JunitModel
+  # Parse a file path into a Junit::TestGroup
+  class Parser
+    def self.read_path(path)
+      Parser.new.read_path(path)
+    end
+
+    def self.read_string(string)
+      Parser.new.read_string(string)
+    end
+
+    def read_path(path)
+      test_file = File.read(path)
+      read_string(test_file)
+    end
+
+    def read_string(string)
+      test_output_hash = XmlSimple.xml_in string
+      test_group = build_test_group(test_output_hash)
+      test_group
+    end
+
+    private
+
+    def build_test_group(test_output_hash)
+      test_output_hash['test_suites'] = test_output_hash['testsuite']
+      test_output_hash.delete('testsuite')
+      group = JunitModel::TestGroup.new(test_output_hash)
+      group.test_suites = build_test_suites(group.test_suites)
+      group
+    end
+
+    def build_test_suites(test_suties_array)
+      test_suties_array.map do |suite_hash|
+        suite = JunitModel::TestSuite.new(suite_hash)
+        suite.testcase = build_test_cases(suite.testcase)
+        suite
+      end
+    end
+
+    def build_test_cases(test_cases_array)
+      test_cases_array.map { |test_hash| JunitModel::TestCase.new(test_hash) }
+    end
+  end
+end

data/lib/junit_model/version.rb

@@ -0,0 +1,3 @@
+module JunitModel
+  VERSION = '0.1.0'
+end

data/lib/junit_model/xml.rb

@@ -0,0 +1,20 @@
+require 'builder'
+
+module JunitModel
+  # Convert Junit::TestGroup to XML
+  class XMLBuilder
+    def self.xml_for_result(result)
+      builder = Builder::XmlMarkup.new indent: 2
+      builder.instruct! :xml, version: '1.0', encoding: 'UTF-8'
+      builder.testsuites(tests: result.test_count, failures: result.failures_count) do |suite_builder|
+        result.test_suites.each do |suite|
+          suite_builder.testsuite(name: suite.name, tests: suite.tests, failures: suite.failures) do |test_builder|
+            suite.test_cases.each do |test_case|
+              test_builder.testcase(classname: test_case.classname, name: test_case.name, time: test_case.time)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/junit_model.rb

@@ -0,0 +1,9 @@
+require 'junit_model/version'
+require 'junit_model/parser'
+require 'junit_model/xml'
+require 'junit_model/merger'
+require 'junit_model/models'
+
+# Junit Model is here for good
+module JunitModel
+end

metadata

@@ -0,0 +1,204 @@
+--- !ruby/object:Gem::Specification
+name: junit_model
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Iain Smith
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: xml-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.5
+- !ruby/object:Gem::Dependency
+  name: builder
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier-guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-remote
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard-rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- iain@mountain23.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- junit_model.gemspec
+- lib/junit_model.rb
+- lib/junit_model/merger.rb
+- lib/junit_model/models.rb
+- lib/junit_model/parser.rb
+- lib/junit_model/version.rb
+- lib/junit_model/xml.rb
+homepage: https://www.github.com/iainsmith/junit_model
+licenses:
+- MIT
+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.4.6
+signing_key: 
+specification_version: 4
+summary: A nicer way to deal with JUnit style xml
+test_files: []
+has_rdoc: