class ErrorTest
Same name in other branches
- 9 core/tests/Drupal/Tests/Core/Utility/ErrorTest.php \Drupal\Tests\Core\Utility\ErrorTest
- 8.9.x core/tests/Drupal/Tests/Core/Utility/ErrorTest.php \Drupal\Tests\Core\Utility\ErrorTest
- 10 core/tests/Drupal/Tests/Core/Utility/ErrorTest.php \Drupal\Tests\Core\Utility\ErrorTest
@coversDefaultClass \Drupal\Core\Utility\Error @group Utility
Hierarchy
- class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses \Drupal\Tests\PhpUnitCompatibilityTrait, \Prophecy\PhpUnit\ProphecyTrait, \Drupal\TestTools\Extension\DeprecationBridge\ExpectDeprecationTrait, \Drupal\Tests\RandomGeneratorTrait
- class \Drupal\Tests\Core\Utility\ErrorTest extends \Drupal\Tests\UnitTestCase
Expanded class hierarchy of ErrorTest
File
-
core/
tests/ Drupal/ Tests/ Core/ Utility/ ErrorTest.php, line 14
Namespace
Drupal\Tests\Core\UtilityView source
class ErrorTest extends UnitTestCase {
/**
* Tests the getLastCaller() method.
*
* @param array $backtrace
* The test backtrace array.
* @param array $expected
* The expected return array.
*
* @dataProvider providerTestGetLastCaller
*/
public function testGetLastCaller(array $backtrace, array $expected) : void {
$this->assertSame($expected, Error::getLastCaller($backtrace));
}
/**
* Data provider for testGetLastCaller.
*
* @return array
* An array of parameter data.
*/
public static function providerTestGetLastCaller() : array {
$data = [];
// Test with just one item. This should default to the function being
// main().
$single_item = [
self::createBacktraceItem(),
];
$data[] = [
$single_item,
self::createBacktraceItem('main()'),
];
// Add a second item, without a class.
$two_items = $single_item;
$two_items[] = self::createBacktraceItem('test_function_two');
$data[] = [
$two_items,
self::createBacktraceItem('test_function_two()'),
];
// Add a second item, with a class.
$two_items = $single_item;
$two_items[] = self::createBacktraceItem('test_function_two', 'TestClass');
$data[] = [
$two_items,
self::createBacktraceItem('TestClass->test_function_two()'),
];
// Add ignored functions to backtrace. They should get removed.
foreach ([
'debug',
'_drupal_error_handler',
'_drupal_exception_handler',
] as $function) {
$two_items = $single_item;
// Push to the start of the backtrace.
array_unshift($two_items, self::createBacktraceItem($function));
$data[] = [
$single_item,
self::createBacktraceItem('main()'),
];
}
return $data;
}
/**
* Tests the formatBacktrace() method.
*
* @param array $backtrace
* The test backtrace array.
* @param string $expected
* The expected backtrace as a string.
*
* @dataProvider providerTestFormatBacktrace
*/
public function testFormatBacktrace(array $backtrace, string $expected) : void {
$this->assertSame($expected, Error::formatBacktrace($backtrace));
}
/**
* Data provider for testFormatBacktrace.
*
* @return array
*/
public static function providerTestFormatBacktrace() : array {
$data = [];
// Test with no function, main should be in the backtrace.
$data[] = [
[
self::createBacktraceItem(NULL, NULL),
],
"main() (Line: 10)\n",
];
$base = [
self::createBacktraceItem(),
];
$data[] = [
$base,
"test_function() (Line: 10)\n",
];
// Add a second item.
$second_item = $base;
$second_item[] = self::createBacktraceItem('test_function_2');
$data[] = [
$second_item,
"test_function() (Line: 10)\ntest_function_2() (Line: 10)\n",
];
// Add a second item, with a class.
$second_item_class = $base;
$second_item_class[] = self::createBacktraceItem('test_function_2', 'TestClass');
$data[] = [
$second_item_class,
"test_function() (Line: 10)\nTestClass->test_function_2() (Line: 10)\n",
];
// Add a second item, with a class.
$second_item_args = $base;
$second_item_args[] = self::createBacktraceItem('test_function_2', NULL, [
'string',
10,
new \stdClass(),
]);
$data[] = [
$second_item_args,
"test_function() (Line: 10)\ntest_function_2('string', 10, Object) (Line: 10)\n",
];
return $data;
}
/**
* Creates a mock backtrace item.
*
* @param string|null $function
* (optional) The function name to use in the backtrace item.
* @param string|null $class
* (optional) The class to use in the backtrace item.
* @param array $args
* (optional) An array of function arguments to add to the backtrace item.
* @param int $line
* (optional) The line where the function was called.
*
* @return array
* A backtrace array item.
*/
protected static function createBacktraceItem(?string $function = 'test_function', ?string $class = NULL, array $args = [], int $line = 10) : array {
$backtrace = [
'file' => 'test_file',
'line' => $line,
'function' => $function,
'args' => [],
];
if (isset($class)) {
$backtrace['class'] = $class;
$backtrace['type'] = '->';
}
if (!empty($args)) {
$backtrace['args'] = $args;
}
return $backtrace;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|
ErrorTest::createBacktraceItem | protected static | function | Creates a mock backtrace item. | |
ErrorTest::providerTestFormatBacktrace | public static | function | Data provider for testFormatBacktrace. | |
ErrorTest::providerTestGetLastCaller | public static | function | Data provider for testGetLastCaller. | |
ErrorTest::testFormatBacktrace | public | function | Tests the formatBacktrace() method. | |
ErrorTest::testGetLastCaller | public | function | Tests the getLastCaller() method. | |
ExpectDeprecationTrait::expectDeprecation | public | function | Adds an expected deprecation. | |
ExpectDeprecationTrait::getCallableName | private static | function | Returns a callable as a string suitable for inclusion in a message. | |
ExpectDeprecationTrait::setUpErrorHandler | public | function | Sets up the test error handler. | |
ExpectDeprecationTrait::tearDownErrorHandler | public | function | Tears down the test error handler. | |
RandomGeneratorTrait::getRandomGenerator | protected | function | Gets the random generator for the utility methods. | |
RandomGeneratorTrait::randomMachineName | protected | function | Generates a unique random string containing letters and numbers. | |
RandomGeneratorTrait::randomObject | public | function | Generates a random PHP object. | |
RandomGeneratorTrait::randomString | public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |
UnitTestCase::$root | protected | property | The app root. | |
UnitTestCase::getClassResolverStub | protected | function | Returns a stub class resolver. | |
UnitTestCase::getConfigFactoryStub | public | function | Returns a stub config factory that behaves according to the passed array. | |
UnitTestCase::getConfigStorageStub | public | function | Returns a stub config storage that returns the supplied configuration. | |
UnitTestCase::getContainerWithCacheTagsInvalidator | protected | function | Sets up a container with a cache tags invalidator. | |
UnitTestCase::getStringTranslationStub | public | function | Returns a stub translation manager that just returns the passed string. | |
UnitTestCase::setUp | protected | function | 355 | |
UnitTestCase::setUpBeforeClass | public static | function |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.