Add system tests to generate scaffold #29418

dinahshi · 2017-06-11T14:02:41Z

generate scaffold currently generates a simple system test. This change
populates the generated system test with index, create, update, and destroy
behaviour. Feature request from @eileencodes

Sample generated test from bin/rails generate scaffold HighScore game:string score:integer:

require "application_system_test_case"

class HighScoresTest < ApplicationSystemTestCase
  setup do
    @high_score = high_scores(:one)
  end

  test "visiting the index" do
    visit high_scores_url
    assert_selector "h1", text: "High Scores"
  end

  test "creating a High score" do
    visit high_scores_url
    click_on "New High Score"

    fill_in "Game", with: @high_score.game
    fill_in "Score", with: @high_score.score
    click_on "Create High score"

    assert_text "High score was successfully created"
    click_on "Back"
  end

  test "updating a High score" do
    visit high_scores_url
    click_on "Edit", match: :first

    fill_in "Game", with: @high_score.game
    fill_in "Score", with: @high_score.score
    click_on "Update High score"

    assert_text "High score was successfully updated"
    click_on "Back"
  end

  test "destroying a High score" do
    visit high_scores_url
    page.accept_confirm do
      click_on "Destroy", match: :first
    end

    assert_text "High score was successfully destroyed"
  end
end

rails-bot · 2017-06-11T14:02:43Z

Thanks for the pull request, and welcome! The Rails team is excited to review your changes, and you should hear from @matthewd (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

This repository is being automatically checked for code quality issues using Code Climate. You can see results for this analysis in the PR status below. Newly introduced issues should be fixed before a Pull Request is considered ready to review.

Please see the contribution instructions for more information.

eileencodes

This is looking really great! I just tried it out and all the tests worked with the scaffold! 😄

I left a few comments for things that need some changes. Thanks for working on this!

eileencodes · 2017-06-11T22:54:31Z

railties/lib/rails/generators/test_unit/scaffold/scaffold_generator.rb

+
+        unless options.api?
+          template "system_test.rb", File.join("test/system", class_path, "#{file_name.pluralize}_test.rb")
+        end


I think this needs to check depends_on_system_test? because some users may want to skip system tests when generating the scaffold.

Looks like this method is defined in Rails::Generators::AppBase. Would it be best to replicate this in TestUnit::Generators::Base or rely on the system_tests option set here?

I think what you wrote is correct. I was thinking of the skip code elsewhere in the generators.

eileencodes · 2017-06-11T22:55:45Z

railties/lib/rails/generators/test_unit/scaffold/scaffold_generator.rb

+            ["#{name}", "@#{singular_table_name}.#{name}"]
+          end
+        end.sort.to_h
+      end


The rubocop build is failing for these because the methods should be indented 2 spaces under private and there should be a space after the bracket here {|k, v| "#{k}: #{v}"}.join(", ").

eileencodes · 2017-06-11T22:56:03Z

railties/lib/rails/generators/test_unit/scaffold/templates/api_functional_test.rb

@@ -29,7 +29,7 @@ class <%= controller_class_name %>ControllerTest < ActionDispatch::IntegrationTe
  end

  test "should update <%= singular_table_name %>" do
-    patch <%= show_helper %>, params: { <%= "#{singular_table_name}: { #{attributes_hash} }" %> }, as: :json
+    patch <%= show_helper %>, params: { <%= "#{singular_table_name}: { #{attributes_string} }" %> }, as: :json


Why did these need to change?

attributes_hash formerly referred to a string representation of the attributes (i.e. "{key: value}"). I needed a real ruby hash to iterate over so I named that method attributes_hash and renamed this to reflect its type.

Cool thanks for the explanation!

dinahshi · 2017-06-30T01:05:47Z

railties/lib/rails/generators/rails/scaffold/scaffold_generator.rb

@@ -16,13 +16,10 @@ class ScaffoldGenerator < ResourceGenerator # :nodoc:
      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]


I swapped this out for @options = @options.merge(system_tests: nil) if options[:api] and it still wasn't available in the options hash in railties/lib/rails/generators/test_unit/scaffold/scaffold_generator.rb so I left the options.api? check in. I'm not sure what the purpose of this line is.

eileencodes · 2017-06-30T12:49:04Z

Awesome work @dinahshi! Can you squash your commits into 1 and then I'll merge? Thanks so much for working on this.

eileencodes

There's one issue when we're skipping system tests on the scaffold generator. There's a missing test case since all the tests are passing.

eileencodes · 2017-06-30T12:54:55Z

railties/lib/rails/generators/test_unit/scaffold/scaffold_generator.rb

+
+        unless options.api? || options[:system_tests].nil?
+          template "system_test.rb", File.join("test/system", class_path, "#{file_name.pluralize}_test.rb")
+        end


I just tested this and there's a missing test case. This doesn't work for generating a scaffold and passing the skip system test option.

bin/rails g scaffold Tree title:string --skip-system-test

In that case the system test file would still be generated because we're not checking at all for the skip-system-test option which is why I ended up changing the config file in the other PR. Because then otherwise we end up checking for 2 options for skipping system tests.

I tried this on master and it's not currently supported. bin/rails g scaffold Tree title:string --skip-test also doesn't skip any tests (including model, controller, and system tests). As a result I think adding command line options to non-application generate commands is likely a larger task and should be separate from this change.

You're right, it's not supported on master. I think this PR is fine then and if we want to implement --skip-system-test for scaffold we can do that in a separate PR.

rails-bot assigned matthewd Jun 11, 2017

eileencodes assigned eileencodes and unassigned matthewd Jun 11, 2017

eileencodes added the actionpack label Jun 11, 2017

eileencodes requested changes Jun 11, 2017

View reviewed changes

eileencodes mentioned this pull request Jun 23, 2017

Fix system test generator option to be consistent #29550

Closed

dinahshi commented Jun 30, 2017

View reviewed changes

eileencodes approved these changes Jun 30, 2017

View reviewed changes

eileencodes requested changes Jun 30, 2017

View reviewed changes

Add system tests to generate scaffold

d502cd1

dinahshi force-pushed the scaffold_system_tests branch from efd260f to d502cd1 Compare June 30, 2017 13:40

eileencodes approved these changes Jun 30, 2017

View reviewed changes

eileencodes merged commit 6671340 into rails:master Jun 30, 2017

dinahshi deleted the scaffold_system_tests branch January 24, 2018 23:51

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add system tests to generate scaffold #29418

Add system tests to generate scaffold #29418

dinahshi commented Jun 11, 2017 •

edited

rails-bot commented Jun 11, 2017

eileencodes left a comment

eileencodes Jun 11, 2017

dinahshi Jun 12, 2017

eileencodes Jun 19, 2017

eileencodes Jun 11, 2017

eileencodes Jun 11, 2017

dinahshi Jun 12, 2017

eileencodes Jun 16, 2017

dinahshi Jun 30, 2017

eileencodes commented Jun 30, 2017

eileencodes left a comment

eileencodes Jun 30, 2017

dinahshi Jun 30, 2017

eileencodes Jun 30, 2017

Add system tests to generate scaffold #29418

Add system tests to generate scaffold #29418

Conversation

dinahshi commented Jun 11, 2017 • edited

rails-bot commented Jun 11, 2017

eileencodes left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eileencodes commented Jun 30, 2017

eileencodes left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dinahshi commented Jun 11, 2017 •

edited