coverband 4.2.7 → 5.0.0.rc.7

data/lib/coverband.rb

@@ -1,42 +1,34 @@
 # frozen_string_literal: true
 
-require 'logger'
-require 'json'
-require 'redis'
-require 'coverband/version'
-require 'coverband/at_exit'
-require 'coverband/configuration'
-require 'coverband/utils/relative_file_converter'
-require 'coverband/utils/absolute_file_converter'
-require 'coverband/adapters/base'
-require 'coverband/adapters/redis_store'
-require 'coverband/adapters/hash_redis_store'
-require 'coverband/adapters/file_store'
-require 'coverband/utils/file_hasher'
-require 'coverband/utils/s3_report'
-require 'coverband/utils/html_formatter'
-require 'coverband/utils/result'
-require 'coverband/utils/file_list'
-require 'coverband/utils/gem_list'
-require 'coverband/utils/source_file'
-require 'coverband/utils/file_groups'
-require 'coverband/utils/lines_classifier'
-require 'coverband/utils/results'
-require 'coverband/collectors/coverage'
-require 'coverband/collectors/view_tracker'
-require 'coverband/reporters/base'
-require 'coverband/reporters/html_report'
-require 'coverband/reporters/console_report'
-require 'coverband/reporters/web'
-require 'coverband/integrations/background'
-require 'coverband/integrations/background_middleware'
-require 'coverband/integrations/rack_server_check'
-
-Coverband::Adapters::RedisStore = Coverband::Adapters::HashRedisStore if ENV['COVERBAND_HASH_REDIS_STORE']
+require "logger"
+require "json"
+require "redis"
+require "coverband/version"
+require "coverband/at_exit"
+require "coverband/configuration"
+require "coverband/utils/relative_file_converter"
+require "coverband/utils/absolute_file_converter"
+require "coverband/adapters/base"
+require "coverband/adapters/redis_store"
+require "coverband/adapters/hash_redis_store"
+require "coverband/adapters/file_store"
+require "coverband/adapters/stdout_store"
+require "coverband/utils/file_hasher"
+require "coverband/collectors/coverage"
+require "coverband/collectors/view_tracker"
+require "coverband/collectors/view_tracker_service"
+require "coverband/reporters/base"
+require "coverband/reporters/console_report"
+require "coverband/integrations/background"
+require "coverband/integrations/background_middleware"
+require "coverband/integrations/rack_server_check"
+
+Coverband::Adapters::RedisStore = Coverband::Adapters::HashRedisStore if ENV["COVERBAND_HASH_REDIS_STORE"]
 
 module Coverband
   @@configured = false
-  CONFIG_FILE = './config/coverband.rb'
+  SERVICE_CONFIG = "./config/coverband_service.rb"
+  CONFIG_FILE = "./config/coverband.rb"
   RUNTIME_TYPE = :runtime
   EAGER_TYPE = :eager_loading
   MERGED_TYPE = :merged
@@ -44,19 +36,27 @@ module Coverband
   ALL_TYPES = TYPES + [:merged]
 
   def self.configure(file = nil)
-    configuration_file = file || ENV.fetch('COVERBAND_CONFIG', CONFIG_FILE)
+    configuration_file = file || ENV["COVERBAND_CONFIG"]
+    if configuration_file.nil?
+      configuration_file = coverband_service? ? SERVICE_CONFIG : CONFIG_FILE
+    end
+
     configuration
     if block_given?
       yield(configuration)
     elsif File.exist?(configuration_file)
       load configuration_file
     else
-      configuration.logger.debug('using default configuration')
+      configuration.logger.debug("using default configuration")
     end
     @@configured = true
     coverage_instance.reset_instance
   end
 
+  def self.coverband_service?
+    !!File.exist?(SERVICE_CONFIG)
+  end
+
   def self.configured?
     @@configured
   end
@@ -98,19 +98,43 @@ module Coverband
   private_class_method def self.coverage_instance
     Coverband::Collectors::Coverage.instance
   end
-  unless ENV['COVERBAND_DISABLE_AUTO_START']
+
+  unless ENV["COVERBAND_DISABLE_AUTO_START"]
     begin
-      require 'coverband/utils/jruby_ext' if RUBY_PLATFORM == 'java'
       # Coverband should be setup as early as possible
       # to capture usage of things loaded by initializers or other Rails engines
-      configure
-      start
-      require 'coverband/utils/railtie' if defined? ::Rails::Railtie
-      require 'coverband/integrations/resque' if defined? ::Resque
-      require 'coverband/integrations/bundler' if defined? ::Bundler
+      # but after gems are loaded to avoid slowing down gem usage
+      # best is in application.rb after the bundler line but we get close with Railtie
+      if defined? ::Rails::Railtie
+        require "coverband/utils/railtie"
+      else
+        configure
+        start
+      end
+      require "coverband/integrations/resque" if defined? ::Resque
     rescue Redis::CannotConnectError => error
       Coverband.configuration.logger.info "Redis is not available (#{error}), Coverband not configured"
-      Coverband.configuration.logger.info 'If this is a setup task like assets:precompile feel free to ignore'
+      Coverband.configuration.logger.info "If this is a setup task like assets:precompile feel free to ignore"
+    end
+  end
+
+  module Reporters
+    class Web
+      ###
+      # NOTE: if the user doesn't setup the webreporter
+      # we don't need any of the below files loaded or using memory
+      ###
+      def initialize
+        require "coverband/reporters/web"
+        require "coverband/utils/html_formatter"
+        require "coverband/utils/result"
+        require "coverband/utils/file_list"
+        require "coverband/utils/source_file"
+        require "coverband/utils/lines_classifier"
+        require "coverband/utils/results"
+        require "coverband/reporters/html_report"
+        init_web
+      end
     end
   end
 end

data/lib/coverband/adapters/base.rb

@@ -3,11 +3,11 @@
 module Coverband
   module Adapters
     class Base
-      DATA_KEY = 'data'
-      FIRST_UPDATED_KEY = 'first_updated_at'
-      LAST_UPDATED_KEY = 'last_updated_at'
-      FILE_HASH = 'file_hash'
-      ABSTRACT_KEY = 'abstract'
+      DATA_KEY = "data"
+      FIRST_UPDATED_KEY = "first_updated_at"
+      LAST_UPDATED_KEY = "last_updated_at"
+      FILE_HASH = "file_hash"
+      ABSTRACT_KEY = "abstract"
 
       attr_accessor :type
 
@@ -40,11 +40,11 @@ module Coverband
       end
 
       def size_in_mib
-        format('%<size>.2f', size: (size.to_f / 2**20))
+        format("%<size>.2f", size: (size.to_f / 2**20))
       end
 
       def save_report(_report)
-        raise 'abstract'
+        raise "abstract"
       end
 
       def get_coverage_report
@@ -76,7 +76,7 @@ module Coverband
         runtime_data = coverage(Coverband::RUNTIME_TYPE)
         eager_data = coverage(Coverband::EAGER_TYPE)
         eager_data.values do |vals|
-          vals['data'].map! { |line_coverage| line_coverage ? (0 - line_coverage) : line_coverage }
+          vals["data"].map! { |line_coverage| line_coverage ? (0 - line_coverage) : line_coverage }
         end
         merge_reports(runtime_data, eager_data, skip_expansion: true)
       end
@@ -112,19 +112,18 @@ module Coverband
         # transparently update from RUNTIME_TYPE = nil to RUNTIME_TYPE = :runtime
         # transparent update for format coveband_3_2
         old_report = coverage(nil, override_type: nil) if old_report.nil? && type == Coverband::RUNTIME_TYPE
-
         new_report = expand_report(new_report) unless options[:skip_expansion]
         keys = (new_report.keys + old_report.keys).uniq
         keys.each do |file|
           new_report[file] = if new_report[file] &&
-                                old_report[file] &&
-                                new_report[file][FILE_HASH] == old_report[file][FILE_HASH]
-                               merge_expanded_data(new_report[file], old_report[file])
-                             elsif new_report[file]
-                               new_report[file]
-                             else
-                               old_report[file]
-                             end
+              old_report[file] &&
+              new_report[file][FILE_HASH] == old_report[file][FILE_HASH]
+            merge_expanded_data(new_report[file], old_report[file])
+          elsif new_report[file]
+            new_report[file]
+          else
+            old_report[file]
+          end
         end
         new_report
       end
@@ -145,7 +144,7 @@ module Coverband
         elsif Coverband.configuration.simulate_oneshot_lines_coverage
           latest.map.with_index { |v, i| (v + original[i] >= 1 ? 1 : 0) if v && original[i] }
         else
-          latest.map.with_index { |v, i| (v && original[i]) ? v + original[i] : nil }
+          latest.map.with_index { |v, i| v && original[i] ? v + original[i] : nil }
         end
       end
     end

data/lib/coverband/adapters/file_store.rb

@@ -3,14 +3,38 @@
 module Coverband
   module Adapters
     ###
-    # FilesStore store a merged coverage file to local disk
-    # Generally this is for testing and development
-    # Not recommended for production deployment
+    # FileStore store a merged coverage file to local disk
+    #
+    # Notes: Concurrency
+    # * threadsafe as the caller to save_report uses @semaphore.synchronize
+    # * file access process safe as each file written per process PID
+    #
+    # Usage:
+    # config.store = Coverband::Adapters::FileStore.new('log/coverage.log')
+    #
+    # View Reports:
+    # Using this assumes you are syncing the coverage files
+    # to some shared storage that is accessable outside of the production server
+    # download files to a system where you want to view the reports..
+    # When viewing coverage from the filestore adapter it merges all coverage
+    # files matching the path pattern, in this case `log/coverage.log.*`
+    #
+    # run: `bundle exec rake coverband:coverage_server`
+    # open http://localhost:1022/
+    #
+    # one could also build a report via code, the output is suitable to feed into SimpleCov
+    #
+    # ```
+    # coverband.configuration.store.merge_mode = true
+    # coverband.configuration.store.coverage
+    # ```
     ###
     class FileStore < Base
+      attr_accessor :merge_mode
       def initialize(path, _opts = {})
         super()
-        @path = path
+        @path = "#{path}.#{::Process.pid}"
+        @merge_mode = false
 
         config_dir = File.dirname(@path)
         Dir.mkdir config_dir unless File.exist?(config_dir)
@@ -29,17 +53,25 @@ module Coverband
       end
 
       def coverage(_local_type = nil)
-        if File.exist?(path)
+        if merge_mode
+          data = {}
+          Dir[path.sub(/\.\d+/, ".*")].each do |path|
+            data = merge_reports(data, JSON.parse(File.read(path)), skip_expansion: true)
+          end
+          data
+        elsif File.exist?(path)
           JSON.parse(File.read(path))
         else
           {}
         end
+      rescue Errno::ENOENT
+        {}
       end
 
       def save_report(report)
         data = report.dup
         data = merge_reports(data, coverage)
-        File.open(path, 'w') { |f| f.write(data.to_json) }
+        File.write(path, JSON.dump(data))
       end
 
       def raw_store

data/lib/coverband/adapters/hash_redis_store.rb

@@ -1,19 +1,19 @@
 # frozen_string_literal: true
 
-require 'securerandom'
+require "securerandom"
 
 module Coverband
   module Adapters
     class HashRedisStore < Base
-      FILE_KEY = 'file'
-      FILE_LENGTH_KEY = 'file_length'
+      FILE_KEY = "file"
+      FILE_LENGTH_KEY = "file_length"
       META_DATA_KEYS = [DATA_KEY, FIRST_UPDATED_KEY, LAST_UPDATED_KEY, FILE_HASH].freeze
       ###
       # This key isn't related to the coverband version, but to the interal format
       # used to store data to redis. It is changed only when breaking changes to our
       # redis format are required.
       ###
-      REDIS_STORAGE_FORMAT_VERSION = 'coverband_hash_3_3'
+      REDIS_STORAGE_FORMAT_VERSION = "coverband_hash_3_3"
 
       JSON_PAYLOAD_EXPIRATION = 5 * 60
 
@@ -25,14 +25,17 @@ module Coverband
         @save_report_batch_size = opts[:save_report_batch_size] || 100
         @format_version = REDIS_STORAGE_FORMAT_VERSION
         @redis = redis
-        raise 'HashRedisStore requires redis >= 2.6.0' unless supported?
+        raise "HashRedisStore requires redis >= 2.6.0" unless supported?
 
         @ttl = opts[:ttl]
         @relative_file_converter = opts[:relative_file_converter] || Utils::RelativeFileConverter
       end
 
       def supported?
-        Gem::Version.new(@redis.info['redis_version']) >= Gem::Version.new('2.6.0')
+        Gem::Version.new(@redis.info["redis_version"]) >= Gem::Version.new("2.6.0")
+      rescue Redis::CannotConnectError => error
+        Coverband.configuration.logger.info "Redis is not available (#{error}), Coverband not configured"
+        Coverband.configuration.logger.info "If this is a setup task like assets:precompile feel free to ignore"
       end
 
       def clear!
@@ -60,7 +63,7 @@ module Coverband
         updated_time = type == Coverband::EAGER_TYPE ? nil : report_time
         keys = []
         report.each_slice(@save_report_batch_size) do |slice|
-          files_data = slice.map do |(file, data)|
+          files_data = slice.map { |(file, data)|
             relative_file = @relative_file_converter.convert(file)
             file_hash = file_hash(relative_file)
             key = key(relative_file, file_hash: file_hash)
@@ -73,11 +76,11 @@ module Coverband
               report_time: report_time,
               updated_time: updated_time
             )
-          end
+          }
           next unless files_data.any?
 
-          arguments_key = [@redis_namespace, SecureRandom.uuid].compact.join('.')
-          @redis.set(arguments_key, { ttl: @ttl, files_data: files_data }.to_json, ex: JSON_PAYLOAD_EXPIRATION)
+          arguments_key = [@redis_namespace, SecureRandom.uuid].compact.join(".")
+          @redis.set(arguments_key, {ttl: @ttl, files_data: files_data}.to_json, ex: JSON_PAYLOAD_EXPIRATION)
           @redis.evalsha(hash_incr_script, [arguments_key])
         end
         @redis.sadd(files_key, keys) if keys.any?
@@ -85,11 +88,11 @@ module Coverband
 
       def coverage(local_type = nil)
         files_set = files_set(local_type)
-        @redis.pipelined do
+        @redis.pipelined {
           files_set.map do |key|
             @redis.hgetall(key)
           end
-        end.each_with_object({}) do |data_from_redis, hash|
+        }.each_with_object({}) do |data_from_redis, hash|
           add_coverage_for_file(data_from_redis, hash)
         end
       end
@@ -99,11 +102,11 @@ module Coverband
       end
 
       def size
-        'not available'
+        "not available"
       end
 
       def size_in_mib
-        'not available'
+        "not available"
       end
 
       private
@@ -115,7 +118,7 @@ module Coverband
         return unless file_hash(file) == data_from_redis[FILE_HASH]
 
         data = coverage_data_from_redis(data_from_redis)
-        hash[file] = data_from_redis.select { |meta_data_key, _value| META_DATA_KEYS.include?(meta_data_key) }.merge!('data' => data)
+        hash[file] = data_from_redis.select { |meta_data_key, _value| META_DATA_KEYS.include?(meta_data_key) }.merge!("data" => data)
         hash[file][LAST_UPDATED_KEY] = hash[file][LAST_UPDATED_KEY].blank? ? nil : hash[file][LAST_UPDATED_KEY].to_i
         hash[file].merge!(LAST_UPDATED_KEY => hash[file][LAST_UPDATED_KEY], FIRST_UPDATED_KEY => hash[file][FIRST_UPDATED_KEY].to_i)
       end
@@ -129,9 +132,9 @@ module Coverband
       end
 
       def script_input(key:, file:, file_hash:, data:, report_time:, updated_time:)
-        coverage_data = data.each_with_index.each_with_object({}) do |(coverage, index), hash|
+        coverage_data = data.each_with_index.each_with_object({}) { |(coverage, index), hash|
           hash[index] = coverage if coverage
-        end
+        }
         meta = {
           first_updated_at: report_time,
           file: file,
@@ -153,8 +156,8 @@ module Coverband
 
       def lua_script_content
         File.read(File.join(
-                    File.dirname(__FILE__), '../../../lua/lib/persist-coverage.lua'
-                  ))
+          File.dirname(__FILE__), "../../../lua/lib/persist-coverage.lua"
+        ))
       end
 
       def values_from_redis(local_type, files)
@@ -178,12 +181,12 @@ module Coverband
       end
 
       def key(file, local_type = nil, file_hash:)
-        [key_prefix(local_type), file, file_hash].join('.')
+        [key_prefix(local_type), file, file_hash].join(".")
       end
 
       def key_prefix(local_type = nil)
         local_type ||= type
-        [@format_version, @redis_namespace, local_type].compact.join('.')
+        [@format_version, @redis_namespace, local_type].compact.join(".")
       end
     end
   end

data/lib/coverband/adapters/redis_store.rb

@@ -11,19 +11,19 @@ module Coverband
       # used to store data to redis. It is changed only when breaking changes to our
       # redis format are required.
       ###
-      REDIS_STORAGE_FORMAT_VERSION = 'coverband_3_2'
+      REDIS_STORAGE_FORMAT_VERSION = "coverband_3_2"
 
       attr_reader :redis_namespace
 
       def initialize(redis, opts = {})
         super()
-        @redis           = redis
-        @ttl             = opts[:ttl]
+        @redis = redis
+        @ttl = opts[:ttl]
         @redis_namespace = opts[:redis_namespace]
-        @format_version  = REDIS_STORAGE_FORMAT_VERSION
-        @keys            = {}
+        @format_version = REDIS_STORAGE_FORMAT_VERSION
+        @keys = {}
         Coverband::TYPES.each do |type|
-          @keys[type] = [@format_version, @redis_namespace, type].compact.join('.')
+          @keys[type] = [@format_version, @redis_namespace, type].compact.join(".")
         end
       end
 
@@ -54,15 +54,15 @@ module Coverband
       ###
       def migrate!
         reset_base_key
-        @format_version = 'coverband3_1'
+        @format_version = "coverband3_1"
         previous_data = coverage
         if previous_data.empty?
-          puts 'no previous data to migrate found'
+          puts "no previous data to migrate found"
           exit 0
         end
-        relative_path_report = previous_data.each_with_object({}) do |(key, vals), fixed_report|
+        relative_path_report = previous_data.each_with_object({}) { |(key, vals), fixed_report|
           fixed_report[Utils::RelativeFileConverter.convert(key)] = vals
-        end
+        }
         clear!
         reset_base_key
         @format_version = REDIS_STORAGE_FORMAT_VERSION
@@ -78,7 +78,7 @@ module Coverband
         local_type ||= opts.key?(:override_type) ? opts[:override_type] : type
         data = redis.get type_base_key(local_type)
         data = data ? JSON.parse(data) : {}
-        data.delete_if { |file_path, file_data| file_hash(file_path) != file_data['file_hash'] } unless opts[:skip_hash_check]
+        data.delete_if { |file_path, file_data| file_hash(file_path) != file_data["file_hash"] } unless opts[:skip_hash_check]
         data
       end
 
@@ -105,7 +105,7 @@ module Coverband
       end
 
       def base_key
-        @base_key ||= [@format_version, @redis_namespace, type].compact.join('.')
+        @base_key ||= [@format_version, @redis_namespace, type].compact.join(".")
       end
 
       def type_base_key(local_type)