класс ActionDispatch::Integration::Session

Родительский класс:: Object
Подключённые модули:: ActionDispatch::Routing::UrlFor

Экземпляр этого класса представляет набор запросов и ответов, последовательно выполняемых тестовым процессом. Поскольку можно создавать несколько сессий и запускать их параллельно, можно также имитировать (в некоторой степени) взаимодействие нескольких пользователей с системой одновременно.

Как правило, новую сессию создают с помощью Runner#open_session, а не создают экземпляр Session напрямую.

Константы

DEFAULT_HOST

Атрибуты

accept [RW]

Заголовок Accept, который нужно отправить.

controller [R]

Ссылка на экземпляр контроллера, использованный в последнем запросе.

host [W]

host! [W]

remote_addr [RW]

remote_addr, использованный в последнем запросе.

request [R]

Ссылка на экземпляр запроса, использованный в последнем запросе.

request_count [RW]

Счётчик обработанных запросов.

response [R]

Ссылка на экземпляр ответа, использованный в последнем запросе.

Общедоступные методы класса

new (app) Показать исходный код

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

  reset!
end

Создаёт и инициализирует новый экземпляр Session.

Вызывает метод суперкласса ActionDispatch::Routing::UrlFor::new

Общедоступные методы экземпляра

cookies () Показать исходный код

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

Хеш файлов cookie, полученных в последнем ответе и отправляемых со следующим запросом.

host () Показать исходный код

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

Имя хоста, использованное в последнем запросе.

https! (flag = true) Показать исходный код

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

Указывает, должна ли сессия имитировать защищённый HTTPS-запрос.

session.https!
session.https!(false)

https? () Показать исходный код

# File actionpack/lib/action_dispatch/testing/integration.rb, line 189
def https?
  @https
end

Возвращает true, если сессия имитирует защищённый HTTPS-запрос.

if session.https?
  ...
end

process (method, path, params: nil, headers: nil, env: nil, xhr: false, as: nil) Показать исходный код

# 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

Выполняет фактический запрос.

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: Дополнительные параметры окружения для передачи в виде Hash. Заголовки будут объединены с хешем окружения Rack.
xhr: Установите значение true, чтобы выполнить Ajax-запрос. Добавляет характерные для XMLHttpRequest заголовки запроса, например HTTP_X_REQUESTED_WITH. Заголовки будут объединены с хешем окружения Rack.
as: Используется для кодирования запроса с другим типом содержимого. По умолчанию поддерживается :json и устанавливаются соответствующие заголовки запроса. Заголовки будут объединены с хешем окружения Rack.

Этот метод редко используется напрямую. В интеграционных тестах используйте RequestHelpers#get, RequestHelpers#post или другие стандартные методы HTTP. process нужен только при использовании метода запроса, для которого в интеграционных тестах не определён отдельный метод.

Этот метод возвращает статус ответа после выполнения запроса. Кроме того, если метод был вызван из объекта ActionDispatch::IntegrationTest, его переменная экземпляра @response будет указывать на объект Response, который можно использовать для изучения сведений об ответе.

Пример: process :get, ‘/author’, params: { since: 201501011400 }

reset! () Показать исходный код

# 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

Сбрасывает состояние экземпляра. Это можно использовать для сброса данных о состоянии существующего экземпляра сессии, чтобы начать работу с ним с чистого листа.

session.reset!

url_options () Показать исходный код

# 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