ruby-prof 0.18.0 → 1.2.0

data/test/call_tree_visitor_test.rb

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require File.expand_path('../test_helper', __FILE__)
+require_relative './measure_times'
+
+class CallTreeVisitorTest < TestCase
+  def setup
+    # Need to use wall time for this test due to the sleep calls
+    RubyProf::measure_mode = RubyProf::WALL_TIME
+  end
+
+  def test_visit
+    result = RubyProf.profile do
+      RubyProf::C1.sleep_wait
+    end
+
+    visitor = RubyProf::CallTreeVisitor.new(result.threads.first.call_tree)
+
+    method_names = Array.new
+
+    visitor.visit do |call_tree, event|
+      method_names << call_tree.target.full_name if event == :enter
+    end
+
+    assert_equal(3, method_names.length)
+    assert_equal("CallTreeVisitorTest#test_visit", method_names[0])
+    assert_equal("<Class::RubyProf::C1>#sleep_wait", method_names[1])
+    assert_equal("Kernel#sleep", method_names[2])
+  end
+end
+

data/test/call_trees_test.rb

@@ -0,0 +1,66 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require File.expand_path('../test_helper', __FILE__)
+
+# --  Tests ----
+class CallTreesTest < TestCase
+  def some_method_1
+    some_method_2
+  end
+
+  def some_method_2
+  end
+
+  def test_call_infos
+    result = RubyProf.profile do
+      some_method_1
+    end
+
+    thread = result.threads.first
+    assert_equal(3, thread.methods.length)
+
+    method = thread.methods[0]
+    assert_equal('CallTreesTest#test_call_infos', method.full_name)
+
+    call_trees = method.call_trees
+    assert_empty(call_trees.callers)
+    assert_equal(1, call_trees.callees.length)
+    assert_kind_of(RubyProf::AggregateCallTree, call_trees.callees[0])
+    assert_equal('CallTreesTest#some_method_1', call_trees.callees[0].target.full_name)
+
+    method = thread.methods[1]
+    assert_equal('CallTreesTest#some_method_1', method.full_name)
+
+    call_trees = method.call_trees
+    assert_equal(1, call_trees.callers.length)
+    assert_kind_of(RubyProf::AggregateCallTree, call_trees.callers[0])
+    assert_equal('CallTreesTest#test_call_infos', call_trees.callers[0].parent.target.full_name)
+    assert_equal(1, call_trees.callees.length)
+    assert_kind_of(RubyProf::AggregateCallTree, call_trees.callees[0])
+    assert_equal('CallTreesTest#some_method_2', call_trees.callees[0].target.full_name)
+
+    method = thread.methods[2]
+    assert_equal('CallTreesTest#some_method_2', method.full_name)
+
+    call_trees = method.call_trees
+    assert_equal(1, call_trees.callers.length)
+    assert_kind_of(RubyProf::AggregateCallTree, call_trees.callers[0])
+    assert_equal('CallTreesTest#some_method_1', call_trees.callers[0].parent.target.full_name)
+    assert_empty(call_trees.callees)
+  end
+
+  def test_gc
+    result = RubyProf.profile do
+      some_method_1
+    end
+
+    method = result.threads.first.methods[1]
+
+    100.times do |i|
+      method.call_trees.callers
+      GC.start
+    end
+    assert(true)
+  end
+end

data/test/dynamic_method_test.rb

@@ -38,8 +38,6 @@ class DynamicMethodTest < TestCase
       medley.peach
     end
 
-    # RubyProf::FlatPrinter.new(result).print(STDOUT)
-
     methods = result.threads.first.methods.sort.reverse
     expected_method_names = %w(
       DynamicMethodTest#test_dynamic_method

data/test/exclude_methods_test.rb

@@ -43,13 +43,12 @@ class ExcludeMethodsTest < TestCase
     obj = ExcludeMethodsClass.new
     prf = RubyProf::Profile.new
 
-    result = prf.profile { 5.times {obj.a} }
+    result = prf.profile {obj.a}
     methods = result.threads.first.methods.sort.reverse
-
     assert_equal(10, methods.count)
     assert_equal('ExcludeMethodsTest#test_methods_can_be_profiled', methods[0].full_name)
-    assert_equal('Integer#times', methods[1].full_name)
-    assert_equal('ExcludeMethodsClass#a', methods[2].full_name)
+    assert_equal('ExcludeMethodsClass#a', methods[1].full_name)
+    assert_equal('Integer#times', methods[2].full_name)
     assert_equal('ExcludeMethodsClass#b', methods[3].full_name)
     assert_equal('<Class::ExcludeMethodsClass>#e', methods[4].full_name)
     assert_equal('<Class::ExcludeMethodsClass>#f', methods[5].full_name)
@@ -65,7 +64,7 @@ class ExcludeMethodsTest < TestCase
 
     prf.exclude_methods!(Integer, :times)
 
-    result = prf.profile { 5.times {obj.a} }
+    result = prf.profile {obj.a}
     methods = result.threads.first.methods.sort.reverse
 
     assert_equal(9, methods.count)
@@ -88,7 +87,7 @@ class ExcludeMethodsTest < TestCase
     prf.exclude_methods!(ExcludeMethodsClass.singleton_class, :f)
     prf.exclude_methods!(ExcludeMethodsModule.singleton_class, :d)
 
-    result = prf.profile { 5.times {obj.a} }
+    result = prf.profile {obj.a}
     methods = result.threads.first.methods.sort.reverse
 
     assert_equal(7, methods.count)
@@ -107,13 +106,19 @@ class ExcludeMethodsTest < TestCase
 
     prf.exclude_common_methods!
 
-    result = prf.profile { 5.times {obj.a} }
+    result = prf.profile {obj.a}
     methods = result.threads.first.methods.sort.reverse
 
     assert_equal(9, methods.count)
     assert_equal('ExcludeMethodsTest#test_exclude_common_methods1', methods[0].full_name)
     assert_equal('ExcludeMethodsClass#a', methods[1].full_name)
     assert_equal('ExcludeMethodsClass#b', methods[2].full_name)
+    assert_equal('<Class::ExcludeMethodsClass>#e', methods[3].full_name)
+    assert_equal('<Class::ExcludeMethodsClass>#f', methods[4].full_name)
+    assert_equal('Kernel#sleep', methods[5].full_name)
+    assert_equal('ExcludeMethodsModule#c', methods[6].full_name)
+    assert_equal('<Module::ExcludeMethodsModule>#d', methods[7].full_name)
+    assert_equal('Kernel#class', methods[8].full_name)
   end
 
   def test_exclude_common_methods2
@@ -130,14 +135,14 @@ class ExcludeMethodsTest < TestCase
 
   private
 
-  def assert_method_has_been_eliminated(result, eliminated_method)
+  def assert_method_has_been_excluded(result, excluded_method)
     result.threads.each do |thread|
       thread.methods.each do |method|
-        method.call_infos.each do |ci|
-          assert(ci.target != eliminated_method, "broken self")
-          assert(ci.parent.target != eliminated_method, "broken parent") if ci.parent
+        method.call_trees.each do |ci|
+          assert(ci.target != excluded_method, "broken self")
+          assert(ci.parent.target != excluded_method, "broken parent") if ci.parent
           ci.children.each do |callee|
-            assert(callee.target != eliminated_method, "broken kid")
+            assert(callee.target != excluded_method, "broken kid")
           end
         end
       end

data/test/fiber_test.rb

@@ -2,25 +2,21 @@
 # encoding: UTF-8
 
 require File.expand_path('../test_helper', __FILE__)
+require 'fiber'
 require 'timeout'
 require 'set'
-begin
-  require 'fiber'
-rescue LoadError
-end
 
 # --  Tests ----
 class FiberTest < TestCase
-
   def fiber_test
     @fiber_ids << Fiber.current.object_id
     enum = Enumerator.new do |yielder|
-        [1,2].each do |x|
-          @fiber_ids << Fiber.current.object_id
-          sleep 0.1
-          yielder.yield x
-        end
+      [1,2].each do |x|
+        @fiber_ids << Fiber.current.object_id
+        sleep 0.1
+        yielder.yield x
       end
+    end
     while true
       begin
         enum.next
@@ -41,6 +37,7 @@ class FiberTest < TestCase
 
   def test_fibers
     result  = RubyProf.profile { fiber_test }
+
     profiled_fiber_ids = result.threads.map(&:fiber_id)
     assert_equal(2, result.threads.length)
     assert_equal([@thread_id], result.threads.map(&:id).uniq)
@@ -49,31 +46,225 @@ class FiberTest < TestCase
     assert profiled_fiber_ids.include?(@root_fiber)
     assert(root_fiber_profile = result.threads.detect{|t| t.fiber_id == @root_fiber})
     assert(enum_fiber_profile = result.threads.detect{|t| t.fiber_id != @root_fiber})
+    assert_in_delta(0.33, root_fiber_profile.total_time, 0.05)
+    assert_in_delta(0.33, enum_fiber_profile.total_time, 0.05)
 
-    assert_in_delta(0.3, root_fiber_profile.total_time, 0.05)
-    assert_in_delta(0.2, enum_fiber_profile.total_time, 0.05)
+    methods = result.threads[0].methods.sort.reverse
+    assert_equal(12, methods.count)
 
-    assert(method_next = root_fiber_profile.methods.detect{|m| m.full_name == "Enumerator#next"})
-    assert(method_each = enum_fiber_profile.methods.detect{|m| m.full_name == "Enumerator#each"})
+    method = methods[0]
+    assert_equal('FiberTest#test_fibers', method.full_name)
+    assert_equal(1, method.called)
+    assert_in_delta(0.33, method.total_time, 0.05)
+    assert_in_delta(0, method.self_time, 0.05)
+    assert_in_delta(0, method.wait_time, 0.05)
+    assert_in_delta(0.33, method.children_time, 0.05)
 
-    assert_in_delta(0.2, method_next.total_time, 0.05)
-    assert_in_delta(0.2, method_each.total_time, 0.05)
+    method = methods[1]
+    assert_equal('FiberTest#fiber_test', method.full_name)
+    assert_equal(1, method.called)
+    assert_in_delta(0.33, method.total_time, 0.05)
+    assert_in_delta(0, method.self_time, 0.05)
+    assert_in_delta(0, method.wait_time, 0.05)
+    assert_in_delta(0.33, method.children_time, 0.05)
+
+    method = methods[2]
+    assert_equal('Enumerator#next', method.full_name)
+    assert_equal(3, method.called)
+    assert_in_delta(0.22, method.total_time, 0.05)
+    assert_in_delta(0, method.self_time, 0.05)
+    assert_in_delta(0.22, method.wait_time, 0.05)
+    assert_in_delta(0, method.children_time, 0.05)
+
+    method = methods[3]
+    assert_equal('Kernel#sleep', method.full_name)
+    assert_equal(1, method.called)
+    assert_in_delta(0.11, method.total_time, 0.05)
+    assert_in_delta(0.11, method.self_time, 0.05)
+    assert_in_delta(0, method.wait_time, 0.05)
+    assert_in_delta(0, method.children_time, 0.05)
+
+    # Since these methods have such short times their order is a bit indeterminate
+    method = methods.detect {|method| method.full_name == 'Class#new'}
+    assert_equal('Class#new', method.full_name)
+    assert_equal(1, method.called)
+    assert_in_delta(0, method.total_time, 0.05)
+    assert_in_delta(0, method.self_time, 0.05)
+    assert_in_delta(0, method.wait_time, 0.05)
+    assert_in_delta(0, method.children_time, 0.05)
+
+    if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.5.0')
+    method = methods.detect {|method| method.full_name == 'Set#<<'}
+    assert_equal('Set#<<', method.full_name)
+    assert_equal(1, method.called)
+    assert_in_delta(0, method.total_time, 0.05)
+    assert_in_delta(0, method.self_time, 0.05)
+    assert_in_delta(0, method.wait_time, 0.05)
+    assert_in_delta(0, method.children_time, 0.05)
+    end
+
+    method = methods.detect {|method| method.full_name == 'Module#==='}
+    assert_equal('Module#===', method.full_name)
+    assert_equal(1, method.called)
+    assert_in_delta(0, method.total_time, 0.05)
+    assert_in_delta(0, method.self_time, 0.05)
+    assert_in_delta(0, method.wait_time, 0.05)
+    assert_in_delta(0, method.children_time, 0.05)
+
+    method = methods.detect {|method| method.full_name == 'Kernel#object_id'}
+    assert_equal('Kernel#object_id', method.full_name)
+    assert_equal(1, method.called)
+    assert_in_delta(0, method.total_time, 0.05)
+    assert_in_delta(0, method.self_time, 0.05)
+    assert_in_delta(0, method.wait_time, 0.05)
+    assert_in_delta(0, method.children_time, 0.05)
+
+    method = methods.detect {|method| method.full_name == '<Class::Fiber>#current'}
+    assert_equal('<Class::Fiber>#current', method.full_name)
+    assert_equal(1, method.called)
+    assert_in_delta(0, method.total_time, 0.05)
+    assert_in_delta(0, method.self_time, 0.05)
+    assert_in_delta(0, method.wait_time, 0.05)
+    assert_in_delta(0, method.children_time, 0.05)
+
+    method = methods.detect {|method| method.full_name == 'Exception#exception'}
+    assert_equal('Exception#exception', method.full_name)
+    assert_equal(1, method.called)
+    assert_in_delta(0, method.total_time, 0.05)
+    assert_in_delta(0, method.self_time, 0.05)
+    assert_in_delta(0, method.wait_time, 0.05)
+    assert_in_delta(0, method.children_time, 0.05)
+
+    method = methods.detect {|method| method.full_name == 'Exception#backtrace'}
+    assert_equal('Exception#backtrace', method.full_name)
+    assert_equal(1, method.called)
+    assert_in_delta(0, method.total_time, 0.05)
+    assert_in_delta(0, method.self_time, 0.05)
+    assert_in_delta(0, method.wait_time, 0.05)
+    assert_in_delta(0, method.children_time, 0.05)
+
+    method = methods.detect {|method| method.full_name == 'Enumerator#initialize'}
+    assert_equal('Enumerator#initialize', method.full_name)
+    assert_equal(1, method.called)
+    assert_in_delta(0, method.total_time, 0.05)
+    assert_in_delta(0, method.self_time, 0.05)
+    assert_in_delta(0, method.wait_time, 0.05)
+    assert_in_delta(0, method.children_time, 0.05)
+
+    methods = result.threads[1].methods.sort.reverse
+
+    if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.6.0')
+      assert_equal(10, methods.count)
+    else
+      assert_equal(11, methods.count)
+    end
+
+    method = methods[0]
+    assert_equal('RubyProf::Profile#_inserted_parent_', method.full_name)
+    assert_equal(1, method.called)
+    assert_in_delta(0.33, method.total_time, 0.05)
+    assert_in_delta(0, method.self_time, 0.05)
+    assert_in_delta(0.11, method.wait_time, 0.05)
+    assert_in_delta(0.22, method.children_time, 0.05)
+
+    method = methods[1]
+    assert_equal('Enumerator#each', method.full_name)
+    assert_equal(1, method.called)
+    assert_in_delta(0.22, method.total_time, 0.05)
+    assert_in_delta(0, method.self_time, 0.05)
+    assert_in_delta(0, method.wait_time, 0.05)
+    assert_in_delta(0.22, method.children_time, 0.05)
+
+    method = methods[2]
+    assert_equal('Enumerator::Generator#each', method.full_name)
+    assert_equal(1, method.called)
+    assert_in_delta(0.22, method.total_time, 0.05)
+    assert_in_delta(0, method.self_time, 0.05)
+    assert_in_delta(0, method.wait_time, 0.05)
+    assert_in_delta(0.22, method.children_time, 0.05)
+
+    method = methods[3]
+    assert_equal('Array#each', method.full_name)
+    assert_equal(1, method.called)
+    assert_in_delta(0.22, method.total_time, 0.05)
+    assert_in_delta(0, method.self_time, 0.05)
+    assert_in_delta(0, method.wait_time, 0.05)
+    assert_in_delta(0.22, method.children_time, 0.05)
+
+    method = methods[4]
+    assert_equal('Kernel#sleep', method.full_name)
+    assert_equal(2, method.called)
+    assert_in_delta(0.22, method.total_time, 0.05)
+    assert_in_delta(0.22, method.self_time, 0.05)
+    assert_in_delta(0, method.wait_time, 0.05)
+    assert_in_delta(0, method.children_time, 0.05)
+
+    # Since these methods have such short times their order is a bit indeterminate
+    method = methods.detect {|method| method.full_name == 'Exception#initialize'}
+    assert_equal('Exception#initialize', method.full_name)
+    assert_equal(1, method.called)
+    assert_in_delta(0, method.total_time, 0.05)
+    assert_in_delta(0, method.self_time, 0.05)
+    assert_in_delta(0, method.wait_time, 0.05)
+    assert_in_delta(0, method.children_time, 0.05)
+
+    if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.5.0')
+      method = methods.detect {|method| method.full_name == 'Set#<<'}
+      assert_equal('Set#<<', method.full_name)
+      assert_equal(2, method.called)
+      assert_in_delta(0, method.total_time, 0.05)
+      assert_in_delta(0, method.self_time, 0.05)
+      assert_in_delta(0, method.wait_time, 0.05)
+      assert_in_delta(0, method.children_time, 0.05)
+    end
+
+    method = methods.detect {|method| method.full_name == 'Kernel#object_id'}
+    assert_equal('Kernel#object_id', method.full_name)
+    assert_equal(2, method.called)
+    assert_in_delta(0, method.total_time, 0.05)
+    assert_in_delta(0, method.self_time, 0.05)
+    assert_in_delta(0, method.wait_time, 0.05)
+    assert_in_delta(0, method.children_time, 0.05)
+
+    method = methods.detect {|method| method.full_name == 'Enumerator::Yielder#yield'}
+    assert_equal('Enumerator::Yielder#yield', method.full_name)
+    assert_equal(2, method.called)
+    assert_in_delta(0, method.total_time, 0.05)
+    assert_in_delta(0, method.self_time, 0.05)
+    assert_in_delta(0, method.wait_time, 0.05)
+    assert_in_delta(0, method.children_time, 0.05)
+
+    method = methods.detect {|method| method.full_name == '<Class::Fiber>#current'}
+    assert_equal('<Class::Fiber>#current', method.full_name)
+    assert_equal(2, method.called)
+    assert_in_delta(0, method.total_time, 0.05)
+    assert_in_delta(0, method.self_time, 0.05)
+    assert_in_delta(0, method.wait_time, 0.05)
+    assert_in_delta(0, method.children_time, 0.05)
+
+    #if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.7.0')
+    #  method = methods.detect {|method| method.full_name == 'Numeric#eql?'}
+    #  assert_equal('Numeric#eql?', method.full_name)
+    #  assert_equal(1, method.called)
+    #  assert_in_delta(0, method.total_time, 0.05)
+    #  assert_in_delta(0, method.self_time, 0.05)
+    #  assert_in_delta(0, method.wait_time, 0.05)
+    #  assert_in_delta(0, method.children_time, 0.05)
+    #end
   end
 
   def test_merged_fibers
     result  = RubyProf.profile(merge_fibers: true) { fiber_test }
     assert_equal(1, result.threads.length)
 
-    profile = result.threads.first
-    assert_equal 0, profile.fiber_id
+    thread = result.threads.first
+    assert_equal(thread.id, thread.fiber_id)
+    assert_in_delta(0.3, thread.total_time, 0.05)
 
-    assert_in_delta(0.3, profile.total_time, 0.05)
-
-    assert(method_next = profile.methods.detect{|m| m.full_name == "Enumerator#next"})
-    assert(method_each = profile.methods.detect{|m| m.full_name == "Enumerator#each"})
+    assert(method_next = thread.methods.detect{|m| m.full_name == "Enumerator#next"})
+    assert(method_each = thread.methods.detect{|m| m.full_name == "Enumerator#each"})
 
     assert_in_delta(0.2, method_next.total_time, 0.05)
     assert_in_delta(0.2, method_each.total_time, 0.05)
   end
-
 end