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

Instance Method Summary collapse

Methods included from ActionDispatch::TestProcess

#assigns, #cookies, #flash, #redirect_to_url, #session

Methods included from ActionDispatch::TestProcess::FixtureFile

#file_fixture_upload

Instance Attribute Details

#request ⇒ Object (readonly)

Returns the value of attribute request.



367
368
369
 
# File 'lib/action_controller/test_case.rb', line 367

def request
  @request
end

#response ⇒ Object (readonly)

Returns the value of attribute response.



367
368
369
 
# File 'lib/action_controller/test_case.rb', line 367

def response
  @response
end

Instance Method Details

#build_response(klass) ⇒ Object 



584
585
586
 
# File 'lib/action_controller/test_case.rb', line 584

def build_response(klass)
  klass.create
end

#controller_class_name ⇒ Object 



544
545
546
 
# File 'lib/action_controller/test_case.rb', line 544

def controller_class_name
  @controller.class.anonymous? ? "anonymous" : @controller.class.controller_path
end

#delete(action, **args) ⇒ Object

Simulate a DELETE request with the given parameters and set/volley the response. See ‘get` for more details.



455
456
457
 
# File 'lib/action_controller/test_case.rb', line 455

def delete(action, **args)
  process(action, method: "DELETE", **args)
end

#generated_path(generated_extras) ⇒ Object 



548
549
550
 
# File 'lib/action_controller/test_case.rb', line 548

def generated_path(generated_extras)
  generated_extras[0]
end

#get(action, **args) ⇒ Object

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 be `nil`.

  • ‘body`: The request body with a string that is appropriately encoded (`application/x-www-form-urlencoded` or `multipart/form-data`).

  • ‘session`: A hash of parameters to store in the session. This may be `nil`.

  • ‘flash`: A hash of parameters to store in the flash. This may be `nil`.

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.



429
430
431
432
433
 
# File 'lib/action_controller/test_case.rb', line 429

def get(action, **args)
  res = process(action, method: "GET", **args)
  cookies.update res.cookies
  res
end

#head(action, **args) ⇒ Object

Simulate a HEAD request with the given parameters and set/volley the response. See ‘get` for more details.



461
462
463
 
# File 'lib/action_controller/test_case.rb', line 461

def head(action, **args)
  process(action, method: "HEAD", **args)
end

#patch(action, **args) ⇒ Object

Simulate a PATCH request with the given parameters and set/volley the response. See ‘get` for more details.



443
444
445
 
# File 'lib/action_controller/test_case.rb', line 443

def patch(action, **args)
  process(action, method: "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.



437
438
439
 
# File '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) ⇒ Object

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 are `GET`, `POST`, `PATCH`, `PUT`, `DELETE`, `HEAD`. Defaults to `GET`. Can be a symbol.

  • ‘params`: The hash with HTTP parameters that you want to pass. This may be `nil`.

  • ‘body`: The request body with a string that is appropriately encoded (`application/x-www-form-urlencoded` or `multipart/form-data`).

  • ‘session`: A hash of parameters to store in the session. This may be `nil`.

  • ‘flash`: A hash of parameters to store in the flash. This may be `nil`.

  • ‘format`: Request format. Defaults to `nil`. Can be string or symbol.

  • ‘as`: Content type. Defaults to `nil`. 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: '[email protected]' }
  },
  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.



504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
 
# File '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

  cookies.update(@request.cookies)
  cookies.update_cookies_from_jar
  @request.set_header "HTTP_COOKIE", cookies.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, cookies, xhr)
end

#put(action, **args) ⇒ Object

Simulate a PUT request with the given parameters and set/volley the response. See ‘get` for more details.



449
450
451
 
# File 'lib/action_controller/test_case.rb', line 449

def put(action, **args)
  process(action, method: "PUT", **args)
end

#query_parameter_names(generated_extras) ⇒ Object 



552
553
554
 
# File 'lib/action_controller/test_case.rb', line 552

def query_parameter_names(generated_extras)
  generated_extras[1] + [:controller, :action]
end

#setup_controller_request_and_response ⇒ Object 



556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
 
# File '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