From 1819652578e8f9fe3606f7a716ec4e427fc55f0a Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nguy=E1=BB=85n=20Quang=20Minh?= Date: Thu, 6 Aug 2020 09:56:24 +0700 Subject: [Feature #16513] TracePoint#inspect returns "... file:line" (#3391) * Fix debug documents to match Thread#to_s change (Feature #16412 ticket) * TracePoint#inspect returns "... file:line" (Feature #16513) * Guard older version of Ruby in Tracepoint inspection tests * Focus on current thread only when running TracePoint inspection test --- lib/debug.rb | 8 +-- spec/ruby/core/tracepoint/enable_spec.rb | 14 ++++- spec/ruby/core/tracepoint/inspect_spec.rb | 95 ++++++++++++++++++++++++++++++- test/ruby/test_settracefunc.rb | 4 +- trace_point.rb | 2 +- vm_trace.c | 6 +- 6 files changed, 116 insertions(+), 13 deletions(-) diff --git a/lib/debug.rb b/lib/debug.rb index 6f519c6c77..bf53eb80a4 100644 --- a/lib/debug.rb +++ b/lib/debug.rb @@ -1012,8 +1012,8 @@ EOHELP # # (rdb:1) DEBUGGER__.thread_list_all # +1 # debug_me.rb.rb:3 - # 2 # - # 3 # + # 2 # + # 3 # # [1, 2, 3] # # Your current thread is indicated by a + @@ -1022,8 +1022,8 @@ EOHELP # # (rdb:1) th l # +1 # debug_me.rb:3 - # 2 # debug_me.rb:3 - # 3 # debug_me.rb:3 + # 2 # debug_me.rb:3 + # 3 # debug_me.rb:3 # # See DEBUGGER__ for more usage. diff --git a/spec/ruby/core/tracepoint/enable_spec.rb b/spec/ruby/core/tracepoint/enable_spec.rb index aa0c3aa0dc..13c7b82b54 100644 --- a/spec/ruby/core/tracepoint/enable_spec.rb +++ b/spec/ruby/core/tracepoint/enable_spec.rb @@ -123,6 +123,18 @@ describe 'TracePoint#enable' do end describe "when nested" do + before do + ruby_version_is ""..."2.8" do + # Old behavior for Ruby < 2.8 + @path_prefix = '@' + end + + ruby_version_is "2.8" do + # New behavior for Ruby >= 2.8 + @path_prefix = ' ' + end + end + it "enables both TracePoints but only calls the respective callbacks" do called = false first = TracePoint.new(:line) do |tp| @@ -146,7 +158,7 @@ describe 'TracePoint#enable' do end all.uniq.should == [second] - inspects.uniq.should == ["#"] + inspects.uniq.should == ["#"] called.should == true end end diff --git a/spec/ruby/core/tracepoint/inspect_spec.rb b/spec/ruby/core/tracepoint/inspect_spec.rb index 1e48caa215..80de965337 100644 --- a/spec/ruby/core/tracepoint/inspect_spec.rb +++ b/spec/ruby/core/tracepoint/inspect_spec.rb @@ -2,6 +2,18 @@ require_relative '../../spec_helper' require_relative 'fixtures/classes' describe 'TracePoint#inspect' do + before do + ruby_version_is ""..."2.8" do + # Old behavior for Ruby < 2.8 + @path_prefix = '@' + end + + ruby_version_is "2.8" do + # New behavior for Ruby >= 2.8 + @path_prefix = ' ' + end + end + it 'returns a string containing a human-readable TracePoint status' do TracePoint.new(:line) {}.inspect.should == '#' end @@ -16,7 +28,54 @@ describe 'TracePoint#inspect' do line = __LINE__ end - inspect.should == "#" + inspect.should == "#" + end + + it 'returns a String showing the event, method, path and line for a :call event' do + inspect = nil + line = nil + TracePoint.new(:call) { |tp| + next unless TracePointSpec.target_thread? + inspect ||= tp.inspect + }.enable do + line = __LINE__ + 1 + def trace_point_spec_test_call; end + trace_point_spec_test_call + end + + inspect.should == "#" + end + + it 'returns a String showing the event, method, path and line for a :return event' do + inspect = nil + line = nil + TracePoint.new(:return) { |tp| + next unless TracePointSpec.target_thread? + inspect ||= tp.inspect + }.enable do + line = __LINE__ + 4 + def trace_point_spec_test_return + a = 1 + return a + end + trace_point_spec_test_return + end + + inspect.should == "#" + end + + it 'returns a String showing the event, method, path and line for a :c_call event' do + inspect = nil + line = nil + TracePoint.new(:c_call) { |tp| + next unless TracePointSpec.target_thread? + inspect ||= tp.inspect + }.enable do + line = __LINE__ + 1 + [0, 1].max + end + + inspect.should == "#" end it 'returns a String showing the event, path and line for a :class event' do @@ -31,6 +90,38 @@ describe 'TracePoint#inspect' do end end - inspect.should == "#" + inspect.should == "#" + end + + it 'returns a String showing the event and thread for :thread_begin event' do + inspect = nil + thread = nil + thread_inspection = nil + TracePoint.new(:thread_begin) { |tp| + next unless Thread.current == thread + inspect ||= tp.inspect + }.enable do + thread = Thread.new {} + thread_inspection = thread.inspect + thread.join + end + + inspect.should == "#" + end + + it 'returns a String showing the event and thread for :thread_end event' do + inspect = nil + thread = nil + thread_inspection = nil + TracePoint.new(:thread_end) { |tp| + next unless Thread.current == thread + inspect ||= tp.inspect + }.enable do + thread = Thread.new {} + thread_inspection = thread.inspect + thread.join + end + + inspect.should == "#" end end diff --git a/test/ruby/test_settracefunc.rb b/test/ruby/test_settracefunc.rb index f688e5a9aa..9579974407 100644 --- a/test/ruby/test_settracefunc.rb +++ b/test/ruby/test_settracefunc.rb @@ -937,9 +937,9 @@ class TestSetTraceFunc < Test::Unit::TestCase when :line assert_match(/ in /, str) when :call, :c_call - assert_match(/call \`/, str) # # + assert_match(/call \`/, str) # # when :return, :c_return - assert_match(/return \`/, str) # # + assert_match(/return \`/, str) # # when /thread/ assert_match(/\#> else diff --git a/trace_point.rb b/trace_point.rb index 52272a09e3..d68eed4248 100644 --- a/trace_point.rb +++ b/trace_point.rb @@ -183,7 +183,7 @@ class TracePoint # t.enable(target: method(:m1)) # # m1 - # # prints # + # # prints # # m2 # # prints nothing # diff --git a/vm_trace.c b/vm_trace.c index c02ad87f13..7b39779a83 100644 --- a/vm_trace.c +++ b/vm_trace.c @@ -1456,7 +1456,7 @@ tracepoint_inspect(rb_execution_context_t *ec, VALUE self) VALUE sym = rb_tracearg_method_id(trace_arg); if (NIL_P(sym)) break; - return rb_sprintf("#", + return rb_sprintf("#", rb_tracearg_event(trace_arg), rb_tracearg_path(trace_arg), FIX2INT(rb_tracearg_lineno(trace_arg)), @@ -1466,7 +1466,7 @@ tracepoint_inspect(rb_execution_context_t *ec, VALUE self) case RUBY_EVENT_C_CALL: case RUBY_EVENT_RETURN: case RUBY_EVENT_C_RETURN: - return rb_sprintf("#", + return rb_sprintf("#", rb_tracearg_event(trace_arg), rb_tracearg_method_id(trace_arg), rb_tracearg_path(trace_arg), @@ -1479,7 +1479,7 @@ tracepoint_inspect(rb_execution_context_t *ec, VALUE self) default: break; } - return rb_sprintf("#", + return rb_sprintf("#", rb_tracearg_event(trace_arg), rb_tracearg_path(trace_arg), FIX2INT(rb_tracearg_lineno(trace_arg))); -- cgit v1.2.3