add back some useful test

Author: xuan-cao-swi

lib/solarwinds_apm.rb

@@ -9,12 +9,12 @@
 begin
   require 'solarwinds_apm/logger'
   require 'solarwinds_apm/version'
-  require 'solarwinds_apm/noop'
   require 'opentelemetry-api'
   if ENV.fetch('SW_APM_ENABLED', 'true') == 'false'
     SolarWindsAPM.logger.info '==================================================================='
     SolarWindsAPM.logger.info 'SW_APM_ENABLED environment variable detected and was set to false. SolarWindsAPM disabled'
     SolarWindsAPM.logger.info '==================================================================='
+    require 'solarwinds_apm/noop'
     return
   end
 
@@ -36,8 +36,8 @@
         SolarWindsAPM.logger.warn 'SolarWindsAPM not loaded. SolarWinds APM disabled'
         SolarWindsAPM.logger.warn 'Please check previous log messages.'
         SolarWindsAPM.logger.warn '=============================================================='
+        require 'solarwinds_apm/noop'
       end
-
     elsif ENV['SW_APM_AUTO_CONFIGURE'] == 'false'
       SolarWindsAPM.logger.warn '=============================================================='
       SolarWindsAPM.logger.warn 'SW_APM_AUTO_CONFIGURE set to false.'
@@ -48,6 +48,7 @@
       SolarWindsAPM.logger.warn 'See: https://github.com/solarwinds/apm-ruby/blob/main/CONFIGURATION.md#in-code-configuration'
       SolarWindsAPM.logger.warn "\e[1mPlease discard this message if application have already taken this action.\e[0m"
       SolarWindsAPM.logger.warn '=============================================================='
+      require 'solarwinds_apm/noop'
     end
   end
 rescue StandardError => e

lib/solarwinds_apm/api/tracing.rb

@@ -37,7 +37,6 @@ def solarwinds_ready?(wait_milliseconds = 3000, integer_response: false)
 
         root_sampler = ::OpenTelemetry.tracer_provider.sampler.instance_variable_get(:@root)
         is_ready = root_sampler.wait_until_ready(wait_milliseconds / 1000)
-        puts "is_ready: #{is_ready}"
         !!is_ready
       end
     end

lib/solarwinds_apm/noop/api.rb

@@ -19,8 +19,9 @@ module NoopAPI
   # Tracing
   module Tracing
     # (wait_milliseconds=3000, integer_response: false)
-    def solarwinds_ready?(*_args, **options)
-      options && options[:integer_response] ? 0 : false
+    def solarwinds_ready?(_wait_milliseconds = 3000, integer_response: false)
+      _noop = integer_response
+      false
     end
   end
 

test/initest_helper.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2024 SolarWinds, LLC.
+# All rights reserved.
+
+require 'minitest'
+require 'minitest/autorun'
+require 'minitest/spec'
+require 'minitest/reporters'
+require './lib/solarwinds_apm/logger'
+
+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/")
+
+def noop_shared_test
+  _(defined?(SolarWindsAPM::API)).must_equal 'constant'
+  _(SolarWindsAPM::API.solarwinds_ready?(300)).must_equal false
+  assert_nil SolarWindsAPM::API.in_span('params')
+  _(SolarWindsAPM::API.set_transaction_name).must_equal true
+  _(SolarWindsAPM::API.current_trace_info.hash_for_log.to_s).must_equal '{}'
+  _(SolarWindsAPM::API.current_trace_info.for_log).must_equal ''
+  _(SolarWindsAPM::API.current_trace_info.tracestring).must_equal '00-00000000000000000000000000000000-0000000000000000-00'
+  _(SolarWindsAPM::API.current_trace_info.trace_flags).must_equal '00'
+  _(SolarWindsAPM::API.current_trace_info.span_id).must_equal '0000000000000000'
+  _(SolarWindsAPM::API.current_trace_info.trace_id).must_equal '00000000000000000000000000000000'
+  _(SolarWindsAPM::API.current_trace_info.do_log).must_equal :never
+
+  in_span_result = SolarWindsAPM::API.in_span('params') do |_span|
+    value = 1 + 1
+    value
+  end
+
+  _(in_span_result).must_equal 2
+end

test/run_tests.sh

@@ -93,6 +93,13 @@ for file in $RESOURCE_DETECTOR_TEST_FILE; do
   check_status
 done
 
+NUMBER_FILE=$(find test/solarwinds_apm/init_test/*_test.rb -type f | wc -l)
+for ((i = 1; i <= $NUMBER_FILE; i++)); do
+  check_file_name=init_${i}_test.rb
+  BUNDLE_GEMFILE=gemfiles/test_gems.gemfile bundle exec ruby -I test test/solarwinds_apm/init_test/init_${i}_test.rb
+  check_status
+done
+
 echo ""
 echo "--- SUMMARY ------------------------------"
 grep -E '===|failures|FAIL|ERROR' "$TEST_RUNS_FILE_NAME"

test/solarwinds_apm/init_test/init_1_test.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2024 SolarWinds, LLC.
+# All rights reserved.
+
+require 'initest_helper'
+
+describe 'solarwinds_apm_init_1' do
+  it 'SW_APM_ENABLED_set_to_disabled' do
+    puts "\n\033[1m=== TEST RUN: #{RUBY_VERSION} #{File.basename(__FILE__)} #{Time.now.strftime('%Y-%m-%d %H:%M')} ===\033[0m\n"
+
+    log_output = StringIO.new
+    SolarWindsAPM.logger = Logger.new(log_output)
+
+    ENV['SW_APM_ENABLED'] = 'false'
+
+    require './lib/solarwinds_apm'
+    assert_includes log_output.string,
+                    'SW_APM_ENABLED environment variable detected and was set to false. SolarWindsAPM disabled'
+
+    noop_shared_test
+  end
+end

test/solarwinds_apm/init_test/init_2_test.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2024 SolarWinds, LLC.
+# All rights reserved.
+
+require 'initest_helper'
+
+describe 'solarwinds_apm_init_2' do
+  it 'SW_APM_SERVICE_KEY_is_invalid' do
+    puts "\n\033[1m=== TEST RUN: #{RUBY_VERSION} #{File.basename(__FILE__)} #{Time.now.strftime('%Y-%m-%d %H:%M')} ===\033[0m\n"
+
+    log_output = StringIO.new
+    SolarWindsAPM.logger = Logger.new(log_output)
+
+    ENV['SW_APM_SERVICE_KEY'] = ':abcd'
+
+    require './lib/solarwinds_apm'
+    assert_includes log_output.string, 'SW_APM_SERVICE_KEY problem. API Token in wrong format. Masked token'
+
+    noop_shared_test
+  end
+end

test/solarwinds_apm/init_test/init_3_test.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2024 SolarWinds, LLC.
+# All rights reserved.
+
+require 'initest_helper'
+
+describe 'solarwinds_apm_init_3' do
+  it 'SW_APM_AUTO_CONFIGURE_set_to_false' do
+    puts "\n\033[1m=== TEST RUN: #{RUBY_VERSION} #{File.basename(__FILE__)} #{Time.now.strftime('%Y-%m-%d %H:%M')} ===\033[0m\n"
+
+    log_output = StringIO.new
+    SolarWindsAPM.logger = Logger.new(log_output)
+
+    ENV['SW_APM_AUTO_CONFIGURE'] = 'false'
+
+    require './lib/solarwinds_apm'
+    assert_includes log_output.string, 'SW_APM_AUTO_CONFIGURE set to false.'
+
+    noop_shared_test
+  end
+end

test/solarwinds_apm/init_test/init_4_test.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Copyright (c) 2024 SolarWinds, LLC.
+# All rights reserved.
+
+require 'initest_helper'
+
+describe 'solarwinds_apm_init_4' do
+  it 'everything_default' do
+    puts "\n\033[1m=== TEST RUN: #{RUBY_VERSION} #{File.basename(__FILE__)} #{Time.now.strftime('%Y-%m-%d %H:%M')} ===\033[0m\n"
+
+    log_output = StringIO.new
+    SolarWindsAPM.logger = Logger.new(log_output)
+
+    require './lib/solarwinds_apm'
+    assert_includes log_output.string, 'Current solarwinds_apm version:'
+  end
+end