(CAT-1618) - Add code coverage back to ci

Author: jordanbreen28

.github/workflows/ci.yml

@@ -6,6 +6,9 @@ on:
       - "main"
   workflow_dispatch:
 
+env:
+  CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
 jobs:
 
   spec:
@@ -19,6 +22,7 @@ jobs:
     uses: "puppetlabs/cat-github-actions/.github/workflows/gem_ci.yml@main"
     secrets: "inherit"
     with:
+      rake_task: "spec:coverage"
       ruby_version: ${{ matrix.ruby_version }}
 
   acceptance:

Gemfile

@@ -10,8 +10,9 @@ group :test do
   gem 'json'
 
   gem 'rspec-json_expectations', '~> 1.4'
-
-  gem 'simplecov', :require => false if ENV['COVERAGE'] == 'yes'
+  gem 'simplecov', :require => false
+  gem 'simplecov-console', :require => false
+  gem 'codecov', :require => false
 end
 
 group :acceptance do

Rakefile

@@ -27,6 +27,14 @@ rescue LoadError
   # Gem not present
 end
 
+namespace :spec do
+  desc 'Run RSpec code examples with coverage collection'
+  task :coverage do
+      ENV['COVERAGE'] = 'yes'
+      Rake::Task['spec'].execute
+  end
+end
+
 RSpec::Core::RakeTask.new(:spec) do |t|
   t.exclude_pattern = 'spec/acceptance/**/*_spec.rb'
 end

spec/spec_helper.rb

@@ -1,12 +1,26 @@
 # Disable GitHub Actions reporting since it breaks the test suite
 ENV.delete('GITHUB_ACTION')
 
-if ENV['COVERAGE'] == 'yes' && RUBY_VERSION.start_with?('2.7.')
-  require 'simplecov'
-  SimpleCov.start do
-    add_filter('/spec/')
-    add_filter('/vendor/')
-    add_group('Checks', 'lib/puppet-lint/plugins')
+if ENV['COVERAGE'] == 'yes'
+  begin
+    require 'simplecov'
+    require 'simplecov-console'
+    SimpleCov.formatters = [
+      SimpleCov::Formatter::HTMLFormatter,
+      SimpleCov::Formatter::Console,
+    ]
+    if ENV['CI'] == 'true'
+      require 'codecov'
+      SimpleCov.formatters << SimpleCov::Formatter::Codecov
+    end
+
+    SimpleCov.start do
+      add_filter('/spec/')
+      add_filter('/vendor/')
+      add_group('Checks', 'lib/puppet-lint/plugins')
+    end
+  rescue LoadError
+    raise 'Add the simplecov, simplecov-console, codecov gems to Gemfile to enable this task'
   end
 end