@covers Monolog\Handler\RotatingFileHandler More...

Inheritance diagram for Monolog\Handler\RotatingFileHandlerTest:

Collaboration diagram for Monolog\Handler\RotatingFileHandlerTest:

Public Member Functions
	setUp ()

	testRotationCreatesNewFile ()

	testRotation ($createFile, $dateFormat, $timeCallback)
	@dataProvider rotationTests More...

	rotationTests ()

	testAllowOnlyFixedDefinedDateFormats ($dateFormat, $valid)
	@dataProvider dateFormatProvider More...

	dateFormatProvider ()

	testDisallowFilenameFormatsWithoutDate ($filenameFormat, $valid)
	@dataProvider filenameFormatProvider More...

	filenameFormatProvider ()

	testRotationWhenSimilarFileNamesExist ($dateFormat)
	@dataProvider rotationWhenSimilarFilesExistTests More...

	rotationWhenSimilarFilesExistTests ()

	testReuseCurrentFile ()

	tearDown ()

Data Fields
	$lastError
	This var should be private but then the anonymous function in the `setUp` method won't be able to set it. More...

Private Member Functions
	assertErrorWasTriggered ($code, $message)

Additional Inherited Members
Protected Member Functions inherited from Monolog\TestCase
	getRecord ($level=Logger::WARNING, $message='test', $context=array())

	getMultipleRecords ()

	getIdentityFormatter ()

Detailed Description

@covers Monolog\Handler\RotatingFileHandler

Definition at line 20 of file RotatingFileHandlerTest.php.

Member Function Documentation

◆ assertErrorWasTriggered()

Monolog\Handler\RotatingFileHandlerTest::assertErrorWasTriggered	(	$code,
		$message
	)

private

Definition at line 48 of file RotatingFileHandlerTest.php.

    {
        if (empty($this->lastError)) {
            $this->fail(
                sprintf(
                    'Failed asserting that error with code `%d` and message `%s` was triggered',
                    $code,
                    $message
                )
            );
        }
        $this->assertEquals($code, $this->lastError['code'], sprintf('Expected an error with code %d to be triggered, got `%s` instead', $code, $this->lastError['code']));
        $this->assertEquals($message, $this->lastError['message'], sprintf('Expected an error with message `%d` to be triggered, got `%s` instead', $message, $this->lastError['message']));
    }

References $code, and $message.

Referenced by Monolog\Handler\RotatingFileHandlerTest\testAllowOnlyFixedDefinedDateFormats(), and Monolog\Handler\RotatingFileHandlerTest\testDisallowFilenameFormatsWithoutDate().

Here is the caller graph for this function:

◆ dateFormatProvider()

Monolog\Handler\RotatingFileHandlerTest::dateFormatProvider ( )

Definition at line 155 of file RotatingFileHandlerTest.php.

    {
        return array(
            array(RotatingFileHandler::FILE_PER_DAY, true),
            array(RotatingFileHandler::FILE_PER_MONTH, true),
            array(RotatingFileHandler::FILE_PER_YEAR, true),
            array('m-d-Y', false),
            array('Y-m-d-h-i', false)
        );
    }

References Monolog\Handler\RotatingFileHandler\FILE_PER_DAY, Monolog\Handler\RotatingFileHandler\FILE_PER_MONTH, and Monolog\Handler\RotatingFileHandler\FILE_PER_YEAR.

◆ filenameFormatProvider()

Monolog\Handler\RotatingFileHandlerTest::filenameFormatProvider ( )

Definition at line 181 of file RotatingFileHandlerTest.php.

    {
        return array(
            array('{filename}', false),
            array('{filename}-{date}', true),
            array('{date}', true),
            array('foobar-{date}', true),
            array('foo-{date}-bar', true),
            array('{date}-foobar', true),
            array('foobar', false),
        );
    }

◆ rotationTests()

Monolog\Handler\RotatingFileHandlerTest::rotationTests ( )

Definition at line 107 of file RotatingFileHandlerTest.php.

    {
        $now = time();
        $dayCallback = function($ago) use ($now) {
            return $now + 86400 * $ago;
        };
        $monthCallback = function($ago) {
            return gmmktime(0, 0, 0, date('n') + $ago, 1, date('Y'));
        };
        $yearCallback = function($ago) {
            return gmmktime(0, 0, 0, 1, 1, date('Y') + $ago);
        };
 
        return array(
            'Rotation is triggered when the file of the current day is not present'
                => array(true, RotatingFileHandler::FILE_PER_DAY, $dayCallback),
            'Rotation is not triggered when the file of the current day is already present'
                => array(false, RotatingFileHandler::FILE_PER_DAY, $dayCallback),
 
            'Rotation is triggered when the file of the current month is not present'
                => array(true, RotatingFileHandler::FILE_PER_MONTH, $monthCallback),
            'Rotation is not triggered when the file of the current month is already present'
                => array(false, RotatingFileHandler::FILE_PER_MONTH, $monthCallback),
 
            'Rotation is triggered when the file of the current year is not present'
                => array(true, RotatingFileHandler::FILE_PER_YEAR, $yearCallback),
            'Rotation is not triggered when the file of the current year is already present'
                => array(false, RotatingFileHandler::FILE_PER_YEAR, $yearCallback),
        );
    }

References Monolog\Handler\RotatingFileHandler\FILE_PER_DAY, Monolog\Handler\RotatingFileHandler\FILE_PER_MONTH, and Monolog\Handler\RotatingFileHandler\FILE_PER_YEAR.

◆ rotationWhenSimilarFilesExistTests()

Monolog\Handler\RotatingFileHandlerTest::rotationWhenSimilarFilesExistTests ( )

Definition at line 213 of file RotatingFileHandlerTest.php.

    {
 
        return array(
            'Rotation is triggered when the file of the current day is not present but similar exists'
                => array(RotatingFileHandler::FILE_PER_DAY),
 
            'Rotation is triggered when the file of the current month is not present but similar exists'
                => array(RotatingFileHandler::FILE_PER_MONTH),
 
            'Rotation is triggered when the file of the current year is not present but similar exists'
                => array(RotatingFileHandler::FILE_PER_YEAR),
        );
    }

References Monolog\Handler\RotatingFileHandler\FILE_PER_DAY, Monolog\Handler\RotatingFileHandler\FILE_PER_MONTH, and Monolog\Handler\RotatingFileHandler\FILE_PER_YEAR.

◆ setUp()

Monolog\Handler\RotatingFileHandlerTest::setUp ( )

Definition at line 30 of file RotatingFileHandlerTest.php.

    {
        $dir = __DIR__.'/Fixtures';
        chmod($dir, 0777);
        if (!is_writable($dir)) {
            $this->markTestSkipped($dir.' must be writable to test the RotatingFileHandler.');
        }
        $this->lastError = null;
        $self = $this;
        // workaround with &$self used for PHP 5.3
        set_error_handler(function($code, $message) use (&$self) {
            $self->lastError = array(
                'code' => $code,
                'message' => $message,
            );
        });
    }

References $code, and $message.

◆ tearDown()

Monolog\Handler\RotatingFileHandlerTest::tearDown ( )

Definition at line 238 of file RotatingFileHandlerTest.php.

    {
        foreach (glob(__DIR__.'/Fixtures/*.rot') as $file) {
            unlink($file);
        }
        restore_error_handler();
    }

◆ testAllowOnlyFixedDefinedDateFormats()

Monolog\Handler\RotatingFileHandlerTest::testAllowOnlyFixedDefinedDateFormats	(	$dateFormat,
		$valid
	)

@dataProvider dateFormatProvider

Definition at line 141 of file RotatingFileHandlerTest.php.

    {
        $handler = new RotatingFileHandler(__DIR__.'/Fixtures/foo.rot', 2);
        $handler->setFilenameFormat('{filename}-{date}', $dateFormat);
        if (!$valid) {
            $this->assertErrorWasTriggered(
                E_USER_DEPRECATED,
                'Invalid date format - format must be one of RotatingFileHandler::FILE_PER_DAY ("Y-m-d"), '.
                'RotatingFileHandler::FILE_PER_MONTH ("Y-m") or RotatingFileHandler::FILE_PER_YEAR ("Y"), '.
                'or you can set one of the date formats using slashes, underscores and/or dots instead of dashes.'
            );
        }
    }

References $handler, $valid, and Monolog\Handler\RotatingFileHandlerTest\assertErrorWasTriggered().

Here is the call graph for this function:

◆ testDisallowFilenameFormatsWithoutDate()

Monolog\Handler\RotatingFileHandlerTest::testDisallowFilenameFormatsWithoutDate	(	$filenameFormat,
		$valid
	)

@dataProvider filenameFormatProvider

Definition at line 169 of file RotatingFileHandlerTest.php.

    {
        $handler = new RotatingFileHandler(__DIR__.'/Fixtures/foo.rot', 2);
        $handler->setFilenameFormat($filenameFormat, RotatingFileHandler::FILE_PER_DAY);
        if (!$valid) {
            $this->assertErrorWasTriggered(
                E_USER_DEPRECATED,
                'Invalid filename format - format should contain at least `{date}`, because otherwise rotating is impossible.'
            );
        }
    }

References $handler, $valid, Monolog\Handler\RotatingFileHandlerTest\assertErrorWasTriggered(), and Monolog\Handler\RotatingFileHandler\FILE_PER_DAY.

Here is the call graph for this function:

◆ testReuseCurrentFile()

Monolog\Handler\RotatingFileHandlerTest::testReuseCurrentFile ( )

Definition at line 228 of file RotatingFileHandlerTest.php.

    {
        $log = __DIR__.'/Fixtures/foo-'.date('Y-m-d').'.rot';
        file_put_contents($log, "foo");
        $handler = new RotatingFileHandler(__DIR__.'/Fixtures/foo.rot');
        $handler->setFormatter($this->getIdentityFormatter());
        $handler->handle($this->getRecord());
        $this->assertEquals('footest', file_get_contents($log));
    }

References $handler, $log, Monolog\TestCase\getIdentityFormatter(), and Monolog\TestCase\getRecord().

Here is the call graph for this function:

◆ testRotation()

Monolog\Handler\RotatingFileHandlerTest::testRotation	(	$createFile,
		$dateFormat,
		$timeCallback
	)

@dataProvider rotationTests

Definition at line 79 of file RotatingFileHandlerTest.php.

    {
        touch($old1 = __DIR__.'/Fixtures/foo-'.date($dateFormat, $timeCallback(-1)).'.rot');
        touch($old2 = __DIR__.'/Fixtures/foo-'.date($dateFormat, $timeCallback(-2)).'.rot');
        touch($old3 = __DIR__.'/Fixtures/foo-'.date($dateFormat, $timeCallback(-3)).'.rot');
        touch($old4 = __DIR__.'/Fixtures/foo-'.date($dateFormat, $timeCallback(-4)).'.rot');
 
        $log = __DIR__.'/Fixtures/foo-'.date($dateFormat).'.rot';
 
        if ($createFile) {
            touch($log);
        }
 
        $handler = new RotatingFileHandler(__DIR__.'/Fixtures/foo.rot', 2);
        $handler->setFormatter($this->getIdentityFormatter());
        $handler->setFilenameFormat('{filename}-{date}', $dateFormat);
        $handler->handle($this->getRecord());
 
        $handler->close();
 
        $this->assertTrue(file_exists($log));
        $this->assertTrue(file_exists($old1));
        $this->assertEquals($createFile, file_exists($old2));
        $this->assertEquals($createFile, file_exists($old3));
        $this->assertEquals($createFile, file_exists($old4));
        $this->assertEquals('test', file_get_contents($log));
    }

References $handler, $log, Monolog\TestCase\getIdentityFormatter(), and Monolog\TestCase\getRecord().

Here is the call graph for this function:

◆ testRotationCreatesNewFile()

Monolog\Handler\RotatingFileHandlerTest::testRotationCreatesNewFile ( )

Definition at line 63 of file RotatingFileHandlerTest.php.

    {
        touch(__DIR__.'/Fixtures/foo-'.date('Y-m-d', time() - 86400).'.rot');
 
        $handler = new RotatingFileHandler(__DIR__.'/Fixtures/foo.rot');
        $handler->setFormatter($this->getIdentityFormatter());
        $handler->handle($this->getRecord());
 
        $log = __DIR__.'/Fixtures/foo-'.date('Y-m-d').'.rot';
        $this->assertTrue(file_exists($log));
        $this->assertEquals('test', file_get_contents($log));
    }

References $handler, $log, Monolog\TestCase\getIdentityFormatter(), and Monolog\TestCase\getRecord().

Here is the call graph for this function:

◆ testRotationWhenSimilarFileNamesExist()

Monolog\Handler\RotatingFileHandlerTest::testRotationWhenSimilarFileNamesExist ( $dateFormat )

@dataProvider rotationWhenSimilarFilesExistTests

Definition at line 197 of file RotatingFileHandlerTest.php.

    {
        touch($old1 = __DIR__.'/Fixtures/foo-foo-'.date($dateFormat).'.rot');
        touch($old2 = __DIR__.'/Fixtures/foo-bar-'.date($dateFormat).'.rot');
 
        $log = __DIR__.'/Fixtures/foo-'.date($dateFormat).'.rot';
 
        $handler = new RotatingFileHandler(__DIR__.'/Fixtures/foo.rot', 2);
        $handler->setFormatter($this->getIdentityFormatter());
        $handler->setFilenameFormat('{filename}-{date}', $dateFormat);
        $handler->handle($this->getRecord());
        $handler->close();
 
        $this->assertTrue(file_exists($log));
    }

References $handler, $log, Monolog\TestCase\getIdentityFormatter(), and Monolog\TestCase\getRecord().

Here is the call graph for this function:

Field Documentation

◆ $lastError

Monolog\Handler\RotatingFileHandlerTest::$lastError

This var should be private but then the anonymous function in the setUp method won't be able to set it.

$this cant't be used in the anonymous function in setUp because PHP 5.3 does not support it.

Definition at line 28 of file RotatingFileHandlerTest.php.

The documentation for this class was generated from the following file:

libs/composer/vendor/monolog/monolog/tests/Monolog/Handler/RotatingFileHandlerTest.php

Public Member Functions

Data Fields

Private Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ assertErrorWasTriggered()

◆ dateFormatProvider()

◆ filenameFormatProvider()

◆ rotationTests()

◆ rotationWhenSimilarFilesExistTests()

◆ setUp()

◆ tearDown()

◆ testAllowOnlyFixedDefinedDateFormats()

◆ testDisallowFilenameFormatsWithoutDate()

◆ testReuseCurrentFile()

◆ testRotation()

◆ testRotationCreatesNewFile()

◆ testRotationWhenSimilarFileNamesExist()

Field Documentation

◆ $lastError