Class: ActionController::TestCase

Inherits:
ActiveSupport::TestCase
  • Object
show all
Defined in:
lib/action_controller/test_case.rb

Overview

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).

Basic example

Functional tests are written as follows:

  1. First, one uses the get, post, put, delete or head method to simulate an HTTP request.

  2. Then, one asserts whether the current state is as expected. “State” can be anything: the controller’s HTTP response, the database contents, etc.

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

Special instance variables

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.)

Controller is automatically inferred

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

Defined Under Namespace

Modules: RaiseActionExceptions

Constant Summary collapse

@@controller_class = 
nil

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.controller_class ⇒ Object 



114
115
116
117
118
119
120
 
# File 'lib/action_controller/test_case.rb', line 114

def controller_class
  if current_controller_class = read_inheritable_attribute(:controller_class)
    current_controller_class
  else
    self.controller_class = determine_default_controller_class(name)
  end
end

.controller_class=(new_class) ⇒ Object 



109
110
111
112
 
# File 'lib/action_controller/test_case.rb', line 109

def controller_class=(new_class)
  prepare_controller_class(new_class)
  write_inheritable_attribute(:controller_class, new_class)
end

.determine_default_controller_class(name) ⇒ Object 



122
123
124
125
126
 
# File 'lib/action_controller/test_case.rb', line 122

def determine_default_controller_class(name)
  name.sub(/Test$/, '').constantize
rescue NameError
  raise NonInferrableControllerError.new(name)
end

.prepare_controller_class(new_class) ⇒ Object 



128
129
130
 
# File 'lib/action_controller/test_case.rb', line 128

def prepare_controller_class(new_class)
  new_class.send :include, RaiseActionExceptions
end

.tests(controller_class) ⇒ Object

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.



105
106
107
 
# File 'lib/action_controller/test_case.rb', line 105

def tests(controller_class)
  self.controller_class = controller_class
end

Instance Method Details

#rescue_action_in_public! ⇒ Object

Cause the action to be rescued according to the regular rules for rescue_action when the visitor is not local



143
144
145
 
# File 'lib/action_controller/test_case.rb', line 143

def rescue_action_in_public!
  @request.remote_addr = '208.77.188.166' # example.com
end

#setup_controller_request_and_response ⇒ Object 



133
134
135
136
137
138
139
140
 
# File 'lib/action_controller/test_case.rb', line 133

def setup_controller_request_and_response
  @controller = self.class.controller_class.new
  @controller.request = @request = TestRequest.new
  @response = TestResponse.new

  @controller.params = {}
  @controller.send(:initialize_current_url)
end