coverband 3.0.0 → 3.0.1.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: c2b0fe96cfa4c9cfd336166b498bdbbba7d297265b5a7883d423b1b19d4738ad
-  data.tar.gz: 31b7d38ea823730d3855fa2203da308adc862c2c8320b756c10671873f6b016e
+SHA1:
+  metadata.gz: b33132c4d855470c5510444a91b0df3a99ef3ee8
+  data.tar.gz: e9a6c32142c9421251ce7588dcb80a4686c48e45
 SHA512:
-  metadata.gz: 1ec633dcb00294b67974c083853cdb28148ce93fc68783aaab87fe2c343a00b880c3f5b653573cca147ce3eb2e0a1aa2933ed3629d157284fc34873838971918
-  data.tar.gz: 5f58cce89174ca835edcbc53ce9a30a53facc276ad7ae290510380c133e640abe899087132ceff408c959fa4be5f119e8d4bb2c31b3da2b2e66b72dfae62f931
+  metadata.gz: 74411fa1d49db9c7bea3b59e49fcc2432a48650ecfae86c2e09273623c48e148995606ce8bdde73aaa789e8973655394672c01967827e97cd345443cd3a39d2f
+  data.tar.gz: 37dbb381f412f2b11269dbf9550148ab97cd273d60e9afae47ee47772427c0855dd4fe286dce2e9c1e73f686f257a9154f72c928de3ca22cf50008a3c9594ceb

data/README.md

@@ -194,8 +194,9 @@ run ActionController::Dispatcher.new
 # Verify Correct Installation
 
 * boot up your application
+* run app and hit a controller (via a web request, at least one request must complete)
 * run `rake coverband:coverage` this will show app initialization coverage
-* run app and hit a controller (hit at least +1 time over your `config.startup_delay` setting default is 0)
+* make another request, or enough that your reporting frequency will trigger
 * run `rake coverband:coverage` and you should see coverage increasing for the endpoints you hit.
 
 ## Installation Session

data/changes.md

@@ -30,7 +30,7 @@ Will be the fully modern release that drops maintenance legacy support in favor
 Will be a stable and fast release that drops maintenance legacy support in favor of increased performance and maintainability.
 
 - expects to drop Tracepoint collection engine
-- expects to drop anything below Ruby 2.3
+- drop anything below Ruby 2.3
 - release begins to simplify ease of use
   - drop collectors adapter
   - reduced configuration options
@@ -44,6 +44,8 @@ Will be a stable and fast release that drops maintenance legacy support in favor
 - add additional config / protection options on Coverage clear
 - add memory benchmarks showing memory overhead of coverband
 - add articles / podcasts like prontos readme https://github.com/prontolabs/pronto
+- add meta data information first seen last recorded to the coverage report views (probably need to drop simplecov for that).
+   - more details in this issue: https://github.com/danmayer/coverband/issues/118 
 
 ### Coverband_jam_session
 
@@ -70,8 +72,12 @@ Feature Ideas:
 
 ### Coverband 3.0.1
 
-* ??? ;)
-
+* update documentation around verification steps (https://github.com/danmayer/coverband/issues/135), thanks @kbaum
+* resolve coverage drift issue, https://github.com/danmayer/coverband/issues/118, thanks for MD5 hash ideas @dnasseri and @kbaum
+* first version of background thread coverage reporting https://github.com/danmayer/coverband/pull/138, thanks @kbaum
+* auto-detection of Rack & Rails thanks @kbaum
+* improved tests allowing exceptions to raise in tests @kbaum
+* add support for both aws-sdk 1.x and 2.x thanks @jared
 
 # Released
 

data/coverband.gemspec

@@ -19,22 +19,28 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
+  # to test support for sdk 1, uncomment this line
+  # spec.add_development_dependency 'aws-sdk', '~> 1'
+  # to test sdk 2 use this one
   spec.add_development_dependency 'aws-sdk', '~> 2'
+  spec.add_development_dependency 'benchmark-ips'
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'mocha', '~> 0.14.0'
   spec.add_development_dependency 'rack'
   spec.add_development_dependency 'rack-test'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'test-unit'
   spec.add_development_dependency 'redis'
-  spec.add_development_dependency 'benchmark-ips'
+  spec.add_development_dependency 'test-unit'
+  spec.add_development_dependency 'm'
+
   # used for benchmarking and tests
   spec.add_development_dependency 'classifier-reborn'
   # add when debugging
   # require 'byebug'; byebug
-  spec.add_development_dependency 'byebug'
+  spec.add_development_dependency 'pry-byebug'
 
-  # todo make an optional dependency for simplecov reports
+  # TODO: make an optional dependency for simplecov reports
   # also likely should just require simplecov-html not the whole lib
+  # I tried this but it was harder than I thought
   spec.add_runtime_dependency 'simplecov', '> 0.11.1'
 end

data/lib/coverband.rb

@@ -8,11 +8,13 @@ require 'coverband/configuration'
 require 'coverband/adapters/base'
 require 'coverband/adapters/redis_store'
 require 'coverband/adapters/file_store'
-require 'coverband/utils/s3_report_writer'
+require 'coverband/utils/s3_report'
 require 'coverband/collectors/coverage'
 require 'coverband/reporters/base'
 require 'coverband/reporters/simple_cov_report'
 require 'coverband/reporters/console_report'
+require 'coverband/integrations/background'
+require 'coverband/integrations/rack_server_check'
 require 'coverband/reporters/web'
 require 'coverband/integrations/middleware'
 require 'coverband/integrations/background'
@@ -44,5 +46,6 @@ module Coverband
 
   def self.start
     Coverband::Collectors::Coverage.instance
+    Background.start if configuration.background_reporting_enabled && !RackServerCheck.running?
   end
 end

data/lib/coverband/adapters/base.rb

@@ -4,36 +4,70 @@ module Coverband
   module Adapters
     class Base
       def initialize
-        raise 'abstract'
+        @file_hash_cache = {}
       end
 
       def clear!
         raise 'abstract'
       end
 
-      def save_report(_report)
-        raise 'abstract'
+      # Note: This could lead to slight race on redis
+      # where multiple processes pull the old coverage and add to it then push
+      # the Coverband 2 had the same issue,
+      # and the tradeoff has always been acceptable
+      def save_report(report)
+        data = report.dup
+        merge_reports(data, get_report)
+        save_coverage(data)
       end
 
       def coverage
-        raise 'abstract'
+        simple_report(get_report)
       end
 
       def covered_files
+        coverage.keys || []
+      end
+
+      def covered_lines_for_file(file)
+        coverage[file] || []
+      end
+
+      protected
+
+      def save_coverage
         raise 'abstract'
       end
 
-      def covered_lines_for_file(_file)
+      def get_report
         raise 'abstract'
       end
 
-      protected
+      def file_hash(file)
+        @file_hash_cache[file] ||= Digest::MD5.file(file).hexdigest
+      end
+
+      def expand_report(report)
+        report_time = Time.now.to_i
+        report.each_pair do |key, line_data|
+          extended_data = {
+            'first_updated_at' => report_time,
+            'last_updated_at' => report_time,
+            'file_hash' => file_hash(key),
+            'data' => line_data
+          }
+          report[key] = extended_data
+        end
+      end
 
       def merge_reports(new_report, old_report)
+        new_report = expand_report(new_report)
         keys = (new_report.keys + old_report.keys).uniq
         keys.each do |file|
-          new_report[file] = if new_report[file] && old_report[file]
-                               array_add(new_report[file], old_report[file])
+          new_report[file] = if new_report[file] &&
+                                old_report[file] &&
+                                new_report[file]['file_hash'] == old_report[file]['file_hash']
+                               merge_expanded_data(new_report[file], old_report[file])
                              elsif new_report[file]
                                new_report[file]
                              else
@@ -43,9 +77,24 @@ module Coverband
         new_report
       end
 
+      def merge_expanded_data(new_expanded, old_expanded)
+        {
+          'first_updated_at' => old_expanded['first_updated_at'],
+          'last_updated_at' => new_expanded['last_updated_at'],
+          'file_hash' => new_expanded['file_hash'],
+          'data' => array_add(new_expanded['data'], old_expanded['data'])
+        }
+      end
+
       def array_add(latest, original)
         latest.map.with_index { |v, i| (v && original[i]) ? v + original[i] : nil }
       end
+
+      def simple_report(report)
+        report.each_with_object({}) do |(key, extended_data), simple|
+          simple[key] = extended_data['data']
+        end
+      end
     end
   end
 end

data/lib/coverband/adapters/file_store.rb

@@ -8,9 +8,8 @@ module Coverband
     # Not recommended for production deployment
     ###
     class FileStore < Base
-      attr_accessor :path
-
       def initialize(path, _opts = {})
+        super()
         @path = path
 
         config_dir = File.dirname(@path)
@@ -21,32 +20,15 @@ module Coverband
         File.delete(path) if File.exist?(path)
       end
 
-      def save_report(report)
-        merge_reports(report, coverage)
-        save_coverage(report)
-      end
-
-      def coverage
-        existing_data(path)
-      end
-
-      def covered_files
-        report = existing_data(path)
-        existing_data(path).merge(report).keys || []
-      end
-
-      def covered_lines_for_file(file)
-        report = existing_data(path)
-        report[file] || []
-      end
-
       private
 
+      attr_accessor :path
+
       def save_coverage(report)
         File.open(path, 'w') { |f| f.write(report.to_json) }
       end
 
-      def existing_data(path)
+      def get_report
         if File.exist?(path)
           JSON.parse(File.read(path))
         else

data/lib/coverband/adapters/redis_store.rb

@@ -6,9 +6,10 @@ module Coverband
     # RedisStore store a merged coverage file to redis
     ###
     class RedisStore < Base
-      BASE_KEY = 'coverband3'
+      BASE_KEY = 'coverband3_1'
 
       def initialize(redis, opts = {})
+        super()
         @redis           = redis
         @ttl             = opts[:ttl]
         @redis_namespace = opts[:redis_namespace]
@@ -18,27 +19,6 @@ module Coverband
         @redis.del(base_key)
       end
 
-      def save_report(report)
-        # Note: This could lead to slight races
-        # where multiple processes pull the old coverage and add to it then push
-        # the Coverband 2 had the same issue,
-        # and the tradeoff has always been acceptable
-        merge_reports(report, coverage)
-        save_coverage(base_key, report)
-      end
-
-      def coverage
-        get_report(base_key)
-      end
-
-      def covered_files
-        coverage.keys
-      end
-
-      def covered_lines_for_file(file)
-        coverage[file]
-      end
-
       private
 
       attr_reader :redis
@@ -47,13 +27,13 @@ module Coverband
         @base_key ||= [BASE_KEY, @redis_namespace].compact.join('.')
       end
 
-      def save_coverage(key, data)
-        redis.set key, data.to_json
-        redis.expire(key, @ttl) if @ttl
+      def save_coverage(data)
+        redis.set base_key, data.to_json
+        redis.expire(base_key, @ttl) if @ttl
       end
 
-      def get_report(key)
-        data = redis.get key
+      def get_report
+        data = redis.get base_key
         data ? JSON.parse(data) : {}
       end
     end

data/lib/coverband/collectors/coverage.rb

@@ -24,12 +24,16 @@ module Coverband
         @verbose  = Coverband.configuration.verbose
         @logger   = Coverband.configuration.logger
         @current_thread = Thread.current
+        @test_env = Coverband.configuration.test_env
+        @background_reporting_enabled = Coverband.configuration.background_reporting_enabled
         Thread.current[:coverband_instance] = nil
         self
       end
 
       def report_coverage(force_report = false)
+        return Background.start if @background_reporting_enabled
         return if !ready_to_report? && !force_report
+
         unless @store
           @logger.debug 'no store set, no-op'
           return
@@ -44,6 +48,7 @@ module Coverband
           @logger.error "error: #{err.inspect} #{err.message}"
           @logger.error err.backtrace
         end
+        raise err if @test_env
       end
 
       protected

data/lib/coverband/configuration.rb

@@ -7,7 +7,8 @@ module Coverband
                   :reporter, :reporting_frequency,
                   :disable_on_failure_for,
                   :redis_namespace, :redis_ttl,
-                  :safe_reload_files
+                  :safe_reload_files, :background_reporting_enabled,
+                  :background_reporting_sleep_seconds, :test_env
 
     attr_writer :logger, :s3_region, :s3_bucket, :s3_access_key_id, :s3_secret_access_key
 
@@ -29,6 +30,8 @@ module Coverband
       @s3_secret_access_key = nil
       @redis_namespace = nil
       @redis_ttl = nil
+      @test_env = nil
+      @background_reporting_sleep_seconds = 30
     end
 
     def logger

data/lib/coverband/integrations/background.rb

@@ -2,6 +2,30 @@
 
 module Coverband
   class Background
-    # TODO: stub to implement background thread recording
+    @semaphore = Mutex.new
+
+    def self.start
+      return if @background_reporting_running
+
+      logger = Coverband.configuration.logger
+      @semaphore.synchronize do
+        return if @background_reporting_running
+
+        @background_reporting_running = true
+        sleep_seconds = Coverband.configuration.background_reporting_sleep_seconds
+        Thread.new do
+          loop do
+            Coverband::Collectors::Coverage.instance.report_coverage
+            logger&.debug("Reported coverage from thread. Sleeping for #{sleep_seconds} seconds")
+            sleep(sleep_seconds)
+          end
+        end
+
+        at_exit do
+          Coverband::Collectors::Coverage.instance.report_coverage
+          logger&.debug("Reported coverage before exit")
+        end
+      end
+    end
   end
 end

data/lib/coverband/integrations/rack_server_check.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Coverband
+  class RackServerCheck
+    def self.running?
+      new(Kernel.caller_locations).running?
+    end
+
+    def initialize(stack)
+      @stack = stack
+    end
+
+    def running?
+      rack_server? || rails_server?
+    end
+
+    def rack_server?
+      @stack.any? { |line| line.path.include?('lib/rack/') }
+    end
+
+    def rails_server?
+      @stack.any? do |location|
+        location.path.include?('rails/commands/commands_tasks.rb') && location.label == 'server'
+      end
+    end
+  end
+end

data/lib/coverband/reporters/simple_cov_report.rb

@@ -38,13 +38,7 @@ module Coverband
           Coverband.configuration.logger.info "report is ready and viewable: open #{SimpleCov.coverage_dir}/index.html"
         end
 
-        s3_writer_options = {
-          region: Coverband.configuration.s3_region,
-          access_key_id: Coverband.configuration.s3_access_key_id,
-          secret_access_key: Coverband.configuration.s3_secret_access_key
-        }
-        Coverband::Utils::S3ReportWriter.new(Coverband.configuration.s3_bucket,
-                                                s3_writer_options).persist! if Coverband.configuration.s3_bucket
+        Coverband::Utils::S3Report.instance.persist! if Coverband.configuration.s3_bucket
       end
     end
   end

data/lib/coverband/reporters/web.rb

@@ -71,7 +71,7 @@ module Coverband
       end
 
       def show
-        html = s3.get_object(bucket: Coverband.configuration.s3_bucket, key: 'coverband/index.html').body.read
+        html = Coverband::Utils::S3Report.instance.retrieve
         # HACK: the static HTML assets to link to the path where this was mounted
         html = html.gsub("src='", "src='#{base_path}")
         html = html.gsub("href='", "href='#{base_path}")
@@ -126,30 +126,12 @@ module Coverband
 
       # This method should get the root mounted endpoint
       # for example if the app is mounted like so:
-      # mount Coverband::S3Web, at: '/coverage'
+      # mount Coverband::Web, at: '/coverage'
       # "/coverage/collect_coverage?" become:
       # /coverage/
       def base_path
         request.path.match("\/.*\/") ? request.path.match("\/.*\/")[0] : '/'
       end
-
-      def s3
-        begin
-          require 'aws-sdk'
-        rescue StandardError
-          Coverband.configuration.logger.error "coverband requires 'aws-sdk' in order use S3ReportWriter."
-          return
-        end
-        @s3 ||= begin
-          client_options = {
-            region: Coverband.configuration.s3_region,
-            access_key_id: Coverband.configuration.s3_access_key_id,
-            secret_access_key: Coverband.configuration.s3_secret_access_key
-          }
-          client_options = {} if client_options.values.any?(&:nil?)
-          Aws::S3::Client.new(client_options)
-        end
-      end
     end
   end
 end

data/lib/coverband/utils/s3_report.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module Coverband
+  module Utils
+    ###
+    # TODO: this is currently a html report writer
+    # this should support writing coverage the current method should be fine
+    # to write every report to S3 and sum them later or use the 2 pass
+    # method we do for redis if in a background thread
+    ###
+    class S3Report
+      def self.instance
+        s3_options = {
+          region: Coverband.configuration.s3_region,
+          access_key_id: Coverband.configuration.s3_access_key_id,
+          secret_access_key: Coverband.configuration.s3_secret_access_key
+        }
+        new(Coverband.configuration.s3_bucket, s3_options)
+      end
+
+      def initialize(bucket_name, options = {})
+        @bucket_name = bucket_name
+        @region = options[:region]
+        @access_key_id = options[:access_key_id]
+        @secret_access_key = options[:secret_access_key]
+        begin
+          require 'aws-sdk'
+        rescue StandardError
+          err_msg = 'coverband requires aws-sdk in order use S3Report.'
+          Coverband.configuration.logger.error err_msg
+          return
+        end
+      end
+
+      def persist!
+        if defined?(Aws)
+          object.put(body: coverage_content)
+        else
+          object.write(coverage_content)
+        end
+      end
+
+      def retrieve
+        if defined?(Aws)
+          s3_client.get_object(bucket: Coverband.configuration.s3_bucket,
+                               key: 'coverband/index.html').body.read
+        else
+          object.read
+        end
+      end
+
+      private
+
+      def coverage_content
+        version = Gem::Specification.find_by_name('simplecov-html').version.version
+        File.read("#{SimpleCov.coverage_dir}/index.html").gsub("./assets/#{version}/", '')
+      rescue StandardError
+        File.read("#{SimpleCov.coverage_dir}/index.html").to_s.gsub('./assets/0.10.1/', '')
+      end
+
+      def object
+        if defined?(Aws)
+          bucket.object('coverband/index.html')
+        else
+          bucket.objects['coverband/index.html']
+        end
+      end
+
+      def client_options
+        {
+          region: @region,
+          access_key_id: @access_key_id,
+          secret_access_key: @secret_access_key
+        }
+      end
+
+      def s3_client
+        if defined?(Aws)
+          # AWS SDK v2
+          Aws::S3::Client.new(client_options)
+        else
+          # AWS SDK v1
+          AWS::S3::Client.new(client_options)
+        end
+      end
+
+      def s3
+        resource_options = { client: s3_client }
+        resource_options = {} if client_options.values.any?(&:nil?)
+        if defined?(Aws)
+          # AWS SDK v2
+          Aws::S3::Resource.new(resource_options)
+        else
+          # AWS SDK v1
+          AWS::S3.new(resource_options)
+        end
+      end
+
+      def bucket
+        if defined?(Aws)
+          s3.bucket(@bucket_name)
+        else
+          s3.buckets[@bucket_name]
+        end
+      end
+    end
+  end
+end

data/lib/coverband/version.rb

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

data/test/benchmarks/benchmark.rake

@@ -169,6 +169,18 @@ namespace :benchmarks do
   def reporting_speed
     report = fake_report
     store = benchmark_redis_store
+    store.clear!
+
+    ###
+    # this is a hack because in the benchmark we don't have real files
+    ###
+    def store.file_hash(file)
+      if @file_hash_cache[file]
+        @file_hash_cache[file]
+      else
+        @file_hash_cache[file] = Digest::MD5.file(__FILE__).hexdigest
+      end
+    end
 
     5.times { store.save_report(report) }
     Benchmark.ips do |x|
@@ -198,7 +210,7 @@ namespace :benchmarks do
   desc 'benchmarks external requests to coverband_demo site'
   task :coverband_demo do
     # for local testing
-    # puts `ab -n 200 -c 5 "http://127.0.0.1:3000/posts"`
+    # puts `ab -n 500 -c 5 "http://127.0.0.1:3000/posts"`
     puts `ab -n 2000 -c 10 "https://coverband-demo.herokuapp.com/posts"`
   end
 
@@ -206,6 +218,7 @@ namespace :benchmarks do
   task :coverband_demo_graph do
     # for local testing
     # puts `ab -n 200 -c 5 "http://127.0.0.1:3000/posts"`
+    #puts `ab -n 500 -c 10 -g tmp/ab_brench.tsv "http://127.0.0.1:3000/posts"`
     puts `ab -n 2000 -c 10 -g tmp/ab_brench.tsv "https://coverband-demo.herokuapp.com/posts"`
     puts `test/benchmarks/graph_bench.sh`
     `open tmp/timeseries.jpg`

data/test/test_helper.rb

@@ -7,6 +7,7 @@ require 'mocha/setup'
 require 'ostruct'
 require 'json'
 require 'redis'
+require 'pry-byebug'
 
 SimpleCov.start do
   add_filter 'specs/ruby/1.9.1/gems/'
@@ -14,10 +15,12 @@ SimpleCov.start do
   add_filter '/config/'
 end
 
-TEST_COVERAGE_FILE = '/tmp/fake_file.json'.freeze
+TEST_COVERAGE_FILE = '/tmp/fake_file.json'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
+
+Mocha::Configuration.prevent(:stubbing_method_unnecessarily)
 Mocha::Configuration.prevent(:stubbing_non_existent_method)
 
 def test(name, &block)
@@ -37,6 +40,12 @@ def test(name, &block)
   end
 end
 
+def mock_file_hash
+  mock_file = mock('mock_file')
+  mock_file.expects(:hexdigest).at_least_once.returns('abcd')
+  Digest::MD5.expects(:file).at_least_once.returns(mock_file)
+end
+
 def example_line
   [0, 1, 2]
 end
@@ -68,3 +77,9 @@ Coverband.configure do |config|
   config.reporter            = 'std_out'
   config.store               = Coverband::Adapters::RedisStore.new(Redis.new)
 end
+
+Coverband::Configuration.class_eval do
+  def test_env
+    true
+  end
+end

data/test/unit/adapters_base_test.rb

@@ -6,23 +6,44 @@ class AdaptersBaseTest < Test::Unit::TestCase
   def setup
     @test_file_path = '/tmp/coverband_filestore_test_path.json'
     @store = Coverband::Adapters::FileStore.new(@test_file_path)
+    mock_file_hash
   end
 
   def test_covered_merge
-    old_report = { '/Users/danmayer/projects/coverband_demo/config/coverband.rb' => [5, 7, nil],
-                   '/Users/danmayer/projects/coverband_demo/config/initializers/assets.rb' => [5, 5, nil],
-                   '/Users/danmayer/projects/coverband_demo/config/initializers/cookies_serializer.rb' => [5, 5, nil] }
-    new_report = { '/Users/danmayer/projects/coverband_demo/config/coverband.rb' => [5, 7, nil],
-                   '/Users/danmayer/projects/coverband_demo/config/initializers/filter_logging.rb' => [5, 5, nil],
-                   '/Users/danmayer/projects/coverband_demo/config/initializers/wrap_parameters.rb' => [5, 5, nil],
-                   '/Users/danmayer/projects/coverband_demo/app/controllers/application_controller.rb' => [5, 5, nil] }
+    old_time = 1541958097
+    current_time = Time.now.to_i
+    old_data = {
+      'first_updated_at' => old_time,
+      'last_updated_at' => current_time,
+      'file_hash' => 'abcd',
+      'data' => [5, 7, nil]
+    }
+    old_report = { '/projects/coverband_demo/config/coverband.rb' => old_data,
+                   '/projects/coverband_demo/config/initializers/assets.rb' => old_data,
+                   '/projects/coverband_demo/config/initializers/cookies_serializer.rb' => old_data }
+    new_report = { '/projects/coverband_demo/config/coverband.rb' => [5, 7, nil],
+                   '/projects/coverband_demo/config/initializers/filter_logging.rb' => [5, 7, nil],
+                   '/projects/coverband_demo/config/initializers/wrap_parameters.rb' => [5, 7, nil],
+                   '/projects/coverband_demo/app/controllers/application_controller.rb' => [5, 7, nil] }
+    expected_merge = {
+      'first_updated_at' => old_time,
+      'last_updated_at' => current_time,
+      'file_hash' => 'abcd',
+      'data' => [10, 14, nil]
+    }
+    new_data = {
+      'first_updated_at' => current_time,
+      'last_updated_at' => current_time,
+      'file_hash' => 'abcd',
+      'data' => [5, 7, nil]
+    }
     expected_result = {
-      '/Users/danmayer/projects/coverband_demo/app/controllers/application_controller.rb' => [5, 5, nil],
-      '/Users/danmayer/projects/coverband_demo/config/coverband.rb' => [10, 14, nil],
-      '/Users/danmayer/projects/coverband_demo/config/initializers/assets.rb' => [5, 5, nil],
-      '/Users/danmayer/projects/coverband_demo/config/initializers/cookies_serializer.rb' => [5, 5, nil],
-      '/Users/danmayer/projects/coverband_demo/config/initializers/filter_logging.rb' => [5, 5, nil],
-      '/Users/danmayer/projects/coverband_demo/config/initializers/wrap_parameters.rb' => [5, 5, nil]
+      '/projects/coverband_demo/app/controllers/application_controller.rb' => new_data,
+      '/projects/coverband_demo/config/coverband.rb' => expected_merge,
+      '/projects/coverband_demo/config/initializers/assets.rb' => old_data,
+      '/projects/coverband_demo/config/initializers/cookies_serializer.rb' => old_data,
+      '/projects/coverband_demo/config/initializers/filter_logging.rb' => new_data,
+      '/projects/coverband_demo/config/initializers/wrap_parameters.rb' => new_data
     }
     assert_equal expected_result, @store.send(:merge_reports, new_report, old_report)
   end

data/test/unit/adapters_file_store_test.rb

@@ -10,8 +10,8 @@ class AdaptersFileStoreTest < Test::Unit::TestCase
   end
 
   def test_covered_lines_for_file
-    assert_equal @store.covered_lines_for_file('dog.rb')['1'],  1
-    assert_equal @store.covered_lines_for_file('dog.rb')['2'],  2
+    assert_equal @store.covered_lines_for_file('dog.rb')[0],  1
+    assert_equal @store.covered_lines_for_file('dog.rb')[1],  2
   end
 
   def test_covered_lines_when_null
@@ -28,7 +28,8 @@ class AdaptersFileStoreTest < Test::Unit::TestCase
   end
 
   def test_save_report
-    @store.send(:save_report, 'cat.rb' => [0,1])
+    mock_file_hash
+    @store.send(:save_report, 'cat.rb' => [0, 1])
     assert_equal @store.covered_lines_for_file('cat.rb')[1], 1
   end
 
@@ -36,7 +37,10 @@ class AdaptersFileStoreTest < Test::Unit::TestCase
 
   def test_data
     {
-      'dog.rb' => { 1 => 1, 2 => 2 }
+      'dog.rb' => { 'data' => [1, 2, nil],
+                    'file_hash' => 'abcd',
+                    'first_updated_at' => 1541968729,
+                    'last_updated_at' => 1541968729 }
     }
   end
 end

data/test/unit/adapters_redis_store_test.rb

@@ -12,27 +12,30 @@ class RedisTest < Test::Unit::TestCase
   end
 
   def test_coverage
+    mock_file_hash
     expected = basic_coverage
     @store.save_report(expected)
     assert_equal expected, @store.coverage
   end
 
   def test_coverage_increments
-    expected = basic_coverage
-    @store.save_report(expected)
+    mock_file_hash
+    expected = basic_coverage.dup
+    @store.save_report(basic_coverage.dup)
     assert_equal expected, @store.coverage
-    @store.save_report(expected)
+    @store.save_report(basic_coverage.dup)
     assert_equal [0, 2, 4], @store.coverage['app_path/dog.rb']
   end
 
   def test_covered_lines_for_file
+    mock_file_hash
     expected = basic_coverage
     @store.save_report(expected)
     assert_equal example_line, @store.covered_lines_for_file('app_path/dog.rb')
   end
 
   def test_covered_lines_when_null
-    assert_equal nil, @store.covered_lines_for_file('app_path/dog.rb')
+    assert_equal [], @store.covered_lines_for_file('app_path/dog.rb')
   end
 
   def test_clear
@@ -42,15 +45,6 @@ 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/background_test.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require File.expand_path('../test_helper', File.dirname(__FILE__))
+
+class BackgroundTest < Test::Unit::TestCase
+  def test_start
+    Thread.expects(:new).yields
+    Coverband::Background.expects(:loop).yields
+    Coverband::Collectors::Coverage.instance.expects(:report_coverage)
+    Coverband::Background.expects(:sleep).with(30)
+    Coverband::Background.expects(:at_exit).yields
+    Coverband::Collectors::Coverage.instance.expects(:report_coverage)
+    2.times { Coverband::Background.start }
+  end
+end
+

data/test/unit/collectors_coverage_test.rb

@@ -29,5 +29,29 @@ if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.3.0')
       assert_equal Coverband::Adapters::RedisStore, coverband.instance_variable_get('@store').class
     end
 
+    test 'reports coverage in background when background reporting enabled' do
+      Coverband.configuration.stubs(:background_reporting_enabled).returns(true)
+      @coverband.reset_instance
+      Coverband::Background.expects(:start)
+      @coverband.report_coverage
+    end
+
+    test 'report_coverage raises errors in tests' do
+      Coverband.configuration.stubs(:background_reporting_enabled).returns(true)
+      @coverband.reset_instance
+      Coverband::Background.expects(:start).raises("Oh no")
+      assert_raise RuntimeError do
+        @coverband.report_coverage
+      end
+    end
+
+    test 'report_coverage does not raise errors in non-test mode' do
+      Coverband.configuration.stubs(:background_reporting_enabled).returns(true)
+      Coverband.configuration.stubs(:test_env).returns(false)
+      @coverband.reset_instance
+      Coverband::Background.expects(:start).raises("Oh no")
+      @coverband.report_coverage
+    end
+
   end
 end

data/test/unit/coverband_test.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require File.expand_path('../test_helper', File.dirname(__FILE__))
+
+class CoverbandTest < Test::Unit::TestCase
+
+  test 'Coverband#start kicks off background reporting if enabled and not in rack server' do
+    Coverband.configuration.stubs(:background_reporting_enabled).returns(:true)
+    Coverband::RackServerCheck.expects(:running?).returns(false)
+    Coverband::Background.expects(:start)
+    Coverband.start
+  end
+
+  test 'Coverband#start delays background reporting if enabled and running in a rack server' do
+    Coverband.configuration.stubs(:background_reporting_enabled).returns(true)
+    Coverband::RackServerCheck.expects(:running?).returns(true)
+    Coverband::Background.expects(:start).never
+    Coverband.start
+  end
+
+  test 'Coverband#start does not kick off background reporting if not enabled' do
+    Coverband.configuration.stubs(:background_reporting_enabled).returns(false)
+    Coverband::Background.expects(:start).never
+    ::Coverband.start
+  end
+end

data/test/unit/rack_server_checkout_test.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require File.expand_path('../test_helper', File.dirname(__FILE__))
+
+class RackServerCheckTest < Test::Unit::TestCase
+
+  test 'returns true when running in rack server' do
+    caller_locations = ['blah/lib/rack/server.rb'].map{ |path| OpenStruct.new(path: path, label: 'foo') }
+    Kernel.expects(:caller_locations).returns(caller_locations)
+    assert_true(Coverband::RackServerCheck.running?)
+  end
+
+  test 'returns false when not running in rack server' do
+    caller_locations = ['blah/lib/sidekiq/worker.rb'].map{ |path| OpenStruct.new(path: path, label: 'foo') }
+    Kernel.expects(:caller_locations).returns(caller_locations)
+    assert_false(Coverband::RackServerCheck.running?)
+  end
+
+  test 'returns true if running within a rails server' do
+    caller_locations = [OpenStruct.new(path: '/lib/rails/commands/commands_tasks.rb', label: 'server')] 
+    Kernel.expects(:caller_locations).returns(caller_locations)
+    assert_true(Coverband::RackServerCheck.running?)
+  end
+end

data/test/unit/reports_base_test.rb

@@ -103,8 +103,6 @@ class ReportsBaseTest < Test::Unit::TestCase
     lines_hit = [1, 3, 6]
     store.stubs(:coverage).returns(key => lines_hit)
     expected = { key => [1, 3, 6] }
-    File.stubs(:exist?).returns(true)
-    File.stubs(:foreach).returns(['line 1', 'line2', 'line3', 'line4', 'line5', 'line6'])
 
     assert_equal expected, Coverband::Reporters::Base.send(:get_current_scov_data_imp, store, roots)
   end

data/test/unit/reports_console_test.rb

@@ -18,6 +18,7 @@ class SimpleCovReportTest < Test::Unit::TestCase
       config.reporting_frequency = 100.0
     end
     Coverband.configuration.logger.stubs('info')
+    mock_file_hash
     Coverband::Reporters::ConsoleReport
       .expects(:current_root)
       .returns('app_path')

data/test/unit/reports_simple_cov_test.rb

@@ -11,15 +11,6 @@ class ReportsSimpleCovTest < Test::Unit::TestCase
     @store.clear!
   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.reporter          = 'scov'
@@ -28,13 +19,13 @@ class ReportsSimpleCovTest < Test::Unit::TestCase
       config.ignore            = ['notsomething.rb']
     end
     Coverband.configuration.logger.stubs('info')
+    mock_file_hash
     @store.send(:save_report, basic_coverage)
 
     SimpleCov.expects(:track_files)
     SimpleCov.expects(:add_not_loaded_files).returns({})
     SimpleCov::Result.any_instance.expects(:format!)
     SimpleCov.stubs(:root)
-
     Coverband::Reporters::SimpleCovReport.report(@store, open_report: false)
   end
 end

data/test/unit/reports_web_test.rb

@@ -29,9 +29,7 @@ if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.2.0')
 
       test 'renders show content' do
         Coverband.configuration.s3_bucket = 'coverage-bucket'
-        s3 = mock('s3')
-        Aws::S3::Client.expects(:new).returns(s3)
-        s3.expects(:get_object).with(bucket: 'coverage-bucket', key: 'coverband/index.html').returns mock('response', body: mock('body', read: 'content'))
+        Coverband::Utils::S3Report.any_instance.expects(:retrieve).returns('content')
         get '/show'
         assert last_response.ok?
         assert_equal 'content', last_response.body

data/test/unit/utils_s3_report_test.rb

@@ -0,0 +1,44 @@
+require File.expand_path('../test_helper', File.dirname(__FILE__))
+require 'aws-sdk'
+
+module Coverband
+  class S3ReportTest < Test::Unit::TestCase
+    def html_version
+      Gem::Specification.find_by_name('simplecov-html').version.version.to_s
+    rescue StandardError
+      '0.10.1'
+    end
+
+    test 'it writes the coverage report to s3' do
+      if defined?(Aws::S3::Resource)
+        # AWS v2
+        s3 = mock('s3_resource')
+        bucket = mock('bucket')
+        object = mock('object')
+        s3.expects(:bucket).with('coverage-bucket').returns(bucket)
+        bucket.expects(:object).with('coverband/index.html').returns(object)
+        File.expects(:read).at_least(0).returns("content ./assets/#{html_version}/")
+        object.expects(:put).with(body: 'content ')
+        Aws::S3::Resource.expects(:new).returns(s3)
+      else
+        # AWS v1
+        object = mock('object')
+        object.expects(:write).with('content ')
+        bucket = mock('bucket')
+        bucket.expects(:objects).returns('coverband/index.html' => object)
+        local_s3 = mock('s3_resource')
+        local_s3.expects(:buckets).returns('coverage-bucket' => bucket)
+        File.expects(:read).at_least(0).returns("content ./assets/#{html_version}/")
+        AWS::S3::Client.expects(:new).returns(nil)
+        AWS::S3.expects(:new).returns(local_s3)
+      end
+
+      s3_options = {
+        region: 'us-west-1',
+        access_key_id: '',
+        secret_access_key: ''
+      }
+      Coverband::Utils::S3Report.new('coverage-bucket', s3_options).persist!
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coverband
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1.alpha
 platform: ruby
 authors:
 - Dan Mayer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-04 00:00:00.000000000 Z
+date: 2018-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  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: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -95,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: redis
+  name: test-unit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +137,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: benchmark-ips
+  name: m
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,7 +165,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -204,11 +218,12 @@ files:
 - lib/coverband/configuration.rb
 - lib/coverband/integrations/background.rb
 - lib/coverband/integrations/middleware.rb
+- lib/coverband/integrations/rack_server_check.rb
 - lib/coverband/reporters/base.rb
 - lib/coverband/reporters/console_report.rb
 - lib/coverband/reporters/simple_cov_report.rb
 - lib/coverband/reporters/web.rb
-- lib/coverband/utils/s3_report_writer.rb
+- lib/coverband/utils/s3_report.rb
 - lib/coverband/utils/tasks.rb
 - lib/coverband/version.rb
 - test/benchmarks/.gitignore
@@ -220,16 +235,19 @@ files:
 - test/unit/adapters_base_test.rb
 - test/unit/adapters_file_store_test.rb
 - test/unit/adapters_redis_store_test.rb
+- test/unit/background_test.rb
 - test/unit/collectors_coverage_test.rb
 - test/unit/configuration_test.rb
+- test/unit/coverband_test.rb
 - test/unit/dog.rb
 - test/unit/full_stack_test.rb
 - test/unit/middleware_test.rb
+- test/unit/rack_server_checkout_test.rb
 - test/unit/reports_base_test.rb
 - test/unit/reports_console_test.rb
 - test/unit/reports_simple_cov_test.rb
 - test/unit/reports_web_test.rb
-- test/unit/utils_s3_report_writer_test.rb
+- test/unit/utils_s3_report_test.rb
 homepage: https://github.com/danmayer/coverband
 licenses:
 - MIT
@@ -245,12 +263,12 @@ 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.7.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Rack middleware to help measure production code usage (LOC runtime usage)
@@ -264,13 +282,16 @@ test_files:
 - test/unit/adapters_base_test.rb
 - test/unit/adapters_file_store_test.rb
 - test/unit/adapters_redis_store_test.rb
+- test/unit/background_test.rb
 - test/unit/collectors_coverage_test.rb
 - test/unit/configuration_test.rb
+- test/unit/coverband_test.rb
 - test/unit/dog.rb
 - test/unit/full_stack_test.rb
 - test/unit/middleware_test.rb
+- test/unit/rack_server_checkout_test.rb
 - test/unit/reports_base_test.rb
 - test/unit/reports_console_test.rb
 - test/unit/reports_simple_cov_test.rb
 - test/unit/reports_web_test.rb
-- test/unit/utils_s3_report_writer_test.rb
+- test/unit/utils_s3_report_test.rb

data/lib/coverband/utils/s3_report_writer.rb

@@ -1,59 +0,0 @@
-# frozen_string_literal: true
-
-module Coverband
-  module Utils
-    ###
-    # TODO: this is currently a html report writer
-    # this should support writing coverage the current method should be fine
-    # to write every report to S3 and sum them later or use the 2 pass
-    # method we do for redis if in a background thread
-    ###
-    class S3ReportWriter
-      def initialize(bucket_name, options = {})
-        @bucket_name = bucket_name
-        @region = options[:region]
-        @access_key_id = options[:access_key_id]
-        @secret_access_key = options[:secret_access_key]
-        begin
-          require 'aws-sdk'
-        rescue StandardError
-          err_msg = 'coverband requires aws-sdk in order use S3ReportWriter.'
-          Coverband.configuration.logger.error err_msg
-          return
-        end
-      end
-
-      def persist!
-        object.put(body: coverage_content)
-      end
-
-      private
-
-      def coverage_content
-        version = Gem::Specification.find_by_name('simplecov-html').version.version
-        File.read("#{SimpleCov.coverage_dir}/index.html").gsub("./assets/#{version}/", '')
-      rescue StandardError
-        File.read("#{SimpleCov.coverage_dir}/index.html").to_s.gsub('./assets/0.10.1/', '')
-      end
-
-      def object
-        bucket.object('coverband/index.html')
-      end
-
-      def s3
-        client_options = {
-          region: @region,
-          access_key_id: @access_key_id,
-          secret_access_key: @secret_access_key
-        }
-        resource_options = { client: Aws::S3::Client.new(client_options) }
-        resource_options = {} if client_options.values.any?(&:nil?)
-        Aws::S3::Resource.new(resource_options)
-      end
-
-      def bucket
-        s3.bucket(@bucket_name)
-      end
-    end
-  end
-end

data/test/unit/utils_s3_report_writer_test.rb

@@ -1,30 +0,0 @@
-require File.expand_path('../test_helper', File.dirname(__FILE__))
-require 'aws-sdk'
-
-module Coverband
-  class S3ReportWriterTest < Test::Unit::TestCase
-    def html_version
-      Gem::Specification.find_by_name('simplecov-html').version.version.to_s
-    rescue StandardError
-      '0.10.1'
-    end
-
-    test 'it writes the coverage report to s3' do
-      s3 = mock('s3_resource')
-      bucket = mock('bucket')
-      object = mock('object')
-      s3.expects(:bucket).with('coverage-bucket').returns(bucket)
-      bucket.expects(:object).with('coverband/index.html').returns(object)
-      File.expects(:read).at_least(0).returns("content ./assets/#{html_version}/")
-      object.expects(:put).with(body: 'content ')
-      Aws::S3::Resource.expects(:new).returns(s3)
-
-      s3_writer_options = {
-        region: 'us-west-1',
-        access_key_id: '',
-        secret_access_key: ''
-      }
-      Coverband::Utils::S3ReportWriter.new('coverage-bucket', s3_writer_options).persist!
-    end
-  end
-end