airbnb-ruby-prof 0.0.1

data/test/multi_measure_test.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+
+require File.expand_path('../test_helper', __FILE__)
+
+class MultiMeasureTest < TestCase
+  def foo
+  end
+
+  def test_measure_modes
+    measure_modes = [RubyProf::PROCESS_TIME, RubyProf::WALL_TIME]
+
+    profile = RubyProf::Profile.new(measure_modes: measure_modes)
+
+    assert_equal measure_modes, profile.measure_modes
+  end
+
+  def test_measure_values
+    measure_modes = [RubyProf::PROCESS_TIME, RubyProf::WALL_TIME]
+
+    profile = RubyProf::Profile.new(measure_modes: measure_modes)
+
+    profile.start
+
+    foo
+
+    profile.stop
+
+    call_info = profile.threads.first.methods.first.call_infos.first
+
+    measure_values = call_info.measure_values
+
+    assert_equal 2, measure_values.size
+
+    measure_values.each do |val|
+      assert_equal 3, val.size
+    end
+  end
+end

data/test/multi_printer_test.rb

@@ -0,0 +1,83 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require File.expand_path('../test_helper', __FILE__)
+
+# Test data
+#     A
+#    / \
+#   B   C
+#        \
+#         B
+
+class MSTPT
+  def a
+    100.times{b}
+    300.times{c}
+    c;c;c
+  end
+
+  def b
+    sleep 0
+  end
+
+  def c
+    5.times{b}
+  end
+end
+
+class MultiPrinterTest < 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_all_profiles_can_be_created
+    start_time = Time.now
+    RubyProf.start
+    5.times{MSTPT.new.a}
+    result = RubyProf.stop
+    end_time = Time.now
+    expected_time = end_time - start_time
+    stack = graph = nil
+    assert_nothing_raised { stack, graph = print(result) }
+    re = Regexp.new('
+\s*<table>
+\s*<tr>
+\s*<th>Thread ID</th>
+\s*(<th>Fiber ID</th>)?
+\s*<th>Total Time</th>
+\s*</tr>
+\s*
+\s*<tr>
+\s*(<td>([\.0-9]+)</td>)?
+\s*<td><a href="#-?\d+">-?\d+</a></td>
+\s*<td>([\.0-9e]+)</td>
+\s*</tr>
+\s*
+\s*</table>')
+    assert_match(re, graph)
+    graph =~ re
+    display_time = $4.to_f
+    assert_in_delta expected_time, display_time, 0.001
+  end
+
+  private
+
+  def print(result)
+    test = caller.first =~ /in `(.*)'/ ? $1 : "test"
+    path = RubyProf.tmpdir
+    profile = "ruby_prof_#{test}"
+    printer = RubyProf::MultiPrinter.new(result)
+    printer.print(:path => path, :profile => profile,
+                  :threshold => 0, :min_percent => 0, :title => "ruby_prof #{test}")
+    if RUBY_PLATFORM =~ /darwin/ && ENV['SHOW_RUBY_PROF_PRINTER_OUTPUT']=="1"
+      system("open '#{printer.stack_profile}'")
+    end
+    # if GC.respond_to?(:dump_file_and_line_info)
+    #   GC.start
+    #   GC.dump_file_and_line_info("heap.dump")
+    # end
+    [File.read(printer.stack_profile), File.read(printer.graph_profile)]
+  end
+end

data/test/no_method_class_test.rb

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require File.expand_path('../test_helper', __FILE__)
+
+# Make sure this works with no class or method
+result = RubyProf.profile do
+  sleep 1
+end
+
+methods = result.threads.first.methods
+global_method = methods.sort_by {|method| method.full_name}.first
+if global_method.full_name != 'Kernel#sleep'
+  raise(RuntimeError, "Wrong method name.  Expected: Global#[No method].  Actual: #{global_method.full_name}")
+end

data/test/pause_resume_test.rb

@@ -0,0 +1,166 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require File.expand_path('../test_helper', __FILE__)
+
+class PauseResumeTest < 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_pause_resume
+    # Measured
+    RubyProf.start
+    RubyProf::C1.hello
+
+    # Not measured
+    RubyProf.pause
+    sleep 1
+    RubyProf::C1.hello
+
+    # Measured
+    RubyProf.resume
+    RubyProf::C1.hello
+
+    result = RubyProf.stop
+
+    # Length should be 3:
+    #   PauseResumeTest#test_pause_resume
+    #   <Class::RubyProf::C1>#hello
+    #   Kernel#sleep
+
+    methods = result.threads.first.methods.sort_by {|method_info| method_info.full_name}
+    # remove methods called by pause/resume
+    called_methods = ['Array#include?', 'Fixnum#==', 'Kernel#respond_to?', 'Kernel#respond_to_missing?']
+    methods.reject!{|m| called_methods.include?(m.full_name) }
+    # TODO: fix pause/resume to not include those methods in the first place
+    assert_equal(3, methods.length)
+
+    # Check the names
+    assert_equal('<Class::RubyProf::C1>#hello', methods[0].full_name)
+    assert_equal('Kernel#sleep', methods[1].full_name)
+    assert_equal('PauseResumeTest#test_pause_resume', methods[2].full_name)
+
+    # Check times
+    assert_in_delta(0.2, methods[0].total_time, 0.02)
+    assert_in_delta(0, methods[0].wait_time, 0.02)
+    assert_in_delta(0, methods[0].self_time, 0.02)
+
+    assert_in_delta(0.2, methods[1].total_time, 0.02)
+    assert_in_delta(0, methods[1].wait_time, 0.02)
+    assert_in_delta(0.2, methods[1].self_time, 0.02)
+
+    assert_in_delta(0.2, methods[2].total_time, 0.02)
+    assert_in_delta(0, methods[2].wait_time, 0.02)
+    assert_in_delta(0, methods[2].self_time, 0.02)
+  end
+
+  # pause/resume in the same frame
+  def test_pause_resume_1
+    profile = RubyProf::Profile.new({})
+
+    profile.start
+    method_1a
+
+    profile.pause
+    method_1b
+
+    profile.resume
+    method_1c
+
+    result = profile.stop
+    assert_in_delta(0.6, result.threads[0].methods.select{|m| m.full_name =~ /test_pause_resume_1$/}[0].total_time, 0.05)
+  end
+  def method_1a; sleep 0.2 end
+  def method_1b; sleep 1   end
+  def method_1c; sleep 0.4 end
+
+  # pause in parent frame, resume in child
+  def test_pause_resume_2
+    profile = RubyProf::Profile.new({})
+
+    profile.start
+    method_2a
+
+    profile.pause
+    sleep 0.5
+    method_2b(profile)
+
+    result = profile.stop
+    assert_in_delta(0.6, result.threads[0].methods.select{|m| m.full_name =~ /test_pause_resume_2$/}[0].total_time, 0.05)
+  end
+  def method_2a; sleep 0.2 end
+  def method_2b(profile); sleep 0.5; profile.resume; sleep 0.4 end
+
+  # pause in child frame, resume in parent
+  def test_pause_resume_3
+    profile = RubyProf::Profile.new({})
+
+    profile.start
+    method_3a(profile)
+
+    sleep 0.5
+    profile.resume
+    method_3b
+
+    result = profile.stop
+    assert_in_delta(0.6, result.threads[0].methods.select{|m| m.full_name =~ /test_pause_resume_3$/}[0].total_time, 0.05)
+  end
+  def method_3a(profile); sleep 0.2; profile.pause; sleep 0.5 end
+  def method_3b; sleep 0.4 end
+
+  def test_pause_seq
+    profile = RubyProf::Profile.new({})
+    profile.start ; assert !profile.paused?
+    profile.pause ; assert profile.paused?
+    profile.resume; assert !profile.paused?
+    profile.pause ; assert profile.paused?
+    profile.pause ; assert profile.paused?
+    profile.resume; assert !profile.paused?
+    profile.resume; assert !profile.paused?
+    profile.stop  ; assert !profile.paused?
+  end
+
+  def test_pause_block
+    profile = RubyProf::Profile.new({})
+    profile.start
+    profile.pause
+    assert profile.paused?
+
+    times_block_invoked = 0
+    retval= profile.resume{
+      times_block_invoked += 1
+      120 + times_block_invoked
+    }
+    assert_equal 1, times_block_invoked
+    assert profile.paused?
+
+    assert_equal 121, retval, "resume() should return the result of the given block."
+
+    profile.stop
+  end
+
+  def test_pause_block_with_error
+    profile = RubyProf::Profile.new({})
+    profile.start
+    profile.pause
+    assert profile.paused?
+
+    begin
+      profile.resume{ raise }
+      flunk 'Exception expected.'
+    rescue
+      assert profile.paused?
+    end
+
+    profile.stop
+  end
+
+  def test_resume_when_not_paused
+    profile = RubyProf::Profile.new({})
+    profile.start ; assert !profile.paused?
+    profile.resume; assert !profile.paused?
+    profile.stop  ; assert !profile.paused?
+  end
+end

data/test/prime.rb

@@ -0,0 +1,54 @@
+# A silly little test program that finds prime numbers.  It
+# is intentionally badly designed to show off the use
+# of ruby-prof.
+#
+# Source from http://people.cs.uchicago.edu/~bomb154/154/maclabs/profilers-lab/
+
+def make_random_array(length, maxnum)
+  result = Array.new(length)
+  result.each_index do |i|
+    result[i] = rand(maxnum)
+  end
+
+  result
+end
+
+def is_prime(x)
+  y = 2
+  y.upto(x-1) do |i|
+    return false if (x % i) == 0
+  end
+  true
+end
+
+def find_primes(arr)
+  result = arr.select do |value|
+    is_prime(value)
+  end
+  result
+end
+
+def find_largest(primes)
+  largest = primes.first
+
+  # Intentionally use upto for example purposes
+  # (upto is also called from is_prime)
+  0.upto(primes.length-1) do |i|
+    prime = primes[i]
+    if prime > largest
+      largest = prime
+    end
+  end
+  largest
+end
+
+def run_primes(length=10, maxnum=1000)
+  # Create random numbers
+  random_array = make_random_array(length, maxnum)
+
+  # Find the primes
+  primes = find_primes(random_array)
+
+  # Find the largest primes
+  find_largest(primes)
+end

data/test/printers_test.rb

@@ -0,0 +1,255 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require File.expand_path('../test_helper', __FILE__)
+require 'stringio'
+require 'fileutils'
+
+# --  Tests ----
+class PrintersTest < TestCase
+  def setup
+    # WALL_TIME so we can use sleep in our test and get same measurements on linux and windows
+    RubyProf::measure_mode = RubyProf::WALL_TIME
+    @result = RubyProf.profile do
+      run_primes(1000, 5000)
+    end
+  end
+
+  def test_printers
+    assert_nothing_raised do
+      output = ENV['SHOW_RUBY_PROF_PRINTER_OUTPUT'] == "1" ? STDOUT : StringIO.new('')
+
+      printer = RubyProf::CallInfoPrinter.new(@result)
+      printer.print(output)
+
+      printer = RubyProf::CallTreePrinter.new(@result)
+      printer.print()
+
+      printer = RubyProf::FlatPrinter.new(@result)
+      printer.print(output)
+
+      printer = RubyProf::FlatPrinterWithLineNumbers.new(@result)
+      printer.print(output)
+
+      printer = RubyProf::GraphHtmlPrinter.new(@result)
+      printer.print(output)
+
+      printer = RubyProf::GraphPrinter.new(@result)
+      printer.print(output)
+    end
+  end
+
+  def test_print_to_files
+    assert_nothing_raised do
+      output_dir = 'examples2'
+
+      if ENV['SAVE_NEW_PRINTER_EXAMPLES']
+        output_dir = 'examples'
+      end
+      FileUtils.mkdir_p output_dir
+
+      printer = RubyProf::DotPrinter.new(@result)
+      File.open("#{output_dir}/graph.dot", "w") {|f| printer.print(f)}
+
+      printer = RubyProf::CallStackPrinter.new(@result)
+      File.open("#{output_dir}/stack.html", "w") {|f| printer.print(f, :application => "primes")}
+
+      printer = RubyProf::MultiPrinter.new(@result)
+      printer.print(:path => "#{output_dir}", :profile => "multi", :application => "primes")
+      for file in ['graph.dot', 'multi.flat.txt', 'multi.graph.html', "multi.callgrind.out.#{$$}", 'multi.stack.html', 'stack.html']
+        existant_file = output_dir + '/' + file
+        assert File.size(existant_file) > 0
+      end
+    end
+  end
+
+  def test_flat_string
+    output = helper_test_flat_string(RubyProf::FlatPrinter)
+    refute_match(/prime.rb/, output)
+  end
+
+  def helper_test_flat_string(klass)
+    output = ''
+
+    printer = klass.new(@result)
+    printer.print(output)
+
+    assert_match(/Thread ID: -?\d+/i, output)
+    assert_match(/Fiber ID: -?\d+/i, output)
+    assert_match(/Total: \d+\.\d+/i, output)
+    assert_match(/Object#run_primes/i, output)
+    output
+  end
+
+  def test_flat_string_with_numbers
+    output = helper_test_flat_string RubyProf::FlatPrinterWithLineNumbers
+    assert_match(/prime.rb/, output)
+    refute_match(/ruby_runtime:0/, output)
+    assert_match(/called from/, output)
+
+    # should combine common parents
+    # 1.9 inlines it's  Fixnum#- so we don't see as many
+    assert_equal(2, output.scan(/Object#is_prime/).length)
+    refute_match(/\.\/test\/prime.rb/, output) # don't use relative paths
+  end
+
+  def test_graph_html_string
+    output = ''
+    printer = RubyProf::GraphHtmlPrinter.new(@result)
+    printer.print(output)
+
+    assert_match(/DTD HTML 4\.01/i, output)
+    assert_match( %r{<th>Total Time</th>}i, output)
+    assert_match(/Object#run_primes/i, output)
+  end
+
+  def test_graph_string
+    output = ''
+    printer = RubyProf::GraphPrinter.new(@result)
+    printer.print(output)
+
+    assert_match(/Thread ID: -?\d+/i, output)
+    assert_match(/Fiber ID: -?\d+/i, output)
+    assert_match(/Total Time: \d+\.\d+/i, output)
+    assert_match(/Object#run_primes/i, output)
+  end
+
+  def test_call_tree_string
+    printer = RubyProf::CallTreePrinter.new(@result)
+    printer.print(:profile => "lolcat", :path => RubyProf.tmpdir)
+    main_output_file_name = File.join(RubyProf.tmpdir, "lolcat.callgrind.out.#{$$}")
+    assert(File.exist?(main_output_file_name))
+    output = File.read(main_output_file_name)
+    assert_match(/fn=Object::find_primes/i, output)
+    assert_match(/events: wall_time/i, output)
+    refute_match(/d\d\d\d\d\d/, output) # old bug looked [in error] like Object::run_primes(d5833116)
+  end
+
+  def do_nothing
+    start = Time.now
+    while(Time.now == start)
+    end
+  end
+
+  def test_all_with_small_percentiles
+    result = RubyProf.profile do
+      sleep 2
+      do_nothing
+    end
+
+    # RubyProf::CallTreePrinter doesn't "do" a min_percent
+    # RubyProf::FlatPrinter only outputs if self time > percent...
+    # RubyProf::FlatPrinterWithLineNumbers same
+    for klass in [ RubyProf::GraphPrinter, RubyProf::GraphHtmlPrinter]
+      printer = klass.new(result)
+      out = ''
+      printer.print(out, :min_percent => 0.00000001)
+      assert_match(/do_nothing/, out)
+    end
+
+  end
+
+  def test_flat_result_sorting_by_self_time_is_default
+    printer = RubyProf::FlatPrinter.new(@result)
+
+    printer.print(output = '')
+    self_times = flat_output_nth_column_values(output, 3)
+
+    assert_sorted self_times
+  end
+
+  def test_flat_result_sorting
+    printer = RubyProf::FlatPrinter.new(@result)
+
+    sort_method_with_column_number = {:total_time => 2, :self_time => 3, :wait_time => 4, :children_time => 5}
+
+    sort_method_with_column_number.each_pair do |sort_method, n|
+      printer.print(output = '', :sort_method => sort_method)
+      times = flat_output_nth_column_values(output, n)
+      assert_sorted times
+    end
+  end
+
+  def test_flat_result_with_line_numbers_sorting_by_self_time_is_default
+    printer = RubyProf::FlatPrinterWithLineNumbers.new(@result)
+
+    printer.print(output = '')
+    self_times = flat_output_nth_column_values(output, 3)
+
+    assert_sorted self_times
+  end
+
+  def test_flat_with_line_numbers_result_sorting
+    printer = RubyProf::FlatPrinterWithLineNumbers.new(@result)
+
+    sort_method_with_column_number = {:total_time => 2, :self_time => 3, :wait_time => 4, :children_time => 5}
+
+    sort_method_with_column_number.each_pair do |sort_method, n|
+      printer.print(output = '', :sort_method => sort_method)
+      times = flat_output_nth_column_values(output, n)
+      assert_sorted times
+    end
+  end
+
+  def test_graph_result_sorting_by_total_time_is_default
+    printer = RubyProf::GraphPrinter.new(@result)
+    printer.print(output = '')
+    total_times = graph_output_nth_column_values(output, 3)
+
+    assert_sorted total_times
+  end
+
+  def test_graph_results_sorting
+    printer = RubyProf::GraphPrinter.new(@result)
+
+    sort_method_with_column_number = {:total_time => 3, :self_time => 4, :wait_time => 5, :children_time => 6}
+
+    sort_method_with_column_number.each_pair do |sort_method, n|
+      printer.print(output = '', :sort_method => sort_method)
+      times = graph_output_nth_column_values(output, n)
+      assert_sorted times
+    end
+  end
+
+  def test_graph_html_result_sorting_by_total_time_is_default
+    printer = RubyProf::GraphHtmlPrinter.new(@result)
+    printer.print(output = '')
+    total_times = graph_html_output_nth_column_values(output, 3)
+
+    assert_sorted total_times
+  end
+
+  def test_graph_html_result_sorting
+    printer = RubyProf::GraphHtmlPrinter.new(@result)
+
+    sort_method_with_column_number = {:total_time => 3, :self_time => 4, :wait_time => 5, :children_time => 6}
+
+    sort_method_with_column_number.each_pair do |sort_method, n|
+      printer.print(output = '', :sort_method => sort_method)
+      times = graph_html_output_nth_column_values(output, n)
+      assert_sorted times
+    end
+  end
+
+  private
+  def flat_output_nth_column_values(output, n)
+    only_method_calls = output.split("\n").select { |line| line =~ /^ +\d+/ }
+    only_method_calls.collect { |line| line.split(/ +/)[n] }
+  end
+
+  def graph_output_nth_column_values(output, n)
+    only_root_calls = output.split("\n").select { |line| line =~ /^ +[\d\.]+%/ }
+    only_root_calls.collect { |line| line.split(/ +/)[n] }
+  end
+
+  def graph_html_output_nth_column_values(output, n)
+    only_root_calls = output.split('<tr class="method">')
+    only_root_calls.delete_at(0)
+    only_root_calls.collect {|line| line.scan(/[\d\.]+/)[n - 1] }
+  end
+
+  def assert_sorted array
+    array = array.map{|n| n.to_f} # allow for > 10s times to sort right, since lexographically 4.0 > 10.0
+    assert_equal array, array.sort.reverse, "Array #{array.inspect} is not sorted"
+  end
+end