coverband 1.3.1 → 1.5.0

data/lib/coverband/baseline.rb

@@ -0,0 +1,35 @@
+module Coverband
+  class Baseline
+
+    def self.record
+      require 'coverage'
+      Coverage.start
+      yield
+
+      project_directory = File.expand_path(Coverband.configuration.root)
+      results = Coverage.result
+      results = results.reject { |key, val| !key.match(project_directory) || Coverband.configuration.ignore.any? { |pattern| key.match(/#{pattern}/) } }
+
+      Coverband.configuration.store.save_report(convert_coverage_format(results))
+    end
+
+    def self.parse_baseline(back_compat = nil)
+      Coverband.configuration.store.coverage
+    end
+
+    private
+
+    def self.convert_coverage_format(results)
+      file_map = {}
+      results.each_pair do |file, data|
+        lines_map = {}
+        data.each_with_index do |hits, index|
+          lines_map[(index+1)] = hits unless hits.nil?
+        end
+        file_map[file] = lines_map
+      end
+      file_map
+    end
+
+  end
+end

data/lib/coverband/configuration.rb

@@ -1,17 +1,19 @@
 module Coverband
   class Configuration
      
-    attr_accessor :redis, :coverage_baseline, :root_paths, :root, 
+    attr_accessor :redis, :root_paths, :root,
                   :ignore, :percentage, :verbose, :reporter, :stats,
-                  :logger, :startup_delay, :baseline_file, :trace_point_events, 
-                  :include_gems, :memory_caching, :s3_bucket
+                  :logger, :startup_delay, :trace_point_events,
+                  :include_gems, :memory_caching, :s3_bucket, :coverage_file, :store
+
+    # deprecated, but leaving to allow old configs to 'just work'
+    # remove for 2.0
+    attr_accessor :coverage_baseline
 
     def initialize
       @root = Dir.pwd
       @redis = nil
       @stats = nil
-      @coverage_baseline = {}
-      @baseline_file = './tmp/coverband_baseline.json'
       @root_paths = []
       @ignore = []
       @include_gems = false
@@ -22,11 +24,24 @@ module Coverband
       @startup_delay = 0
       @trace_point_events = [:line]
       @memory_caching = false
+      @coverage_file = nil
+      @store = nil
     end
 
     def logger
       @logger ||= Logger.new(STDOUT)
     end
 
+    #TODO considering removing @redis / @coveragefile and have user set store directly
+    def store
+      return @store if @store
+      if redis
+        @store = Coverband::Adapters::RedisStore.new(redis)
+      elsif Coverband.configuration.coverage_file
+        @store = Coverband::Adapters::FileStore.new(coverage_file)
+      end
+      @store
+    end
+
   end
 end

data/lib/coverband/reporters/base.rb

@@ -0,0 +1,150 @@
+module Coverband
+  module Reporters
+    class Base
+
+      def self.report(store, options = {})
+        roots = get_roots
+        additional_coverage_data = options.fetch(:additional_scov_data) { [] }
+
+        if Coverband.configuration.verbose
+          Coverband.configuration.logger.info "fixing root: #{roots.join(', ')}"
+          Coverband.configuration.logger.info "additional data:\n #{additional_coverage_data}"
+        end
+
+        scov_style_report = report_scov_with_additional_data(store, additional_coverage_data, roots)
+
+        if Coverband.configuration.verbose
+          Coverband.configuration.logger.info "report:\n #{scov_style_report.inspect}"
+        end
+        scov_style_report
+      end
+
+      def self.get_roots
+        roots = Coverband.configuration.root_paths
+        roots << "#{current_root}/"
+        roots
+      end
+
+      def self.current_root
+        File.expand_path(Coverband.configuration.root)
+      end
+
+      protected
+
+      def self.fix_file_names(report_hash, roots)
+        fixed_report = {} #normalize names across servers
+        report_hash.each_pair do |key, values|
+          filename = filename_from_key(key, roots)
+          fixed_report[filename] = values
+        end
+        fixed_report
+      end
+
+      # > merge_arrays([0,0,1,0,1],[nil,0,1,0,0])
+      # [0,0,1,0,1]
+      def self.merge_arrays(first, second)
+        merged = []
+        longest = first.length > second.length ? first : second
+
+        longest.each_with_index do |line, index|
+          if first[index] || second[index]
+            merged[index] = (first[index].to_i + second[index].to_i)
+          else
+            merged[index] = nil
+          end
+        end
+
+        merged
+      end
+
+      # > merge_existing_coverage({"file.rb" => [0,1,2,nil,nil,nil]}, {"file.rb" => [0,1,2,nil,0,1,2]})
+      # expects = {"file.rb" => [0,2,4,nil,0,1,2]}
+      def self.merge_existing_coverage(scov_style_report, existing_coverage)
+        existing_coverage.each_pair do |file_key, existing_lines|
+          next if Coverband.configuration.ignore.any?{ |i| file_key.match(i) }
+          if current_line_hits = scov_style_report[file_key]
+            scov_style_report[file_key] = merge_arrays(current_line_hits, existing_lines)
+          else
+            scov_style_report[file_key] = existing_lines
+          end
+        end
+        scov_style_report
+      end
+
+      def self.filename_from_key(key, roots)
+        filename = key
+        roots.each do |root|
+          filename = filename.gsub(/^#{root}/, './')
+        end
+        # the filename for  SimpleCov is expected to be a full path.
+        # roots.last should be roots << current_root}/
+        # a fully expanded path of config.root
+        filename = filename.gsub('./', roots.last)
+        filename
+      end
+
+      # > line_hash(store, 'hearno/script/tester.rb', ['/app/', '/Users/danmayer/projects/hearno/'])
+      # {"/Users/danmayer/projects/hearno/script/tester.rb"=>[1, nil, 1, 2, nil, nil, nil]}
+      def self.line_hash(store, key, roots)
+        filename = filename_from_key(key, roots)
+        if File.exists?(filename)
+
+          count = File.foreach(filename).inject(0) { |c, line| c + 1 }
+          line_array = Array.new(count, nil)
+
+          lines_hit = store.covered_lines_for_file(key)
+          if lines_hit.is_a?(Array)
+            line_array.each_with_index{|_,index| line_array[index] = 1 if lines_hit.include?((index + 1)) }
+          else
+            line_array.each_with_index{|_,index| line_array[index] = (line_array[index].to_i + lines_hit[(index + 1).to_s].to_i) if lines_hit.keys.include?((index + 1).to_s) }
+          end
+          {filename => line_array}
+        else
+          Coverband.configuration.logger.info "file #{filename} not found in project"
+          nil
+        end
+      end
+
+      def self.get_current_scov_data_imp(store, roots)
+        scov_style_report = {}
+
+        ###
+        # why do we need to merge covered files data?
+        # basically because paths on machines or deployed hosts could be different, so
+        # two different keys could point to the same filename or `line_key`
+        # this logic should be pushed to base report
+        ###
+        store.covered_files.each do |key|
+          next if Coverband.configuration.ignore.any?{ |i| key.match(i) }
+          line_data = line_hash(store, key, roots)
+
+          if line_data
+            line_key = line_data.keys.first
+            previous_line_hash = scov_style_report[line_key]
+
+            if previous_line_hash
+              line_data[line_key] = merge_arrays(line_data[line_key], previous_line_hash)
+            end
+
+            scov_style_report.merge!(line_data)
+          end
+        end
+
+        scov_style_report = fix_file_names(scov_style_report, roots)
+        scov_style_report
+      end
+
+      def self.report_scov_with_additional_data(store, additional_scov_data, roots)
+        scov_style_report = get_current_scov_data_imp(store, roots)
+
+        additional_scov_data.each do |data|
+          scov_style_report = merge_existing_coverage(scov_style_report, data)
+        end
+
+        scov_style_report
+      end
+
+    end
+  end
+end
+

data/lib/coverband/reporters/console_report.rb

@@ -0,0 +1,17 @@
+module Coverband
+  module Reporters
+    class ConsoleReport < Base
+
+      def self.report(store, options = {})
+        scov_style_report = super(store, options)
+
+        scov_style_report.each_pair do |file, usage|
+          Coverband.configuration.logger.info "#{file}: #{usage}"
+        end
+        scov_style_report
+      end
+
+    end
+  end
+end
+

data/lib/coverband/reporters/simple_cov_report.rb

@@ -0,0 +1,46 @@
+module Coverband
+  module Reporters
+    class SimpleCovReport < Base
+
+      def self.report(store, options = {})
+        begin
+          require 'simplecov'
+        rescue
+          Coverband.configuration.logger.error "coverband requires simplecov in order to generate a report, when configured for the scov report style."
+          return
+        end
+
+        scov_style_report = super(store, options)
+
+        open_report = options.fetch(:open_report) { true }
+
+        # set root to show files if user has simplecov profiles
+        # https://github.com/danmayer/coverband/issues/59
+        SimpleCov.root(current_root)
+
+        # add in files never hit in coverband
+        SimpleCov.track_files "#{current_root}/{app,lib,config}/**/*.{rb,haml,erb,slim}"
+
+        # still apply coverband filters
+        report_files = SimpleCov.add_not_loaded_files(scov_style_report)
+        filtered_report_files = {}
+        report_files.each_pair do |file, data|
+          next if Coverband.configuration.ignore.any?{ |i| file.match(i) }
+          filtered_report_files[file] = data
+        end
+
+        SimpleCov::Result.new(filtered_report_files).format!
+
+        if open_report
+          `open #{SimpleCov.coverage_dir}/index.html`
+        else
+          Coverband.configuration.logger.info "report is ready and viewable: open #{SimpleCov.coverage_dir}/index.html"
+        end
+
+        S3ReportWriter.new(Coverband.configuration.s3_bucket).persist! if Coverband.configuration.s3_bucket
+      end
+
+    end
+  end
+end
+

data/lib/coverband/s3_report_writer.rb

@@ -2,6 +2,12 @@ class S3ReportWriter
 
   def initialize(bucket_name)
     @bucket_name = bucket_name
+    begin
+      require 'aws-sdk'
+    rescue
+      Coverband.configuration.logger.error "coverband requires 'aws-sdk' in order use S3ReportWriter."
+      return
+    end
   end
 
   def persist!
@@ -26,5 +32,4 @@ class S3ReportWriter
     s3.bucket(@bucket_name)
   end
 
-
 end

data/lib/coverband/tasks.rb

@@ -2,21 +2,23 @@ namespace :coverband do
 
   desc "record coverband coverage baseline"
   task :baseline do
-    Coverband::Reporter.baseline {
+    Coverband::Baseline.record {
         if Rake::Task.tasks.any?{ |key| key.to_s.match(/environment$/) }
+          Coverband.configuration.logger.info "invoking rake environment"
           Rake::Task['environment'].invoke
         elsif Rake::Task.tasks.any?{ |key| key.to_s.match(/env$/) }
+          Coverband.configuration.logger.info "invoking rake env"
           Rake::Task["env"].invoke
-        else
-          baseline_files = [File.expand_path('./config/boot.rb',  Dir.pwd),
-                            File.expand_path('./config/application.rb', Dir.pwd),
-                            File.expand_path('./config/environment.rb', Dir.pwd)]
-          
-          baseline_files.each do |baseline_file|
-                          if File.exists?(baseline_file)
-                            require baseline_file
-                          end
-                        end
+        end
+
+        baseline_files = [File.expand_path('./config/boot.rb',  Dir.pwd),
+                          File.expand_path('./config/application.rb', Dir.pwd),
+                          File.expand_path('./config/environment.rb', Dir.pwd)]
+
+        baseline_files.each do |baseline_file|
+          if File.exists?(baseline_file)
+            require baseline_file
+          end
         end
         if defined? Rails
           Dir.glob("#{Rails.root}/app/**/*.rb").sort.each { |file| 
@@ -44,7 +46,11 @@ namespace :coverband do
   ###
   desc "report runtime coverband code coverage"
   task :coverage => :environment do
-    Coverband::Reporter.report
+    if Coverband.configuration.reporter=='scov'
+      Coverband::Reporters::SimpleCovReport.report(Coverband.configuration.store)
+    else
+      Coverband::Reporters::ConsoleReport.report(Coverband.configuration.store)
+    end
   end
 
   def clear_simplecov_filters
@@ -55,18 +61,22 @@ namespace :coverband do
 
   desc "report runtime coverband code coverage after disabling simplecov filters"
   task :coverage_no_filters => :environment do
-    clear_simplecov_filters
-    Coverband::Reporter.report
+    if Coverband.configuration.reporter=='scov'
+      clear_simplecov_filters
+      Coverband::Reporters::SimpleCovReport.report(Coverband.configuration.store)
+    else
+      puts "coverage without filters only makes sense for SimpleCov reports"
+    end
   end
 
   ###
   # You likely want to clear coverage after significant code changes.
   # You may want to have a hook that saves current coverband data on deploy
-  # and then resets the redis data.
+  # and then resets the coverband store data.
   ###
   desc "reset coverband coverage data"
   task :clear  => :environment do
-    Coverband::Reporter.clear_coverage
+    Coverband.configuration.store.clear!
   end
 
 end

data/lib/coverband/version.rb

@@ -1,3 +1,3 @@
 module Coverband
-  VERSION = "1.3.1"
+  VERSION = "1.5.0"
 end

data/test/benchmarks/benchmark.rake

@@ -14,7 +14,7 @@ namespace :benchmarks do
     end
   end
 
-  desc 'set up coverband'
+  desc 'set up coverband default redis'
   task :setup do
     clone_classifier
     $LOAD_PATH.unshift(File.join(classifier_dir, 'lib'))
@@ -34,6 +34,42 @@ namespace :benchmarks do
 
   end
 
+  desc 'set up coverband redis array'
+  task :setup_array do
+    clone_classifier
+    $LOAD_PATH.unshift(File.join(classifier_dir, 'lib'))
+    require 'benchmark'
+    require 'classifier-reborn'
+
+    Coverband.configure do |config|
+      config.redis              = Redis.new
+      config.root               = Dir.pwd
+      config.startup_delay      = 0
+      config.percentage         = 100.0
+      config.logger             = $stdout
+      config.verbose            = false
+      config.store              = Coverband::Adapters::RedisStore.new(Redis.new, array: true)
+    end
+  end
+
+  desc 'set up coverband filestore'
+  task :setup_file do
+    clone_classifier
+    $LOAD_PATH.unshift(File.join(classifier_dir, 'lib'))
+    require 'benchmark'
+    require 'classifier-reborn'
+
+    Coverband.configure do |config|
+      config.redis              = nil
+      config.store              = nil
+      config.root               = Dir.pwd
+      config.startup_delay      = 0
+      config.percentage         = 100.0
+      config.logger             = $stdout
+      config.verbose            = false
+      config.coverage_file     = '/tmp/benchmark_store.json'
+    end
+  end
 
   def bayes_classification
     b = ClassifierReborn::Bayes.new 'Interesting', 'Uninteresting'
@@ -65,11 +101,9 @@ namespace :benchmarks do
     10_000.times { Dog.new.bark }
   end
 
-
-
-  desc 'runs benchmarks'
-  task :run => :setup do
-    SAMPLINGS = 3
+  def run_work
+    puts "benchmark for: #{Coverband.configuration.inspect}"
+    puts "store: #{Coverband.configuration.store.inspect}"
     bm = Benchmark.bm(15) do |x|
 
       x.report 'coverband' do
@@ -85,10 +119,26 @@ namespace :benchmarks do
           work
         end
       end
-
     end
   end
 
+  desc 'runs benchmarks on default redis setup'
+  task :run => :setup do
+    SAMPLINGS = 5
+    run_work
+  end
+
+  desc 'runs benchmarks redis array'
+  task :run_array => :setup_array do
+    SAMPLINGS = 5
+    run_work
+  end
+
+  desc 'runs benchmarks file store'
+  task :run_file => :setup_file do
+    SAMPLINGS = 5
+    run_work
+  end
 end
 
 desc "runs benchmarks"