coverband 2.0.1 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a3885791f4771973082ff809237d3a15a7f397ed
-  data.tar.gz: 158d669d609287e94b50b12d71811ca3252d80ee
+  metadata.gz: d053a25d6140b3254fe2d2f1afa6a92fc06f0d3e
+  data.tar.gz: 069d15a21f7c2909fcdcb7a2f955fecc2daef168
 SHA512:
-  metadata.gz: c252116c4add56d46c26662dbebf90d03ba40de023dbb67250f69c92a72037f7a8c0d3e2a4a075f365f2f6c4be5306d1fe0a2328e03d684be615d3d2a922272c
-  data.tar.gz: 51988a04b8b22d8181beeaf209bf320c9bdfd042e427de59b9caa8902f3f9792569451454489961c290105a67e2e0e40efcc2684d10aabaea6114c3e41ae8215
+  metadata.gz: 8b4dfdbe5797949ab92ac9ec869f4fb4776162b0c681427436733fa4bbc4bdf4bf02be159559e8e1baf613704ecc8044256cd21e8dca3d6f3f575be00e7908f7
+  data.tar.gz: de454d222f4545cd6db08d9043fe97a1d5aa71aa339c5c0b9b6cd5694d252cb344fca4183a6cb55c30e052a709ff251de9ebeb2d1e2c79d2572594faa3e1411f

data/.gitignore

@@ -18,4 +18,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-.byebug_history
+.byebug_history
+.env

data/README.md

@@ -4,11 +4,13 @@ Build Status: [![Build Status](https://travis-ci.org/danmayer/coverband.svg?bran
 
 <p align="center">
   <a href="#key-features">Key Features</a> •
+  <a href="#coverband-demo">Coverband Demo</a> •
   <a href="#how-to-use">How To Use</a> •
   <a href="#installation">Installation</a> •
   <a href="#configuration">Configuration</a> •
   <a href="#usage">Usage</a> •
-  <a href="#license">License</a>
+  <a href="#license">License</a> •
+  <a href="/changes.md">Change Log / Roadmap</a>
 </p>
 
 A gem to measure production code usage, showing each line of code that is executed. Coverband allows easy configuration to collect and report on production code usage. It can be used as Rack middleware, wrapping a block with sampling, or manually configured to meet any need (like usage during background jobs).
@@ -17,24 +19,31 @@ Note: Coverband is not intended for test code coverage, for that just check out
 
 ## Key Features
 
-* Allows sampling to avoid the performance overhead on every request.
+The primary goal of Coverband is giving deep insight into your production runtime usage of your application code, while having the least impact on performance possible.
+
+* Low performance overhead
+* Various controls from sampling, data collection rate, etc to further control performance
 * Ignore directories to avoid overhead data collection on vendor, lib, etc.
-* Take a baseline to get initial app execution during app initialization. (the baseline is important because some code is executed during app load, but might not be invoked during any requests, think prefetching, initial cache builds, setting constants, etc...)
-* Development mode for additional code usage details (number of LOC execution during single request, etc).
+* Development mode, offers deep insight of code usage details (number of LOC execution during single request, etc) during development.
+* Easy setup for any Ruby Rack based web framework (Rails, Sinatra, etc)
+* Allows for integration with any other Ruby application flows (background jobs, crons, scripts)
+
+## Coverband Demo
+
+Take Coverband for a spin on the live Heroku deployed [Coverband Demo](https://coverband-demo.herokuapp.com/). The [full source code for the demo](https://github.com/danmayer/coverband_demo) is available to help with configuration and understanding of basic usage.
 
 # How To Use
 
 Below is my Coverband workflow, which hopefully will help other best use this library.
 
-* install coverband.
-* take baseline measurment: `rake coverband:baseline` (__note: never run baseline on production__)
-* validate baseline with  `rake coverband:coverage`
+* install coverband
+* start your app and hit a few endpoints
+* validate data collection and code coverage with  `rake coverband:coverage`
 * test setup in development (hit endpoints and generate new report)
 * deploy to staging and verify functionality
 * deploy to production and verify functionality
-* every 2 weeks or with major releases
+* every 2 weeks or so, with major releases
    * clear old coverage: `rake coverband:clear`
-   * take new baseline: `rake coverband:baseline`
    * deploy and verify coverage is matching expectations
 * __COVERAGE DRIFT__
    * if you never clear you have lines of code drift from when they were recorded
@@ -138,8 +147,7 @@ require 'coverband/tasks'
 This should give you access to a number of Coverband tasks
 
 ```bash
-bundle exec rake -T coverband
-rake coverband:baseline      # record coverband coverage baseline
+rake -T coverband
 rake coverband:clear         # reset coverband coverage data
 rake coverband:coverage      # report runtime coverband code coverage
 ```
@@ -194,10 +202,10 @@ run ActionController::Dispatcher.new
 
 # Verify Correct Installation
 
-* Gather baseline metrics: run `bundle exec rake coverband:baseline` (__note: never run baseline on production__)
-* run `bundle exec rake coverband:coverage` this will show app initialization coverage
+* boot up your application
+* run `rake coverband:coverage` this will show app initialization coverage
 * run app and hit a controller (hit at least +1 time over your `config.startup_delay` setting default is 0)
-* run `bundle exec rake coverband:coverage` and you should see coverage increasing for the endpoints you hit.
+* run `rake coverband:coverage` and you should see coverage increasing for the endpoints you hit.
 
 ## Installation Script
 
@@ -220,7 +228,7 @@ bundle install
 
 # Make some code so we can look at the coverage
 rails generate scaffold blogs
-bundle exec rake db:migrate
+rake db:migrate
 
 # open Rakefile, add lines
 require 'coverband'
@@ -233,10 +241,9 @@ rake -T coverband
 # configure config/application.rb
 # copy lines from readme
 
-
-rake coverband:baseline
+# start up your app
 rake coverband:coverage
-# view baseline coverage
+# view boot up coverage
 
 rails s
 
@@ -256,68 +263,14 @@ rake coverband:coverage
 - [Sinatra app](https://github.com/danmayer/churn-site)
 - [Non Rack Ruby app](https://github.com/danmayer/coverband_examples)
 
-### Coverband Baseline
-
-__TLDR:__ Baseline is app initialization coverage, not captured during runtime.
-
-Before starting a service verify your baseline by running `rake coverband:baseline` followed by `rake coverband:coverage` to view what your baseline coverage looks like before any runtime traffic has been recorded.
-
-The baseline seems to cause some confusion. Basically, when Coverband records code usage, it will not request initial startup code like method definition, it covers what it hit during run time. This would produce a fairly odd view of code usage. To cover things like defining routes, dynamic methods, and the like Coverband records a baseline. The baseline should capture coverage of app initialization and boot up, we don't want to do this on deploy as it can be slow. So we take a recording of boot up as a one time baseline Rake task `bundle exec rake coverband:baseline`.
-
-1. Start your server with `rails s` or `rackup config.ru`.
-2. Hit your development server exercising the endpoints you want to verify Coverband is recording (you should see debug outputs in your server console)
-3. Run `rake coverband:coverage` again, previously it should have only shown the baseline data of your app initializing. After using it in development it should show increased coverage from the actions you have exercised.
-
-Note: if you use `rails s` and data isn't recorded, make sure it is using your `config.ru`.
-
-### Baseline Missing data
-
-The default Coverband baseline task will try to detect your app as either Rack or Rails environment. It will load the app to take a baseline reading. The baseline coverage is important because some code is executed during app load, but might not be invoked during any requests, think prefetching, initial cache builds, setting constants, etc. If the baseline task doesn't load your app well you can override the default baseline to create a better baseline yourself. Below for example is how I take a baseline on a pretty simple Sinatra app.
-
-```ruby
-namespace :coverband do
-  desc "get coverage baseline"
-  task :baseline_app do
-    Coverband::Reporter.baseline {
-      require 'sinatra'
-      require './app.rb'
-    }
-  end
-end
-```
-
 ### View Coverage
 
 You can view the report different ways, but the easiest is the Rake task which opens the SimpleCov formatted HTML.
 
-`bundle exec rake coverband:coverage`
+`rake coverband:coverage`
 
 This should auto-open in your browser, but if it doesn't the output file should be in `coverage/index.html`
 
-### Conflicting .Simplecov: Issue with Missing or 0% Coverage Report
-
-If you use SimpleCov to generate code coverage for your tests. You might have setup a `.simplecov` file to help control and focus it's output. Often the settings you want for your test's code coverage report are different than what you want Coverband to be reporting on. Since Coverband uses the SimpleCov HTML formatter to prepare it's report.
-
-So if you had something like this in a `.simplecov` file in the root of your project, as reported in [issue 83](https://github.com/danmayer/coverband/issues/83)
-
-```
-require 'simplecov'
-
-SimpleCov.start do
-  add_filter 'app/admin'
-  add_filter '/spec/'
-  add_filter '/config/'
-  add_filter '/vendor/'
-  add_filter 'userevents'
-end
-```
-
-You could see some confusing results... To avoid this issue Coverband has a Rake task that will ignore all Simplecov filters.
-
-`rake coverband:coverage_no_filters`
-
-This will build the report after disabling any `.simplecov` applied settings.
-
 ### Clear Coverage
 
 If your code has changed and your coverage line data doesn't seem to match run time. You probably need to clear your old line data... You will need to run this in the environment you wish to clear the data from.
@@ -525,7 +478,7 @@ Beyond writing to S3 you can host the S3 file with a build in Sintatra app in Co
 ```
 Rails.application.routes.draw do
   # ... lots of routes
-  mount Coverband::S3Web, at: '/coverage'
+  mount Coverband::Reporters::Web.new, at: '/coverage'
 end
 ```
 
@@ -554,11 +507,35 @@ end
 Rails.application.routes.draw do
   # ... lots of routes
   constraints basic_constraint do
-    mount Coverband::S3Web, at: '/coverage'
+    mount Coverband::Reporters::Web.new, at: '/coverage'
   end
 end
 ```
 
+### Conflicting .Simplecov: Issue with Missing or 0% Coverage Report
+
+If you use SimpleCov to generate code coverage for your tests. You might have setup a `.simplecov` file to help control and focus it's output. Often the settings you want for your test's code coverage report are different than what you want Coverband to be reporting on. Since Coverband uses the SimpleCov HTML formatter to prepare it's report.
+
+So if you had something like this in a `.simplecov` file in the root of your project, as reported in [issue 83](https://github.com/danmayer/coverband/issues/83)
+
+```
+require 'simplecov'
+
+SimpleCov.start do
+  add_filter 'app/admin'
+  add_filter '/spec/'
+  add_filter '/config/'
+  add_filter '/vendor/'
+  add_filter 'userevents'
+end
+```
+
+You could see some confusing results... To avoid this issue Coverband has a Rake task that will ignore all Simplecov filters.
+
+`rake coverband:coverage_no_filters`
+
+This will build the report after disabling any `.simplecov` applied settings.
+
 # Contributing To Coverband
 
 If you are working on adding features, PRs, or bugfixes to Coverband this section should help get you going.
@@ -567,24 +544,24 @@ If you are working on adding features, PRs, or bugfixes to Coverband this sectio
 2. Create your feature branch (`git checkout -b my-new-feature`)
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
-5. Make sure all tests are passing (run `bundle install`, make sure Redis is running, and then execute `bundle exec rake test`)
+5. Make sure all tests are passing (run `bundle install`, make sure Redis is running, and then execute `rake test`)
 6. Create new Pull Request
 
 ### Tests & Benchmarks
 
 If you submit a change please make sure the tests and benchmarks are passing.
 
-* run tests: `bundle exec rake`
+* run tests: `rake`
 * view test coverage: `open coverage/index.html`
 * run the benchmarks before and after your change to see impact
-   * `bundle exec rake benchmarks` 
+   * `rake benchmarks` 
 
 ### Known Issues
 
 * __total fail__ on front end code, because of the precompiled template step basically coverage doesn't work well for `erb`, `slim`, and the like.
   * related it will try to report something, but the line numbers reported for `ERB` files are often off and aren't considered useful. I recommend filtering out .erb using the `config.ignore` option. 
 * If you have SimpleCov filters, you need to clear them prior to generating your coverage report. As the filters will be applied to Coverband as well and can often filter out everything we are recording.
-* coverage doesn't show for Rails `config/application.rb` or `config/boot.rb` as they get loaded when loading the Rake environment prior to starting to record the baseline.
+* coverage doesn't show for Rails `config/application.rb` or `config/boot.rb` as they get loaded when loading the Rake environment prior to starting the `Coverage` library.
 
 ### Debugging Redis Store
 
@@ -655,20 +632,19 @@ Similar format to redis store, but array with integer values
 
 ### Todo
 
-* Sinatra App with admin controls
+* add articles / podcasts like prontos readme https://github.com/prontolabs/pronto
 * graphite adapters (it would allow passing in date ranges on usage)
 * perf test for array vs hash
 * redis pipeline around hash (or batch get then push)
-* pass in namespace to redis (coverage vs baseline)
-* what about having baseline a onetime recording into redis no merge later
 * move to SimpleCov console out, or make similar console tabular output
-* Fix network performance by logging to files that purge later (like NR) (far more time lost in TracePoint than sending files, hence not a high priority, but would be cool)
+* Improve network performance by logging to files that purge later (like NR) (far more time lost in TracePoint than sending files, hence not a high priority, but would be cool)
 * Add support for [zadd](http://redis.io/topics/data-types-intro) so one could determine single call versus multiple calls on a line, letting us determine the most executed code in production.
 * Possibly add ability to record code run for a given route
+* integrate recording with deploy tag or deploy timestamp
+   *  diff code usage across deployed versions 
 * Improve client code api, around manual usage of sampling (like event usage)
 * ability to change the Coverband config at runtime by changing the config pushed to the Redis hash. In memory cache around the changes to only make that call periodically.
 * Opposed to just showing code usage on a route allow 'tagging' events which would record line coverage for that tag (this would allow tagging all code that modified an ActiveRecord model for example
-* mountable rack app to view coverage similar to flipper-ui
 * support runner, active job, etc without needed extra config (improved railtie integration)
 
 # Resources

data/Rakefile

@@ -19,3 +19,10 @@ desc 'load irb with this gem'
 task :console do
   exec 'irb -I lib -r coverband'
 end
+
+# This is really just for testing and development because without configuration
+# Coverband can't do much
+desc 'start webserver'
+task :server do
+  exec 'rackup -I lib'
+end

data/changes.md

@@ -14,17 +14,33 @@ Will be the fully modern release that drops maintenance legacy support in favor
    * built in support for activejob, sidekiq, and other common frameworks
 * code route tracing (entry point to all code executed for example /some_path -> code coverage of that path)
 
+# Alpha
+
+### ???
+
+
 # Released
 
+### 2.0.2
+
+* fix possible nil error on files that changed since initial recording @viktor-silakov
+* add improve error logging in verbose mode (stacktrace) @viktor-silakov
+* improved logging level support @viktor-silakov
+* launch Coverband demo and integrate into Readme / Documentation
+* fix on baseline to show an issue by @viktor-silakov
+* remove all coverband:baseline related features and documentation
+* dropped Sinatra requirement for web mountable page
+* fixes to the MemoryCacheStore by @kbaum
+
 ### 2.0.1
 
 * add support for fine grained S3 configuration via Coverband config, thanks @a0s
-  * https://github.com/danmayer/coverband/pull/98 
+  * https://github.com/danmayer/coverband/pull/98
 * Using the file argument to self.configure in lib/coverband.rb, thanks @ThomasOwens
   * https://github.com/danmayer/coverband/pull/100
-* added redis improvements allowing namespace and TTL thx @oded-zahavi 
-* fix warnings about duplicate method definition 
-* Add support for safe_reload_files based on full file path 
+* added redis improvements allowing namespace and TTL thx @oded-zahavi
+* fix warnings about duplicate method definition
+* Add support for safe_reload_files based on full file path
 * Add support for Sinatra admin control endpoints
 * improved documentation
 

data/config.ru

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require ::File.expand_path('../lib/coverband', __FILE__)
+run Coverband::Reporters::Web.new

data/coverband.gemspec

@@ -26,7 +26,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rack'
   spec.add_development_dependency 'rack-test'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'sinatra'
   spec.add_development_dependency 'test-unit'
   spec.add_development_dependency 'redis'
   spec.add_development_dependency 'benchmark-ips'

data/lib/coverband/adapters/memory_cache_store.rb

@@ -9,16 +9,18 @@ module Coverband
     class MemoryCacheStore < Base
       attr_accessor :store
 
+      @@files_cache = {}
+
       def initialize(store)
         @store = store
       end
 
-      def self.reset!
-        files_cache.clear
+      def self.clear!
+        @@files_cache.clear
       end
 
       def clear!
-        self.class.reset!
+        self.class.clear!
       end
 
       def save_report(files)
@@ -26,28 +28,26 @@ module Coverband
         store.save_report(filtered_files) if filtered_files.any?
       end
 
-      # rubocop:disable Lint/IneffectiveAccessModifier
       private
 
-      def self.files_cache
-        @files_cache ||= {}
-      end
-
       def files_cache
-        self.class.files_cache
+        @@files_cache
       end
 
       def filter(files)
-        files.each_with_object({}) do |(file, lines), filtered_file_hash|
-          # first time we see a file, we pre-init the in memory cache to whatever is in store(redis)
-          line_cache = files_cache[file] ||= Set.new(store.covered_lines_for_file(file))
-          lines.reject! do |line|
-            line_cache.include?(line) ? true : (line_cache << line && false)
+        files.each_with_object({}) do |(file, covered_lines), filtered_file_hash|
+          if covered_lines != cached_file(file)
+            files_cache[file] = covered_lines
+            filtered_file_hash[file] = covered_lines
           end
-          filtered_file_hash[file] = lines if lines.any?
         end
       end
-      # rubocop:enable Lint/IneffectiveAccessModifier
+
+      def cached_file(file)
+        files_cache[file]  ||= store.covered_lines_for_file(file).each_with_object({}) do |(line_number, value), hash|
+          hash[line_number.to_i] = value.to_i
+        end
+      end
     end
   end
 end

data/lib/coverband/collectors/base.rb

@@ -87,7 +87,7 @@ module Coverband
       end
 
       def output_file_line_usage
-        @logger.info 'coverband debug coverband file:line usage:'
+        @logger.debug 'coverband debug coverband file:line usage:'
         @file_line_usage.sort_by { |_key, value| value.length }.each do |pair|
           file = pair.first
           lines = pair.last

data/lib/coverband/collectors/coverage.rb

@@ -18,7 +18,7 @@ module Coverband
         end
 
         if failed_recently?
-          @logger.info 'coverage reporting standing-by because of recent failure' if @verbose
+          @logger.error 'coverage reporting standing-by because of recent failure' if @verbose
           return
         end
 
@@ -31,7 +31,7 @@ module Coverband
         end
 
         if @verbose
-          @logger.info "coverband file usage: #{file_usage.inspect}"
+          @logger.debug "coverband file usage: #{file_usage.inspect}"
           output_file_line_usage if @verbose == 'debug'
         end
 
@@ -39,8 +39,8 @@ module Coverband
           @store.save_report(@file_line_usage)
           @file_line_usage.clear
         elsif @verbose
-          @logger.info 'coverage report: '
-          @logger.info @file_line_usage.inspect
+          @logger.debug 'coverage report: '
+          @logger.debug @file_line_usage.inspect
         end
       # StandardError might be better option
       # coverband previously had RuntimeError here
@@ -49,15 +49,16 @@ module Coverband
       rescue StandardError => err
         failed!
         if @verbose
-          @logger.info 'coverage missing'
-          @logger.info "error: #{err.inspect} #{err.message}"
+          @logger.error 'coverage missing'
+          @logger.error "error: #{err.inspect} #{err.message}"
+          @logger.error err.backtrace
         end
       end
 
       private
 
       def array_diff(latest, original)
-        latest.map.with_index { |v, i| v ? v - original[i] : nil }
+        latest.map.with_index { |v, i| (v && original[i]) ? v - original[i] : nil }
       end
 
       def previous_results

data/lib/coverband/collectors/trace.rb

@@ -2,8 +2,16 @@
 
 module Coverband
   module Collectors
+    ###
+    # NOTE: While this still works it is slower than Coverage.
+    # I recommend using the Coverage adapter.
+    # As baseline is removed the Trace collector also doesn't have a good way
+    # to collect initial code usage during app boot up.
+    #
+    # I am leaving Trace around as I believe there are some interesting use cases
+    # also, it illustrates an alternative collector, and I have some others I would like to implement
+    ###
     class Trace < Base
-
       def reset_instance
         super
         @tracer_set = false
@@ -21,8 +29,9 @@ module Coverband
       rescue RuntimeError => err
         failed!
         if @verbose
-          @logger.info 'error stating recording coverage'
-          @logger.info "error: #{err.inspect} #{err.message}"
+          @logger.error 'error stating recording coverage'
+          @logger.error "error: #{err.inspect} #{err.message}"
+          @logger.error err.backtrace
         end
       end
 
@@ -39,12 +48,12 @@ module Coverband
         unset_tracer
 
         if failed_recently?
-          @logger.info 'coverage reporting standing-by because of recent failure' if @verbose
+          @logger.error 'coverage reporting standing-by because of recent failure' if @verbose
           return
         end
 
         if @verbose
-          @logger.info "coverband file usage: #{file_usage.inspect}"
+          @logger.debug "coverband file usage: #{file_usage.inspect}"
           output_file_line_usage if @verbose == 'debug'
         end
 
@@ -58,8 +67,9 @@ module Coverband
       rescue RuntimeError => err
         failed!
         if @verbose
-          @logger.info 'coverage missing'
-          @logger.info "error: #{err.inspect} #{err.message}"
+          @logger.error 'coverage missing'
+          @logger.error "error: #{err.inspect} #{err.message}"
+          @logger.error err.backtrace
         end
       end
 

data/lib/coverband/configuration.rb

@@ -71,7 +71,7 @@ module Coverband
         @store = Coverband::Adapters::RedisStore.new(redis, ttl: Coverband.configuration.redis_ttl,
                                                             redis_namespace: Coverband.configuration.redis_namespace)
       elsif store.is_a?(String)
-        @store = Coverband::Adapters::FileStore.new(coverage_file)
+        @store = Coverband::Adapters::FileStore.new(store)
       end
     end
   end

data/lib/coverband/reporters/base.rb

@@ -9,13 +9,13 @@ module Coverband
 
         if Coverband.configuration.verbose
           Coverband.configuration.logger.info "fixing root: #{roots.join(', ')}"
-          Coverband.configuration.logger.info "additional data:\n #{additional_coverage_data}"
+          Coverband.configuration.logger.debug "additional data:\n #{additional_coverage_data}"
         end
 
         scov_style_report = report_scov_with_additional_data(store, additional_coverage_data, roots)
 
         if Coverband.configuration.verbose
-          Coverband.configuration.logger.info "report:\n #{scov_style_report.inspect}"
+          Coverband.configuration.logger.debug "report:\n #{scov_style_report.inspect}"
         end
         scov_style_report
       end