Class | ActionController::TestCase |
In: |
vendor/rails/actionpack/lib/action_controller/test_case.rb
|
Parent: | ActiveSupport::TestCase |
Superclass for ActionController functional tests. Functional tests allow you to test a single controller action per test method. This should not be confused with integration tests (see ActionController::IntegrationTest), which are more like "stories" that can involve multiple controllers and mutliple actions (i.e. multiple different HTTP requests).
Functional tests are written as follows:
For example:
class BooksControllerTest < ActionController::TestCase def test_create # Simulate a POST response with the given HTTP parameters. post(:create, :book => { :title => "Love Hina" }) # Assert that the controller tried to redirect us to # the created book's URI. assert_response :found # Assert that the controller really put the book in the database. assert_not_nil Book.find_by_title("Love Hina") end end
ActionController::TestCase will also automatically provide the following instance variables for use in the tests:
@controller: | The controller instance that will be tested. |
@request: | An ActionController::TestRequest, representing the current HTTP request. You can modify this object before sending the HTTP request. For example, you might want to set some session properties before sending a GET request. |
@response: | An ActionController::TestResponse object, representing the response of the last HTTP response. In the above example, @response becomes valid after calling post. If the various assert methods are not sufficient, then you may use this object to inspect the HTTP response in detail. |
(Earlier versions of Rails required each functional test to subclass Test::Unit::TestCase and define @controller, @request, @response in setup.)
ActionController::TestCase will automatically infer the controller under test from the test class name. If the controller cannot be inferred from the test class name, you can explicity set it with tests.
class SpecialEdgeCaseWidgetsControllerTest < ActionController::TestCase tests WidgetController end
# File vendor/rails/actionpack/lib/action_controller/test_case.rb, line 114 114: def controller_class 115: if current_controller_class = read_inheritable_attribute(:controller_class) 116: current_controller_class 117: else 118: self.controller_class = determine_default_controller_class(name) 119: end 120: end
# File vendor/rails/actionpack/lib/action_controller/test_case.rb, line 109 109: def controller_class=(new_class) 110: prepare_controller_class(new_class) 111: write_inheritable_attribute(:controller_class, new_class) 112: end
# File vendor/rails/actionpack/lib/action_controller/test_case.rb, line 122 122: def determine_default_controller_class(name) 123: name.sub(/Test$/, '').constantize 124: rescue NameError 125: raise NonInferrableControllerError.new(name) 126: end
# File vendor/rails/actionpack/lib/action_controller/test_case.rb, line 128 128: def prepare_controller_class(new_class) 129: new_class.send :include, RaiseActionExceptions 130: end
Sets the controller class name. Useful if the name can‘t be inferred from test class. Expects controller_class as a constant. Example: tests WidgetController.
# File vendor/rails/actionpack/lib/action_controller/test_case.rb, line 105 105: def tests(controller_class) 106: self.controller_class = controller_class 107: end
Cause the action to be rescued according to the regular rules for rescue_action when the visitor is not local
# File vendor/rails/actionpack/lib/action_controller/test_case.rb, line 143 143: def rescue_action_in_public! 144: @request.remote_addr = '208.77.188.166' # example.com 145: end
# File vendor/rails/actionpack/lib/action_controller/test_case.rb, line 133 133: def setup_controller_request_and_response 134: @controller = self.class.controller_class.new 135: @controller.request = @request = TestRequest.new 136: @response = TestResponse.new 137: 138: @controller.params = {} 139: @controller.send(:initialize_current_url) 140: end