Class: ActionDispatch::Integration::Session

Inherits:
Object
  • Object
show all
Includes:
Assertions, RequestHelpers, Routing::UrlFor, TestProcess, Minitest::Assertions
Defined in:
actionpack/lib/action_dispatch/testing/integration.rb

Overview

An instance of this class represents a set of requests and responses performed sequentially by a test process. Because you can instantiate multiple sessions and run them side-by-side, you can also mimic (to some limited extent) multiple simultaneous users interacting with your system.

Typically, you will instantiate a new session using IntegrationTest#open_session, rather than instantiating Integration::Session directly.

Constant Summary collapse

DEFAULT_HOST =
"www.example.com"

Constants included from Assertions::ResponseAssertions

Assertions::ResponseAssertions::RESPONSE_PREDICATES

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Routing::UrlFor

#url_for

Methods included from ActiveSupport::Concern

#append_features, #class_methods, extended, #included

Methods included from Routing::PolymorphicRoutes

#polymorphic_path, #polymorphic_url

Methods included from TestProcess

#assigns, #flash, #redirect_to_url, #session

Methods included from TestProcess::FixtureFile

#fixture_file_upload

Methods included from RequestHelpers

#delete, #delete_via_redirect, #follow_redirect!, #get, #get_via_redirect, #head, #patch, #patch_via_redirect, #post, #post_via_redirect, #put, #put_via_redirect, #request_via_redirect, #xml_http_request

Methods included from Assertions

#html_document

Methods included from Assertions::RoutingAssertions

#assert_generates, #assert_recognizes, #assert_routing, #method_missing, #with_routing

Methods included from Assertions::ResponseAssertions

#assert_redirected_to, #assert_response

Constructor Details

#initialize(app) ⇒ Session

Create and initialize a new Session instance.


186
187
188
189
190
191
# File 'actionpack/lib/action_dispatch/testing/integration.rb', line 186

def initialize(app)
  super()
  @app = app

  reset!
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method in the class ActionDispatch::Assertions::RoutingAssertions

Instance Attribute Details

#acceptObject

The Accept header to send.


163
164
165
# File 'actionpack/lib/action_dispatch/testing/integration.rb', line 163

def accept
  @accept
end

#controllerObject (readonly)

A reference to the controller instance used by the last request.


172
173
174
# File 'actionpack/lib/action_dispatch/testing/integration.rb', line 172

def controller
  @controller
end

#hostObject

The hostname used in the last request.


154
155
156
# File 'actionpack/lib/action_dispatch/testing/integration.rb', line 154

def host
  @host || DEFAULT_HOST
end

#remote_addrObject

The remote_addr used in the last request.


160
161
162
# File 'actionpack/lib/action_dispatch/testing/integration.rb', line 160

def remote_addr
  @remote_addr
end

#requestObject (readonly)

A reference to the request instance used by the last request.


175
176
177
# File 'actionpack/lib/action_dispatch/testing/integration.rb', line 175

def request
  @request
end

#request_countObject

A running counter of the number of requests processed.


181
182
183
# File 'actionpack/lib/action_dispatch/testing/integration.rb', line 181

def request_count
  @request_count
end

#responseObject (readonly)

A reference to the response instance used by the last request.


178
179
180
# File 'actionpack/lib/action_dispatch/testing/integration.rb', line 178

def response
  @response
end

Instance Method Details

#cookiesObject

A map of the cookies returned by the last response, and which will be sent with the next request.


167
168
169
# File 'actionpack/lib/action_dispatch/testing/integration.rb', line 167

def cookies
  _mock_session.cookie_jar
end

#https!(flag = true) ⇒ Object

Specify whether or not the session should mimic a secure HTTPS request.

session.https!
session.https!(false)

234
235
236
# File 'actionpack/lib/action_dispatch/testing/integration.rb', line 234

def https!(flag = true)
  @https = flag
end

#https?Boolean

Returns true if the session is mimicking a secure HTTPS request.

if session.https?
  ...
end

Returns:

  • (Boolean)

243
244
245
# File 'actionpack/lib/action_dispatch/testing/integration.rb', line 243

def https?
  @https
end

#process(method, path, params: nil, headers: nil, env: nil, xhr: false, as: nil) ⇒ Object

Performs the actual request.

  • method: The HTTP method (GET, POST, PATCH, PUT, DELETE, HEAD, OPTIONS) as a symbol.

  • path: The URI (as a String) on which you want to perform the request.

  • params: 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).

  • headers: Additional headers to pass, as a Hash. The headers will be merged into the Rack env hash.

  • env: Additional env to pass, as a Hash. The headers will be merged into the Rack env hash.

This method is rarely used directly. Use #get, #post, or other standard HTTP methods in integration tests. #process is only required when using a request method that doesn't have a method defined in the integrations tests.

This method returns a Response object, which one can use to inspect the details of the response. Furthermore, if this method was called from an ActionDispatch::IntegrationTest object, then that object's @response instance variable will point to the same response object.

Example:

process :get, '/author', params: { since: 201501011400 }

276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
# File 'actionpack/lib/action_dispatch/testing/integration.rb', line 276

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

#reset!Object

Resets the instance. This can be used to reset the state information in an existing session instance, so it can be used from a clean-slate condition.

session.reset!

210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
# File 'actionpack/lib/action_dispatch/testing/integration.rb', line 210

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

#url_optionsObject


193
194
195
196
197
198
199
200
201
202
203
# File 'actionpack/lib/action_dispatch/testing/integration.rb', line 193

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