ruby-prof 1.0.0

data/test/printer_graph_test.rb

@@ -0,0 +1,41 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require File.expand_path('../test_helper', __FILE__)
+require 'stringio'
+require 'fileutils'
+require 'tmpdir'
+require_relative 'prime'
+
+# --  Tests ----
+class PrinterGraphTest < 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 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 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
+
+  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
+end

data/test/printers_test.rb

@@ -0,0 +1,141 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require File.expand_path('../test_helper', __FILE__)
+require 'stringio'
+require 'fileutils'
+require 'tmpdir'
+require_relative 'prime'
+
+# --  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
+    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::GraphHtmlPrinter.new(@result)
+    printer.print(output)
+
+    printer = RubyProf::GraphPrinter.new(@result)
+    printer.print(output)
+  end
+
+  def test_print_to_files
+    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
+
+  def test_refuses_io_objects
+    p = RubyProf::MultiPrinter.new(@result)
+    begin
+      p.print(STDOUT)
+      flunk "should have raised an ArgumentError"
+    rescue ArgumentError => e
+      assert_match(/IO/, e.to_s)
+    end
+  end
+
+  def test_refuses_non_hashes
+    p = RubyProf::MultiPrinter.new (@result)
+    begin
+      p.print([])
+      flunk "should have raised an ArgumentError"
+    rescue ArgumentError => e
+      assert_match(/hash/, e.to_s)
+    end
+  end
+
+  def test_flat_string
+    output = helper_test_flat_string(RubyProf::FlatPrinter)
+    assert_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_graph_html_string
+    output = ''
+    printer = RubyProf::GraphHtmlPrinter.new(@result)
+    printer.print(output)
+
+    assert_match(/<!DOCTYPE html>/i, output)
+    assert_match( %r{<th>Total</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 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...
+    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
+end

data/test/printing_recursive_graph_test.rb

@@ -0,0 +1,81 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require File.expand_path('../test_helper', __FILE__)
+require 'stringio'
+require 'fileutils'
+
+# --- code to be tested ---
+module PRGT
+  extend self
+
+  def f(n)
+    n.times { sleep 0.1 }
+  end
+
+  def g(n)
+    n.times { sleep 0.2 }
+  end
+
+  def run
+    2.times { f(2); g(4) }
+  end
+end
+
+# --- expected test output ---
+=begin
+Measure Mode: wall_time
+Thread ID: 1307675084040
+Fiber ID: 1307708787440
+Total Time: 2.0939999999973224
+Sort by:
+
+  %total   %self      total       self       wait      child            calls     name
+--------------------------------------------------------------------------------
+                      1.657      0.000      0.000      1.657              2/2     Integer#times
+  79.13%   0.00%      1.657      0.000      0.000      1.657                2     PRGT#g
+                      1.657      0.000      0.000      1.657              2/5     Integer#times
+--------------------------------------------------------------------------------
+                      2.094      2.094      0.000      0.000            12/12     Integer#times
+ 100.00% 100.00%      2.094      2.094      0.000      0.000               12     Kernel#sleep
+--------------------------------------------------------------------------------
+                      0.437      0.000      0.000      0.437              2/2     Integer#times
+  20.87%   0.00%      0.437      0.000      0.000      0.437                2     PRGT#f
+                      0.437      0.000      0.000      0.437              2/5     Integer#times
+--------------------------------------------------------------------------------
+                      0.437      0.000      0.000      0.437              2/5     PRGT#f
+                      1.657      0.000      0.000      1.657              2/5     PRGT#g
+                      2.094      0.000      0.000      2.094              1/5     PRGT#run
+ 100.00%   0.00%      2.094      0.000      0.000      2.094                5    *Integer#times
+                      2.094      2.094      0.000      0.000            12/12     Kernel#sleep
+                      1.657      0.000      0.000      1.657              2/2     PRGT#g
+                      0.437      0.000      0.000      0.437              2/2     PRGT#f
+--------------------------------------------------------------------------------
+                      2.094      0.000      0.000      2.094              1/1     PrintingRecursiveGraphTest#setup
+ 100.00%   0.00%      2.094      0.000      0.000      2.094                1     PRGT#run
+                      2.094      0.000      0.000      2.094              1/5     Integer#times
+--------------------------------------------------------------------------------
+ 100.00%   0.00%      2.094      0.000      0.000      2.094                1     PrintingRecursiveGraphTest#setup
+                      2.094      0.000      0.000      2.094              1/1     PRGT#run
+
+* indicates recursively called methods
+=end
+
+class PrintingRecursiveGraphTest < 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
+      PRGT.run
+    end
+  end
+
+  def test_printing_rescursive_graph
+    printer = RubyProf::GraphPrinter.new(@result)
+    buffer = ''
+    printer.print(StringIO.new(buffer))
+    puts buffer if ENV['SHOW_RUBY_PROF_PRINTER_OUTPUT'] == "1"
+
+    refute_nil(buffer)
+  end
+end

data/test/rack_test.rb

@@ -0,0 +1,157 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require File.expand_path('../test_helper', __FILE__)
+
+class FakeRackApp
+  def call(env)
+  end
+end
+
+module Rack
+  class Request
+    def initialize(env)
+      if env == :fake_env
+        @env = {}
+      else
+        @env = env
+      end
+    end
+
+    def path
+      @env[:path] || '/path/to/resource.json'
+    end
+  end
+end
+
+module Rack
+  class RubyProf
+    attr_reader :_profiler
+
+    def public_delete_profiler!
+      delete_profiler!
+    end
+  end
+end
+
+class RackTest < TestCase
+  def test_create_print_path
+    path = Dir.mktmpdir
+    Dir.delete(path)
+
+    Rack::RubyProf.new(FakeRackApp.new, :path => path)
+
+    assert(Dir.exist?(path))
+  end
+
+  def test_create_profile_reports
+    path = Dir.mktmpdir
+
+    adapter = Rack::RubyProf.new(FakeRackApp.new, :path => path)
+
+    adapter.call(:fake_env)
+
+    %w(flat.txt graph.txt graph.html call_stack.html).each do |base_name|
+      file_path = ::File.join(path, "path-to-resource.json-#{base_name}")
+      assert(File.exist?(file_path))
+    end
+  end
+
+  def test_skip_paths
+    path = Dir.mktmpdir
+
+    adapter = Rack::RubyProf.new(FakeRackApp.new, :path => path, :skip_paths => [%r{\.json$}])
+
+    adapter.call(:fake_env)
+
+    %w(flat.txt graph.txt graph.html call_stack.html).each do |base_name|
+      file_path = ::File.join(path, "path-to-resource.json-#{base_name}")
+      assert(!File.exist?(file_path))
+    end
+  end
+
+  def test_only_paths
+    path = Dir.mktmpdir
+
+    adapter = Rack::RubyProf.new(FakeRackApp.new, :path => path, :only_paths => [%r{\.json$}])
+
+    adapter.call({path: '/path/to/resource.json'})
+
+    %w(flat.txt graph.txt graph.html call_stack.html).each do |base_name|
+      file_path = ::File.join(path, "path-to-resource.json-#{base_name}")
+      assert(File.exist?(file_path))
+    end
+
+    adapter.call({path: '/path/to/resource.html'})
+    %w(flat.txt graph.txt graph.html call_stack.html).each do |base_name|
+      file_path = ::File.join(path, "path-to-resource.html-#{base_name}")
+      assert(!File.exist?(file_path))
+    end
+  end
+
+  def test_allows_lazy_filename_setting
+    path = Dir.mktmpdir
+
+    printer = {::RubyProf::FlatPrinter => lambda { 'dynamic.txt' }}
+    adapter = Rack::RubyProf.new(FakeRackApp.new, :path => path, :printers => printer)
+
+    adapter.call(:fake_env)
+
+    file_path = ::File.join(path, 'path-to-resource.json-dynamic.txt')
+    assert(File.exist?(file_path))
+  end
+
+  def test_works_for_multiple_requests
+    path = Dir.mktmpdir
+
+    adapter = Rack::RubyProf.new(FakeRackApp.new, :path => path, :max_requests => 2)
+
+    # make a 1st request, and check that this didn't create any files
+    adapter.call(:fake_env)
+    assert(Dir["#{path}/*"].empty?)
+
+    # now a second request should create all the expected files
+    adapter.call(:fake_env)
+    %w(flat.txt graph.txt graph.html call_stack.html).each do |base_name|
+      file_path = ::File.join(path, "multi-requests-2-#{base_name}")
+      assert(File.exist?(file_path))
+    end
+
+    # let's clean up
+    FileUtils.rm_rf(Dir["#{path}/*"])
+
+    # and do the same again for the next 2 requests
+    adapter.call(:fake_env)
+    assert(Dir["#{path}/*"].empty?)
+
+    adapter.call(:fake_env)
+    %w(flat.txt graph.txt graph.html call_stack.html).each do |base_name|
+      file_path = ::File.join(path, "multi-requests-2-#{base_name}")
+      assert(File.exist?(file_path))
+    end
+  end
+
+  def test_tries_to_print_results_if_shut_down_before_max_requests_reached
+    path = Dir.mktmpdir
+
+    adapter = Rack::RubyProf.new(FakeRackApp.new, :path => path, :max_requests => 100)
+
+    # make a 1st request, and check that this didn't create any files
+    adapter.call(:fake_env)
+    assert(Dir["#{path}/*"].empty?)
+
+    adapter.public_delete_profiler!
+
+    %w(flat.txt graph.txt graph.html call_stack.html).each do |base_name|
+      file_path = ::File.join(path, "multi-requests-1-#{base_name}")
+      assert(File.exist?(file_path))
+    end
+  end
+
+  def test_it_uses_separate_profilers_if_not_aggregating_multiple_requests
+    adapter1 = Rack::RubyProf.new(FakeRackApp.new)
+    adapter2 = Rack::RubyProf.new(FakeRackApp.new)
+
+    assert(adapter1.object_id != adapter2.object_id)
+  end
+end

data/test/recursive_test.rb

@@ -0,0 +1,210 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+
+require File.expand_path('../test_helper', __FILE__)
+
+module SimpleRecursion
+  # Simple recursive test
+  def simple(n)
+    sleep(1)
+    return if n == 0
+    simple(n-1)
+  end
+
+  # More complicated recursive test
+  def render_partial(i)
+    sleep(1)
+    case i
+    when 0
+      render_partial(10)
+    when 1
+      2.times do |j|
+        render_partial(j + 10)
+      end
+    end
+  end
+
+  def render
+    2.times do |i|
+      render_partial(i)
+    end
+  end
+end
+
+# --  Tests ----
+class RecursiveTest < TestCase
+  def setup
+    # Need to use wall time for this test due to the sleep calls
+    RubyProf::measure_mode = RubyProf::WALL_TIME
+  end
+
+  include SimpleRecursion
+
+  def test_simple
+    result = RubyProf.profile do
+      simple(1)
+    end
+
+    methods = result.threads.first.methods.sort.reverse
+    assert_equal(3, methods.length)
+
+    # Method 0: RecursiveTest#test_simple
+    method = methods[0]
+    assert_equal('RecursiveTest#test_simple', method.full_name)
+    assert_equal(1, method.called)
+    refute(method.recursive?)
+    assert_in_delta(2, method.total_time, 0.1)
+    assert_in_delta(0, method.self_time, 0.01)
+    assert_in_delta(0, method.wait_time, 0.01)
+    assert_in_delta(2, method.children_time, 0.1)
+
+    assert_equal(1, method.callers.length)
+    call_info = method.callers[0]
+    assert_nil(call_info.parent)
+
+    assert_equal(1, method.callees.length)
+    call_info = method.callees[0]
+    assert_equal('SimpleRecursion#simple', call_info.target.full_name)
+
+    # Method 1: SimpleRecursion#simple
+    method = methods[1]
+    assert_equal('SimpleRecursion#simple', method.full_name)
+    assert_equal(2, method.called)
+    assert(method.recursive?)
+    assert_in_delta(2, method.total_time, 0.1)
+    assert_in_delta(0, method.self_time, 0.1)
+    assert_in_delta(0, method.wait_time, 0.1)
+    assert_in_delta(2, method.children_time, 0.1)
+
+    assert_equal(2, method.callers.length)
+    call_info = method.callers[0]
+    assert_equal('RecursiveTest#test_simple', call_info.parent.full_name)
+
+    call_info = method.callers[1]
+    assert_equal('SimpleRecursion#simple', call_info.parent.full_name)
+
+    assert_equal(2, method.callees.length)
+    call_info = method.callees[0]
+    assert_equal('Kernel#sleep', call_info.target.full_name)
+
+    call_info = method.callees[1]
+    assert_equal('SimpleRecursion#simple', call_info.target.full_name)
+
+    # Method 2: Kernel#sleep
+    method = methods[2]
+    assert_equal('Kernel#sleep', method.full_name)
+    assert_equal(2, method.called)
+    refute(method.recursive?)
+    assert_in_delta(2, method.total_time, 0.1)
+    assert_in_delta(2, method.self_time, 0.1)
+    assert_in_delta(0, method.wait_time, 0.1)
+    assert_in_delta(0, method.children_time, 0.1)
+
+    assert_equal(1, method.callers.length)
+    call_info = method.callers[0]
+    assert_equal('SimpleRecursion#simple', call_info.parent.full_name)
+    assert_equal(0, method.callees.length)
+
+    assert_equal(0, method.callees.length)
+  end
+
+  def test_cycle
+    result = RubyProf.profile do
+      render
+    end
+
+    methods = result.threads.first.methods.sort.reverse
+    assert_equal(5, methods.length)
+
+    method = methods[0]
+    assert_equal('RecursiveTest#test_cycle', method.full_name)
+    assert_equal(1, method.called)
+    refute(method.recursive?)
+    assert_in_delta(5, method.total_time, 0.1)
+    assert_in_delta(0, method.self_time, 0.01)
+    assert_in_delta(0, method.wait_time, 0.01)
+    assert_in_delta(5, method.children_time, 0.1)
+
+    assert_equal(1, method.callers.length)
+    call_info = method.callers[0]
+    assert_nil(call_info.parent)
+
+    assert_equal(1, method.callees.length)
+    call_info = method.callees[0]
+    assert_equal('SimpleRecursion#render', call_info.target.full_name)
+
+    method = methods[1]
+    assert_equal('SimpleRecursion#render', method.full_name)
+    assert_equal(1, method.called)
+    refute(method.recursive?)
+    assert_in_delta(5, method.total_time, 0.1)
+    assert_in_delta(0, method.self_time, 0.01)
+    assert_in_delta(0, method.wait_time, 0.01)
+    assert_in_delta(5, method.children_time, 0.1)
+
+    assert_equal(1, method.callers.length)
+    call_info = method.callers[0]
+    assert_equal('RecursiveTest#test_cycle', call_info.parent.full_name)
+
+    assert_equal(1, method.callees.length)
+    call_info = method.callees[0]
+    assert_equal('Integer#times', call_info.target.full_name)
+
+    method = methods[2]
+    assert_equal('Integer#times', method.full_name)
+    assert_equal(2, method.called)
+    assert(method.recursive?)
+    assert_in_delta(5, method.total_time, 0.1)
+    assert_in_delta(0, method.self_time, 0.1)
+    assert_in_delta(0, method.wait_time, 0.1)
+    assert_in_delta(5, method.children_time, 0.1)
+
+    assert_equal(2, method.callers.length)
+    call_info = method.callers[0]
+    assert_equal('SimpleRecursion#render', call_info.parent.full_name)
+
+    call_info = method.callers[1]
+    assert_equal('SimpleRecursion#render_partial', call_info.parent.full_name)
+
+    assert_equal(1, method.callees.length)
+    call_info = method.callees[0]
+    assert_equal('SimpleRecursion#render_partial', call_info.target.full_name)
+
+    method = methods[3]
+    assert_equal('SimpleRecursion#render_partial', method.full_name)
+    assert_equal(5, method.called)
+    assert(method.recursive?)
+    assert_in_delta(5, method.total_time, 0.1)
+    assert_in_delta(0, method.self_time, 0.1)
+    assert_in_delta(0, method.wait_time, 0.01)
+    assert_in_delta(5, method.children_time, 0.05)
+
+    assert_equal(2, method.callers.length)
+    call_info = method.callers[0]
+    assert_equal('Integer#times', call_info.parent.full_name)
+
+    call_info = method.callers[1]
+    assert_equal('SimpleRecursion#render_partial', call_info.parent.full_name)
+
+    assert_equal(3, method.callees.length)
+    call_info = method.callees[0]
+    assert_equal('Kernel#sleep', call_info.target.full_name)
+
+    call_info = method.callees[1]
+    assert_equal('SimpleRecursion#render_partial', call_info.target.full_name)
+
+    call_info = method.callees[2]
+    assert_equal('Integer#times', call_info.target.full_name)
+
+    method = methods[4]
+    assert_equal('Kernel#sleep', method.full_name)
+    assert_equal(5, method.called)
+    refute(method.recursive?)
+    assert_in_delta(5, method.total_time, 0.1)
+    assert_in_delta(5, method.self_time, 0.1)
+    assert_in_delta(0, method.wait_time, 0.01)
+    assert_in_delta(0, method.children_time, 0.01)
+
+    assert_equal(0, method.callees.length)
+  end
+end