Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Performance: integration test benchmarking and profiling. [Jeremy Kem…

…per]
  • Loading branch information...
commit eab71208db1afead6803501c8d51d77625e5ad6e 1 parent ba0f38f
Jeremy Kemper jeremy authored
9 actionpack/lib/action_controller/integration.rb
View
@@ -1,9 +1,10 @@
-require 'stringio'
-require 'uri'
-
+require 'active_support/test_case'
require 'action_controller/dispatcher'
require 'action_controller/test_process'
+require 'stringio'
+require 'uri'
+
module ActionController
module Integration #:nodoc:
# An integration Session instance represents a set of requests and responses
@@ -580,7 +581,7 @@ def method_missing(sym, *args, &block)
# end
# end
# end
- class IntegrationTest < Test::Unit::TestCase
+ class IntegrationTest < ActiveSupport::TestCase
include Integration::Runner
# Work around a bug in test/unit caused by the default test being named
16 actionpack/lib/action_controller/performance_test.rb
View
@@ -0,0 +1,16 @@
+require 'action_controller/integration'
+require 'active_support/testing/performance'
+require 'active_support/testing/default'
+
+module ActionController
+ # An integration test that runs a code profiler on your test methods.
+ # Profiling output for combinations of each test method, measurement, and
+ # output format are written to your tmp/performance directory.
+ #
+ # By default, process_time is measured and both flat and graph_html output
+ # formats are written, so you'll have two output files per test method.
+ class PerformanceTest < ActionController::IntegrationTest
+ include ActiveSupport::Testing::Performance
+ include ActiveSupport::Testing::Default
+ end
+end
226 activesupport/lib/active_support/testing/performance.rb
View
@@ -0,0 +1,226 @@
+require 'rubygems'
+gem 'ruby-prof', '>= 0.6.1'
+require 'ruby-prof'
+
+require 'fileutils'
+require 'rails/version'
+
+module ActiveSupport
+ module Testing
+ module Performance
+ benchmark = ARGV.include?('--benchmark') # HAX for rake test
+
+ DEFAULTS = {
+ :benchmark => benchmark,
+ :runs => benchmark ? 20 : 4,
+ :min_percent => 0.05,
+ :metrics => [:process_time, :memory, :allocations],
+ :formats => [:flat, :graph_html, :call_tree],
+ :output => 'tmp/performance' }
+
+ def self.included(base)
+ base.extend ClassMethods
+ base.class_inheritable_accessor :profile_options
+ base.profile_options = DEFAULTS.dup
+ end
+
+ def run(result)
+ return if method_name =~ /^default_test$/
+
+ yield(self.class::STARTED, name)
+ @_result = result
+
+ run_warmup
+
+ self.class.measure_modes.each do |measure_mode|
+ data = run_profile(measure_mode)
+ self.class.report_profile_total(data, measure_mode)
+ self.class.record_results(full_test_name, data, measure_mode)
+ result.add_run
+ end
+
+ yield(self.class::FINISHED, name)
+ end
+
+ protected
+ def full_test_name
+ "#{self.class.name}##{@method_name}"
+ end
+
+ def run_test
+ run_callbacks :setup
+ setup
+ yield
+ rescue ::Test::Unit::AssertionFailedError => e
+ add_failure(e.message, e.backtrace)
+ rescue StandardError, ScriptError
+ add_error($!)
+ ensure
+ begin
+ teardown
+ run_callbacks :teardown, :enumerator => :reverse_each
+ rescue ::Test::Unit::AssertionFailedError => e
+ add_failure(e.message, e.backtrace)
+ rescue StandardError, ScriptError
+ add_error($!)
+ end
+ end
+
+ def run_warmup
+ puts
+ print full_test_name
+
+ run_test do
+ bench = Benchmark.realtime do
+ __send__(@method_name)
+ end
+ puts " (%.2fs warmup)" % bench
+ end
+ end
+
+ def run_profile(measure_mode)
+ RubyProf.benchmarking = profile_options[:benchmark]
+ RubyProf.measure_mode = measure_mode
+
+ print ' '
+ profile_options[:runs].times do |i|
+ run_test do
+ begin
+ GC.disable
+ RubyProf.resume { __send__(@method_name) }
+ print '.'
+ $stdout.flush
+ ensure
+ GC.enable
+ end
+ end
+ end
+
+ RubyProf.stop
+ end
+
+ module ClassMethods
+ def record_results(test_name, data, measure_mode)
+ if RubyProf.benchmarking?
+ record_benchmark(test_name, data, measure_mode)
+ else
+ record_profile(test_name, data, measure_mode)
+ end
+ end
+
+ def report_profile_total(data, measure_mode)
+ total_time =
+ if RubyProf.benchmarking?
+ data
+ else
+ data.threads.values.sum(0) do |method_infos|
+ method_infos.sort.last.total_time
+ end
+ end
+
+ format =
+ case measure_mode
+ when RubyProf::PROCESS_TIME, RubyProf::WALL_TIME
+ "%.2f seconds"
+ when RubyProf::MEMORY
+ "%.2f bytes"
+ when RubyProf::ALLOCATIONS
+ "%d allocations"
+ else
+ "%.2f #{measure_mode}"
+ end
+
+ total = format % total_time
+ puts "\n #{ActiveSupport::Testing::Performance::Util.metric_name(measure_mode)}: #{total}\n"
+ end
+
+ def measure_modes
+ ActiveSupport::Testing::Performance::Util.measure_modes(profile_options[:metrics])
+ end
+
+ def printer_classes
+ ActiveSupport::Testing::Performance::Util.printer_classes(profile_options[:formats])
+ end
+
+ private
+ def record_benchmark(test_name, data, measure_mode)
+ bench_filename = "#{profile_options[:output]}/benchmarks.csv"
+
+ if new_file = !File.exist?(bench_filename)
+ FileUtils.mkdir_p(File.dirname(bench_filename))
+ end
+
+ File.open(bench_filename, 'ab') do |file|
+ if new_file
+ file.puts 'test,metric,measurement,runs,average,created_at,rails_version,ruby_engine,ruby_version,ruby_patchlevel,ruby_platform'
+ end
+
+ file.puts [test_name,
+ ActiveSupport::Testing::Performance::Util.metric_name(measure_mode),
+ data, profile_options[:runs], data / profile_options[:runs],
+ Time.now.utc.xmlschema,
+ Rails::VERSION::STRING,
+ defined?(RUBY_ENGINE) ? RUBY_ENGINE : 'ruby',
+ RUBY_VERSION, RUBY_PATCHLEVEL, RUBY_PLATFORM].join(',')
+ end
+ end
+
+ def record_profile(test_name, data, measure_mode)
+ printer_classes.each do |printer_class|
+ fname = output_filename(test_name, printer, measure_mode)
+
+ FileUtils.mkdir_p(File.dirname(fname))
+ File.open(fname, 'wb') do |file|
+ printer_class.new(data).print(file, profile_printer_options)
+ end
+ end
+ end
+
+ # The report filename is test_name + measure_mode + report_type
+ def output_filename(test_name, printer, measure_mode)
+ suffix =
+ case printer
+ when RubyProf::FlatPrinter; 'flat.txt'
+ when RubyProf::GraphPrinter; 'graph.txt'
+ when RubyProf::GraphHtmlPrinter; 'graph.html'
+ when RubyProf::CallTreePrinter; 'tree.txt'
+ else printer.to_s.downcase
+ end
+
+ "#{profile_options[:output]}/#{test_name}_#{ActiveSupport::Testing::Performance::Util.metric_name(measure_mode)}_#{suffix}"
+ end
+
+ def profile_printer_options
+ profile_options.slice(:min_percent)
+ end
+ end
+
+ module Util
+ extend self
+
+ def metric_name(measure_mode)
+ case measure_mode
+ when RubyProf::PROCESS_TIME; 'process_time'
+ when RubyProf::WALL_TIME; 'wall_time'
+ when RubyProf::MEMORY; 'memory'
+ when RubyProf::ALLOCATIONS; 'allocations'
+ else "measure#{measure_mode}"
+ end
+ end
+
+ def measure_modes(metrics)
+ ruby_prof_consts(metrics.map { |m| m.to_s.upcase })
+ end
+
+ def printer_classes(formats)
+ ruby_prof_consts(formats.map { |f| "#{f.to_s.camelize}Printer" })
+ end
+
+ private
+ def ruby_prof_consts(names)
+ names.map { |name| RubyProf.const_get(name) rescue nil }.compact
+ end
+ end
+ end
+ end
+end
11 railties/helpers/performance_test.rb
View
@@ -0,0 +1,11 @@
+ENV['RAILS_ENV'] ||= 'test'
+require "#{File.dirname(__FILE__)}/../../config/environment"
+require 'test/unit'
+require 'action_controller/performance_test'
+
+# Profiling results for each test method are written to tmp/performance.
+class BrowsingTest < ActionController::PerformanceTest
+ def test_homepage
+ get '/'
+ end
+end
2  railties/lib/rails_generator/generators/applications/app/app_generator.rb
View
@@ -51,6 +51,7 @@ def manifest
m.template "helpers/application.rb", "app/controllers/application.rb", :assigns => { :app_name => @app_name, :app_secret => md5.hexdigest }
m.template "helpers/application_helper.rb", "app/helpers/application_helper.rb"
m.template "helpers/test_helper.rb", "test/test_helper.rb"
+ m.template "helpers/performance_test.rb", "test/performance/browsing_test.rb"
# database.yml and routes.rb
m.template "configs/databases/#{options[:db]}.yml", "config/database.yml", :assigns => {
@@ -155,6 +156,7 @@ def mysql_socket_location
test/fixtures
test/functional
test/integration
+ test/performance
test/unit
vendor
vendor/plugins
15 railties/lib/tasks/testing.rake
View
@@ -103,6 +103,21 @@ namespace :test do
end
Rake::Task['test:integration'].comment = "Run the integration tests in test/integration"
+ Rake::TestTask.new(:benchmark) do |t|
+ t.libs << 'test'
+ t.pattern = 'test/performance/**/*_test.rb'
+ t.verbose = true
+ t.options = '-- --benchmark'
+ end
+ Rake::Task['test:benchmark'].comment = 'Benchmark the performance tests'
+
+ Rake::TestTask.new(:profile) do |t|
+ t.libs << 'test'
+ t.pattern = 'test/performance/**/*_test.rb'
+ t.verbose = true
+ end
+ Rake::Task['test:profile'].comment = 'Profile the performance tests'
+
Rake::TestTask.new(:plugins => :environment) do |t|
t.libs << "test"
Please sign in to comment.
Something went wrong with that request. Please try again.