simplecov-bamboo 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 80adccfff338182a3a76d33a590497cfe17bd26b
+  data.tar.gz: b2b6c96a57103cfd84b82c11f9a23e2ad16d0878
+SHA512:
+  metadata.gz: 7af7a6c67ce0d1a5dd21866f86c0377c9ce98890c2b2685605488c6c23a8ce9345a8e51f74b73b03af9914afdd67cdef77c961592ceb3e452c0931b03c465759
+  data.tar.gz: e45f82186313ab9642a3a46320948c00f065632d9b21b559e58c6abd02e1a41e0c2b3ee5ff94faded8a687ee4f29962003ed7461e53d14a328745fe9c567fa63

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,27 @@
+.rvmrc
+.bundle
+Gemfile.lock
+
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+.sass-cache
+
+## PROJECT::SPECIFIC
+target

data/Gemfile

@@ -0,0 +1,15 @@
+source :rubygems
+
+gemspec
+
+group :development do
+  # Use local copy of simplecov in development when checked out, fetch from git otherwise
+  if File.directory?(File.dirname(__FILE__) + '/../simplecov')
+    gem 'simplecov', :path => File.dirname(__FILE__) + '/../simplecov'
+  else
+    gem 'simplecov', :git => 'https://github.com/colszowka/simplecov'
+  end
+
+  gem 'guard-bundler'
+  gem 'guard-rake'
+end

data/Guardfile

@@ -0,0 +1,12 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'bundler' do
+  watch('Gemfile')
+  # Uncomment next line if Gemfile contain `gemspec' command
+  # watch(/^.+\.gemspec/)
+end
+
+guard 'rake', :task => 'assets:compile' do
+  watch(%r{^assets\/})
+end

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010-2011 Christoph Olszowka
+
+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,56 @@
+# Bamboo formatter for SimpleCov
+
+***Note: To learn more about SimpleCov, check out the main repo at https://github.com/colszowka/simplecov***
+
+SimpleCov-Bamboo is a result formatter for SimpleCov that helps one to integrate SimpleCov into the [Atlassian
+Bamboo](https://www.atlassian.com/software/bamboo) Continuous Integration Server.
+
+The formatter creates a file called *clover.xml* in the coverage directory, which contains a minimal subset of the coverage information generated by clover. It also uses the default HTMLGenerator to generates the HTML Coverage Report to *target/site/clover*, which is the location expected by Bamboo.
+
+## Getting Started
+
+1. Add the SimpleCov-Bamboo gem to test group your Gemfile:
+
+        gem 'simplecov-bamboo', :require => false,
+            :github => "darylrobbins/simplecov-bamboo", :group => "test" 
+
+   Note the :github reference is currently required as this gem is not yet part of the Gem repository.
+
+2. Configure SimpleCov in your test helper:
+
+        SimpleCov.coverage_dir('target/coverage')   # optional
+        SimpleCov.formatter = SimpleCov::Formatter::BambooFormatter
+    
+3. Configure Bamboo to process Clover coverage information
+
+    See: https://confluence.atlassian.com/display/BAMBOO/Using+Bamboo+with+Clover
+    
+    On the miscellaneous tab when configuring your build job (not the plan):
+    
+- Check 'Use Clover to collect Code Coverage for this build.'
+- Select 'Clover is already integrated into this build and a clover.xml file will be produced'
+- Enter your coverage directory into the 'Clover XML Location' field; for example: target/coverage
+    
+### Results
+
+After the next build, you can now browse your coverage information for the build:
+
+- See the Clover tab of the Build Plan Details for coverage and loc trends for the porject; and for a link to the latest coverage report.
+- You can also access the coverage report for a particular build result. Navigate to the build result and select the results for the job, where the coverage report was published. You may need to expand the Tree Navigation bar on the left of the page to select the job results. From the job results, select the Clover tab to view the coverage report. 
+
+## Background
+
+For code coverage reporting, Bamboo has native support for Clover (Java and Groovy) and NCover (.NET). Unfortunately, there is no native (or plugin support) for displaying Ruby coverage information.
+
+I first looked at building a Bamboo plugin to support SimpleCov, but determined it would be much easier to just transform the SimpleCov output to be Clover-like.
+
+There is actually on a very small amount of information that is processed by Bamboo directly in the clover.xml results file: total elements, covered elements, and non-comment lines of code (at the entire project level). So, I generate the minimal clover.xml file.
+
+The second thing that Bamboo is expecting is an HTML coverage report to be published to target/site/clover, so I also invoke the HTMLFormatter and force it to produce it's output at that location.
+
+## Compatibility
+
+I have tested this project with Bamboo 5.0, but it should likely work with earlier versions. Native Clover support has been in-place since Bamboo 2.4.
+
+## Credits 
+Code based on SimpleCov/SimpleCov-HTML by Christoph Olszowka. Modified by Daryl Robbins to generate the results expected by Bamboo.

data/Rakefile

@@ -0,0 +1,32 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+# See https://github.com/colszowka/simplecov/issues/171
+desc "Set permissions on all files so they are compatible with both user-local and system-wide installs"
+task :fix_permissions do
+  system 'bash -c "find . -type f -exec chmod 644 {} \; && find . -type d -exec chmod 755 {} \;"'
+end
+# Enforce proper permissions on each build
+Rake::Task[:build].prerequisites.unshift :fix_permissions
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+namespace :assets do
+  desc "Compiles all assets"
+  task :compile do
+    puts "Compiling assets"
+    require 'sprockets'
+    assets = Sprockets::Environment.new
+    assets.append_path 'assets/javascripts'
+    assets.append_path 'assets/stylesheets'
+    assets['application.js'].write_to('public/application.js')
+    assets['application.css'].write_to('public/application.css')
+  end
+end

data/lib/simplecov-bamboo.rb

@@ -0,0 +1,61 @@
+require 'erb'
+require 'cgi'
+require 'fileutils'
+require 'digest/sha1'
+require 'time'
+require 'nokogiri'
+
+# Ensure we are using a compatible version of SimpleCov
+if Gem::Version.new(SimpleCov::VERSION) < Gem::Version.new("0.7.1")
+  raise RuntimeError, "The version of SimpleCov you are using is too old. Please update with `gem install simplecov` or `bundle update simplecov`"
+end
+
+
+class SimpleCov::Formatter::BambooFormatter
+  
+  def format(result)
+
+    # First, generate HTML report
+    BambooHTMLFormatter.new.format(result)
+
+    # Second, generate the Clover summary report
+    generateCloverReport(result)
+
+  end
+
+  private
+
+    class BambooHTMLFormatter < SimpleCov::Formatter::HTMLFormatter
+    
+      def output_path
+        "target/site/clover"
+      end
+
+    end
+
+    def generateCloverReport(result)
+
+      builder = Nokogiri::XML::Builder.new do
+        coverage(generated: Time.now.to_i, clover: "3.1.12") {
+          project(timestamp: Time.now.to_i) {
+            metrics(elements: result.total_lines, coveredelements: result.covered_lines, ncloc: result.total_lines)
+          }
+        }
+      end
+
+      File.open(File.join(output_path, "clover.xml"), "w+") do |file|
+        file.puts builder.to_xml
+      end
+
+    end
+
+
+    def output_path
+      SimpleCov.coverage_path
+    end
+
+end
+
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__)))
+require 'simplecov-bamboo/version'

data/lib/simplecov-bamboo/version.rb

@@ -0,0 +1,7 @@
+module SimpleCov
+  module Formatter
+    class BambooFormatter
+      VERSION = "0.1.0"
+    end
+  end
+end

data/simplecov-bamboo.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'simplecov-bamboo/version'
+
+Gem::Specification.new do |s|
+  s.name        = "simplecov-bamboo"
+  s.version     = SimpleCov::Formatter::BambooFormatter::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Daryl Robbins"]
+  s.email       = ["daryl at robbins dot name"]
+  s.homepage    = "https://github.com/darylrobbins/simplecov-bamboo"
+  s.summary     = %Q{SimpleCov/Bamboo Integration}
+  s.description = %Q{Integrate SimpleCov results into Atlassian Bamboo CI server}
+  s.license     = 'MIT'
+
+  s.rubyforge_project = "simplecov-bamboo"
+  
+  s.add_runtime_dependency 'nokogiri'
+  s.add_runtime_dependency 'simplecov'
+  s.add_runtime_dependency 'simplecov-html'
+
+  s.add_development_dependency 'rake'
+  s.add_development_dependency 'sprockets'
+  s.add_development_dependency 'sass'
+
+  s.add_development_dependency 'appraisal', '~> 0.5.1'
+  s.add_development_dependency 'rspec', '~> 2.13.0'
+  s.add_development_dependency 'shoulda', '~> 3.4.0'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/test/fixtures/app/controllers/sample_controller.rb

@@ -0,0 +1,10 @@
+# Foo class
+class Foo
+  def initialize
+    @foo = 'baz'
+  end
+
+  def bar
+    @foo
+  end
+end

data/test/fixtures/app/models/user.rb

@@ -0,0 +1,10 @@
+# Foo class
+class Foo
+  def initialize
+    @foo = 'baz'
+  end
+
+  def bar
+    @foo
+  end
+end

data/test/fixtures/sample.rb

@@ -0,0 +1,16 @@
+# Foo class
+class Foo
+  def initialize
+    @foo = 'baz'
+  end
+
+  def bar
+    @foo
+  end
+
+  #:nocov:
+  def skipped
+    @foo * 2
+  end
+  #:nocov:
+end

data/test/helper.rb

@@ -0,0 +1,36 @@
+require 'bundler/setup'
+require 'simplecov'
+require 'test/unit'
+require 'shoulda'
+
+require 'simplecov-bamboo'
+
+SimpleCov.coverage_dir('tmp/coverage')
+
+class Test::Unit::TestCase
+  def source_fixture(filename)
+    File.expand_path(File.join(File.dirname(__FILE__), 'fixtures', filename))
+  end
+
+  # Keep 1.8-rubies from complaining about missing tests in each file that covers only 1.9 functionality
+  def default_test
+  end
+end
+
+require 'shoulda_macros'
+Test::Unit::TestCase.send :extend, ShouldaMacros
+
+# Taken from http://stackoverflow.com/questions/4459330/how-do-i-temporarily-redirect-stderr-in-ruby
+require "stringio"
+
+def capture_stderr
+  # The output stream must be an IO-like object. In this case we capture it in
+  # an in-memory IO object so we can return the string value. You can assign any
+  # IO object here.
+  previous_stderr, $stderr = $stderr, StringIO.new
+  yield
+  $stderr.string
+ensure
+  # Restore the previous value of stderr (typically equal to STDERR).
+  $stderr = previous_stderr
+end

data/test/shoulda_macros.rb

@@ -0,0 +1,19 @@
+module ShouldaMacros
+  def should_be(boolean_flag)
+    should "be #{boolean_flag}" do
+      assert_equal true, subject.send(boolean_flag)
+    end
+  end
+
+  def should_not_be(boolean_flag)
+    should "not be #{boolean_flag}" do
+      assert_equal false, subject.send(boolean_flag)
+    end
+  end
+
+  def should_have(attr_name, expectation)
+    should "have #{attr_name} == #{expectation.inspect}" do
+      assert_equal expectation, subject.send(attr_name)
+    end
+  end
+end

data/test/test_simple_cov-bamboo.rb

@@ -0,0 +1,56 @@
+require 'helper'
+
+class TestBambooFormatter < Test::Unit::TestCase
+  context "With a (mocked) Coverage.result" do
+    setup do
+      SimpleCov.filters = []
+      SimpleCov.groups = {}
+      SimpleCov.formatter = nil
+      @original_result = {source_fixture('sample.rb') => [nil, 1, 1, 1, nil, nil, 1, 1, nil, nil],
+          source_fixture('app/models/user.rb') => [nil, 1, 1, 1, nil, nil, 1, 0, nil, nil],
+          source_fixture('app/controllers/sample_controller.rb') => [nil, 1, 1, 1, nil, nil, 1, 0, nil, nil]}
+    end
+
+    context "a simple cov result initialized from that" do
+      setup { @result = SimpleCov::Result.new(@original_result) }
+
+      should "have 3 filenames" do
+        assert_equal 3, @result.filenames.count
+      end
+
+      should "have 3 source files" do
+        assert_equal 3, @result.source_files.count
+        assert @result.source_files.all? {|s| s.instance_of?(SimpleCov::SourceFile)}, "Not all instances are of SimpleCov::SourceFile type"
+      end
+
+      should "return an instance of SimpleCov::FileList for source_files and files" do
+        assert_equal SimpleCov::FileList, @result.source_files.class
+        assert_equal SimpleCov::FileList, @result.files.class
+      end
+
+      should "have files equal to source_files" do
+        assert_equal @result.files, @result.source_files
+      end
+
+      should "have accurate covered percent" do
+        # in our fixture, there are 13 covered line (result in 1) in all 15 relevant line (result in non-nil)
+        assert_equal 100.0*13/15, @result.covered_percent
+      end
+
+    end
+
+
+
+      context "and bamboo formatter being used" do
+        setup do
+          @result = SimpleCov::Result.new(@original_result)
+          SimpleCov.formatter = SimpleCov::Formatter::BambooFormatter
+        end
+
+        should "return an array containing formatted string with result.format!" do
+          @result.format!
+        end
+      end
+    end
+
+end if SimpleCov.usable?

metadata

@@ -0,0 +1,192 @@
+--- !ruby/object:Gem::Specification
+name: simplecov-bamboo
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daryl Robbins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-21 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  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: simplecov-html
+  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: 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: sprockets
+  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: sass
+  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: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.4.0
+description: Integrate SimpleCov results into Atlassian Bamboo CI server
+email:
+- daryl at robbins dot name
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .document
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/simplecov-bamboo.rb
+- lib/simplecov-bamboo/version.rb
+- simplecov-bamboo.gemspec
+- test/fixtures/app/controllers/sample_controller.rb
+- test/fixtures/app/models/user.rb
+- test/fixtures/sample.rb
+- test/helper.rb
+- test/shoulda_macros.rb
+- test/test_simple_cov-bamboo.rb
+homepage: https://github.com/darylrobbins/simplecov-bamboo
+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: simplecov-bamboo
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: SimpleCov/Bamboo Integration
+test_files:
+- test/fixtures/app/controllers/sample_controller.rb
+- test/fixtures/app/models/user.rb
+- test/fixtures/sample.rb
+- test/helper.rb
+- test/shoulda_macros.rb
+- test/test_simple_cov-bamboo.rb