coverband 4.2.0.beta → 4.2.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9aa38073bdae160d98f4b0114909db9e0f3967535df5ed10d92be7ef7f85d58
-  data.tar.gz: f0f4ba2d756e783569f75f2444d613eaf17b46eed1b8ff41103dcf1b95454aa0
+  metadata.gz: f6f8d36b44cdc8402a49224920afd6c7a896a88a06ca81d7237566dc3784283a
+  data.tar.gz: 5968d46ebf2badb624044a0af99ac13b3d1cf4f9aa390786da7cc52debc4fe57
 SHA512:
-  metadata.gz: 6d65b43454b8a119b4fbd52577aef646235facde4e6e887a8e6c41ffbed81fd1e3b13282f4a8dd7ab72a47582dec61706ada1b115b869145bb086b435f6f2dbb
-  data.tar.gz: 0b91d57c2f558d8dcfec0452db8c0e8fa7273b19bee982a5ac7fbd1f3da89cac09c154a86bcd21fe89e3c1828328ccf9e3dfd1a68fe9cddafb69a795ee848772
+  metadata.gz: 8b16934f2a74fb43a2868648cc2008100a8abb7c099f087b6b3eb28fd5e9acc2aa697b8c38189e1a510efbcbc363eefb72582d70ad095c451399735299ebbf31
+  data.tar.gz: c8bdb22ed7aab4f36e3daee17ee4f070e3e529c3ce47689e9c14ef4b7499e8d3cad53140dee308b235deb5666ab13f9cc1a493fca0f93dd612374831c19ab308

data/README.md

@@ -38,6 +38,8 @@ Coverband stores coverage data in Redis. The Redis endpoint is looked for in thi
 2. `ENV['REDIS_URL']`
 3. `localhost`
 
+The redis store can also be explicitly defined within the coverband.rb. See [advanced config](#advanced-config).
+
 ## Gem Installation
 
 Add this line to your application's `Gemfile`, remember to `bundle install` after updating:
@@ -46,9 +48,11 @@ Add this line to your application's `Gemfile`, remember to `bundle install` afte
 gem 'coverband'
 ```
 
+If [tracking gem usage](#collecting-gem--library-usage), be sure to include coverband before other gems you would like to track.
+
 ## Rails
 
-The Railtie integration means you shouldn't need to do anything anything else. If you have an issue with that, please [file an issue](https://github.com/danmayer/coverband/issues).
+The Railtie integration means you shouldn't need to do anything anything else other than ensure coverband is required after rails within your Gemfile.
 
 
 ## Sinatra
@@ -198,6 +202,15 @@ ENV['AWS_ACCESS_KEY_ID']
 ENV['AWS_SECRET_ACCESS_KEY']
 ```
 
+### Coverage Data Migration
+
+Between the release of 4.0 and 4.1 our data format changed. This resets all your coverage data. If you want to restore your previous coverage data, feel free to migrate.
+
+`rake coverband:migrate`
+
+* We will be working to support migrations going forward, when possible
+
+
 ### Clear Coverage
 
 Now that Coverband uses MD5 hashes there should be no reason to manually clear coverage unless one is testing, changing versions, possibly debugging Coverband itself.
@@ -242,16 +255,28 @@ By adding any files above you will get reporting on those files as part of your
 
 ### Collecting Gem / Library Usage
 
-By default Coverband has assumed you are trying to track your application code usage and not all the supporting framework and library (Gems) code usage. There are reasons to track library usage though such as finding out which Gems aren't actually being used within production. See some of the discussion on [issue 21](https://github.com/danmayer/coverband/issues/21).
+Gem usage can be tracked by enabling the `track_gems` config.
+
+```
+Coverband.configure do |config|
+  config.track_gems = true
+end
+```
+
+The `track_gems` feature exposes a Gems tab in the report which prints out the percentage usage of each Gem. See demo [here](https://coverband-demo.herokuapp.com/coverage?#_Gems).
+
+When tracking gems, it is important that `Coverband#start` is called before the gems to be tracked are required. Since `Coverband#start` is automatically called by default when coverband is required, list coverband before the other gems to be tracked within your Gemfile. The exception to this are gems like rails and resque. Since coverband has some specific intergrations for these frameworks, these two gems should be required first.
 
-How to collect gem usage with Coverband:
+The track_gems config only exposes the overall usage of a gem. In order to see the detail of each file, enable the `gem_details` flag.
 
-* use the `safe_reload_files` feature to add the path of all gem files you wish to track
-* --- or ---
-* ensure you call `require 'coverband'` which triggers `Coverband.start` before loading all your gems
-   * while possible this is currently hard as Rails and most environments load your whole Gemfile
-   * we are looking for an improve and easier way to support this.
+```
+Coverband.configure do |config|
+  config.track_gems = true
+  config.gem_details = true
+end
+```
 
+This flag exposes line by line usage of gem files. Unfortunately due to the way the coverband report is currently rendered, enabling `gem_details` slows down viewing of the coverage report in the browser and is not yet recommended.
 
 ### Verbose Debug / Development Mode
 

data/Rakefile

@@ -13,7 +13,7 @@ Rake::TestTask.new(:test) do |test|
   # exclude benchmark from the tests as the way it functions resets code coverage during executions
   # test.pattern = 'test/unit/*_test.rb'
   # using test files opposed to pattern as it outputs which files are run
-  test.test_files = FileList['test/unit/**/*_test.rb']
+  test.test_files = FileList['test/**/*_test.rb']
   test.verbose = true
 end
 

data/changes.md

@@ -65,20 +65,41 @@ Feature Ideas:
 
 ### Coverband 4.2.0.alpha
 
-- pilot release of Gems tracking
+???
+
+### Coverband 4.1.0.beta
+
+- default disabled web clear, add config option to allow it
+- out of the box support for resque
+- readme improvements
+- fix on regression of merging directory changing deployments
+  - fixes for duplicate root paths 
+- pilot release of Gems tracking (disabled by default)
 	- todos
 	  - support multiple gem paths (various version managers setup multiple gem paths)
 	  - speed up page load by allowing multiple pages
-- web settings and debug views
-	 - todo improve these views  
+- added web settings and debug views
+   - added support for seeing coverage data size consumed in redis 
+- support coverage data migrations from 4.0.x to 4.1.0
+- fixes for heroku /tmp asset building
+
+# Released
 
-### Coverband 4.1.0.alpha
+### Coverband 4.1.0
 
 - default disabled web clear, add config option to allow it
 - out of the box support for resque
 - readme improvements
-
-# Released
+- fix on regression of merging directory changing deployments
+  - fixes for duplicate root paths 
+- pilot release of Gems tracking (disabled by default)
+	- todos
+	  - support multiple gem paths (various version managers setup multiple gem paths)
+	  - speed up page load by allowing multiple pages
+- added web settings and debug views
+   - added support for seeing coverage data size consumed in redis 
+- support coverage data migrations from 4.0.x to 4.1.0
+- fixes for heroku /tmp asset building
 
 ### Coverband 4.0.1
 
@@ -88,7 +109,7 @@ Feature Ideas:
 - reduced the S3 dependencies to minimal set (not loading all of aws-sdk, only aws-sdk-s3), ensured they are optional
 - Improved Coverband web admin
 - Coverage reports include timestamps of Coverage collection
-- Added Coveralls to the dev process thanks @dondonz 
+- Added Coveralls to the dev process thanks @dondonz
 - now tested under Ruby 2.6.0 thanks @Kbaum
 - improved full stack testing for Rails 5 & 4
 - warning before clear coverage on coverband web

data/coverband.gemspec

@@ -42,6 +42,8 @@ Gem::Specification.new do |spec|
   # require 'byebug'; byebug
   spec.add_development_dependency 'pry-byebug'
 
+  spec.add_development_dependency 'minitest-profile'
+
   # TODO: Remove when other production adapters exist
   # because the default configuration of redis store, we really do require
   # redis now. I was reluctant to add this, but until we offer another production

data/lib/coverband.rb

@@ -7,6 +7,7 @@ require 'redis'
 require 'coverband/version'
 require 'coverband/at_exit'
 require 'coverband/configuration'
+require 'coverband/utils/file_path_helper'
 require 'coverband/adapters/base'
 require 'coverband/adapters/redis_store'
 require 'coverband/adapters/file_store'
@@ -49,6 +50,10 @@ module Coverband
     end
   end
 
+  def self.report_coverage(force_report = false)
+    Coverband::Collectors::Coverage.instance.report_coverage(force_report)
+  end
+
   def self.configuration
     self.configuration_data ||= Configuration.new
   end

data/lib/coverband/adapters/base.rb

@@ -3,6 +3,8 @@
 module Coverband
   module Adapters
     class Base
+      include Coverband::Utils::FilePathHelper
+
       def initialize
         @file_hash_cache = {}
       end
@@ -11,13 +13,25 @@ module Coverband
         raise 'abstract'
       end
 
+      def migrate!
+        raise 'abstract'
+      end
+
+      def size
+        raise 'abstract'
+      end
+
+      def size_in_mib
+        format('%.2f', (size.to_f / 2**20))
+      end
+
       # Note: This could lead to slight race on redis
       # where multiple processes pull the old coverage and add to it then push
       # the Coverband 2 had the same issue,
       # and the tradeoff has always been acceptable
       def save_report(report)
         data = report.dup
-        merge_reports(data, get_report)
+        data = merge_reports(data, get_report)
         save_coverage(data)
       end
 
@@ -49,6 +63,7 @@ module Coverband
       end
 
       def expand_report(report)
+        expanded = {}
         report_time = Time.now.to_i
         report.each_pair do |key, line_data|
           extended_data = {
@@ -57,12 +72,13 @@ module Coverband
             'file_hash' => file_hash(key),
             'data' => line_data
           }
-          report[key] = extended_data
+          expanded[full_path_to_relative(key)] = extended_data
         end
+        expanded
       end
 
-      def merge_reports(new_report, old_report)
-        new_report = expand_report(new_report)
+      def merge_reports(new_report, old_report, options = {})
+        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] &&

data/lib/coverband/adapters/file_store.rb

@@ -20,6 +20,14 @@ module Coverband
         File.delete(path) if File.exist?(path)
       end
 
+      def size
+        File.size?(path).to_i
+      end
+
+      def migrate!
+        raise NotImplementedError, "FileStore doesn't support migrations"
+      end
+
       private
 
       attr_accessor :path

data/lib/coverband/adapters/redis_store.rb

@@ -11,25 +11,56 @@ 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 = 'coverband3_1'
+      REDIS_STORAGE_FORMAT_VERSION = 'coverband_3_2'
 
       def initialize(redis, opts = {})
         super()
         @redis           = redis
         @ttl             = opts[:ttl]
         @redis_namespace = opts[:redis_namespace]
+        @format_version  = REDIS_STORAGE_FORMAT_VERSION
       end
 
       def clear!
         @redis.del(base_key)
       end
 
+      def size
+        @redis.get(base_key).bytesize
+      end
+
+      ###
+      # Current implementation moves from coverband3_1 to coverband_3_2
+      # In the future this can be made more general and support a more specific
+      # version format.
+      ###
+      def migrate!
+        reset_base_key
+        @format_version = 'coverband3_1'
+        previous_data = get_report
+        if previous_data.empty?
+          puts 'no previous data to migrate found'
+          exit 0
+        end
+        relative_path_report = previous_data.each_with_object({}) do |(key, vals), fixed_report|
+          fixed_report[full_path_to_relative(key)] = vals
+        end
+        clear!
+        reset_base_key
+        @format_version = REDIS_STORAGE_FORMAT_VERSION
+        save_coverage(merge_reports(get_report, relative_path_report, skip_expansion: true))
+      end
+
       private
 
       attr_reader :redis
 
+      def reset_base_key
+        @base_key = nil
+      end
+
       def base_key
-        @base_key ||= [REDIS_STORAGE_FORMAT_VERSION, @redis_namespace].compact.join('.')
+        @base_key ||= [@format_version, @redis_namespace].compact.join('.')
       end
 
       def save_coverage(data)

data/lib/coverband/at_exit.rb

@@ -11,7 +11,7 @@ module Coverband
         @at_exit_registered = true
         at_exit do
           ::Coverband::Background.stop
-          Coverband::Collectors::Coverage.instance.report_coverage(true)
+          Coverband.report_coverage(true)
           Coverband.configuration.logger&.debug('Coverband: Reported coverage before exit')
         end
       end

data/lib/coverband/collectors/coverage.rb

@@ -87,7 +87,17 @@ module Coverband
       end
 
       def array_diff(latest, original)
-        latest.map.with_index { |v, i| (v && original[i]) ? v - original[i] : nil }
+        latest.map.with_index do |v, i|
+           if (v && original[i])
+              if v >= original[i]
+                v - original[i]
+              else
+                0
+              end
+           else
+            nil
+           end
+         end
       end
 
       def previous_results

data/lib/coverband/configuration.rb

@@ -20,7 +20,10 @@ module Coverband
     def reset
       @root = Dir.pwd
       @root_paths = []
-      @ignore = %w[vendor .erb$ .slim$]
+      # Heroku when building assets runs code from a dynamic directory
+      # /tmp was added to avoid coverage from /tmp/build directories during
+      # heroku asset compilation
+      @ignore = %w[vendor .erb$ .slim$ /tmp]
       @additional_files = []
       @reporting_frequency = 0.0
       @verbose = false
@@ -87,6 +90,8 @@ module Coverband
       # by default we ignore vendor where many deployments put gems
       # we will remove this default if track_gems is set
       @ignore.delete('vendor')
+      # while we want to allow vendored gems we don't want to track vendored ruby STDLIB
+      @ignore << 'vendor/ruby-*'
       add_group('App', root)
       # TODO: rework support for multiple gem paths
       # currently this supports GEM_HOME (which should be first path)
@@ -119,7 +124,18 @@ module Coverband
       Gem::PathSupport.new(ENV).path.select { |path| File.exist?(path) }
     end
 
-    SKIPPED_SETTINGS = %w[@s3_secret_access_key @store]
+    def current_root
+      File.expand_path(Coverband.configuration.root)
+    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
+    end
+
+    SKIPPED_SETTINGS = %w(@s3_secret_access_key @store)
     def to_h
       instance_variables
         .each_with_object('gem_paths': gem_paths) do |var, hash|

data/lib/coverband/integrations/background.rb

@@ -5,6 +5,7 @@ module Coverband
     @semaphore = Mutex.new
 
     def self.stop
+      return unless @thread
       @semaphore.synchronize do
         if @thread
           @thread.exit
@@ -13,6 +14,10 @@ module Coverband
       end
     end
 
+    def self.running?
+      !!@thread
+    end
+
     def self.start
       return if @thread
 
@@ -23,7 +28,7 @@ module Coverband
         sleep_seconds = Coverband.configuration.background_reporting_sleep_seconds
         @thread = Thread.new do
           loop do
-            Coverband::Collectors::Coverage.instance.report_coverage(true)
+            Coverband.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,15 +4,20 @@ 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::Collectors::Coverage.instance.report_coverage(true)
+      Coverband.report_coverage(true)
     end
   end
 end
 
 Resque::Job.prepend(Coverband::ResqueWorker)
-

data/lib/coverband/reporters/base.rb

@@ -8,8 +8,10 @@ module Coverband
     ###
     class Base
       class << self
+        include Coverband::Utils::FilePathHelper
         def report(store, _options = {})
-          scov_style_report = get_current_scov_data_imp(store, root_paths)
+          all_roots = Coverband.configuration.all_root_paths
+          scov_style_report = get_current_scov_data_imp(store, all_roots)
 
           if Coverband.configuration.verbose
             msg = "report:\n #{scov_style_report.inspect}"
@@ -20,17 +22,6 @@ 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(', ')}"
@@ -38,9 +29,11 @@ module Coverband
 
           # normalize names across servers
           report_hash.each_with_object({}) do |(key, vals), fixed_report|
-            filename = filename_from_key(key, roots)
-            fixed_report[filename] = if fixed_report.key?(filename)
-                                       merge_arrays(fixed_report[filename], vals)
+            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
                                      else
                                        vals
                                      end
@@ -62,33 +55,10 @@ 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
         ###