class ActionDispatch::Integration::Session
Integration::Session directly.
IntegrationTest#open_session, rather than instantiating
Typically, you will instantiate a new session using
limited extent) multiple simultaneous users interacting with your system.
multiple sessions and run them side-by-side, you can also mimic (to some
performed sequentially by a test process. Because you can instantiate
An instance of this class represents a set of requests and responses
def _mock_session
def _mock_session @_mock_session ||= Rack::MockSession.new(@app, host) end
def build_full_uri(path, env)
def build_full_uri(path, env) "#{env['rack.url_scheme']}://#{env['SERVER_NAME']}:#{env['SERVER_PORT']}#{path}" end
def cookies
A map of the cookies returned by the last response, and which will be
def cookies _mock_session.cookie_jar end
def host
def host @host || DEFAULT_HOST end
def https!(flag = true)
session.https!
Specify whether or not the session should mimic a secure HTTPS request.
def https!(flag = true) @https = flag end
def https?
...
if session.https?
Returns +true+ if the session is mimicking a secure HTTPS request.
def https? @https end
def initialize(app)
def initialize(app) super() @app = app reset! end
def kwarg_request?(args)
def kwarg_request?(args) args[0].respond_to?(:keys) && args[0].keys.any? { |k| REQUEST_KWARGS.include?(k) } end
def non_kwarg_request_warning
def non_kwarg_request_warning ActiveSupport::Deprecation.warn(<<-MSG.strip_heredoc) Using positional arguments in integration tests has been deprecated, in favor of keyword arguments, and will be removed in Rails 5.1. Deprecated style: get "/profile", { id: 1 }, { "X-Extra-Header" => "123" } New keyword style: get "/profile", params: { id: 1 }, headers: { "X-Extra-Header" => "123" } MSG end
def process(method, path, params: nil, headers: nil, env: nil, xhr: false, as: nil)
Example:
response object.
object's @response instance variable will point to the same
called from an ActionDispatch::IntegrationTest object, then that
inspect the details of the response. Furthermore, if this method was
This method returns a Response object, which one can use to
request method that doesn't have a method defined in the integrations tests.
HTTP methods in integration tests. +#process+ is only required when using a
This method is rarely used directly. Use +#get+, +#post+, or other standard
merged into the Rack env hash.
- +env+: Additional env to pass, as a Hash. The headers will be
merged into the Rack env hash.
- +headers+: Additional headers to pass, as a Hash. The headers will be
multipart/form-data).
(application/x-www-form-urlencoded or
a Hash, or a String that is appropriately encoded
be +nil+,
- +params+: The HTTP parameters that you want to pass. This may
request.
- +path+: The URI (as a String) on which you want to perform the
as a symbol.
- +method+: The HTTP method (GET, POST, PATCH, PUT, DELETE, HEAD, OPTIONS)
Performs the actual request.
def process(method, path, params: nil, headers: nil, env: nil, xhr: false, as: nil) request_encoder = RequestEncoder.encoder(as) headers ||= {} if method == :get && as == :json && params headers['X-Http-Method-Override'] = 'GET' method = :post end if path =~ %r{://} location = URI.parse(path) https! URI::HTTPS === location if location.scheme if url_host = location.host default = Rack::Request::DEFAULT_PORTS[location.scheme] url_host += ":#{location.port}" if default != location.port host! url_host end path = location.query ? "#{location.path}?#{location.query}" : location.path end hostname, port = host.split(':') request_env = { :method => method, :params => request_encoder.encode_params(params), "SERVER_NAME" => hostname, "SERVER_PORT" => port || (https? ? "443" : "80"), "HTTPS" => https? ? "on" : "off", "rack.url_scheme" => https? ? "https" : "http", "REQUEST_URI" => path, "HTTP_HOST" => host, "REMOTE_ADDR" => remote_addr, "CONTENT_TYPE" => request_encoder.content_type, "HTTP_ACCEPT" => request_encoder.accept_header || accept } wrapped_headers = Http::Headers.from_hash({}) wrapped_headers.merge!(headers) if headers if xhr wrapped_headers["HTTP_X_REQUESTED_WITH"] = "XMLHttpRequest" wrapped_headers["HTTP_ACCEPT"] ||= [Mime[:js], Mime[:html], Mime[:xml], "text/xml", "*/*"].join(", ") end # this modifies the passed request_env directly if wrapped_headers.present? Http::Headers.from_hash(request_env).merge!(wrapped_headers) end if env.present? Http::Headers.from_hash(request_env).merge!(env) end session = Rack::Test::Session.new(_mock_session) # NOTE: rack-test v0.5 doesn't build a default uri correctly # Make sure requested path is always a full uri session.request(build_full_uri(path, request_env), request_env) @request_count += 1 @request = ActionDispatch::Request.new(session.last_request.env) response = _mock_session.last_response @response = ActionDispatch::TestResponse.from_response(response) @response.request = @request @html_document = nil @url_options = nil @controller = @request.controller_instance response.status end
def process_with_kwargs(http_method, path, *args)
def process_with_kwargs(http_method, path, *args) if kwarg_request?(args) process(http_method, path, *args) else non_kwarg_request_warning if args.any? process(http_method, path, { params: args[0], headers: args[1] }) end end
def reset!
condition.
in an existing session instance, so it can be used from a clean-slate
Resets the instance. This can be used to reset the state information
def reset! @https = false @controller = @request = @response = nil @_mock_session = nil @request_count = 0 @url_options = nil self.host = DEFAULT_HOST self.remote_addr = "127.0.0.1" self.accept = "text/xml,application/xml,application/xhtml+xml," + "text/html;q=0.9,text/plain;q=0.8,image/png," + "*/*;q=0.5" unless defined? @named_routes_configured # the helpers are made protected by default--we make them public for # easier access during testing and troubleshooting. @named_routes_configured = true end end
def url_options
def url_options @url_options ||= default_url_options.dup.tap do |url_options| url_options.reverse_merge!(controller.url_options) if controller if @app.respond_to?(:routes) url_options.reverse_merge!(@app.routes.default_url_options) end url_options.reverse_merge!(:host => host, :protocol => https? ? "https" : "http") end end