myronmarston-test_benchmarker 0.9.1

data/CHANGELOG

@@ -0,0 +1,3 @@
+== 1.0.0 2009-03-27
+
+* Initial release

data/Manifest.txt

@@ -0,0 +1,14 @@
+CHANGELOG
+Manifest.txt
+README.rdoc
+Rakefile
+lib
+lib/test_benchmarker
+lib/test_benchmarker.rb
+lib/test_benchmarker/core_ext.rb
+lib/test_benchmarker/test_benchmarks.rb
+lib/test_benchmarker/test_suite.rb
+test
+test/test_core_ext.rb
+test/test_helper.rb
+test/test_test_benchmarker.rb

data/README.rdoc

@@ -0,0 +1,48 @@
+= test_benchmarker
+
+* FIX (url)
+
+== DESCRIPTION:
+
+FIX (describe your package)
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Myron Marston, Kashless.org
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,42 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+require 'rake/rdoctask'
+ 
+task :default => :test
+
+desc "Run All Tests"
+Rake::TestTask.new :test do |test|
+  test.test_files = ["test/**/*.rb"]
+  test.verbose = true
+end
+
+desc %{Update ".manifest" with the latest list of project filenames. Respect\
+.gitignore by excluding everything that git ignores. Update `files` and\
+`test_files` arrays in "*.gemspec" file if it's present.}
+task :manifest do
+  list = Dir['**/*'].sort
+  spec_file = Dir['*.gemspec'].first
+  list -= [spec_file] if spec_file
+ 
+  if File.exist?('.gitignore')
+    File.read('.gitignore').each_line do |glob|
+      glob = glob.chomp.sub(/^\//, '')
+      list -= Dir[glob]
+      list -= Dir["#{glob}/**/*"] if File.directory?(glob) and !File.symlink?(glob)
+      puts "excluding #{glob}"
+    end
+  end
+ 
+  if spec_file
+    spec = File.read spec_file
+    spec.gsub! /^(\s* s.(test_)?files \s* = \s* )( \[ [^\]]* \] | %w\( [^)]* \) )/mx do
+      assignment = $1
+      bunch = $2 ? list.grep(/^test\//) : list
+      '%s%%w(%s)' % [assignment, bunch.join(' ')]
+    end
+ 
+    File.open(spec_file, 'w') {|f| f << spec }
+  end
+  File.open('manifest.txt', 'w') {|f| f << list.join("\n") }
+end

data/lib/test_benchmarker.rb

@@ -0,0 +1,7 @@
+module TestBenchmarker
+  VERSION = '0.9.1'
+end
+
+require 'lib/test_benchmarker/test_benchmarks'
+require 'lib/test_benchmarker/test_suite'
+require 'lib/test_benchmarker/core_ext'

data/lib/test_benchmarker/core_ext.rb

@@ -0,0 +1,25 @@
+class TestBenchmarker::ClassNotFoundError < StandardError 
+  attr_accessor :class_str
+  def initialize(class_str)
+    @class_str = class_str
+  end
+end
+
+class String
+  # similar to ActiveSupports constantize, but doesn't require the use of active support.
+  def to_class
+    ObjectSpace.each_object(Class) do |klass|
+      return klass if klass.to_s == self
+    end
+    
+    raise TestBenchmarker::ClassNotFoundError.new(self), "A class matching '#{self}' could not be found"
+  end
+end
+
+class Class
+  def is_subclass_of?(klass)
+    return false if self == Object && klass != Object
+    return true if self == klass
+    return self.superclass.is_subclass_of?(klass)
+  end
+end

data/lib/test_benchmarker/test_benchmarks.rb

@@ -0,0 +1,67 @@
+require 'ostruct'
+
+module TestBenchmarker
+  class TestBenchmark
+    attr_reader :test_class, :test_name, :benchmark
+    
+    def initialize(test_class, test_name, benchmark)
+      @test_class, @test_name, @benchmark = test_class, test_name, benchmark
+      TestBenchmarks.add(self)
+    end
+  end
+  
+  class TestBenchmarks
+    def self.clear
+      @@classes = {}
+      @@tests = []
+    end
+    
+    self.clear
+    
+    def self.add(benchmark)
+      test_class = benchmark.test_class
+      
+      # ignore some bogus test classes that get passed here when run in the context of a rails app...
+      return if test_class =~ /(rake_test_loader|::TestCase|::IntegrationTest)/
+      
+      begin
+        test_class = test_class.to_class
+      rescue TestBenchmarker::ClassNotFoundError
+        return
+      end
+      return unless test_class.is_subclass_of?(Test::Unit::TestCase)
+      
+      @@classes[test_class] ||= OpenStruct.new
+      @@classes[test_class].benchmarks ||= []
+      @@classes[test_class].benchmarks << benchmark
+      @@tests << benchmark
+    end
+    
+    def self.print_results
+      return if @@classes.nil? || @@classes.size == 0
+      
+      benchmark_attr = :real
+      
+      class_benchmarks = []
+      @@classes.each do |test_class, obj| 
+        obj.test_count = obj.benchmarks.size
+        obj.sum = obj.benchmarks.inject(0) {|sum, bmark| sum + bmark.benchmark.send(benchmark_attr)}
+        obj.avg = obj.sum / obj.test_count
+        obj.test_class = test_class
+        class_benchmarks << obj unless obj.benchmarks.nil? || obj.benchmarks.size == 0
+      end
+      
+      puts "\n\n#{'=' * 27} Class Benchmark Results #{'=' * 27}"
+      class_benchmarks.sort {|a, b| b.avg <=> a.avg}.each_with_index do |cb, i|
+        puts "#{i + 1}.#{' ' * (4 - (i + 1).to_s.length)} #{format("%.3f", cb.avg)} secs avg time, #{format("%.3f", cb.sum)} secs total time, #{cb.test_count} tests for: #{cb.test_class.to_s}"
+      end
+      puts "#{'=' * 79}\n\n"
+      
+      puts "\n\n#{'=' * 28} Test Benchmark Results #{'=' * 28}"
+      @@tests.sort {|a, b| b.benchmark.send(benchmark_attr) <=> a.benchmark.send(benchmark_attr)}.each_with_index do |t, i|
+        puts "#{i + 1}.#{' ' * (4 - (i + 1).to_s.length)} #{format("%.3f", t.benchmark.real)} secs total time for: #{t.test_name}"
+      end
+      puts "#{'=' * 80}\n\n"
+    end
+  end
+end

data/lib/test_benchmarker/test_suite.rb

@@ -0,0 +1,22 @@
+require 'benchmark'
+
+if ENV['BENCHMARK_TESTS']
+  class Test::Unit::TestSuite
+    @@run_count = 0
+  
+    def run(result, &progress_block)
+      @@run_count += 1
+      begin
+        yield(STARTED, name)
+        @tests.each do |test|
+          TestBenchmarker::TestBenchmark.new(self.name, test.name, Benchmark.measure { test.run(result, &progress_block) })
+        end
+        yield(FINISHED, name)
+      ensure
+        @@run_count -= 1
+        # print the results as we're exiting the very last test run...
+        TestBenchmarker::TestBenchmarks.print_results if @@run_count == 0
+      end
+    end
+  end
+end

data/test/test_core_ext.rb

@@ -0,0 +1,32 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class Foo; end
+class FooSubclass < Foo; end
+class FooSubSubclass < FooSubclass; end
+class Bar; end
+
+class TestCoreExt < Test::Unit::TestCase
+  def test_string_to_class
+    assert_equal TestCoreExt, 'TestCoreExt'.to_class
+    assert_equal FooSubSubclass, 'FooSubSubclass'.to_class
+  end
+  
+  def test_string_to_class_not_found
+    assert_raise TestBenchmarker::ClassNotFoundError do
+      'This it not the name of a class!'.to_class
+    end
+  end
+  
+  def test_class_is_subclass_of
+    assert FooSubclass.is_subclass_of?(Foo)
+    assert FooSubclass.is_subclass_of?(Object)
+    
+    assert FooSubSubclass.is_subclass_of?(FooSubclass)
+    assert FooSubSubclass.is_subclass_of?(Foo)
+    assert FooSubSubclass.is_subclass_of?(Object)
+  end
+  
+  def test_class_is_not_subclass_of
+    assert !Bar.is_subclass_of?(Foo)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/test_benchmarker'

data/test/test_test_benchmarker.rb

@@ -0,0 +1,117 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+
+class Foo; end
+class Class1 < Test::Unit::TestCase 
+  def test_truth; end
+end
+
+class Class2 < Test::Unit::TestCase
+  def test_truth; end
+end
+
+class Class3 < Test::Unit::TestCase
+  def test_truth; end
+end
+
+class Class4; end
+
+class TestTestBenchmarker < Test::Unit::TestCase
+  def setup
+    1.upto(3) do |class_speed|
+      1.upto(3) do |test_speed|
+        speed = class_speed * 0.01 + test_speed * 0.001
+        TestBenchmarker::TestBenchmark.new("Class#{class_speed}", "test_#{test_speed} (Class#{class_speed})", ::Benchmark.measure { sleep speed })
+      end
+    end
+    
+    TestBenchmarker::TestBenchmark.new("Class4", "test_1 (Class4)", ::Benchmark.measure { sleep 0.01 })
+    
+    @benchmarked_classes = TestBenchmarker::TestBenchmarks.send(:class_variable_get, '@@classes')
+    @benchmarked_tests = TestBenchmarker::TestBenchmarks.send(:class_variable_get, '@@tests').map{ |t| t.test_name }
+    @out, @err = util_capture { TestBenchmarker::TestBenchmarks.print_results }
+  end
+  
+  def teardown
+    TestBenchmarker::TestBenchmarks.clear
+  end
+  
+  def test_has_expected_benchmarked_classes
+    assert_equal 3, @benchmarked_classes.keys.size
+    
+    assert @benchmarked_classes.keys.include?(Class1)
+    assert @benchmarked_classes.keys.include?(Class2)
+    assert @benchmarked_classes.keys.include?(Class3)
+  end
+  
+  def test_does_not_have_classes_not_descended_from_test_unit_testcase
+    assert !@benchmarked_classes.keys.include?(Class4)
+  end
+  
+  def test_has_expected_benchmarked_tests
+    assert_equal 9, @benchmarked_tests.size
+    
+    assert @benchmarked_tests.include?('test_1 (Class1)')
+    assert @benchmarked_tests.include?('test_2 (Class1)')
+    assert @benchmarked_tests.include?('test_3 (Class1)')
+    assert @benchmarked_tests.include?('test_1 (Class2)')
+    assert @benchmarked_tests.include?('test_2 (Class2)')
+    assert @benchmarked_tests.include?('test_3 (Class2)')
+    assert @benchmarked_tests.include?('test_1 (Class3)')
+    assert @benchmarked_tests.include?('test_2 (Class3)')
+    assert @benchmarked_tests.include?('test_3 (Class3)')
+  end
+  
+  def test_does_not_have_tests_not_descended_from_test_unit_testcase
+    assert !@benchmarked_tests.include?("test_1 (Class4)")
+  end
+  
+  def test_class_benchmark_results
+    # should be in order from slowest to fastest
+    assert_match class_benchmark_regex('Class3', 1), @out
+    assert_match class_benchmark_regex('Class2', 2), @out
+    assert_match class_benchmark_regex('Class1', 3), @out
+  end
+  
+  def test_test_benchmark_results
+    # should be in order from slowest to fastest
+    assert_match test_benchmark_regex('test_3 (Class3)', 1), @out
+    assert_match test_benchmark_regex('test_2 (Class3)', 2), @out
+    assert_match test_benchmark_regex('test_1 (Class3)', 3), @out
+    assert_match test_benchmark_regex('test_3 (Class2)', 4), @out
+    assert_match test_benchmark_regex('test_2 (Class2)', 5), @out
+    assert_match test_benchmark_regex('test_1 (Class2)', 6), @out
+    assert_match test_benchmark_regex('test_3 (Class1)', 7), @out
+    assert_match test_benchmark_regex('test_2 (Class1)', 8), @out
+    assert_match test_benchmark_regex('test_1 (Class1)', 9), @out
+  end
+  
+  private
+  
+  # borrowed from zentest assertions...
+  def util_capture
+    require 'stringio'
+    orig_stdout = $stdout.dup
+    orig_stderr = $stderr.dup
+    captured_stdout = StringIO.new
+    captured_stderr = StringIO.new
+    $stdout = captured_stdout
+    $stderr = captured_stderr
+    yield
+    captured_stdout.rewind
+    captured_stderr.rewind
+    return captured_stdout.string, captured_stderr.string
+  ensure
+    $stdout = orig_stdout
+    $stderr = orig_stderr
+  end
+  
+  def class_benchmark_regex(class_name, slowness_ranking)
+    # http://rubular.com/regexes/6815
+    /^#{slowness_ranking}\.\s+[\d\.]+ secs avg time, [\d\.]+ secs total time, [\d]+ tests for: #{Regexp.escape(class_name)}$/
+  end
+  
+  def test_benchmark_regex(test_name, slowness_ranking)
+    # http://rubular.com/regexes/6816
+    /^#{slowness_ranking}.\s+[\d\.]+ secs total time for: #{Regexp.escape(test_name)}$/
+  end
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification 
+name: myronmarston-test_benchmarker
+version: !ruby/object:Gem::Version 
+  version: 0.9.1
+platform: ruby
+authors: 
+- Myron Marston
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-03-27 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: myron.marston@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- CHANGELOG
+- README.rdoc
+files: 
+- CHANGELOG
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib
+- lib/test_benchmarker
+- lib/test_benchmarker.rb
+- lib/test_benchmarker/core_ext.rb
+- lib/test_benchmarker/test_benchmarks.rb
+- lib/test_benchmarker/test_suite.rb
+- test
+- test/test_core_ext.rb
+- test/test_helper.rb
+- test/test_test_benchmarker.rb
+has_rdoc: true
+homepage: http://github.com/myronmarston/test_benchmarker
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+- --title
+- TestBenchmarker Documentation
+- --charset
+- utf-8
+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: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: A tool for benchmarking ruby Test::Unit tests
+test_files: 
+- test/test_core_ext.rb
+- test/test_helper.rb
+- test/test_test_benchmarker.rb