raggedstaff/openfoodnetwork
1
0
Fork 0
mirror of https://github.com/openfoodfoundation/openfoodnetwork synced 2026-03-27 06:05:19 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #12798 from johansenja/enable-simplecov

Browse Source 
Set up code coverage metrics with simplecov
This commit is contained in:
Maikel
2024-08-28 12:07:53 +10:00
committed by GitHub
parent cfeb0afbd4 64470e977a
commit 43a366005c
7 changed files with 309 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

107
.github/workflows/build.yml vendored
View File

@@ -3,7 +3,7 @@ name: Build
on:
workflow_dispatch:
push:
branches-ignore:
branches-ignore:
- 'dependabot/**'
pull_request:
@@ -47,7 +47,7 @@ jobs:
- name: Setup redis
uses: supercharge/redis-github-action@1.4.0
with:
with:
redis-version: 6
- name: Set up Ruby
@@ -81,11 +81,19 @@ jobs:
# RSpec split test files by test examples feature - it's optional
# https://knapsackpro.com/faq/question/how-to-split-slow-rspec-test-files-by-test-examples-by-individual-it
#KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES: true
KNAPSACK_PRO_TEST_FILE_PATTERN: "{spec/controllers/**/*_spec.rb}"
KNAPSACK_PRO_TEST_FILE_PATTERN: "{spec/controllers/**/*_spec.rb}"
run: |
git show --no-patch # the commit being tested (which is often a merge due to actions/checkout@v3)
bin/rake knapsack_pro:rspec
- name: Save SimpleCov file
uses: actions/upload-artifact@v3
with:
name: simplecov-chunk-controllers-${{ matrix.ci_node_index }}
path: coverage/*.*
retention-days: 2 # doesn't need to be long, because it's the combined results that matter
if-no-files-found: ignore
models:
runs-on: ubuntu-22.04
services:
@@ -116,7 +124,7 @@ jobs:
- name: Setup redis
uses: supercharge/redis-github-action@1.4.0
with:
with:
redis-version: 6
- name: Set up Ruby
@@ -141,10 +149,18 @@ jobs:
# RSpec split test files by test examples feature - it's optional
# https://knapsackpro.com/faq/question/how-to-split-slow-rspec-test-files-by-test-examples-by-individual-it
#KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES: true
KNAPSACK_PRO_TEST_FILE_PATTERN: "{spec/models/**/*_spec.rb}"
KNAPSACK_PRO_TEST_FILE_PATTERN: "{spec/models/**/*_spec.rb}"
run: |
bin/rake knapsack_pro:rspec
- name: Save SimpleCov file
uses: actions/upload-artifact@v3
with:
name: simplecov-chunk-models-${{ matrix.ci_node_index }}
path: coverage/*.*
retention-days: 2 # doesn't need to be long, because it's the combined results that matter
if-no-files-found: ignore
system_admin:
runs-on: ubuntu-22.04
services:
@@ -175,7 +191,7 @@ jobs:
- name: Setup redis
uses: supercharge/redis-github-action@1.4.0
with:
with:
redis-version: 6
- name: Set up Ruby
@@ -209,11 +225,19 @@ jobs:
# RSpec split test files by test examples feature - it's optional
# https://knapsackpro.com/faq/question/how-to-split-slow-rspec-test-files-by-test-examples-by-individual-it
#KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES: true
KNAPSACK_PRO_TEST_FILE_PATTERN: "{spec/system/admin/**/*_spec.rb}"
KNAPSACK_PRO_TEST_FILE_PATTERN: "{spec/system/admin/**/*_spec.rb}"
run: |
bin/rake knapsack_pro:queue:rspec
- name: Save SimpleCov file
uses: actions/upload-artifact@v3
with:
name: simplecov-chunk-system-admin-${{ matrix.ci_node_index }}
path: coverage/*.*
retention-days: 2 # doesn't need to be long, because it's the combined results that matter
if-no-files-found: ignore
- name: Archive failed tests screenshots
if: failure()
uses: actions/upload-artifact@v4
@@ -247,13 +271,13 @@ jobs:
ci_node_total: [12]
# Indexes for parallel jobs (starting from zero).
# E.g. use [0, 1] for 2 parallel jobs, [0, 1, 2] for 3 parallel jobs, etc.
ci_node_index: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]
ci_node_index: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11]
steps:
- uses: actions/checkout@v3
- name: Setup redis
uses: supercharge/redis-github-action@1.4.0
with:
with:
redis-version: 6
- name: Set up Ruby
@@ -287,11 +311,19 @@ jobs:
# RSpec split test files by test examples feature - it's optional
# https://knapsackpro.com/faq/question/how-to-split-slow-rspec-test-files-by-test-examples-by-individual-it
#KNAPSACK_PRO_RSPEC_SPLIT_BY_TEST_EXAMPLES: true
KNAPSACK_PRO_TEST_FILE_PATTERN: "{spec/system/consumer/**/*_spec.rb}"
KNAPSACK_PRO_TEST_FILE_PATTERN: "{spec/system/consumer/**/*_spec.rb}"
run: |
bin/rake knapsack_pro:queue:rspec
- name: Save SimpleCov file
uses: actions/upload-artifact@v3
with:
name: simplecov-chunk-system-consumer-${{ matrix.ci_node_index }}
path: coverage/*.*
retention-days: 2 # doesn't need to be long, because it's the combined results that matter
if-no-files-found: ignore
- name: Archive failed tests screenshots
if: failure()
uses: actions/upload-artifact@v4
@@ -331,7 +363,7 @@ jobs:
- name: Setup redis
uses: supercharge/redis-github-action@1.4.0
with:
with:
redis-version: 6
- name: Set up Ruby
@@ -371,6 +403,14 @@ jobs:
run: |
bin/rake knapsack_pro:rspec
- name: Save SimpleCov file
uses: actions/upload-artifact@v3
with:
name: simplecov-chunk-engines-${{ matrix.ci_node_index }}
path: coverage/*.*
retention-days: 2 # doesn't need to be long, because it's the combined results that matter
if-no-files-found: ignore
test_the_rest:
runs-on: ubuntu-22.04
services:
@@ -401,7 +441,7 @@ jobs:
- name: Setup redis
uses: supercharge/redis-github-action@1.4.0
with:
with:
redis-version: 6
- name: Set up Ruby
@@ -439,6 +479,14 @@ jobs:
run: |
bin/rake knapsack_pro:rspec
- name: Save SimpleCov file
uses: actions/upload-artifact@v3
with:
name: simplecov-chunk-the-rest-${{ matrix.ci_node_index }}
path: coverage/*.*
retention-days: 2 # doesn't need to be long, because it's the combined results that matter
if-no-files-found: ignore
non_knapsack_jest_karma:
runs-on: ubuntu-22.04
services:
@@ -476,3 +524,38 @@ jobs:
- name: Run jest tests
run: yarn jest
collate_simplecov_results:
runs-on: ubuntu-22.04
needs:
- controllers
- models
- engines
- system_admin
- system_consumer
- test_the_rest
steps:
- uses: actions/checkout@v3
- name: Set up Ruby
uses: ruby/setup-ruby@v1
with:
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
- name: Download individual results from individual runners
uses: actions/download-artifact@v3
with:
pattern: simplecov-chunk-*
path: tmp/simplecov
merge-multiple: true
- name: collate results from each of the workers
run: bundle exec rake 'simplecov:collate_results[tmp/simplecov]'
- name: Upload collated results
uses: actions/upload-artifact@v3
with:
name: combined-simplecov-report
path: coverage/*.*
retention-days: 7
if-no-files-found: ignore

2
.simplecov
View File

@@ -14,4 +14,6 @@ SimpleCov.start 'rails' do
add_filter '/log'
add_filter '/db'
add_filter '/lib/tasks/sample_data/'
formatter SimpleCov::Formatter::SimpleFormatter
end

17
lib/tasks/simplecov.rake Normal file
View File

@@ -0,0 +1,17 @@
# frozen_string_literal: true
namespace :simplecov do
desc "Collates all result sets produced during parallel test runs"
task :collate_results, # rubocop:disable Rails/RakeEnvironment doesn't need the full env
[:path_to_results, :coverage_dir] do |_t, args|
require "simplecov"
path_to_results = args[:path_to_results].presence || "tmp/simplecov"
output_path = args[:coverage_dir].presence || "coverage"
SimpleCov.collate Dir[File.join(path_to_results, "**", ".resultset.json")], "rails" do
formatter(SimpleCov::Formatter::HTMLFormatter)
coverage_dir(output_path)
end
end
end

9
spec/base_spec_helper.rb
View File

@@ -4,8 +4,9 @@
ENV["RAILS_ENV"] ||= 'test'
# for full configuration, see .simplecov
require 'simplecov' if ENV["COVERAGE"]
require 'rubygems'
require 'pry' unless ENV['CI']
require 'view_component/test_helpers'
@@ -27,6 +28,12 @@ end
require 'knapsack_pro'
KnapsackPro::Adapters::RSpecAdapter.bind
if ENV["COVERAGE"] && defined?(SimpleCov)
KnapsackPro::Hooks::Queue.before_queue do
SimpleCov.command_name("rspec_ci_node_#{KnapsackPro::Config::Env.ci_node_index}")
end
end
# Allow connections to selenium whilst raising errors when connecting to external sites
require 'webmock/rspec'
WebMock.enable!

85
spec/fixtures/simplecov/customer/.resultset.json vendored Normal file
View File

@@ -0,0 +1,85 @@
{
"RSpec": {
"coverage": {
"/Users/josephjohansen/code/open_food_foundation/openfoodnetwork/app/models/customer.rb": {
"lines": [
null,
null,
null,
null,
null,
null,
null,
null,
null,
1,
1,
null,
1,
null,
1,
null,
1,
1,
1,
1,
1,
1,
1,
null,
1,
1,
1,
null,
1,
1,
1,
null,
1,
1,
null,
null,
null,
null,
null,
8,
1,
6,
null,
2,
2,
null,
1,
null,
1,
0,
null,
null,
1,
null,
1,
31,
null,
null,
1,
31,
null,
null,
1,
24,
null,
null,
1,
0,
0,
0,
null,
0,
null,
null
]
}
},
"timestamp": 1724235565
}
}

68
spec/fixtures/simplecov/voucher/.resultset.json vendored Normal file
View File

@@ -0,0 +1,68 @@
{
"RSpec": {
"coverage": {
"/Users/josephjohansen/code/open_food_foundation/openfoodnetwork/app/models/voucher.rb": {
"lines": [
null,
null,
1,
1,
null,
1,
null,
1,
null,
null,
null,
1,
null,
null,
null,
null,
1,
null,
1,
null,
1,
15,
null,
null,
null,
null,
null,
null,
null,
null,
1,
null,
3,
null,
null,
null,
null,
null,
null,
null,
null,
3,
null,
null,
null,
1,
1,
null,
null,
1,
1,
null,
null,
1,
1,
null,
null
]
}
},
"timestamp": 1724239602
}
}

34
spec/lib/tasks/simplecov_spec.rb Normal file
View File

@@ -0,0 +1,34 @@
# frozen_string_literal: true
require 'spec_helper'
require 'rake'
RSpec.describe "simplecov.rake" do
before(:all) do
Rake.application.rake_require("tasks/simplecov")
end
describe "simplecov:collate_results" do
context "when there are reports to merge" do
let(:input_dir) { Rails.root.join("spec/fixtures/simplecov") }
it "creates a new combined report" do
Dir.mktmpdir do |tmp_dir|
output_dir = File.join(tmp_dir, "output")
expect {
Rake.application.invoke_task(
"simplecov:collate_results[#{input_dir},#{output_dir}]"
)
}.to change { Dir.exist?(output_dir) }.
from(false).
to(true).
and change { File.exist?(File.join(output_dir, "index.html")) }.
from(false).
to(true)
end
end
end
end
end