test: start simplecov before library code is loaded

zvkemp · zvkemp · commit 7ce0306c2ac9 · 2025-01-28T10:16:56.000-05:00
diff --git a/.github/actions/test_gem/action.yml b/.github/actions/test_gem/action.yml
@@ -19,6 +19,16 @@ inputs:
     required: false
     type: boolean
     default: false
+  coverage:
+    description: Enforce SimpleCov
+    required: false
+    type: boolean
+    default: true
+  minimum_coverage:
+    description: Minimum test coverage
+    required: false
+    type: string
+    default: 85
   build:
     description: Build gem
     required: false
@@ -153,6 +163,13 @@ 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 -rsimplecov -e 'SimpleCov.minimum_coverage(${{ inputs.minimum_coverage }})'"
+
     - name: Build Gem
       shell: bash
       if: "${{ inputs.build == 'true' }}"
diff --git a/.github/workflows/ci-instrumentation.yml b/.github/workflows/ci-instrumentation.yml
@@ -72,10 +72,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
diff --git a/.simplecov b/.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
diff --git a/helpers/mysql/test/test_helper.rb b/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)
 
diff --git a/instrumentation/action_mailer/test/test_helper.rb b/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)
diff --git a/instrumentation/action_pack/test/test_helper.rb b/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)
diff --git a/instrumentation/action_view/test/test_helper.rb b/instrumentation/action_view/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)
diff --git a/instrumentation/active_job/test/test_helper.rb b/instrumentation/active_job/test/test_helper.rb
@@ -5,6 +5,7 @@
 # SPDX-License-Identifier: Apache-2.0
 ENV['OTEL_LOG_LEVEL'] ||= 'fatal'
 
+require 'simplecov'
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)
 
diff --git a/instrumentation/active_model_serializers/test/test_helper.rb b/instrumentation/active_model_serializers/test/test_helper.rb
@@ -4,6 +4,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'simplecov'
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)
 
diff --git a/instrumentation/active_record/test/test_helper.rb b/instrumentation/active_record/test/test_helper.rb
@@ -4,6 +4,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'simplecov'
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)
 
diff --git a/instrumentation/active_support/test/test_helper.rb b/instrumentation/active_support/test/test_helper.rb
@@ -4,6 +4,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'simplecov'
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)
 
diff --git a/instrumentation/all/test/test_helper.rb b/instrumentation/all/test/test_helper.rb
@@ -4,6 +4,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'simplecov'
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)
 
diff --git a/instrumentation/aws_lambda/test/test_helper.rb b/instrumentation/aws_lambda/test/test_helper.rb
@@ -4,6 +4,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'simplecov'
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)
 
diff --git a/instrumentation/aws_sdk/test/test_helper.rb b/instrumentation/aws_sdk/test/test_helper.rb
@@ -4,6 +4,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'simplecov'
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)
 
diff --git a/instrumentation/base/test/test_helper.rb b/instrumentation/base/test/test_helper.rb
@@ -4,12 +4,10 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'simplecov'
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)
 
-SimpleCov.start
-SimpleCov.minimum_coverage 85
-
 require 'opentelemetry-instrumentation-base'
 require 'minitest/autorun'
 
diff --git a/instrumentation/bunny/test/test_helper.rb b/instrumentation/bunny/test/test_helper.rb
@@ -4,6 +4,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'simplecov'
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)
 
diff --git a/instrumentation/concurrent_ruby/test/test_helper.rb b/instrumentation/concurrent_ruby/test/test_helper.rb
@@ -4,6 +4,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'simplecov'
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)
 
diff --git a/instrumentation/dalli/test/test_helper.rb b/instrumentation/dalli/test/test_helper.rb
@@ -4,6 +4,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'simplecov'
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)
 
diff --git a/instrumentation/delayed_job/test/test_helper.rb b/instrumentation/delayed_job/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)
diff --git a/instrumentation/ethon/test/test_helper.rb b/instrumentation/ethon/test/test_helper.rb
@@ -4,6 +4,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'simplecov'
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)
 
diff --git a/instrumentation/excon/test/test_helper.rb b/instrumentation/excon/test/test_helper.rb
@@ -4,6 +4,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'simplecov'
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)
 
diff --git a/instrumentation/faraday/test/test_helper.rb b/instrumentation/faraday/test/test_helper.rb
@@ -4,6 +4,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'simplecov'
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)
 
diff --git a/instrumentation/grape/test/test_helper.rb b/instrumentation/grape/test/test_helper.rb
@@ -4,6 +4,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'simplecov'
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)
 
diff --git a/instrumentation/graphql/test/test_helper.rb b/instrumentation/graphql/test/test_helper.rb
@@ -4,6 +4,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'simplecov'
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)
 
diff --git a/instrumentation/grpc/test/test_helper.rb b/instrumentation/grpc/test/test_helper.rb
@@ -4,6 +4,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'simplecov'
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)
 
diff --git a/instrumentation/gruf/test/test_helper.rb b/instrumentation/gruf/test/test_helper.rb
@@ -4,6 +4,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'simplecov'
 require 'opentelemetry/sdk'
 require 'minitest/autorun'
 require 'webmock/minitest'
diff --git a/instrumentation/http/test/test_helper.rb b/instrumentation/http/test/test_helper.rb
@@ -4,6 +4,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'simplecov'
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)
 
diff --git a/instrumentation/http_client/test/test_helper.rb b/instrumentation/http_client/test/test_helper.rb
@@ -4,6 +4,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'simplecov'
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)
 
diff --git a/instrumentation/httpx/test/test_helper.rb b/instrumentation/httpx/test/test_helper.rb
@@ -4,6 +4,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'simplecov'
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)
 
diff --git a/instrumentation/koala/test/test_helper.rb b/instrumentation/koala/test/test_helper.rb
@@ -4,6 +4,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'simplecov'
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)
 
diff --git a/instrumentation/lmdb/test/test_helper.rb b/instrumentation/lmdb/test/test_helper.rb
@@ -4,6 +4,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'simplecov'
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)
 
diff --git a/instrumentation/mongo/test/test_helper.rb b/instrumentation/mongo/test/test_helper.rb
@@ -4,6 +4,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'simplecov'
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)
 
diff --git a/instrumentation/mysql2/test/test_helper.rb b/instrumentation/mysql2/test/test_helper.rb
@@ -4,6 +4,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'simplecov'
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)
 
diff --git a/instrumentation/net_http/test/test_helper.rb b/instrumentation/net_http/test/test_helper.rb
@@ -4,6 +4,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'simplecov'
 require 'net/http'
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)
diff --git a/instrumentation/pg/test/test_helper.rb b/instrumentation/pg/test/test_helper.rb
@@ -4,6 +4,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'simplecov'
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)
 
diff --git a/instrumentation/que/test/test_helper.rb b/instrumentation/que/test/test_helper.rb
@@ -4,6 +4,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'simplecov'
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)
 
diff --git a/instrumentation/racecar/test/test_helper.rb b/instrumentation/racecar/test/test_helper.rb
@@ -4,6 +4,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'simplecov'
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)
 
diff --git a/instrumentation/rack/test/test_helper.rb b/instrumentation/rack/test/test_helper.rb
@@ -4,6 +4,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'simplecov'
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)
 require 'rack/events'
diff --git a/instrumentation/rails/Rakefile b/instrumentation/rails/Rakefile
@@ -23,10 +23,14 @@ namespace :test do
     t.libs << 'test/railtie'
     t.test_files = FileList['test/railtie/**/*_test.rb']
   end
+
+  task :start_coverage do
+    require 'simplecov'
+  end
 end
 
 desc 'Run all tests'
-task test: %i[test:instrumentation test:railtie]
+task test: %i[test:start_coverage test:instrumentation test:railtie]
 
 YARD::Rake::YardocTask.new do |t|
   t.stats_options = ['--list-undoc']
diff --git a/instrumentation/rails/test/instrumentation/test_helper.rb b/instrumentation/rails/test/instrumentation/test_helper.rb
@@ -5,6 +5,7 @@
 # SPDX-License-Identifier: Apache-2.0
 
 require 'logger'
+require 'simplecov'
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)
 
diff --git a/instrumentation/rails/test/railtie/test_helper.rb b/instrumentation/rails/test/railtie/test_helper.rb
@@ -9,10 +9,10 @@
 ENV['RAILS_ENV'] = 'test'
 
 require 'logger'
+require 'simplecov'
+
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)
 
 require_relative '../../test/railtie/dummy/config/environment'
 require 'rails/test_help'
-
-SimpleCov.start
diff --git a/instrumentation/rake/test/test_helper.rb b/instrumentation/rake/test/test_helper.rb
@@ -4,6 +4,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'simplecov'
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)
 
diff --git a/instrumentation/rdkafka/test/test_helper.rb b/instrumentation/rdkafka/test/test_helper.rb
@@ -4,6 +4,7 @@
 #
 # SPDX-License-Identifier: Apache-2.0
 
+require 'simplecov'
 require 'bundler/setup'
 Bundler.require(:default, :development, :test)
 
diff --git a/instrumentation/redis/test/test_helper.rb b/instrumentation/redis/test/test_helper.rb
diff --git a/instrumentation/resque/test/test_helper.rb b/instrumentation/resque/test/test_helper.rb
diff --git a/instrumentation/restclient/test/test_helper.rb b/instrumentation/restclient/test/test_helper.rb
diff --git a/instrumentation/rspec/test/test_helper.rb b/instrumentation/rspec/test/test_helper.rb
diff --git a/instrumentation/ruby_kafka/test/test_helper.rb b/instrumentation/ruby_kafka/test/test_helper.rb
diff --git a/instrumentation/sidekiq/test/test_helper.rb b/instrumentation/sidekiq/test/test_helper.rb
diff --git a/instrumentation/sinatra/test/test_helper.rb b/instrumentation/sinatra/test/test_helper.rb
diff --git a/instrumentation/trilogy/test/test_helper.rb b/instrumentation/trilogy/test/test_helper.rb
diff --git a/processor/baggage/Rakefile b/processor/baggage/Rakefile
diff --git a/processor/baggage/test/test_helper.rb b/processor/baggage/test/test_helper.rb
diff --git a/propagator/ottrace/Rakefile b/propagator/ottrace/Rakefile
diff --git a/propagator/ottrace/test/test_helper.rb b/propagator/ottrace/test/test_helper.rb
diff --git a/propagator/vitess/Rakefile b/propagator/vitess/Rakefile
diff --git a/propagator/vitess/test/test_helper.rb b/propagator/vitess/test/test_helper.rb
diff --git a/propagator/xray/test/test_helper.rb b/propagator/xray/test/test_helper.rb
diff --git a/resources/azure/test/test_helper.rb b/resources/azure/test/test_helper.rb
diff --git a/resources/container/test/test_helper.rb b/resources/container/test/test_helper.rb
diff --git a/resources/google_cloud_platform/test/test_helper.rb b/resources/google_cloud_platform/test/test_helper.rb

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`	`#`
`5`	`5`	`# SPDX-License-Identifier: Apache-2.0`
`6`	`6`
	`7`	`+require 'simplecov'`
`7`	`8`	`require 'bundler/setup'`
`8`	`9`	`Bundler.require(:default, :development, :test)`
`9`	`10`