FileWriterTest.php

Go to the documentation of this file.

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

use \org\bovigo\vfs\vfsStream;
use \org\bovigo\vfs\vfsStreamDirectory;
use \org\bovigo\vfs\vfsStreamWrapper;

class FileWriterTest extends \TYPO3\CMS\Core\Tests\UnitTestCase {

    protected $logFileDirectory = 'Log';

    protected $logFileName = 'test.log';

    protected function setUpVfsStream() {
        if (!class_exists('org\\bovigo\\vfs\\vfsStream')) {
            $this->markTestSkipped('File backend tests are not available with this phpunit version.');
        }
        vfsStream::setup('LogRoot');
    }

    protected function createLogger($name = '') {
        if (empty($name)) {
            $name = $this->getUniqueId('test.core.log.');
        }
        \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Log\\LogManager')->registerLogger($name);
        $logger = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Log\\LogManager')->getLogger($name);
        return $logger;
    }

    protected function createWriter($prependName = '') {
        $writer = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Log\\Writer\\FileWriter', array(
            'logFile' => $this->getDefaultFileName($prependName)
        ));
        return $writer;
    }

    protected function getDefaultFileName($prependName = '') {
        return 'vfs://LogRoot/' . $this->logFileDirectory . '/' . $prependName . $this->logFileName;
    }

    public function setLogFileSetsLogFile() {
        $this->setUpVfsStream();
        vfsStream::newFile($this->logFileName)->at(vfsStreamWrapper::getRoot());
        $writer = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Log\\Writer\\FileWriter');
        $writer->setLogFile($this->getDefaultFileName());
        $this->assertAttributeEquals($this->getDefaultFileName(), 'logFile', $writer);
    }

    public function setLogFileAcceptsAbsolutePath() {
        $writer = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Log\\Writer\\FileWriter');
        $tempFile = rtrim(sys_get_temp_dir(), '/\\') . '/typo3.log';
        $writer->setLogFile($tempFile);
        $this->assertAttributeEquals($tempFile, 'logFile', $writer);
    }

    public function createsLogFileDirectory() {
        $this->setUpVfsStream();
        $this->createWriter();
        $this->assertTrue(vfsStreamWrapper::getRoot()->hasChild($this->logFileDirectory));
    }

    public function createsLogFile() {
        $this->setUpVfsStream();
        $this->createWriter();
        $this->assertTrue(vfsStreamWrapper::getRoot()->getChild($this->logFileDirectory)->hasChild($this->logFileName));
    }

    public function logsToFileDataProvider() {
        $simpleRecord = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Log\\LogRecord', $this->getUniqueId('test.core.log.fileWriter.simpleRecord.'), \TYPO3\CMS\Core\Log\LogLevel::INFO, 'test record');
        $recordWithData = \TYPO3\CMS\Core\Utility\GeneralUtility::makeInstance('TYPO3\\CMS\\Core\\Log\\LogRecord', $this->getUniqueId('test.core.log.fileWriter.recordWithData.'), \TYPO3\CMS\Core\Log\LogLevel::ALERT, 'test record with data', array('foo' => array('bar' => 'baz')));
        return array(
            'simple record' => array($simpleRecord, trim((string) $simpleRecord)),
            'record with data' => array($recordWithData, trim((string) $recordWithData))
        );
    }

    public function logsToFile(\TYPO3\CMS\Core\Log\LogRecord $record, $expectedResult) {
        $this->setUpVfsStream();
        $this->createWriter()->writeLog($record);
        $logFileContents = trim(file_get_contents($this->getDefaultFileName()));
        $this->assertEquals($expectedResult, $logFileContents);
    }

    public function differentWritersLogToDifferentFiles(\TYPO3\CMS\Core\Log\LogRecord $record, $expectedResult) {
        $this->setUpVfsStream();
        $firstWriter = $this->createWriter();
        $secondWriter = $this->createWriter('second-');

        $firstWriter->writeLog($record);
        $secondWriter->writeLog($record);

        $firstLogFileContents = trim(file_get_contents($this->getDefaultFileName()));
        $secondLogFileContents = trim(file_get_contents($this->getDefaultFileName('second-')));

        $this->assertEquals($expectedResult, $firstLogFileContents);
        $this->assertEquals($expectedResult, $secondLogFileContents);
    }

    public function aSecondLogWriterToTheSameFileDoesNotOpenTheFileTwice() {
        $this->setUpVfsStream();

        $firstWriter = $this->getMock('TYPO3\\CMS\\Core\\Log\\Writer\\FileWriter', array('dummy'));
        $secondWriter = $this->getMock('TYPO3\\CMS\\Core\\Log\\Writer\\FileWriter', array('createLogFile'));

        $secondWriter->expects($this->never())->method('createLogFile');

        $logFilePrefix = $this->getUniqueId('unique');
        $firstWriter->setLogFile($this->getDefaultFileName($logFilePrefix));
        $secondWriter->setLogFile($this->getDefaultFileName($logFilePrefix));

    }
}