airbnb-ruby-prof 0.0.1

data/test/exclude_threads_test.rb

@@ -0,0 +1,53 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require File.expand_path('../test_helper', __FILE__)
+
+
+# --  Tests ----
+class ExcludeThreadsTest < TestCase
+  def test_exclude_threads
+
+    def thread1_proc
+      sleep(0.5)
+      sleep(2)
+    end
+
+    def thread2_proc
+      sleep(0.5)
+      sleep(2)
+    end
+
+    thread1 = Thread.new do
+      thread1_proc
+    end
+
+    thread2 = Thread.new do
+      thread2_proc
+    end
+
+    # exclude_threads already includes the minitest thread pool
+    RubyProf.exclude_threads += [ thread2 ]
+
+    RubyProf.start
+
+    thread1.join
+    thread2.join
+
+    result = RubyProf.stop
+
+    assert_equal(2, result.threads.length)
+
+    output = Array.new
+    result.threads.each do |thread|
+      thread.methods.each do | m |
+        if m.full_name.index("ExcludeThreadsTest#thread") == 0
+          output.push(m.full_name)
+        end
+      end
+    end
+
+    assert_equal(1, output.length)
+    assert_equal("ExcludeThreadsTest#thread1_proc", output[0])
+  end
+end

data/test/fiber_test.rb

@@ -0,0 +1,79 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require File.expand_path('../test_helper', __FILE__)
+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
+      end
+    while true
+      begin
+        enum.next
+      rescue StopIteration
+        break
+      end
+    end
+    sleep 0.1
+  end
+
+  def setup
+    # Need to use wall time for this test due to the sleep calls
+    RubyProf::measure_mode = RubyProf::WALL_TIME
+    @fiber_ids  = Set.new
+    @root_fiber = Fiber.current.object_id
+    @thread_id  = Thread.current.object_id
+  end
+
+  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)
+    assert_equal(@fiber_ids, Set.new(profiled_fiber_ids))
+
+    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.3, root_fiber_profile.total_time, 0.05)
+    assert_in_delta(0.2, enum_fiber_profile.total_time, 0.05)
+
+    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"})
+
+    assert_in_delta(0.2, method_next.total_time, 0.05)
+    assert_in_delta(0.2, method_each.total_time, 0.05)
+  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
+
+    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_in_delta(0.2, method_next.total_time, 0.05)
+    assert_in_delta(0.2, method_each.total_time, 0.05)
+  end
+
+end

data/test/issue137_test.rb

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require File.expand_path('../test_helper', __FILE__)
+
+# issue 137 is about correctly attributing time of recursive children
+
+class RecursiveChildrenTest < TestCase
+  class SlowClass
+    def time_sink
+      1234567890 ** 100 == 0
+    end
+  end
+
+  class SlowSearcher
+    def do_find(slow_objects)
+      slow_objects.find(&:time_sink)
+    end
+  end
+
+  class MainClass
+    def self.main_method
+      slow_objects = [SlowClass.new] * 100_000
+      slow_searcher = SlowSearcher.new
+      slow_searcher.do_find(slow_objects)
+    end
+  end
+
+  include PrinterTestHelper
+
+  def setup
+    # Need to use wall time for this test due to the sleep calls
+    RubyProf::measure_mode = RubyProf::WALL_TIME
+  end
+
+  def test_simple
+    result = RubyProf.profile do
+      # make array each recursive
+      [1].each do
+        MainClass.main_method
+      end
+    end
+
+    # methods = result.threads.first.methods.sort.reverse
+
+    printer = RubyProf::GraphPrinter.new(result)
+
+    buffer = ''
+    printer.print(StringIO.new(buffer))
+
+    puts buffer if ENV['SHOW_RUBY_PROF_PRINTER_OUTPUT'] == "1"
+
+    parsed_output = MetricsArray.parse(buffer)
+
+    assert( enum_find  = parsed_output.metrics_for("Enumerable#find") )
+    assert( array_each = enum_find.child("Array#each") )
+
+    assert_operator enum_find.metrics.total, :>=, array_each.total
+    assert_operator enum_find.metrics.total, :>, 0
+    assert_in_delta enum_find.metrics.total, array_each.total, 0.02
+  end
+
+end

data/test/line_number_test.rb

@@ -0,0 +1,71 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require File.expand_path('../test_helper', __FILE__)
+
+class LineNumbers
+  def method1
+  end
+
+  def method2
+    method1
+  end
+
+  def method3
+    sleep(1)
+  end
+end
+
+# --  Tests ----
+class LineNumbersTest < TestCase
+  def test_function_line_no
+    numbers = LineNumbers.new
+
+    result = RubyProf.profile do
+      numbers.method2
+    end
+
+    methods = result.threads.first.methods.sort.reverse
+    assert_equal(3, methods.length)
+
+    method = methods[0]
+    assert_equal('LineNumbersTest#test_function_line_no', method.full_name)
+    assert_equal(25, method.line)
+
+    method = methods[1]
+    assert_equal('LineNumbers#method2', method.full_name)
+    assert_equal(10, method.line)
+
+    method = methods[2]
+    assert_equal('LineNumbers#method1', method.full_name)
+    assert_equal(7, method.line)
+  end
+
+  def test_c_function
+    numbers = LineNumbers.new
+
+    result = RubyProf.profile do
+      numbers.method3
+    end
+
+    methods = result.threads.first.methods.sort_by {|method| method.full_name}
+    assert_equal(3, methods.length)
+
+    # Methods:
+    #   LineNumbers#method3
+    #   LineNumbersTest#test_c_function
+    #   Kernel#sleep
+
+    method = methods[0]
+    assert_equal('Kernel#sleep', method.full_name)
+    assert_equal(0, method.line)
+
+    method = methods[1]
+    assert_equal('LineNumbers#method3', method.full_name)
+    assert_equal(14, method.line)
+
+    method = methods[2]
+    assert_equal('LineNumbersTest#test_c_function', method.full_name)
+    assert_equal(48, method.line)
+  end
+end

data/test/measure_allocations_test.rb

@@ -0,0 +1,26 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require File.expand_path('../test_helper', __FILE__)
+
+class MeasureAllocationsTest < TestCase
+  def test_allocations_mode
+    RubyProf::measure_mode = RubyProf::ALLOCATIONS
+    assert_equal(RubyProf::ALLOCATIONS, RubyProf::measure_mode)
+  end
+
+  def test_allocations_enabled_defined
+    assert(defined?(RubyProf::ALLOCATIONS_ENABLED))
+  end
+
+  if RubyProf::ALLOCATIONS_ENABLED
+    def test_allocations
+      t = RubyProf.measure_allocations
+      refute_empty("a" + "b")
+      u = RubyProf.measure_allocations
+      assert_kind_of Integer, t
+      assert_kind_of Integer, u
+      assert_operator t, :<, u
+    end
+  end
+end

data/test/measure_cpu_time_test.rb

@@ -0,0 +1,213 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require File.expand_path('../test_helper', __FILE__)
+
+class MeasureCpuTimeTest < TestCase
+  def setup
+    RubyProf::measure_mode = RubyProf::CPU_TIME
+  end
+
+  def teardown
+    RubyProf::measure_mode = RubyProf::WALL_TIME
+  end
+
+  def test_mode
+    assert_equal(RubyProf::CPU_TIME, RubyProf::measure_mode)
+  end
+
+  def test_cpu_time_enabled_defined
+    assert(defined?(RubyProf::CPU_TIME_ENABLED))
+  end
+
+  def test_class_methods
+    result = RubyProf.profile do
+      RubyProf::C7.busy_wait
+    end
+
+    # Length should be greater 2:
+    #   MeasureCpuTimeTest#test_class_methods
+    #   <Class::RubyProf::C1>#busy_wait
+    #   ....
+
+    methods = result.threads.first.methods.sort.reverse[0..1]
+    assert_equal(2, methods.length)
+
+    # Check the names
+    assert_equal('MeasureCpuTimeTest#test_class_methods', methods[0].full_name)
+    assert_equal('<Class::RubyProf::C7>#busy_wait', methods[1].full_name)
+
+    # Check times
+    assert_in_delta(0.1, methods[0].total_time, 0.05)
+    assert_in_delta(0, methods[0].wait_time, 0.05)
+    assert_in_delta(0, methods[0].self_time, 0.05)
+
+    assert_in_delta(0.1, methods[1].total_time, 0.05)
+    assert_in_delta(0, methods[1].wait_time, 0.05)
+    assert_in_delta(0, methods[1].self_time, 0.05)
+  end
+
+  def test_instance_methods
+    result = RubyProf.profile do
+      RubyProf::C7.new.busy_wait
+    end
+
+    methods = result.threads.first.methods.sort.reverse[0..1]
+    assert_equal(2, methods.length)
+
+    # Methods at this point:
+    #   MeasureCpuTimeTest#test_instance_methods
+    #   C7#busy_wait
+    #   ...
+
+    names = methods.map(&:full_name)
+    assert_equal('MeasureCpuTimeTest#test_instance_methods', names[0])
+    assert_equal('RubyProf::C7#busy_wait', names[1])
+
+
+    # Check times
+    assert_in_delta(0.2, methods[0].total_time, 0.03)
+    assert_in_delta(0, methods[0].wait_time, 0.03)
+    assert_in_delta(0, methods[0].self_time, 0.03)
+
+    assert_in_delta(0.2, methods[1].total_time, 0.03)
+    assert_in_delta(0, methods[1].wait_time, 0.03)
+    assert_in_delta(0, methods[1].self_time, 0.2)
+  end
+
+  def test_module_methods
+    result = RubyProf.profile do
+      RubyProf::C8.busy_wait
+    end
+
+    # Methods:
+    #   MeasureCpuTimeTest#test_module_methods
+    #   M1#busy_wait
+    #   ...
+
+    methods = result.threads.first.methods.sort.reverse[0..1]
+    assert_equal(2, methods.length)
+
+    assert_equal('MeasureCpuTimeTest#test_module_methods', methods[0].full_name)
+    assert_equal('RubyProf::M7#busy_wait', methods[1].full_name)
+
+    # Check times
+    assert_in_delta(0.3, methods[0].total_time, 0.1)
+    assert_in_delta(0, methods[0].wait_time, 0.02)
+    assert_in_delta(0, methods[0].self_time, 0.02)
+
+    assert_in_delta(0.3, methods[1].total_time, 0.1)
+    assert_in_delta(0, methods[1].wait_time, 0.02)
+    assert_in_delta(0, methods[1].self_time, 0.1)
+  end
+
+  def test_module_instance_methods
+    result = RubyProf.profile do
+      RubyProf::C8.new.busy_wait
+    end
+
+    # Methods:
+    #   MeasureCpuTimeTest#test_module_instance_methods
+    #   M7#busy_wait
+    #   ...
+
+    methods = result.threads.first.methods.sort.reverse[0..1]
+    assert_equal(2, methods.length)
+    names = methods.map(&:full_name)
+    assert_equal('MeasureCpuTimeTest#test_module_instance_methods', names[0])
+    assert_equal('RubyProf::M7#busy_wait', names[1])
+
+    # Check times
+    assert_in_delta(0.3, methods[0].total_time, 0.1)
+    assert_in_delta(0, methods[0].wait_time, 0.1)
+    assert_in_delta(0, methods[0].self_time, 0.1)
+
+    assert_in_delta(0.3, methods[1].total_time, 0.1)
+    assert_in_delta(0, methods[1].wait_time, 0.01)
+    assert_in_delta(0, methods[1].self_time, 0.1)
+  end
+
+  def test_singleton
+    c3 = RubyProf::C3.new
+
+    class << c3
+      def busy_wait
+      end
+    end
+
+    result = RubyProf.profile do
+      c3.busy_wait
+    end
+
+    methods = result.threads.first.methods.sort.reverse
+    assert_equal(2, methods.length)
+
+    assert_equal('MeasureCpuTimeTest#test_singleton', methods[0].full_name)
+    assert_equal('<Object::RubyProf::C3>#busy_wait', methods[1].full_name)
+
+    assert_in_delta(0, methods[0].total_time, 0.01)
+    assert_in_delta(0, methods[0].wait_time, 0.01)
+    assert_in_delta(0, methods[0].self_time, 0.01)
+
+    assert_in_delta(0, methods[1].total_time, 0.01)
+    assert_in_delta(0, methods[1].wait_time, 0.01)
+    assert_in_delta(0, methods[1].self_time, 0.01)
+  end
+
+
+  def test_sleeping_does_accumulate_wall_time
+    RubyProf::measure_mode = RubyProf::WALL_TIME
+    result = RubyProf.profile do
+      sleep 0.1
+    end
+    methods = result.threads.first.methods.sort.reverse
+    assert_equal(["MeasureCpuTimeTest#test_sleeping_does_accumulate_wall_time", "Kernel#sleep"], methods.map(&:full_name))
+    assert_in_delta(0.1, methods[1].total_time, 0.01)
+    assert_equal(0, methods[1].wait_time)
+    assert_in_delta(0.1, methods[1].self_time, 0.01)
+  end
+
+  def test_sleeping_does_not_accumulate_significant_cpu_time
+    result = RubyProf.profile do
+      sleep 0.1
+    end
+    methods = result.threads.first.methods.sort.reverse
+    assert_equal(["MeasureCpuTimeTest#test_sleeping_does_not_accumulate_significant_cpu_time", "Kernel#sleep"], methods.map(&:full_name))
+    assert_in_delta(0, methods[1].total_time, 0.01)
+    assert_equal(0, methods[1].wait_time)
+    assert_in_delta(0, methods[1].self_time, 0.01)
+  end
+
+  def test_waiting_for_threads_does_not_accumulate_cpu_time
+    background_thread = nil
+    result = RubyProf.profile do
+      background_thread = Thread.new{ sleep 0.1 }
+      background_thread.join
+    end
+    # check number of threads
+    assert_equal(2, result.threads.length)
+    fg, bg = result.threads
+    assert(fg.methods.map(&:full_name).include?("Thread#join"))
+    assert(bg.methods.map(&:full_name).include?("Kernel#sleep"))
+    assert_in_delta(0, fg.total_time, 0.01)
+    assert_in_delta(0, bg.total_time, 0.01)
+  end
+
+  def test_waiting_for_threads_does_accumulate_wall_time
+    RubyProf::measure_mode = RubyProf::WALL_TIME
+    background_thread = nil
+    result = RubyProf.profile do
+      background_thread = Thread.new{ sleep 0.1 }
+      background_thread.join
+    end
+    # check number of threads
+    assert_equal(2, result.threads.length)
+    fg, bg = result.threads
+    assert(fg.methods.map(&:full_name).include?("Thread#join"))
+    assert(bg.methods.map(&:full_name).include?("Kernel#sleep"))
+    assert_in_delta(0.1, fg.total_time, 0.01)
+    assert_in_delta(0.1, fg.wait_time, 0.01)
+    assert_in_delta(0.1, bg.total_time, 0.01)
+  end
+
+end