test_benchmark 0.0.3 → 0.4.6

data/lib/test_benchmark.rb

@@ -1,26 +1,112 @@
-# EXPERIMENTAL
-# Show a report of the time each test takes to run
-class Test::Unit::TestSuite
+require 'test/unit'
+require 'test/unit/testresult'
+require 'test/unit/testcase'
+require 'test/unit/ui/console/testrunner'
 
-  @@test_benchmarks = {}
+class Test::Unit::UI::Console::TestRunner
+  DEFAULT_DISPLAY_LIMIT = 15
+  DEFAULT_SUITE_DISPLAY_LIMIT = 5
+  
+  @@display_limit = DEFAULT_DISPLAY_LIMIT
+  @@suite_display_limit = DEFAULT_SUITE_DISPLAY_LIMIT
+  
+  def self.set_test_benchmark_limits(set_display_limit=DEFAULT_DISPLAY_LIMIT, set_suite_display_limit=DEFAULT_SUITE_DISPLAY_LIMIT)
+    @@display_limit = set_display_limit
+    @@suite_display_limit = set_suite_display_limit
+  end
+  
+  alias attach_to_mediator_old attach_to_mediator
+  # def attach_to_mediator_old
+  #   @mediator.add_listener(TestResult::FAULT, &method(:add_fault))
+  #   @mediator.add_listener(TestRunnerMediator::STARTED, &method(:started))
+  #   @mediator.add_listener(TestRunnerMediator::FINISHED, &method(:finished))
+  #   @mediator.add_listener(TestCase::STARTED, &method(:test_started))
+  #   @mediator.add_listener(TestCase::FINISHED, &method(:test_finished))
+  # end
+  def attach_to_mediator
+    attach_to_mediator_old
+    @mediator.add_listener(Test::Unit::TestSuite::STARTED, &method(:test_suite_started))
+    @mediator.add_listener(Test::Unit::TestSuite::FINISHED, &method(:test_suite_finished))
+  end
+  
+  alias started_old started
+  def started(result)
+    started_old(result)
+    @test_benchmarks = {} 
+    @suite_benchmarks = {}
+  end
+  
+  alias finished_old finished
+  def finished(elapsed_time)
+    finished_old(elapsed_time)
+    output_benchmarks
+    output_benchmarks(:suite)
+    puts "\n"
+  end
+  
+  alias test_started_old test_started
+  def test_started(name)
+    test_started_old(name)
+    @test_benchmarks[name] = Time.now
+  end
+  
+  alias test_finished_old test_finished
+  def test_finished(name)
+    test_finished_old(name)
+    @test_benchmarks[name] = Time.now - @test_benchmarks[name]
+  end
+  
+  def test_suite_started(suite_name)
+    @suite_benchmarks[suite_name] = Time.now
+  end
+  
+  def test_suite_finished(suite_name)
+    @suite_benchmarks[suite_name] = Time.now - @suite_benchmarks[suite_name]
+    output_benchmarks(suite_name) if full_output?
+  end
+  
+  @@format_benchmark_row = lambda {|tuple| ("%0.3f" % tuple[1]) + " #{tuple[0]}"}
+  @@sort_by_time = lambda { |a,b| b[1] <=> a[1] }
 
-  # Runs the tests and/or suites contained in this
-  # TestSuite.
-  def run(result, &progress_block)
-    yield(STARTED, name)
-    @tests.each do |test|
-      start_single_test = Time.now
-      test.run(result, &progress_block)
-      @@test_benchmarks[test.name] = Time.now - start_single_test
-      # print sprintf("#{test.name} %.3f", Time.now - start_single_test) + " "
+private
+  def full_output?
+    ENV['BENCHMARK'] == 'full'
+  end
+
+  def select_by_suite_name(suite_name)
+    if suite_name == :suite
+      @suite_benchmarks.select{ |k,v| @test_benchmarks.detect{ |k1,v1| k1.include?(k) } }
+    elsif suite_name
+      @test_benchmarks.select{ |k,v| k.include?(suite_name) }
+    else
+      @test_benchmarks
     end
-    yield(FINISHED, name)
+  end
 
-    puts "\nTEST BENCHMARK REPORT"
-    @@test_benchmarks.keys.sort{|a, b| @@test_benchmarks[a] <=> @@test_benchmarks[b]}.each do |key|
-      value = @@test_benchmarks[key]
-      puts(("%0.3f" % value) + " #{key}") if /^test_/.match(key)
+  def prep_benchmarks(suite_name=nil)
+    benchmarks = select_by_suite_name(suite_name)
+    return if benchmarks.nil? || benchmarks.empty?
+    benchmarks = benchmarks.sort(&@@sort_by_time)
+    unless full_output?
+      cutoff = (suite_name == :suite) ? @@suite_display_limit : @@display_limit
+      benchmarks = benchmarks.slice(0, cutoff) 
     end
+    benchmarks.map(&@@format_benchmark_row)
   end
 
+  def header(suite_name)
+    if suite_name == :suite
+      "\nTest Benchmark Times: Suite Totals:\n"
+    elsif suite_name
+      "\nTest Benchmark Times: #{suite_name}\n"
+    else
+      "\nTEST BENCHMARK TIMES: OVERALL\n"
+    end
+  end
+
+  def output_benchmarks(suite_name=nil)
+    benchmarks = prep_benchmarks(suite_name)
+    return if benchmarks.nil? || benchmarks.empty?
+    puts header(suite_name) + benchmarks.join("\n") + "\n"
+  end
 end

metadata

@@ -1,64 +1,59 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
-specification_version: 1
 name: test_benchmark
 version: !ruby/object:Gem::Version 
-  version: 0.0.3
-date: 2007-06-24 00:00:00 -07:00
-summary: A plugin for showing how long tests take to run.
-require_paths: 
-- lib
-email: boss AT topfunky.com
-homepage: http://rubyforge.org/projects/seattlerb
-rubyforge_project: seattlerb
-description: A simple hack that prints a report of test/unit test runtimes.
-autorequire: 
-default_executable: 
-bindir: bin
-has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
-  requirements: 
-  - - ">"
-    - !ruby/object:Gem::Version 
-      version: 0.0.0
-  version: 
+  version: 0.4.6
 platform: ruby
-signing_key: 
-cert_chain: 
-post_install_message: 
 authors: 
+- Tim Connor
 - Geoffrey Grosenbach
-files: 
-- History.txt
-- Manifest.txt
-- README.txt
-- Rakefile
-- about.yml
-- init.rb
-- lib/test_benchmark.rb
-- test/test_benchmark_test.rb
-test_files: 
-- test/test_benchmark_test.rb
-rdoc_options: 
-- --main
-- README.txt
-extra_rdoc_files: 
-- History.txt
-- Manifest.txt
-- README.txt
+- Mike Gunderloy
+- Luke Francl
+- Marek de Heus
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-13 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: 
+email: timocratic@gmail.com
 executables: []
 
 extensions: []
 
+extra_rdoc_files: []
+
+files: 
+- lib/test_benchmark.rb
+has_rdoc: false
+homepage: http://github.com/timocratic/test_benchmark
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
 requirements: []
 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: hoe
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Version::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: 1.2.1
-    version: 
+rubyforge_project: 
+rubygems_version: 1.3.2
+signing_key: 
+specification_version: 3
+summary: "Rails plugin (and/or ruby gem) for benchmarking your test::units: a rework of the original by topfunky"
+test_files: []
+

data/History.txt

@@ -1,10 +0,0 @@
-== 0.0.3 / 2007-06-24
-
-* Updated Manifest.txt so files are actually packaged in the gem. D'oh!
-* See also release notes for version 0.0.2
-
-== 0.0.2
-
-* Renamed gem to test_benchmark
-* Upgraded to Hoe.
-* Will always show report. If you don't want to see the report, it is recommended that you install the gem and list or comment out "require 'test_benchmark'" to enable the gem.

data/Manifest.txt

@@ -1,8 +0,0 @@
-History.txt
-Manifest.txt
-README.txt
-Rakefile
-about.yml
-init.rb
-lib/test_benchmark.rb
-test/test_benchmark_test.rb

data/README.txt

@@ -1,16 +0,0 @@
-Test Benchmark
-==============
-
-A hack to show a report of how long each test takes to run.
-
-Useful for troubleshooting slow tests.
-
-Sample output:
-
-  7.124 test_destroy(FeedTest)
-  7.219 test_create(FeedTest)
-  7.646 test_subscribe_to_auto_discovery(FeedTest)
-  9.339 test_auto_discover_updates_url(FeedTest)
-  9.543 test_find_or_create_by_auto_discover_url(FeedTest)
-  15.780 test_import_from_opml(FeedTest)
-

data/Rakefile

@@ -1,13 +0,0 @@
-require 'rubygems'
-require 'hoe'
-# require './lib/test_benchmark.rb'
-
-Hoe.new("test_benchmark", '0.0.3') do |p|
-  p.summary = "A plugin for showing how long tests take to run."
-  p.rubyforge_name = 'seattlerb'
-  p.author = 'Geoffrey Grosenbach'
-  p.email = 'boss AT topfunky.com'
-  p.description = 'A simple hack that prints a report of test/unit test runtimes.'
-  p.url = "http://rubyforge.org/projects/seattlerb"
-  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
-end

data/about.yml

@@ -1,7 +0,0 @@
-author: topfunky
-summary: Hack to show a report of how long individual tests take to run.
-homepage: http://nubyonrails.com
-plugin: http://topfunky.net/svn/plugins/test_benchmark
-license: MIT
-version: 0.1
-rails_version: 1.1+

data/init.rb

@@ -1 +0,0 @@
-require File.dirname(__FILE__) + "/lib/test_benchmark"

data/test/test_benchmark_test.rb

@@ -1,16 +0,0 @@
-require 'rubygems'
-require 'test/unit'
-
-require File.dirname(__FILE__) + "/../lib/test_benchmark"
-
-class BenchmarkTest < Test::Unit::TestCase
-
-  def test_basic
-    assert true
-  end
-  
-  def test_long_running
-    sleep 5
-  end
-  
-end