Class: ActionDispatch::Integration::Session

Inherits:
Object
  • Object
show all
Includes:
Assertions, RequestHelpers, Routing::UrlFor, TestProcess, Minitest::Assertions
Defined in:
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 Runner#open_session, rather than instantiating a 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

#full_url_for, #route_for, #url_for

Methods included from Routing::PolymorphicRoutes

#polymorphic_path, #polymorphic_url

Methods included from TestProcess

#assigns, #flash, #redirect_to_url, #session

Methods included from TestProcess::FixtureFile

#file_fixture_upload

Methods included from RequestHelpers

#delete, #follow_redirect!, #get, #head, #options, #patch, #post, #put

Methods included from Assertions

#html_document

Methods included from Assertions::RoutingAssertions

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

Methods included from Assertions::ResponseAssertions

#assert_redirected_to, #assert_response

Constructor Details

#initialize(app) ⇒ Session

Create and initialize a new Session instance.



133
134
135
136
137
138
 
# File 'lib/action_dispatch/testing/integration.rb', line 133

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

#accept ⇒ Object

The Accept header to send.



110
111
112
 
# File 'lib/action_dispatch/testing/integration.rb', line 110

def accept
  @accept
end

#controller ⇒ Object (readonly)

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



119
120
121
 
# File 'lib/action_dispatch/testing/integration.rb', line 119

def controller
  @controller
end

#host ⇒ Object

The hostname used in the last request.



101
102
103
 
# File 'lib/action_dispatch/testing/integration.rb', line 101

def host
  @host || DEFAULT_HOST
end

#remote_addr ⇒ Object

The remote_addr used in the last request.



107
108
109
 
# File 'lib/action_dispatch/testing/integration.rb', line 107

def remote_addr
  @remote_addr
end

#request ⇒ Object (readonly)

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



122
123
124
 
# File 'lib/action_dispatch/testing/integration.rb', line 122

def request
  @request
end

#request_count ⇒ Object

A running counter of the number of requests processed.



128
129
130
 
# File 'lib/action_dispatch/testing/integration.rb', line 128

def request_count
  @request_count
end

#response ⇒ Object (readonly)

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



125
126
127
 
# File 'lib/action_dispatch/testing/integration.rb', line 125

def response
  @response
end

Instance Method Details

#cookies ⇒ Object

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



114
115
116
 
# File 'lib/action_dispatch/testing/integration.rb', line 114

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)



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

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) 


189
190
191
 
# File 'lib/action_dispatch/testing/integration.rb', line 189

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.

  • ‘xhr`: Set to `true` if you want to make an Ajax request. Adds request headers characteristic of XMLHttpRequest e.g. HTTP_X_REQUESTED_WITH. The headers will be merged into the Rack env hash.

  • ‘as`: Used for encoding the request with different content type. Supports `:json` by default and will set the appropriate request headers. The headers will be merged into the Rack env hash.

This method is rarely used directly. Use RequestHelpers#get, RequestHelpers#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 integration tests.

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

Example:

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



225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
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
 
# File 'lib/action_dispatch/testing/integration.rb', line 225

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.include?("://")
    path = build_expanded_path(path) do |location|
      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
    end
  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,
    "HTTP_ACCEPT"    => request_encoder.accept_header || accept
  }

  if request_encoder.content_type
    request_env["CONTENT_TYPE"] = request_encoder.content_type
  end

  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.
  uri = build_full_uri(path, request_env)

  if method == :get && String === request_env[:params]
    # rack-test will needlessly parse and rebuild a :params
    # querystring, using Rack's query parser. At best that's a
    # waste of time; at worst it can change the value.

    uri << "?" << request_env.delete(:params)
  end

  session.request(uri, 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!



156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/action_dispatch/testing/integration.rb', line 156

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_options ⇒ Object 



140
141
142
143
144
145
146
147
148
149
150
 
# File 'lib/action_dispatch/testing/integration.rb', line 140

def url_options
  @url_options ||= default_url_options.dup.tap do |url_options|
    url_options.reverse_merge!(controller.url_options) if controller.respond_to?(:url_options)

    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