Module: ActionController::TestCase::Behavior
Relationships & Source Files | |
Namespace Children | |
Modules:
| |
Extension / Inclusion / Inheritance Descendants | |
Included In:
| |
Super Chains via Extension / Inclusion / Inheritance | |
Class Chain:
self,
::ActiveSupport::Concern
|
|
Instance Chain:
self,
Rails::Dom::Testing::Assertions,
::ActiveSupport::Testing::ConstantLookup ,
::ActionDispatch::TestProcess ,
::ActionDispatch::TestProcess::FixtureFile
|
|
Defined in: | actionpack/lib/action_controller/test_case.rb |
Class Method Summary
::ActiveSupport::Concern
- Extended
class_methods | Define class methods from given block. |
included | Evaluate given block in context of base class, so that you can write class macros here. |
prepended | Evaluate given block in context of base class, so that you can write class macros here. |
append_features, prepend_features |
Instance Attribute Summary
Instance Method Summary
- #build_response(klass)
- #controller_class_name
-
#delete(action, **args)
Simulate a DELETE request with the given parameters and set/volley the response.
- #generated_path(generated_extras)
-
#get(action, **args)
Simulate a GET request with the given parameters.
-
#head(action, **args)
Simulate a HEAD request with the given parameters and set/volley the response.
-
#patch(action, **args)
Simulate a PATCH request with the given parameters and set/volley the response.
-
#post(action, **args)
Simulate a POST request with the given parameters and set/volley the response.
-
#process(action, method: "GET", params: nil, session: nil, body: nil, flash: {}, format: nil, xhr: false, as: nil)
Simulate an HTTP request to
action
by specifying request method, parameters and set/volley the response. -
#put(action, **args)
Simulate a PUT request with the given parameters and set/volley the response.
- #query_parameter_names(generated_extras)
- #setup_controller_request_and_response
- #check_required_ivars private
- #document_root_element private
- #process_controller_response(action, cookies, xhr) private
- #scrub_env!(env) private
- #setup_request(controller_class_name, action, parameters, session, flash, xhr) private
- #wrap_execution(&block) private
::ActionDispatch::TestProcess
- Included
::ActionDispatch::TestProcess::FixtureFile
- Included
#file_fixture_upload | Shortcut for ‘Rack::Test::UploadedFile.new(File.join(ActionDispatch::IntegrationTest.file_f ixture_path, path), type)`: |
#fixture_file_upload |
DSL Calls
included
[ GitHub ]588 589 590 591 592 593 594
# File 'actionpack/lib/action_controller/test_case.rb', line 588
included do include ActionController::TemplateAssertions include ActionDispatch::Assertions class_attribute :_controller_class setup :setup_controller_request_and_response ActiveSupport.run_load_hooks(:action_controller_test_case, self) end
Instance Attribute Details
#request (readonly)
[ GitHub ]# File 'actionpack/lib/action_controller/test_case.rb', line 369
attr_reader :response, :request
#response (readonly)
[ GitHub ]# File 'actionpack/lib/action_controller/test_case.rb', line 369
attr_reader :response, :request
Instance Method Details
#build_response(klass)
[ GitHub ]# File 'actionpack/lib/action_controller/test_case.rb', line 584
def build_response(klass) klass.create end
#check_required_ivars (private)
[ GitHub ]# File 'actionpack/lib/action_controller/test_case.rb', line 677
def check_required_ivars # Check for required instance variables so we can give an understandable error # message. [:@routes, :@controller, :@request, :@response].each do |iv_name| if !instance_variable_defined?(iv_name) || instance_variable_get(iv_name).nil? raise "#{iv_name} is nil: make sure you set it in your test's setup method." end end end
#controller_class_name
[ GitHub ]# File 'actionpack/lib/action_controller/test_case.rb', line 544
def controller_class_name @controller.class.anonymous? ? "anonymous" : @controller.class.controller_path end
#delete(action, **args)
Simulate a DELETE request with the given parameters and set/volley the response. See #get for more details.
# File 'actionpack/lib/action_controller/test_case.rb', line 455
def delete(action, **args) process(action, method: "DELETE", **args) end
#document_root_element (private)
[ GitHub ]# File 'actionpack/lib/action_controller/test_case.rb', line 673
def document_root_element html_document.root end
#generated_path(generated_extras)
[ GitHub ]# File 'actionpack/lib/action_controller/test_case.rb', line 548
def generated_path(generated_extras) generated_extras[0] end
#get(action, **args)
Simulate a GET request with the given parameters.
-
action
: The controller action to call. -
params
: The hash with HTTP parameters that you want to pass. This may benil
. -
body
: The request body with a string that is appropriately encoded (‘application/x-www-form-urlencoded` ormultipart/form-data
). -
session
: A hash of parameters to store in the session. This may benil
. -
flash
: A hash of parameters to store in the flash. This may benil
.
You can also simulate POST, PATCH, PUT, DELETE, and HEAD requests with #post, #patch, #put, #delete, and #head. Example sending parameters, session, and setting a flash message:
get :show,
params: { id: 7 },
session: { user_id: 1 },
flash: { notice: 'This is flash message' }
Note that the request method is not verified. The different methods are available to make the tests more expressive.
# File 'actionpack/lib/action_controller/test_case.rb', line 431
def get(action, **args) process(action, method: "GET", **args) end
#head(action, **args)
Simulate a HEAD request with the given parameters and set/volley the response. See #get for more details.
# File 'actionpack/lib/action_controller/test_case.rb', line 461
def head(action, **args) process(action, method: "HEAD", **args) end
#patch(action, **args)
Simulate a PATCH request with the given parameters and set/volley the response. See #get for more details.
# File 'actionpack/lib/action_controller/test_case.rb', line 443
def patch(action, **args) process(action, method: "PATCH", **args) end
#post(action, **args)
Simulate a POST request with the given parameters and set/volley the response. See #get for more details.
# File 'actionpack/lib/action_controller/test_case.rb', line 437
def post(action, **args) process(action, method: "POST", **args) end
#process(action, method: "GET", params: nil, session: nil, body: nil, flash: {}, format: nil, xhr: false, as: nil)
Simulate an HTTP request to action
by specifying request method, parameters and set/volley the response.
-
action
: The controller action to call. -
method
: Request method used to send the HTTP request. Possible values areGET
,POST
,PATCH
,PUT
,DELETE
,HEAD
. Defaults toGET
. Can be a symbol. -
params
: The hash with HTTP parameters that you want to pass. This may benil
. -
body
: The request body with a string that is appropriately encoded (‘application/x-www-form-urlencoded` ormultipart/form-data
). -
session
: A hash of parameters to store in the session. This may benil
. -
flash
: A hash of parameters to store in the flash. This may benil
. -
format
: Request format. Defaults tonil
. Can be string or symbol. -
as
: Content type. Defaults tonil
. Must be a symbol that corresponds to a mime type.
Example calling create
action and sending two params:
process :create,
method: 'POST',
params: {
user: { name: 'Gaurish Sharma', email: 'user@example.com' }
},
session: { user_id: 1 },
flash: { notice: 'This is flash message' }
To simulate GET
, POST
, PATCH
, PUT
, DELETE
, and HEAD
requests prefer using #get, #post, #patch, #put, #delete and #head methods respectively which will make tests more expressive.
It’s not recommended to make more than one request in the same test. Instance variables that are set in one request will not persist to the next request, but it’s not guaranteed that all ::Rails
internal state will be reset. Prefer ::ActionDispatch::IntegrationTest
for making multiple requests in the same test.
Note that the request method is not verified.
# File 'actionpack/lib/action_controller/test_case.rb', line 504
def process(action, method: "GET", params: nil, session: nil, body: nil, flash: {}, format: nil, xhr: false, as: nil) check_required_ivars @controller.clear_instance_variables_between_requests action = +action.to_s http_method = method.to_s.upcase @html_document = nil .update(@request. ) . @request.set_header "HTTP_COOKIE", .to_header @request.delete_header "action_dispatch.cookies" @request = TestRequest.new scrub_env!(@request.env), @request.session, @controller.class @response = build_response @response_klass @response.request = @request @controller.recycle! if body @request.set_header "RAW_POST_DATA", body end @request.set_header "REQUEST_METHOD", http_method if as @request.content_type = Mime[as].to_s format ||= as end parameters = (params || {}).symbolize_keys if format parameters[:format] = format end setup_request(controller_class_name, action, parameters, session, flash, xhr) process_controller_response(action, , xhr) end
#process_controller_response(action, cookies, xhr) (private)
[ GitHub ]# File 'actionpack/lib/action_controller/test_case.rb', line 627
def process_controller_response(action, , xhr) begin @controller.recycle! wrap_execution { @controller.dispatch(action, @request, @response) } ensure @request = @controller.request @response = @controller.response if @request. unless @request. .committed? @request. .write(@response) .update(@request. .instance_variable_get(:@cookies)) .update(@response. ) end end @response.prepare! if flash_value = @request.flash.to_session_value @request.session["flash"] = flash_value else @request.session.delete("flash") end if xhr @request.delete_header "HTTP_X_REQUESTED_WITH" @request.delete_header "HTTP_ACCEPT" end @request.query_string = "" @response.sent! end @response end
#put(action, **args)
Simulate a PUT request with the given parameters and set/volley the response. See #get for more details.
# File 'actionpack/lib/action_controller/test_case.rb', line 449
def put(action, **args) process(action, method: "PUT", **args) end
#query_parameter_names(generated_extras)
[ GitHub ]# File 'actionpack/lib/action_controller/test_case.rb', line 552
def query_parameter_names(generated_extras) generated_extras[1] + [:controller, :action] end
#scrub_env!(env) (private)
[ GitHub ]#setup_controller_request_and_response
[ GitHub ]# File 'actionpack/lib/action_controller/test_case.rb', line 556
def setup_controller_request_and_response @controller = nil unless defined? @controller @response_klass = ActionDispatch::TestResponse if klass = self.class.controller_class if klass < ActionController::Live @response_klass = LiveTestResponse end unless @controller begin @controller = klass.new rescue warn "could not construct controller #{klass}" if $VERBOSE end end end @request = TestRequest.create(@controller.class) @response = build_response @response_klass @response.request = @request if @controller @controller.request = @request @controller.params = {} end end
#setup_request(controller_class_name, action, parameters, session, flash, xhr) (private)
[ GitHub ]# File 'actionpack/lib/action_controller/test_case.rb', line 597
def setup_request(controller_class_name, action, parameters, session, flash, xhr) generated_extras = @routes.generate_extras(parameters.merge(controller: controller_class_name, action: action)) generated_path = generated_path(generated_extras) query_string_keys = query_parameter_names(generated_extras) @request.assign_parameters(@routes, controller_class_name, action, parameters, generated_path, query_string_keys) @request.session.update(session) if session @request.flash.update(flash || {}) if xhr @request.set_header "HTTP_X_REQUESTED_WITH", "XMLHttpRequest" @request.fetch_header("HTTP_ACCEPT") do |k| @request.set_header k, [Mime[:js], Mime[:html], Mime[:xml], "text/xml", "*/*"].join(", ") end end @request.fetch_header("SCRIPT_NAME") do |k| @request.set_header k, @controller.config.relative_url_root end end
#wrap_execution(&block) (private)
[ GitHub ]# File 'actionpack/lib/action_controller/test_case.rb', line 619
def wrap_execution(&block) if ActionController::TestCase.executor_around_each_request && defined?(Rails.application) && Rails.application Rails.application.executor.wrap(&block) else yield end end