Use kwargs in ActionController::TestCase and ActionDispatch::Integration HTTP methods #18323

kirs · 2015-01-04T09:38:00Z

As @dhh suggested, controller HTTP methods are a prime candidate for kwargs.
post url, nil, nil, { a: 'b' } doesn't make sense.
More explicit way would be: post url, params: { y: x }, session: { a: 'b' }.

rafaelfranca · 2015-01-04T14:05:32Z

actionpack/lib/action_controller/test_case.rb

+          session =    args[0][:session]
+          flash =      args[0][:flash]
+        else
+          parameters, session, flash = args


We should deprecate this path or we will not be able to use kwargs for real here in the future.

Since we are deprecating all documentation and tests should use the kwarg implementation and we can remove the old implementation from the documentation keeping only a few tests to make sure it works and it is deprecated.

Good point, thanks.

Here is rdoc syntax for usual arguments:

- +action+: The controller action to call. - +http_method+: Request method used to send the http request. Possible values are +GET+, +POST+, +PATCH+, +PUT+, +DELETE+, +HEAD+. Defaults to +GET+. - +parameters+: The HTTP parameters. This may be +nil+, a hash, or a string that is appropriately encoded (+application/x-www-form-urlencoded+ or +multipart/form-data+). - +session+: A hash of parameters to store in the session. This may be +nil+. - +flash+: A hash of parameters to store in the flash. This may be +nil+.

Any suggestions how it will look like with kwargs? Couldn't find it in docs.

New form should be:

process action, method: 'GET', params: {}, session: {}, flash: {}

And then we add on with:

post/get/put/patch/delete/head action, params: {}, session: {}, flash: {}

Got it. I meant the rdoc syntax for describing kwargs

dhh · 2015-01-04T17:02:30Z

We should do the same treatment to ActionDispatch::IntegrationTest.

kirs · 2015-01-04T17:04:12Z

@dhh in the same PR or in the separate?

rafaelfranca · 2015-01-04T17:04:39Z

In the same

On Sun, Jan 4, 2015, 15:04 Kir Shatrov notifications@github.com wrote:

@dhh https://github.com/dhh in the same PR or in the separate?

—
Reply to this email directly or view it on GitHub
#18323 (comment).

dhh · 2015-01-04T17:06:10Z

We can do a separate PR for that. Just that we don’t want the two APIs to diverge in a release.

On Jan 4, 2015, at 9:04 AM, Kir Shatrov notifications@github.com wrote:

@dhh https://github.com/dhh in the same PR or in the separate?

—
Reply to this email directly or view it on GitHub #18323 (comment).

dhh · 2015-01-04T17:08:17Z

Ha, I don't really care if it's the same or separate. But yeah, @rafaelfranca is probably right that we might as well treat it as one change. Since it's the same API. Although IntegrationTests also have env.

rafaelfranca · 2015-01-04T17:28:25Z

Yeah, they can be different commits but I'd like to have the whole set of
changes grouped so we can link is release notes or even revert if needed.

On Sun, Jan 4, 2015, 15:08 David Heinemeier Hansson <
notifications@github.com> wrote:

Ha, I don't really care if it's the same or separate. But yeah,
@rafaelfranca https://github.com/rafaelfranca is probably right that we
might as well treat it as one change. Since it's the same API. Although
IntegrationTests also have env.

—
Reply to this email directly or view it on GitHub
#18323 (comment).

kirs · 2015-01-19T17:52:21Z

@rafaelfranca @dhh done

dhh · 2015-01-19T18:07:21Z

actionpack/test/controller/integration_test.rb

-    end
-  end
-end
+# class MetalIntegrationTest < ActionDispatch::IntegrationTest


Why is this test commented out?

rafaelfranca · 2015-01-20T18:35:30Z

Should we update the testing guide?

kirs · 2015-01-20T19:12:20Z

@rafaelfranca TODO is fixed, thanks! I will update the guide soon.

kirs · 2015-01-20T20:11:38Z

@rafaelfranca guide updated.

rafaelfranca · 2015-01-20T20:31:30Z

actionpack/lib/action_controller/test_case.rb

-      #   be +nil+, a hash, or a string that is appropriately encoded
+      # - action: The controller action to call.
+      # - params: The hash with HTTP parameters that you want to pass. This may be +nil+.
+      # - body: The request body with a string that is appropriately encoded
      #   (<tt>application/x-www-form-urlencoded</tt> or <tt>multipart/form-data</tt>).
      # - +session+: A hash of parameters to store in the session. This may be +nil+.


If we removed the fixed size of fonts of the other arguments we should do the same with session and flash.

But I really not sure if we should remove it @fxn?

What do you mean under "fixed size of fonts"?

The +action+ over action.

Yep, we should keep it.

@kirs when you refer to variables, keyword arguments, etc. you use fixed-width font for them. That is assigns, rather than just assigns. Have a look at the API guidelines.

Thanks for review and explanation, I will fix it.

kirs · 2015-01-24T17:34:05Z

@rafaelfranca I added the CHANGELOG entry. Ready for merge?

robin850 · 2015-01-25T11:06:05Z

actionpack/lib/action_controller/test_case.rb

@@ -491,58 +491,64 @@ def determine_default_controller_class(name)
        end
      end

-      # Simulate a GET request with the given parameters.
+      # Simulate a GET request with the given keyword arguments.


"parameters" is maybe a better fit here ; "keyword arguments" is more an implementation detail and we are still passing the action as a normal parameter, not as a keyword argument. What do you think ?

robin850 · 2015-01-25T11:48:30Z

Awesome work @kirs !

There's just a tiny missing change here to avoid displaying a deprecation warning running the test suite. Also, regarding deprecation warnings, you may want to use strip_heredoc instead of squish to keep the formatting. At the moment, it displays like this:

DEPRECATION WARNING: ActionDispatch::Integration::TestCase HTTP request methods will accept only keyword arguments in future Rails versions. Examples: get '/profile', params: { id: 1 }, headers: { 'X-Extra-Header' => '123' }, env: { 'action_dispatch.custom' => 'custom' } xhr :post, '/profile', params: { id: 1 }. (called from block (3 levels) in run at ...).

But well, that's just styling concerns, there's no big deal. Thank you !

connorshea · 2016-07-20T21:39:54Z

Anyone having trouble with this change specifically may want to take a look at the rails5-spec-converter gem

hakanai · 2016-08-02T01:19:14Z

This warning was awfully hard to understand because by reading my code, it seemed like my params were already "keyword arguments". Now I understand that what it really means for all of my usages is that params can no longer be passed bare anymore.

aaronrussell · 2016-08-02T19:33:59Z

Is there a way of writing ActionController::TestCase tests that will pass in both Rails 5 and 4.2? (for rails engines that need to run in both)

connorshea · 2016-08-02T19:37:07Z

@aaronrussell they'll still pass in both, but will print deprecation warnings on 5.

Prevent hitting integration tests users with two deprecation warnings by clarifying how they should upgrade to the request helpers `get` and friends. It's hard to imagine people having `xhr` calls that use keywords, why not follow the xhr deprecation message? Why instead insert a middle layer of migration? They have to switch to something else anyway, so just show how that looks and nudge them a bit more. The code was originally added in #18323, but then wasn't touched when deprecating xhr in #18771.

@rosmith76

rails/rails#18323 Changes code like: * get :show, params.merge(format: :atom) * get(path, {}, headers) to * get :show, params: params.merge(format: :atom) * get(path, params: {}, headers: headers) Thanks to @rosmith76 and @asackofwheat

Adds both `html` and `js` responses allowing the editting/updating of `first_name`, `last_name`, & `location` on a users profile. Introduces the `profile.edit` & `profile.edit.others` permissions. Removes the `Rail/HttpPositionalArguments` Cop from `rubocop`, this is due to the fact that we're using `rails-4.2.7.1` and that cop is intended to catch behaviour that was deprecated in this [PR](rails/rails#18323) however that deprecation does not affect our current `rails` version.

rails/rails#18323

…ests#676 - update jsonapi initializer and corresponding JSON response keys - add rails-controller-testing gem to support 'assert_template' and 'assigns' - see rspec/rspec-rails#1393 - update controller tests as Rails5 only accepts keyword arguments - see rails/rails#18323

Rails 5 introduces a breaking change to request helpers synopsis. Unfortunately, the modern way doesn't work in Rails 4, so we need to choose between old and new helpers depending on Rails version. See: - rails/rails#18323 - https://blog.bigbinary.com/2016/04/19/changes-to-test-controllers-in-rails-5.html

- Use kwargs in HTTP request methods in rspec See: rails/rails#18323

- rails/rails@4414c5d - rails/rails#18323

kirs mentioned this pull request Jan 4, 2015

Publish the Rails Testing Guide #18305

Closed

rafaelfranca reviewed Jan 4, 2015
View reviewed changes

rafaelfranca added the actionpack label Jan 4, 2015

kirs changed the title ~~Use kwargs in ActionController::TestCase HTTP methods~~ Use kwargs in ActionController::TestCase and ActionDispatch::Integration HTTP methods Jan 19, 2015

dhh reviewed Jan 19, 2015
View reviewed changes

rafaelfranca reviewed Jan 20, 2015
View reviewed changes

robin850 reviewed Jan 25, 2015
View reviewed changes

connorshea mentioned this pull request Jul 20, 2016

Rails 5 helpyio/helpy#224

Open

prathamesh-sonpatki mentioned this pull request Aug 17, 2016

put :update with String no longer sets RAW_POST_DATA #26194

Closed

CGA1123 mentioned this pull request Nov 28, 2016

Add basic edit/update functionality to Profiles CGA1123/F29SO#43

Merged

mrageh mentioned this pull request Feb 5, 2017

Use keyword args for HTTP methods in controller specs only on Rails 5 rspec/rspec-rails#1710

Merged

fragoulis added a commit to skroutz/cogy that referenced this pull request May 30, 2017

Specify params explicitely in controller specs

c53ead8

rails/rails#18323

fragoulis added a commit to skroutz/cogy that referenced this pull request May 30, 2017

Specify params explicitely in controller specs

6f85a82

rails/rails#18323

fragoulis added a commit to skroutz/cogy that referenced this pull request May 30, 2017

Specify params explicitely in controller specs

793d2b3

rails/rails#18323

fragoulis added a commit to skroutz/cogy that referenced this pull request May 30, 2017

Specify params explicitely in controller specs

bf7df0b

rails/rails#18323

fragoulis added a commit to skroutz/cogy that referenced this pull request May 31, 2017

Specify params explicitely in controller specs

2266cf4

rails/rails#18323

fragoulis added a commit to skroutz/cogy that referenced this pull request May 31, 2017

Specify params explicitely in controller specs

572ed16

rails/rails#18323

fragoulis added a commit to skroutz/cogy that referenced this pull request May 31, 2017

Specify params explicitely in controller specs

d9be4fc

rails/rails#18323

jwilsjustin mentioned this pull request Aug 18, 2017

Request Specs throw a deprecation warning with Rails 5 rspec/rspec-rails#1515

Closed

mklemme mentioned this pull request Jan 31, 2018

Scaffold generator generates gets error on rails4. rspec/rspec-rails#1679

Closed

GabrielSandoval pushed a commit to GabrielSandoval/asyncapi-server that referenced this pull request Mar 13, 2018

Make gem Rails 5 compatible

dda41cb

- Use kwargs in HTTP request methods in rspec See: rails/rails#18323

GabrielSandoval pushed a commit to GabrielSandoval/asyncapi-server that referenced this pull request Mar 14, 2018

Make gem Rails 5 compatible

22df431

- Use kwargs in HTTP request methods in rspec See: rails/rails#18323

GabrielSandoval mentioned this pull request Mar 14, 2018

Add Rails 5 compatible version G5/asyncapi-server#10

Merged

waiting-for-dev mentioned this pull request Mar 14, 2018

Adding additional test helpers to streamline testing flow waiting-for-dev/devise-jwt#77

Closed

kimmy mentioned this pull request Nov 27, 2018

Add Rails 5 compatible version G5/asyncapi-server#11

Merged

falusi94 added a commit to kir-dev/pek-next that referenced this pull request Aug 26, 2019

Fix tests [skip ci]

3365544

- rails/rails@4414c5d - rails/rails#18323

falusi94 added a commit to kir-dev/pek-next that referenced this pull request Oct 29, 2019

Fix tests [skip ci]

5bf40d4

- rails/rails@4414c5d - rails/rails#18323

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Use kwargs in ActionController::TestCase and ActionDispatch::Integration HTTP methods #18323

Use kwargs in ActionController::TestCase and ActionDispatch::Integration HTTP methods #18323

kirs commented Jan 4, 2015

rafaelfranca Jan 4, 2015

rafaelfranca Jan 4, 2015

kirs Jan 7, 2015

dhh Jan 7, 2015

kirs Jan 7, 2015

dhh commented Jan 4, 2015

kirs commented Jan 4, 2015

rafaelfranca commented Jan 4, 2015

dhh commented Jan 4, 2015

dhh commented Jan 4, 2015

rafaelfranca commented Jan 4, 2015

kirs commented Jan 19, 2015

dhh Jan 19, 2015

rafaelfranca commented Jan 20, 2015

kirs commented Jan 20, 2015

kirs commented Jan 20, 2015

rafaelfranca Jan 20, 2015

rafaelfranca Jan 20, 2015

kirs Jan 21, 2015

rafaelfranca Jan 21, 2015

fxn Jan 21, 2015

fxn Jan 21, 2015

kirs Jan 21, 2015

kirs commented Jan 24, 2015

robin850 Jan 25, 2015

robin850 commented Jan 25, 2015

connorshea commented Jul 20, 2016

hakanai commented Aug 2, 2016

aaronrussell commented Aug 2, 2016

connorshea commented Aug 2, 2016

Use kwargs in ActionController::TestCase and ActionDispatch::Integration HTTP methods #18323

Use kwargs in ActionController::TestCase and ActionDispatch::Integration HTTP methods #18323

Conversation

kirs commented Jan 4, 2015

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

dhh commented Jan 4, 2015

kirs commented Jan 4, 2015

rafaelfranca commented Jan 4, 2015

dhh commented Jan 4, 2015

dhh commented Jan 4, 2015

rafaelfranca commented Jan 4, 2015

kirs commented Jan 19, 2015

Choose a reason for hiding this comment

rafaelfranca commented Jan 20, 2015

kirs commented Jan 20, 2015

kirs commented Jan 20, 2015

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

kirs commented Jan 24, 2015

Choose a reason for hiding this comment

robin850 commented Jan 25, 2015

connorshea commented Jul 20, 2016

hakanai commented Aug 2, 2016

aaronrussell commented Aug 2, 2016

connorshea commented Aug 2, 2016