LogRecordTest.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;
 
use PHPUnit\Framework\Attributes\Test;
use Psr\Log\InvalidArgumentException;
use Psr\Log\LogLevel;
use ‪TYPO3\CMS\Core\Log\LogRecord;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
final class ‪LogRecordTest extends UnitTestCase
{
    protected function ‪getRecord(array $parameters = []): ‪LogRecord
    {
        ‪$record = new ‪LogRecord(
            $parameters['component'] ?? 'test.core.log',
            $parameters['level'] ?? LogLevel::DEBUG,
            $parameters['message'] ?? 'test message',
            $parameters['data'] ?? []
        );
        return ‪$record;
    }
 
    #[Test]
    public function ‪constructorSetsCorrectComponent(): void
    {
        $component = 'test.core.log';
        ‪$record = $this->‪getRecord(['component' => $component]);
        self::assertEquals($component, ‪$record->getComponent());
    }
 
    #[Test]
    public function ‪constructorSetsCorrectLogLevel(): void
    {
        $logLevel = LogLevel::CRITICAL;
        ‪$record = $this->‪getRecord(['level' => $logLevel]);
        self::assertEquals($logLevel, ‪$record->getLevel());
    }
 
    #[Test]
    public function ‪constructorSetsCorrectMessage(): void
    {
        $logMessage = 'test message';
        ‪$record = $this->‪getRecord(['message' => $logMessage]);
        self::assertEquals($logMessage, ‪$record->getMessage());
    }
 
    #[Test]
    public function ‪constructorSetsCorrectData(): void
    {
        $dataArray = [
            'foo' => 'bar',
        ];
        ‪$record = $this->‪getRecord(['data' => $dataArray]);
        self::assertEquals($dataArray, ‪$record->getData());
    }
 
    #[Test]
    public function ‪setComponentSetsComponent(): void
    {
        ‪$record = $this->‪getRecord();
        $component = 'testcomponent';
        self::assertEquals($component, ‪$record->setComponent($component)->getComponent());
    }
 
    #[Test]
    public function ‪setLevelSetsLevel(): void
    {
        ‪$record = $this->‪getRecord();
        $level = LogLevel::EMERGENCY;
        self::assertEquals($level, ‪$record->setLevel($level)->getLevel());
    }
 
    #[Test]
    public function ‪setLevelValidatesLevel(): void
    {
        $this->expectException(InvalidArgumentException::class);
        $this->expectExceptionCode(1550247164);
 
        ‪$record = $this->‪getRecord();
        ‪$record->setLevel('foo');
    }
 
    #[Test]
    public function ‪setMessageSetsMessage(): void
    {
        ‪$record = $this->‪getRecord();
        $message = 'testmessage';
        self::assertEquals($message, ‪$record->setMessage($message)->getMessage());
    }
 
    #[Test]
    public function ‪setCreatedSetsCreated(): void
    {
        ‪$record = $this->‪getRecord();
        $created = 123.45;
        self::assertEquals($created, ‪$record->setCreated($created)->getCreated());
    }
 
    #[Test]
    public function ‪setRequestIdSetsRequestId(): void
    {
        ‪$record = $this->‪getRecord();
        $requestId = 'testrequestid';
        self::assertEquals($requestId, ‪$record->setRequestId($requestId)->getRequestId());
    }
 
    #[Test]
    public function ‪toArrayReturnsCorrectValues(): void
    {
        $component = 'test.core.log';
        $level = LogLevel::DEBUG;
        $message = 'test message';
        $data = ['foo' => 'bar'];
        ‪$record = new ‪LogRecord($component, $level, $message, $data);
        $recordArray = ‪$record->toArray();
        self::assertEquals($component, $recordArray['component']);
        self::assertEquals($level, $recordArray['level']);
        self::assertEquals($message, $recordArray['message']);
        self::assertEquals($data, $recordArray['data']);
    }
 
    #[Test]
    public function ‪toStringIncludesDataAsJson(): void
    {
        $dataArray = ['foo' => 'bar'];
        ‪$record = $this->‪getRecord(['data' => $dataArray]);
        self::assertStringContainsString(json_encode($dataArray), (string)‪$record);
    }
 
    #[Test]
    public function ‪toStringIncludesExceptionDataAsJson(): void
    {
        $dataArray = ['exception' => new \Exception('foo', 1476049451)];
        ‪$record = $this->‪getRecord(['data' => $dataArray]);
        self::assertStringContainsString('Exception: foo', (string)‪$record);
    }
}