Class: ActionDispatch::Integration::Session

Inherits:
Object
  • Object
show all
Includes:
Assertions, RequestHelpers, Routing::UrlFor, TestProcess, Test::Unit::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

DEFAULT_HOST =
"www.example.com"

Constants included from Assertions

Assertions::NO_STRIP

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Routing::UrlFor

#url_for, #url_options

Methods included from ActiveSupport::Concern

#append_features, extended, #included

Methods included from Routing::PolymorphicRoutes

#polymorphic_path, #polymorphic_url

Methods included from TestProcess

#assigns, #fixture_file_upload, #flash, #redirect_to_url, #session

Methods included from RequestHelpers

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

Methods included from Assertions::TagAssertions

#assert_no_tag, #assert_tag, #find_all_tag, #find_tag, #html_document

Methods included from Assertions::SelectorAssertions

#assert_select, #assert_select_email, #assert_select_encoded, #count_description, #css_select

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

Methods included from Assertions::DomAssertions

#assert_dom_equal, #assert_dom_not_equal

Constructor Details

#initialize(app) ⇒ Session

Create and initialize a new Session instance.



174
175
176
177
178
179
180
181
182
183
184
185
# File 'actionpack/lib/action_dispatch/testing/integration.rb', line 174

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

  # If the app is a Rails app, make url_helpers available on the session
  # This makes app.url_for and app.foo_path available in the console
  if app.respond_to?(:routes) && app.routes.respond_to?(:url_helpers)
    singleton_class.class_eval { include app.routes.url_helpers }
  end

  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.



151
152
153
# File 'actionpack/lib/action_dispatch/testing/integration.rb', line 151

def accept
  @accept
end

#controllerObject (readonly)

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



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

def controller
  @controller
end

#hostObject

The hostname used in the last request.



142
143
144
# File 'actionpack/lib/action_dispatch/testing/integration.rb', line 142

def host
  @host || DEFAULT_HOST
end

#remote_addrObject

The remote_addr used in the last request.



148
149
150
# File 'actionpack/lib/action_dispatch/testing/integration.rb', line 148

def remote_addr
  @remote_addr
end

#requestObject (readonly)

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



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

def request
  @request
end

#request_countObject

A running counter of the number of requests processed.



169
170
171
# File 'actionpack/lib/action_dispatch/testing/integration.rb', line 169

def request_count
  @request_count
end

#responseObject (readonly)

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



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

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.



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

def cookies
  _mock_session.cookie_jar
end

#default_url_optionsObject



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

def default_url_options
  { :host => host, :protocol => https? ? "https" : "http" }
end

#https!(flag = true) ⇒ Object

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

session.https!
session.https!(false)


223
224
225
# File 'actionpack/lib/action_dispatch/testing/integration.rb', line 223

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

#https?Boolean

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

if session.https?
  ...
end

Returns:

  • (Boolean)


232
233
234
# File 'actionpack/lib/action_dispatch/testing/integration.rb', line 232

def https?
  @https
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!


197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
# File 'actionpack/lib/action_dispatch/testing/integration.rb', line 197

def reset!
  @https = false
  @controller = @request = @response = nil
  @_mock_session = nil
  @request_count = 0

  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
    # install the named routes in this session instance.
    klass = singleton_class

    # the helpers are made protected by default--we make them public for
    # easier access during testing and troubleshooting.
    @named_routes_configured = true
  end
end