Merge pull request #9080 from sikachu/master-rails-test

Add `rails test` command to run the test suite

4 files changed, 189 insertions, 55 deletions

diff --git a/railties/lib/rails/commands.rb b/railties/lib/rails/commands.rb
index aacde52cfc..41d3722c18 100644
--- a/railties/lib/rails/commands.rb
+++ b/railties/lib/rails/commands.rb
@@ -5,6 +5,7 @@ aliases = {
   "d"  => "destroy",
   "c"  => "console",
   "s"  => "server",
+  "t"  => "test",
   "db" => "dbconsole",
   "r"  => "runner"
 }
@@ -16,6 +17,7 @@ The most common rails commands are:
  generate    Generate new code (short-cut alias: "g")
  console     Start the Rails console (short-cut alias: "c")
  server      Start the Rails server (short-cut alias: "s")
+ test        Running the test file (short-cut alias: "t")
  dbconsole   Start a console for the database specified in config/database.yml
              (short-cut alias: "db")
  new         Create a new Rails application. "rails new my_app" creates a
@@ -78,6 +80,15 @@ when 'server'
     server.start
   end
 
+when 'test'
+  $LOAD_PATH.unshift("./test")
+  require 'rails/commands/test_runner'
+  options = Rails::TestRunner.parse_arguments(ARGV)
+  ENV['RAILS_ENV'] ||= options[:environment] || 'test'
+
+  require APP_PATH
+  Rails::TestRunner.start(ARGV, options)
+
 when 'dbconsole'
   require 'rails/commands/dbconsole'
   Rails::DBConsole.start
diff --git a/railties/lib/rails/commands/test_runner.rb b/railties/lib/rails/commands/test_runner.rb
new file mode 100644
index 0000000000..d8857bd183
--- /dev/null
+++ b/railties/lib/rails/commands/test_runner.rb
@@ -0,0 +1,146 @@
+require 'optparse'
+require 'minitest/unit'
+
+module Rails
+  # Handles all logic behind +rails test+ command.
+  class TestRunner
+    class << self
+      # Creates a new +TestRunner+ object with an array of test files to run
+      # based on the arguments. When no arguments are provided, it runs all test
+      # files. When a suite argument is provided, it runs only the test files in
+      # that suite. Otherwise, it runs the specified test file(s).
+      def start(files, options = {})
+        original_fixtures_options = options.delete(:fixtures)
+        options[:fixtures] = true
+
+        case files.first
+        when nil
+          new(Dir['test/**/*_test.rb'], options).run
+        when 'models'
+          new(Dir['test/models/**/*_test.rb'], options).run
+        when 'helpers'
+          new(Dir['test/helpers/**/*_test.rb'], options).run
+        when 'units'
+          new(Dir['test/{models,helpers,unit}/**/*_test.rb'], options).run
+        when 'controllers'
+          new(Dir['test/controllers/**/*_test.rb'], options).run
+        when 'mailers'
+          new(Dir['test/mailers/**/*_test.rb'], options).run
+        when 'functionals'
+          new(Dir['test/{controllers,mailers,functional}/**/*_test.rb'], options).run
+        when 'integration'
+          new(Dir['test/integration/**/*_test.rb'], options).run
+        else
+          options[:fixtures] = original_fixtures_options
+          new(files, options).run
+        end
+      end
+
+      # Parses arguments and sets them as option flags
+      def parse_arguments(arguments)
+        options = {}
+        orig_arguments = arguments.dup
+
+        OptionParser.new do |opts|
+          opts.banner = "Usage: rails test [path to test file(s) or test suite]"
+
+          opts.separator ""
+          opts.separator "Run a specific test file(s) or a test suite, under Rails'"
+          opts.separator "environment. If the file name(s) or suit name is omitted,"
+          opts.separator "Rails will run all tests."
+          opts.separator ""
+          opts.separator "Specific options:"
+
+          opts.on '-h', '--help', 'Display this help.' do
+            puts opts
+            exit
+          end
+
+          opts.on '-e', '--environment NAME', String, 'Specifies the environment to run this test under' do |e|
+            options[:environment] = e
+          end
+
+          opts.on '-f', '--fixtures', 'Load fixtures in test/fixtures/ before running the tests' do
+            options[:fixtures] = true
+          end
+
+          opts.on '-s', '--seed SEED', Integer, "Sets random seed" do |m|
+            options[:seed] = m.to_i
+          end
+
+          opts.on '-v', '--verbose', "Verbose. Show progress processing files." do
+            options[:verbose] = true
+          end
+
+          opts.on '-n', '--name PATTERN', "Filter test names on pattern (e.g. /foo/)" do |n|
+            options[:filter] = n
+          end
+
+          opts.separator ""
+          opts.separator "Support types of test suites:"
+          opts.separator "-------------------------------------------------------------"
+          opts.separator "* models (test/models/**/*)"
+          opts.separator "* helpers (test/helpers/**/*)"
+          opts.separator "* units (test/{models,helpers,unit}/**/*"
+          opts.separator "* controllers (test/controllers/**/*)"
+          opts.separator "* mailers (test/mailers/**/*)"
+          opts.separator "* functionals (test/{controllers,mailers,functional}/**/*)"
+          opts.separator "* integration (test/integration/**/*)"
+          opts.separator "-------------------------------------------------------------"
+
+          opts.parse! arguments
+          orig_arguments -= arguments
+        end
+        options
+      end
+    end
+
+    # Creates a new +TestRunner+ object with a list of test file paths.
+    def initialize(files, options)
+      @files = files
+
+      Rails.application.load_tasks
+      Rake::Task['db:test:load'].invoke
+
+      if options.delete(:fixtures)
+        if defined?(ActiveRecord::Base)
+          ActiveSupport::TestCase.send :include, ActiveRecord::TestFixtures
+          ActiveSupport::TestCase.fixture_path = "#{Rails.root}/test/fixtures/"
+          ActiveSupport::TestCase.fixtures :all
+        end
+      end
+
+      MiniTest::Unit.runner.options = options
+      MiniTest::Unit.output = SilentUntilSyncStream.new(MiniTest::Unit.output)
+    end
+
+    # Runs test files by evaluating each of them.
+    def run
+      @files.each { |filename| load(filename) }
+    end
+
+    # A null stream object which ignores everything until +sync+ has been set
+    # to true. This is only used to silence unnecessary output from MiniTest,
+    # as MiniTest calls +output.sync = true+ right before it outputs the first
+    # test result.
+    class SilentUntilSyncStream < File
+      # Creates a +SilentUntilSyncStream+ object by giving it a target stream
+      # object that will be assigned to +MiniTest::Unit.output+ after +sync+ is
+      # set to true.
+      def initialize(target_stream)
+        @target_stream = target_stream
+        super(File::NULL, 'w')
+      end
+
+      # Swaps +MiniTest::Unit.output+ to another stream when +sync+ is true.
+      def sync=(sync)
+        if sync
+          @target_stream.sync = true
+          MiniTest::Unit.output = @target_stream
+        end
+
+        super
+      end
+    end
+  end
+end
diff --git a/railties/lib/rails/generators/rails/app/templates/test/test_helper.rb b/railties/lib/rails/generators/rails/app/templates/test/test_helper.rb
index 9afda2d0df..ca40914d3b 100644
--- a/railties/lib/rails/generators/rails/app/templates/test/test_helper.rb
+++ b/railties/lib/rails/generators/rails/app/templates/test/test_helper.rb
@@ -1,4 +1,4 @@
-ENV["RAILS_ENV"] = "test"
+ENV["RAILS_ENV"] ||= "test"
 require File.expand_path('../../config/environment', __FILE__)
 require 'rails/test_help'
 
@@ -6,11 +6,12 @@ class ActiveSupport::TestCase
 <% unless options[:skip_active_record] -%>
   ActiveRecord::Migration.check_pending!
 
-  # Setup all fixtures in test/fixtures/*.yml for all tests in alphabetical order.
+  # Uncomment the `fixtures :all` line below to setup all fixtures in test/fixtures/*.yml
+  # for all tests in alphabetical order.
   #
   # Note: You'll currently still have to declare fixtures explicitly in integration tests
   # -- they do not yet inherit this setting
-  fixtures :all
+  # fixtures :all
 
 <% end -%>
   # Add more helper methods to be used by all tests here...
diff --git a/railties/lib/rails/test_unit/testing.rake b/railties/lib/rails/test_unit/testing.rake
index 44485d9b14..de44bf9e4d 100644
--- a/railties/lib/rails/test_unit/testing.rake
+++ b/railties/lib/rails/test_unit/testing.rake
@@ -1,6 +1,7 @@
 require 'rbconfig'
 require 'rake/testtask'
 require 'rails/test_unit/sub_test_task'
+require 'active_support/deprecation'
 
 TEST_CHANGES_SINCE = Time.now - 600
 
@@ -47,7 +48,11 @@ task default: :test
 
 desc 'Runs test:units, test:functionals, test:integration together'
 task :test do
-  Rake::Task[ENV['TEST'] ? 'test:single' : 'test:run'].invoke
+  if ENV['TEST']
+    exec "bundle exec rails test #{ENV['TEST'].inspect}"
+  else
+    exec 'bundle exec rails test'
+  end
 end
 
 namespace :test do
@@ -56,19 +61,8 @@ namespace :test do
   end
 
   task :run do
-    errors = %w(test:units test:functionals test:integration).collect do |task|
-      begin
-        Rake::Task[task].invoke
-        nil
-      rescue => e
-        { task: task, exception: e }
-      end
-    end.compact
-
-    if errors.any?
-      puts errors.map { |e| "Errors running #{e[:task]}! #{e[:exception].inspect}" }.join("\n")
-      abort
-    end
+    ActiveSupport::Deprecation.warn "`rake test:run` is deprecated. Please use `rails test`."
+    exec 'bundle exec rails test'
   end
 
   # Inspired by: http://ngauthier.com/2012/02/quick-tests-with-bash.html
@@ -83,7 +77,13 @@ namespace :test do
     task :db => %w[db:test:prepare test:all]
   end
 
-  Rake::TestTask.new(recent: "test:prepare") do |t|
+  # Display deprecation message
+  task :deprecated do
+    task_name = ARGV.first
+    ActiveSupport::Deprecation.warn "`rake #{ARGV.first}` is deprecated with no replacement."
+  end
+
+  Rake::TestTask.new(recent: ["test:deprecated", "test:prepare"]) do |t|
     since = TEST_CHANGES_SINCE
     touched = FileList['test/**/*_test.rb'].select { |path| File.mtime(path) > since } +
       recent_tests('app/models/**/*.rb', 'test/models', since) +
@@ -94,9 +94,9 @@ namespace :test do
     t.libs << 'test'
     t.test_files = touched.uniq
   end
-  Rake::Task['test:recent'].comment = "Test recent changes"
+  Rake::Task['test:recent'].comment = "Deprecated; Test recent changes"
 
-  Rake::TestTask.new(uncommitted: "test:prepare") do |t|
+  Rake::TestTask.new(uncommitted: ["test:deprecated", "test:prepare"]) do |t|
     def t.file_list
       if File.directory?(".svn")
         changed_since_checkin = silence_stderr { `svn status` }.split.map { |path| path.chomp[7 .. -1] }
@@ -118,44 +118,20 @@ namespace :test do
 
     t.libs << 'test'
   end
-  Rake::Task['test:uncommitted'].comment = "Test changes since last checkin (only Subversion and Git)"
-
-  Rake::TestTask.new(single: "test:prepare") do |t|
-    t.libs << "test"
-  end
-
-  Rails::SubTestTask.new(models: "test:prepare") do |t|
-    t.libs << "test"
-    t.pattern = 'test/models/**/*_test.rb'
-  end
-
-  Rails::SubTestTask.new(helpers: "test:prepare") do |t|
-    t.libs << "test"
-    t.pattern = 'test/helpers/**/*_test.rb'
-  end
+  Rake::Task['test:uncommitted'].comment = "Deprecated; Test changes since last checkin (only Subversion and Git)"
 
-  Rails::SubTestTask.new(units: "test:prepare") do |t|
-    t.libs << "test"
-    t.pattern = 'test/{models,helpers,unit}/**/*_test.rb'
+  desc "Deprecated; Please use `rails test \"#{ENV['TEST']}\"`"
+  task :single do
+    ActiveSupport::Deprecation.warn "`rake test:single` is deprecated. Please use `rails test \"#{ENV['TEST']}\"`."
+    exec "bundle exec rails test #{test_suit_name}"
   end
 
-  Rails::SubTestTask.new(controllers: "test:prepare") do |t|
-    t.libs << "test"
-    t.pattern = 'test/controllers/**/*_test.rb'
-  end
+  [:models, :helpers, :units, :controllers, :functionals, :integration].each do |test_suit_name|
+    desc "Deprecated; Please use `rails test #{test_suit_name}`"
+    task test_suit_name do
+      ActiveSupport::Deprecation.warn "`rake test:#{test_suit_name}` is deprecated. Please use `rails test #{test_suit_name}`."
 
-  Rails::SubTestTask.new(mailers: "test:prepare") do |t|
-    t.libs << "test"
-    t.pattern = 'test/mailers/**/*_test.rb'
-  end
-
-  Rails::SubTestTask.new(functionals: "test:prepare") do |t|
-    t.libs << "test"
-    t.pattern = 'test/{controllers,mailers,functional}/**/*_test.rb'
-  end
-
-  Rails::SubTestTask.new(integration: "test:prepare") do |t|
-    t.libs << "test"
-    t.pattern = 'test/integration/**/*_test.rb'
+      exec "bundle exec rails test #{test_suit_name}"
+    end
   end
 end