coverband 3.0.0 → 4.0.0

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/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.0'
+  VERSION = '4.0.0'
 end

data/lib/coverband.rb

@@ -2,17 +2,21 @@
 
 require 'logger'
 require 'json'
+require 'redis'
 
 require 'coverband/version'
 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/utils/railtie' if defined? ::Rails::Railtie
 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'
@@ -33,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
 
@@ -44,5 +47,13 @@ module Coverband
 
   def self.start
     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/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
@@ -166,9 +165,24 @@ namespace :benchmarks do
     report
   end
 
+  def mock_files(store)
+    ###
+    # 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
+  end
+
   def reporting_speed
     report = fake_report
     store = benchmark_redis_store
+    store.clear!
+    mock_files(store)
 
     5.times { store.save_report(report) }
     Benchmark.ips do |x|
@@ -177,6 +191,42 @@ namespace :benchmarks do
     end
   end
 
+  def measure_memory
+    require 'memory_profiler'
+    report = fake_report
+    store = benchmark_redis_store
+    store.clear!
+    mock_files(store)
+
+    # warmup
+    3.times { store.save_report(report) }
+
+    previous_out = $stdout
+    capture = StringIO.new
+    $stdout = capture
+
+    MemoryProfiler.report do
+      10.times { store.save_report(report) }
+    end.pretty_print
+    data = $stdout.string
+    $stdout = previous_out
+    raise 'leaking memory!!!' unless data.match('Total retained:  0 bytes')
+  ensure
+    $stdout = previous_out
+  end
+
+  desc 'runs memory reporting on Redis store'
+  task memory_reporting: [:setup] do
+    puts 'runs memory benchmarking to ensure we dont leak'
+    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'
@@ -198,7 +248,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 +256,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/rails4_dummy/app/controllers/dummy_controller.rb

@@ -0,0 +1,5 @@
+class DummyController < ActionController::Base
+  def show
+    render plain: "I am no dummy"
+  end
+end

data/test/rails4_dummy/config/application.rb

@@ -0,0 +1,15 @@
+require File.expand_path('../boot', __FILE__)
+
+require "rails"
+require "action_controller/railtie"
+module Rails4Dummy
+  class Application < Rails::Application
+    # Coverband needs to be setup before any of the initializers to capture usage of them
+    Coverband.configure(File.open("#{Rails.root}/config/coverband.rb"))
+    config.middleware.use Coverband::Middleware
+    config.before_initialize do
+      Coverband.start
+    end
+    config.eager_load = false
+  end
+end

data/test/rails4_dummy/config/boot.rb

@@ -0,0 +1,3 @@
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+
+require 'bundler/setup' # Set up gems listed in the Gemfile.

data/test/rails4_dummy/config/coverband.rb

@@ -0,0 +1,8 @@
+Coverband.configure do |config|
+  config.root              = Dir.pwd
+  config.store             = Coverband::Adapters::RedisStore.new(Redis.new(url: ENV['REDIS_URL'])) if defined? Redis
+  config.ignore            = %w[vendor .erb$ .slim$]
+  config.root_paths        = []
+  config.reporting_frequency = 100.0
+  config.logger              = Rails.logger
+end

data/test/rails4_dummy/config/environment.rb

@@ -0,0 +1,5 @@
+# Load the Rails application.
+require File.expand_path('../application', __FILE__)
+
+# Initialize the Rails application.
+Rails.application.initialize!

data/test/rails4_dummy/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  get 'dummy/show'
+end

data/test/rails4_dummy/config/secrets.yml

@@ -0,0 +1,3 @@
+test:
+  secret_key_base: 8080f2894307a3dcf72127c0a279a729c58c7c10c11a15de761c8e16017e0e478647d1a7ac11bf143730cac7b6901fa000428c6b4873d9298250f8ca4657b5c6
+

data/test/rails4_dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment', __FILE__)
+run Rails.application

data/test/rails5_dummy/app/controllers/dummy_controller.rb

@@ -0,0 +1,5 @@
+class DummyController < ActionController::API
+  def show
+    render plain: "I am no dummy"
+  end
+end

data/test/rails5_dummy/config/application.rb

@@ -0,0 +1,16 @@
+require "rails"
+require "action_controller/railtie"
+require 'coverband'
+
+module Dummy
+  class Application < Rails::Application
+    # Coverband needs to be setup before any of the initializers to capture usage of them
+    Coverband.configure(File.open("#{Rails.root}/config/coverband.rb"))
+    config.middleware.use Coverband::Middleware
+    config.before_initialize do
+      Coverband.start
+    end
+    config.eager_load = false
+  end
+end
+

data/test/rails5_dummy/config/coverband.rb

@@ -0,0 +1,8 @@
+Coverband.configure do |config|
+  config.root              = Dir.pwd
+  config.store             = Coverband::Adapters::RedisStore.new(Redis.new(url: ENV['REDIS_URL'])) if defined? Redis
+  config.ignore            = %w[vendor .erb$ .slim$]
+  config.root_paths        = []
+  config.reporting_frequency = 100.0
+  config.logger              = Rails.logger
+end

data/test/rails5_dummy/config/environment.rb

@@ -0,0 +1,2 @@
+require_relative 'application'
+Rails.application.initialize!

data/test/rails5_dummy/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  get 'dummy/show'
+end

data/test/rails5_dummy/config.ru

@@ -0,0 +1,3 @@
+require_relative 'config/environment'
+
+run Rails.application

data/test/rails_test_helper.rb

@@ -0,0 +1,11 @@
+# Configure Rails Environment
+ENV["RAILS_ENV"] = "test"
+require 'rails'
+require File.expand_path('./test_helper', File.dirname(__FILE__))
+
+if Rails::VERSION::MAJOR >= 5
+  require_relative "../test/rails5_dummy/config/environment"
+else
+  require_relative "../test/rails4_dummy/config/environment"
+end
+

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
@@ -59,12 +68,8 @@ end
 
 require 'coverband'
 
-Coverband.configure do |config|
-  config.root                = Dir.pwd
-  config.s3_bucket           = nil
-  config.root_paths          = ['/app_path/']
-  config.ignore              = ['vendor']
-  config.reporting_frequency = 100.0
-  config.reporter            = 'std_out'
-  config.store               = Coverband::Adapters::RedisStore.new(Redis.new)
+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,24 @@
+# frozen_string_literal: true
+
+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::Background.expects(:sleep).with(30)
+    Coverband::Background.expects(:at_exit).yields
+    Coverband::Collectors::Coverage.instance.expects(:report_coverage).twice
+    2.times { Coverband::Background.start }
+  end
+end

data/test/unit/collectors_coverage_test.rb

@@ -29,5 +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 'report_coverage raises errors in tests' do
+      @coverband.reset_instance
+      @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(:test_env).returns(false)
+      @coverband.expects(:ready_to_report?).raises('Oh no')
+      @coverband.reset_instance
+      @coverband.report_coverage
+    end
   end
 end

data/test/unit/configuration_test.rb

@@ -3,6 +3,18 @@
 require File.expand_path('../test_helper', File.dirname(__FILE__))
 
 class BaseTest < Test::Unit::TestCase
+  def setup
+    Coverband.configure do |config|
+      config.root                = Dir.pwd
+      config.s3_bucket           = nil
+      config.root_paths          = ['/app_path/']
+      config.ignore              = ['vendor']
+      config.reporting_frequency = 100.0
+      config.reporter            = 'std_out'
+      config.store               = Coverband::Adapters::RedisStore.new(Redis.new)
+    end
+  end
+
   test 'defaults ' do
     coverband = Coverband::Collectors::Coverage.instance.reset_instance
     assert_equal ['vendor', 'internal:prelude', 'schema.rb'], coverband.instance_variable_get('@ignore_patterns')