coverband 3.0.0 → 4.0.0

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/full_stack_test.rb

@@ -5,7 +5,7 @@ require 'rack'
 
 class FullStackTest < Test::Unit::TestCase
   BASE_KEY = Coverband::Adapters::RedisStore::BASE_KEY
-  TEST_RACK_APP = '../fake_app/basic_rack.rb'.freeze
+  TEST_RACK_APP = '../fake_app/basic_rack.rb'
 
   def setup
     Coverband::Collectors::Coverage.instance.reset_instance
@@ -13,6 +13,7 @@ class FullStackTest < Test::Unit::TestCase
       config.reporting_frequency = 100.0
       config.store = Coverband::Adapters::RedisStore.new(Redis.new)
       config.s3_bucket = nil
+      config.background_reporting_enabled = false
     end
     Coverband.configuration.store.clear!
     Coverband.start

data/test/unit/middleware_test.rb

@@ -9,6 +9,7 @@ class MiddlewareTest < Test::Unit::TestCase
   def setup
     Coverband.configure do |config|
       config.store = Coverband::Adapters::RedisStore.new(Redis.new)
+      config.background_reporting_enabled = false
     end
   end
 
@@ -27,6 +28,24 @@ class MiddlewareTest < Test::Unit::TestCase
     app.call(env)
   end
 
+  test 'starts background reporter when configured' do
+    request = Rack::MockRequest.env_for('/anything.json')
+    Coverband.configuration.stubs(:background_reporting_enabled).returns(true)
+    Coverband::Collectors::Coverage.instance.expects(:report_coverage).never
+    Coverband::Background.expects(:start)
+    middleware = Coverband::Middleware.new(fake_app)
+    middleware.call(request)
+  end
+
+  test 'reports coverage when not set to background mode' do
+    request = Rack::MockRequest.env_for('/anything.json')
+    Coverband.configuration.stubs(:background_reporting_enabled).returns(false)
+    Coverband::Collectors::Coverage.instance.expects(:report_coverage)
+    Coverband::Background.expects(:start).never
+    middleware = Coverband::Middleware.new(fake_app)
+    middleware.call(request)
+  end
+
   test 'never be report coverage with reporting_frequency of 0' do
     request = Rack::MockRequest.env_for('/anything.json')
     Coverband::Collectors::Coverage.instance.reset_instance

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/rails_full_stack_test.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+require File.expand_path('../rails_test_helper', File.dirname(__FILE__))
+
+class RailsFullStackTest < ActionDispatch::IntegrationTest
+  def setup
+    Coverband.configuration.store.clear!
+  end
+
+  test 'this is how we do it' do
+    get '/dummy/show'
+    assert_response :success
+    assert_equal 'I am no dummy', response.body
+    assert_equal [1, 1, 1, nil, nil], Coverband.configuration.store.coverage["#{Rails.root}/app/controllers/dummy_controller.rb"]
+  end
+
+  ###
+  # Please keep this test starting on line 22
+  # as we run it in single test mode via the benchmarks.
+  # Add new tests below this test
+  ###
+  test 'memory usage' do
+    return unless ENV['COVERBAND_MEMORY_TEST']
+    # we don't want this to run during our standard test suite
+    # as the below profiler changes the runtime
+    # and shold only be included for isolated processes
+    begin
+      require 'memory_profiler'
+
+      # warmup
+      3.times do
+        get '/dummy/show'
+        assert_response :success
+        Coverband::Collectors::Coverage.instance.report_coverage(true)
+      end
+
+      previous_out = $stdout
+      capture = StringIO.new
+      $stdout = capture
+
+      MemoryProfiler.report do
+        15.times do
+          get '/dummy/show'
+          assert_response :success
+          Coverband::Collectors::Coverage.instance.report_coverage(true)
+          # this is expected to retain memory across requests
+          # clear it to remove the false positive from test
+          Coverband::Collectors::Coverage.instance.send(:add_previous_results, nil)
+        end
+      end.pretty_print
+      data = $stdout.string
+      $stdout = previous_out
+      if data.match(/retained objects by gem(.*)retained objects by file/m)[0]&.match(/coverband/)
+        raise 'leaking memory!!!'
+      end
+    ensure
+      $stdout = previous_out
+    end
+  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: 4.0.0
 platform: ruby
 authors:
 - Dan Mayer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-04 00:00:00.000000000 Z
+date: 2018-12-05 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
@@ -39,21 +53,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: mocha
+  name: m
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rack
+  name: memory_profiler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +81,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rack-test
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rack-test
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: test-unit
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +137,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 +151,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: benchmark-ips
+  name: classifier-reborn
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,7 +165,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: classifier-reborn
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -151,13 +179,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: byebug
+  name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -189,6 +217,8 @@ files:
 - ".rubocop.yml"
 - ".travis.yml"
 - Gemfile
+- Gemfile.rails4
+- Gemfile.rails4.lock
 - LICENSE
 - LICENSE.txt
 - README.md
@@ -204,11 +234,13 @@ 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/railtie.rb
+- lib/coverband/utils/s3_report.rb
 - lib/coverband/utils/tasks.rb
 - lib/coverband/version.rb
 - test/benchmarks/.gitignore
@@ -216,20 +248,39 @@ files:
 - test/benchmarks/dog.rb
 - test/benchmarks/graph_bench.sh
 - test/fake_app/basic_rack.rb
+- test/rails4_dummy/app/controllers/dummy_controller.rb
+- test/rails4_dummy/config.ru
+- test/rails4_dummy/config/application.rb
+- test/rails4_dummy/config/boot.rb
+- test/rails4_dummy/config/coverband.rb
+- test/rails4_dummy/config/environment.rb
+- test/rails4_dummy/config/routes.rb
+- test/rails4_dummy/config/secrets.yml
+- test/rails5_dummy/app/controllers/dummy_controller.rb
+- test/rails5_dummy/config.ru
+- test/rails5_dummy/config/application.rb
+- test/rails5_dummy/config/coverband.rb
+- test/rails5_dummy/config/environment.rb
+- test/rails5_dummy/config/routes.rb
+- test/rails_test_helper.rb
 - test/test_helper.rb
 - 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/rails_full_stack_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
@@ -260,17 +311,36 @@ test_files:
 - test/benchmarks/dog.rb
 - test/benchmarks/graph_bench.sh
 - test/fake_app/basic_rack.rb
+- test/rails4_dummy/app/controllers/dummy_controller.rb
+- test/rails4_dummy/config.ru
+- test/rails4_dummy/config/application.rb
+- test/rails4_dummy/config/boot.rb
+- test/rails4_dummy/config/coverband.rb
+- test/rails4_dummy/config/environment.rb
+- test/rails4_dummy/config/routes.rb
+- test/rails4_dummy/config/secrets.yml
+- test/rails5_dummy/app/controllers/dummy_controller.rb
+- test/rails5_dummy/config.ru
+- test/rails5_dummy/config/application.rb
+- test/rails5_dummy/config/coverband.rb
+- test/rails5_dummy/config/environment.rb
+- test/rails5_dummy/config/routes.rb
+- test/rails_test_helper.rb
 - test/test_helper.rb
 - 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/rails_full_stack_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