trait ExpectDeprecationTrait
Same name and namespace in other branches
- 9 core/tests/Drupal/Tests/Traits/ExpectDeprecationTrait.php \Drupal\Tests\Traits\ExpectDeprecationTrait
- 8.9.x core/tests/Drupal/Tests/Traits/ExpectDeprecationTrait.php \Drupal\Tests\Traits\ExpectDeprecationTrait
A trait to include in Drupal tests to manage expected deprecations.
This code works in coordination with DeprecationHandler.
This trait is a replacement for symfony/phpunit-bridge that is not supporting PHPUnit 10. In the future this extension might be dropped if PHPUnit will support all deprecation management needs.
@internal
Hierarchy
- trait \Drupal\TestTools\Extension\DeprecationBridge\ExpectDeprecationTrait
See also
\Drupal\TestTools\Extension\DeprecationBridge\DeprecationHandler
13 files declare their use of ExpectDeprecationTrait
- BrowserTestBase.php in core/
tests/ Drupal/ Tests/ BrowserTestBase.php - BytesTest.php in core/
tests/ Drupal/ Tests/ Component/ Utility/ BytesTest.php - ContainerTest.php in core/
tests/ Drupal/ Tests/ Component/ DependencyInjection/ ContainerTest.php - ExpectDeprecationTest.php in core/
tests/ Drupal/ Tests/ ExpectDeprecationTest.php - FileStorageReadOnlyTest.php in core/
tests/ Drupal/ Tests/ Component/ PhpStorage/ FileStorageReadOnlyTest.php
File
-
core/
tests/ Drupal/ TestTools/ Extension/ DeprecationBridge/ ExpectDeprecationTrait.php, line 25
Namespace
Drupal\TestTools\Extension\DeprecationBridgeView source
trait ExpectDeprecationTrait {
/**
* Sets up the test error handler.
*
* This method is run before each test's ::setUp() method, and when the
* DeprecationHandler is active, resets the extension to be able to collect
* the test's deprecations, and sets TestErrorHandler as the current error
* handler.
*
* @see \Drupal\TestTools\ErrorHandler\TestErrorHandler
*/
public function setUpErrorHandler() : void {
if (!DeprecationHandler::isEnabled()) {
return;
}
DeprecationHandler::reset();
set_error_handler(new TestErrorHandler(Error::currentErrorHandler(), $this));
}
/**
* Tears down the test error handler.
*
* This method is run after each test's ::tearDown() method, and checks if
* collected deprecations match the expectations; it also resets the error
* handler to the one set prior of the change made by ::setUpErrorHandler().
*/
public function tearDownErrorHandler() : void {
if (!DeprecationHandler::isEnabled()) {
return;
}
// We expect that the current error handler is the one set by
// ::setUpErrorHandler() prior to the start of the test execution. If not,
// the error handler was changed during the test execution but not properly
// restored during ::tearDown().
$handler = Error::currentErrorHandler();
if (!$handler instanceof TestErrorHandler) {
throw new \RuntimeException(sprintf('%s registered its own error handler without restoring the previous one before or during tear down. This can cause unpredictable test results. Ensure the test cleans up after itself.', $this->name()));
}
restore_error_handler();
// Checks if collected deprecations match the expectations.
if (DeprecationHandler::getExpectedDeprecations()) {
$prefix = "@expectedDeprecation:\n";
$expDep = $prefix . '%A ' . implode("\n%A ", DeprecationHandler::getExpectedDeprecations()) . "\n%A";
$actDep = $prefix . ' ' . implode("\n ", DeprecationHandler::getCollectedDeprecations()) . "\n";
$this->assertStringMatchesFormat($expDep, $actDep);
}
}
/**
* Adds an expected deprecation.
*
* @param string $message
* The expected deprecation message.
*/
public function expectDeprecation(string $message) : void {
if (!DeprecationHandler::isDeprecationTest($this)) {
throw new \RuntimeException('expectDeprecation() can only be called from tests marked with #[IgnoreDeprecations] or \'@group legacy\'');
}
if (!DeprecationHandler::isEnabled()) {
return;
}
DeprecationHandler::expectDeprecation($message);
}
}
Members
Title Sort descending | Modifiers | Object type | Summary |
---|---|---|---|
ExpectDeprecationTrait::expectDeprecation | public | function | Adds an expected deprecation. |
ExpectDeprecationTrait::setUpErrorHandler | public | function | Sets up the test error handler. |
ExpectDeprecationTrait::tearDownErrorHandler | public | function | Tears down the test error handler. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.