Module: ActionController::TestCase::Behavior

Extended by:
ActiveSupport::Concern
Includes:
ActionDispatch::TestProcess, ActiveSupport::Testing::ConstantLookup
Included in:
ActionController::TestCase
Defined in:
actionpack/lib/action_controller/test_case.rb

Defined Under Namespace

Modules: ClassMethods

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from ActiveSupport::Concern

append_features, extended, included

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



434
435
436
 
# File 'actionpack/lib/action_controller/test_case.rb', line 434

def request
  @request
end

#response ⇒ Object (readonly)

Returns the value of attribute response



434
435
436
 
# File 'actionpack/lib/action_controller/test_case.rb', line 434

def response
  @response
end

Instance Method Details

#build_request ⇒ Object 



638
639
640
 
# File 'actionpack/lib/action_controller/test_case.rb', line 638

def build_request
  TestRequest.new
end

#build_response(klass) ⇒ Object 



642
643
644
 
# File 'actionpack/lib/action_controller/test_case.rb', line 642

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.



518
519
520
 
# File 'actionpack/lib/action_controller/test_case.rb', line 518

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 be nil, a hash, or 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, HEAD, and OPTIONS requests with post, patch, put, delete, head, and options.

Note that the request method is not verified. The different methods are available to make the tests more expressive.



494
495
496
 
# File 'actionpack/lib/action_controller/test_case.rb', line 494

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.



524
525
526
 
# File 'actionpack/lib/action_controller/test_case.rb', line 524

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

#paramify_values(hash_or_array_or_value) ⇒ Object 



538
539
540
541
542
543
544
545
546
547
548
549
 
# File 'actionpack/lib/action_controller/test_case.rb', line 538

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.



506
507
508
 
# File 'actionpack/lib/action_controller/test_case.rb', line 506

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.



500
501
502
 
# File 'actionpack/lib/action_controller/test_case.rb', line 500

def post(action, *args)
  process(action, "POST", *args)
end

#process(action, http_method = 'GET', *args) ⇒ Object 



551
552
553
554
555
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
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
 
# File 'actionpack/lib/action_controller/test_case.rb', line 551

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

  # 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

  unless @controller.respond_to?(:recycle!)
    @controller.extend(Testing::Functional)
    @controller.class.class_eval { include Testing }
  end

  @request.recycle!
  @response.recycle!
  @controller.recycle!

  @request.env['REQUEST_METHOD'] = http_method

  parameters ||= {}
  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 cookies = @request.env['action_dispatch.cookies']
    unless @response.committed?
      cookies.write(@response)
    end
  end
  @response.prepare!

  @assigns = @controller.respond_to?(:view_assigns) ? @controller.view_assigns : {}
  @request.session['flash'] = @request.flash.to_session_value
  @request.session.delete('flash') if @request.session['flash'].blank?
  @response
end

#put(action, *args) ⇒ Object

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



512
513
514
 
# File 'actionpack/lib/action_controller/test_case.rb', line 512

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

#setup_controller_request_and_response ⇒ Object 



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
 
# File 'actionpack/lib/action_controller/test_case.rb', line 610

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 



528
529
530
531
532
533
534
535
 
# File 'actionpack/lib/action_controller/test_case.rb', line 528

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