new test case method

Author: xuan-cao-swi

CONTRIBUTING.md

@@ -165,19 +165,11 @@ To run the full suite:
 test/run_tests.sh
 ```
 
-To run a single test file:
+To run a single test file or single test case:
 
 ```bash
 # most tests require just the unit.gemfile dependencies
-BUNDLE_GEMFILE=gemfiles/unit.gemfile bundle update
-
-BUNDLE_GEMFILE=gemfiles/unit.gemfile bundle exec ruby -I test test/opentelemetry/solarwinds_propagator_test.rb
-```
-
-To run a specific test with 'trace_state_header' inside test case name:
-
-```bash
-BUNDLE_GEMFILE=gemfiles/unit.gemfile bundle update
-
-BUNDLE_GEMFILE=gemfiles/unit.gemfile bundle exec ruby -I test test/opentelemetry/solarwinds_propagator_test.rb -n /trace_state_header/
+bundle update
+bundle exec ruby -I test test/opentelemetry/solarwinds_propagator_test.rb
+bundle exec ruby -I test test/opentelemetry/solarwinds_propagator_test.rb -n /trace_state_header/
 ```

Gemfile

@@ -2,17 +2,45 @@
 
 source 'https://rubygems.org'
 
-# this Gemfile is very minimal
-# use rake commands or gemfiles in the gemfiles directory for testing
-
-gem 'rake', '>= 0.9.0'
+gem 'rake'
 
 group :development, :test do
+  if RUBY_VERSION < '3.0.0'
+    gem 'ffi', '<= 1.16.3' # set this version due to ffi 1.17.0 need rubygems version > 3 (https://rubygems.org/gems/ffi/versions/1.17.0-arm-linux-musl)
+    gem 'google-protobuf', '< 3.25.4'
+  elsif RUBY_VERSION < '3.1.0'
+    gem 'ffi', '<= 1.17'
+  else
+    gem 'ffi'
+  end
+  gem 'benchmark-ips', '>= 2.7.2'
+  gem 'bson'
   gem 'byebug', '>= 8.0.0'
-  gem 'irb', '>= 1.0.0' # if RUBY_VERSION >= '2.6.0'
+  gem 'e2mmap'
+  gem 'get_process_mem'
+  gem 'irb', '>= 1.0.0'
+  gem 'logging'
+  gem 'lumberjack'
   gem 'memory_profiler'
-  gem 'rubocop'
+  gem 'minitest', '< 5.25.0'
+  gem 'minitest-debugger', require: false
+  gem 'minitest-focus', '>= 1.1.2'
+  gem 'minitest-hooks', '>= 1.5.0'
+  gem 'minitest-reporters', '< 1.0.18'
+  gem 'mocha'
+  gem 'rack-cache'
+  gem 'rack-test'
+  gem 'rubocop', require: false
   gem 'rubocop-performance', require: false
   gem 'rubocop-rake', require: false
+  gem 'code-scanning-rubocop', '~> 0.6.1'
+  gem 'simplecov', require: false, group: :test
+  gem 'simplecov-console', require: false, group: :test
+  gem 'webmock' if RUBY_VERSION >= '2.0.0'
+  gem 'base64' if RUBY_VERSION >= '3.4.0'
+
+  gem 'opentelemetry-propagator-b3'
+  gem 'opentelemetry-test-helpers'
+
   gemspec
 end

gemfiles/test_gems.gemfile

@@ -30,6 +30,7 @@
   it 'test_custom_instrumentation_simple_case' do
     class MyClass
       include SolarWindsAPM::API::Tracer
+
       def new_method(param1, param2)
         param1 + param2
       end
@@ -54,6 +55,7 @@ def new_method(param1, param2)
   it 'test_custom_instrumentation_simple_case_with_custom_name_and_options' do
     class MyClass
       include SolarWindsAPM::API::Tracer
+
       def new_method(param1, param2)
         param1 + param2
       end
@@ -83,6 +85,7 @@ def self.new_method(param1, param2)
 
       class << self
         include SolarWindsAPM::API::Tracer
+
         add_tracer :new_method, 'custom_name', { attributes: { 'foo' => 'bar' }, kind: :unknown }
       end
     end

gemfiles/unit.gemfile

@@ -8,28 +8,11 @@
 require 'minitest/spec'
 require 'minitest/reporters'
 require './lib/solarwinds_apm/logger'
+require 'simplecov'
+SimpleCov.start
 
 ENV['SW_APM_SERVICE_KEY'] = 'this-is-a-dummy-api-token-for-testing-111111111111111111111111111111111:test-service'
 
-# write to a file as well as STDOUT (comes in handy with docker runs)
-# This approach preserves the coloring of pass fail, which the cli
-# `./run_tests.sh 2>&1 | tee -a test/docker_test.log` does not
-if ENV['TEST_RUNS_TO_FILE']
-  FileUtils.mkdir_p('log') # create if it doesn't exist
-  $out_file = if ENV['TEST_RUNS_FILE_NAME']
-                File.new(ENV['TEST_RUNS_FILE_NAME'], 'a')
-              else
-                File.new("log/test_direct_runs_#{Time.now.strftime('%Y%m%d_%H_%M')}.log", 'a')
-              end
-  $out_file.sync = true
-  $stdout.sync = true
-
-  def $stdout.write(string)
-    $out_file.write(string)
-    super
-  end
-end
-
 Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new
 
 $LOAD_PATH.unshift("#{Dir.pwd}/lib/")

test/api/custom_instrumentation_test.rb

@@ -18,50 +18,21 @@
 require 'lumberjack'
 require 'logging'
 require 'bson'
-require 'grpc'
 require 'pp'
 
 require './lib/solarwinds_apm/version'
 require './lib/solarwinds_apm/logger'
+require './lib/solarwinds_apm/constants'
+require 'opentelemetry-exporter-otlp-metrics'
 
-# simplecov coverage information
 require 'simplecov'
-require 'simplecov-console'
-SimpleCov.formatter = SimpleCov::Formatter::Console
-SimpleCov::Formatter::Console.max_rows = 15
-SimpleCov::Formatter::Console.max_lines = 5
-SimpleCov::Formatter::Console.missing_len = 20
 SimpleCov.start
 
 # needed by most tests
 ENV['SW_APM_SERVICE_KEY'] = 'this-is-a-dummy-api-token-for-testing-111111111111111111111111111111111:test-service'
-
-# write to a file as well as STDOUT (comes in handy with docker runs)
-# This approach preserves the coloring of pass fail, which the cli
-# `./run_tests.sh 2>&1 | tee -a test/docker_test.log` does not
-if ENV['TEST_RUNS_TO_FILE']
-  FileUtils.mkdir_p('log') # create if it doesn't exist
-  $out_file = if ENV['TEST_RUNS_FILE_NAME']
-                File.new(ENV['TEST_RUNS_FILE_NAME'], 'a')
-              else
-                File.new("log/test_direct_runs_#{Time.now.strftime('%Y%m%d_%H_%M')}.log", 'a')
-              end
-  $out_file.sync = true
-  $stdout.sync = true
-
-  def $stdout.write(string)
-    $out_file.write(string)
-    super
-  end
-end
-
-# Print out a headline in with the settings used in the test run
-puts "\n\033[1m=== TEST RUN: #{RUBY_VERSION} #{File.basename(ENV.fetch('BUNDLE_GEMFILE', nil))} #{ENV.fetch('DBTYPE', nil)} #{ENV.fetch('TEST_PREPARED_STATEMENT', nil)} #{Time.now.strftime('%Y-%m-%d %H:%M')} ===\033[0m\n" unless ENV['DBO_PATCH_TEST']
-
 ENV['RACK_ENV'] = 'test'
 Minitest::Reporters.use! Minitest::Reporters::SpecReporter.new
 
-# Bundler.require(:default, :test) # this load the solarwinds_apm library
 SolarWindsAPM.logger.level = 1
 
 # Dummy Propagator for testing

test/initest_helper.rb

@@ -5,7 +5,6 @@
 
 require 'minitest_helper'
 require './lib/solarwinds_apm/opentelemetry'
-require './lib/solarwinds_apm/constants'
 require './lib/solarwinds_apm/support/txn_name_manager'
 require './lib/solarwinds_apm/support/utils'
 require './lib/solarwinds_apm/sampling/sampling_patch'

test/minitest_helper.rb

@@ -6,7 +6,6 @@
 require 'minitest_helper'
 require './lib/solarwinds_apm/config'
 require './lib/solarwinds_apm/opentelemetry'
-require './lib/solarwinds_apm/constants'
 require './lib/solarwinds_apm/support/txn_name_manager'
 require './lib/solarwinds_apm/otel_native_config'
 require './lib/solarwinds_apm/api'

test/opentelemetry/otlp_processor_sampled_test.rb

@@ -5,7 +5,6 @@
 
 require 'minitest_helper'
 require './lib/solarwinds_apm/opentelemetry'
-require './lib/solarwinds_apm/constants'
 require './lib/solarwinds_apm/support/txn_name_manager'
 require './lib/solarwinds_apm/support/utils'
 require './lib/solarwinds_apm/sampling/sampling_patch'