Add SimpleCov and test coverage reporting (riscv-software-src#654)

Shehrozkashif · web-flow · commit 808077a49727 · 2025-05-14T13:07:10.000Z
Closes riscv-software-src#629 Signed-off-by: Shehroz Kashif <131602772+Shehrozkashif@users.noreply.github.com>
diff --git a/.gitignore b/.gitignore
@@ -23,3 +23,4 @@ __pycache__/
 *.bak
 *.log
 sorbet
+coverage
diff --git a/Gemfile b/Gemfile
@@ -36,3 +36,8 @@ group :development do
   gem "spoom"
   gem "tapioca", require: false
 end
+
+group :development, :test do
+  gem "minitest"
+  gem "simplecov"
+end
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -64,6 +64,7 @@ GEM
       irb (~> 1.10)
       reline (>= 0.3.8)
     diff-lcs (1.6.0)
+    docile (1.4.1)
     drb (2.2.1)
     erubi (1.13.1)
     hana (1.3.7)
@@ -176,6 +177,12 @@ GEM
     ruby-rc4 (0.1.5)
     rubyzip (2.4.1)
     securerandom (0.4.1)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.13.1)
+    simplecov_json_formatter (0.1.4)
     simpleidn (0.2.3)
     solargraph (0.52.0)
       backport (~> 1.2)
@@ -267,6 +274,7 @@ DEPENDENCIES
   ruby-prof
   ruby-prof-flamegraph!
   ruby-progressbar (~> 1.13)
+  simplecov
   solargraph
   sorbet
   sorbet-runtime
diff --git a/lib/idl/tests/test_expressions.rb b/lib/idl/tests/test_expressions.rb
@@ -1,3 +1,4 @@
+require_relative '../../test/test_helper'
 require "minitest/autorun"
 
 $root ||= (Pathname.new(__FILE__) / ".." / ".." / ".." / "..").realpath
diff --git a/lib/idl/tests/test_functions.rb b/lib/idl/tests/test_functions.rb
@@ -1,3 +1,4 @@
+require_relative '../../test/test_helper'
 require "minitest/autorun"
 
 $root ||= (Pathname.new(__FILE__) / ".." / ".." / ".." / "..").realpath
diff --git a/lib/idl/tests/test_lexer.rb b/lib/idl/tests/test_lexer.rb
@@ -1,3 +1,4 @@
+require_relative '../../test/test_helper'
 require "minitest/autorun"
 
 $root ||= (Pathname.new(__FILE__) / ".." / ".." / ".." / "..").realpath
diff --git a/lib/idl/tests/test_variables.rb b/lib/idl/tests/test_variables.rb
@@ -1,3 +1,4 @@
+require_relative '../../test/test_helper'
 require "minitest/autorun"
 
 $root ||= (Pathname.new(__FILE__) / ".." / ".." / ".." / "..").realpath
diff --git a/lib/test/test_backend_helpers.rb b/lib/test/test_backend_helpers.rb
@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'test_helper'
 require "English"
 require "minitest/autorun"
 require "backend_helpers"
diff --git a/lib/test/test_helper.rb b/lib/test/test_helper.rb
@@ -0,0 +1,14 @@
+require 'simplecov'
+
+SimpleCov.start do
+  enable_coverage :branch
+
+  add_group 'Arch Obj Models', 'arch_obj_models'
+  add_group 'IDL Core', 'idl'
+  add_group 'IDL Regression Tests', 'idl/tests'
+  add_group 'Top-level Tests', 'test'
+end
+
+puts "[SimpleCov] Coverage started."
+
+require 'minitest/autorun'
diff --git a/lib/test/test_yaml_loader.rb b/lib/test/test_yaml_loader.rb
@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'test_helper'
 require "English"
 require "fileutils"
 require "minitest/autorun"

-Original file line number
+Diff line change
 *.bak
 *.log
 sorbet
 +coverage
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+require_relative '../../test/test_helper'`
`1`	`2`	`require "minitest/autorun"`
`2`	`3`
`3`	`4`	`$root \|\|= (Pathname.new(__FILE__) / ".." / ".." / ".." / "..").realpath`