activesupport 3.0.20 → 3.1.0

data/lib/active_support/testing/performance.rb

@@ -1,38 +1,83 @@
-begin
-  require 'ruby-prof'
-
-  require 'fileutils'
-  require 'rails/version'
-  require 'active_support/core_ext/class/delegating_attributes'
-  require 'active_support/core_ext/string/inflections'
-
-  module ActiveSupport
-    module Testing
-      module Performance
-        DEFAULTS =
-          if benchmark = ARGV.include?('--benchmark')  # HAX for rake test
-            { :benchmark => true,
-              :runs => 4,
-              :metrics => [:wall_time, :memory, :objects, :gc_runs, :gc_time],
-              :output => 'tmp/performance' }
-          else
-            { :benchmark => false,
-              :runs => 1,
-              :min_percent => 0.01,
-              :metrics => [:process_time, :memory, :objects],
-              :formats => [:flat, :graph_html, :call_tree],
-              :output => 'tmp/performance' }
-          end.freeze
-
-        def self.included(base)
-          base.superclass_delegating_accessor :profile_options
-          base.profile_options = DEFAULTS
+require 'fileutils'
+require 'rails/version'
+require 'active_support/concern'
+require 'active_support/core_ext/class/delegating_attributes'
+require 'active_support/core_ext/string/inflections'
+require 'action_view/helpers/number_helper'
+
+module ActiveSupport
+  module Testing
+    module Performance
+      extend ActiveSupport::Concern
+
+      included do
+        superclass_delegating_accessor :profile_options
+        self.profile_options = {}
+
+        if defined?(MiniTest::Assertions) && TestCase < MiniTest::Assertions
+          include ForMiniTest
+        else
+          include ForClassicTestUnit
+        end
+      end
+
+      # each implementation should define metrics and freeze the defaults
+      DEFAULTS =
+        if ARGV.include?('--benchmark') # HAX for rake test
+          { :runs => 4,
+            :output => 'tmp/performance',
+            :benchmark => true }
+        else
+          { :runs => 1,
+            :output => 'tmp/performance',
+            :benchmark => false }
+        end
+
+      def full_profile_options
+        DEFAULTS.merge(profile_options)
+      end
+
+      def full_test_name
+        "#{self.class.name}##{method_name}"
+      end
+
+      module ForMiniTest
+        def run(runner)
+          @runner = runner
+
+          run_warmup
+          if full_profile_options && metrics = full_profile_options[:metrics]
+            metrics.each do |metric_name|
+              if klass = Metrics[metric_name.to_sym]
+                run_profile(klass.new)
+              end
+            end
+          end
+
+          return
         end
 
-        def full_test_name
-          "#{self.class.name}##{method_name}"
+        def run_test(metric, mode)
+          result = '.'
+          begin
+            run_callbacks :setup
+            setup
+            metric.send(mode) { __send__ method_name }
+          rescue Exception => e
+            result = @runner.puke(self.class, method_name, e)
+          ensure
+            begin
+              teardown
+              run_callbacks :teardown, :enumerator => :reverse_each
+            rescue Exception => e
+              result = @runner.puke(self.class, method_name, e)
+            end
+          end
+          result
         end
+      end
 
+      module ForClassicTestUnit
         def run(result)
           return if method_name =~ /^default_test$/
 
@@ -40,11 +85,13 @@ begin
           @_result = result
 
           run_warmup
-          if profile_options && metrics = profile_options[:metrics]
+          if full_profile_options && metrics = full_profile_options[:metrics]
             metrics.each do |metric_name|
               if klass = Metrics[metric_name.to_sym]
                 run_profile(klass.new)
                 result.add_run
+              else
+                puts '%20s: unsupported' % metric_name
               end
             end
           end
@@ -57,7 +104,7 @@ begin
           setup
           metric.send(mode) { __send__ @method_name }
         rescue ::Test::Unit::AssertionFailedError => e
-          add_failure(e.message, e.backtrace)
+        add_failure(e.message, e.backtrace)
         rescue StandardError, ScriptError => e
           add_error(e)
         ensure
@@ -70,356 +117,201 @@ begin
             add_error(e)
           end
         end
+      end
 
-        protected
-          def run_warmup
-            GC.start
+      protected
+        # overridden by each implementation
+        def run_gc; end
 
-            time = Metrics::Time.new
-            run_test(time, :benchmark)
-            puts "%s (%s warmup)" % [full_test_name, time.format(time.total)]
+        def run_warmup
+          run_gc
 
-            GC.start
-          end
+          time = Metrics::Time.new
+          run_test(time, :benchmark)
+          puts "%s (%s warmup)" % [full_test_name, time.format(time.total)]
 
-          def run_profile(metric)
-            klass = profile_options[:benchmark] ? Benchmarker : Profiler
-            performer = klass.new(self, metric)
+          run_gc
+        end
 
-            performer.run
-            puts performer.report
-            performer.record
-          end
+        def run_profile(metric)
+          klass = full_profile_options[:benchmark] ? Benchmarker : Profiler
+          performer = klass.new(self, metric)
 
-        class Performer
-          delegate :run_test, :profile_options, :full_test_name, :to => :@harness
+          performer.run
+          puts performer.report
+          performer.record
+        end
 
-          def initialize(harness, metric)
-            @harness, @metric = harness, metric
-          end
+      class Performer
+        delegate :run_test, :full_profile_options, :full_test_name, :to => :@harness
+
+        def initialize(harness, metric)
+          @harness, @metric, @supported = harness, metric, false
+        end
 
-          def report
-            rate = @total / profile_options[:runs]
+        def report
+          if @supported
+            rate = @total / full_profile_options[:runs]
             '%20s: %s' % [@metric.name, @metric.format(rate)]
+          else
+            '%20s: unsupported' % @metric.name
           end
-
-          protected
-            def output_filename
-              "#{profile_options[:output]}/#{full_test_name}_#{@metric.name}"
-            end
         end
 
-        class Benchmarker < Performer
-          def run
-            profile_options[:runs].to_i.times { run_test(@metric, :benchmark) }
-            @total = @metric.total
+        protected
+          def output_filename
+            "#{full_profile_options[:output]}/#{full_test_name}_#{@metric.name}"
           end
+      end
 
-          def record
-            avg = @metric.total / profile_options[:runs].to_i
-            now = Time.now.utc.xmlschema
-            with_output_file do |file|
-              file.puts "#{avg},#{now},#{environment}"
-            end
-          end
+      # overridden by each implementation
+      class Profiler < Performer
+        def time_with_block
+          before = Time.now
+          yield
+          Time.now - before
+        end
 
-          def environment
-            unless defined? @env
-              app = "#{$1}.#{$2}" if File.directory?('.git') && `git branch -v` =~ /^\* (\S+)\s+(\S+)/
+        def run;    end
+        def record; end
+      end
 
-              rails = Rails::VERSION::STRING
-              if File.directory?('vendor/rails/.git')
-                Dir.chdir('vendor/rails') do
-                  rails += ".#{$1}.#{$2}" if `git branch -v` =~ /^\* (\S+)\s+(\S+)/
-                end
-              end
+      class Benchmarker < Performer     
+        def initialize(*args)
+          super
+          @supported = @metric.respond_to?('measure')
+        end
 
-              ruby = defined?(RUBY_ENGINE) ? RUBY_ENGINE : 'ruby'
-              ruby += "-#{RUBY_VERSION}.#{RUBY_PATCHLEVEL}"
+        def run
+          return unless @supported
 
-              @env = [app, rails, ruby, RUBY_PLATFORM] * ','
-            end
+          full_profile_options[:runs].to_i.times { run_test(@metric, :benchmark) }
+          @total = @metric.total
+        end
 
-            @env
+        def record
+          avg = @metric.total / full_profile_options[:runs].to_i
+          now = Time.now.utc.xmlschema
+          with_output_file do |file|
+            file.puts "#{avg},#{now},#{environment}"
           end
+        end
 
-          protected
-            HEADER = 'measurement,created_at,app,rails,ruby,platform'
-
-            def with_output_file
-              fname = output_filename
-
-              if new = !File.exist?(fname)
-                FileUtils.mkdir_p(File.dirname(fname))
-              end
+        def environment
+          unless defined? @env
+            app = "#{$1}.#{$2}" if File.directory?('.git') && `git branch -v` =~ /^\* (\S+)\s+(\S+)/
 
-              File.open(fname, 'ab') do |file|
-                file.puts(HEADER) if new
-                yield file
+            rails = Rails::VERSION::STRING
+            if File.directory?('vendor/rails/.git')
+              Dir.chdir('vendor/rails') do
+                rails += ".#{$1}.#{$2}" if `git branch -v` =~ /^\* (\S+)\s+(\S+)/
               end
             end
 
-            def output_filename
-              "#{super}.csv"
-            end
-        end
-
-        class Profiler < Performer
-          def initialize(*args)
-            super
-            @supported = @metric.measure_mode rescue false
-          end
-
-          def run
-            return unless @supported
+            ruby = defined?(RUBY_ENGINE) ? RUBY_ENGINE : 'ruby'
+            ruby += "-#{RUBY_VERSION}.#{RUBY_PATCHLEVEL}"
 
-            RubyProf.measure_mode = @metric.measure_mode
-            RubyProf.start
-            RubyProf.pause
-            profile_options[:runs].to_i.times { run_test(@metric, :profile) }
-            @data = RubyProf.stop
-            @total = @data.threads.values.sum(0) { |method_infos| method_infos.max.total_time }
+            @env = [app, rails, ruby, RUBY_PLATFORM] * ','
           end
 
-          def report
-            if @supported
-              super
-            else
-              '%20s: unsupported' % @metric.name
-            end
-          end
+          @env
+        end
 
-          def record
-            return unless @supported
+        protected
+          HEADER = 'measurement,created_at,app,rails,ruby,platform'
 
-            klasses = profile_options[:formats].map { |f| RubyProf.const_get("#{f.to_s.camelize}Printer") }.compact
+          def with_output_file
+            fname = output_filename
 
-            klasses.each do |klass|
-              fname = output_filename(klass)
+            if new = !File.exist?(fname)
               FileUtils.mkdir_p(File.dirname(fname))
-              File.open(fname, 'wb') do |file|
-                klass.new(@data).print(file, profile_options.slice(:min_percent))
-              end
             end
-          end
 
-          protected
-            def output_filename(printer_class)
-              suffix =
-                case printer_class.name.demodulize
-                  when 'FlatPrinter';                 'flat.txt'
-                  when 'FlatPrinterWithLineNumbers';  'flat_line_numbers.txt'
-                  when 'GraphPrinter';                'graph.txt'
-                  when 'GraphHtmlPrinter';            'graph.html'
-                  when 'GraphYamlPrinter';            'graph.yml'
-                  when 'CallTreePrinter';             'tree.txt'
-                  when 'CallStackPrinter';            'stack.html'
-                  when 'DotPrinter';                  'graph.dot'
-                  else printer_class.name.sub(/Printer$/, '').underscore
-                end
-
-              "#{super()}_#{suffix}"
+            File.open(fname, 'ab') do |file|
+              file.puts(HEADER) if new
+              yield file
             end
-        end
-
-        module Metrics
-          def self.[](name)
-            const_get(name.to_s.camelize)
-          rescue NameError
-            nil
           end
 
-          class Base
-            attr_reader :total
-
-            def initialize
-              @total = 0
-            end
-
-            def name
-              @name ||= self.class.name.demodulize.underscore
-            end
-
-            def measure_mode
-              self.class::Mode
-            end
-
-            def measure
-              0
-            end
-
-            def benchmark
-              with_gc_stats do
-                before = measure
-                yield
-                @total += (measure - before)
-              end
-            end
-
-            def profile
-              RubyProf.resume
-              yield
-            ensure
-              RubyProf.pause
-            end
-
-            protected
-              # Ruby 1.9 with GC::Profiler
-              if defined?(GC::Profiler)
-                def with_gc_stats
-                  GC::Profiler.enable
-                  GC.start
-                  yield
-                ensure
-                  GC::Profiler.disable
-                end
-
-              # Ruby 1.8 + ruby-prof wrapper (enable/disable stats for Benchmarker)
-              elsif GC.respond_to?(:enable_stats)
-                def with_gc_stats
-                  GC.enable_stats
-                  yield
-                ensure
-                  GC.disable_stats
-                end
-
-              else
-                def with_gc_stats
-                  yield
-                end
-              end
+          def output_filename
+            "#{super}.csv"
           end
+      end
 
-          class Time < Base
-            def measure
-              ::Time.now.to_f
-            end
+      module Metrics
+        def self.[](name)
+          const_get(name.to_s.camelize)
+        rescue NameError
+          nil
+        end
 
-            def format(measurement)
-              if measurement < 1
-                '%d ms' % (measurement * 1000)
-              else
-                '%.2f sec' % measurement
-              end
-            end
-          end
+        class Base
+          include ActionView::Helpers::NumberHelper
 
-          class ProcessTime < Time
-            Mode = RubyProf::PROCESS_TIME
+          attr_reader :total
 
-            def measure
-              RubyProf.measure_process_time
-            end
+          def initialize
+            @total = 0
           end
 
-          class WallTime < Time
-            Mode = RubyProf::WALL_TIME
-
-            def measure
-              RubyProf.measure_wall_time
-            end
+          def name
+            @name ||= self.class.name.demodulize.underscore
           end
 
-          class CpuTime < Time
-            Mode = RubyProf::CPU_TIME if RubyProf.const_defined?(:CPU_TIME)
-
-            def initialize(*args)
-              # FIXME: yeah my CPU is 2.33 GHz
-              RubyProf.cpu_frequency = 2.33e9 unless RubyProf.cpu_frequency > 0
-              super
-            end
-
-            def measure
-              RubyProf.measure_cpu_time
+          def benchmark            
+            with_gc_stats do
+              before = measure
+              yield
+              @total += (measure - before)
             end
           end
 
-          class Memory < Base
-            Mode = RubyProf::MEMORY if RubyProf.const_defined?(:MEMORY)
+          # overridden by each implementation
+          def profile; end
 
-            # Ruby 1.9 + GCdata patch
-            if GC.respond_to?(:malloc_allocated_size)
-              def measure
-                GC.malloc_allocated_size / 1024.0
-              end
-
-            # Ruby 1.8 + ruby-prof wrapper
-            elsif RubyProf.respond_to?(:measure_memory)
-              def measure
-                RubyProf.measure_memory / 1024.0
-              end
-            end
+          protected
+            # overridden by each implementation
+            def with_gc_stats; end
+        end
 
-            def format(measurement)
-              '%.2f KB' % measurement
-            end
+        class Time < Base
+          def measure
+            ::Time.now.to_f
           end
 
-          class Objects < Base
-            Mode = RubyProf::ALLOCATIONS if RubyProf.const_defined?(:ALLOCATIONS)
-
-            # Ruby 1.9 + GCdata patch
-            if GC.respond_to?(:malloc_allocations)
-              def measure
-                GC.malloc_allocations
-              end
-
-            # Ruby 1.8 + ruby-prof wrapper
-            elsif RubyProf.respond_to?(:measure_allocations)
-              def measure
-                RubyProf.measure_allocations
-              end
-            end
-
-            def format(measurement)
-              measurement.to_i.to_s
+          def format(measurement)
+            if measurement < 1
+              '%d ms' % (measurement * 1000)
+            else
+              '%.2f sec' % measurement
             end
           end
+        end
 
-          class GcRuns < Base
-            Mode = RubyProf::GC_RUNS if RubyProf.const_defined?(:GC_RUNS)
-
-            # Ruby 1.9
-            if GC.respond_to?(:count)
-              def measure
-                GC.count
-              end
-
-            # Ruby 1.8 + ruby-prof wrapper
-            elsif RubyProf.respond_to?(:measure_gc_runs)
-              def measure
-                RubyProf.measure_gc_runs
-              end
-            end
-
-            def format(measurement)
-              measurement.to_i.to_s
-            end
+        class Amount < Base
+          def format(measurement)
+            number_with_delimiter(measurement.floor)
           end
+        end
 
-          class GcTime < Base
-            Mode = RubyProf::GC_TIME if RubyProf.const_defined?(:GC_TIME)
-
-            # Ruby 1.9 with GC::Profiler
-            if defined?(GC::Profiler) && GC::Profiler.respond_to?(:total_time)
-              def measure
-                GC::Profiler.total_time
-              end
-
-            # Ruby 1.8 + ruby-prof wrapper
-            elsif RubyProf.respond_to?(:measure_gc_time)
-              def measure
-                RubyProf.measure_gc_time / 1000
-              end
-            end
-
-            def format(measurement)
-              '%.2f ms' % measurement
-            end
+        class DigitalInformationUnit < Base
+          def format(measurement)
+            number_to_human_size(measurement, :precision => 2)
           end
         end
+
+        # each implementation provides its own metrics like ProcessTime, Memory or GcRuns
       end
     end
   end
-rescue LoadError
+end
+
+RUBY_ENGINE = 'ruby' unless defined?(RUBY_ENGINE) # mri 1.8
+case RUBY_ENGINE
+  when 'ruby'   then require 'active_support/testing/performance/ruby'
+  when 'rbx'    then require 'active_support/testing/performance/rubinius'
+  when 'jruby'  then require 'active_support/testing/performance/jruby'
+  else
+    $stderr.puts 'Your ruby interpreter is not supported for benchmarking.'
+    exit
 end