Merge pull request #26703 from eileencodes/rails_system_tests

WIP: Capybara Integration with Rails (AKA System Tests)

19 files changed, 134 insertions, 1 deletions

diff --git a/railties/lib/rails/generators.rb b/railties/lib/rails/generators.rb
index 99bda728ee..85f66cc416 100644
--- a/railties/lib/rails/generators.rb
+++ b/railties/lib/rails/generators.rb
@@ -62,6 +62,7 @@ module Rails
         stylesheets: true,
         stylesheet_engine: :css,
         scaffold_stylesheet: true,
+        system_tests: nil,
         test_framework: false,
         template_engine: :erb
       }
@@ -151,6 +152,7 @@ module Rails
             "#{test}:controller",
             "#{test}:helper",
             "#{test}:integration",
+            "#{test}:system",
             "#{test}:mailer",
             "#{test}:model",
             "#{test}:scaffold",
diff --git a/railties/lib/rails/generators/app_base.rb b/railties/lib/rails/generators/app_base.rb
index ea88afe9f4..e55da93f45 100644
--- a/railties/lib/rails/generators/app_base.rb
+++ b/railties/lib/rails/generators/app_base.rb
@@ -82,6 +82,9 @@ module Rails
         class_option :skip_test,          type: :boolean, aliases: "-T", default: false,
                                           desc: "Skip test files"
 
+        class_option :skip_system_test,   type: :boolean, default: false,
+                                          desc: "Skip system test files"
+
         class_option :dev,                type: :boolean, default: false,
                                           desc: "Setup the #{name} with Gemfile pointing to your Rails checkout"
 
diff --git a/railties/lib/rails/generators/rails/app/app_generator.rb b/railties/lib/rails/generators/rails/app/app_generator.rb
index 3cf923faf0..18e48c8016 100644
--- a/railties/lib/rails/generators/rails/app/app_generator.rb
+++ b/railties/lib/rails/generators/rails/app/app_generator.rb
@@ -150,6 +150,12 @@ module Rails
       template "test/test_helper.rb"
     end
 
+    def system_test
+      empty_directory_with_keep_file "test/system"
+
+      template "test/application_system_test_case.rb"
+    end
+
     def tmp
       empty_directory_with_keep_file "tmp"
       empty_directory "tmp/cache"
@@ -262,6 +268,10 @@ module Rails
         build(:test) unless options[:skip_test]
       end
 
+      def create_system_test_files
+        build(:system_test) unless options[:skip_system_test] || options[:skip_test] || options[:api]
+      end
+
       def create_tmp_files
         build(:tmp)
       end
diff --git a/railties/lib/rails/generators/rails/app/templates/Gemfile b/railties/lib/rails/generators/rails/app/templates/Gemfile
index 24d2fa1284..b082d70cba 100644
--- a/railties/lib/rails/generators/rails/app/templates/Gemfile
+++ b/railties/lib/rails/generators/rails/app/templates/Gemfile
@@ -32,6 +32,11 @@ end
 group :development, :test do
   # Call 'byebug' anywhere in the code to stop execution and get a debugger console
   gem 'byebug', platforms: [:mri, :mingw, :x64_mingw]
+  <%- unless options.skip_system_test? || options.api? -%>
+  # Adds support for Capybara system testing and selenium driver
+  gem 'capybara', '~> 2.7.0'
+  gem 'selenium-webdriver'
+  <%- end -%>
 end
 
 group :development do
diff --git a/railties/lib/rails/generators/rails/app/templates/test/application_system_test_case.rb b/railties/lib/rails/generators/rails/app/templates/test/application_system_test_case.rb
new file mode 100644
index 0000000000..d19212abd5
--- /dev/null
+++ b/railties/lib/rails/generators/rails/app/templates/test/application_system_test_case.rb
@@ -0,0 +1,5 @@
+require "test_helper"
+
+class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
+  driven_by :selenium, using: :chrome, screen_size: [1400, 1400]
+end
diff --git a/railties/lib/rails/generators/rails/plugin/templates/test/application_system_test_case.rb b/railties/lib/rails/generators/rails/plugin/templates/test/application_system_test_case.rb
new file mode 100644
index 0000000000..d19212abd5
--- /dev/null
+++ b/railties/lib/rails/generators/rails/plugin/templates/test/application_system_test_case.rb
@@ -0,0 +1,5 @@
+require "test_helper"
+
+class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
+  driven_by :selenium, using: :chrome, screen_size: [1400, 1400]
+end
diff --git a/railties/lib/rails/generators/rails/scaffold/scaffold_generator.rb b/railties/lib/rails/generators/rails/scaffold/scaffold_generator.rb
index ed6bf7f7d7..12d6bc85b2 100644
--- a/railties/lib/rails/generators/rails/scaffold/scaffold_generator.rb
+++ b/railties/lib/rails/generators/rails/scaffold/scaffold_generator.rb
@@ -6,6 +6,7 @@ module Rails
       remove_hook_for :resource_controller
       remove_class_option :actions
 
+      class_option :api, type: :boolean
       class_option :stylesheets, type: :boolean, desc: "Generate Stylesheets"
       class_option :stylesheet_engine, desc: "Engine for Stylesheets"
       class_option :assets, type: :boolean
@@ -15,10 +16,13 @@ module Rails
       def handle_skip
         @options = @options.merge(stylesheets: false) unless options[:assets]
         @options = @options.merge(stylesheet_engine: false) unless options[:stylesheets] && options[:scaffold_stylesheet]
+        @options = @options.merge(system_tests: false) if options[:api]
       end
 
       hook_for :scaffold_controller, required: true
 
+      hook_for :system_tests, as: :system
+
       hook_for :assets do |assets|
         invoke assets, [controller_name]
       end
diff --git a/railties/lib/rails/generators/rails/system_test/USAGE b/railties/lib/rails/generators/rails/system_test/USAGE
new file mode 100644
index 0000000000..f11a99e008
--- /dev/null
+++ b/railties/lib/rails/generators/rails/system_test/USAGE
@@ -0,0 +1,10 @@
+Description:
+    Stubs out a new system test. Pass the name of the test, either
+    CamelCased or under_scored, as an argument.
+
+    This generator invokes the current system tool, which defaults to
+    TestUnit.
+
+Example:
+    `rails generate system_test GeneralStories` creates a GeneralStories
+    system test in test/system/general_stories_test.rb
diff --git a/railties/lib/rails/generators/rails/system_test/system_test_generator.rb b/railties/lib/rails/generators/rails/system_test/system_test_generator.rb
new file mode 100644
index 0000000000..901120e892
--- /dev/null
+++ b/railties/lib/rails/generators/rails/system_test/system_test_generator.rb
@@ -0,0 +1,7 @@
+module Rails
+  module Generators
+    class SystemTestGenerator < NamedBase # :nodoc:
+      hook_for :system_tests, as: :system
+    end
+  end
+end
diff --git a/railties/lib/rails/generators/test_unit/system/system_generator.rb b/railties/lib/rails/generators/test_unit/system/system_generator.rb
new file mode 100644
index 0000000000..aec415a4e5
--- /dev/null
+++ b/railties/lib/rails/generators/test_unit/system/system_generator.rb
@@ -0,0 +1,17 @@
+require "rails/generators/test_unit"
+
+module TestUnit # :nodoc:
+  module Generators # :nodoc:
+    class SystemGenerator < Base # :nodoc:
+      check_class_collision suffix: "Test"
+
+      def create_test_files
+        if !File.exist?(File.join("test/application_system_test_case.rb"))
+          template "application_system_test_case.rb", File.join("test", "application_system_test_case.rb")
+        end
+
+        template "system_test.rb", File.join("test/system", "#{file_name.pluralize}_test.rb")
+      end
+    end
+  end
+end
diff --git a/railties/lib/rails/generators/test_unit/system/templates/application_system_test_case.rb b/railties/lib/rails/generators/test_unit/system/templates/application_system_test_case.rb
new file mode 100644
index 0000000000..d19212abd5
--- /dev/null
+++ b/railties/lib/rails/generators/test_unit/system/templates/application_system_test_case.rb
@@ -0,0 +1,5 @@
+require "test_helper"
+
+class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
+  driven_by :selenium, using: :chrome, screen_size: [1400, 1400]
+end
diff --git a/railties/lib/rails/generators/test_unit/system/templates/system_test.rb b/railties/lib/rails/generators/test_unit/system/templates/system_test.rb
new file mode 100644
index 0000000000..b5ce2ba5c8
--- /dev/null
+++ b/railties/lib/rails/generators/test_unit/system/templates/system_test.rb
@@ -0,0 +1,9 @@
+require "application_system_test_case"
+
+class <%= class_name.pluralize %>Test < ApplicationSystemTestCase
+  # test "visiting the index" do
+  #   visit <%= plural_table_name %>_url
+  #
+  #   assert_selector "h1", text: "<%= class_name %>"
+  # end
+end
diff --git a/railties/lib/rails/tasks/statistics.rake b/railties/lib/rails/tasks/statistics.rake
index ba1697186e..cb569be58b 100644
--- a/railties/lib/rails/tasks/statistics.rake
+++ b/railties/lib/rails/tasks/statistics.rake
@@ -17,6 +17,7 @@ STATS_DIRECTORIES = [
   %w(Mailer\ tests      test/mailers),
   %w(Job\ tests         test/jobs),
   %w(Integration\ tests test/integration),
+  %w(System\ tests      test/system),
 ].collect do |name, dir|
   [ name, "#{File.dirname(Rake.application.rakefile_location)}/#{dir}" ]
 end.select { |name, dir| File.directory?(dir) }
diff --git a/railties/lib/rails/test_help.rb b/railties/lib/rails/test_help.rb
index 0f9bf98737..75171f2395 100644
--- a/railties/lib/rails/test_help.rb
+++ b/railties/lib/rails/test_help.rb
@@ -7,6 +7,7 @@ require "active_support/test_case"
 require "action_controller"
 require "action_controller/test_case"
 require "action_dispatch/testing/integration"
+require "action_dispatch/system_test_case"
 require "rails/generators/test_case"
 
 require "active_support/testing/autorun"
@@ -44,3 +45,10 @@ class ActionDispatch::IntegrationTest
     super
   end
 end
+
+class ActionDispatch::SystemTestCase
+  def before_setup # :nodoc:
+    @routes = Rails.application.routes
+    super
+  end
+end
diff --git a/railties/lib/rails/test_unit/railtie.rb b/railties/lib/rails/test_unit/railtie.rb
index 746120e6a1..9cc3f73a9c 100644
--- a/railties/lib/rails/test_unit/railtie.rb
+++ b/railties/lib/rails/test_unit/railtie.rb
@@ -11,6 +11,7 @@ module Rails
                                    fixture_replacement: nil
 
       c.integration_tool :test_unit
+      c.system_tests :test_unit
     end
 
     initializer "test_unit.line_filtering" do
diff --git a/railties/lib/rails/test_unit/testing.rake b/railties/lib/rails/test_unit/testing.rake
index 4c157c1262..4dde3d3c97 100644
--- a/railties/lib/rails/test_unit/testing.rake
+++ b/railties/lib/rails/test_unit/testing.rake
@@ -47,4 +47,9 @@ namespace :test do
     $: << "test"
     Minitest.rake_run(["test/controllers", "test/mailers", "test/functional"])
   end
+
+  task system: "test:prepare" do
+    $: << "test"
+    Minitest.rake_run(["test/system"])
+  end
 end
diff --git a/railties/test/generators/app_generator_test.rb b/railties/test/generators/app_generator_test.rb
index ce29d93d6e..687aed2c47 100644
--- a/railties/test/generators/app_generator_test.rb
+++ b/railties/test/generators/app_generator_test.rb
@@ -42,6 +42,7 @@ DEFAULT_APP_FILES = %w(
   test/helpers
   test/mailers
   test/integration
+  test/system
   vendor
   tmp
   tmp/cache
@@ -805,8 +806,26 @@ class AppGeneratorTest < Rails::Generators::TestCase
     assert_equal 4, @sequence_step
   end
 
-  private
+  def test_system_tests_directory_generated
+    run_generator
+
+    assert_file("test/system/.keep")
+    assert_directory("test/system")
+  end
+
+  def test_system_tests_are_not_generated_on_system_test_skip
+    run_generator [destination_root, "--skip-system-test"]
+
+    assert_no_directory("test/system")
+  end
+
+  def test_system_tests_are_not_generated_on_test_skip
+    run_generator [destination_root, "--skip-test"]
 
+    assert_no_directory("test/system")
+  end
+
+  private
     def stub_rails_application(root)
       Rails.application.config.root = root
       Rails.application.class.stub(:name, "Myapp") do
diff --git a/railties/test/generators/scaffold_generator_test.rb b/railties/test/generators/scaffold_generator_test.rb
index e2b2acab0f..436fbd5d73 100644
--- a/railties/test/generators/scaffold_generator_test.rb
+++ b/railties/test/generators/scaffold_generator_test.rb
@@ -62,6 +62,11 @@ class ScaffoldGeneratorTest < Rails::Generators::TestCase
       assert_match(/patch product_line_url\(@product_line\), params: \{ product_line: \{ product_id: @product_line\.product_id, title: @product_line\.title, user_id: @product_line\.user_id \} \}/, test)
     end
 
+    # System tests
+    assert_file "test/system/product_lines_test.rb" do |test|
+      assert_match(/class ProductLinesTest < ApplicationSystemTestCase/, test)
+    end
+
     # Views
     assert_no_file "app/views/layouts/product_lines.html.erb"
 
diff --git a/railties/test/generators/system_test_generator_test.rb b/railties/test/generators/system_test_generator_test.rb
new file mode 100644
index 0000000000..e8e561ec49
--- /dev/null
+++ b/railties/test/generators/system_test_generator_test.rb
@@ -0,0 +1,12 @@
+require "generators/generators_test_helper"
+require "rails/generators/rails/system_test/system_test_generator"
+
+class SystemTestGeneratorTest < Rails::Generators::TestCase
+  include GeneratorsTestHelper
+  arguments %w(user)
+
+  def test_system_test_skeleton_is_created
+    run_generator
+    assert_file "test/system/users_test.rb", /class UsersTest < ApplicationSystemTestCase/
+  end
+end