(maint) use puppetlabs_spec_helper coverage config

Author: DavidS

.travis.yml

@@ -14,8 +14,8 @@ branches:
 matrix:
   include:
     - rvm: 2.4.3
-      env: PUPPET_GEM_VERSION='~> 5' COVERAGE=yes # 5.5
-    - env: RVM="jruby-1.7.26" PUPPET_GEM_VERSION='~> 5' JRUBY_OPTS="--debug" COVERAGE=yes
+      env: PUPPET_GEM_VERSION='~> 5' SIMPLECOV=yes # 5.5
+    - env: RVM="jruby-1.7.26" PUPPET_GEM_VERSION='~> 5' JRUBY_OPTS="--debug" SIMPLECOV=yes
       before_cache: pushd ~/.rvm && rm -rf archives rubies/ruby-2.2.7 rubies/ruby-2.3.4 && popd
       cache:
         bundler: true
@@ -45,7 +45,7 @@ matrix:
     - rvm: 2.4.1
       env: PUPPET_GEM_VERSION='~> 5.0.0'
     - rvm: 2.1.9
-      env: PUPPET_GEM_VERSION='~> 4' COVERAGE=yes # 4.10
+      env: PUPPET_GEM_VERSION='~> 4' SIMPLECOV=yes # 4.10
     - rvm: 2.1.9
       env: PUPPET_GEM_VERSION='~> 4.9.0'
     - rvm: 2.1.9

Rakefile

@@ -27,7 +27,7 @@ end
 namespace :spec do
   desc 'Run RSpec code examples with coverage collection'
   task :coverage do
-    ENV['COVERAGE'] = 'yes'
+    ENV['SIMPLECOV'] = 'yes'
     Rake::Task['spec'].execute
   end
 end

spec/spec_helper.rb

@@ -1,36 +1,4 @@
-if ENV['COVERAGE'] == 'yes'
-  require 'simplecov'
-  require 'simplecov-console'
-  require 'codecov'
-
-  SimpleCov.formatters = [
-    SimpleCov::Formatter::HTMLFormatter,
-    SimpleCov::Formatter::Console,
-    SimpleCov::Formatter::Codecov,
-  ]
-  SimpleCov.start do
-    track_files 'lib/**/*.rb'
-
-    add_filter 'lib/puppet/resource_api/version.rb'
-
-    add_filter '/spec'
-
-    # do not track vendored files
-    add_filter '/vendor'
-    add_filter '/.vendor'
-
-    # do not track gitignored files
-    # this adds about 4 seconds to the coverage check
-    # this could definitely be optimized
-    add_filter do |f|
-      # system returns true if exit status is 0, which with git-check-ignore means file is ignored
-      system("git check-ignore --quiet #{f.filename}")
-    end
-  end
-end
-
 require 'bundler/setup'
-require 'puppet/resource_api'
 
 RSpec.configure do |config|
   # Enable flags like --only-failures and --next-failure
@@ -47,4 +15,9 @@
   config.mock_with :rspec
 end
 
+# load puppet spec support and coverage setup before loading our code
 require 'puppetlabs_spec_helper/module_spec_helper'
+require 'puppet/resource_api'
+
+# exclude the `version.rb` which already gets loaded by bundler via the gemspec, and doesn't need coverage testing anyways.
+SimpleCov.add_filter 'lib/puppet/resource_api/version.rb' if ENV['SIMPLECOV'] == 'yes'