coverband 4.2.1.rc3 → 4.2.1.rc4

data/lib/coverband/collectors/coverage.rb

@@ -31,7 +31,7 @@ module Coverband
       end
 
       def runtime!
-        @store.type = nil
+        @store.type = Coverband::RUNTIME_TYPE
       end
 
       def eager_loading!
@@ -82,9 +82,8 @@ module Coverband
       private
 
       def filtered_files(new_results)
-        new_results.each_with_object({}) do |(file, line_counts), file_line_usage|
-          file_line_usage[file] = line_counts if track_file?(file)
-        end.select { |_file_name, coverage| coverage.any? { |value| value&.nonzero? } }
+        new_results.select! { |file, coverage| track_file?(file) && coverage.any? { |value| value&.nonzero? } }
+        new_results
       end
 
       def initialize

data/lib/coverband/collectors/delta.rb

@@ -4,6 +4,8 @@ module Coverband
   module Collectors
     class Delta
       @@previous_coverage = {}
+      @@stubs = {}
+
       attr_reader :current_coverage
 
       def initialize(current_coverage)
@@ -12,20 +14,27 @@ module Coverband
 
       class RubyCoverage
         def self.results
-          ::Coverage.peek_result.dup
+          if Coverband.configuration.use_oneshot_lines_coverage
+            ::Coverage.result(clear: true, stop: false)
+          else
+            ::Coverage.peek_result
+          end
         end
       end
 
       def self.results(process_coverage = RubyCoverage)
         coverage_results = process_coverage.results
-        coverage_results = transform_oneshot_lines_results(coverage_results) if Coverband.configuration.use_oneshot_lines_coverage
         new(coverage_results).results
       end
 
       def results
-        new_results = generate
-        @@previous_coverage = current_coverage
-        new_results
+        if Coverband.configuration.use_oneshot_lines_coverage
+          transform_oneshot_lines_results(current_coverage)
+        else
+          new_results = generate
+          @@previous_coverage = current_coverage unless Coverband.configuration.simulate_oneshot_lines_coverage
+          new_results
+        end
       end
 
       def self.reset
@@ -36,7 +45,7 @@ module Coverband
 
       def generate
         current_coverage.each_with_object({}) do |(file, line_counts), new_results|
-          new_results[file] = if @@previous_coverage[file]
+          new_results[file] = if @@previous_coverage && @@previous_coverage[file]
                                 array_diff(line_counts, @@previous_coverage[file])
                               else
                                 line_counts
@@ -50,9 +59,10 @@ module Coverband
         end
       end
 
-      private_class_method def self.transform_oneshot_lines_results(results)
+      def transform_oneshot_lines_results(results)
         results.each_with_object({}) do |(file, coverage), new_results|
-          transformed_line_counts = coverage[:oneshot_lines].each_with_object(::Coverage.line_stub(file)) do |line_number, line_counts|
+          @@stubs[file] ||= ::Coverage.line_stub(file)
+          transformed_line_counts = coverage[:oneshot_lines].each_with_object(@@stubs[file].dup) do |line_number, line_counts|
             line_counts[line_number - 1] = 1
           end
           new_results[file] = transformed_line_counts

data/lib/coverband/configuration.rb

@@ -7,9 +7,10 @@ module Coverband
                   :reporter, :redis_namespace, :redis_ttl,
                   :background_reporting_enabled,
                   :background_reporting_sleep_seconds, :test_env,
-                  :web_enable_clear, :gem_details, :web_debug, :report_on_exit
+                  :web_enable_clear, :gem_details, :web_debug, :report_on_exit,
+                  :simulate_oneshot_lines_coverage
 
-    attr_writer :logger, :s3_region, :s3_bucket, :s3_access_key_id, :s3_secret_access_key
+    attr_writer :logger, :s3_region, :s3_bucket, :s3_access_key_id, :s3_secret_access_key, :password
     attr_reader :track_gems, :ignore, :use_oneshot_lines_coverage
 
     #####
@@ -51,7 +52,12 @@ module Coverband
       @groups = {}
       @web_debug = false
       @report_on_exit = true
-      @use_oneshot_lines_coverage = false
+      @use_oneshot_lines_coverage = ENV['ONESHOT'] || false
+      @simulate_oneshot_lines_coverage = ENV['SIMULATE_ONESHOT'] || false
+      @current_root = nil
+      @all_root_paths = nil
+      @all_root_patterns = nil
+      @password = nil
 
       # TODO: should we push these to adapter configs
       @s3_region = nil
@@ -59,7 +65,7 @@ module Coverband
       @s3_access_key_id = nil
       @s3_secret_access_key = nil
       @redis_namespace = nil
-      @redis_ttl = nil
+      @redis_ttl = 2_592_000 # in seconds. Default is 30 days.
     end
 
     def logger
@@ -70,6 +76,10 @@ module Coverband
                   end
     end
 
+    def password
+      @password || ENV['COVERBAND_PASSWORD']
+    end
+
     def s3_bucket
       @s3_bucket || ENV['AWS_BUCKET']
     end
@@ -143,14 +153,20 @@ module Coverband
     end
 
     def current_root
-      File.expand_path(Coverband.configuration.root)
+      @current_root ||= File.expand_path(Coverband.configuration.root).freeze
     end
 
     def all_root_paths
-      roots = Coverband.configuration.root_paths.dup
-      roots += Coverband.configuration.gem_paths.dup if Coverband.configuration.track_gems
-      roots << "#{Coverband.configuration.current_root}/"
-      roots
+      return @all_root_paths if @all_root_paths
+
+      @all_root_paths = Coverband.configuration.root_paths.dup
+      @all_root_paths += Coverband.configuration.gem_paths.dup if Coverband.configuration.track_gems
+      @all_root_paths << "#{Coverband.configuration.current_root}/"
+      @all_root_paths
+    end
+
+    def all_root_patterns
+      @all_root_patterns ||= all_root_paths.map { |path| /^#{path}/ }.freeze
     end
 
     SKIPPED_SETTINGS = %w[@s3_secret_access_key @store]

data/lib/coverband/integrations/background.rb

@@ -32,7 +32,9 @@ module Coverband
         @thread = Thread.new do
           loop do
             Coverband.report_coverage
-            logger.debug("Coverband: Reported coverage via thread. Sleeping #{sleep_seconds}s") if Coverband.configuration.verbose
+            if Coverband.configuration.verbose
+              logger.debug("Coverband: background reporting coverage (#{Coverband.configuration.store.type}). Sleeping #{sleep_seconds}s")
+            end
             sleep(sleep_seconds)
           end
         end

data/lib/coverband/reporters/base.rb

@@ -9,6 +9,9 @@ module Coverband
     class Base
       class << self
         include Coverband::Utils::FilePathHelper
+
+        DATA_KEY = 'data'
+
         def report(store, _options = {})
           all_roots = Coverband.configuration.all_root_paths
           scov_style_report = get_current_scov_data_imp(store, all_roots)
@@ -54,9 +57,9 @@ module Coverband
             fixed_report[name] = {}
             report.each_pair do |key, vals|
               filename = relative_path_to_full(key, roots)
-              fixed_report[name][filename] = if fixed_report[name].key?(filename) && fixed_report[name][filename]['data'] && vals['data']
-                                               merged_data = merge_arrays(fixed_report[name][filename]['data'], vals['data'])
-                                               vals['data'] = merged_data
+              fixed_report[name][filename] = if fixed_report[name].key?(filename) && fixed_report[name][filename][DATA_KEY] && vals[DATA_KEY]
+                                               merged_data = merge_arrays(fixed_report[name][filename][DATA_KEY], vals[DATA_KEY])
+                                               vals[DATA_KEY] = merged_data
                                                vals
                                              else
                                                vals

data/lib/coverband/reporters/web.rb

@@ -18,9 +18,20 @@ module Coverband
                                    urls: [/.*\.css/, /.*\.js/, /.*\.gif/, /.*\.png/])
       end
 
+      def check_auth
+        return true unless Coverband.configuration.password
+
+        auth_header = request.get_header('HTTP_AUTHORIZATION')
+        return unless auth_header
+
+        Coverband.configuration.password == Base64.decode64(auth_header.split[1]).split(':')[1]
+      end
+
       def call(env)
         @request = Rack::Request.new(env)
 
+        return [401, { 'www-authenticate' => 'Basic realm=""' }, ['']] unless check_auth
+
         if request.post?
           case request.path_info
           when %r{\/clear_file}

data/lib/coverband/utils/file_path_helper.rb

@@ -8,16 +8,23 @@ module Coverband
     module FilePathHelper
       module_function
 
+      @@path_cache = {}
+
       ###
       # Takes a full path and converts to a relative path
       ###
       def full_path_to_relative(full_path)
+        return @@path_cache[full_path] if @@path_cache.key?(full_path)
+
         relative_filename = full_path
-        Coverband.configuration.all_root_paths.each do |root|
-          relative_filename = relative_filename.gsub(/^#{root}/, './')
+        Coverband.configuration.all_root_patterns.each do |root|
+          relative_filename = relative_filename.sub(root, './')
           # once we have a relative path break out of the loop
           break if relative_filename.start_with? './'
         end
+
+        @@path_cache[full_path] = relative_filename
+
         relative_filename
       end
 
@@ -42,7 +49,9 @@ module Coverband
         relative_filename = relative_path
         local_filename = relative_filename
         roots.each do |root|
-          relative_filename = relative_filename.gsub(/^#{root}/, './')
+          relative_filename = relative_filename.sub(/^#{root}/, './')
+          # once we have a relative path break out of the loop
+          break if relative_filename.start_with? './'
         end
         # the filename for our reports is expected to be a full path.
         # roots.last should be roots << current_root}/

data/lib/coverband/utils/source_file.rb

@@ -160,7 +160,8 @@ module Coverband
 
         return 0.0 if relevant_lines.zero?
 
-        Float(covered_lines.size * 100.0 / relevant_lines.to_f)
+        # handle edge case where runtime in dev can go over 100%
+        [Float(covered_lines.size * 100.0 / relevant_lines.to_f), 100.0].min
       end
 
       def formatted_covered_percent

data/lib/coverband/utils/tasks.rb

@@ -4,15 +4,8 @@ namespace :coverband do
   # handles configuring in require => false and COVERBAND_DISABLE_AUTO_START cases
   Coverband.configure unless Coverband.configured?
 
-  def environment
-    Coverband.configuration.report_on_exit = false
-    Coverband.configuration.background_reporting_enabled = false
-    Rake.application['environment'].invoke if Rake::Task.task_defined?('environment')
-  end
-
   desc 'report runtime Coverband code coverage'
   task :coverage do
-    environment
     if Coverband.configuration.reporter == 'scov'
       Coverband::Reporters::HTMLReport.new(Coverband.configuration.store).report
     else
@@ -22,7 +15,6 @@ namespace :coverband do
 
   desc 'report runtime Coverband code coverage'
   task :coverage_server do
-    environment
     Rack::Server.start app: Coverband::Reporters::Web.new, Port: ENV.fetch('COVERBAND_COVERAGE_PORT', 1022).to_i
   end
 
@@ -31,16 +23,14 @@ namespace :coverband do
   ###
   desc 'reset Coverband coverage data, helpful for development, debugging, etc'
   task :clear do
-    environment
     Coverband.configuration.store.clear!
   end
 
   ###
-  # clear data helpful for development or after configuration issues
+  # Updates the data in the coverband store from one format to another
   ###
   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.2.1.rc3'
+  VERSION = '4.2.1.rc4'
 end

data/test/benchmarks/benchmark.rake

@@ -32,10 +32,7 @@ namespace :benchmarks do
   end
 
   def clone_classifier
-    unless Dir.exist? classifier_dir
-      system "git clone https://github.com/jekyll/classifier-reborn.git #{classifier_dir}"
-    end
-    # rubocop:enable Style/IfUnlessModifier
+    system "git clone https://github.com/jekyll/classifier-reborn.git #{classifier_dir}" unless Dir.exist? classifier_dir
   end
 
   # desc 'setup standard benchmark'
@@ -54,9 +51,9 @@ namespace :benchmarks do
     # moving from 5 second of time to 12 still shows slower based on when classifier is required
     # make sure to be plugged in while benchmarking ;) Otherwise you get very unreliable results
     require 'classifier-reborn'
-    if ENV['COVERAGE']
+    if ENV['COVERAGE'] || ENV['ONESHOT']
       require 'coverage'
-      ::Coverage.start
+      ::Coverage.start(oneshot_lines: !!ENV['ONESHOT'])
     end
     require 'redis'
     require 'coverband'
@@ -79,6 +76,8 @@ namespace :benchmarks do
       config.root                = Dir.pwd
       config.logger              = $stdout
       config.store               = benchmark_redis_store
+      config.use_oneshot_lines_coverage = true if ENV['ONESHOT']
+      config.simulate_oneshot_lines_coverage = true if ENV['SIMULATE_ONESHOT']
     end
   end
 
@@ -207,11 +206,54 @@ namespace :benchmarks do
     end.pretty_print
     data = $stdout.string
     $stdout = previous_out
-    raise 'leaking memory!!!' unless data.match('Total retained:  0 bytes')
+    unless data.match('Total retained:  0 bytes')
+      puts data
+      raise 'leaking memory!!!'
+    end
+  ensure
+    $stdout = previous_out
+  end
+
+  def measure_memory_report_coverage
+    require 'memory_profiler'
+    report = fake_report
+    store = benchmark_redis_store
+    store.clear!
+    mock_files(store)
+
+    # warmup
+    3.times { Coverband.report_coverage }
+
+    previous_out = $stdout
+    capture = StringIO.new
+    $stdout = capture
+
+    MemoryProfiler.report do
+      10.times do
+        Coverband.report_coverage
+        ###
+        # Set to nil not {} as it is easier to verify that no memory is retained when nil gets released
+        # don't use Coverband::Collectors::Delta.reset which sets to {}
+        # we clear this as this one variable is expected to retain memory and is a false positive
+        ###
+        Coverband::Collectors::Delta.class_variable_set(:@@previous_coverage, nil)
+      end
+    end.pretty_print
+    data = $stdout.string
+    $stdout = previous_out
+    unless data.match('Total retained:  0 bytes')
+      puts data
+      raise 'leaking memory!!!'
+    end
   ensure
     $stdout = previous_out
   end
 
+  ###
+  # TODO: This currently fails, as it holds a string in redis adapter
+  # but really Coverband shouldn't be configured multiple times and the leak is small
+  # not including in test suite but we can try to figure it out and fix.
+  ###
   def measure_configure_memory
     require 'memory_profiler'
     # warmup
@@ -231,18 +273,73 @@ namespace :benchmarks do
     end.pretty_print
     data = $stdout.string
     $stdout = previous_out
-    puts data
-    raise 'leaking memory!!!' unless data.match('Total retained:  0 bytes')
+    unless data.match('Total retained:  0 bytes')
+      puts data
+      raise 'leaking memory!!!'
+    end
   ensure
     $stdout = previous_out
   end
 
+  desc 'checks memory of collector'
+  task memory_check: [:setup] do
+    require 'pry-byebug'
+    require 'objspace'
+    puts 'memory load check'
+    puts(ObjectSpace.memsize_of_all / 2**20)
+    data = File.read('./tmp/debug_data.json')
+    # about 2mb
+    puts(ObjectSpace.memsize_of(data) / 2**20)
+
+    json_data = JSON.parse(data)
+    # this seems to just show the value of the pointer
+    # puts(ObjectSpace.memsize_of(json_data) / 2**20)
+    # implies json takes 10-12 mb
+    puts(ObjectSpace.memsize_of_all / 2**20)
+
+    json_data = nil
+    GC.start
+    json_data = JSON.parse(data)
+    # this seems to just show the value of the pointer
+    # puts(ObjectSpace.memsize_of(json_data) / 2**20)
+    # implies json takes 10-12 mb
+    puts(ObjectSpace.memsize_of_all / 2**20)
+
+    json_data = nil
+    GC.start
+    json_data = JSON.parse(data)
+    # this seems to just show the value of the pointer
+    # puts(ObjectSpace.memsize_of(json_data) / 2**20)
+    # implies json takes 10-12 mb
+    puts(ObjectSpace.memsize_of_all / 2**20)
+
+    json_data = nil
+    GC.start
+    json_data = JSON.parse(data)
+    # this seems to just show the value of the pointer
+    # puts(ObjectSpace.memsize_of(json_data) / 2**20)
+    # implies json takes 10-12 mb
+    puts(ObjectSpace.memsize_of_all / 2**20)
+
+    json_data = nil
+    GC.start
+    puts(ObjectSpace.memsize_of_all / 2**20)
+    debugger
+    puts 'done'
+  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 report_coverage'
+  task memory_reporting_report_coverage: [:setup] do
+    puts 'runs memory benchmarking on report_coverage to ensure we dont leak'
+    measure_memory_report_coverage
+  end
+
   desc 'runs memory reporting on configure'
   task memory_configure_reporting: [:setup] do
     puts 'runs memory benchmarking on configure to ensure we dont leak'
@@ -252,7 +349,12 @@ namespace :benchmarks do
   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`
+    puts `COVERBAND_MEMORY_TEST=true bundle exec test/forked/rails_full_stack_test.rb`
+  end
+
+  desc 'runs memory leak checks'
+  task memory: %i[memory_reporting memory_reporting_report_coverage memory_rails] do
+    puts 'done'
   end
 
   desc 'runs benchmarks on reporting large sets of files to redis'
@@ -267,6 +369,29 @@ namespace :benchmarks do
     run_work(true)
   end
 
+  def run_big
+    require 'memory_profiler'
+    require './test/unique_files'
+
+    4000.times { |index| require_unique_file('dog.rb.erb', dog_number: index) }
+    # warmup
+    3.times { Coverband.report_coverage }
+    dogs = 400.times.map { |index| Object.const_get("Dog#{index}") }
+    MemoryProfiler.report do
+      10.times do
+        dogs.each(&:bark)
+        Coverband.report_coverage
+      end
+    end.pretty_print
+  end
+
+  task run_big: %i[setup setup_redis] do
+    # ensure we cleared from last run
+    benchmark_redis_store.clear!
+
+    run_big
+  end
+
   # desc 'runs benchmarks file store'
   task run_file: %i[setup setup_file] do
     puts 'Coverband configured with file store'