rails-perftest 0.0.1

data/lib/rails/perftest/active_support/testing/performance/rubinius.rb

@@ -0,0 +1,113 @@
+require 'rubinius/agent'
+
+module ActiveSupport
+  module Testing
+    module Performance
+      DEFAULTS.merge!(
+        if ARGV.include?('--benchmark')
+          {:metrics => [:wall_time, :memory, :objects, :gc_runs, :gc_time]}
+        else
+          { :metrics => [:wall_time],
+            :formats => [:flat, :graph] }
+        end).freeze
+
+      protected
+        def run_gc
+          GC.run(true)
+        end
+
+      class Performer; end
+
+      class Profiler < Performer
+        def initialize(*args)
+          super
+          @supported = @metric.is_a?(Metrics::WallTime)
+        end
+
+        def run
+          return unless @supported
+
+          @profiler = Rubinius::Profiler::Instrumenter.new
+
+          @total = time_with_block do
+            @profiler.profile(false) do
+              full_profile_options[:runs].to_i.times { run_test(@metric, :profile) }
+            end
+          end
+        end
+
+        def record
+          return unless @supported
+
+          if(full_profile_options[:formats].include?(:flat))
+            create_path_and_open_file(:flat) do |file|
+              @profiler.show(file)
+            end
+          end
+
+          if(full_profile_options[:formats].include?(:graph))
+            create_path_and_open_file(:graph) do |file|
+              @profiler.show(file)
+            end
+          end
+        end
+
+        protected
+          def create_path_and_open_file(printer_name)
+            fname = "#{output_filename}_#{printer_name}.txt"
+            FileUtils.mkdir_p(File.dirname(fname))
+            File.open(fname, 'wb') do |file|
+              yield(file)
+            end
+          end
+      end
+
+      module Metrics
+        class Base
+          attr_reader :loopback
+
+          def profile
+            yield
+          end
+
+          protected
+            def with_gc_stats
+              @loopback = Rubinius::Agent.loopback
+              GC.run(true)
+              yield
+            end
+        end
+
+        class WallTime < Time
+          def measure
+            super
+          end
+        end
+
+        class Memory < DigitalInformationUnit
+          def measure
+            loopback.get("system.memory.counter.bytes").last
+          end
+        end
+
+        class Objects < Amount
+          def measure
+            loopback.get("system.memory.counter.objects").last
+          end
+        end
+
+        class GcRuns < Amount
+          def measure
+            loopback.get("system.gc.full.count").last + loopback.get("system.gc.young.count").last
+          end
+        end
+
+        class GcTime < Time
+          def measure
+            (loopback.get("system.gc.full.wallclock").last + loopback.get("system.gc.young.wallclock").last) / 1000.0
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails/perftest/active_support/testing/performance/ruby.rb

@@ -0,0 +1,173 @@
+begin
+  require 'ruby-prof'
+rescue LoadError
+  $stderr.puts 'Specify ruby-prof as application\'s dependency in Gemfile to run benchmarks.'
+  raise
+end
+
+module ActiveSupport
+  module Testing
+    module Performance
+      DEFAULTS.merge!(
+        if ARGV.include?('--benchmark')
+          { :metrics => [:wall_time, :memory, :objects, :gc_runs, :gc_time] }
+        else
+          { :min_percent => 0.01,
+            :metrics => [:process_time, :memory, :objects],
+            :formats => [:flat, :graph_html, :call_tree, :call_stack] }
+        end).freeze
+
+      protected
+        remove_method :run_gc
+        def run_gc
+          GC.start
+        end
+
+      class Profiler < Performer
+        def initialize(*args)
+          super
+          @supported = @metric.measure_mode rescue false
+        end
+
+        remove_method :run
+        def run
+          return unless @supported
+
+          RubyProf.measure_mode = @metric.measure_mode
+          RubyProf.start
+          RubyProf.pause
+          full_profile_options[:runs].to_i.times { run_test(@metric, :profile) }
+          @data = RubyProf.stop
+          @total = @data.threads.sum(0) { |thread| thread.methods.max.total_time }
+        end
+
+        remove_method :record
+        def record
+          return unless @supported
+
+          klasses = full_profile_options[:formats].map { |f| RubyProf.const_get("#{f.to_s.camelize}Printer") }.compact
+
+          klasses.each do |klass|
+            fname = output_filename(klass)
+            FileUtils.mkdir_p(File.dirname(fname))
+            File.open(fname, 'wb') do |file|
+              klass.new(@data).print(file, full_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}"
+          end
+      end
+
+      module Metrics
+        class Base
+          def measure_mode
+            self.class::Mode
+          end
+
+          remove_method :profile
+          def profile
+            RubyProf.resume
+            yield
+          ensure
+            RubyProf.pause
+          end
+
+          protected
+            remove_method :with_gc_stats
+            def with_gc_stats
+              GC::Profiler.enable
+              GC.start
+              yield
+            ensure
+              GC::Profiler.disable
+            end
+        end
+
+        class ProcessTime < Time
+          Mode = RubyProf::PROCESS_TIME if RubyProf.const_defined?(:PROCESS_TIME)
+
+          def measure
+            RubyProf.measure_process_time
+          end
+        end
+
+        class WallTime < Time
+          Mode = RubyProf::WALL_TIME if RubyProf.const_defined?(:WALL_TIME)
+
+          def measure
+            RubyProf.measure_wall_time
+          end
+        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
+          end
+        end
+
+        class Memory < DigitalInformationUnit
+          Mode = RubyProf::MEMORY if RubyProf.const_defined?(:MEMORY)
+
+          # Ruby 1.9 + GCdata patch
+          if GC.respond_to?(:malloc_allocated_size)
+            def measure
+              GC.malloc_allocated_size
+            end
+          end
+        end
+
+        class Objects < Amount
+          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
+          end
+        end
+
+        class GcRuns < Amount
+          Mode = RubyProf::GC_RUNS if RubyProf.const_defined?(:GC_RUNS)
+
+          def measure
+            GC.count
+          end
+        end
+
+        class GcTime < Time
+          Mode = RubyProf::GC_TIME if RubyProf.const_defined?(:GC_TIME)
+
+          def measure
+            GC::Profiler.total_time
+          end
+        end
+      end
+    end
+  end
+end

data/lib/rails/perftest/commands.rb

@@ -0,0 +1,30 @@
+ARGV << '--help' if ARGV.empty?
+
+help_message = <<-EOT
+Usage: rperf COMMAND [ARGS]
+
+ benchmarker  See how fast a piece of code runs
+ profiler     Get profile information from a piece of code
+
+All commands can be run with -h (or --help) for more information.
+EOT
+
+command = ARGV.shift
+
+case command
+
+when 'benchmarker', 'profiler'
+  require APP_PATH
+  Rails.application.require_environment!
+  require "rails/perftest/commands/#{command}"
+
+when '-h', '--help'
+  puts help_message
+else
+  puts "Error: Command '#{command}' not recognized"
+  if %x{rake #{command} --dry-run 2>&1 } && $?.success?
+    puts "Did you mean: `$ rake #{command}` ?\n\n"
+  end
+  puts help_message
+  exit(1)
+end

data/lib/rails/perftest/commands/benchmarker.rb

@@ -0,0 +1,34 @@
+require 'optparse'
+require 'rails/test_help'
+require 'rails/performance_test_help'
+
+ARGV.push('--benchmark') # HAX
+require 'rails/perftest/active_support/testing/performance'
+ARGV.pop
+
+def options
+  options = {}
+  defaults = ActiveSupport::Testing::Performance::DEFAULTS
+
+  OptionParser.new do |opt|
+    opt.banner = "Usage: rails benchmarker 'Ruby.code' 'Ruby.more_code' ... [OPTS]"
+    opt.on('-r', '--runs N', Numeric, 'Number of runs.', "Default: #{defaults[:runs]}") { |r| options[:runs] = r }
+    opt.on('-o', '--output PATH', String, 'Directory to use when writing the results.', "Default: #{defaults[:output]}") { |o| options[:output] = o }
+    opt.on('-m', '--metrics a,b,c', Array, 'Metrics to use.', "Default: #{defaults[:metrics].join(",")}") { |m| options[:metrics] = m.map(&:to_sym) }
+    opt.parse!(ARGV)
+  end
+
+  options
+end
+
+class BenchmarkerTest < ActionDispatch::PerformanceTest #:nodoc:
+  self.profile_options = options
+
+  ARGV.each do |expression|
+    eval <<-RUBY
+      def test_#{expression.parameterize('_')}
+        #{expression}
+      end
+    RUBY
+  end
+end

data/lib/rails/perftest/commands/profiler.rb

@@ -0,0 +1,32 @@
+require 'optparse'
+require 'rails/test_help'
+require 'rails/performance_test_help'
+require 'rails/perftest/active_support/testing/performance'
+
+def options
+  options = {}
+  defaults = ActiveSupport::Testing::Performance::DEFAULTS
+
+  OptionParser.new do |opt|
+    opt.banner = "Usage: rails profiler 'Ruby.code' 'Ruby.more_code' ... [OPTS]"
+    opt.on('-r', '--runs N', Numeric, 'Number of runs.', "Default: #{defaults[:runs]}") { |r| options[:runs] = r }
+    opt.on('-o', '--output PATH', String, 'Directory to use when writing the results.', "Default: #{defaults[:output]}") { |o| options[:output] = o }
+    opt.on('-m', '--metrics a,b,c', Array, 'Metrics to use.', "Default: #{defaults[:metrics].join(",")}") { |m| options[:metrics] = m.map(&:to_sym) }
+    opt.on('-f', '--formats x,y,z', Array, 'Formats to output to.', "Default: #{defaults[:formats].join(",")}") { |m| options[:formats] = m.map(&:to_sym) }
+    opt.parse!(ARGV)
+  end
+
+  options
+end
+
+class ProfilerTest < ActionDispatch::PerformanceTest #:nodoc:
+  self.profile_options = options
+
+  ARGV.each do |expression|
+    eval <<-RUBY
+      def test_#{expression.parameterize('_')}
+        #{expression}
+      end
+    RUBY
+  end
+end

data/lib/rails/perftest/railtie.rb

@@ -0,0 +1,20 @@
+require 'rails/railtie'
+
+module Rails
+  module PerformanceTest
+    class Railtie < ::Rails::Railtie
+
+      rake_tasks do
+        load 'rails/perftest/railties/testing.tasks'
+      end
+
+      initializer "action_dispatch.performance_test" do
+        ActiveSupport.on_load(:action_controller) do
+          require "rails/perftest/action_dispatch"
+          require "rails/perftest/action_controller"
+        end
+      end
+
+    end
+  end
+end

data/lib/rails/perftest/railties/testing.tasks

@@ -0,0 +1,12 @@
+namespace :test do
+  Rails::SubTestTask.new(benchmark: 'test:prepare') do |t|
+    t.libs << 'test'
+    t.pattern = 'test/performance/**/*_test.rb'
+    t.options = '-- --benchmark'
+  end
+
+  Rails::SubTestTask.new(profile: 'test:prepare') do |t|
+    t.libs << 'test'
+    t.pattern = 'test/performance/**/*_test.rb'
+  end
+end

data/lib/rails/perftest/version.rb

@@ -0,0 +1,5 @@
+module Rails
+  module Perftest
+    VERSION = "0.0.1"
+  end
+end

data/rails-perftest.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rails/perftest/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Yves Senn"]
+  gem.email         = ["yves.senn@gmail.com"]
+  gem.description   = %q{Rails performance tests (removed from core in Rails 4.0)}
+  gem.summary       = %q{ActionDispatch::PerformanceTest, ActiveSupport::Testing::Performance extracted from Rails.}
+  gem.homepage      = "https://github.com/rails/rails-perftest"
+
+  gem.files         = [".gitignore","Gemfile","LICENSE","README.md","Rakefile","bin/perftest","lib/generators/rails/app/templates/test/performance/browsing_test.rb","lib/generators/rails/performance_test/USAGE","lib/generators/rails/performance_test/performance_test_generator.rb","lib/generators/rails/performance_test/templates/performance_test.rb","lib/rails-perftest.rb","lib/rails/performance_test_help.rb","lib/rails/perftest/action_controller.rb","lib/rails/perftest/action_controller/performance_test.rb","lib/rails/perftest/action_dispatch.rb","lib/rails/perftest/action_dispatch/performance_test.rb","lib/rails/perftest/active_support/testing/performance.rb","lib/rails/perftest/active_support/testing/performance/jruby.rb","lib/rails/perftest/active_support/testing/performance/rubinius.rb","lib/rails/perftest/active_support/testing/performance/ruby.rb","lib/rails/perftest/commands.rb","lib/rails/perftest/commands/benchmarker.rb","lib/rails/perftest/commands/profiler.rb","lib/rails/perftest/railtie.rb","lib/rails/perftest/railties/testing.tasks","lib/rails/perftest/version.rb","rails-perftest.gemspec","rails-perftest.gemspec.erb","test/generators/generators_test_helper.rb","test/generators/performance_test_generator_test.rb","test/helper.rb","test/performance_test.rb"]
+  gem.executables   = ["perftest"]
+  gem.test_files    = ["test/generators/generators_test_helper.rb","test/generators/performance_test_generator_test.rb","test/helper.rb","test/performance_test.rb"]
+  gem.name          = "rails-perftest"
+  gem.require_paths = ["lib"]
+  gem.version       = Rails::Perftest::VERSION
+
+  gem.add_development_dependency 'ruby-prof'
+  gem.add_development_dependency 'minitest', '>= 3'
+  gem.add_development_dependency 'railties', '~> 4.0.0.beta'
+  gem.add_development_dependency 'activerecord', '~> 4.0.0.beta'
+  gem.add_development_dependency 'activemodel', '~> 4.0.0.beta'
+  gem.add_development_dependency 'actionmailer', '~> 4.0.0.beta'
+  gem.add_development_dependency 'actionpack', '~> 4.0.0.beta'
+  gem.add_development_dependency 'sqlite3', '~> 1.3'
+end