|
| 1 | +# SPDX-License-Identifier: MIT |
| 2 | + |
| 3 | +require 'minitest/autorun' |
| 4 | +require_relative '../codetracer/kernel_patches' # Adjust path as necessary |
| 5 | + |
| 6 | +class MockTracer |
| 7 | + attr_reader :events, :name |
| 8 | + |
| 9 | + def initialize(name = "tracer") |
| 10 | + @events = [] |
| 11 | + @name = name |
| 12 | + end |
| 13 | + |
| 14 | + def record_event(path, lineno, content) |
| 15 | + @events << { path: path, lineno: lineno, content: content } |
| 16 | + end |
| 17 | + |
| 18 | + def clear_events |
| 19 | + @events = [] |
| 20 | + end |
| 21 | +end |
| 22 | + |
| 23 | +class TestKernelPatches < Minitest::Test |
| 24 | + def setup |
| 25 | + @tracer1 = MockTracer.new("tracer1") |
| 26 | + @tracer2 = MockTracer.new("tracer2") |
| 27 | + # Ensure a clean state before each test by attempting to clear any existing tracers |
| 28 | + # This is a bit of a hack, ideally KernelPatches would offer a reset or more direct access |
| 29 | + current_tracers = Codetracer::KernelPatches.class_variable_get(:@@tracers).dup |
| 30 | + current_tracers.each do |tracer| |
| 31 | + Codetracer::KernelPatches.uninstall(tracer) |
| 32 | + end |
| 33 | + end |
| 34 | + |
| 35 | + def teardown |
| 36 | + # Ensure all tracers are uninstalled after each test |
| 37 | + current_tracers = Codetracer::KernelPatches.class_variable_get(:@@tracers).dup |
| 38 | + current_tracers.each do |tracer| |
| 39 | + Codetracer::KernelPatches.uninstall(tracer) |
| 40 | + end |
| 41 | + # Verify that original methods are restored if no tracers are left |
| 42 | + assert_empty Codetracer::KernelPatches.class_variable_get(:@@tracers), "Tracers should be empty after teardown" |
| 43 | + assert_empty Codetracer::KernelPatches.class_variable_get(:@@original_methods), "Original methods should be cleared if no tracers are left" |
| 44 | + end |
| 45 | + |
| 46 | + def test_patching_and_basic_event_recording |
| 47 | + Codetracer::KernelPatches.install(@tracer1) |
| 48 | + |
| 49 | + expected_line_p = __LINE__; p 'hello' |
| 50 | + expected_line_puts = __LINE__; puts 'world' |
| 51 | + expected_line_print = __LINE__; print 'test' |
| 52 | + |
| 53 | + assert_equal 3, @tracer1.events.size |
| 54 | + |
| 55 | + event_p = @tracer1.events[0] |
| 56 | + assert_equal __FILE__, event_p[:path] |
| 57 | + assert_equal expected_line_p, event_p[:lineno] |
| 58 | + assert_equal "\"hello\"", event_p[:content] # p uses inspect |
| 59 | + |
| 60 | + event_puts = @tracer1.events[1] |
| 61 | + assert_equal __FILE__, event_puts[:path] |
| 62 | + assert_equal expected_line_puts, event_puts[:lineno] |
| 63 | + assert_equal "world", event_puts[:content] |
| 64 | + |
| 65 | + event_print = @tracer1.events[2] |
| 66 | + assert_equal __FILE__, event_print[:path] |
| 67 | + assert_equal expected_line_print, event_print[:lineno] |
| 68 | + assert_equal "test", event_print[:content] |
| 69 | + |
| 70 | + Codetracer::KernelPatches.uninstall(@tracer1) |
| 71 | + end |
| 72 | + |
| 73 | + def test_multiple_tracers |
| 74 | + Codetracer::KernelPatches.install(@tracer1) |
| 75 | + Codetracer::KernelPatches.install(@tracer2) |
| 76 | + |
| 77 | + expected_line_multi = __LINE__; p 'multitest' |
| 78 | + |
| 79 | + assert_equal 1, @tracer1.events.size |
| 80 | + assert_equal 1, @tracer2.events.size |
| 81 | + |
| 82 | + event1_multi = @tracer1.events.first |
| 83 | + assert_equal __FILE__, event1_multi[:path] |
| 84 | + assert_equal expected_line_multi, event1_multi[:lineno] |
| 85 | + assert_equal "\"multitest\"", event1_multi[:content] |
| 86 | + |
| 87 | + event2_multi = @tracer2.events.first |
| 88 | + assert_equal __FILE__, event2_multi[:path] |
| 89 | + assert_equal expected_line_multi, event2_multi[:lineno] |
| 90 | + assert_equal "\"multitest\"", event2_multi[:content] |
| 91 | + |
| 92 | + Codetracer::KernelPatches.uninstall(@tracer1) |
| 93 | + @tracer1.clear_events |
| 94 | + @tracer2.clear_events |
| 95 | + |
| 96 | + expected_line_one_left = __LINE__; p 'one left' |
| 97 | + |
| 98 | + assert_empty @tracer1.events, "Tracer1 should have no events after being uninstalled" |
| 99 | + assert_equal 1, @tracer2.events.size |
| 100 | + |
| 101 | + event2_one_left = @tracer2.events.first |
| 102 | + assert_equal __FILE__, event2_one_left[:path] |
| 103 | + assert_equal expected_line_one_left, event2_one_left[:lineno] |
| 104 | + assert_equal "\"one left\"", event2_one_left[:content] |
| 105 | + |
| 106 | + Codetracer::KernelPatches.uninstall(@tracer2) |
| 107 | + end |
| 108 | + |
| 109 | + def test_restoration_of_original_methods |
| 110 | + Codetracer::KernelPatches.install(@tracer1) |
| 111 | + Codetracer::KernelPatches.uninstall(@tracer1) |
| 112 | + |
| 113 | + # To truly test restoration, we'd capture stdout. Here, we focus on the tracer not being called. |
| 114 | + # If KernelPatches is working, uninstalling the last tracer should remove the patches. |
| 115 | + p 'original restored' # This line's output will go to actual stdout |
| 116 | + |
| 117 | + assert_empty @tracer1.events, "Tracer should not record events after being uninstalled and patches removed" |
| 118 | + end |
| 119 | + |
| 120 | + def test_correct_event_arguments |
| 121 | + Codetracer::KernelPatches.install(@tracer1) |
| 122 | + |
| 123 | + arg_obj = { key: "value", number: 123 } |
| 124 | + |
| 125 | + expected_line_p_detailed = __LINE__; p "detailed_p", arg_obj |
| 126 | + expected_line_puts_detailed = __LINE__; puts "detailed_puts", arg_obj.to_s |
| 127 | + expected_line_print_detailed = __LINE__; print "detailed_print", arg_obj.to_s |
| 128 | + |
| 129 | + assert_equal 3, @tracer1.events.size |
| 130 | + |
| 131 | + event_p = @tracer1.events[0] |
| 132 | + assert_equal __FILE__, event_p[:path], "Path for p mismatch" |
| 133 | + assert_equal expected_line_p_detailed, event_p[:lineno], "Line number for p mismatch" |
| 134 | + # p calls inspect on each argument and joins with newline if multiple, but here it's one string then obj |
| 135 | + assert_equal "\"detailed_p\"\n{:key=>\"value\", :number=>123}", event_p[:content], "Content for p mismatch" |
| 136 | + |
| 137 | + |
| 138 | + event_puts = @tracer1.events[1] |
| 139 | + assert_equal __FILE__, event_puts[:path], "Path for puts mismatch" |
| 140 | + assert_equal expected_line_puts_detailed, event_puts[:lineno], "Line number for puts mismatch" |
| 141 | + # puts calls to_s on each argument and prints each on a new line |
| 142 | + assert_equal "detailed_puts\n{:key=>\"value\", :number=>123}", event_puts[:content], "Content for puts mismatch" |
| 143 | + |
| 144 | + |
| 145 | + event_print = @tracer1.events[2] |
| 146 | + assert_equal __FILE__, event_print[:path], "Path for print mismatch" |
| 147 | + assert_equal expected_line_print_detailed, event_print[:lineno], "Line number for print mismatch" |
| 148 | + # print calls to_s on each argument and prints them sequentially |
| 149 | + assert_equal "detailed_print{:key=>\"value\", :number=>123}", event_print[:content], "Content for print mismatch" |
| 150 | + |
| 151 | + Codetracer::KernelPatches.uninstall(@tracer1) |
| 152 | + end |
| 153 | +end |
0 commit comments