coverband 2.0.2 → 2.0.3.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d053a25d6140b3254fe2d2f1afa6a92fc06f0d3e
-  data.tar.gz: 069d15a21f7c2909fcdcb7a2f955fecc2daef168
+  metadata.gz: f64bc911c54a44ba522c2e10ae79e0ce7d7d90e9
+  data.tar.gz: 84d3605cc8c8454ba045319a3b13ede37be8898d
 SHA512:
-  metadata.gz: 8b4dfdbe5797949ab92ac9ec869f4fb4776162b0c681427436733fa4bbc4bdf4bf02be159559e8e1baf613704ecc8044256cd21e8dca3d6f3f575be00e7908f7
-  data.tar.gz: de454d222f4545cd6db08d9043fe97a1d5aa71aa339c5c0b9b6cd5694d252cb344fca4183a6cb55c30e052a709ff251de9ebeb2d1e2c79d2572594faa3e1411f
+  metadata.gz: 4a0f028257b276cbadd8c721c21aa299431a2fb3f8cce233491da8443a769d7b425a3432ca3875081c44c72fd78d0398f24dceb0be4783241c67849bcbbc208f
+  data.tar.gz: dd05e38601f80feebe393b3c5d91769512980b68df15acf9ab3504f99997eadf77531810007f34cb3959c51e3a0dd4e0a42d1f10ad60fba84395645b862babda

data/changes.md

@@ -16,7 +16,14 @@ Will be the fully modern release that drops maintenance legacy support in favor
 
 # Alpha
 
-### ???
+### 3.0.0
+
+* drop Tracepoint
+* background thread reporter
+
+# 2.0.3
+
+* don''t include docs in the gemfile thanks @bquorning
 
 
 # Released
@@ -30,6 +37,7 @@ Will be the fully modern release that drops maintenance legacy support in favor
 * fix on baseline to show an issue by @viktor-silakov
 * remove all coverband:baseline related features and documentation
 * dropped Sinatra requirement for web mountable page
+* fix on filestore by @danrabinowitz
 * fixes to the MemoryCacheStore by @kbaum
 
 ### 2.0.1

data/coverband.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
   spec.homepage      = 'https://github.com/danmayer/coverband'
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split("\n")
+  spec.files         = `git ls-files`.split("\n").reject { |f| f.start_with?('docs') }
   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']

data/lib/coverband/adapters/redis_store.rb

@@ -23,9 +23,10 @@ module Coverband
       def save_report(report)
         store_array(base_key, report.keys)
 
-        report.each do |file, lines|
-          store_map("#{base_key}.#{file}", lines)
-        end
+        file_keys = report.keys.map {|file| "#{base_key}.#{file}"}
+        existing_records = existing_records(file_keys)
+        combined_report = combined_report(file_keys, report, existing_records)
+        pipelined_save(combined_report)
       end
 
       def coverage
@@ -47,16 +48,42 @@ module Coverband
       private
 
       attr_reader :redis
+      
+      def pipelined_save(combined_report)
+        redis.pipelined do
+          combined_report.each do |file, values|
+            existing = values[:existing]
+            new = values[:new]
+            unless values.empty?
+              # in redis all file_keys are strings
+              new_string_values = Hash[new.map {|k, val| [k.to_s, val]}]
+              new_string_values.merge!(existing) {|_k, old_v, new_v| old_v.to_i + new_v.to_i}
+              redis.mapped_hmset(file, new_string_values)
+              redis.expire(file, @ttl) if @ttl
+            end
+          end
+        end
+      end
+
+      def existing_records(file_keys)
+        redis.pipelined do
+          file_keys.each do |key|
+            redis.hgetall(key)
+          end
+        end
+      end
+
+      def combined_report(file_keys, report, existing_records)
+        combined_report = {}
 
-      def store_map(key, values)
-        unless values.empty?
-          existing = redis.hgetall(key)
-          # in redis all keys are strings
-          values = Hash[values.map { |k, val| [k.to_s, val] }]
-          values.merge!(existing) { |_k, old_v, new_v| old_v.to_i + new_v.to_i }
-          redis.mapped_hmset(key, values)
-          redis.expire(key, @ttl) if @ttl
+        file_keys.each_with_index do |key, i|
+          combined_report[key] = {
+            new: report.values[i],
+            existing: existing_records[i]
+          }
         end
+        
+        return combined_report
       end
 
       def store_array(key, values)

data/lib/coverband/collectors/coverage.rb

@@ -36,7 +36,7 @@ module Coverband
         end
 
         if @store
-          @store.save_report(@file_line_usage)
+          @store.save_report(files_with_line_usage)
           @file_line_usage.clear
         elsif @verbose
           @logger.debug 'coverage report: '
@@ -57,6 +57,12 @@ module Coverband
 
       private
 
+      def files_with_line_usage
+        @file_line_usage.select do |_file_name, coverage|
+          coverage.values.any? { |value| value != 0 }
+        end
+      end
+
       def array_diff(latest, original)
         latest.map.with_index { |v, i| (v && original[i]) ? v - original[i] : nil }
       end

data/lib/coverband/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Coverband
-  VERSION = '2.0.2'
+  VERSION = '2.0.3.alpha'
 end

data/test/benchmarks/benchmark.rake

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 namespace :benchmarks do
-
   # https://github.com/evanphx/benchmark-ips
   # Enable and start GC before each job run. Disable GC afterwards.
   #
@@ -48,7 +47,7 @@ namespace :benchmarks do
     require 'benchmark'
     require 'benchmark/ips'
 
-    # TODO ok this is interesting and weird
+    # TODO: ok this is interesting and weird
     # basically the earlier I require coverage and
     # then require files the larger perf impact
     # this is somewhat expected but can lead to significant perf diffs
@@ -67,6 +66,16 @@ namespace :benchmarks do
     require File.join(File.dirname(__FILE__), 'dog')
   end
 
+  def benchmark_redis_store
+    redis = if ENV['REDIS_TEST_URL']
+              Redis.new(url: ENV['REDIS_TEST_URL'])
+            else
+              Redis.new
+            end
+    Coverband::Adapters::RedisStore.new(redis,
+                                        redis_namespace: 'coverband_bench')
+  end
+
   desc 'set up coverband tracepoint Redis'
   task :setup_redis do
     Coverband.configure do |config|
@@ -76,7 +85,7 @@ namespace :benchmarks do
       config.logger             = $stdout
       config.collector          = 'trace'
       config.memory_caching     = ENV['MEMORY_CACHE'] ? true : false
-      config.store              = Coverband::Adapters::RedisStore.new(Redis.new)
+      config.store              = benchmark_redis_store
     end
   end
 
@@ -88,7 +97,8 @@ namespace :benchmarks do
       config.logger             = $stdout
       config.collector          = 'trace'
       config.memory_caching     = ENV['MEMORY_CACHE'] ? true : false
-      config.store              = Coverband::Adapters::FileStore.new('/tmp/benchmark_store.json')
+      file_path                 = '/tmp/benchmark_store.json'
+      config.store              = Coverband::Adapters::FileStore.new(file_path)
     end
   end
 
@@ -104,7 +114,7 @@ namespace :benchmarks do
       config.logger             = $stdout
       config.collector          = 'coverage'
       config.memory_caching     = ENV['MEMORY_CACHE'] ? true : false
-      config.store              = Coverband::Adapters::RedisStore.new(Redis.new)
+      config.store              = benchmark_redis_store
     end
   end
 
@@ -138,12 +148,12 @@ namespace :benchmarks do
     10_000.times { Dog.new.bark }
   end
 
+  # puts "benchmark for: #{Coverband.configuration.inspect}"
+  # puts "store: #{Coverband.configuration.store.inspect}"
   def run_work(hold_work = false)
     suite = GCSuite.new
-    #puts "benchmark for: #{Coverband.configuration.inspect}"
-    #puts "store: #{Coverband.configuration.store.inspect}"
     Benchmark.ips do |x|
-      x.config(:time => 12, :warmup => 5, :suite => suite)
+      x.config(time: 12, warmup: 5, suite: suite)
       x.report 'coverband' do
         Coverband::Collectors::Base.instance.sample do
           work
@@ -159,6 +169,73 @@ namespace :benchmarks do
     Coverband::Collectors::Base.instance.reset_instance
   end
 
+  def fake_line_numbers
+    24.times.each_with_object({}) do |line, line_hash|
+      line_hash[(line + 1).to_s] = rand(5)
+    end
+  end
+
+  def fake_report
+    2934.times.each_with_object({}) do |file_number, hash|
+      hash["file#{file_number + 1}.rb"] = fake_line_numbers
+    end
+  end
+
+  def adjust_report(report)
+    report.keys.each do |file|
+      next unless rand < 0.15
+      report[file] = fake_line_numbers
+    end
+    report
+  end
+
+  def reporting_speed
+    report = fake_report
+    store = benchmark_redis_store
+
+    5.times { store.save_report(report) }
+    Benchmark.ips do |x|
+      x.config(time: 15, warmup: 5)
+      x.report('store_reports') { store.save_report(report) }
+    end
+  end
+
+  def reporting_memorycache_speed
+    report = fake_report
+    redis_store = benchmark_redis_store
+    cache_store = Coverband::Adapters::MemoryCacheStore.new(redis_store)
+
+    5.times do
+      redis_store.save_report(report)
+      cache_store.save_report(report)
+      adjust_report(report)
+    end
+    Benchmark.ips do |x|
+      x.config(time: 15, warmup: 5)
+      x.report('store_redis_reports') do
+        redis_store.save_report(report)
+        adjust_report(report)
+      end
+      x.report('store_cache_reports') do
+        cache_store.save_report(report)
+        adjust_report(report)
+      end
+      x.compare!
+    end
+  end
+
+  desc 'runs benchmarks on reporting large sets of files to redis'
+  task redis_reporting: [:setup] do
+    puts 'runs benchmarks on reporting large sets of files to redis'
+    reporting_speed
+  end
+
+  desc 'benchmarks: reporting large sets of files to redis using memory cache'
+  task cache_reporting: [:setup] do
+    puts 'benchmarks: reporting large sets of files to redis using memory cache'
+    reporting_memorycache_speed
+  end
+
   desc 'runs benchmarks on default redis setup'
   task run_redis: [:setup, :setup_redis] do
     puts 'Coverband tracepoint configured with default Redis store'
@@ -179,11 +256,13 @@ namespace :benchmarks do
 
   desc 'compare Coverband Ruby Coverage with normal Ruby'
   task :compare_coverage do
-    puts 'comparing with Coverage loaded and not, this takes some time for output...'
+    puts 'comparing Coverage loaded/not, this takes some time for output...'
     puts `COVERAGE=true rake benchmarks:run_coverage`
     puts `rake benchmarks:run_coverage`
   end
 end
 
 desc 'runs benchmarks'
-task benchmarks: ['benchmarks:run_file', 'benchmarks:run_redis', 'benchmarks:compare_coverage']
+task benchmarks: ['benchmarks:run_file',
+                  'benchmarks:run_redis',
+                  'benchmarks:compare_coverage']

data/test/unit/adapters_redis_store_test.rb

@@ -17,13 +17,13 @@ class RedisTest < Test::Unit::TestCase
 
   def test_coverage
     @redis.sadd(BASE_KEY, 'dog.rb')
-    @store.send(:store_map, "#{BASE_KEY}.dog.rb", example_hash)
-    expected = { 'dog.rb' => example_hash }
+    @store.send(:pipelined_save, combined_report)
+    expected = {'dog.rb' => example_hash}
     assert_equal expected, @store.coverage
   end
 
   def test_covered_lines_for_file
-    @store.send(:store_map, "#{BASE_KEY}.dog.rb", example_hash)
+    @store.send(:pipelined_save, combined_report)
     assert_equal [["1", "1"], ["2", "2"]], @store.covered_lines_for_file('dog.rb').sort
   end
 
@@ -47,6 +47,15 @@ class RedisTest < Test::Unit::TestCase
 
   private
 
+  def combined_report
+    {
+      "#{BASE_KEY}.dog.rb" => {
+        new: example_hash,
+        existing: {}
+      }
+    }
+  end
+
   def test_data
     {
       '/Users/danmayer/projects/cover_band_server/app.rb' => { 54 => 1, 55 => 2 },

data/test/unit/reports_console_test.rb

@@ -15,6 +15,15 @@ class SimpleCovReportTest < Test::Unit::TestCase
     {'1' => '1', '2' => '2'}
   end
 
+  def combined_report
+    {
+      "#{BASE_KEY}.test/unit/dog.rb" => {
+        new: example_hash,
+        existing: {}
+      }
+    }
+  end
+
   test 'report data' do
     Coverband.configure do |config|
       config.redis             = @redis
@@ -25,7 +34,7 @@ class SimpleCovReportTest < Test::Unit::TestCase
     Coverband::Reporters::ConsoleReport.expects(:current_root).returns('./test/unit')
 
     @redis.sadd(BASE_KEY, 'test/unit/dog.rb')
-    @store.send(:store_map, "#{BASE_KEY}.test/unit/dog.rb", example_hash)
+    @store.send(:pipelined_save, combined_report)
 
     report = Coverband::Reporters::ConsoleReport.report(@store)
     expected = {"test/unit/dog.rb"=>[1, 2, nil, nil, nil, nil, nil]}

data/test/unit/reports_simple_cov_test.rb

@@ -15,6 +15,15 @@ class ReportsSimpleCovTest < Test::Unit::TestCase
     {'1' => '1', '2' => '2'}
   end
 
+  def combined_report
+    {
+      "#{BASE_KEY}.test/unit/dog.rb" => {
+        new: example_hash,
+        existing: {}
+      }
+    }
+  end
+
   test 'generate scov report' do
     Coverband.configure do |config|
       config.redis             = @redis
@@ -26,7 +35,7 @@ class ReportsSimpleCovTest < Test::Unit::TestCase
     Coverband.configuration.logger.stubs('info')
 
     @redis.sadd(BASE_KEY, 'test/unit/dog.rb')
-    @store.send(:store_map, "#{BASE_KEY}.test/unit/dog.rb", example_hash)
+    @store.send(:pipelined_save, combined_report)
 
     SimpleCov.expects(:track_files)
     SimpleCov.expects(:add_not_loaded_files).returns({})
@@ -48,7 +57,7 @@ class ReportsSimpleCovTest < Test::Unit::TestCase
     Coverband::Reporters::SimpleCovReport.expects(:current_root).at_least_once.returns('/tmp/root_dir')
 
     @redis.sadd(BASE_KEY, 'test/unit/dog.rb')
-    @store.send(:store_map, "#{BASE_KEY}.test/unit/dog.rb", example_hash)
+    @store.send(:pipelined_save, combined_report)
     SimpleCov.expects(:track_files)
     SimpleCov.expects(:add_not_loaded_files).returns('fake_file.rb' => [1])
     SimpleCov::Result.any_instance.expects(:format!)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coverband
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.0.3.alpha
 platform: ruby
 authors:
 - Dan Mayer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-09-15 00:00:00.000000000 Z
+date: 2018-10-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -195,10 +195,6 @@ files:
 - changes.md
 - config.ru
 - coverband.gemspec
-- docs/coverband-install-resize.gif
-- docs/coverband_details.png
-- docs/coverband_index.png
-- docs/coverband_install.gif
 - lib/coverband.rb
 - lib/coverband/adapters/base.rb
 - lib/coverband/adapters/file_store.rb
@@ -250,9 +246,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.5.1