class ActionController::TestCase

Resolve the controller from the test name when using the spec DSL

# File lib/minitest/rails.rb, line 51
def self.determine_default_controller_class(name)
  controller = determine_constant_from_test_name(name) do |constant|
    Class === constant && constant < ActionController::Metal
  end
  raise NameError.new("Unable to resolve controller for #{name}") if controller.nil?
  controller
end

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.rb, line 372
  

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.rb, line 383
  

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.rb, line 144
  

Identical to assert_tag, but asserts that a matching tag does not exist. (See assert_tag for a full discussion of the syntax.)

# Assert that there is not a "div" containing a "p"
assert_no_tag tag: "div", descendant: { tag: "p" }

# Assert that an unordered list is empty
assert_no_tag tag: "ul", descendant: { tag: "li" }

# Assert that there is not a "p" tag with between 1 to 3 "img" tags
# as immediate children
assert_no_tag tag: "p",
           children: { count: 1..3, only: { tag: "img" } }

See also Minitest::Rails::Expectations#wont_have_tag

# File lib/minitest/rails/assertions.rb, line 511
  

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.rb, line 181
  

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.rb, line 85
  

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.rb, line 63
  

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.rb, line 209
  

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.rb, line 302
  

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.rb, line 323
  

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.rb, line 361
  

Asserts that there is a tag/node/element in the body of the response that meets all of the given conditions. The conditions parameter must be a hash of any of the following keys (all are optional):

• :tag: the node type must match the corresponding value

• :attributes: a hash. The node's attributes must match the corresponding values in the hash.

• :parent: a hash. The node's parent must match the corresponding hash.

• :child: a hash. At least one of the node's immediate children must meet the criteria described by the hash.

• :ancestor: a hash. At least one of the node's ancestors must meet the criteria described by the hash.

• :descendant: a hash. At least one of the node's descendants must meet the criteria described by the hash.

• :sibling: a hash. At least one of the node's siblings must meet the criteria described by the hash.

• :after: a hash. The node must be after any sibling meeting the criteria described by the hash, and at least one sibling must match.

• :before: a hash. The node must be before any sibling meeting the criteria described by the hash, and at least one sibling must match.

• :children: a hash, for counting children of a node. Accepts the keys:

  • :count: either a number or a range which must equal (or include) the number of children that match.

  • :less_than: the number of matching children must be less than this number.

  • :greater_than: the number of matching children must be greater than this number.

  • :only: another hash consisting of the keys to use to match on the children, and only matching children will be counted.

• :content: the textual content of the node must match the given value. This will not match HTML tags in the body of a tag–only text.

Conditions are matched using the following algorithm:

• if the condition is a string, it must be a substring of the value.

• if the condition is a regexp, it must match the value.

• if the condition is a number, the value must match number.to_s.

• if the condition is true, the value must not be nil.

• if the condition is false or nil, the value must be nil.

  # Assert that there is a “span” tag assert_tag tag: “span”

  # Assert that there is a “span” tag with id=“x” assert_tag tag: “span”, attributes: { id: “x” }

  # Assert that there is a “span” tag using the short-hand assert_tag :span

  # Assert that there is a “span” tag with id=“x” using the short-hand assert_tag :span, attributes: { id: “x” }

  # Assert that there is a “span” inside of a “div” assert_tag tag: “span”, parent: { tag: “div” }

  # Assert that there is a “span” somewhere inside a table assert_tag tag: “span”, ancestor: { tag: “table” }

  # Assert that there is a “span” with at least one “em” child assert_tag tag: “span”, child: { tag: “em” }

  # Assert that there is a “span” containing a (possibly nested) # “strong” tag. assert_tag tag: “span”, descendant: { tag: “strong” }

  # Assert that there is a “span” containing between 2 and 4 “em” tags # as immediate children assert_tag tag: “span”,

  children: { count: 2..4, only: { tag: "em" } }

  # Get funky: assert that there is a “div”, with an “ul” ancestor # and an “li” parent (with “class” = “enum”), and containing a # “span” descendant that contains text matching /hello world/ assert_tag tag: “div”,

  ancestor: { tag: "ul" },
  parent: { tag: "li",
               attributes: { class: "enum" } },
  descendant: { tag: "span",
                   child: /hello world/ }

Please note: assert_tag and assert_no_tag only work with well-formed XHTML. They recognize a few tags as implicitly self-closing (like br and hr and such) but will not work correctly with tags that allow optional closing tags (p, li, td). You must explicitly close all of your tags to use these assertions.

See also Minitest::Rails::Expectations#must_have_tag

# File lib/minitest/rails/assertions.rb, line 491
  

Asserts that the request was rendered with the appropriate template file or partials.

# assert that the "new" view template was rendered
assert_template "new"

# assert that the exact template "admin/posts/new" was rendered
assert_template %r{\Aadmin/posts/new\Z}

# assert that the layout 'admin' was rendered
assert_template layout: 'admin'
assert_template layout: 'layouts/admin'
assert_template layout: :admin

# assert that no layout was rendered
assert_template layout: nil
assert_template layout: false

# assert that the "_customer" partial was rendered twice
assert_template partial: '_customer', count: 2

# assert that no partials were rendered
assert_template partial: false

In a view test case, you can also assert that specific locals are passed to partials:

# assert that the "_customer" partial was rendered with a specific object
assert_template partial: '_customer', locals: { customer: @customer }

See also Minitest::Rails::Expectations#must_render_template

# File lib/minitest/rails/assertions.rb, line 120