Module: ActionDispatch::Assertions::ResponseAssertions

Extended by:
ActiveSupport::Concern
Included in:
ActionDispatch::Assertions
Defined in:
actionpack/lib/action_dispatch/testing/assertions/response.rb

Overview

A small suite of assertions that test responses from Rails applications.

Instance Method Summary (collapse)

Methods included from ActiveSupport::Concern

append_features, extended, included

Instance Method Details

- (Object) assert_redirected_to(options = {}, message = nil)

Assert that the redirection options passed in match those of the redirect called in the latest action. This match can be partial, such that assert_redirected_to(:controller => "weblog") will also match the redirection of redirect_to(:controller => "weblog", :action => "show") and so on.

Examples

# assert that the redirection was to the "index" action on the WeblogController
assert_redirected_to :controller => "weblog", :action => "index"

# assert that the redirection was to the named route login_url
assert_redirected_to 

# assert that the redirection was to the url for @customer
assert_redirected_to @customer


57
58
59
60
61
62
63
64
65
66
67
68
69
# File 'actionpack/lib/action_dispatch/testing/assertions/response.rb', line 57

def assert_redirected_to(options = {}, message=nil)
  validate_request!

  assert_response(:redirect, message)
  return true if options == @response.location

  redirected_to_after_normalisation = normalize_argument_to_redirection(@response.location)
  options_after_normalisation       = normalize_argument_to_redirection(options)

  if redirected_to_after_normalisation != options_after_normalisation
    flunk "Expected response to be a redirect to <#{options_after_normalisation}> but was a redirect to <#{redirected_to_after_normalisation}>"
  end
end

- (Object) assert_response(type, message = nil)

Asserts that the response is one of the following types:

  • :success - Status code was 200

  • :redirect - Status code was in the 300-399 range

  • :missing - Status code was 404

  • :error - Status code was in the 500-599 range

You can also pass an explicit status number like assert_response(501) or its symbolic equivalent assert_response(:not_implemented). See Rack::Utils::SYMBOL_TO_STATUS_CODE for a full list.

Examples

# assert that the response was a redirection
assert_response :redirect

# assert that the response code was status code 401 (unauthorized)
assert_response 401


28
29
30
31
32
33
34
35
36
37
38
39
40
# File 'actionpack/lib/action_dispatch/testing/assertions/response.rb', line 28

def assert_response(type, message = nil)
  validate_request!

  if type.in?([:success, :missing, :redirect, :error]) && @response.send("#{type}?")
    assert_block("") { true } # to count the assertion
  elsif type.is_a?(Fixnum) && @response.response_code == type
    assert_block("") { true } # to count the assertion
  elsif type.is_a?(Symbol) && @response.response_code == Rack::Utils::SYMBOL_TO_STATUS_CODE[type]
    assert_block("") { true } # to count the assertion
  else
    flunk(build_message(message, "Expected response to be a <?>, but was <?>", type, @response.response_code))
  end
end