класс ActionController::TestCase

Родитель:: ActiveSupport::TestCase
Включенные модули:: ActionController::TestCase::Behavior

Базовый класс для функциональных тестов ActionController. Функциональные тесты позволяют тестировать одно действие контроллера в каждом методе теста.

Используйте интеграционные тесты контроллера вместо функциональных.

В Rails использование функциональных тестов не рекомендуется в пользу интеграционных тестов (используйте ActionDispatch::IntegrationTest).

Новые приложения Rails больше не генерируют функциональные тесты контроллеров, и они должны использоваться только для обратной совместимости. Интеграционные тесты контроллеров выполняют реальные запросы, в то время как функциональные тесты просто имитируют запрос. Кроме того, интеграционные тесты работают так же быстро, как и функциональные, и предоставляют множество вспомогательных функций, таких как as, parsed_body, для эффективного тестирования действий контроллера, включая даже API-эндпоинты.

Пример

Функциональные тесты записываются следующим образом:

Сначала используется метод get, post, patch, put, delete или head для имитации HTTP-запроса.
Затем проверяется, соответствует ли текущее состояние ожидаемому. «Состояние» может быть чем угодно: HTTP-ответом контроллера, содержимым базы данных и т. д.

Например:

class BooksControllerTest < ActionController::TestCase
  def test_create
    # Simulate a POST response with the given HTTP parameters.
    post(:create, params: { book: { title: "Love Hina" }})

    # Asserts that the controller tried to redirect us to
    # the created book's URI.
    assert_response :found

    # Asserts that the controller really put the book in the database.
    assert_not_nil Book.find_by(title: "Love Hina")
  end
end

Вы также можете отправить реальный документ в имитируемый HTTP-запрос.

def test_create
  json = {book: { title: "Love Hina" }}.to_json
  post :create, json
end

Специальные переменные экземпляра

ActionController::TestCase также автоматически предоставит следующие переменные экземпляра для использования в тестах:

@controller: Экземпляр контроллера, который будет тестироваться.
@request: ActionController::TestRequest, представляющий текущий HTTP-запрос. Вы можете изменить этот объект перед отправкой HTTP-запроса. Например, вы можете установить некоторые свойства сеанса перед отправкой запроса GET.
@response: Объект ActionDispatch::TestResponse, представляющий ответ последнего HTTP-ответа. В приведенном выше примере @response становится допустимым после вызова post. Если различных методов проверки недостаточно, вы можете использовать этот объект для детального анализа HTTP-ответа.

(В более ранних версиях Rails каждый функциональный тест должен был быть подклассом Test::Unit::TestCase и определять @controller, @request, @response в setup.)

Контроллер автоматически определяется

ActionController::TestCase автоматически определит контроллер, подлежащий тестированию, по имени класса теста. Если контроллер невозможно определить по имени класса теста, вы можете явно задать его с помощью tests.

class SpecialEdgeCaseWidgetsControllerTest < ActionController::TestCase
  tests WidgetController
end

Тестирование внутренних частей контроллера

В дополнение к этим специфическим проверкам, вы также можете легко получить доступ к различным коллекциям, к которым могут применяться обычные проверки test/unit. Эти коллекции:

session: Объекты, сохраненные в сеансе.
flash: Объекты flash, текущие в сеансе.
cookies: Куки, отправляемые пользователю в этом запросе.

Эти коллекции могут быть использованы как любой другой хэш:

assert_equal "Dave", cookies[:name] # makes sure that a cookie called :name was set as "Dave"
assert flash.empty? # makes sure that there's nothing in the flash

Помимо коллекций, вы имеете доступ к полному URL, на который перенаправило данное действие, в redirect_to_url.

Для перенаправлений внутри того же контроллера вы можете вызвать follow_redirect, и перенаправление будет выполнено, вызвав другое действие, которое затем можно проверить.

Иногда вам нужно настроить переменные сеанса и куки для теста. Для этого просто присвойте значение коллекции сеанса или куки:

session[:key] = "value"
cookies[:key] = "value"

Для очистки куки в тесте просто очистите коллекцию куки:

cookies.clear

Тестирование именованных маршрутов

Если вы используете именованные маршруты, их можно легко протестировать с помощью оригинальных методов именованных маршрутов непосредственно в тестовом случае.

assert_redirected_to page_url(title: 'foo')