DI: eliminate Ruby warnings in test suite (#4950)

Co-authored-by: Oleg Pudeyev <[email protected]>

Author: p-datadog

spec/datadog/di/hook_line_load.rb

@@ -1,17 +1,37 @@
-# Comment line - not executable
+# This file is loaded repeatedly in the test suite due to the way DI performs
+# code tracking. Remove the constants if they have already been defined
+# to avoid Ruby warnings.
+begin
+  Object.send(:remove_const, :HookLineLoadTestClass)
+  Object.send(:remove_const, :HookLineIvarLoadTestClass)
+rescue NameError
+end
+
+# padding
+# padding
+# padding
+# padding
+# padding
+# padding
+# padding
+# padding
+# padding
+# padding
+
+# Comment line - not executable - line 21
 
 class HookLineLoadTestClass
-  def test_method       # Line 4
-    42                  # Line 5
-  end                   # Line 6
+  def test_method       # Line 24
+    42                  # Line 25
+  end                   # Line 26
 
   def test_method_with_local
     local = 42 # standard:disable Style/RedundantAssignment
-    local               # Line 10 # standard:disable Style/RedundantAssignment
+    local               # Line 30 # standard:disable Style/RedundantAssignment
   end
 
   def test_method_with_arg(arg)
-    arg                 # Line 14
+    arg                 # Line 34
   end
 end
 
@@ -24,16 +44,16 @@ def initialize
   end
 
   def test_method
-    1337                 # Line 24
+    1337                 # Line 47
   end
 
   def test_exception
     local = 42
-    raise TestException, 'Intentional exception'       # Line 32
-    local               # Line 33 # standard:disable Lint/UnreachableCode
+    raise TestException, 'Intentional exception'       # Line 52
+    local               # Line 53 # standard:disable Lint/UnreachableCode
   end
 end
 
-unless (actual = File.read(__FILE__).count("\n")) == 39
-  raise "Wrong number of lines in hook_line_load.rb: actual #{actual}, expected 39"
+unless (actual = File.read(__FILE__).count("\n")) == 59
+  raise "Wrong number of lines in hook_line_load.rb: actual #{actual}, expected 59"
 end

spec/datadog/di/hook_line_recursive.rb

@@ -1,17 +1,27 @@
+# This file is loaded repeatedly in the test suite due to the way DI performs
+# code tracking. Remove the constants if they have already been defined
+# to avoid Ruby warnings.
+begin
+  Object.send(:remove_const, :HookLineRecursiveTestClass)
+rescue NameError
+end
+
+# padding
+
 class HookLineRecursiveTestClass
   def recursive(depth)
-    if depth > 0        # Line 3
+    if depth > 0        # Line 13
       recursive(depth - 1) + '-'
     else
       '+'
     end
   end
 
   def infinitely_recursive(depth = 0)
-    infinitely_recursive(depth + 1)     # Line 11
+    infinitely_recursive(depth + 1)     # Line 21
   end
 end
 
-unless (actual = File.read(__FILE__).count("\n")) == 17
+unless (actual = File.read(__FILE__).count("\n")) == 27
   raise "Wrong number of lines in hook_line_recursive.rb: actual #{actual}, expected 17"
 end

spec/datadog/di/hook_line_targeted.rb

@@ -1,9 +1,19 @@
+# This file is loaded repeatedly in the test suite due to the way DI performs
+# code tracking. Remove the constants if they have already been defined
+# to avoid Ruby warnings.
+begin
+  Object.send(:remove_const, :HookLineTargetedTestClass)
+rescue NameError
+end
+
+# padding
+
 class HookLineTargetedTestClass
-  def test_method       # Line 2
-    42                  # Line 3
+  def test_method       # Line 12
+    42                  # Line 13
   end
 end
 
-unless (actual = File.read(__FILE__).count("\n")) == 9
+unless (actual = File.read(__FILE__).count("\n")) == 19
   raise "Wrong number of lines in hook_line_targeted.rb: actual #{actual}, expected 9"
 end

spec/datadog/di/hook_method.rb

@@ -1,3 +1,19 @@
+# This file is loaded repeatedly in the test suite due to the way DI performs
+# code tracking. Remove the constants if they have already been defined
+# to avoid Ruby warnings.
+begin
+  Object.send(:remove_const, :HookTestClass)
+rescue NameError
+end
+begin
+  Object.send(:remove_const, :YieldingMethodMissingHookTestClass)
+rescue NameError
+end
+begin
+  Object.send(:remove_const, :HookIvarTestClass)
+rescue NameError
+end
+
 class HookTestClass
   class TestException < StandardError
   end

spec/datadog/di/instrumenter_spec.rb

@@ -1008,7 +1008,7 @@
         end
 
         let(:probe) do
-          Datadog::DI::Probe.new(file: 'hook_line_load.rb', line_no: 5,
+          Datadog::DI::Probe.new(file: 'hook_line_load.rb', line_no: 25,
             id: 1, type: :log, rate_limit: rate_limit)
         end
 
@@ -1060,7 +1060,7 @@
         let(:code_tracker) { nil }
 
         let(:probe) do
-          Datadog::DI::Probe.new(file: 'hook_line_load.rb', line_no: 1,
+          Datadog::DI::Probe.new(file: 'hook_line_load.rb', line_no: 21,
             id: 1, type: :log)
         end
 
@@ -1096,7 +1096,7 @@
         end
 
         let(:probe) do
-          Datadog::DI::Probe.new(file: 'hook_line_load.rb', line_no: 1,
+          Datadog::DI::Probe.new(file: 'hook_line_load.rb', line_no: 21,
             id: 1, type: :log)
         end
 
@@ -1240,7 +1240,7 @@
       end
 
       let(:probe) do
-        Datadog::DI::Probe.new(file: 'hook_line_targeted.rb', line_no: 3,
+        Datadog::DI::Probe.new(file: 'hook_line_targeted.rb', line_no: 13,
           id: 1, type: :log)
       end
 
@@ -1249,7 +1249,7 @@
         target = code_tracker.send(:registry)[path]
         expect(target).to be_a(RubyVM::InstructionSequence)
 
-        expect_any_instance_of(TracePoint).to receive(:enable).with(target: target, target_line: 3).and_call_original
+        expect_any_instance_of(TracePoint).to receive(:enable).with(target: target, target_line: 13).and_call_original
 
         instrumenter.hook_line(probe) do |payload|
           observed_calls << payload
@@ -1267,7 +1267,7 @@
         end
 
         let(:probe) do
-          Datadog::DI::Probe.new(file: 'hook_line_load.rb', line_no: 6,
+          Datadog::DI::Probe.new(file: 'hook_line_load.rb', line_no: 26,
             id: 1, type: :log, rate_limit: rate_limit)
         end
 
@@ -1332,7 +1332,7 @@
 
       context 'non-enriched probe' do
         let(:probe_args) do
-          {file: 'hook_line_recursive.rb', line_no: 3}
+          {file: 'hook_line_recursive.rb', line_no: 13}
         end
 
         it 'invokes callback for every method invocation' do
@@ -1365,7 +1365,7 @@
       include_context 'with code tracking'
 
       before do
-        require_relative 'hook_line_recursive'
+        load File.join(File.dirname(__FILE__), 'hook_line_recursive.rb')
       end
 
       # We need to use a rate limiter, otherwise the stack is exhausted
@@ -1377,7 +1377,7 @@
 
       context 'non-enriched probe' do
         let(:probe) do
-          Datadog::DI::Probe.new(file: 'hook_line_recursive.rb', line_no: 11,
+          Datadog::DI::Probe.new(file: 'hook_line_recursive.rb', line_no: 21,
             id: 1, type: :log, rate_limit: rate_limit)
         end
 
@@ -1408,7 +1408,7 @@
       end
 
       let(:probe) do
-        Datadog::DI::Probe.new(file: 'hook_line_load.rb', line_no: 32,
+        Datadog::DI::Probe.new(file: 'hook_line_load.rb', line_no: 52,
           id: 1, type: :log, rate_limit: rate_limit)
       end
 
@@ -1436,7 +1436,7 @@
       include_context 'with code tracking'
 
       let(:probe) do
-        Datadog::DI::Probe.new(file: 'hook_line_load.rb', line_no: 10,
+        Datadog::DI::Probe.new(file: 'hook_line_load.rb', line_no: 30,
           id: 1, type: :log, rate_limit: rate_limit, condition: condition)
       end
 
@@ -1489,7 +1489,7 @@
 
       context 'when condition is on instance variable' do
         let(:probe) do
-          Datadog::DI::Probe.new(file: 'hook_line_load.rb', line_no: 24,
+          Datadog::DI::Probe.new(file: 'hook_line_load.rb', line_no: 47,
             id: 1, type: :log, rate_limit: rate_limit, condition: condition)
         end
 

spec/datadog/di/integration/everything_from_remote_config_spec.rb

@@ -612,7 +612,7 @@ def assert_received_and_errored
         {
           id: '11', name: 'bar', type: 'LOG_PROBE',
           where: {
-            sourceFile: 'hook_line_load.rb', lines: [14],
+            sourceFile: 'hook_line_load.rb', lines: [34],
           },
           when: {json: {'contains' => [{'ref' => 'bar'}, 'baz']}, dsl: '(expression)'},
         }

spec/datadog/di/integration/instrumentation_integration_test_class.rb

@@ -11,8 +11,8 @@ def method_with_no_locals
 
   def test_method
     a = 21
-    password = 'password'
-    redacted = {b: 33, session: 'blah'}
+    $__password = password = 'password'
+    $__redacted = redacted = {b: 33, session: 'blah'}
     # The following condition causes instrumentation trace point callback
     # to be invoked multiple times in CircleCI on Ruby 3.0-3.2 and 3.4
     #if true || password || redacted

spec/datadog/di/integration/instrumentation_integration_test_class_2.rb

@@ -3,8 +3,8 @@
 class InstrumentationIntegrationTestClass2
   def test_method
     a = 21
-    password = 'password'
-    redacted = {b: 33, session: 'blah'}
+    $__password = password = 'password'
+    $__redacted = redacted = {b: 33, session: 'blah'}
     # padding
     # padding
     a * 2 # line 10

spec/datadog/di/integration/instrumentation_integration_test_class_3.rb

@@ -3,8 +3,8 @@
 class InstrumentationIntegrationTestClass3
   def test_method
     a = 21
-    password = 'password'
-    redacted = {b: 33, session: 'blah'}
+    $__password = password = 'password'
+    $__redacted = redacted = {b: 33, session: 'blah'}
     # padding
     # padding
     a * 2 # line 10

spec/datadog/di/integration/instrumentation_integration_test_class_4.rb

@@ -3,8 +3,8 @@
 class InstrumentationIntegrationTestClass4
   def test_method
     a = 21
-    password = 'password'
-    redacted = {b: 33, session: 'blah'}
+    $__password = password = 'password'
+    $__redacted = redacted = {b: 33, session: 'blah'}
     # padding
     # padding
     a * 2 # line 10