test: Fix simplecov configuration (#1366)

test: start simplecov before library code is loaded

Co-authored-by: Kayla Reopelle <[email protected]>

Author: zvkemp

.github/actions/test_gem/action.yml

@@ -19,6 +19,16 @@ inputs:
     required: false
     type: boolean
     default: false
+  coverage:
+    description: Enforce test coverage
+    required: false
+    type: boolean
+    default: false
+  minimum_coverage:
+    description: Minimum test coverage
+    required: false
+    type: string
+    default: 85
   build:
     description: Build gem
     required: false
@@ -161,6 +171,14 @@ runs:
         bundle exec rake rubocop
       working-directory: "${{ steps.setup.outputs.gem_dir }}"
 
+    - name: Coverage
+      shell: bash
+      if: "${{ inputs.coverage == 'true' }}"
+      # This starts a new simplecov run which tracks nothing of its own,
+      # but merges with the existing coverage reports generated during testing.
+      run: 'bundle exec ruby -e ''require "simplecov"; SimpleCov.minimum_coverage(${{ inputs.minimum_coverage }})'''
+      working-directory: "${{ steps.setup.outputs.gem_dir }}"
+
     - name: Build Gem
       shell: bash
       if: "${{ inputs.build == 'true' }}"

.github/workflows/ci-contrib.yml

@@ -47,6 +47,7 @@ jobs:
           ruby: "3.1"
           yard: true
           rubocop: true
+          coverage: true
           build: true
       - name: "Test JRuby"
         if: "${{ matrix.os == 'ubuntu-latest' }}"
@@ -125,6 +126,7 @@ jobs:
           ruby: "3.1"
           yard: true
           rubocop: true
+          coverage: true
           build: true
       - name: "Test JRuby"
         if: "${{ matrix.os == 'ubuntu-latest' }}"
@@ -162,6 +164,7 @@ jobs:
           ruby: "3.1"
           yard: true
           rubocop: true
+          coverage: true
           build: true
       - name: "Test JRuby"
         if: "${{ matrix.os == 'ubuntu-latest' && steps.jruby_skip.outputs.skip == 'false' }}"

.github/workflows/ci-instrumentation-with-services.yml

@@ -46,6 +46,7 @@ jobs:
           ruby: "3.1"
           yard: true
           rubocop: true
+          coverage: true
           build: true
       - name: "Test JRuby"
         uses: ./.github/actions/test_gem
@@ -92,6 +93,7 @@ jobs:
           ruby: "3.1"
           yard: true
           rubocop: true
+          coverage: true
           build: true
     services:
       mysql:
@@ -129,6 +131,7 @@ jobs:
           ruby: "3.1"
           yard: true
           rubocop: true
+          coverage: true
           build: true
     services:
       zookeeper:
@@ -182,6 +185,7 @@ jobs:
           ruby: "3.1"
           yard: true
           rubocop: true
+          coverage: true
           build: true
     services:
       redis:
@@ -226,6 +230,7 @@ jobs:
           ruby: "3.1"
           yard: true
           rubocop: true
+          coverage: true
           build: true
     services:
       postgres:
@@ -267,6 +272,7 @@ jobs:
           ruby: "3.1"
           yard: true
           rubocop: true
+          coverage: true
           build: true
     services:
       rabbitmq:

.github/workflows/ci-instrumentation.yml

@@ -73,10 +73,11 @@ jobs:
       - name: "Test Ruby 3.1"
         uses: ./.github/actions/test_gem
         with:
-          gem:  "opentelemetry-instrumentation-${{ matrix.gem }}"
+          gem: "opentelemetry-instrumentation-${{ matrix.gem }}"
           ruby: "3.1"
           yard: true
           rubocop: true
+          coverage: true
           build: true
       - name: "JRuby Filter"
         id: jruby_skip

.simplecov

@@ -0,0 +1,14 @@
+require 'digest'
+
+digest = Digest::MD5.new
+digest.update('test')
+digest.update(ENV.fetch('BUNDLE_GEMFILE', 'gemfile')) if ENV['APPRAISAL_INITIALIZED']
+
+ENV['ENABLE_COVERAGE'] ||= '1'
+
+if ENV['ENABLE_COVERAGE'].to_i.positive?
+  SimpleCov.command_name(digest.hexdigest)
+  SimpleCov.start do
+    add_filter %r{^/test/}
+  end
+end

helpers/mysql/test/test_helper.rb

@@ -4,6 +4,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'simplecov'
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)
 

helpers/sql-obfuscation/opentelemetry-helpers-sql-obfuscation.gemspec

@@ -33,6 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rubocop', '~> 1.71.0'
   spec.add_development_dependency 'rubocop-performance', '~> 1.23.0'
+  spec.add_development_dependency 'simplecov', '~> 0.22.0'
   spec.add_development_dependency 'yard', '~> 0.9'
   spec.add_development_dependency 'yard-doctest', '~> 0.1.6'
 

helpers/sql-obfuscation/test/test_helper.rb

@@ -4,6 +4,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'simplecov'
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)
 

instrumentation/action_mailer/test/test_helper.rb

@@ -4,6 +4,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'simplecov'
 require 'logger'
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)

instrumentation/action_pack/test/test_helper.rb

@@ -4,6 +4,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'simplecov'
 require 'logger'
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)