Deprecate *_via_redirect integration test methods

[aditya-kapoor]

As asked by @dhh in #18333.
Closes #18333.

[dhh]

In the deprecation, we should just add "Please use follow_redirect! manually after the request call for the same behavior."

[egilburg]

Instead of adding new tests, you can wrap assert_deprecated around existing test assertions. I think this will also prevent the existing tests from spamming deprecation text in the test log.

[aditya-kapoor]

@ddh, @egilburg please review..

[egilburg]

@aditya-kapoor looks OK although usually you'd try reducing assert_deprecated around as little lines as possible.

[rafaelfranca]

The message should be:

get_via_redirect is deprecated and will be removed in the next version of Rails. Please use follow_redirect! manually after the request call for the same behavior.

[rafaelfranca]

Also remove the whitespaces changes in the patch.

[aditya-kapoor]

@rafaelfranca done...

[rafaelfranca]

Merging

[mhartl]

I like to use defined?(post_via_redirect) to define an integration_test? boolean, which works because post_via_redirect isn't defined inside non-integration tests. Now that the *_via_redirect methods are deprecated, does anyone have a suggestion for a replacement?

[dhh]

What are you using the integration_test? check for?

On Jan 30, 2015, at 7:29 PM, Michael Hartl notifications@github.com wrote:

I like to use defined?(post_via_redirect) to define an integration_test? boolean, which works because post_via_redirect isn't defined inside non-integration tests. Now that the *_via_redirect methods are deprecated, does anyone have a suggestion for a replacement?

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

[mhartl]

I define a log_in_as test helper that posts to the Sessions controller if called inside an integration test but manipulates the session object directly otherwise.

[dhh]

Ah, I think maybe having separate helpers when they do separate things is a better deal than multiple paths inside a single method. But curious to see the implementation!

On Jan 30, 2015, at 8:13 PM, Michael Hartl notifications@github.com wrote:

I define a log_in_as test helper that posts to the Sessions controller if called inside an integration test but manipulates the session object directly otherwise.

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

[mhartl]

The log_in_as method is an abstraction layer over the idea of logging in inside a test. If you don't switch on the test type, you need something like log_in_as_integration and log_in_as_non_integration which is rather verbose. The implementation (from the Rails Tutorial sample app's test helper) looks like this:

# Logs in a test user.
def log_in_as(user, options = {})
  password    = options[:password]    || 'password'
  remember_me = options[:remember_me] || '1'
  if integration_test?
    post login_path, session: { email:       user.email,
                                password:    password,
                                remember_me: remember_me }
  else
    session[:user_id] = user.id
  end
end

  private

    # Returns true inside an integration test.
    def integration_test?
      defined?(post_via_redirect)
    end

(Come to think of it, the definitions of password and remember_me should probably be moved into the if branch.) I don't particularly care about post_via_redirect per se, and indeed its use in the integration_test? method is a bit of a kludge, but I do want to have an automatic way of detecting whether the log_in_as method is being invoked inside an integration test. With the deprecation of *_via_redirect, it would be great to have an alternate way of doing that.

[dhh]

These two paths share almost nothing. Not even the signature. I would split them out. Much clearer, imo:

# Logs in a test user.
def log_in_as(user, password: 'password', remember_me: '1')
  post login_path, session: { email:       user.email,
                              password:    password,
                              remember_me: remember_me }
end

def log_in_as(user)
  session[:user_id] = user.id
end

[dhh]

In fact, I would also rename them to follow the intent. The integration helper is legitimately log_in_as but the controller test is more accurately described as logged_in_as, since it sets the state AFTER someone has been logged in – it doesn't perform the login action.

[mhartl]

I appreciate the feedback and will consider incorporating it in future refinements of the tutorial. In the mean time, does anyone have any suggestions for writing an integration_test? method that will still work after the *_via_redirect methods have been removed?

[dhh]

If you don't care about the implementation, you can just do is_a? ActiveSupport::IntegrationTest or whatever it is.

[georgeclaghorn]

Consider separate implementations in the controller and integration test classes:

class ActionDispatch::IntegrationTest
  def log_in_as(user, password: 'password', remember_me: '1')
    post login_path, session: {
      email: user.email,
      password: password,
      remember_me: remember_me
    }
  end
end

class ActionController::TestCase
  def log_in_as(user)
    session[:user_id] = user.id
  end
end

[mhartl]

@georgeclaghorn Cool, thanks for the suggestion.