coverband 0.0.9 → 0.0.10

data/README.md

@@ -1,6 +1,12 @@
 # Coverband
 
-Rack middleware to help measure production code coverage
+Rack middleware to measure production code coverage. Coverband allows easy configuration to collect and report on production code coverage.
+
+* Allow sampleing to avoid the perf overhead on every request.
+* Ignore directories to avoid data collection on vendor, lib, etc
+* Take a baseline to get inital app loading coverage.
+
+At the momement, Coverband relies on Ruby's `set_trace_func` hook. I attempted to use the standard lib's `Coverage` support but it proved buggy when stampling or stoping and starting collection. When [Coverage is patched](https://www.ruby-forum.com/topic/1811306) in future Ruby versions it would likely be better. Using `set_trace_func` has some limitations where it doesn't collect covered lines, but I have been impressed with the coverage it shows for both Sinatra and Rails applications.
 
 ## Installation
 
@@ -18,7 +24,61 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+After installing the gem you likely want to get the rake tasks configured as well as the rack middle ware.
+
+#### Configuring Rake
+
+Either add the below to your `Rakefile` or to a file included in you Rakefile
+
+	require 'coverband'
+	Coverband.configure do |config|
+      config.redis             = Redis.new
+      # merge in lines to consider covered manually to override any misses
+	  # existing_coverage = {'./cover_band_server/app.rb' => Array.new(31,1)}
+	  # JSON.parse(File.read('./tmp/coverband_baseline.json')).merge(existing_coverage) 
+      config.coverage_baseline = JSON.parse(File.read('./tmp/coverband_baseline.json'))
+      config.root_paths        = ['/app/']
+    end
+
+	desc "report unused lines"
+	task :coverband => :environment do
+	  baseline = JSON.parse(File.read('./tmp/coverband_baseline.json'))
+
+	  root_paths = ['/app/']
+	  coverband_options = {:existing_coverage => baseline, :roots => root_paths}
+	  Coverband::Reporter.report(Redis.new, coverband_options)
+	end
+	
+	desc "get coverage baseline"
+	task :coverband_baseline do
+	  Coverband::Reporter.baseline {
+	  	#rails
+      	require File.expand_path("../config/environment", __FILE__)
+      	#sinatra
+      	#require File.expand_path("./app", __FILE__)
+      }
+    end
+    
+#### Configure rack middleware
+
+For the best coverage you want this loaded as early as possible. I have been putting it directly in my `config.ru` but you could use an initializer you may just end up missing some boot up coverage.
+
+	require File.dirname(__FILE__) + '/config/environment'
+	
+	require 'coverband'
+	
+	Coverband.configure do |config|
+	  config.root              = Dir.pwd
+	  config.redis             = Redis.new
+	  config.coverage_baseline = JSON.parse(File.read('./tmp/coverband_baseline.json'))
+	  config.root_paths        = ['/app/']
+	  config.ignore            = ['vendor']
+	  config.percentage        = 100.0
+	end
+
+	use Coverband::Middleware
+	run ActionController::Dispatcher.new
+
 
 ## TODO
 
@@ -43,6 +103,7 @@ TODO: Write usage instructions here
 * [Ruby Coverage docs](http://www.ruby-doc.org/stdlib-1.9.3/libdoc/coverage/rdoc/Coverage.html)
 * [simplecov walk through](http://www.tamingthemindmonkey.com/2011/09/27/ruby-code-coverage-using-simplecov) copy some of the syntax sugar setup for cover band
 * [Jruby coverage bug](http://jira.codehaus.org/browse/JRUBY-6106?page=com.atlassian.jira.plugin.system.issuetabpanels:changehistory-tabpanel)
+* [learn from oboe ruby code](https://github.com/appneta/oboe-ruby#writing-custom-instrumentation)
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,9 @@
 require "bundler/gem_tasks"
+
+task :default => :test
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end

data/coverband.gemspec

@@ -20,6 +20,9 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
+  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "shoulda"
   spec.add_runtime_dependency "simplecov"
   spec.add_runtime_dependency "json"
+  spec.add_runtime_dependency "redis"
 end

data/lib/coverband.rb

@@ -5,5 +5,30 @@ require "coverband/reporter"
 require "coverband/middleware"
 
 module Coverband
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield(configuration)
+  end
+
+  class Configuration
+    attr_accessor :redis, :coverage_baseline, :root_paths, :root, :ignore, :percentage, :verbose, :reporter
+    
+
+    def initialize
+      @root = Dir.pwd
+      @redis = nil
+      @coverage_baseline = {}
+      @root_paths = []
+      @ignore = []
+      @percentage = 100.0
+      @verbose = false
+      @reporter = 'rcov'
+    end
+  end
   
 end

data/lib/coverband/middleware.rb

@@ -1,17 +1,18 @@
 module Coverband
   class Middleware
 
-    def initialize(app, settings={})
+    def initialize(app)
       @app = app
-      root = settings[:root] || './'
+      root = Coverband.configuration.root
       @project_directory = File.expand_path(root)
       @enabled = true
       @function_set = false
       @files = {}
 
-      @ignore_patterns = settings[:ignore] || []
-      @sample_percentage = settings[:percentage] || 100.0
-      @reporter = settings[:reporter]
+      @ignore_patterns = Coverband.configuration.ignore
+      @sample_percentage = Coverband.configuration.percentage
+      @reporter = Coverband.configuration.redis
+      @verbose = Coverband.configuration.verbose
     end
 
     def call(env)
@@ -68,20 +69,26 @@ module Coverband
               old_files = @files.dup
               @files = {}
               old_files.each_pair do |key, values|
-                @reporter.sadd "coverband", key.gsub('/','.')
-                @reporter.sadd "coverband#{key.gsub('/','.')}", values
+                @reporter.sadd "coverband", key
+                if @reporter.inspect.match(/v2/)
+                  values.each do |value|
+                    @reporter.sadd "coverband.#{key}", value
+                  end
+                else
+                  @reporter.sadd "coverband.#{key}", values
+                end
               end
             end
           else
-            puts "coverage report: "
-            puts @files.inspect
+            puts "coverage report: " if @verbose
+            puts @files.inspect if @verbose
           end
         else
-          puts "coverage disabled" if @reporter
+          puts "coverage disabled" if @verbose
         end
       rescue RuntimeError => err
-        if @reporter
-          puts "coverage missing"
+        if @verbose
+          puts "coverage missing" 
           puts "error: #{err.inspect} #{err.message}"
         end
       end

data/lib/coverband/reporter.rb

@@ -1,14 +1,13 @@
 require 'simplecov'
 
 module Coverband
-
   class Reporter
 
     def self.baseline
       require 'coverage'
       Coverage.start
       yield
-      @project_directory = File.expand_path(Dir.pwd)
+      @project_directory = File.expand_path(Coverband.configuration.root)
       results = Coverage.result
       results = results.reject{|key, val| !key.match(@project_directory)}
       puts results.inspect
@@ -16,18 +15,28 @@ module Coverband
       File.open('./tmp/coverband_baseline.json', 'w') {|f| f.write(results.to_json) }
     end
 
-    def self.report(redis, options = {})
-      roots = options.fetch(:roots){[]}
-      existing_coverage = options.fetch(:existing_coverage){ {} }
-      roots << "#{File.expand_path(Dir.pwd)}/"
+    def self.report
+      redis = Coverband.configuration.redis
+      roots = Coverband.configuration.root_paths
+      existing_coverage = Coverband.configuration.coverage_baseline
+      roots << "#{current_root}/"
       puts "fixing root: #{roots.join(', ')}"
-      if options.fetch(:reporter){ 'rcov' }=='rcov'
+      if  Coverband.configuration.reporter=='rcov'
         report_rcov(redis, existing_coverage, roots)
       else
-        redis.smembers('coverband').each{|key| report_line(redis, key) }
+        lines = redis.smembers('coverband').map{|key| report_line(redis, key) }
+        puts lines.join("\n")
       end
     end
 
+    def self.clear_coverage(redis)
+      Coverband.configuration.redis.smembers('coverband').each{|key| redis.del("coverband.#{key}")}
+    end
+
+    def self.current_root
+      File.expand_path(Coverband.configuration.root)
+    end
+
     private
 
     def self.fix_file_names(report_hash, roots)
@@ -73,11 +82,11 @@ module Coverband
     # /Users/danmayer/projects/cover_band_server/app/rb: ["54", "55"]
     # /Users/danmayer/projects/cover_band_server/views/layout/erb: ["0", "33", "36", "37", "38", "39", "40", "62", "63", "66", "65532", "65533"]
     def self.report_line(redis, key)
-      puts "#{key.gsub('.','/')}: #{redis.smembers("coverband#{key}").inspect}"
+      "#{key}: #{redis.smembers("coverband.#{key}").inspect}"
     end
 
     def self.filename_from_key(key, roots)
-      filename = key.gsub('.','/').gsub('//','./').gsub('/rb','.rb').gsub('/erb','.erb')
+      filename = key
       roots.each do |root|
         filename = filename.gsub(/^#{root}/, './')
       end
@@ -90,7 +99,7 @@ module Coverband
     def self.line_hash(redis, key, roots)
       filename = filename_from_key(key, roots)
       if File.exists?(filename)
-        lines_hit = redis.smembers("coverband#{key}")
+        lines_hit = redis.smembers("coverband.#{key}")
         count = File.foreach(filename).inject(0) {|c, line| c+1}
         if filename.match(/\.erb/)
           line_array = Array.new(count, nil)
@@ -105,5 +114,4 @@ module Coverband
     end
 
   end
-
 end

data/lib/coverband/version.rb

@@ -1,3 +1,3 @@
 module Coverband
-  VERSION = "0.0.9"
+  VERSION = "0.0.10"
 end

data/test/test_helper.rb

@@ -0,0 +1,34 @@
+require 'rubygems'
+require 'simplecov'
+require 'test/unit'
+require 'shoulda'
+require 'mocha'
+require 'ostruct'
+require 'json'
+
+SimpleCov.start do
+  add_filter 'specs/ruby/1.9.1/gems/'
+  add_filter '/test/'
+  add_filter '/config/'
+end
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+Mocha::Configuration.prevent(:stubbing_non_existent_method)
+
+require 'coverband'
+
+unless File.exist?('./tmp/coverband_baseline.json')
+  `mkdir -p ./tmp`
+  `touch ./tmp/coverband_baseline.json`
+end
+
+Coverband.configure do |config|
+  config.root              = Dir.pwd
+  config.redis             = Redis.new
+  #config.coverage_baseline = JSON.parse(File.read('./tmp/coverband_baseline.json'))
+  config.root_paths        = ['/app/']
+  config.ignore            = ['vendor']
+  config.percentage        = 100.0
+  config.reporter          = 'std_out'
+end

data/test/unit/middleware_test.rb

@@ -0,0 +1,25 @@
+require File.expand_path('../test_helper', File.dirname(__FILE__))
+
+class MiddlewareTest < Test::Unit::TestCase
+  
+  FAKE_RESULTS = 'results'
+
+  should "call app" do
+    middleware = Coverband::Middleware.new(fake_app)
+    results = middleware.call({})
+    assert_equal FAKE_RESULTS, results
+  end
+
+  private
+
+  def fake_app
+    @app ||= begin 
+              my_app = OpenStruct.new()
+              def my_app.call(env)
+                FAKE_RESULTS
+              end
+              my_app
+            end
+  end
+
+end

data/test/unit/reporter_test.rb

@@ -0,0 +1,63 @@
+require File.expand_path('../test_helper', File.dirname(__FILE__))
+
+class ReporterTest < Test::Unit::TestCase
+
+  should "record baseline" do
+    Coverage.expects(:start).at_least_once
+    Coverage.expects(:result).returns({'fake' => [0,1]}).at_least_once
+    File.expects(:open).once
+
+    Coverband::Reporter.stubs(:puts)
+
+    Coverband::Reporter.baseline{
+      #nothing
+    }
+  end
+
+  should "report data" do
+    Coverband.configure do |config|
+      config.redis             = fake_redis
+      config.reporter          = 'std_out'
+    end
+
+    Coverband::Reporter.expects(:current_root).returns('/root_dir')
+    fake_redis.expects(:smembers).with('coverband').returns(fake_coverband_members)
+    Coverband::Reporter.expects('puts').with("fixing root: /app/, /root_dir/")
+    
+    fake_coverband_members.each do |key|
+      fake_redis.expects(:smembers).with("coverband.#{key}").returns(["54", "55"])
+    end
+
+    matchers = [regexp_matches(/tester/),
+                regexp_matches(/application_controller/),
+                regexp_matches(/account/),
+                regexp_matches(/54/)]
+    
+    Coverband::Reporter.expects('puts').with(all_of(*matchers))
+
+    Coverband::Reporter.report
+  end
+
+  private
+
+  def fake_redis
+    @redis ||= begin
+                 redis = OpenStruct.new()
+                 def redis.smembers(key)
+                 end
+                 redis
+               end
+  end
+
+  def fake_coverband_members
+    ["/Users/danmayer/projects/hearno/script/tester.rb",
+     "/Users/danmayer/projects/hearno/app/controllers/application_controller.rb",
+     "/Users/danmayer/projects/hearno/app/models/account.rb"
+    ]
+  end
+
+  def fake_coverage_report
+    {"/Users/danmayer/projects/hearno/script/tester.rb"=>[1, nil, 1, 1, nil, nil, nil]}
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coverband
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-19 00:00:00.000000000 Z
+date: 2013-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -43,6 +43,38 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -75,6 +107,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Rack middleware to help measure production code coverage
 email:
 - dan@mayerdan.com
@@ -93,6 +141,9 @@ files:
 - lib/coverband/middleware.rb
 - lib/coverband/reporter.rb
 - lib/coverband/version.rb
+- test/test_helper.rb
+- test/unit/middleware_test.rb
+- test/unit/reporter_test.rb
 homepage: ''
 licenses:
 - MIT
@@ -108,7 +159,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1438367846441616619
+      hash: 1293128324123628513
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -117,11 +168,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1438367846441616619
+      hash: 1293128324123628513
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Rack middleware to help measure production code coverage
-test_files: []
+test_files:
+- test/test_helper.rb
+- test/unit/middleware_test.rb
+- test/unit/reporter_test.rb