LogRecordTest.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Core\Tests\Unit\Log;

/*
 * 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!
 */

class LogRecordTest extends \TYPO3\CMS\Core\Tests\UnitTestCase
{
    protected function getRecord(array $parameters = [])
    {
        $record = new \TYPO3\CMS\Core\Log\LogRecord($parameters['component'] ?: 'test.core.log', $parameters['level'] ?: \TYPO3\CMS\Core\Log\LogLevel::DEBUG, $parameters['message'] ?: 'test message', $parameters['data'] ?: []);
        return $record;
    }

    public function constructorSetsCorrectComponent()
    {
        $component = 'test.core.log';
        $record = $this->getRecord(['component' => $component]);
        $this->assertEquals($component, $record->getComponent());
    }

    public function constructorSetsCorrectLogLevel()
    {
        $logLevel = \TYPO3\CMS\Core\Log\LogLevel::CRITICAL;
        $record = $this->getRecord(['level' => $logLevel]);
        $this->assertEquals($logLevel, $record->getLevel());
    }

    public function constructorSetsCorrectMessage()
    {
        $logMessage = 'test message';
        $record = $this->getRecord(['message' => $logMessage]);
        $this->assertEquals($logMessage, $record->getMessage());
    }

    public function constructorSetsCorrectData()
    {
        $dataArray = [
            'foo' => 'bar'
        ];
        $record = $this->getRecord(['data' => $dataArray]);
        $this->assertEquals($dataArray, $record->getData());
    }

    public function setComponentSetsComponent()
    {
        $record = $this->getRecord();
        $component = 'testcomponent';
        $this->assertEquals($component, $record->setComponent($component)->getComponent());
    }

    public function setLevelSetsLevel()
    {
        $record = $this->getRecord();
        $level = \TYPO3\CMS\Core\Log\LogLevel::EMERGENCY;
        $this->assertEquals($level, $record->setLevel($level)->getLevel());
    }

    public function setLevelValidatesLevel()
    {
        $record = $this->getRecord();
        $record->setLevel(100);
    }

    public function setMessageSetsMessage()
    {
        $record = $this->getRecord();
        $message = 'testmessage';
        $this->assertEquals($message, $record->setMessage($message)->getMessage());
    }

    public function setCreatedSetsCreated()
    {
        $record = $this->getRecord();
        $created = 123.45;
        $this->assertEquals($created, $record->setCreated($created)->getCreated());
    }

    public function setRequestIdSetsRequestId()
    {
        $record = $this->getRecord();
        $requestId = 'testrequestid';
        $this->assertEquals($requestId, $record->setRequestId($requestId)->getRequestId());
    }

    public function toArrayReturnsCorrectValues()
    {
        $component = 'test.core.log';
        $level = \TYPO3\CMS\Core\Log\LogLevel::DEBUG;
        $message = 'test message';
        $data = ['foo' => 'bar'];
        $record = new \TYPO3\CMS\Core\Log\LogRecord($component, $level, $message, $data);
        $recordArray = $record->toArray();
        $this->assertEquals($component, $recordArray['component']);
        $this->assertEquals($level, $recordArray['level']);
        $this->assertEquals($message, $recordArray['message']);
        $this->assertEquals($data, $recordArray['data']);
    }

    public function toStringIncludesDataAsJson()
    {
        $dataArray = ['foo' => 'bar'];
        $record = $this->getRecord(['data' => $dataArray]);
        $this->assertContains(json_encode($dataArray), (string)$record);
    }

    public function toStringIncludesExceptionDataAsJson()
    {
        $dataArray = ['exception' => new \Exception('foo')];
        $record = $this->getRecord(['data' => $dataArray]);
        // Since 7.0.0-dev 17.05.2015 the output of Exception is changed.
        // https://github.com/php/php-src/commit/3ae995f03c8f60c4a4c9718262545cf5a6a08da3
        // To check for dev version we need to compare with a version before 7.0.0
        if (version_compare(PHP_VERSION, '6.99.00') >= 0) {
            $this->assertContains('Exception: foo', (string)$record);
        } else {
            $this->assertContains('\'Exception\' with message \'foo\'', (string)$record);
        }
    }
}