IntrospectionProcessorTest.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\Unit\Log\Processor;
 
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use PHPUnit\Framework\MockObject\MockObject;
use Psr\Log\LogLevel;
use ‪TYPO3\CMS\Core\Log\LogRecord;
use ‪TYPO3\CMS\Core\Log\Processor\IntrospectionProcessor;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
final class ‪IntrospectionProcessorTest extends UnitTestCase
{
    protected ‪IntrospectionProcessor&MockObject ‪$processor;
 
    protected array ‪$dummyBacktrace = [
        [
            'file' => '/foo/filename1.php',
            'line' => 1,
            'class' => 'class1',
            'function' => 'function1',
        ],
        [
            'file' => '/foo/filename2.php',
            'line' => 2,
            'class' => 'class2',
            'function' => 'function2',
        ],
        [
            'class' => 'class3',
            'function' => 'function3',
        ],
        [
            'file' => '/foo/filename4.php',
            'line' => 4,
            'class' => 'class4',
            'function' => 'function4',
        ],
    ];
 
    protected function ‪setUp(): void
    {
        parent::setUp();
        $this->processor = $this->getAccessibleMock(IntrospectionProcessor::class, ['getDebugBacktrace']);
    }
 
    #[Test]
    public function ‪introspectionProcessorAddsLastBacktraceItemToLogRecord(): void
    {
        $this->processor->method('getDebugBacktrace')->willReturn($this->dummyBacktrace);
        $logRecord = new ‪LogRecord('test.core.log', LogLevel::DEBUG, 'test');
        $logRecord = $this->processor->processLogRecord($logRecord);
 
        self::assertEquals($this->dummyBacktrace[0]['file'], $logRecord['data']['file']);
        self::assertEquals($this->dummyBacktrace[0]['line'], $logRecord['data']['line']);
        self::assertEquals($this->dummyBacktrace[0]['class'], $logRecord['data']['class']);
        self::assertEquals($this->dummyBacktrace[0]['function'], $logRecord['data']['function']);
    }
 
    #[Test]
    public function ‪introspectionProcessorShiftsLogRelatedFunctionsFromBacktrace(): void
    {
        ‪$dummyBacktrace = ‪$this->dummyBacktrace;
        array_unshift(
            ‪$dummyBacktrace,
            [
                'file' => '/foo/Log.php',
                'line' => 999,
                'class' => 'TYPO3\CMS\Core\Log\Bar\Foo',
                'function' => 'function999',
            ],
            [
                'file' => '/foo/Log2.php',
                'line' => 888,
                'class' => 'TYPO3\CMS\Core\Log\Bar2\Foo2',
                'function' => 'function888',
            ]
        );
        $this->processor->method('getDebugBacktrace')->willReturn(‪$dummyBacktrace);
 
        $logRecord = new ‪LogRecord('test.core.log', LogLevel::DEBUG, 'test');
        $logRecord = $this->processor->processLogRecord($logRecord);
 
        self::assertEquals($this->dummyBacktrace[0]['file'], $logRecord['data']['file']);
        self::assertEquals($this->dummyBacktrace[0]['line'], $logRecord['data']['line']);
        self::assertEquals($this->dummyBacktrace[0]['class'], $logRecord['data']['class']);
        self::assertEquals($this->dummyBacktrace[0]['function'], $logRecord['data']['function']);
    }
 
    public static function ‪introspectionProcessorShiftsGivenNumberOfEntriesFromBacktraceDataProvider(): array
    {
        return [
            ['0'],
            ['1'],
            ['3'],
        ];
    }
 
    #[DataProvider('introspectionProcessorShiftsGivenNumberOfEntriesFromBacktraceDataProvider')]
    #[Test]
    public function ‪introspectionProcessorShiftsGivenNumberOfEntriesFromBacktrace($number): void
    {
        $this->processor->method('getDebugBacktrace')->willReturn($this->dummyBacktrace);
        $this->processor->setShiftBackTraceLevel($number);
 
        $logRecord = new ‪LogRecord('test.core.log', LogLevel::DEBUG, 'test');
        $logRecord = $this->processor->processLogRecord($logRecord);
 
        self::assertEquals($this->dummyBacktrace[$number]['file'], $logRecord['data']['file']);
        self::assertEquals($this->dummyBacktrace[$number]['line'], $logRecord['data']['line']);
        self::assertEquals($this->dummyBacktrace[$number]['class'], $logRecord['data']['class']);
        self::assertEquals($this->dummyBacktrace[$number]['function'], $logRecord['data']['function']);
    }
 
    #[Test]
    public function ‪introspectionProcessorLeavesOneEntryIfGivenNumberOfEntriesFromBacktraceIsGreaterOrEqualNumberOfBacktraceLevels(): void
    {
        $this->processor->method('getDebugBacktrace')->willReturn($this->dummyBacktrace);
        $this->processor->setShiftBackTraceLevel(4);
 
        $logRecord = new ‪LogRecord('test.core.log', LogLevel::DEBUG, 'test');
        $logRecord = $this->processor->processLogRecord($logRecord);
 
        self::assertEquals($this->dummyBacktrace[3]['file'], $logRecord['data']['file']);
        self::assertEquals($this->dummyBacktrace[3]['line'], $logRecord['data']['line']);
        self::assertEquals($this->dummyBacktrace[3]['class'], $logRecord['data']['class']);
        self::assertEquals($this->dummyBacktrace[3]['function'], $logRecord['data']['function']);
    }
 
    #[Test]
    public function ‪appendFullBacktraceAddsTheFullBacktraceAsStringToTheLog(): void
    {
        $this->processor->method('getDebugBacktrace')->willReturn($this->dummyBacktrace);
 
        $this->processor->setAppendFullBackTrace(true);
 
        $logRecord = new ‪LogRecord('test.core.log', LogLevel::DEBUG, 'test');
        $logRecord = $this->processor->processLogRecord($logRecord);
 
        self::assertContains($this->dummyBacktrace[0], $logRecord['data']['backtrace']);
        self::assertContains($this->dummyBacktrace[1], $logRecord['data']['backtrace']);
        self::assertContains($this->dummyBacktrace[2], $logRecord['data']['backtrace']);
        self::assertContains($this->dummyBacktrace[3], $logRecord['data']['backtrace']);
    }
}