jasmine_junitxml_formatter 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b6456b32d0f79ef1c46a0729cf97e91aa6a72fbe
+  data.tar.gz: 7b1cc46c50921b59b136758be96198d760f19c07
+SHA512:
+  metadata.gz: 3fb57069d004992cb4779befdcbecacc1acbd6043597093d70901c9fbbc6ed251a3c6ad7893835415f72be5a640d85180c32486b0350e4e60dfc0bdc49adbf73
+  data.tar.gz: ac9588ef857f5c42edf11dbb85660bab5a4d142f66e490b4fc38975ba2422ffc5459306b86fde896c7ff2a9971e1de99f7430dca6719d639e86dd21e553566ef

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,7 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'jasmine', :git => 'https://github.com/pivotal/jasmine-gem.git'
+# gem 'jasmine', :path => '../jasmine-gem'
+

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Pivotal Labs
+
+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,42 @@
+# Jasmine JUnit Xml Formatter [![Build Status](https://travis-ci.org/jasmine/jasmine_junitxml_formatter.png?branch=master)](https://travis-ci.org/jasmine/jasmine_junitxml_formatter)
+
+Format jasmine results as junit compatible XML so CI servers, like Hudson/Jenkins can parse it
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'jasmine_junitxml_formatter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install jasmine_junitxml_formatter
+
+## Usage
+
+- In rails, simply `run rake jasmine:ci`, tests should generate a JUnit XML file
+- Outside of rails, you may need to add `require 'jasmine_junitxml_formatter'` to your Rakefile after jasmine is required.
+
+### Configuring the output location:
+
+Create a jasmine_junitxml_formatter.yml in spec/javascripts/support with something like this:
+
+    ---
+    junit_xml_path: /absolute/path/to/output
+
+The config file will be processed with ERB if you want to make the destination dynamic. e.g.
+
+    ---
+    junit_xml_path: <%= File.join(Dir.pwd, 'some', 'relative', 'path')
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/jasmine_junitxml_formatter.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jasmine_junitxml_formatter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "jasmine_junitxml_formatter"
+  spec.version       = JasmineJunitxmlFormatter::VERSION
+  spec.authors       = ["Gregg Van Hove"]
+  spec.email         = ["pair+gvanhove@pivotallabs.com"]
+  spec.description   = %q{Format jasmine results as junit compatible XML so CI servers, like Hudson/Jenkins can parse it}
+  spec.summary       = %q{Format jasmine results as junit compatible XML so CI servers, like Hudson/Jenkins can parse it}
+  spec.homepage      = "https://github.com/jasmine/jasmine_junitxml_formatter"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency 'jasmine', '~> 2.0.0.alpha'
+  spec.add_dependency "nokogiri"
+end

data/lib/jasmine/formatters/junit_xml.rb

@@ -0,0 +1,59 @@
+require 'nokogiri'
+
+module Jasmine
+  module Formatters
+    class JunitXml
+      def initialize
+        load_config
+        @doc = Nokogiri::XML '<testsuites></testsuites>', nil, 'UTF-8'
+      end
+
+      def format(results)
+        testsuites = doc.at_css('testsuites')
+
+        results.each do |result|
+          testsuite = Nokogiri::XML::Node.new 'testsuite', doc
+          testsuite['tests'] = 1
+          testsuite['failures'] = result.failed? ? 1 : 0
+          testsuite['errors'] = 0
+          testsuite['name'] = result.suite_name
+          testsuite.parent = testsuites
+
+          testcase = Nokogiri::XML::Node.new 'testcase', doc
+          testcase['name'] = result.description
+
+          if result.failed?
+            result.failed_expectations.each do |failed_exp|
+              failure = Nokogiri::XML::Node.new 'failure', doc
+              failure['message'] = failed_exp.message
+              failure['type'] = 'Failure'
+              failure.content = failed_exp.stack
+              failure.parent = testcase
+            end
+          end
+
+          testcase.parent = testsuite
+        end
+      end
+
+      def done
+        File.open(File.join(output_dir, 'junit_results.xml'), 'w') do |file|
+          file.puts doc.to_xml(indent: 2)
+        end
+      end
+
+      private
+      attr_reader :doc, :config
+
+      def output_dir
+        config['junit_xml_path'] || Dir.pwd
+      end
+
+      def load_config
+        filepath = File.join(Dir.pwd, 'spec', 'javascripts', 'support', 'jasmine_junitxml_formatter.yml')
+        @config = YAML::load(ERB.new(File.read(filepath)).result(binding)) if File.exist?(filepath)
+        @config ||= {}
+      end
+    end
+  end
+end

data/lib/jasmine_junitxml_formatter.rb

@@ -0,0 +1,16 @@
+def safe_gem_check(gem_name, version_string)
+  if Gem::Specification.respond_to?(:find_by_name)
+    Gem::Specification.find_by_name(gem_name, version_string)
+  elsif Gem.respond_to?(:available?)
+    Gem.available?(gem_name, version_string)
+  end
+rescue Gem::LoadError
+  false
+end
+
+if safe_gem_check('rails', '>= 3')
+  require File.join('jasmine_junitxml_formatter', 'railtie')
+else
+  require File.join('jasmine_junitxml_formatter', 'configure_jasmine.rb')
+end
+

data/lib/jasmine_junitxml_formatter/configure_jasmine.rb

@@ -0,0 +1,6 @@
+require 'jasmine'
+require 'jasmine/formatters/junit_xml'
+
+Jasmine.configure do |config|
+  config.formatters << Jasmine::Formatters::JunitXml
+end

data/lib/jasmine_junitxml_formatter/railtie.rb

@@ -0,0 +1,11 @@
+require 'rails/railtie'
+
+module JasmineJunitxmlFormatter
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load 'jasmine_junitxml_formatter/tasks/jasmine_junitxml_formatter.rake'
+    end
+  end
+end
+
+

data/lib/jasmine_junitxml_formatter/tasks/jasmine_junitxml_formatter.rake

@@ -0,0 +1,8 @@
+namespace :jasmine_junitxml_formatter do
+  task :setup do
+    require File.join('jasmine_junitxml_formatter', 'configure_jasmine')
+  end
+end
+
+task 'jasmine:require' => ['jasmine_junitxml_formatter:setup']
+

data/lib/jasmine_junitxml_formatter/version.rb

@@ -0,0 +1,3 @@
+module JasmineJunitxmlFormatter
+  VERSION = "0.1.0"
+end

data/spec/lib/jasmine/formatters/junit_xml_spec.rb

@@ -0,0 +1,103 @@
+require 'spec_helper'
+require 'nokogiri'
+
+describe Jasmine::Formatters::JunitXml do
+
+  class FakeFile
+    def initialize
+      @content = ''
+    end
+
+    attr_reader :content
+
+    def puts(content)
+      @content << content
+    end
+  end
+
+  let(:file_stub) { FakeFile.new }
+
+  describe 'creating the xml' do
+    before do
+      Dir.stub(:pwd).and_return('/junit_path')
+      File.stub(:open).and_call_original
+      File.stub(:open).with('/junit_path/junit_results.xml', 'w').and_yield(file_stub)
+    end
+
+    describe 'when the full suite passes' do
+      it 'shows the spec counts' do
+        results = [passing_result('fullName' => 'Passing test', 'description' => 'test')]
+        subject = Jasmine::Formatters::JunitXml.new
+
+        subject.format(results)
+        subject.done
+        xml = Nokogiri::XML(file_stub.content)
+
+        testsuite = xml.xpath('/testsuites/testsuite').first
+        testsuite['tests'].should == '1'
+        testsuite['failures'].should == '0'
+        testsuite['name'].should == 'Passing'
+
+        xml.xpath('//testcase').size.should == 1
+        xml.xpath('//testcase').first['name'].should == 'test'
+      end
+    end
+
+    describe 'when there are failures' do
+      it 'shows the spec counts' do
+        results1 = [passing_result]
+        results2 = [failing_result]
+        subject = Jasmine::Formatters::JunitXml.new
+
+        subject.format(results1)
+        subject.format(results2)
+        subject.done
+        xml = Nokogiri::XML(file_stub.content)
+
+        testsuite = xml.xpath('/testsuites/testsuite').first
+        testsuite['tests'].should == '1'
+        testsuite['failures'].should == '0'
+
+        testsuite = xml.xpath('/testsuites/testsuite')[1]
+        testsuite['tests'].should == '1'
+        testsuite['failures'].should == '1'
+
+        xml.xpath('//testcase').size.should == 2
+        xml.xpath('//testcase/failure').size.should == 1
+        xml.xpath('//testcase/failure').first['message'].should == 'a failure message'
+        xml.xpath('//testcase/failure').first.content.should == 'a stack trace'
+      end
+    end
+  end
+
+  describe 'when the output directory has been customized' do
+    before do
+      Dir.stub(:pwd).and_return('/default_path')
+      config_path = File.join('/default_path', 'spec', 'javascripts', 'support', 'jasmine_junitxml_formatter.yml')
+      File.stub(:exist?).with(config_path).and_return(true)
+      File.stub(:read).with(config_path).and_return <<-YAML
+---
+junit_xml_path: "/custom_path"
+YAML
+      File.stub(:open).and_call_original
+      File.stub(:open).with('/custom_path/junit_results.xml', 'w').and_yield(file_stub)
+    end
+
+    it 'writes to the specified location' do
+      results = [passing_result('fullName' => 'Passing test', 'description' => 'test')]
+      subject = Jasmine::Formatters::JunitXml.new
+
+      subject.format(results)
+      subject.done
+      file_stub.content.should_not == ''
+    end
+  end
+
+  def failing_result(options = {})
+    Jasmine::Result.new(failing_raw_result.merge(options))
+  end
+
+  def passing_result(options = {})
+    Jasmine::Result.new(passing_raw_result.merge(options))
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,38 @@
+require 'rspec'
+require 'jasmine_junitxml_formatter'
+
+def in_temp_dir
+  project_root = File.expand_path(File.join('..', '..'), __FILE__)
+  Dir.mktmpdir do |tmp_dir|
+    begin
+      Dir.chdir tmp_dir
+      yield tmp_dir, project_root
+    ensure
+      Dir.chdir project_root
+    end
+  end
+end
+
+def passing_raw_result
+  {'id' => 123, 'status' => 'passed', 'fullName' => 'Passing test', 'description' => 'Passing', 'failedExpectations' => []}
+end
+
+def pending_raw_result
+  {'id' => 123, 'status' => 'pending', 'fullName' => 'Passing test', 'description' => 'Pending', 'failedExpectations' => []}
+end
+
+def failing_raw_result
+  {
+    'status' => 'failed',
+    'id' => 124,
+    'description' => 'a failing spec',
+    'fullName' => 'a suite with a failing spec',
+    'failedExpectations' => [
+      {
+        'message' => 'a failure message',
+        'stack' => 'a stack trace'
+      }
+    ]
+  }
+end
+

metadata

@@ -0,0 +1,132 @@
+--- !ruby/object:Gem::Specification
+name: jasmine_junitxml_formatter
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Gregg Van Hove
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-09-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: 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: rake
+  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: jasmine
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0.alpha
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.0.0.alpha
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  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'
+description: Format jasmine results as junit compatible XML so CI servers, like Hudson/Jenkins
+  can parse it
+email:
+- pair+gvanhove@pivotallabs.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- jasmine_junitxml_formatter.gemspec
+- lib/jasmine/formatters/junit_xml.rb
+- lib/jasmine_junitxml_formatter.rb
+- lib/jasmine_junitxml_formatter/configure_jasmine.rb
+- lib/jasmine_junitxml_formatter/railtie.rb
+- lib/jasmine_junitxml_formatter/tasks/jasmine_junitxml_formatter.rake
+- lib/jasmine_junitxml_formatter/version.rb
+- spec/lib/jasmine/formatters/junit_xml_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jasmine/jasmine_junitxml_formatter
+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.0.5
+signing_key: 
+specification_version: 4
+summary: Format jasmine results as junit compatible XML so CI servers, like Hudson/Jenkins
+  can parse it
+test_files:
+- spec/lib/jasmine/formatters/junit_xml_spec.rb
+- spec/spec_helper.rb