coverband 5.0.0.rc.6 → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c21f1b570030f2e8d3199ce170a95d24e2191cb36e3675e63f8d0d226b798a87
-  data.tar.gz: 9f7788c6545f9cdc9bd4939aae262c71a11bd6efda81adaf08b15adfc3df8fa4
+  metadata.gz: 2869a30161428e6236dee380660fe39797c6fd6029225c4987d8de79cfce9019
+  data.tar.gz: 43f2998da3c1735f452c71aaf93179d714933e4f7da11d420477155a8427ab85
 SHA512:
-  metadata.gz: '032594e2650af6ad12a8602ac1a610f6e5d3307d0a9ae3b1bf780537be45d919af2508bc9e5a87da53ac9bd0dd7b59949d83723a91c84616fbb516cbb490296a'
-  data.tar.gz: 281798ba980ecfc48d9f41553d5fe3da646480eb050fbb4c67c901d32eae9f017cd7567bbfad0d44a812dbcf32b0458cd829c9ae4218429c175ddbcc62abdaa0
+  metadata.gz: d083c07eb9c101e87f19902b9f7c531e4f06f7b7f8421912f77cd25d74340f1f6824d97059d410711b092a36e5a52dc01afa1ea30af714331fb3bdc905ac4ce7
+  data.tar.gz: e1fd6726954fdb473fc21570207923942953faa3360ca4dfea9a6fb825fbb42fef77e3b593469f5a28e42f9a1e7115f96815822405ad26d34c113f364aa8ee69

data/README.md

@@ -10,7 +10,7 @@
 <p align="center">
   <a href="#key-features">Key Features</a> •
   <a href="#installation">Installation</a> •
-  <a href="#coverage-report">Coverage Report</a> •
+  <a href="#coverband-web-ui">Coverband Web UI</a> •
   <a href="#advanced-config">Advanced Config</a> •
   <a href="#license">License</a> •
   <a href="/changes.md">Change Log / Roadmap</a> •
@@ -28,7 +28,7 @@ The primary goal of Coverband is giving deep insight into your production runtim
 - Low performance overhead
 - Simple setup and configuration
 - Out of the box support for all standard code execution paths (web, cron, background jobs, rake tasks, etc)
-- Splits load time (Rails eager load) and Run time metrics
+- Splits load time (Rails eager load) and runtime metrics
 - Easy to understand actionable insights from the report
 - Development mode, offers deep insight of code usage details (number of LOC execution during single request, etc) during development.
 - Mountable web interface to easily share reports
@@ -41,7 +41,7 @@ Coverband stores coverage data in Redis. The Redis endpoint is looked for in thi
 
 1. `ENV['COVERBAND_REDIS_URL']`
 2. `ENV['REDIS_URL']`
-3. `localhost`
+3. `localhost:6379`
 
 The redis store can also be explicitly defined within the coverband.rb. See [advanced config](#advanced-config).
 
@@ -53,8 +53,6 @@ Add this line to your application's `Gemfile`, remember to `bundle install` afte
 gem 'coverband'
 ```
 
-## Upgrading to Latest
-
 ### No custom code or middleware required
 
 With older versions of coverband, projects would report to redis using rack or sidekiq middleware. After coverband 4.0, this should no longer be required and could cause performance issues. Reporting to redis is now automatically done within a background thread with no custom code needed.
@@ -67,7 +65,7 @@ The Railtie integration means you shouldn't need to do anything else other than
 
 ## Sinatra
 
-For the best coverage you want this loaded as early as possible. I have been putting it directly in my `config.ru` but you could use an initializer, though you may end up missing some boot up coverage. To start collection require Coverband as early as possible.
+For the best coverage you want this loaded as early as possible. We recommend requiring cover band directly in the `config.ru`.  Requiring coverband within an initializer could also work, but you may end up missing some boot up coverage. To start collection require Coverband as early as possible.
 
 ```ruby
 require 'coverband'
@@ -77,7 +75,33 @@ use Coverband::BackgroundMiddleware
 run ActionController::Dispatcher.new
 ```
 
-# Coverage Report
+## Coverband Web UI
+
+![image](https://raw.github.com/danmayer/coverband/master/docs/coverband_web_ui.png)
+
+> The web index as available on the [Coverband Demo site](https://coverband-demo.herokuapp.com/coverage?#_Coverage)
+
+- View overall coverage information
+
+- Drill into individual file coverage
+
+- View individual file details
+
+- Clear Coverage - disabled by default as it could be considered a dangerous operation in production. Enable with `config.web_enable_clear` or leave off and clear from [rake task](#clear-coverage).
+
+  - Clear coverage report
+
+    This will clear the coverage data. This wipes out all collected data. 
+
+  - Clear individual file coverage
+
+    This will clear the details of the file you are looking at. This is helpful if you don't want to lose all Coverage data but made a change that you expect would impact a particular file.
+
+- Force coverage collection
+
+  This triggers coverage collection on the current webserver process. Useful in development but confusing in production environments where many ruby processes are usually running.
+
+### Mounting as a Rack App
 
 Coverband comes with a mountable rack app for viewing reports. For Rails this can be done in `config/routes.rb` with:
 
@@ -97,49 +121,23 @@ Rails.application.routes.draw do
 end
 ```
 
-or you can enable basic auth by setting `ENV['COVERBAND_PASSWORD']` or via your configuration `config.password = 'my_pass'`
+or you can enable basic auth by setting `ENV['COVERBAND_PASSWORD']` or via your configuration `config.password = <YOUR_COMPLEX_UNGUESSABLE_PASSWORD>`
 
-### Coverband Web Endpoint
+### Standalone
 
-The web endpoint is a barebones endpoint that you can either expose direct (after authentication) or you can just link to the actions you wish to expose. The index is intended as a example to showcase all the features.
+The coverage server can also be started standalone with a rake task:
 
-![image](https://raw.github.com/danmayer/coverband/master/docs/coverband_web_ui.png)
-
-> The web index as available on the Coverband Demo site
-
-- **force coverage collection:** This triggers coverage collection on the current webserver process
-- **clear coverage report:** This will clear the coverage data. This wipes out all collected data (**dangerous**)
-- View individual file details
-- **clear individual file coverage:** This will clear the details of the file you are looking at. This is helpful if you don't want to lose all Coverage data but made a change that you expect would impact a particular file.
-
-### JRuby Support
-
-Coverband is compatible with JRuby. If you want to run on JRuby note that I haven't benchmarked and I believe the perf impact on older versions of JRuby could be significant, improved Coverage support is in [JRuby master](https://github.com/jruby/jruby/pull/6180), and will be in the next release.
-
-- older versions of JRuby need tracing enabled to work (and this could cause bad performance)
-  - run Jruby with the `--debug` option
-  - add into your `.jrubyrc` the `debug.fullTrace=true` setting
-- For best performance the `oneshot_lines` is recommended, and in the latest releases should have very low overhead
-- See JRuby support in a Rails app configured to run via JRuby, in [Coverband Demo](https://github.com/coverband-service/coverband_demo)
-- JRuby is tested via CI against Rails 5 and 6
-
-### Rake Tasks
-
-The rake task generates a report locally and opens a browser pointing to `coverage/index.html`.
-
-`rake coverband:coverage`
-
-This is mostly useful in your local development environment.
-
-##### Example Output
+```
+ bundle exec rake coverband:coverage_server
+```
 
-Since Coverband is [Simplecov](https://github.com/colszowka/simplecov) output compatible it should work with any of the `SimpleCov::Formatter`'s available. The output below is produced using the default Simplecov HTML formatter.
+The web UI should then be available here: http://localhost:1022/
 
-Index Page
-![image](https://raw.github.com/danmayer/coverband/master/docs/coverband_index.png)
+This is especially useful for projects that are api only and cannot support the mounted rack app. To get production coverage, point coverband at your production redis server and ensure to checkout the production version of your project code locally.
 
-Details on an example Sinatra app
-![image](https://raw.github.com/danmayer/coverband/master/docs/coverband_details.png)
+```
+ COVERBAND_REDIS_URL=redis://username:password:redis_production_server:2322 bundle exec rake coverband:coverage_server
+```
 
 # Coverband Demo
 
@@ -245,7 +243,7 @@ end
 
 ### Avoiding Cache Stampede
 
-If you have many servers and they all hit Redis at the same time you can see spikes in your Redis CPU, and memory. This is do to a concept called [cache stampede](https://en.wikipedia.org/wiki/Cache_stampede). It is better to spread out the reporting across your servers. A simple way to do this is to add a random wiggle on your background reporting. This configuration option allows a wiggle. The right amount of wiggle depends on the numbers of servers you have and how willing you are to have delays in your coverage reporting. I would recommend at least 1 second per server.
+If you have many servers and they all hit Redis at the same time you can see spikes in your Redis CPU, and memory. This is do to a concept called [cache stampede](https://en.wikipedia.org/wiki/Cache_stampede). It is better to spread out the reporting across your servers. A simple way to do this is to add a random wiggle on your background reporting. This configuration option allows a wiggle. The right amount of wiggle depends on the numbers of servers you have and how willing you are to have delays in your coverage reporting. I would recommend at least 1 second per server. Note, the default wiggle is set to 30 seconds.
 
 Add a wiggle (in seconds) to the background thread to avoid all your servers reporting at the same time:
 
@@ -253,11 +251,12 @@ Add a wiggle (in seconds) to the background thread to avoid all your servers rep
 
 ### Redis Hash Store
 
-Coverband on very high volume sites with many server processes reporting can have a race condition. To resolve the race condition and reduce Ruby memory overhead we have introduced a new Redis storage option. This moves the some of the work from the Ruby processes to Redis. It is worth noting because of this, it has a larger demands on the Redis server. So adjust your Redis instance accordingly. To help reduce the extra redis load you can also change the background reporting time period.
+Coverband on very high volume sites with many server processes reporting can have a race condition which can cause hit counts to be inaccurate. To resolve the race condition and reduce Ruby memory overhead we have introduced a new Redis storage option. This moves the some of the work from the Ruby processes to Redis. It is worth noting because of this, it has a larger demands on the Redis server. So adjust your Redis instance accordingly. To help reduce the extra redis load you can also change the background reporting frequency.
 
-- set the new Redis store: `config.store = Coverband::Adapters::HashRedisStore.new(Redis.new(url: redis_url))`
-- adjust from default 30s reporting `config.background_reporting_sleep_seconds = 120`
-- reminder it is recommended to have a unique Redis per workload (background jobs, caching, Coverband), for this store, it may be more important to have a dedicated Redis.
+- Use a dedicated coverband redis instance: `config.store = Coverband::Adapters::HashRedisStore.new(Redis.new(url: redis_url))`
+- Adjust from default 30s reporting `config.background_reporting_sleep_seconds = 120`
+
+See more discussion [here](https://github.com/danmayer/coverband/issues/384).
 
 ### Clear Coverage
 
@@ -265,6 +264,8 @@ Now that Coverband uses MD5 hashes there should be no reason to manually clear c
 
 `rake coverband:clear`
 
+This can also be done through the web if `config.web_enable_clear` is enabled.
+
 ### 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.
@@ -306,7 +307,7 @@ Coverband.start
 
 ### Verbose Debug / Development Mode
 
-Note: To debug issues getting Coverband working. I recommend running in development mode, by turning verbose logging on `config.verbose = true` and passing in the Rails.logger `config.logger = Rails.logger` to the Coverband config. We respect the log level, and I would recommend log level info generally, but if you are investigating a prolbem Coverband logs additional data at the `debug` level. This makes it easy to follow in development mode. Be careful to not leave these on in production as they will affect performance.
+Note: To debug issues getting Coverband working. I recommend running in development mode, by turning verbose logging on `config.verbose = true` and passing in the Rails.logger `config.logger = Rails.logger` to the Coverband config. We respect the log level, and I would recommend log level info generally, but if you are investigating a problem Coverband logs additional data at the `debug` level. This makes it easy to follow in development mode. Be careful to not leave these on in production as they will affect performance.
 
 ---
 
@@ -339,6 +340,17 @@ We will match Heroku & Ruby's support lifetime, supporting the last 3 major Ruby
 
 For Rails, we will follow the policy of the [Rails team maintenance policy](https://guides.rubyonrails.org/maintenance_policy.html). We officially support the last two major release versions, while providing minimal support (major bugs / security fixes) for an additional version. This means at the moment we primaryly target Rails 6.x, 5.x, and will try to keep current functionality working for Rails 4.x but may release new features that do not work on that target.
 
+### JRuby Support
+
+Coverband is compatible with JRuby. If you want to run on JRuby note that I haven't benchmarked and I believe the perf impact on older versions of JRuby could be significant. Improved Coverage support is in [JRuby master](https://github.com/jruby/jruby/pull/6180), and will be in the next release.
+
+- older versions of JRuby need tracing enabled to work (and this could cause bad performance)
+  - run Jruby with the `--debug` option
+  - add into your `.jrubyrc` the `debug.fullTrace=true` setting
+- For best performance the `oneshot_lines` is recommended, and in the latest releases should have very low overhead
+- See JRuby support in a Rails app configured to run via JRuby, in [Coverband Demo](https://github.com/coverband-service/coverband_demo)
+- JRuby is tested via CI against Rails 5 and 6
+
 # Contributing To Coverband
 
 If you are working on adding features, PRs, or bugfixes to Coverband this section should help get you going.

data/changes.md

@@ -53,6 +53,16 @@ Will be the fully modern release that drops maintenance legacy support in favor
 
 # Alpha / Beta / Release Candidates
 
+### Coverband 5.0.2
+
+- ?
+
+# Released
+
+### Coverband 5.0.1
+
+- fix for race condition on view tracker redis configuration setting ensuring it is set after it is configured... bug only impacted apps that have multiple redis connections for the same system and have Coverband not on the default REDIS_URL
+
 ### Coverband 5.0.0
 
 - Full JRuby support
@@ -66,21 +76,23 @@ Will be the fully modern release that drops maintenance legacy support in favor
 	- all config options can be set via coverband config, not requiring ENV var support
 	- deprecation notices on soon to be removed config options
 	- config exceptions on invalid configuration combinations
+	- additional testing around configurations
+	- improved defaults and reduced configuration options
 - improved resque patching pattern
 - improved default ignores
 - additional adapters
   - supports web-service adapter for http coverage collection
   - support log/file adapter
+  - extendable pattern to support any additional backends
 - reduce logs / errors / alerts on bad startup configurations
+- fix: #301 runtime vs eagerload should always remain correct
 
-# Released
-
-###Coverband 4.2.7
+### Coverband 4.2.7
 
 - Ignore patterns too aggressive #382, thanks @thijsnado
 - Stack level too deep error when running certain activejob jobs #367, thanks @kejordan and @hanslauwers
 
-###Coverband 4.2.6
+### Coverband 4.2.6
 
 - Address Redis exists deprecation warning by baffers
 
@@ -263,7 +275,7 @@ Will be a stable and fast release that drops maintenance legacy support in favor
   - implemented for Redis and File store
 - improved mountable web interface
 
-# 2.0.3
+### 2.0.3
 
 - don''t include docs in the gemfile thanks @bquorning
 - pipeline_redis to reduce network overhead thanks @Kallin

data/coverband.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "memory_profiler"
   spec.add_development_dependency "minitest"
   spec.add_development_dependency "minitest-fork_executor"
+  spec.add_development_dependency "minitest-stub-const"
   spec.add_development_dependency "mocha", "~> 1.7.0"
   spec.add_development_dependency "rack"
   spec.add_development_dependency "rack-test"

data/lib/coverband/configuration.rb

@@ -130,7 +130,7 @@ module Coverband
 
     def store
       @store ||= if service?
-        raise "invalid configuration: unclear default store coverband expects either api_key or redis_url" if redis_url
+        raise "invalid configuration: unclear default store coverband expects either api_key or redis_url" if ENV["COVERBAND_REDIS_URL"]
         require "coverband/adapters/web_service_store"
         Coverband::Adapters::WebServiceStore.new(service_url)
       else
@@ -141,7 +141,7 @@ module Coverband
     def store=(store)
       raise "Pass in an instance of Coverband::Adapters" unless store.is_a?(Coverband::Adapters::Base)
       raise "invalid configuration: only coverband service expects an API Key" if api_key && store.class.to_s != "Coverband::Adapters::WebServiceStore"
-      raise "invalid configuration: coverband service shouldn't have redis url set" if redis_url && store.class.to_s == "Coverband::Adapters::WebServiceStore"
+      raise "invalid configuration: coverband service shouldn't have redis url set" if ENV["COVERBAND_REDIS_URL"] && store.class.to_s == "Coverband::Adapters::WebServiceStore"
 
       @store = store
     end

data/lib/coverband/reporters/console_report.rb

@@ -8,14 +8,8 @@ module Coverband
     class ConsoleReport < Base
       def self.report(store, options = {})
         scov_style_report = super(store, options)
-
-        scov_style_report.each_pair do |file, usage|
-          # TODO: In Coverband 5 deprecate none hash format
-          if usage.is_a?(Hash)
-            Coverband.configuration.logger.info "#{file}: #{usage["data"]}"
-          else
-            Coverband.configuration.logger.info "#{file}: #{usage}"
-          end
+        scov_style_report[:merged].each_pair do |file, usage|
+          Coverband.configuration.logger.info "#{file}: #{usage["data"]}"
         end
         scov_style_report
       end

data/lib/coverband/utils/railtie.rb

@@ -13,7 +13,21 @@ module Coverband
     initializer "coverband.configure" do |app|
       begin
         app.middleware.use Coverband::BackgroundMiddleware
+      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
+    end
 
+    config.after_initialize do
+      unless Coverband.tasks_to_ignore?
+        Coverband.configure
+        Coverband.eager_loading_coverage!
+        Coverband.report_coverage
+        Coverband.runtime_coverage!
+      end
+
+      begin
         if Coverband.configuration.track_views
           COVERBAND_VIEW_TRACKER = if Coverband.coverband_service?
             Coverband::Collectors::ViewTrackerService.new
@@ -33,15 +47,6 @@ module Coverband
       end
     end
 
-    config.after_initialize do
-      unless Coverband.tasks_to_ignore?
-        Coverband.configure
-        Coverband.eager_loading_coverage!
-        Coverband.report_coverage
-        Coverband.runtime_coverage!
-      end
-    end
-
     config.before_configuration do
       unless ENV["COVERBAND_DISABLE_AUTO_START"]
         begin

data/lib/coverband/version.rb

@@ -5,5 +5,5 @@
 # use format '4.2.1.rc.1' ~> 4.2.1.rc to prerelease versions like v4.2.1.rc.2 and v4.2.1.rc.3
 ###
 module Coverband
-  VERSION = "5.0.0.rc.6"
+  VERSION = "5.0.1"
 end

data/test/coverband/configuration_test.rb

@@ -89,17 +89,29 @@ class BaseTest < Minitest::Test
     end
   end
 
-  test "store raises when api key and redis_url" do
+  test "store raises when api key and coverband redis env" do
     Coverband::Collectors::Coverage.instance.reset_instance
     Coverband.configuration.reset
-    assert_raises RuntimeError do
-      Coverband.configure do |config|
-        config.api_key = "test-key"
-        config.redis_url = "redis://localhost:3333"
+
+    env = ENV.to_hash.merge("COVERBAND_REDIS_URL" => "redis://localhost:3333")
+    Object.stub_const(:ENV, env) do
+      assert_raises RuntimeError do
+        Coverband.configure do |config|
+          config.api_key = "test-key"
+        end
       end
     end
   end
 
+  test "store doesnt raises when api key and redis_url" do
+    Coverband::Collectors::Coverage.instance.reset_instance
+    Coverband.configuration.reset
+    Coverband.configure do |config|
+      config.api_key = "test-key"
+      config.redis_url = "redis://localhost:3333"
+    end
+  end
+
   test "use_oneshot_lines_coverage" do
     refute Coverband.configuration.use_oneshot_lines_coverage
 

data/test/coverband/reporters/web_test.rb

@@ -22,13 +22,13 @@ if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new("2.2.0")
       test "renders index content" do
         get "/"
         assert last_response.ok?
-        assert_match "Coverband Admin", last_response.body
+        assert_match "Coverband Home", last_response.body
       end
 
       test "renders index content for empty path" do
         get ""
         assert last_response.ok?
-        assert_match "Coverband Admin", last_response.body
+        assert_match "Coverband Home", last_response.body
       end
 
       test "renders 404" do

data/test/test_helper.rb

@@ -6,6 +6,7 @@ require "rubygems"
 require "simplecov"
 require "coveralls"
 require "minitest/autorun"
+require "minitest/stub_const"
 require "mocha/minitest"
 require "ostruct"
 require "json"

data/views/nav.erb

@@ -1,7 +1,7 @@
 
 <div id="header">
-  <a href='<%= base_path %>'>Coverband Admin</a> &nbsp;
-  <a href='<%= base_path %>settings'>Info</a> &nbsp;
+  <a href='<%= base_path %>'>Coverband Home</a> &nbsp;
+  <a href='<%= base_path %>settings'>Configuration</a> &nbsp;
   <% if Coverband.configuration.web_enable_clear %>
     <%= button("#{base_path}clear", 'clear coverage report', delete: true) %>
   <% end %>

data/views/settings.erb

@@ -11,8 +11,8 @@
   <body>
     <div id="wrapper" style="">
       <div id="header">
-        <a href='<%= base_path %>'>Coverband Admin</a> &nbsp;
-        <a href='<%= base_path %>settings'>Info</a> &nbsp;
+        <a href='<%= base_path %>'>Coverband Home</a> &nbsp;
+        <a href='<%= base_path %>settings'>Configuration</a> &nbsp;
       </div>
       <div id="content">
         <dl>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: coverband
 version: !ruby/object:Gem::Version
-  version: 5.0.0.rc.6
+  version: 5.0.1
 platform: ruby
 authors:
 - Dan Mayer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-28 00:00:00.000000000 Z
+date: 2020-09-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
@@ -95,6 +95,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest-stub-const
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: mocha
   requirement: !ruby/object:Gem::Requirement
@@ -448,11 +462,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.0.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Rack middleware to measure production code usage (LOC runtime usage)