class ActionView::TestCase

Public Instance Methods

assert_difference(expression, difference = 1, message = nil, &block) click to toggle source

Checks the numeric difference between the return value of an expression as a result of what is evaluated.

assert_difference "User.count", +1 do
  User.create
end

See also Minitest::Rails::Expectations#must_change

# File lib/minitest/rails/assertions/action_view.rb, line 14
  
assert_dom_equal(expected, actual, message = nil) click to toggle source

Checks that two HTML strings are equivalent. That they contain the same elements and attributes with the associated values.

assert_dom_equal '<a href="http://www.example.com">Apples</a>',
                 link_to("Apples", "http://www.example.com")

See also Minitest::Rails::Expectations#must_dom_equal

# File lib/minitest/rails/assertions/action_view.rb, line 334
  
assert_dom_not_equal(expected, actual, message = nil) click to toggle source

Checks that two HTML strings are not equivalent. That they do not contain the same elements and attributes with the associated values.

assert_dom_not_equal '<a href="http://www.example.com">Oranges</a>',
                     link_to("Apples", "http://www.example.com")

See also Minitest::Rails::Expectations#wont_dom_equal

# File lib/minitest/rails/assertions/action_view.rb, line 345
  
Also aliased as: refute_dom_equal
assert_generates(expected_path, options, defaults={}, extras = {}, message=nil) click to toggle source

Asserts that the provided options can be used to generate the provided path. This is the inverse of assert_recognizes. The extras parameter is used to tell the request the names and values of additional request parameters that would be in a query string. The message parameter allows you to specify a custom error message for assertion failures.

The defaults parameter is unused.

# Asserts that the default action is generated for a route with no action
assert_generates "/items", controller: "items", action: "index"

# Tests that the list action is properly routed
assert_generates "/items/list", controller: "items", action: "list"

# Tests the generation of a route with a parameter
assert_generates "/items/list/1", { controller: "items", action: "list", id: "1" }

# Asserts that the generated route gives us our custom route
assert_generates "changesets/12", { controller: 'scm', action: 'show_diff', revision: "12" }

See also Minitest::Rails::Expectations#must_route_to

# File lib/minitest/rails/assertions/action_view.rb, line 106
  
assert_no_difference(expression, message = nil, &block) click to toggle source

Checks that the numeric result of evaluating an expression is not changed before and after invoking.

assert_no_difference "User.count" do
  User.new
end

See also Minitest::Rails::Expectations#wont_change

# File lib/minitest/rails/assertions/action_view.rb, line 26
  
Also aliased as: refute_difference
assert_recognizes(expected_options, path, extras={}, msg=nil) click to toggle source

Asserts that the routing of the given path was handled correctly and that the parsed options (given in the expected_options hash) match path. Basically, it asserts that Rails recognizes the route given by expected_options.

Pass a hash in the second argument (path) to specify the request method. This is useful for routes requiring a specific HTTP method. The hash should contain a :path with the incoming request path and a :method containing the required HTTP verb.

# assert that POSTing to /items will call the create action on ItemsController
assert_recognizes({controller: 'items', action: 'create'}, {path: 'items', method: :post})

You can also pass in extras with a hash containing URL parameters that would normally be in the query string. This can be used to assert that values in the query string string will end up in the params hash correctly. To test query strings you must use the extras argument, appending the query string on the path directly will not work. For example:

# assert that a path of '/items/list/1?view=print' returns the correct options
assert_recognizes({controller: 'items', action: 'list', id: '1', view: 'print'}, 'items/list/1', { view: "print" })

The message parameter allows you to pass in an error message that is displayed upon failure.

# Check the default route (i.e., the index action)
assert_recognizes({controller: 'items', action: 'index'}, 'items')

# Test a specific action
assert_recognizes({controller: 'items', action: 'list'}, 'items/list')

# Test an action with a parameter
assert_recognizes({controller: 'items', action: 'destroy', id: '1'}, 'items/destroy/1')

# Test a custom route
assert_recognizes({controller: 'items', action: 'show', id: '1'}, 'view/item1')

See also Minitest::Rails::Expectations#must_route_from

# File lib/minitest/rails/assertions/action_view.rb, line 143
  
assert_redirected_to(options = {}, message=nil) click to toggle source

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.

# 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 login_url

# assert 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)

See also Minitest::Rails::Expectations#must_redirect_to

# File lib/minitest/rails/assertions/action_view.rb, line 82
  
assert_response(type, message = nil) click to toggle source

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.

# assert that the response was a redirection
assert_response :redirect

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

See also Minitest::Rails::Expectations#must_respond_with

# File lib/minitest/rails/assertions/action_view.rb, line 60
  
assert_routing(path, options, defaults={}, extras={}, message=nil) click to toggle source

Asserts that path and options match both ways; in other words, it verifies that path generates options and then that options generates path. This essentially combines assert_recognizes and assert_generates into one step.

The extras hash allows you to specify options that would normally be provided as a query string to the action. The message parameter allows you to specify a custom error message to display upon failure.

# Assert a basic route: a controller with the default action (index)
assert_routing '/home', controller: 'home', action: 'index'

# Test a route generated with a specific controller, action, and parameter (id)
assert_routing '/entries/show/23', controller: 'entries', action: 'show', id: 23

# Assert a basic route (controller + default action), with an error message if it fails
assert_routing '/store', { controller: 'store', action: 'index' }, {}, {}, 'Route for store index not generated properly'

# Tests a route, providing a defaults hash
assert_routing 'controller/action/9', {id: "9", item: "square"}, {controller: "controller", action: "action"}, {}, {item: "square"}

# Tests a route with a HTTP method
assert_routing({ method: 'put', path: '/product/321' }, { controller: "product", action: "update", id: "321" })

See also Minitest::Rails::Expectations#must_route

# File lib/minitest/rails/assertions/action_view.rb, line 171
  
assert_select(*args, &block) click to toggle source

An assertion that selects elements and makes one or more equality tests.

If the first argument is an element, selects all matching elements starting from (and including) that element and all its children in depth-first order.

If no element if specified, calling assert_select selects from the response HTML unless assert_select is called from within an assert_select block.

When called with a block assert_select passes an array of selected elements to the block. Calling assert_select from the block, with no element specified, runs the assertion on the complete set of elements selected by the enclosing assertion. Alternatively the array may be iterated through so that assert_select can be called separately for each element.

Example

If the response contains two ordered lists, each with four list elements then:

assert_select "ol" do |elements|
  elements.each do |element|
    assert_select element, "li", 4
  end
end

will pass, as will:

assert_select "ol" do
  assert_select "li", 8
end

The selector may be a CSS selector expression (String), an expression with substitution values, or an HTML::Selector object.

Equality Tests

The equality test may be one of the following:

  • true - Assertion is true if at least one element selected.

  • false - Assertion is true if no element selected.

  • String/Regexp - Assertion is true if the text value of at least one element matches the string or regular expression.

  • Integer - Assertion is true if exactly that number of elements are selected.

  • Range - Assertion is true if the number of selected elements fit the range.

If no equality test specified, the assertion is true if at least one element selected.

To perform more than one equality tests, use a hash with the following keys:

  • :text - Narrow the selection to elements that have this text value (string or regexp).

  • :html - Narrow the selection to elements that have this HTML content (string or regexp).

  • :count - Assertion is true if the number of selected elements is equal to this value.

  • :minimum - Assertion is true if the number of selected elements is at least this value.

  • :maximum - Assertion is true if the number of selected elements is at most this value.

If the method is called with a block, once all equality tests are evaluated the block is called with an array of all matched elements.

# At least one form element
assert_select "form"

# Form element includes four input fields
assert_select "form input", 4

# Page title is "Welcome"
assert_select "title", "Welcome"

# Page title is "Welcome" and there is only one title element
assert_select "title", {count: 1, text: "Welcome"},
    "Wrong title or more than one title element"

# Page contains no forms
assert_select "form", false, "This page must contain no forms"

# Test the content and style
assert_select "body div.header ul.menu"

# Use substitution values
assert_select "ol>li#?", /item-\d+/

# All input fields in the form have a name
assert_select "form input" do
  assert_select "[name=?]", /.+/  # Not empty
end

See also Minitest::Rails::Expectations#must_select

# File lib/minitest/rails/assertions/action_view.rb, line 264
  
assert_select_email(&block) click to toggle source

Extracts the body of an email and runs nested assertions on it.

You must enable deliveries for this assertion to work, use:

 ActionMailer::Base.perform_deliveries = true

assert_select_email do
  assert_select "h1", "Email alert"
end

assert_select_email do
  items = assert_select "ol>li"
  items.each do
     # Work with items here...
  end
end

See also Minitest::Rails::Expectations#must_select_email

# File lib/minitest/rails/assertions/action_view.rb, line 285
  
assert_select_encoded(element = nil, &block) click to toggle source

Extracts the content of an element, treats it as encoded HTML and runs nested assertion on it.

You typically call this method within another assertion to operate on all currently selected elements. You can also pass an element or array of elements.

The content of each element is un-encoded, and wrapped in the root element encoded. It then calls the block with all un-encoded elements.

# Selects all bold tags from within the title of an Atom feed's entries (perhaps to nab a section name prefix)
assert_select "feed[xmlns='http://www.w3.org/2005/Atom']" do
  # Select each entry item and then the title item
  assert_select "entry>title" do
    # Run assertions on the encoded title elements
    assert_select_encoded do
      assert_select "b"
    end
  end
end

# Selects all paragraph tags from within the description of an RSS feed
assert_select "rss[version=2.0]" do
  # Select description element of each feed item.
  assert_select "channel>item>description" do
    # Run assertions on the encoded elements.
    assert_select_encoded do
      assert_select "p"
    end
  end
end

See also Minitest::Rails::Expectations#must_select_encoded

# File lib/minitest/rails/assertions/action_view.rb, line 323
  
refute_difference()

Checks that the numeric result of evaluating an expression is not changed before and after invoking.

refute_difference "User.count", do
  User.new
end

See also Minitest::Rails::Expectations#wont_change

:args: expression, message = nil, &block

refute_dom_equal()

Checks that two HTML strings are not equivalent. That they do not contain the same elements and attributes with the associated values.

refute_dom_equal '<a href="http://www.example.com">Oranges</a>',
                 link_to("Apples", "http://www.example.com")

See also Minitest::Rails::Expectations#wont_dom_equal

:method: assert_dom_equal :call-seq: assert_dom_equal(expected, actual, message = nil)