coverband 2.0.3 → 3.0.0.alpha

data/lib/coverband/utils/s3_report_writer.rb

@@ -0,0 +1,59 @@
+# 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/lib/coverband/version.rb

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

data/test/benchmarks/benchmark.rake

@@ -155,18 +155,18 @@ namespace :benchmarks do
     Benchmark.ips do |x|
       x.config(time: 12, warmup: 5, suite: suite)
       x.report 'coverband' do
-        Coverband::Collectors::Base.instance.sample do
+        Coverband::Collectors::Coverage.instance.sample do
           work
         end
       end
-      Coverband::Collectors::Base.instance.stop
+      Coverband::Collectors::Coverage.instance.stop
       x.report 'no coverband' do
         work
       end
       x.hold! 'temp_results' if hold_work
       x.compare!
     end
-    Coverband::Collectors::Base.instance.reset_instance
+    Coverband::Collectors::Coverage.instance.reset_instance
   end
 
   def fake_line_numbers

data/test/test_helper.rb

@@ -14,7 +14,7 @@ SimpleCov.start do
   add_filter '/config/'
 end
 
-TEST_COVERAGE_FILE = '/tmp/fake_file.json'
+TEST_COVERAGE_FILE = '/tmp/fake_file.json'.freeze
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
@@ -37,33 +37,34 @@ def test(name, &block)
   end
 end
 
+def example_line
+  [0, 1, 2]
+end
+
+def basic_coverage
+  { 'app_path/dog.rb' => example_line }
+end
+
 def fake_redis
   @redis ||= begin
     redis = OpenStruct.new
-    # mocha requires method to exist to mock it
-    def redis.smembers(key); end
-    def redis.hgetall(key); end
     redis
   end
 end
 
-def fake_coverband_members
-  ['/Users/danmayer/projects/hearno/script/tester.rb',
-   '/Users/danmayer/projects/hearno/app/controllers/application_controller.rb',
-   '/Users/danmayer/projects/hearno/app/models/account.rb']
-end
-
 def fake_coverage_report
-  { '/Users/danmayer/projects/hearno/script/tester.rb' => [1, nil, 1, 1, nil, nil, nil] }
+  file_name = '/Users/danmayer/projects/hearno/script/tester.rb'
+  { file_name => [1, nil, 1, 1, nil, nil, nil] }
 end
 
 require 'coverband'
 
 Coverband.configure do |config|
-  config.root              = Dir.pwd
-  config.root_paths        = ['/app/']
-  config.ignore            = ['vendor']
-  config.percentage        = 100.0
-  config.reporter          = 'std_out'
-  config.store             = Coverband::Adapters::RedisStore.new(Redis.new)
+  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

data/test/unit/adapters_base_test.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require File.expand_path('../test_helper', File.dirname(__FILE__))
+
+class AdaptersBaseTest < Test::Unit::TestCase
+  def setup
+    @test_file_path = '/tmp/coverband_filestore_test_path.json'
+    @store = Coverband::Adapters::FileStore.new(@test_file_path)
+  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] }
+    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]
+    }
+    assert_equal expected_result, @store.send(:merge_reports, new_report, old_report)
+  end
+end

data/test/unit/adapters_file_store_test.rb

@@ -28,8 +28,8 @@ class AdaptersFileStoreTest < Test::Unit::TestCase
   end
 
   def test_save_report
-    @store.save_report('cat.rb' => { 1 => 1 })
-    assert_equal @store.covered_lines_for_file('cat.rb')['1'], 1
+    @store.send(:save_report, 'cat.rb' => [0,1])
+    assert_equal @store.covered_lines_for_file('cat.rb')[1], 1
   end
 
   private

data/test/unit/adapters_redis_store_test.rb

@@ -5,42 +5,37 @@ require File.expand_path('../test_helper', File.dirname(__FILE__))
 class RedisTest < Test::Unit::TestCase
   BASE_KEY = Coverband::Adapters::RedisStore::BASE_KEY
 
-  def example_hash
-    {'1' => '1', '2' => '2'}
-  end
-
   def setup
     @redis = Redis.new
-    @redis.flushdb
     @store = Coverband::Adapters::RedisStore.new(@redis)
+    @store.clear!
   end
 
   def test_coverage
-    @redis.sadd(BASE_KEY, 'dog.rb')
-    @store.send(:pipelined_save, combined_report)
-    expected = {'dog.rb' => example_hash}
+    expected = basic_coverage
+    @store.save_report(expected)
     assert_equal expected, @store.coverage
   end
 
-  def test_covered_lines_for_file
-    @store.send(:pipelined_save, combined_report)
-    assert_equal [["1", "1"], ["2", "2"]], @store.covered_lines_for_file('dog.rb').sort
+  def test_coverage_increments
+    expected = basic_coverage
+    @store.save_report(expected)
+    assert_equal expected, @store.coverage
+    @store.save_report(expected)
+    assert_equal [0, 2, 4], @store.coverage['app_path/dog.rb']
   end
 
-  def test_covered_lines_for_file__hash
-    @redis.mapped_hmset("#{BASE_KEY}.dog.rb", '1' => 1, '2' => 2)
-    @store = Coverband::Adapters::RedisStore.new(@redis)
-    expected = [%w[1 1], %w[2 2]]
-    assert_equal expected, @store.covered_lines_for_file('dog.rb').sort
+  def test_covered_lines_for_file
+    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
-    empty_hash = {}
-    assert_equal empty_hash, @store.covered_lines_for_file('dog.rb')
+    assert_equal nil, @store.covered_lines_for_file('app_path/dog.rb')
   end
 
   def test_clear
-    @redis.expects(:smembers).with(BASE_KEY).once.returns([])
     @redis.expects(:del).with(BASE_KEY).once
     @store.clear!
   end
@@ -63,35 +58,3 @@ class RedisTest < Test::Unit::TestCase
     }
   end
 end
-
-class RedisStoreTestV3Hash < RedisTest
-  def setup
-    @redis = Redis.current.tap do |redis|
-      redis.stubs(:sadd).with(anything, anything)
-    end
-
-    @store = Coverband::Adapters::RedisStore.new(@redis)
-  end
-
-  test 'it stores the files into coverband' do
-    @redis.expects(:sadd).with(BASE_KEY, [
-                                 '/Users/danmayer/projects/cover_band_server/app.rb',
-                                 '/Users/danmayer/projects/cover_band_server/server.rb'
-                               ])
-
-    @store.save_report(test_data)
-  end
-
-  test 'it stores the file lines of the file app.rb' do
-      @redis.expects(:mapped_hmset).with(
-      "#{BASE_KEY}./Users/danmayer/projects/cover_band_server/app.rb",
-      '54' => 1, '55' => 2
-    )
-    @redis.expects(:mapped_hmset).with(
-      "#{BASE_KEY}./Users/danmayer/projects/cover_band_server/server.rb",
-      '5' => 1
-    )
-
-    @store.save_report(test_data)
-  end
-end

data/test/unit/collectors_coverage_test.rb

@@ -9,18 +9,16 @@ if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.3.0')
 
     def setup
       Coverband.configure do |config|
-        config.collector = 'coverage'
-        config.store     = Coverband::Adapters::RedisStore.new(Redis.new)
+        config.store = Coverband::Adapters::RedisStore.new(Redis.new)
       end
-      @coverband = Coverband::Collectors::Base.instance.reset_instance
+      @coverband = Coverband::Collectors::Coverage.instance.reset_instance
     end
 
     def teardown
       Thread.current[:coverband_instance] = nil
       Coverband.configure do |config|
-        config.collector = 'trace'
       end
-      @coverband = Coverband::Collectors::Base.instance.reset_instance
+      @coverband = Coverband::Collectors::Coverage.instance.reset_instance
     end
 
     test 'gets coverage instance' do
@@ -31,107 +29,5 @@ 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 'configure memory caching' do
-      Coverband.configuration.memory_caching = true
-      coverband = Coverband::Collectors::Base.instance.reset_instance
-      assert_equal Coverband::Adapters::MemoryCacheStore, coverband.instance_variable_get('@store').class
-      Coverband.configuration.memory_caching = false
-    end
-
-    test 'start should enable coverage' do
-      assert_equal false, coverband.instance_variable_get('@enabled')
-      coverband.expects(:record_coverage).once
-      coverband.start
-      assert_equal true, coverband.instance_variable_get('@enabled')
-    end
-
-    test 'stop should disable coverage' do
-      assert_equal false, coverband.instance_variable_get('@enabled')
-      coverband.expects(:record_coverage).once
-      coverband.start
-      assert_equal true, coverband.instance_variable_get('@enabled')
-      coverband.stop
-      assert_equal false, coverband.instance_variable_get('@enabled')
-    end
-
-    test 'allow for sampling with a block and enable when 100 percent sample' do
-      logger = Logger.new(STDOUT)
-      coverband.instance_variable_set('@sample_percentage', 100.0)
-      coverband.instance_variable_set('@verbose', true)
-      coverband.instance_variable_set('@logger', logger)
-      coverband.instance_variable_set('@store', nil)
-      assert_equal false, coverband.instance_variable_get('@enabled')
-      logger.stubs('info')
-      logger.expects(:debug).at_least_once
-      coverband.sample { 1 + 1 }
-      assert_equal true, coverband.instance_variable_get('@enabled')
-    end
-
-    test 'allow reporting with start stop save' do
-      logger = Logger.new(STDOUT)
-      coverband.instance_variable_set('@sample_percentage', 100.0)
-      coverband.instance_variable_set('@verbose', true)
-      coverband.instance_variable_set('@logger', logger)
-      coverband.instance_variable_set('@store', nil)
-      assert_equal false, coverband.instance_variable_get('@enabled')
-      logger.expects(:info).at_least_once
-      logger.stubs('debug')
-      coverband.start
-      logger.info(1 + 1)
-      coverband.stop
-      coverband.save
-    end
-
-    test 'allow reporting to redis start stop save' do
-      dog_file = File.expand_path('./dog.rb', File.dirname(__FILE__))
-      coverband.instance_variable_set('@sample_percentage', 100.0)
-      store = Coverband::Adapters::RedisStore.new(Redis.new)
-      coverband.instance_variable_set('@store', store)
-
-      prior = Coverage.peek_result[dog_file].dup
-      prior[4] = prior[4] + 5
-      expected = {}
-      prior.each_with_index do |count, index|
-        expected[(index + 1)] = count if count
-      end
-
-      store.expects(:save_report).once.with(has_entries(dog_file => expected))
-      assert_equal false, coverband.instance_variable_get('@enabled')
-      coverband.start
-      5.times { Dog.new.bark }
-      coverband.stop
-      coverband.save
-    end
-
-    test 'coverage should count line numbers only the new calls' do
-      dog_file = File.expand_path('./dog.rb', File.dirname(__FILE__))
-      coverband.instance_variable_set('@sample_percentage', 100.0)
-      coverband.instance_variable_set('@store', nil)
-      original_count = Coverage.peek_result[dog_file][4]
-      coverband.start
-      100.times { Dog.new.bark }
-      coverband.stop
-      coverband.save
-      assert_equal (original_count + 100), coverband.instance_variable_get('@file_line_usage')[dog_file][5]
-      50.times { Dog.new.bark }
-      coverband.save
-      assert_equal 50, coverband.instance_variable_get('@file_line_usage')[dog_file][5]
-    end
-
-    test 'coverage should count line numbers' do
-      dog_file = File.expand_path('./dog.rb', File.dirname(__FILE__))
-      coverband.instance_variable_set('@sample_percentage', 100.0)
-      coverband.instance_variable_set('@store', nil)
-      original_count = Coverage.peek_result[dog_file][4]
-      coverband.start
-      100.times { Dog.new.bark }
-      coverband.stop
-      coverband.save
-      assert_equal (original_count + 100), coverband.instance_variable_get('@file_line_usage')[dog_file][5]
-    end
-
-    test 'sample should return the result of the block' do
-      assert_equal 2, coverband.sample { 1 + 1 }
-    end
   end
 end

data/test/unit/configuration_test.rb

@@ -3,15 +3,8 @@
 require File.expand_path('../test_helper', File.dirname(__FILE__))
 
 class BaseTest < Test::Unit::TestCase
-  test 'defaults to ignore gems' do
-    assert_equal Coverband.configuration.include_gems, false
-    coverband = Coverband::Collectors::Base.instance.reset_instance
-    assert_equal ['vendor', 'internal:prelude', 'schema.rb', 'gems'], coverband.instance_variable_get('@ignore_patterns')
-  end
-
-  test "doesn't ignore gems if include_gems = true" do
-    Coverband.configuration.include_gems = true
-    coverband = Coverband::Collectors::Base.instance.reset_instance
+  test 'defaults ' do
+    coverband = Coverband::Collectors::Coverage.instance.reset_instance
     assert_equal ['vendor', 'internal:prelude', 'schema.rb'], coverband.instance_variable_get('@ignore_patterns')
   end
 end

data/test/unit/full_stack_test.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require File.expand_path('../test_helper', File.dirname(__FILE__))
+require 'rack'
+
+class FullStackTest < Test::Unit::TestCase
+  BASE_KEY = Coverband::Adapters::RedisStore::BASE_KEY
+  TEST_RACK_APP = '../fake_app/basic_rack.rb'.freeze
+
+  def setup
+    Coverband::Collectors::Coverage.instance.reset_instance
+    Coverband.configure do |config|
+      config.reporting_frequency = 100.0
+      config.store = Coverband::Adapters::RedisStore.new(Redis.new)
+      config.s3_bucket = nil
+    end
+    Coverband.configuration.store.clear!
+    Coverband.start
+    @rack_file = File.expand_path(TEST_RACK_APP, File.dirname(__FILE__))
+    require @rack_file
+  end
+
+  test 'call app' do
+    request = Rack::MockRequest.env_for('/anything.json')
+    middleware = Coverband::Middleware.new(fake_app_with_lines)
+    results = middleware.call(request)
+    assert_equal 'Hello Rack!', results.last
+    expected = [nil, nil, 1, nil, 1, 1, 1, nil, nil]
+    assert_equal expected, Coverband.configuration.store.coverage[@rack_file]
+
+    # additional calls increase count by 1
+    middleware.call(request)
+    expected = [nil, nil, 1, nil, 1, 1, 2, nil, nil]
+    assert_equal expected, Coverband.configuration.store.coverage[@rack_file]
+
+    expected = nil
+    # TODO: read the html to test it matches expectations? or return data as a hash?
+    actual = Coverband::Reporters::SimpleCovReport.report(Coverband.configuration.store, open_report: false)
+    assert_equal expected, actual
+  end
+
+  private
+
+  def fake_app_with_lines
+    @fake_app_with_lines ||= ::HelloWorld.new
+  end
+end