coverband 3.0.1 → 4.0.0.alpha

data/changes.md

@@ -23,30 +23,20 @@ Will be the fully modern release that drops maintenance legacy support in favor
 - Support for file versions
   - md5 or release tags
   - add coverage timerange support
-- Drop Simplecov dependency 
-
-### Coverband 3.X
-
-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
-- drop anything below Ruby 2.3
-- release begins to simplify ease of use
-  - drop collectors adapter
-  - reduced configuration options
+- Drop Simplecov dependency
 - improved web reporting
   - no longer relying directly on HTML in S3 but dynamically generated from any adapter
   - lists current config options
   - eventually allow updating remote config
   - full theming
-  - list redis data dump for debugging
+  - list redis data dump for debugging 
 - additional adapters: Memcache, S3, and ActiveRecord
-- 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 detailed Gem usage report, if we collect and send gem usage we can give percentage of gem code used, which should help application developers know when to remove gem dependencies (0%) or perhaps inline single methods for little usage (using <= 5%) for example.
+- add additional config / protection options on Coverage clear
 - 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  
+   - more details in this issue: https://github.com/danmayer/coverband/issues/118 
+- Make good video on setup, install, usage 
 
 ### Coverband_jam_session
 
@@ -68,15 +58,36 @@ Feature Ideas:
 - tagging of reported Coverage
 - allow only to collect coverage based on route (limiting or scoped coverage)
 - coverage over some other variable like a set of alpha users
+- document how to use this on staging / selenium test suite runs
+   - possible add API to pull report at end of run 
 
 # Alpha
 
-### Coverband ???
+### Coverband 4.0.0
 
 * Add support for Railties integration
+* Reduce configuration options
+* Default to background reporting vs middleware reporting
+* Resolves issue requiring submitting initial coverage data pre-fork
+* Simplified setup with just works sensible defaults for configuration out of the box
+* Fixes on the pilot release of background reporting in 3.0.1
+* Rake tasks automatically configured
+* Updated and simplified documentation
 
 # Released
 
+### Coverband 3.X
+
+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
+- drop anything below Ruby 2.3
+- release begins to simplify ease of use
+  - drop collectors adapter
+  - reduced configuration options
+- add memory benchmarks showing memory overhead of coverband
+- use full stack tests to prove no memory leaks when used in Rails 
+
 ### Coverband 3.0.1
 
 * update documentation around verification steps (https://github.com/danmayer/coverband/issues/135), thanks @kbaum

data/coverband.gemspec

@@ -25,14 +25,13 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'aws-sdk', '~> 2'
   spec.add_development_dependency 'benchmark-ips'
   spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'm'
+  spec.add_development_dependency 'memory_profiler'
   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 'redis'
   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'
@@ -40,6 +39,12 @@ Gem::Specification.new do |spec|
   # require 'byebug'; byebug
   spec.add_development_dependency 'pry-byebug'
 
+  # TODO: Remove when other production adapters exist
+  # because the default configuration of redis store, we really do require
+  # redis now. I was reluctant to add this, but until we offer another production
+  # quality adapter, I think this is more honest about requirements and reduces confusion
+  # without this there was a race condition on calling coverband configure before redis was loaded
+  spec.add_runtime_dependency 'redis'
   # 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

data/lib/coverband.rb

@@ -2,6 +2,7 @@
 
 require 'logger'
 require 'json'
+require 'redis'
 
 require 'coverband/version'
 require 'coverband/configuration'
@@ -9,6 +10,7 @@ require 'coverband/adapters/base'
 require 'coverband/adapters/redis_store'
 require 'coverband/adapters/file_store'
 require 'coverband/utils/s3_report'
+require 'coverband/utils/railtie' if defined? ::Rails::Railtie
 require 'coverband/collectors/coverage'
 require 'coverband/reporters/base'
 require 'coverband/reporters/simple_cov_report'
@@ -35,8 +37,7 @@ module Coverband
     elsif File.exist?(configuration_file)
       require configuration_file
     else
-      msg = "configure requires a block, #{CONFIG_FILE} in project, or file path passed in configure"
-      raise ArgumentError, msg
+      configuration.logger&.debug('using default configuration')
     end
   end
 
@@ -48,4 +49,11 @@ module Coverband
     Coverband::Collectors::Coverage.instance
     Background.start if configuration.background_reporting_enabled && !RackServerCheck.running?
   end
+
+  unless ENV['COVERBAND_DISABLE_AUTO_START']
+    # Coverband should be setup as early as possible
+    # to capture usage of things loaded by initializers or other Rails engines
+    configure
+    start
+  end
 end

data/lib/coverband/collectors/coverage.rb

@@ -17,7 +17,6 @@ module Coverband
       def reset_instance
         @project_directory = File.expand_path(Coverband.configuration.root)
         @file_line_usage = {}
-        @ignored_files = Set.new
         @ignore_patterns = Coverband.configuration.ignore + ['internal:prelude', 'schema.rb']
         @reporting_frequency = Coverband.configuration.reporting_frequency
         @store = Coverband.configuration.store
@@ -25,19 +24,15 @@ module Coverband
         @logger   = Coverband.configuration.logger
         @current_thread = Thread.current
         @test_env = Coverband.configuration.test_env
-        @background_reporting_enabled = Coverband.configuration.background_reporting_enabled
+        @@previous_results = nil
         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
+        raise 'no Coverband store set' unless @store
 
-        unless @store
-          @logger.debug 'no store set, no-op'
-          return
-        end
         new_results = get_new_coverage_results
         add_filtered_files(new_results)
         @store.save_report(files_with_line_usage)
@@ -63,7 +58,6 @@ module Coverband
 
       def add_filtered_files(new_results)
         new_results.each_pair do |file, line_counts|
-          next if @ignored_files.include?(file)
           next unless track_file?(file)
           add_file(file, line_counts)
         end
@@ -74,14 +68,12 @@ module Coverband
       end
 
       def get_new_coverage_results
-        coverage_results = nil
-        @semaphore.synchronize { coverage_results = new_coverage(::Coverage.peek_result.dup) }
-        coverage_results
+        @semaphore.synchronize { new_coverage(::Coverage.peek_result.dup) }
       end
 
       def files_with_line_usage
         @file_line_usage.select do |_file_name, coverage|
-          coverage.any? { |value| value && value.nonzero? }
+          coverage.any? { |value| value&.nonzero? }
         end
       end
 

data/lib/coverband/configuration.rb

@@ -2,10 +2,9 @@
 
 module Coverband
   class Configuration
-    attr_accessor :redis, :root_paths, :root,
+    attr_accessor :root_paths, :root,
                   :ignore, :additional_files, :verbose,
                   :reporter, :reporting_frequency,
-                  :disable_on_failure_for,
                   :redis_namespace, :redis_ttl,
                   :safe_reload_files, :background_reporting_enabled,
                   :background_reporting_sleep_seconds, :test_env
@@ -15,13 +14,16 @@ module Coverband
     def initialize
       @root = Dir.pwd
       @root_paths = []
-      @ignore = []
+      @ignore = %w(vendor .erb$ .slim$)
       @additional_files = []
       @reporting_frequency = 0.0
       @verbose = false
       @reporter = 'scov'
-      @logger = Logger.new(STDOUT)
+      @logger = nil
       @store = nil
+      @background_reporting_enabled = true
+      @background_reporting_sleep_seconds = 30
+      @test_env = nil
 
       # TODO: should we push these to adapter configs
       @s3_region = nil
@@ -30,12 +32,14 @@ module Coverband
       @s3_secret_access_key = nil
       @redis_namespace = nil
       @redis_ttl = nil
-      @test_env = nil
-      @background_reporting_sleep_seconds = 30
     end
 
     def logger
-      @logger ||= Logger.new(STDOUT)
+      @logger ||= if defined?(Rails)
+                    Rails.logger
+                  else
+                    Logger.new(STDOUT)
+                  end
     end
 
     def s3_bucket
@@ -55,19 +59,26 @@ module Coverband
     end
 
     def store
-      return @store if @store
-      raise 'no valid store configured'
+      @store ||= Coverband::Adapters::RedisStore.new(Redis.new(url: redis_url), redis_store_options)
     end
 
     def store=(store)
       if store.is_a?(Coverband::Adapters::Base)
         @store = store
-      elsif defined?(Redis) && redis && redis.is_a?(Redis)
-        @store = Coverband::Adapters::RedisStore.new(redis, ttl: Coverband.configuration.redis_ttl,
-                                                            redis_namespace: Coverband.configuration.redis_namespace)
-      elsif store.is_a?(String)
-        @store = Coverband::Adapters::FileStore.new(store)
+      else
+        raise 'please pass in an subclass of Coverband::Adapters for supported stores'
       end
     end
+
+    private
+
+    def redis_url
+      ENV['COVERBAND_REDIS_URL'] || ENV['REDIS_URL']
+    end
+
+    def redis_store_options
+      { ttl: Coverband.configuration.redis_ttl,
+        redis_namespace: Coverband.configuration.redis_namespace }
+    end
   end
 end

data/lib/coverband/integrations/background.rb

@@ -10,20 +10,21 @@ module Coverband
       logger = Coverband.configuration.logger
       @semaphore.synchronize do
         return if @background_reporting_running
+        logger&.debug('Starting background reporting')
 
         @background_reporting_running = true
         sleep_seconds = Coverband.configuration.background_reporting_sleep_seconds
         Thread.new do
           loop do
-            Coverband::Collectors::Coverage.instance.report_coverage
+            Coverband::Collectors::Coverage.instance.report_coverage(true)
             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")
+          Coverband::Collectors::Coverage.instance.report_coverage(true)
+          logger&.debug('Reported coverage before exit')
         end
       end
     end

data/lib/coverband/integrations/middleware.rb

@@ -9,7 +9,11 @@ module Coverband
     def call(env)
       @app.call(env)
     ensure
-      Coverband::Collectors::Coverage.instance.report_coverage
+      if Coverband.configuration.background_reporting_enabled
+        Coverband::Background.start
+      else
+        Coverband::Collectors::Coverage.instance.report_coverage
+      end
     end
   end
 end

data/lib/coverband/reporters/web.rb

@@ -93,7 +93,7 @@ module Coverband
       end
 
       def collect_coverage
-        Coverband::Collectors::Coverage.instance.report_coverage
+        Coverband::Collectors::Coverage.instance.report_coverage(true)
         notice = 'coverband coverage collected'
         [301, { 'Location' => "#{base_path}?notice=#{notice}" }, []]
       end

data/lib/coverband/utils/railtie.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Coverband
+  class Railtie < Rails::Railtie
+    initializer 'coverband.configure' do |app|
+      app.middleware.use Coverband::Middleware
+    end
+
+    config.after_initialize do
+      Coverband::Collectors::Coverage.instance.report_coverage(true)
+    end
+
+    rake_tasks do
+      load 'coverband/utils/tasks.rb'
+    end
+  end
+end

data/lib/coverband/utils/tasks.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
 
 namespace :coverband do
+  Coverband.configure
+
   ###
-  # note: If your project has set many simplecov filters.
+  # NOTE: If your project has set many simplecov filters.
   # You might want to override them and clear the filters.
   # Or run the task `coverage_no_filters` below.
   ###
-  desc 'report runtime coverband code coverage'
+  desc 'report runtime Coverband code coverage'
   task coverage: :environment do
     if Coverband.configuration.reporter == 'scov'
       Coverband::Reporters::SimpleCovReport.report(Coverband.configuration.store)
@@ -30,11 +32,9 @@ namespace :coverband do
   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 coverband store data.
+  # clear data helpful for development or after configuration issues
   ###
-  desc 'reset coverband coverage data'
+  desc 'reset Coverband coverage data, helpful for development, debugging, etc'
   task clear: :environment do
     Coverband.configuration.store.clear!
   end

data/lib/coverband/version.rb

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

data/test/benchmarks/benchmark.rake

@@ -78,7 +78,6 @@ namespace :benchmarks do
   # desc 'set up coverband with Redis'
   task :setup_redis do
     Coverband.configure do |config|
-      config.redis               = Redis.new
       config.root                = Dir.pwd
       config.reporting_frequency = 100.0
       config.logger              = $stdout
@@ -222,6 +221,12 @@ namespace :benchmarks do
     measure_memory
   end
 
+  desc 'runs memory leak check via Rails tests'
+  task memory_rails: [:setup] do
+    puts 'runs memory rails test to ensure we dont leak'
+    puts `COVERBAND_MEMORY_TEST=true bundle exec m test/unit/rails_full_stack_test.rb:22`
+  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'

data/test/unit/background_test.rb

@@ -3,14 +3,22 @@
 require File.expand_path('../test_helper', File.dirname(__FILE__))
 
 class BackgroundTest < Test::Unit::TestCase
+  def setup
+    Coverband::Collectors::Coverage.instance.reset_instance
+    Coverband.configure do |config|
+      config.store = Coverband::Adapters::RedisStore.new(Redis.new)
+      config.background_reporting_enabled = true
+    end
+    Coverband::Background.instance_variable_set(:@background_reporting_running, nil)
+  end
+
   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)
+    Coverband::Collectors::Coverage.instance.expects(:report_coverage).twice
     2.times { Coverband::Background.start }
   end
 end
-

data/test/unit/collectors_coverage_test.rb

@@ -29,29 +29,19 @@ 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")
+      @coverband.expects(:ready_to_report?).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.expects(:ready_to_report?).raises('Oh no')
       @coverband.reset_instance
-      Coverband::Background.expects(:start).raises("Oh no")
       @coverband.report_coverage
     end
-
   end
 end