coverband 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 596cbfbecac5e0b49abfb79b09b10a8b68913c48
-  data.tar.gz: 340cbd1d66d93036dfa88ba2ea28072862bb26a6
+  metadata.gz: e98fd5cb692315012eaf942729c5dda8733dc1f2
+  data.tar.gz: f5aa2c9ed5c11d804a5849f17044c557545adb02
 SHA512:
-  metadata.gz: 7d12ac9b92ca27079ceef0cac971295f85808f2b4ca75f6ed8e150f1bc4302012402ab6be91c8084ce1ac5e46182eea4bce921d1fee448117203179532866480
-  data.tar.gz: bec658051aa2b3f324e8b5aa0d04bf5d1a4a163dda65cbe2304f78c924fe8c7837657f057a4cfd248d3aa9016c0b94c282f6f8e9fa525d2050123e98c1f35223
+  metadata.gz: 520f5f7d174cbb4839b8d2aa8a763c5810efcc5102d32e0891ca1923a7cdf2a87183d6267cd24576159001f1829b7ac8eed4eddbc1d3f2eb196285d78adc80ea
+  data.tar.gz: 1398b2283ba65698d8ce5040b69742e365c3cf9c26a52300322baff70fad708e65152531487dec576ec4a8030fc6b1e1542645f21bb3c32f1d868d3eb16431d2

data/Gemfile

@@ -2,5 +2,4 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in coverband.gemspec
 gemspec
-gem 'classifier-reborn'
 

data/README.md

@@ -39,6 +39,19 @@ Or install it yourself as:
 $ gem install coverband
 ```
 
+That gives you the gem, but to get up and running then follow:
+
+* [Coverband Configuration](https://github.com/danmayer/coverband#configuration)
+  * Rake integration
+  * Coverband config setup
+  * Require Coverband
+  * Insert middleware in stack  
+* run `bundle exec rake coverband:baseline` ([what is baseline?](https://github.com/danmayer/coverband#coverband-baseline))
+* run `bundle exec 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 2)
+* run `bundle exec rake coverband:coverage` and you should see coverage increasing for the endpoints you hit.
+
+
 ## Example Output
 
 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.
@@ -51,7 +64,13 @@ Details on a example Sinatra app
 
 ## Notes
 
-* Coverband has been used on large scale production websites without large impacts on performance. Adjusting the samplerate to achieve an acceptable trade-off on detailed information vs performance impact.
+* Coverband has been used on large scale production websites without large impacts on performance. Adjusting the sample rate to achieve an acceptable trade-off on detailed information vs performance impact. Coverband started as a Ruby 1.9 project and the performance impact has been reduced by each Ruby release since.
+
+## Coverband Baseline
+
+__TLDR:__ Baseline is app initialization coverage, not captured during runtime.
+
+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`.
 
 ## Configuration
 
@@ -73,6 +92,7 @@ Coverband.configure do |config|
   config.ignore            = ['vendor','lib/scrazy_i18n_patch_thats_hit_all_the_time.rb']
   # Since rails and other frameworks lazy load code. I have found it is bad to allow
   # initial requests to record with coverband. This ignores first 15 requests
+  # NOTE: If you are using a threaded webserver (example: Puma) this will ignore requests for each thread
   config.startup_delay     = Rails.env.production? ? 15 : 2
   # Percentage of requests recorded
   config.percentage        = Rails.env.production? ? 30.0 : 100.0
@@ -290,6 +310,15 @@ 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.
 
+### Coverband development
+
+If you are working on adding features, PRs, or bugfixes to Coverband this section should help get you going.
+
+* run tests: `bundle exec rake`
+* view test coverage: `open coverage/index.html`
+* run the benchmarks before and after your change to see impact
+   * `bundle exec rake benchmarks` 
+
 ### Known issues
 
 * If you don't have a baseline recorded your coverage can look odd like you are missing a bunch of data. It would be good if Coverband gave a more actionable warning in this situation.

data/Rakefile

@@ -6,6 +6,9 @@ task :default => :test
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/*_test.rb'
+  # 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.verbose = true
 end

data/coverband.gemspec

@@ -8,9 +8,9 @@ Gem::Specification.new do |spec|
   spec.version       = Coverband::VERSION
   spec.authors       = ["Dan Mayer"]
   spec.email         = ["dan@mayerdan.com"]
-  spec.description   = %q{Rack middleware to help measure production code coverage}
-  spec.summary       = %q{Rack middleware to help measure production code coverage}
-  spec.homepage      = ""
+  spec.description   = %q{Rack middleware to help measure production code usage (LOC runtime usage)}
+  spec.summary       = %q{Rack middleware to help measure production code usage (LOC runtime usage)}
+  spec.homepage      = "https://github.com/danmayer/coverband"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
@@ -24,9 +24,10 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rack"
   spec.add_development_dependency "rack-test"
   spec.add_development_dependency "test-unit"
+  spec.add_development_dependency 'sinatra'
+  spec.add_development_dependency 'classifier-reborn'
   spec.add_runtime_dependency "simplecov"
   spec.add_runtime_dependency "json"
   spec.add_runtime_dependency "redis"
   spec.add_runtime_dependency 'aws-sdk', '~> 2'
-  spec.add_runtime_dependency 'sinatra'
 end

data/lib/coverband/reporter.rb

@@ -146,7 +146,9 @@ module Coverband
         Coverband.configuration.logger.info scov_style_report.inspect
       end
 
-      SimpleCov::Result.new(scov_style_report).format!
+      # add in files never hit in coverband
+      SimpleCov.track_files "#{current_root}/{app,lib,config}/**/*.{rb,haml,erb,slim}"
+      SimpleCov::Result.new(SimpleCov.add_not_loaded_files(scov_style_report)).format!
       if open_report
         `open #{SimpleCov.coverage_dir}/index.html`
       else

data/lib/coverband/version.rb

@@ -1,3 +1,3 @@
 module Coverband
-  VERSION = "1.3.0"
+  VERSION = "1.3.1"
 end

data/test/unit/base_test.rb

@@ -8,7 +8,6 @@ class BaseTest < Test::Unit::TestCase
     assert_equal Coverband::RedisStore, coverband.instance_variable_get('@reporter').class
   end
 
-
   test 'configure memory caching' do
     Coverband.configuration.memory_caching = true
     coverband = Coverband::Base.instance.reset_instance

data/test/unit/reporter_test.rb

@@ -3,7 +3,7 @@ require File.expand_path('../test_helper', File.dirname(__FILE__))
 class ReporterTest < Test::Unit::TestCase
 
   test "record baseline" do
-    Coverage.expects(:start).at_least_once
+    Coverage.expects(:start).returns(true).at_least_once
     Coverage.expects(:result).returns({'fake' => [0,1]}).at_least_once
     File.expects(:open).once
 
@@ -37,6 +37,26 @@ class ReporterTest < Test::Unit::TestCase
     Coverband::Reporter.report
   end
 
+    test "report data with scov" do
+    Coverband.configure do |config|
+      config.redis             = fake_redis
+      config.reporter          = 'scov'
+      config.s3_bucket         = nil
+    end
+
+    Coverband::Reporter.expects(:current_root).at_least_once.returns('/root_dir')
+    fake_redis.expects(:smembers).with('coverband').returns(fake_coverband_members)
+    
+    fake_coverband_members.each do |key|
+      File.expects(:exists?).with(key).returns(true)
+      File.expects(:foreach).with(key).returns(['a','b','c'])
+      fake_redis.expects(:smembers).with("coverband.#{key}").returns(["54", "55"])
+    end
+    
+    Coverband.configuration.logger.stubs('info')
+
+    Coverband::Reporter.report(open_report: false)
+  end
 
   ####
   # TODO

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: coverband
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - Dan Mayer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-04 00:00:00.000000000 Z
+date: 2016-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -95,13 +95,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -109,13 +109,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: classifier-reborn
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -123,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: redis
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,21 +137,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: aws-sdk
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: sinatra
+  name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -164,7 +164,21 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: Rack middleware to help measure production code coverage
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+description: Rack middleware to help measure production code usage (LOC runtime usage)
 email:
 - dan@mayerdan.com
 executables: []
@@ -206,7 +220,7 @@ files:
 - test/unit/reporter_test.rb
 - test/unit/s3_report_writer_test.rb
 - test/unit/s3_web_test.rb
-homepage: ''
+homepage: https://github.com/danmayer/coverband
 licenses:
 - MIT
 metadata: {}
@@ -229,7 +243,7 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: Rack middleware to help measure production code coverage
+summary: Rack middleware to help measure production code usage (LOC runtime usage)
 test_files:
 - test/benchmarks/.gitignore
 - test/benchmarks/benchmark.rake