跳至内容 跳至搜索

此类的一个实例表示一组由测试进程按顺序执行的请求和响应。因为您可以实例化多个会话并并行运行它们，所以您还可以模拟（在一定程度上）多个用户同时与您的系统交互。

通常，您将使用 Runner#open_session 实例化一个新的会话，而不是直接实例化一个 Session。

方法
C
H
N
P
R
U
包含的模块

常量

DEFAULT_HOST = "www.example.com"
 

属性

[RW] accept

要发送的 Accept 标头。
[R] controller

对上次请求使用的控制器实例的引用。
[W] host
[W] host!
[RW] remote_addr

上次请求中使用的 remote_addr。
[R] request

对上次请求使用的请求实例的引用。
[RW] request_count

已处理请求数的运行计数器。
[R] response

对上次请求使用的响应实例的引用。

类公共方法

new(app)

创建并初始化一个新的 Session 实例。

源代码： 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/testing/integration.rb, line 133
def initialize(app)
  super()
  @app = app

  reset!
end

实例公共方法

cookies()

上次响应返回的 cookie 的映射，这些 cookie 将与下一个请求一起发送。

源代码： 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/testing/integration.rb, line 114
def cookies
  _mock_session.cookie_jar
end

host()

上次请求中使用的主机名。

源代码： 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/testing/integration.rb, line 101
def host
  @host || DEFAULT_HOST
end

https!(flag = true)

指定会话是否应该模拟安全的 HTTPS 请求。

session.https!
session.https!(false)

源代码： 显示 | 在 GitHub 上

# File actionpack/lib/action_dispatch/testing/integration.rb, line 180
def https!(flag = true)
  @https = flag
end

https?()

如果会话正在模拟安全的 HTTPS 请求，则返回 true。

if session.https?
  ...
end

源代码： 显示 | 在 GitHub 上

# File actionpack/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)

执行实际的请求。

  • method：HTTP 方法（GET、POST、PATCH、PUT、DELETE、HEAD、OPTIONS）作为符号。

  • path：您想要执行请求的 URI（作为 String）。

  • params：您想要传递的 HTTP 参数。这可能是 nil、Hash 或 String，该字符串经过适当编码（application/x-www-form-urlencoded 或 multipart/form-data）。

  • headers：要传递的其他标头，作为 Hash。标头将合并到 Rack env 哈希中。

  • env：要传递的其他 env，作为 Hash。标头将合并到 Rack env 哈希中。

  • xhr：如果要进行 Ajax 请求，则设置为 true。添加 XMLHttpRequest 的特征请求标头，例如 HTTP_X_REQUESTED_WITH。标头将合并到 Rack env 哈希中。

  • as：用于使用不同的内容类型对请求进行编码。默认情况下支持 :json，并将设置相应的请求标头。标头将合并到 Rack env 哈希中。

此方法很少直接使用。在集成测试中使用 RequestHelpers#get、RequestHelpers#post 或其他标准 HTTP 方法。#process 仅在使用集成测试中未定义方法的请求方法时才需要。

此方法执行请求后返回响应状态。此外，如果此方法是从 ActionDispatch::IntegrationTest 对象调用的，那么该对象的 @response 实例变量将指向一个 Response 对象，可以使用该对象检查响应的详细信息。

示例：process :get, ‘/author’, params: { since: 201501011400 }

源代码： 显示 | 在 GitHub 上

# File actionpack/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!()

重置实例。这可以用于重置现有会话实例中的状态信息，以便它可以从一个干净的状态条件使用。

session.reset!

源代码： 显示 | 在 GitHub 上

# File actionpack/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()

源代码： 显示 | 在 GitHub 上

# File actionpack/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