Skip to content

armgit / spree

Public Imported from GitHub
0

Open Source Platform for DTC, B2B Commerce, Marketplaces & Omnichannel. REST APIs, TypeScript SDKs, and production-ready Next.js storefront. Self-host it. Own your data. No vendor lock-in. Zero platform fees.

Add Codecov coverage tracking (#13640)

Damian Legawiec74cef3c181dc
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
index 87680472fe..434c13dda1 100644
--- a/.github/workflows/tests.yml
+++ b/.github/workflows/tests.yml
@@ -146,6 +146,9 @@ jobs:
CI_ARTIFACTS: /tmp/test-artifacts
BUNDLE_JOBS: 4
BUNDLE_RETRY: 3
+ COVERAGE: true
+ COVERAGE_DIR: ${{ github.workspace }}/coverage
+ CI_SHARD: ${{ matrix.shard }}
steps:
- uses: actions/checkout@v4
@@ -211,6 +214,16 @@ jobs:
-o ${{ github.workspace }}/tmp/test-results/rspec/${{ matrix.project }}-${{ matrix.shard }}.xml \
${{ steps.specs.outputs.files }}
+ - name: Upload coverage to Codecov
+ if: always() && (github.event_name != 'pull_request' || github.event.pull_request.head.repo.full_name == github.repository)
+ uses: codecov/codecov-action@v5
+ with:
+ token: ${{ secrets.CODECOV_TOKEN }}
+ files: ${{ github.workspace }}/coverage/${{ matrix.project }}_${{ matrix.shard }}/coverage.xml
+ flags: ${{ matrix.project }}
+ name: ${{ matrix.project }}-shard-${{ matrix.shard }}
+ fail_ci_if_error: false
+
- name: Upload test results
if: always()
uses: actions/upload-artifact@v4
diff --git a/backend/Gemfile b/backend/Gemfile
index caecff7a4b..65968366ec 100644
--- a/backend/Gemfile
+++ b/backend/Gemfile
@@ -66,4 +66,5 @@ group :development, :test do
gem "spree_dev_tools"
gem "letter_opener"
gem "listen"
+ gem "simplecov-cobertura"
end
diff --git a/backend/Gemfile.lock b/backend/Gemfile.lock
index a6fc299500..b2959e8103 100644
--- a/backend/Gemfile.lock
+++ b/backend/Gemfile.lock
@@ -675,6 +675,9 @@ GEM
docile (~> 1.1)
simplecov-html (~> 0.11)
simplecov_json_formatter (~> 0.1)
+ simplecov-cobertura (3.1.0)
+ rexml
+ simplecov (~> 0.19)
simplecov-html (0.13.2)
simplecov_json_formatter (0.1.4)
solid_cable (3.0.12)
@@ -837,6 +840,7 @@ DEPENDENCIES
puma (>= 5.0)
rails (~> 8.1.2)
rubocop-rails-omakase
+ simplecov-cobertura
solid_cable
solid_cache
solid_queue
@@ -1080,6 +1084,7 @@ CHECKSUMS
selenium-webdriver (4.10.0) sha256=a322af38f9a8966a6c3ab85c365b08c5556cdef72f577905b2b42469faee9d43
simple_po_parser (1.1.6) sha256=122687d44d3de516a0e69e2f383a4180f5015e8c5ed5a7f2258f2b376f64cbf3
simplecov (0.22.0) sha256=fe2622c7834ff23b98066bb0a854284b2729a569ac659f82621fc22ef36213a5
+ simplecov-cobertura (3.1.0) sha256=6d7f38aa32c965ca2174b2e5bd88cb17138eaf629518854976ac50e628925dc5
simplecov-html (0.13.2) sha256=bd0b8e54e7c2d7685927e8d6286466359b6f16b18cb0df47b508e8d73c777246
simplecov_json_formatter (0.1.4) sha256=529418fbe8de1713ac2b2d612aa3daa56d316975d307244399fa4838c601b428
solid_cable (3.0.12) sha256=a168a54731a455d5627af48d8441ea3b554b8c1f6e6cd6074109de493e6b0460
diff --git a/backend/engines/admin/spec/spec_helper.rb b/backend/engines/admin/spec/spec_helper.rb
index 9ae5c66a5f..0c98a13dba 100644
--- a/backend/engines/admin/spec/spec_helper.rb
+++ b/backend/engines/admin/spec/spec_helper.rb
@@ -1,16 +1,28 @@
if ENV['COVERAGE']
- # Run Coverage report
require 'simplecov'
+ require 'simplecov-cobertura'
+ SimpleCov.root(ENV.fetch('GITHUB_WORKSPACE', File.expand_path('../../..', __dir__)))
+ SimpleCov.formatter = SimpleCov::Formatter::CoberturaFormatter
SimpleCov.start 'rails' do
add_group 'Libraries', 'lib/spree'
+ add_filter '/app/assets/'
+ add_filter '/app/javascript/'
+ add_filter '/app/views/'
add_filter '/bin/'
+ add_filter '/config/'
add_filter '/db/'
+ add_filter '/lib/generators/'
+ add_filter '/lib/tasks/'
add_filter '/script/'
add_filter '/spec/'
- add_filter '/lib/generators/'
+ add_filter '/vendor/'
- coverage_dir "#{ENV['COVERAGE_DIR']}/admin" if ENV['COVERAGE_DIR']
+ if ENV['COVERAGE_DIR']
+ shard = ENV.fetch('CI_SHARD', '1')
+ coverage_dir "#{ENV['COVERAGE_DIR']}/admin_#{shard}"
+ end
+ command_name "admin_shard_#{ENV.fetch('CI_SHARD', '1')}"
end
end
diff --git a/backend/engines/api/spec/spec_helper.rb b/backend/engines/api/spec/spec_helper.rb
index 92df7916ae..49643befb1 100644
--- a/backend/engines/api/spec/spec_helper.rb
+++ b/backend/engines/api/spec/spec_helper.rb
@@ -1,19 +1,24 @@
if ENV['COVERAGE']
- # Run Coverage report
require 'simplecov'
+ require 'simplecov-cobertura'
+ SimpleCov.root(ENV.fetch('GITHUB_WORKSPACE', File.expand_path('../../..', __dir__)))
+ SimpleCov.formatter = SimpleCov::Formatter::CoberturaFormatter
SimpleCov.start 'rails' do
add_group 'Serializers', 'app/serializers'
add_group 'Libraries', 'lib/spree'
add_filter '/bin/'
+ add_filter '/config/'
add_filter '/db/'
+ add_filter '/lib/spree/api/testing_support/'
add_filter '/script/'
add_filter '/spec/'
- add_filter '/lib/spree/api/testing_support/'
-
- coverage_dir "#{ENV['COVERAGE_DIR']}/api_"+ ENV.fetch('CIRCLE_NODE_INDEX', 0) if ENV['COVERAGE_DIR']
- command_name "test_" + ENV.fetch('CIRCLE_NODE_INDEX', 0)
+ if ENV['COVERAGE_DIR']
+ shard = ENV.fetch('CI_SHARD', '1')
+ coverage_dir "#{ENV['COVERAGE_DIR']}/api_#{shard}"
+ end
+ command_name "api_shard_#{ENV.fetch('CI_SHARD', '1')}"
end
end
diff --git a/backend/engines/common_spree_dependencies.rb b/backend/engines/common_spree_dependencies.rb
index 8ddfc5d5b1..2bfef1fa17 100644
--- a/backend/engines/common_spree_dependencies.rb
+++ b/backend/engines/common_spree_dependencies.rb
@@ -33,6 +33,7 @@ group :test do
gem 'rswag-specs'
gem 'jsonapi-rspec'
gem 'simplecov'
+ gem 'simplecov-cobertura'
gem 'stackprof'
gem 'webmock'
gem 'timecop'
diff --git a/backend/engines/core/spec/spec_helper.rb b/backend/engines/core/spec/spec_helper.rb
index 233c9efe94..2cf4f90068 100644
--- a/backend/engines/core/spec/spec_helper.rb
+++ b/backend/engines/core/spec/spec_helper.rb
@@ -1,6 +1,8 @@
if ENV['COVERAGE']
- # Run Coverage report
require 'simplecov'
+ require 'simplecov-cobertura'
+ SimpleCov.root(ENV.fetch('GITHUB_WORKSPACE', File.expand_path('../../..', __dir__)))
+ SimpleCov.formatter = SimpleCov::Formatter::CoberturaFormatter
SimpleCov.start 'rails' do
add_group 'Finders', 'app/finders'
add_group 'Mailers', 'app/mailers'
@@ -10,15 +12,24 @@ if ENV['COVERAGE']
add_group 'Validators', 'app/validators'
add_group 'Libraries', 'lib/spree'
+ add_filter '/app/assets/'
+ add_filter '/app/javascript/'
+ add_filter '/app/views/'
add_filter '/bin/'
+ add_filter '/config/'
add_filter '/db/'
+ add_filter '/lib/generators/'
+ add_filter '/lib/spree/testing_support/'
+ add_filter '/lib/tasks/'
add_filter '/script/'
add_filter '/spec/'
- add_filter '/lib/spree/testing_support/'
- add_filter '/lib/generators/'
+ add_filter '/vendor/'
- coverage_dir "#{ENV['COVERAGE_DIR']}/core_"+ ENV.fetch('CIRCLE_NODE_INDEX', 0) if ENV['COVERAGE_DIR']
- command_name "test_" + ENV.fetch('CIRCLE_NODE_INDEX', 0)
+ if ENV['COVERAGE_DIR']
+ shard = ENV.fetch('CI_SHARD', '1')
+ coverage_dir "#{ENV['COVERAGE_DIR']}/core_#{shard}"
+ end
+ command_name "core_shard_#{ENV.fetch('CI_SHARD', '1')}"
end
end
diff --git a/backend/engines/emails/spec/spec_helper.rb b/backend/engines/emails/spec/spec_helper.rb
index 234d325e44..45ef29619e 100644
--- a/backend/engines/emails/spec/spec_helper.rb
+++ b/backend/engines/emails/spec/spec_helper.rb
@@ -1,20 +1,29 @@
if ENV['COVERAGE']
- # Run Coverage report
require 'simplecov'
+ require 'simplecov-cobertura'
+ SimpleCov.root(ENV.fetch('GITHUB_WORKSPACE', File.expand_path('../../..', __dir__)))
+ SimpleCov.formatter = SimpleCov::Formatter::CoberturaFormatter
SimpleCov.start 'rails' do
add_group 'Models', 'app/models'
add_group 'Mailers', 'app/mailers'
add_group 'Helpers', 'app/helpers'
+ add_filter '/app/assets/'
+ add_filter '/app/views/'
add_filter '/bin/'
+ add_filter '/config/'
add_filter '/db/'
+ add_filter '/lib/generators/'
+ add_filter '/lib/spree/testing_support/'
+ add_filter '/lib/tasks/'
add_filter '/script/'
add_filter '/spec/'
- add_filter '/lib/spree/testing_support/'
- add_filter '/lib/generators/'
- coverage_dir "#{ENV['COVERAGE_DIR']}/emails_" + ENV.fetch('CIRCLE_NODE_INDEX', 0) if ENV['COVERAGE_DIR']
- command_name "test_" + ENV.fetch('CIRCLE_NODE_INDEX', 0)
+ if ENV['COVERAGE_DIR']
+ shard = ENV.fetch('CI_SHARD', '1')
+ coverage_dir "#{ENV['COVERAGE_DIR']}/emails_#{shard}"
+ end
+ command_name "emails_shard_#{ENV.fetch('CI_SHARD', '1')}"
end
end
diff --git a/backend/engines/multi_store/spec/spec_helper.rb b/backend/engines/multi_store/spec/spec_helper.rb
index dffa2bbed6..6566ffdc1f 100644
--- a/backend/engines/multi_store/spec/spec_helper.rb
+++ b/backend/engines/multi_store/spec/spec_helper.rb
@@ -1,3 +1,27 @@
+if ENV['COVERAGE']
+ require 'simplecov'
+ require 'simplecov-cobertura'
+ SimpleCov.root(ENV.fetch('GITHUB_WORKSPACE', File.expand_path('../../..', __dir__)))
+ SimpleCov.formatter = SimpleCov::Formatter::CoberturaFormatter
+ SimpleCov.start 'rails' do
+ add_group 'Libraries', 'lib/spree'
+
+ add_filter '/app/views/'
+ add_filter '/bin/'
+ add_filter '/config/'
+ add_filter '/db/'
+ add_filter '/lib/generators/'
+ add_filter '/script/'
+ add_filter '/spec/'
+
+ if ENV['COVERAGE_DIR']
+ shard = ENV.fetch('CI_SHARD', '1')
+ coverage_dir "#{ENV['COVERAGE_DIR']}/multi_store_#{shard}"
+ end
+ command_name "multi_store_shard_#{ENV.fetch('CI_SHARD', '1')}"
+ end
+end
+
# This file is copied to ~/spec when you run 'ruby script/generate rspec'
# from the project root directory.
ENV['RAILS_ENV'] ||= 'test'
diff --git a/codecov.yml b/codecov.yml
new file mode 100644
index 0000000000..5683954ce0
--- /dev/null
+++ b/codecov.yml
@@ -0,0 +1,82 @@
+codecov:
+ require_ci_to_pass: false
+
+coverage:
+ precision: 2
+ round: down
+ range: "50...90"
+ status:
+ project:
+ default:
+ target: auto
+ threshold: 1%
+ patch:
+ default:
+ target: 80%
+ threshold: 5%
+
+comment:
+ layout: "header, diff, flags, components"
+ behavior: default
+ require_changes: false
+ require_base: false
+ require_head: true
+
+flags:
+ core:
+ paths:
+ - backend/engines/core/
+ carryforward: true
+ api:
+ paths:
+ - backend/engines/api/
+ carryforward: true
+ admin:
+ paths:
+ - backend/engines/admin/
+ carryforward: true
+ emails:
+ paths:
+ - backend/engines/emails/
+ carryforward: true
+ multi_store:
+ paths:
+ - backend/engines/multi_store/
+ carryforward: true
+
+component_management:
+ individual_components:
+ - component_id: core
+ name: Core
+ paths:
+ - backend/engines/core/app/**
+ - backend/engines/core/lib/**
+ - component_id: api
+ name: API
+ paths:
+ - backend/engines/api/app/**
+ - backend/engines/api/lib/**
+ - component_id: admin
+ name: Admin
+ paths:
+ - backend/engines/admin/app/**
+ - backend/engines/admin/lib/**
+ - component_id: emails
+ name: Emails
+ paths:
+ - backend/engines/emails/app/**
+ - backend/engines/emails/lib/**
+ - component_id: multi_store
+ name: Multi Store
+ paths:
+ - backend/engines/multi_store/app/**
+ - backend/engines/multi_store/lib/**
+
+ignore:
+ - "docs/**"
+ - "packages/**"
+ - "**/spec/**"
+ - "**/test/**"
+ - "**/testing_support/**"
+ - "**/generators/**"
+ - "**/dummy/**"