Add support for new codecov uploader

The ruby codecov uploader gem is deprecated in favor
of the codecov cli. There is a GitHub action that can be
used to upload the coverage report.

Set the CODECOV_COVERAGE_PATH env var to use
the simplecov-cobertura formatter.

See: https://docs.codecov.com/docs/deprecated-uploader-migration-guide#ruby-uploader

Author: tvdeyen

README.md

@@ -143,6 +143,33 @@ you need to do! If your setup is more complex, look at the
 [SimpleCov](https://github.com/colszowka/simplecov)
 and [codecov-ruby](https://github.com/codecov/codecov-ruby) docs.
 
+> [!WARNING]
+> The Codecov ruby uploader is deprecated.
+> Please use the Codecov CLI uploader to upload code coverage reports.
+> See https://docs.codecov.com/docs/deprecated-uploader-migration-guide#ruby-uploader for more information on upgrading.
+
+#### Using GitHub Actions
+
+The recommended way to upload coverage reports to Codecov with GitHub Actions is to use the `solidusio/test-solidus-extension`
+workflow.
+
+```yaml
+jobs:
+  RSpec:
+    env:
+      CODECOV_COVERAGE_PATH: ./coverage/coverage.xml
+    steps:
+      - uses: actions/checkout@v4
+      - name: Run extension tests
+        uses: solidusio/test-solidus-extension@main
+      - name: Upload coverage reports to Codecov
+        uses: codecov/codecov-action@v5
+        continue-on-error: true
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+          files: ${{ env.CODECOV_COVERAGE_PATH }}
+```
+
 ### RuboCop configuration
 
 solidus_dev_support includes a default [RuboCop](https://github.com/rubocop-hq/rubocop)

lib/solidus_dev_support/rspec/coverage.rb

@@ -19,6 +19,14 @@
 if ENV['CODECOV_TOKEN']
   require 'codecov'
   SimpleCov.formatter = SimpleCov::Formatter::Codecov
+  warn <<~WARN
+    DEPRECATION WARNING: The Codecov ruby uploader is deprecated.
+    Please use the Codecov CLI uploader to upload code coverage reports.
+    See https://docs.codecov.com/docs/deprecated-uploader-migration-guide#ruby-uploader for more information on upgrading.
+  WARN
+elsif ENV['CODECOV_COVERAGE_PATH']
+  require 'simplecov-cobertura'
+  SimpleCov.formatter = SimpleCov::Formatter::CoberturaFormatter
 else
-  warn "Provide a CODECOV_TOKEN environment variable to enable Codecov uploads"
+  warn "Provide a CODECOV_COVERAGE_PATH environment variable to enable Codecov uploads"
 end

solidus_dev_support.gemspec

@@ -46,5 +46,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'rubocop-rails', '~> 2.3'
   spec.add_dependency 'rubocop-rspec', '~> 2.0'
   spec.add_dependency 'selenium-webdriver', '~> 4.11'
+  spec.add_dependency 'simplecov-cobertura', '~> 2.1'
   spec.add_dependency 'solidus_core', ['>= 2.0', '< 5']
 end

spec/features/create_extension_spec.rb

@@ -131,7 +131,7 @@ def check_run_specs
       output = sh('bundle exec rspec')
       expect(output).to include('loading test_extension factories')
       expect(output).to include('1 example, 0 failures')
-      expect(output).to include(ENV['CODECOV_TOKEN'] ? 'Coverage reports upload successfully' : 'Provide a CODECOV_TOKEN environment variable to enable Codecov uploads')
+      expect(output).to include(ENV['CODECOV_TOKEN'] ? 'Coverage reports upload successfully' : 'Provide a CODECOV_COVERAGE_PATH environment variable to enable Codecov uploads')
     end
   end