coverband 2.0.0 → 2.0.1.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 104227eaef7c235ff16b13a0f80c5f29fe4117deac05acbed7553e3343be7ea9
-  data.tar.gz: dd5a621f881e955c52c1a2acf903f3bc5abd550bc015650851cb385ff76bf758
+SHA1:
+  metadata.gz: 69453bf4b4d3273ce29f591dd5db1c45cf0f16fd
+  data.tar.gz: c9603b2dd9c5a736e9448711c4fae77456d7118b
 SHA512:
-  metadata.gz: 7a2c2041a887b5ac729a540489b20e48fba117e2d70e827f3b7c5fb6da21382fa6786a093e915232771abc7a0903f78b3484713e39394fdf3bbf6cda6f8f57c9
-  data.tar.gz: 38ed9c82a8a607d349f4edef901d7d348b128c9ff2f6ad6276df388f29ee25e98c6e9534f3e0d4d16d1902f958575f72aa6676c8499d81f6a44b72eaaef534fc
+  metadata.gz: 484e9b4182057196b7c6b8f4cc8c2b299d04b329d285004534bee436a24587754bcd7d181e1c6991aaf5642f9595f69d5498cf8efff791e4c624e8f7cdfed58c
+  data.tar.gz: 8aff2bd0a4be57763d100726596d0dea50867d35b665e26e2ad36f5655d3803a50abd594bc4c1f17c45db2a86baa20447a30f5180832fbbd71764c83009490ea

data/README.md

@@ -57,7 +57,7 @@ Details on a example Sinatra app
 
 Follow the below section to install and configure Coverband.
 
-![coverband installation](https://raw.githubusercontent.com/danmayer/coverband/feature/via_coverage/docs/coverband_install.gif?raw=true)
+![coverband installation](https://raw.githubusercontent.com/danmayer/coverband/master/docs/coverband-install-resize.gif)
 
 ## Prerequisites
 
@@ -102,6 +102,10 @@ Coverband.configure do |config|
   config.root              = Dir.pwd
   config.collector         = 'coverage'
   config.redis             = Redis.new(url: ENV['REDIS_URL']) if defined? Redis
+  # TODO NOTE THIS IS A ISSUE IN THE 2.0 release you set something like redis and the store
+  # I need to look a bit more at this but got one bug report quickly after release
+  # (even though test builds didnt need)
+  config.store             = Redis.new(url: ENV['REDIS_URL']) if defined? Redis
   config.ignore            = %w[vendor .erb$ .slim$]
   # add paths that you deploy to that might be different than your local dev root path
   config.root_paths        = []
@@ -212,8 +216,9 @@ bundle install
 
 # create config/coverband.rb
 # copy the config from the readme
-# If you don't set REDIS_URL, remove that to use default localhose
+# If you don't set REDIS_URL, remove that to use default localhost
 
+# Make some code so we can look at the coverage
 rails generate scaffold blogs
 bundle exec rake db:migrate
 
@@ -283,12 +288,36 @@ end
 
 ### View Coverage
 
-You can view the report different ways, but the easiest is the Rake task which opens the Simplecov formated HTML.
+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`
 
 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.
@@ -313,7 +342,7 @@ Coverband::Reporter.clear_coverage(Redis.new(:host => 'target.com', :port => 678
 ```
 You can also do this with the included rake tasks.
 
-### Manual configuration (for example for background jobs)
+### Manual Configuration (for example for background jobs)
 
 It is easy to use Coverband outside of a Rack environment. Make sure you configure Coverband in whatever environment you are using (such as `config/initializers/*.rb`). Then you can hook into before and after events to add coverage around background jobs, or for any non Rack code.
 
@@ -360,6 +389,83 @@ coverband.sample {
 }
 ```
 
+### Manual Configuration (for cron jobs / Raketasks)
+
+A question about [supporting cron jobs and Rake tasks](https://github.com/danmayer/coverband/issues/106) was asked by [@ndbroadbent](https://github.com/ndbroadbent), there are a couple ways to go about it including his good suggestion.
+
+He extended the Coverband Rake tasks by adding `lib/tasks/coverband.rake` with support to wrap all Rake tasks with coverband support.
+
+```
+require 'coverband'
+Coverband.configure
+require 'coverband/tasks'
+
+# Wrap all Rake tasks with Coverband
+current_tasks = Rake.application.top_level_tasks
+if current_tasks.any? && current_tasks.none? { |t| t.to_s.match?(/^coverband:/) }
+  current_tasks.unshift 'coverband:start'
+  current_tasks.push 'coverband:stop_and_save'
+end
+
+namespace :coverband do
+  task :start do
+    Coverband::Base.instance.start
+  end
+
+  task :stop_and_save do
+    Coverband::Base.instance.stop
+    Coverband::Base.instance.save
+  end
+end
+```
+
+That is a interesting approach and if you Run all your cron jobs as Rake tasks might work well for you. In a production application where we run Coverband, we run all of our Cron jobs with the `rails runner` script. We took this alternative approach which will wrap all runner jobs with Coverband recording, by creating `lib/railties/coverage_runner.rb`.
+
+```
+require 'rails'
+
+# Capture code coverage during our cron jobs
+class CoverageRunner < ::Rails::Railtie
+  runner do
+    Coverband::Collectors::Base.instance.start
+    at_exit do
+      Coverband::Collectors::Base.instance.report_coverage
+    end
+  end
+end
+```
+
+### safe_reload_files: Forcing Coverband to Track Coverage on Files loaded during boot
+
+The way Coverband is built it will record and report code usage in production for anything `required` or `loaded` after calling `Coverband.start`. This means some of Rails initial files and Gems are loaded before you can generally call `Coverband.start` for example if you use the `application.rb` to initialize and start Coverband, that file will be reported as having no coverage, as it can't possibly start Coverband before the file is loaded. 
+
+The `safe_reload_files` reload option in the configuration options can help to ensure you can track any files you want regardless of them loading before Coverband. For example if I wanted to show the coverage of `config/coverband.rb` which has to be loaded before calling `Coverband.start` I could do that by adding that path to the `safe_reload_files` option.
+
+```
+Coverband.configure do |config|
+  # ... a bunch of other options
+  # using the new safe reload to enforce files loaded
+  config.safe_reload_files = ['config/coverband.rb']
+end
+```
+By adding any files above you will get reporting on those files as part of your coverage runtime report.
+
+
+### Collecting Gem / Library Usage
+
+By default Coverband has assumed you are trying to track your application code usage not all the supporting framework and library (Gems) code usage. There has been some good points and reasons folks want to track library usage, for example to find out which Gems they aren't actually using in production. See some of the discussion on [issue 21](https://github.com/danmayer/coverband/issues/21).
+
+* Using the Tracepoint Collector
+   * just make sure to set `Coverband.configuration.include_gems = true` in your config options
+   * note by tracking all the additional usage this can have significant performance impacts of the Tracepoint implementation
+* Using the Coverage Collector
+   * use the `safe_reload_files` feature to add the path of all gem files you wish to track
+   * --- or ---
+   * ensure you call `Coverband.start` before loading all your gems
+      * while possible this is currently hard as Rails and most environments load your whole Gemfile
+      * looking for an improve and easier way to support this.  
+
+
 ### 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. This makes it easy to follow in development mode. Be careful to not leave these on in production as they will affect performance.
@@ -400,6 +506,59 @@ Coverband::Reporter.report :additional_scov_data => [data]
 
 You can also pass a `:additional_scov_data => [data]` option to `Coverband::Reporter.get_current_scov_data` to write out merged data.
 
+### Writing Coverband Results to S3
+
+If you add some additional Coverband configuration your coverage html report will be written directly to S3, update `config/coverband.rb` like below.
+
+```
+  # configure S3 integration
+  config.s3_bucket = 'coverband-demo'
+  config.s3_region = 'us-east-1'
+  config.s3_access_key_id = ENV['AWS_ACCESS_KEY_ID']
+  config.s3_secret_access_key = ENV['AWS_SECRET_ACCESS_KEY']
+```
+
+### Viewing / Hosting S3 Coverband results in app
+
+Beyond writing to S3 you can host the S3 file with a build in Sintatra app in Coverband. Just configure your Rails route `config/routes.rb`
+
+```
+Rails.application.routes.draw do
+  # ... lots of routes
+  mount Coverband::S3Web, at: '/coverage'
+end
+```
+
+__NOTE__: ADD PASSWORD PROTECTION OR YOU CAN EXPOSE ALL YOUR SOURCE CODE
+
+It is easy to add some basic protect around the coverage data, below shows how you can use devise or basic auth, by adding a bit of code to your `config/routes.rb` file.
+
+```
+# protect with existing Rails devise configuration
+devise_constraint = lambda do |request|
+  request.env['warden'] && request.env['warden'].authenticate? && request.env['warden'].user.admin?
+end
+
+# protect with http basic auth
+# curl --user foo:bar http://localhost:3000/coverage
+basic_constraint = lambda do |request|
+  return true if Rails.env.development?
+  if ActionController::HttpAuthentication::Basic.has_basic_credentials?(request)
+    credentials = ActionController::HttpAuthentication::Basic.decode_credentials(request)
+    email, password = credentials.split(':')
+
+    email == 'foo' && password = 'bar'
+  end
+end
+
+Rails.application.routes.draw do
+  # ... lots of routes
+  constraints basic_constraint do
+    mount Coverband::S3Web, at: '/coverage'
+  end
+end
+```
+
 # Contributing To Coverband
 
 If you are working on adding features, PRs, or bugfixes to Coverband this section should help get you going.
@@ -423,9 +582,9 @@ If you submit a change please make sure the tests and benchmarks are passing.
 ### 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.
-* 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.
-* 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 to record the baseline.
 
 ### Debugging Redis Store
 
@@ -496,6 +655,7 @@ Similar format to redis store, but array with integer values
 
 ### Todo
 
+* Sinatra App with admin controls
 * 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)

data/changes.md

@@ -12,9 +12,21 @@ Will be the fully modern release that drops maintenance legacy support in favor
    * add built-in support for easy loading via Railties
    * expects to add safe list support to force reload files one wants coverage on that may happen outside of the standard load order
    * 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)
 
 # Released
 
+### 2.0.1
+
+* add support for fine grained S3 configuration via Coverband config, thanks @a0s
+  * 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
+* 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
+
 ### 2.0.0
 
 Major release with various backwards compatibility breaking changes (generally related to the configuration). The 2.0 lifecycle will act as a mostly easy upgrade that supports past users looking to move to the much faster new Coverage Adapter.

data/lib/coverband.rb

@@ -27,14 +27,15 @@ module Coverband
   end
 
   def self.configure(file = nil)
+    configuration_file = file || CONFIG_FILE
+
     configuration
     if block_given?
       yield(configuration)
-    elsif File.exist?(CONFIG_FILE)
-      file ||= CONFIG_FILE
-      require file
+    elsif File.exist?(configuration_file)
+      require configuration_file
     else
-      raise ArgumentError, "configure requires a block or the existance of a #{CONFIG_FILE} in your project"
+      raise ArgumentError, "configure requires a block, the existance of a #{CONFIG_FILE} in your project, or a path to a config file passed in to configure"
     end
   end
 

data/lib/coverband/adapters/redis_store.rb

@@ -7,35 +7,41 @@ module Coverband
 
       def initialize(redis, opts = {})
         @redis = redis
+        @ttl             = opts[:ttl]
+        @redis_namespace = opts[:redis_namespace]
       end
 
       def clear!
-        @redis.smembers(BASE_KEY).each { |key| @redis.del("#{BASE_KEY}.#{key}") }
-        @redis.del(BASE_KEY)
+        @redis.smembers(base_key).each { |key| @redis.del("#{base_key}.#{key}") }
+        @redis.del(base_key)
+      end
+
+      def base_key
+        @base_key ||= [BASE_KEY, @redis_namespace].compact.join('.')
       end
 
       def save_report(report)
-        store_array(BASE_KEY, report.keys)
+        store_array(base_key, report.keys)
 
         report.each do |file, lines|
-          store_map("#{BASE_KEY}.#{file}", lines)
+          store_map("#{base_key}.#{file}", lines)
         end
       end
 
       def coverage
         data = {}
-        redis.smembers(BASE_KEY).each do |key|
+        redis.smembers(base_key).each do |key|
           data[key] = covered_lines_for_file(key)
         end
         data
       end
 
       def covered_files
-        redis.smembers(BASE_KEY)
+        redis.smembers(base_key)
       end
 
       def covered_lines_for_file(file)
-        @redis.hgetall("#{BASE_KEY}.#{file}")
+        @redis.hgetall("#{base_key}.#{file}")
       end
 
       private
@@ -49,11 +55,13 @@ module Coverband
           values = Hash[values.map { |k, val| [k.to_s, val] }]
           values.merge!(existing) { |_k, old_v, new_v| old_v.to_i + new_v.to_i }
           redis.mapped_hmset(key, values)
+          redis.expire(key, @ttl) if @ttl
         end
       end
 
       def store_array(key, values)
         redis.sadd(key, values) unless values.empty?
+        redis.expire(key, @ttl) if @ttl
         values
       end
     end

data/lib/coverband/collectors/coverage.rb

@@ -116,6 +116,11 @@ module Coverband
         else
           ::Coverage.start
         end
+        if Coverband.configuration.safe_reload_files
+          Coverband.configuration.safe_reload_files.each do |safe_file|
+            load safe_file
+          end
+        end
         @semaphore = Mutex.new
         @@previous_results = nil
         reset_instance

data/lib/coverband/configuration.rb

@@ -5,9 +5,11 @@ module Coverband
     attr_accessor :redis, :root_paths, :root,
                   :ignore, :additional_files, :percentage, :verbose,
                   :reporter, :startup_delay, :memory_caching,
-                  :include_gems, :s3_bucket,
-                  :collector, :disable_on_failure_for
-    attr_writer :logger
+                  :include_gems, :collector, :disable_on_failure_for,
+                  :redis_namespace, :redis_ttl,
+                  :safe_reload_files
+
+    attr_writer :logger, :s3_region, :s3_bucket, :s3_access_key_id, :s3_secret_access_key
 
     def initialize
       @root = Dir.pwd
@@ -29,12 +31,34 @@ module Coverband
       @memory_caching = false
       @store = nil
       @disable_on_failure_for = nil
+      @s3_region = nil
+      @s3_bucket = nil
+      @s3_access_key_id = nil
+      @s3_secret_access_key = nil
+      @redis_namespace = nil
+      @redis_ttl = nil
     end
 
     def logger
       @logger ||= Logger.new(STDOUT)
     end
 
+    def s3_bucket
+      @s3_bucket || ENV['AWS_BUCKET']
+    end
+
+    def s3_region
+      @s3_region || ENV['AWS_REGION']
+    end
+
+    def s3_access_key_id
+      @s3_access_key_id || ENV['AWS_ACCESS_KEY_ID']
+    end
+
+    def s3_secret_access_key
+      @s3_secret_access_key || ENV['AWS_SECRET_ACCESS_KEY']
+    end
+
     def store
       return @store if @store
       raise 'no valid store configured'
@@ -43,8 +67,9 @@ module Coverband
     def store=(store)
       if store.is_a?(Coverband::Adapters::Base)
         @store = store
-      elsif defined?(Redis) && store.is_a?(Redis)
-        @store = Coverband::Adapters::RedisStore.new(redis)
+      elsif defined?(Redis) && redis && redis.is_a?(Redis)
+        @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)
       end

data/lib/coverband/reporters/simple_cov_report.rb

@@ -38,7 +38,12 @@ module Coverband
           Coverband.configuration.logger.info "report is ready and viewable: open #{SimpleCov.coverage_dir}/index.html"
         end
 
-        S3ReportWriter.new(Coverband.configuration.s3_bucket).persist! if Coverband.configuration.s3_bucket
+        s3_writer_options = {
+          region: Coverband.configuration.s3_region,
+          access_key_id: Coverband.configuration.s3_access_key_id,
+          secret_access_key: Coverband.configuration.s3_secret_access_key
+        }
+        S3ReportWriter.new(Coverband.configuration.s3_bucket, s3_writer_options).persist! if Coverband.configuration.s3_bucket
       end
     end
   end

data/lib/coverband/s3_report_writer.rb

@@ -1,8 +1,11 @@
 # frozen_string_literal: true
 
 class S3ReportWriter
-  def initialize(bucket_name)
+  def initialize(bucket_name, options = {})
     @bucket_name = bucket_name
+    @region = options[:region]
+    @access_key_id = options[:access_key_id]
+    @secret_access_key = options[:secret_access_key]
     begin
       require 'aws-sdk'
     rescue StandardError
@@ -29,7 +32,14 @@ class S3ReportWriter
   end
 
   def s3
-    Aws::S3::Resource.new
+    client_options = {
+      region: @region,
+      access_key_id: @access_key_id,
+      secret_access_key: @secret_access_key
+    }
+    resource_options = { client: Aws::S3::Client.new(client_options) }
+    resource_options = {} if client_options.values.any?(&:nil?)
+    Aws::S3::Resource.new(resource_options)
   end
 
   def bucket

data/lib/coverband/s3_web.rb

@@ -7,7 +7,36 @@ module Coverband
     set :public_folder, proc(){ File.expand_path('public', Gem::Specification.find_by_name('simplecov-html').full_gem_path) }
 
     get '/' do
-      s3.get_object(bucket: Coverband.configuration.s3_bucket, key: 'coverband/index.html').body.read
+      html = s3.get_object(bucket: Coverband.configuration.s3_bucket, key: 'coverband/index.html').body.read
+      # hack the static HTML assets to account for where this was mounted
+      html = html.gsub("src='", "src='#{request.path}")
+      html = html.gsub("href='", "href='#{request.path}")
+      html = html.gsub("loading.gif", "#{request.path}loading.gif")
+      html = html.gsub("/images/", "#{request.path}/images/")
+      html
+    end
+
+    post '/update_report' do
+      Coverband::Reporters::SimpleCovReport.report(Coverband.configuration.store, open_report: false)
+      notice = "coverband coverage updated"
+      redirect "/?notice=#{notice}", 301
+    end
+
+    post '/clear' do
+      Coverband.configuration.store.clear!
+      notice = "coverband coverage cleared"
+      redirect "/?notice=#{notice}", 301
+    end
+
+    post '/reload_files' do
+      if Coverband.configuration.safe_reload_files
+        Coverband.configuration.safe_reload_files.each do |safe_file|
+          load safe_file
+        end
+      end
+      Coverband.configure
+      notice = "coverband files reloaded"
+      redirect "/?notice=#{notice}", 301
     end
 
     private
@@ -19,7 +48,15 @@ module Coverband
         Coverband.configuration.logger.error "coverband requires 'aws-sdk' in order use S3ReportWriter."
         return
       end
-      @s3 ||= Aws::S3::Client.new
+      @s3 ||= begin
+        client_options = {
+          region: Coverband.configuration.s3_region,
+          access_key_id: Coverband.configuration.s3_access_key_id,
+          secret_access_key: Coverband.configuration.s3_secret_access_key
+        }
+        client_options = {} if client_options.values.any?(&:nil?)
+        Aws::S3::Client.new(client_options)
+      end
     end
   end
 end

data/lib/coverband/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Coverband
-  VERSION = '2.0.0'
+  VERSION = '2.0.1.alpha'
 end

data/test/unit/s3_report_writer_test.rb

@@ -18,7 +18,13 @@ module Coverband
       File.expects(:read).at_least(0).returns("content ./assets/#{html_version}/")
       object.expects(:put).with(body: 'content ')
       Aws::S3::Resource.expects(:new).returns(s3)
-      S3ReportWriter.new('coverage-bucket').persist!
+
+      s3_writer_options = {
+        region: 'us-west-1',
+        access_key_id: '',
+        secret_access_key: ''
+      }
+      S3ReportWriter.new('coverage-bucket', s3_writer_options).persist!
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coverband
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1.alpha
 platform: ruby
 authors:
 - Dan Mayer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-07-23 00:00:00.000000000 Z
+date: 2018-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -208,6 +208,7 @@ files:
 - Rakefile
 - changes.md
 - coverband.gemspec
+- docs/coverband-install-resize.gif
 - docs/coverband_details.png
 - docs/coverband_index.png
 - docs/coverband_install.gif
@@ -264,12 +265,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Rack middleware to help measure production code usage (LOC runtime usage)