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

Родитель:: Объект
Включенные модули:: ActionDispatch::Routing::UrlFor

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

Обычно вы создадите новую сессию, используя IntegrationTest#open_session, а не создавая Integration::Session напрямую.

Константы

DEFAULT_HOST

Атрибуты

accept[RW]

Заголовок Accept, который необходимо отправить.

controller[R]

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

host[W]

host![W]

remote_addr[RW]

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

request[R]

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

request_count[RW]

Текущий счётчик количества обработанных запросов.

response[R]

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

Публичные методы класса

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

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

  reset!
end

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

Вызывает метод родительского класса ActionDispatch::Routing::UrlFor::new

Публичные методы экземпляра

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

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

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

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

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

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

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

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

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

session.https!
session.https!(false)

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

# File actionpack/lib/action_dispatch/testing/integration.rb, line 183
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 220
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 %r{://}.match?(path)
    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,
    "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

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

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

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

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

Пример:

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

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

# File actionpack/lib/action_dispatch/testing/integration.rb, line 150
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

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

session.reset!

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

# File actionpack/lib/action_dispatch/testing/integration.rb, line 133
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