Error Handler — ошибки PHP в тестах
Предупреждения, нотисы и депрекейты PHP не прерывают выполнение кода: тест проходит, а ошибка теряется где-то в выводе раннера. Плагин ловит такие ошибки в каждом тесте и выводит их в канал stderr рядом с тестом, который их вызвал. По желанию любая такая ошибка может валить тест.
Плагин поставляется вместе с testo/testo и подключается в каждый Test Suite по умолчанию.
Класс плагина: ErrorHandlerPlugin\Testo\ErrorHandler\ErrorHandlerPlugin. Входит в SuitePlugins\Testo\Application\Config\Plugin\SuitePlugins по умолчанию.
Как ловятся ошибки
Перед стартом теста плагин ставит свой обработчик ошибок, а после теста снимает его. Обработчик, который был установлен до этого, например в бутстрапе приложения, продолжает работать: каждая ошибка сначала уходит к нему. Ошибки, подавленные через @ или исключённые в error_reporting(), плагин не трогает.
Ошибки из хуков #[BeforeTest] и #[AfterTest] относятся к тесту так же, как ошибки из его тела. Хуки #[BeforeClass] и #[AfterClass] выполняются вне тестов, и их ошибки плагин не ловит.
Падение теста на ошибке
ErrorHandlerPlugin::__construct
Перехватывает ошибки PHP в каждом тесте Test Suite.
ErrorHandlerPlugin::__construct(bool $failOnError = false)По умолчанию ошибки только выводятся, и статус теста от них не меняется. С failOnError: true прошедший тест, в котором была ошибка, получает статус Status::Failed\Testo\Core\Value\Status::Failed, а причиной падения становится первая ошибка.
Параметры:
$failOnError- Валить прошедший тест, если в нём была хотя бы одна ошибка PHP.
Примеры:
use Testo\Application\Config\ApplicationConfig;
use Testo\Application\Config\SuiteConfig;
use Testo\ErrorHandler\ErrorHandlerPlugin;
return new ApplicationConfig(
suites: [
new SuiteConfig(
name: 'Unit',
location: ['tests/Unit'],
plugins: [new ErrorHandlerPlugin(failOnError: true)],
),
],
);Обработчик плагина всегда на стеке
Пока выполняется тест, обработчик плагина установлен, поэтому set_error_handler() внутри теста всегда возвращает предыдущий обработчик, даже если приложение никаких обработчиков не ставило.
Код, который по результату set_error_handler() решает, есть ли уже обработчик, под плагином ведёт себя иначе, чем в продакшене: ветка «предыдущего обработчика нет» в тесте не выполнится. Если тест проверяет именно её, отключите для него плагин атрибутом #[WithoutErrorHandler]#[WithoutErrorHandler]Выводит тест из-под действия плагина..
Тесты, которые меняют стек обработчиков
После каждого теста плагин возвращает стек обработчиков в исходное состояние, чтобы обработчик, забытый одним тестом, не перехватывал ошибки следующих. Если тест оставил свой обработчик на стеке или снял чужой, он получает статус Status::Risky\Testo\Core\Value\Status::Risky. Тест, который сам снимает поставленный обработчик, ничего объявлять не должен.
#[ExpectErrorHandlerChange]
Объявляет, что тест намеренно меняет стек обработчиков ошибок.
#[ExpectErrorHandlerChange]Нужен тестам, которые проверяют установку обработчика ошибок, например бутстрап приложения. С атрибутом такой тест не получает статус Status::Risky\Testo\Core\Value\Status::Risky. Если же помеченный тест стек не изменил, он падает: объявление не соответствует действительности.
Атрибут можно повесить на метод, функцию или класс.
Примеры:
use Testo\ErrorHandler\ExpectErrorHandlerChange;
#[Test]
#[ExpectErrorHandlerChange]
public function registersTheApplicationHandler(): void
{
$app->registerErrorHandler();
// ...
}Как отключить плагин
#[WithoutErrorHandler]
Выводит тест из-под действия плагина.
#[WithoutErrorHandler]Для помеченного теста плагин не ставит обработчик и ничего не проверяет: тест видит обработку ошибок такой, какая она есть в процессе, и set_error_handler() возвращает null, если до теста обработчиков не было.
Атрибут можно повесить на метод, функцию или класс. Всё, что такой тест оставит на стеке, достанется следующим тестам, поэтому убирать за собой он должен сам.
Примеры:
use Testo\ErrorHandler\WithoutErrorHandler;
#[Test]
#[WithoutErrorHandler]
public function fallsBackWithoutPreviousHandler(): void
{
// ...
}Чтобы отключить плагин для всего Test Suite, уберите его из стандартного набора в testo.php:
use Testo\Application\Config\Plugin\SuitePlugins;
use Testo\Application\Config\SuiteConfig;
use Testo\ErrorHandler\ErrorHandlerPlugin;
new SuiteConfig(
name: 'Legacy',
location: ['tests/Legacy'],
plugins: SuitePlugins::without(ErrorHandlerPlugin::class),
),