coverband 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: c2b0fe96cfa4c9cfd336166b498bdbbba7d297265b5a7883d423b1b19d4738ad
-  data.tar.gz: 31b7d38ea823730d3855fa2203da308adc862c2c8320b756c10671873f6b016e
+SHA1:
+  metadata.gz: 6e6e4e2aa7c0271b100b0ce9dc5740719a85b6be
+  data.tar.gz: 4be906bc977953bcba78c7d2bcf11f288fa21d15
 SHA512:
-  metadata.gz: 1ec633dcb00294b67974c083853cdb28148ce93fc68783aaab87fe2c343a00b880c3f5b653573cca147ce3eb2e0a1aa2933ed3629d157284fc34873838971918
-  data.tar.gz: 5f58cce89174ca835edcbc53ce9a30a53facc276ad7ae290510380c133e640abe899087132ceff408c959fa4be5f119e8d4bb2c31b3da2b2e66b72dfae62f931
+  metadata.gz: f60a464c8df70d9663ae550ce40e85a3d3c72dc3e32fc27f5ea64af405b57b7354aec420b78cd83a3e60fe018cecd9b80d8f0ae26424a44b90a97f294a488345
+  data.tar.gz: fee9a14503b7009ac42025df790d1c70ab78a33e79eb89bf18349ec25db1213ae6730036f866e1211cb9d4f652fda29becfacf18b0bf82052bc9834328af2056

data/.gitignore

@@ -18,4 +18,5 @@ test/tmp
 test/version_tmp
 tmp
 .byebug_history
-.env
+.env
+log/

data/.travis.yml

@@ -3,6 +3,9 @@ rvm:
   - "2.3"
   - "2.4"
   - "2.5"
+gemfile:
+  - Gemfile
+  - Gemfile.rails4
 services:
   - redis-server
 before_install:

data/Gemfile

@@ -4,3 +4,4 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in coverband.gemspec
 gemspec
+gem 'rails', '~>5'

data/Gemfile.rails4

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in coverband.gemspec
+gemspec
+gem 'rails', '~>4'

data/Gemfile.rails4.lock

@@ -0,0 +1,164 @@
+PATH
+  remote: .
+  specs:
+    coverband (3.0.1.alpha)
+      simplecov (> 0.11.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionmailer (4.2.10)
+      actionpack (= 4.2.10)
+      actionview (= 4.2.10)
+      activejob (= 4.2.10)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+    actionpack (4.2.10)
+      actionview (= 4.2.10)
+      activesupport (= 4.2.10)
+      rack (~> 1.6)
+      rack-test (~> 0.6.2)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (4.2.10)
+      activesupport (= 4.2.10)
+      builder (~> 3.1)
+      erubis (~> 2.7.0)
+      rails-dom-testing (~> 1.0, >= 1.0.5)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activejob (4.2.10)
+      activesupport (= 4.2.10)
+      globalid (>= 0.3.0)
+    activemodel (4.2.10)
+      activesupport (= 4.2.10)
+      builder (~> 3.1)
+    activerecord (4.2.10)
+      activemodel (= 4.2.10)
+      activesupport (= 4.2.10)
+      arel (~> 6.0)
+    activesupport (4.2.10)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      thread_safe (~> 0.3, >= 0.3.4)
+      tzinfo (~> 1.1)
+    arel (6.0.4)
+    aws-sdk (2.11.174)
+      aws-sdk-resources (= 2.11.174)
+    aws-sdk-core (2.11.174)
+      aws-sigv4 (~> 1.0)
+      jmespath (~> 1.0)
+    aws-sdk-resources (2.11.174)
+      aws-sdk-core (= 2.11.174)
+    aws-sigv4 (1.0.3)
+    benchmark-ips (2.7.2)
+    builder (3.2.3)
+    byebug (10.0.2)
+    classifier-reborn (2.2.0)
+      fast-stemmer (~> 1.0)
+    coderay (1.1.2)
+    concurrent-ruby (1.1.3)
+    crass (1.0.4)
+    docile (1.3.1)
+    erubis (2.7.0)
+    fast-stemmer (1.0.2)
+    globalid (0.4.1)
+      activesupport (>= 4.2.0)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    jmespath (1.4.0)
+    json (2.1.0)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    m (1.5.1)
+      method_source (>= 0.6.7)
+      rake (>= 0.9.2.2)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    memory_profiler (0.9.12)
+    metaclass (0.0.4)
+    method_source (0.9.2)
+    mini_mime (1.0.1)
+    mini_portile2 (2.3.0)
+    minitest (5.11.3)
+    mocha (0.14.0)
+      metaclass (~> 0.0.1)
+    nokogiri (1.8.5)
+      mini_portile2 (~> 2.3.0)
+    power_assert (1.1.3)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    pry-byebug (3.6.0)
+      byebug (~> 10.0)
+      pry (~> 0.10)
+    rack (1.6.11)
+    rack-test (0.6.3)
+      rack (>= 1.0)
+    rails (4.2.10)
+      actionmailer (= 4.2.10)
+      actionpack (= 4.2.10)
+      actionview (= 4.2.10)
+      activejob (= 4.2.10)
+      activemodel (= 4.2.10)
+      activerecord (= 4.2.10)
+      activesupport (= 4.2.10)
+      bundler (>= 1.3.0, < 2.0)
+      railties (= 4.2.10)
+      sprockets-rails
+    rails-deprecated_sanitizer (1.0.3)
+      activesupport (>= 4.2.0.alpha)
+    rails-dom-testing (1.0.9)
+      activesupport (>= 4.2.0, < 5.0)
+      nokogiri (~> 1.6)
+      rails-deprecated_sanitizer (>= 1.0.1)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    railties (4.2.10)
+      actionpack (= 4.2.10)
+      activesupport (= 4.2.10)
+      rake (>= 0.8.7)
+      thor (>= 0.18.1, < 2.0)
+    rake (12.3.1)
+    redis (4.0.3)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sprockets (3.7.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.1)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    test-unit (3.2.8)
+      power_assert
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aws-sdk (~> 2)
+  benchmark-ips
+  bundler (~> 1.3)
+  classifier-reborn
+  coverband!
+  m
+  memory_profiler
+  mocha (~> 0.14.0)
+  pry-byebug
+  rack
+  rack-test
+  rails (~> 4)
+  rake
+  redis
+  test-unit
+
+BUNDLED WITH
+   1.16.2

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
@@ -469,21 +470,20 @@ end
 
 # protect with http basic auth
 # curl --user foo:bar http://localhost:3000/coverage
-basic_constraint = lambda do |request|
-  return true if Rails.env.development?
-  if ActionController::HttpAuthentication::Basic.has_basic_credentials?(request)
-    credentials = ActionController::HttpAuthentication::Basic.decode_credentials(request)
-    email, password = credentials.split(':')
-
-    email == 'foo' && password = 'bar'
-  end
-end
-
 Rails.application.routes.draw do
   # ... lots of routes
-  constraints basic_constraint do
-    mount Coverband::Reporters::Web.new, at: '/coverage'
+
+  # Create a Rack wrapper around the Coverband Web Reporter to support & prompt the user for basic authentication.
+  AuthenticatedCoverband = Rack::Builder.new do 
+    use Rack::Auth::Basic do |username, password|
+      username == 'foo' && password == 'bar'
+    end
+
+    run Coverband::Reporters::Web.new 
   end
+
+  # Connect the wrapper app to your desired endpoint.
+  mount AuthenticatedCoverband, at: '/coverage'
 end
 ```
 
@@ -526,7 +526,9 @@ If you are working on adding features, PRs, or bugfixes to Coverband this sectio
 
 If you submit a change please make sure the tests and benchmarks are passing.
 
-* run tests: `rake`
+* run tests: 
+   * `bundle exec rake` 
+   * `BUNDLE_GEMFILE=Gemfile.rails4 bundle exec rake` (Same tests using rails 4 instead of 5)
 * view test coverage: `open coverage/index.html`
 * run the benchmarks before and after your change to see impact
    * `rake benchmarks` 

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,9 @@ 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
+- use full stack tests to prove no memory leaks when used in Rails  
 
 ### Coverband_jam_session
 
@@ -68,13 +71,23 @@ Feature Ideas:
 
 # Alpha
 
-### Coverband 3.0.1
-
-* ??? ;)
+### Coverband ???
 
+* Add support for Railties integration
 
 # Released
 
+### 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
+* adds memory test ensuring no memory leaks
+* full stack Rails tests for Rails 4 and 5 thanks @kbaum
+
 ### Coverband 3.0.0
 
 * drops Tracepoint

data/coverband.gemspec

@@ -19,22 +19,29 @@ 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'
+  spec.add_development_dependency 'memory_profiler'
+
   # 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/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