ErrorHandlerTest.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Core\Tests\Functional\Error;
 
use PHPUnit\Framework\Attributes\Test;
use ‪TYPO3\CMS\Core\Error\ErrorHandler;
use ‪TYPO3\CMS\Core\Log\Logger;
use ‪TYPO3\CMS\Core\Log\LogManager;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\TestingFramework\Core\Functional\FunctionalTestCase;
 
final class ‪ErrorHandlerTest extends FunctionalTestCase
{
    protected bool ‪$initializeDatabase = false;
 
    protected array ‪$configurationToUseInTestInstance = [
        'SYS' => [
            'errorHandler' => ErrorHandler::class,
        ],
    ];
 
    public function ‪tearDown(): void
    {
        // Unset errorHandler instance configured for this test case
        restore_error_handler();
        parent::tearDown();
    }
 
    #[Test]
    public function ‪handleErrorFetchesDeprecations(): void
    {
        trigger_error(
            'The first error triggers database connection to be initialized and should be caught.',
            E_USER_DEPRECATED
        );
        trigger_error(
            'The second error should be caught by ErrorHandler as well.',
            E_USER_DEPRECATED
        );
        self::assertTrue(true);
    }
 
    #[Test]
    public function ‪handleErrorOnlyHandlesRegisteredErrorLevels(): void
    {
        // Make sure the core error handler does not return due to error_reporting being 0
        self::assertNotSame(0, error_reporting());
 
        // Make sure the core error handler does not return true due to a deprecation error
        $logManagerMock = $this->createMock(LogManager::class);
        $logManagerMock->expects(self::never())->method('getLogger')->with('TYPO3.CMS.deprecations');
        GeneralUtility::setSingletonInstance(LogManager::class, $logManagerMock);
 
        $logger = $this->getMockBuilder(Logger::class)
            ->disableOriginalConstructor()
            ->onlyMethods(['log'])
            ->getMock();
 
        // Make sure the assigned logger does not log
        $logger->expects(self::never())->method('log');
 
        $coreErrorHandler = new ‪ErrorHandler(
            E_ALL & ~(E_STRICT | E_NOTICE | E_COMPILE_WARNING | E_COMPILE_ERROR | E_CORE_WARNING | E_CORE_ERROR | E_PARSE | E_ERROR)
        );
        $coreErrorHandler->setLogger($logger);
 
        $customErrorHandler = new class () {
            protected $existingHandler;
 
            public function setExistingHandler($existingHandler): void
            {
                $this->existingHandler = $existingHandler;
            }
 
            public function handleError(int $code, string $message, string $file = '', int $line = 0, array $context = []): mixed
            {
                // process errors
                if ($this->existingHandler !== null) {
                    return ($this->existingHandler)($code, $message, $file, $line, $context);
                }
 
                return false;
            }
        };
 
        $existingHandler = set_error_handler([$customErrorHandler, 'handleError'], E_ALL);
        $customErrorHandler->setExistingHandler($existingHandler);
 
        // This assertion is the base assertion but as \TYPO3\CMS\Core\Error\ErrorHandler::handleError has a few return
        // points that return true, the expectation on dependency objects are in place. We want to be sure that the
        // first return point is used by checking that the method does not log anything, which happens before later
        // return points that return true.
        self::assertTrue($customErrorHandler->handleError(E_NOTICE, 'Notice error message', __FILE__, __LINE__));
 
        // Unset the closure error handler again
        restore_error_handler();
    }
}