(maint) - Optional support for deprecated codecov gem

The codecov gem is deprecated, thus we should try to avoid its use if
possible. We still allow users to require and use this gem if installed
in their environments.

Author: jordanbreen28

Gemfile

@@ -20,7 +20,6 @@ end
 group :development do
   gem 'puppet', *location_for(ENV['PUPPET_GEM_VERSION'])
 
-  gem 'codecov'
   gem 'simplecov'
   gem 'simplecov-console'
 

README.md

@@ -410,7 +410,7 @@ You can enable it, set the following environment variable:s
 
 ``SIMPLECOV=yes``
 
-Remember to add the simplecov-console and codecov gems to your `Gemfile`. If you run `spec:simplecov` on Travis-CI or any of the other supported CI services, reports gets automatically uploaded to https://codecov.io/ .
+Remember to add the simplecov-console gem to your `Gemfile`. If you run `spec:simplecov` on Travis-CI or any of the other supported CI services, reports get generated which can then be uploaded to [codecov.io](https://codecov.io) with the recommended [codecov uploader](https://docs.codecov.com/docs/codecov-uploader).
 
 Some Notes for Windows Users
 ============================

lib/puppetlabs_spec_helper/module_spec_helper.rb

@@ -20,35 +20,42 @@ def verify_contents(subject, title, expected_lines)
 module_path = File.join(fixture_path, 'modules')
 
 module_path = [module_path, env_module_path].join(File::PATH_SEPARATOR) if env_module_path
+
 if ENV['SIMPLECOV'] == 'yes'
   begin
     require 'simplecov'
     require 'simplecov-console'
+  rescue LoadError
+    raise 'Add the simplecov and simplecov-console gems to Gemfile to enable this task'
+  end
+
+  SimpleCov.formatters = [
+    SimpleCov::Formatter::HTMLFormatter,
+    SimpleCov::Formatter::Console
+  ]
+
+  begin
     require 'codecov'
+    SimpleCov.formatters << SimpleCov::Formatter::Codecov
+  rescue LoadError
+    # continue without codecov, we could warn here but we want to avoid its use if possible
+  end
+
+  SimpleCov.start do
+    track_files 'lib/**/*.rb'
+    add_filter '/spec'
 
-    SimpleCov.formatters = [
-      SimpleCov::Formatter::HTMLFormatter,
-      SimpleCov::Formatter::Console,
-      SimpleCov::Formatter::Codecov
-    ]
-    SimpleCov.start do
-      track_files 'lib/**/*.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
+    # 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
-  rescue LoadError
-    raise 'Add the simplecov, simplecov-console, codecov gems to Gemfile to enable this task'
   end
 end
 

spec/spec_helper.rb

@@ -4,30 +4,32 @@
   begin
     require 'simplecov'
     require 'simplecov-console'
+  rescue LoadError
+    raise 'Add the simplecov and simplecov-console gems to Gemfile to enable this task'
+  end
 
-    SimpleCov.formatters = [
-      SimpleCov::Formatter::HTMLFormatter,
-      SimpleCov::Formatter::Console
-    ]
+  SimpleCov.formatters = [
+    SimpleCov::Formatter::HTMLFormatter,
+    SimpleCov::Formatter::Console
+  ]
 
-    if ENV['CI'] == 'true'
-      require 'codecov'
-      SimpleCov.formatters << SimpleCov::Formatter::Codecov
-    end
+  begin
+    require 'codecov'
+    SimpleCov.formatters << SimpleCov::Formatter::Codecov
+  rescue LoadError
+    # continue without codecov, we could warn here but we want to avoid if possible
+  end
 
-    SimpleCov.start do
-      track_files 'lib/**/*.rb'
+  SimpleCov.start do
+    track_files 'lib/**/*.rb'
 
-      add_filter 'lib/puppetlabs_spec_helper/version.rb'
+    add_filter 'lib/puppetlabs_spec_helper/version.rb'
 
-      add_filter '/spec'
+    add_filter '/spec'
 
-      # do not track vendored files
-      add_filter '/vendor'
-      add_filter '/.vendor'
-    end
-  rescue LoadError
-    raise 'Add the simplecov, simplecov-console, codecov gems to Gemfile to enable this task'
+    # do not track vendored files
+    add_filter '/vendor'
+    add_filter '/.vendor'
   end
 end