Module: ActionController::TestCase::Behavior
- Extended by:
- ActiveSupport::Concern
- Includes:
- ActionDispatch::TestProcess, ActiveSupport::Testing::ConstantLookup, Rails::Dom::Testing::Assertions
- Included in:
- ActionController::TestCase
- Defined in:
- lib/action_controller/test_case.rb
Defined Under Namespace
Modules: ClassMethods
Instance Attribute Summary collapse
-
#request ⇒ Object
readonly
Returns the value of attribute request.
-
#response ⇒ Object
readonly
Returns the value of attribute response.
Instance Method Summary collapse
- #build_request ⇒ Object
- #build_response(klass) ⇒ Object
-
#delete(action, *args) ⇒ Object
Simulate a DELETE request with the given parameters and set/volley the response.
-
#get(action, *args) ⇒ Object
Simulate a GET request with the given parameters.
-
#head(action, *args) ⇒ Object
Simulate a HEAD request with the given parameters and set/volley the response.
- #paramify_values(hash_or_array_or_value) ⇒ Object
-
#patch(action, *args) ⇒ Object
Simulate a PATCH request with the given parameters and set/volley the response.
-
#post(action, *args) ⇒ Object
Simulate a POST request with the given parameters and set/volley the response.
-
#process(action, http_method = 'GET', *args) ⇒ Object
Simulate a HTTP request to
action
by specifying request method, parameters and set/volley the response. -
#put(action, *args) ⇒ Object
Simulate a PUT request with the given parameters and set/volley the response.
- #setup_controller_request_and_response ⇒ Object
- #xml_http_request(request_method, action, parameters = nil, session = nil, flash = nil) ⇒ Object (also: #xhr)
Methods included from ActionDispatch::TestProcess
#assigns, #cookies, #fixture_file_upload, #flash, #redirect_to_url, #session
Instance Attribute Details
#request ⇒ Object (readonly)
Returns the value of attribute request.
457 458 459 |
# File 'lib/action_controller/test_case.rb', line 457 def request @request end |
#response ⇒ Object (readonly)
Returns the value of attribute response.
457 458 459 |
# File 'lib/action_controller/test_case.rb', line 457 def response @response end |
Instance Method Details
#build_request ⇒ Object
683 684 685 |
# File 'lib/action_controller/test_case.rb', line 683 def build_request TestRequest.new end |
#build_response(klass) ⇒ Object
687 688 689 |
# File 'lib/action_controller/test_case.rb', line 687 def build_response(klass) klass.new end |
#delete(action, *args) ⇒ Object
Simulate a DELETE request with the given parameters and set/volley the response. See get
for more details.
535 536 537 |
# File 'lib/action_controller/test_case.rb', line 535 def delete(action, *args) process(action, "DELETE", *args) end |
#get(action, *args) ⇒ Object
Simulate a GET request with the given parameters.
-
action
: The controller action to call. -
parameters
: The HTTP parameters that you want to pass. This may benil
, a hash, or 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
.
Note that the request method is not verified. The different methods are available to make the tests more expressive.
511 512 513 |
# File 'lib/action_controller/test_case.rb', line 511 def get(action, *args) process(action, "GET", *args) end |
#head(action, *args) ⇒ Object
Simulate a HEAD request with the given parameters and set/volley the response. See get
for more details.
541 542 543 |
# File 'lib/action_controller/test_case.rb', line 541 def head(action, *args) process(action, "HEAD", *args) end |
#paramify_values(hash_or_array_or_value) ⇒ Object
555 556 557 558 559 560 561 562 563 564 565 566 |
# File 'lib/action_controller/test_case.rb', line 555 def paramify_values(hash_or_array_or_value) case hash_or_array_or_value when Hash Hash[hash_or_array_or_value.map{|key, value| [key, paramify_values(value)] }] when Array hash_or_array_or_value.map {|i| paramify_values(i)} when Rack::Test::UploadedFile, ActionDispatch::Http::UploadedFile hash_or_array_or_value else hash_or_array_or_value.to_param end end |
#patch(action, *args) ⇒ Object
Simulate a PATCH request with the given parameters and set/volley the response. See get
for more details.
523 524 525 |
# File 'lib/action_controller/test_case.rb', line 523 def patch(action, *args) process(action, "PATCH", *args) end |
#post(action, *args) ⇒ Object
Simulate a POST request with the given parameters and set/volley the response. See get
for more details.
517 518 519 |
# File 'lib/action_controller/test_case.rb', line 517 def post(action, *args) process(action, "POST", *args) end |
#process(action, http_method = 'GET', *args) ⇒ Object
Simulate a HTTP request to action
by specifying request method, parameters and set/volley the response.
-
action
: The controller action to call. -
http_method
: Request method used to send the http request. Possible values areGET
,POST
,PATCH
,PUT
,DELETE
,HEAD
. Defaults toGET
. -
parameters
: The HTTP parameters. This may benil
, a hash, or 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
.
Example calling create
action and sending two params:
process :create, 'POST', user: { name: 'Gaurish Sharma', email: '[email protected]' }
Example sending parameters, nil
session and setting a flash message:
process :view, 'GET', { id: 7 }, nil, { 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.
Note that the request method is not verified.
593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 |
# File 'lib/action_controller/test_case.rb', line 593 def process(action, http_method = 'GET', *args) check_required_ivars if args.first.is_a?(String) && http_method != 'HEAD' @request.env['RAW_POST_DATA'] = args.shift end parameters, session, flash = args parameters ||= {} # Ensure that numbers and symbols passed as params are converted to # proper params, as is the case when engaging rack. parameters = paramify_values(parameters) if html_format?(parameters) @html_document = nil @html_scanner_document = nil unless @controller.respond_to?(:recycle!) @controller.extend(Testing::Functional) end @request.recycle! @response.recycle! @controller.recycle! @request.env['REQUEST_METHOD'] = http_method controller_class_name = @controller.class.anonymous? ? "anonymous" : @controller.class.controller_path @request.assign_parameters(@routes, controller_class_name, action.to_s, parameters) @request.session.update(session) if session @request.flash.update(flash || {}) @controller.request = @request @controller.response = @response build_request_uri(action, parameters) name = @request.parameters[:action] @controller.recycle! @controller.process(name) if = @request.env['action_dispatch.cookies'] unless @response.committed? .write(@response) end end @response.prepare! @assigns = @controller.respond_to?(:view_assigns) ? @controller.view_assigns : {} if flash_value = @request.flash.to_session_value @request.session['flash'] = flash_value end @response end |
#put(action, *args) ⇒ Object
Simulate a PUT request with the given parameters and set/volley the response. See get
for more details.
529 530 531 |
# File 'lib/action_controller/test_case.rb', line 529 def put(action, *args) process(action, "PUT", *args) end |
#setup_controller_request_and_response ⇒ Object
655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 |
# File 'lib/action_controller/test_case.rb', line 655 def setup_controller_request_and_response @controller = nil unless defined? @controller response_klass = 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 = build_request @response = build_response response_klass @response.request = @request if @controller @controller.request = @request @controller.params = {} end end |
#xml_http_request(request_method, action, parameters = nil, session = nil, flash = nil) ⇒ Object Also known as: xhr
545 546 547 548 549 550 551 552 |
# File 'lib/action_controller/test_case.rb', line 545 def xml_http_request(request_method, action, parameters = nil, session = nil, flash = nil) @request.env['HTTP_X_REQUESTED_WITH'] = 'XMLHttpRequest' @request.env['HTTP_ACCEPT'] ||= [Mime::JS, Mime::HTML, Mime::XML, 'text/xml', Mime::ALL].join(', ') __send__(request_method, action, parameters, session, flash).tap do @request.env.delete 'HTTP_X_REQUESTED_WITH' @request.env.delete 'HTTP_ACCEPT' end end |