Module: ActionDispatch::Assertions::ResponseAssertions

Included in:
ActionDispatch::Assertions
Defined in:
lib/action_dispatch/testing/assertions/response.rb

Overview

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

Constant Summary collapse

RESPONSE_PREDICATES =

:nodoc:

{ # :nodoc:
  success:  :successful?,
  missing:  :not_found?,
  redirect: :redirection?,
  error:    :server_error?,
}

Instance Method Summary collapse

Instance Method Details

#assert_redirected_to(url_options = {}, options = {}, message = nil) ⇒ Object

Asserts that the response is a redirect to a URL matching the given options.

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

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

# Asserts that the redirection was to the URL for @customer
assert_redirected_to @customer

# Asserts that the redirection matches the regular expression
assert_redirected_to %r(\Ahttp://example.org)

# Asserts that the redirection has the HTTP status code 301 (Moved
# Permanently).
assert_redirected_to "/some/path", status: :moved_permanently



60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/action_dispatch/testing/assertions/response.rb', line 60

def assert_redirected_to(url_options = {}, options = {}, message = nil)
  options, message = {}, options unless options.is_a?(Hash)

  status = options[:status] || :redirect
  assert_response(status, message)
  return true if url_options === @response.location

  redirect_is       = normalize_argument_to_redirection(@response.location)
  redirect_expected = normalize_argument_to_redirection(url_options)

  message ||= "Expected response to be a redirect to <#{redirect_expected}> but was a redirect to <#{redirect_is}>"
  assert_operator redirect_expected, :===, redirect_is, message
end

#assert_response(type, message = nil) ⇒ Object

Asserts that the response is one of the following types:

  • ‘:success` - Status code was in the 200-299 range

  • ‘: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.

# Asserts that the response was a redirection
assert_response :redirect

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



33
34
35
36
37
38
39
40
41
 
# File 'lib/action_dispatch/testing/assertions/response.rb', line 33

def assert_response(type, message = nil)
  message ||= generate_response_message(type)

  if RESPONSE_PREDICATES.key?(type)
    assert @response.public_send(RESPONSE_PREDICATES[type]), message
  else
    assert_equal AssertionResponse.new(type).code, @response.response_code, message
  end
end