coverband 4.1.1 → 4.2.0.alpha

data/lib/coverband/integrations/background.rb

@@ -5,7 +5,6 @@ module Coverband
     @semaphore = Mutex.new
 
     def self.stop
-      return unless @thread
       @semaphore.synchronize do
         if @thread
           @thread.exit
@@ -14,10 +13,6 @@ module Coverband
       end
     end
 
-    def self.running?
-      !!@thread
-    end
-
     def self.start
       return if @thread
 
@@ -28,7 +23,7 @@ module Coverband
         sleep_seconds = Coverband.configuration.background_reporting_sleep_seconds
         @thread = Thread.new do
           loop do
-            Coverband.report_coverage(true)
+            Coverband::Collectors::Coverage.instance.report_coverage(true)
             logger&.debug("Coverband: Reported coverage via thread. Sleeping #{sleep_seconds}s") if Coverband.configuration.verbose
             sleep(sleep_seconds)
           end

data/lib/coverband/integrations/resque.rb

@@ -4,20 +4,15 @@ Resque.after_fork do |job|
   Coverband.start
 end
 
-Resque.before_first_fork do
-  Coverband.configuration.background_reporting_enabled = false
-  Coverband::Background.stop
-  Coverband::Collectors::Coverage.instance.report_coverage(true)
-end
-
 module Coverband
   module ResqueWorker
     def perform
       super
     ensure
-      Coverband.report_coverage(true)
+      Coverband::Collectors::Coverage.instance.report_coverage(true)
     end
   end
 end
 
 Resque::Job.prepend(Coverband::ResqueWorker)
+

data/lib/coverband/reporters/base.rb

@@ -8,10 +8,8 @@ module Coverband
     ###
     class Base
       class << self
-        include Coverband::Utils::FilePathHelper
         def report(store, _options = {})
-          all_roots = Coverband.configuration.all_root_paths
-          scov_style_report = get_current_scov_data_imp(store, all_roots)
+          scov_style_report = get_current_scov_data_imp(store, root_paths)
 
           if Coverband.configuration.verbose
             msg = "report:\n #{scov_style_report.inspect}"
@@ -22,6 +20,17 @@ module Coverband
 
         protected
 
+        def root_paths
+          roots = Coverband.configuration.root_paths
+          roots += Coverband.configuration.gem_paths if Coverband.configuration.track_gems
+          roots << "#{current_root}/"
+          roots
+        end
+
+        def current_root
+          File.expand_path(Coverband.configuration.root)
+        end
+
         def fix_file_names(report_hash, roots)
           if Coverband.configuration.verbose
             Coverband.configuration.logger.info "fixing root: #{roots.join(', ')}"
@@ -29,11 +38,9 @@ module Coverband
 
           # normalize names across servers
           report_hash.each_with_object({}) do |(key, vals), fixed_report|
-            filename = relative_path_to_full(key, roots)
-            fixed_report[filename] = if fixed_report.key?(filename) && fixed_report[filename]['data'] && vals['data']
-                                       merged_data = merge_arrays(fixed_report[filename]['data'], vals['data'])
-                                       vals['data'] = merged_data
-                                       vals
+            filename = filename_from_key(key, roots)
+            fixed_report[filename] = if fixed_report.key?(filename)
+                                       merge_arrays(fixed_report[filename], vals)
                                      else
                                        vals
                                      end
@@ -55,10 +62,33 @@ module Coverband
           merged
         end
 
+        ###
+        # This method is responsible for finding the CURRENT LOCAL
+        # filename regardless of the paths being different on
+        # various servers or deployments
+        ###
+        def filename_from_key(key, roots)
+          relative_filename = key
+          local_filename = relative_filename
+          roots.each do |root|
+            relative_filename = relative_filename.gsub(/^#{root}/, './')
+          end
+          # the filename for our reports is expected to be a full path.
+          # roots.last should be roots << current_root}/
+          # a fully expanded path of config.root
+          # filename = filename.gsub('./', roots.last)
+          # above only works for app files
+          # we need to rethink some of this logic
+          # gems aren't at project root and can have multiple locations
+          local_root = roots.find { |root| File.exist?(relative_filename.gsub('./', root)) }
+          local_root ? relative_filename.gsub('./', local_root) : local_filename
+        end
+
         ###
         # why do we need to merge covered files data?
         # basically because paths on machines or deployed hosts could be different, so
         # two different keys could point to the same filename or `line_key`
+        # this logic should be pushed to base report
         # TODO: think we are filtering based on ignore while sending to the store
         # and as we also pull it out here
         ###

data/lib/coverband/reporters/html_report.rb

@@ -11,7 +11,7 @@ module Coverband
         base_path = options.fetch(:base_path) { nil }
 
         # list all files, even if not tracked by Coverband (0% coverage)
-        tracked_glob = "#{Coverband.configuration.current_root}/{app,lib,config}/**/*.{rb}"
+        tracked_glob = "#{current_root}/{app,lib,config}/**/*.{rb}"
         report_files = Coverband::Utils::Result.add_not_loaded_files(scov_style_report, tracked_glob)
         # apply coverband filters
         filtered_report_files = {}

data/lib/coverband/reporters/web.rb

@@ -35,10 +35,6 @@ module Coverband
           case request.path_info
           when /.*\.(css|js|gif|png)/
             @static.call(env)
-          when %r{\/settings}
-            [200, { 'Content-Type' => 'text/html' }, [settings]]
-          when %r{\/debug_data}
-            [200, { 'Content-Type' => 'text/json' }, [debug_data]]
           when %r{\/$}
             [200, { 'Content-Type' => 'text/html' }, [index]]
           else
@@ -57,16 +53,8 @@ module Coverband
                                                 open_report: false)
       end
 
-      def settings
-        Coverband::Utils::HTMLFormatter.new(nil, base_path: base_path).format_settings!
-      end
-
-      def debug_data
-        Coverband.configuration.store.coverage.to_json
-      end
-
       def collect_coverage
-        Coverband.report_coverage(true)
+        Coverband::Collectors::Coverage.instance.report_coverage(true)
         notice = 'coverband coverage collected'
         [301, { 'Location' => "#{base_path}?notice=#{notice}" }, []]
       end

data/lib/coverband/utils/file_groups.rb

@@ -8,8 +8,7 @@ module Coverband
     class FileGroups
       def initialize(files)
         @grouped = {}
-        @files = files
-        filter_to_groups
+        filter_to_groups(files)
       end
 
       def grouped_results
@@ -18,36 +17,29 @@ module Coverband
 
       private
 
-      def filter_to_groups
+      def filter_to_groups(files)
         grouped_files = []
+        grouped_gems = {}
+        gem_lists = []
         Coverband.configuration.groups.each do |name, filter|
           if name == 'Gems'
-            gem_lists = gem_files(name, filter)
-            grouped_files.concat(gem_lists.flatten) if gem_lists.flatten.any?
+            grouped_gems = files.select { |source_file| source_file.filename =~ /#{filter}/ }.group_by(&:gem_name)
+            gem_lists = grouped_gems.values.map { |gem_files| Coverband::Utils::FileList.new(gem_files) }
+            grouped_files.concat(gem_lists.flatten)
+            @grouped[name] = Coverband::Utils::GemList.new(gem_lists) if gem_lists.flatten.any?
           else
-            app_files(name, filter)
+            @grouped[name] = Coverband::Utils::FileList.new(files.select do |source_file|
+              source_file.filename =~ /#{filter}/
+            end)
             grouped_files += @grouped[name]
           end
         end
-        if !Coverband.configuration.groups.empty? && !(other_files = @files.reject do |source_file|
+        if !Coverband.configuration.groups.empty? && !(other_files = files.reject do |source_file|
                                                          grouped_files.include?(source_file)
                                                        end).empty?
           @grouped['Ungrouped'] = Coverband::Utils::FileList.new(other_files)
         end
       end
-
-      def gem_files(name, filter)
-        grouped_gems = @files.select { |source_file| source_file.filename =~ /#{filter}/ }.group_by(&:gem_name)
-        gem_lists = grouped_gems.values.map { |gem_files| Coverband::Utils::FileList.new(gem_files) }
-        @grouped[name] = Coverband::Utils::GemList.new(gem_lists) if gem_lists.flatten.any?
-        gem_lists
-      end
-
-      def app_files(name, filter)
-        @grouped[name] = Coverband::Utils::FileList.new(@files.select do |source_file|
-          source_file.filename =~ /#{filter}/ && source_file.filename !~ /#{Coverband.configuration.gem_paths.first}/
-        end)
-      end
     end
   end
 end

data/lib/coverband/utils/html_formatter.rb

@@ -18,7 +18,7 @@ module Coverband
       def initialize(report, options = {})
         @notice = options.fetch(:notice) { nil }
         @base_path = options.fetch(:base_path) { nil }
-        @coverage_result = Coverband::Utils::Result.new(report) if report
+        @coverage_result = Coverband::Utils::Result.new(report)
       end
 
       def format!
@@ -29,16 +29,8 @@ module Coverband
         format_html(@coverage_result)
       end
 
-      def format_settings!
-        format_settings
-      end
-
       private
 
-      def format_settings
-        template('settings').result(binding)
-      end
-
       def format(result)
         Dir[File.join(File.dirname(__FILE__), '../../../public/*')].each do |path|
           FileUtils.cp_r(path, asset_output_path)

data/lib/coverband/utils/railtie.rb

@@ -7,7 +7,7 @@ module Coverband
     end
 
     config.after_initialize do
-      Coverband.report_coverage(true)
+      Coverband::Collectors::Coverage.instance.report_coverage(true)
     end
 
     rake_tasks do

data/lib/coverband/utils/tasks.rb

@@ -25,13 +25,4 @@ namespace :coverband do
     environment
     Coverband.configuration.store.clear!
   end
-
-  ###
-  # clear data helpful for development or after configuration issues
-  ###
-  desc 'upgrade previous Coverband datastore to latest format'
-  task :migrate do
-    environment
-    Coverband.configuration.store.migrate!
-  end
 end

data/lib/coverband/version.rb

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

data/test/benchmarks/benchmark.rake

@@ -134,7 +134,7 @@ namespace :benchmarks do
       x.config(time: 12, warmup: 5, suite: suite)
       x.report 'coverband' do
         work
-        Coverband.report_coverage(true)
+        Coverband::Collectors::Coverage.instance.report_coverage
       end
       x.report 'no coverband' do
         work
@@ -176,10 +176,6 @@ namespace :benchmarks do
         @file_hash_cache[file] = Digest::MD5.file(__FILE__).hexdigest
       end
     end
-
-    def store.full_path_to_relative(file)
-      file
-    end
   end
 
   def reporting_speed
@@ -219,43 +215,12 @@ namespace :benchmarks do
     $stdout = previous_out
   end
 
-  def measure_configure_memory
-    require 'memory_profiler'
-    # warmup
-    3.times { Coverband.configure }
-
-    previous_out = $stdout
-    capture = StringIO.new
-    $stdout = capture
-
-    MemoryProfiler.report do
-      10.times do
-        Coverband.configure do |config|
-          redis_url = ENV['CACHE_REDIS_URL'] || ENV['REDIS_URL']
-          config.store = Coverband::Adapters::RedisStore.new(Redis.new(url: redis_url), redis_namespace: 'coverband_data')
-        end
-      end
-    end.pretty_print
-    data = $stdout.string
-    $stdout = previous_out
-    puts data
-    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 reporting on configure'
-  task memory_configure_reporting: [:setup] do
-    puts 'runs memory benchmarking on configure to ensure we dont leak'
-    measure_configure_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'

data/test/test_helper.rb

@@ -16,7 +16,6 @@ require 'json'
 require 'redis'
 require 'resque'
 require 'pry-byebug'
-require_relative 'unique_files'
 $VERBOSE = original_verbosity
 
 Coveralls.wear!
@@ -80,12 +79,20 @@ def basic_coverage
   { 'app_path/dog.rb' => example_line }
 end
 
-def source_fixture(filename)
-  File.expand_path(File.join(File.dirname(__FILE__), 'fixtures', filename))
+def fake_redis
+  @redis ||= begin
+    redis = OpenStruct.new
+    redis
+  end
 end
 
-def test_root
-  File.expand_path(File.join(File.dirname(__FILE__)))
+def fake_coverage_report
+  file_name = '/Users/danmayer/projects/hearno/script/tester.rb'
+  { file_name => [1, nil, 1, 1, nil, nil, nil] }
+end
+
+def source_fixture(filename)
+  File.expand_path(File.join(File.dirname(__FILE__), 'fixtures', filename))
 end
 
 # Taken from http://stackoverflow.com/questions/4459330/how-do-i-temporarily-redirect-stderr-in-ruby

data/test/{coverband/adapters/base_test.rb → unit/adapters_base_test.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require File.expand_path('../../test_helper', File.dirname(__FILE__))
+require File.expand_path('../test_helper', File.dirname(__FILE__))
 
 class AdaptersBaseTest < Minitest::Test
   def setup

data/test/{coverband/adapters/file_store_test.rb → unit/adapters_file_store_test.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require File.expand_path('../../test_helper', File.dirname(__FILE__))
+require File.expand_path('../test_helper', File.dirname(__FILE__))
 
 class AdaptersFileStoreTest < Minitest::Test
   def setup

data/test/{coverband/adapters/redis_store_test.rb → unit/adapters_redis_store_test.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require File.expand_path('../../test_helper', File.dirname(__FILE__))
+require File.expand_path('../test_helper', File.dirname(__FILE__))
 
 class RedisTest < Minitest::Test
   REDIS_STORAGE_FORMAT_VERSION = Coverband::Adapters::RedisStore::REDIS_STORAGE_FORMAT_VERSION

data/test/{coverband/integrations → unit}/background_test.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require File.expand_path('../../test_helper', File.dirname(__FILE__))
+require File.expand_path('../test_helper', File.dirname(__FILE__))
 
 class BackgroundTest < Minitest::Test
   def setup

data/test/unit/collectors_coverage_test.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require File.expand_path('../test_helper', File.dirname(__FILE__))
+require File.expand_path('./dog', File.dirname(__FILE__))
+
+if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.3.0')
+  class CollectorsCoverageTest < Minitest::Test
+    attr_accessor :coverband
+
+    def setup
+      super
+      Coverband.configure do |config|
+        config.store = Coverband::Adapters::RedisStore.new(Redis.new)
+      end
+      @coverband = Coverband::Collectors::Coverage.instance.reset_instance
+    end
+
+    def teardown
+      Thread.current[:coverband_instance] = nil
+      Coverband.configure do |config|
+      end
+      @coverband = Coverband::Collectors::Coverage.instance.reset_instance
+    end
+
+    test 'gets coverage instance' do
+      assert_equal Coverband::Collectors::Coverage, coverband.class
+    end
+
+    test 'defaults to a redis store' do
+      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_raises 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