Psr\Log\Test\LoggerInterfaceTest Class Reference

Provides a base test class for ensuring compliance with the LoggerInterface. More...

Inheritance diagram for Psr\Log\Test\LoggerInterfaceTest:

Collaboration diagram for Psr\Log\Test\LoggerInterfaceTest:

Public Member Functions
	getLogger ()
	getLogs ()
	This must return the log messages in order. More...
	testImplements ()
	testLogsAtAllLevels ($level, $message)
	provideLevelsAndMessages More...
	provideLevelsAndMessages ()
	testThrowsOnInvalidLevel ()
	testContextReplacement ()
	testObjectCastToString ()
	testContextCanContainAnything ()
	testContextExceptionKeyCanBeExceptionOrOtherValues ()

Detailed Description

Provides a base test class for ensuring compliance with the LoggerInterface.

Implementors can extend the class and implement abstract methods to run this as part of their test suite.

Definition at line 14 of file LoggerInterfaceTest.php.

Member Function Documentation

getLogger()

Psr\Log\Test\LoggerInterfaceTest::getLogger ( )

abstract

Returns

LoggerInterface

Referenced by Psr\Log\Test\LoggerInterfaceTest\testContextCanContainAnything(), Psr\Log\Test\LoggerInterfaceTest\testContextExceptionKeyCanBeExceptionOrOtherValues(), Psr\Log\Test\LoggerInterfaceTest\testContextReplacement(), Psr\Log\Test\LoggerInterfaceTest\testImplements(), Psr\Log\Test\LoggerInterfaceTest\testLogsAtAllLevels(), Psr\Log\Test\LoggerInterfaceTest\testObjectCastToString(), and Psr\Log\Test\LoggerInterfaceTest\testThrowsOnInvalidLevel().

Here is the caller graph for this function:

getLogs()

Psr\Log\Test\LoggerInterfaceTest::getLogs ( )

abstract

This must return the log messages in order.

The simple formatting of the messages is: "<LOG LEVEL> <MESSAGE>".

Example ->error('Foo') would yield "error Foo".

Returns

string[]

Referenced by Psr\Log\Test\LoggerInterfaceTest\testContextCanContainAnything(), Psr\Log\Test\LoggerInterfaceTest\testContextExceptionKeyCanBeExceptionOrOtherValues(), Psr\Log\Test\LoggerInterfaceTest\testContextReplacement(), Psr\Log\Test\LoggerInterfaceTest\testLogsAtAllLevels(), and Psr\Log\Test\LoggerInterfaceTest\testObjectCastToString().

Here is the caller graph for this function:

provideLevelsAndMessages()

Psr\Log\Test\LoggerInterfaceTest::provideLevelsAndMessages

(

)

Definition at line 53 of file LoggerInterfaceTest.php.

References Psr\Log\LogLevel\ALERT, Psr\Log\LogLevel\CRITICAL, Psr\Log\LogLevel\DEBUG, Psr\Log\LogLevel\EMERGENCY, Psr\Log\LogLevel\ERROR, Psr\Log\LogLevel\INFO, Psr\Log\LogLevel\NOTICE, and Psr\Log\LogLevel\WARNING.

    {
        return array(
            LogLevel::EMERGENCY => array(LogLevel::EMERGENCY, 'message of level emergency with context: {user}'),
            LogLevel::ALERT => array(LogLevel::ALERT, 'message of level alert with context: {user}'),
            LogLevel::CRITICAL => array(LogLevel::CRITICAL, 'message of level critical with context: {user}'),
            LogLevel::ERROR => array(LogLevel::ERROR, 'message of level error with context: {user}'),
            LogLevel::WARNING => array(LogLevel::WARNING, 'message of level warning with context: {user}'),
            LogLevel::NOTICE => array(LogLevel::NOTICE, 'message of level notice with context: {user}'),
            LogLevel::INFO => array(LogLevel::INFO, 'message of level info with context: {user}'),
            LogLevel::DEBUG => array(LogLevel::DEBUG, 'message of level debug with context: {user}'),
        );
    }

testContextCanContainAnything()

Psr\Log\Test\LoggerInterfaceTest::testContextCanContainAnything

(

)

Definition at line 102 of file LoggerInterfaceTest.php.

References $context, Psr\Log\Test\LoggerInterfaceTest\getLogger(), and Psr\Log\Test\LoggerInterfaceTest\getLogs().

    {
        $context = array(
            'bool' => true,
            'null' => null,
            'string' => 'Foo',
            'int' => 0,
            'float' => 0.5,
            'nested' => array('with object' => new DummyTest),
            'object' => new \DateTime,
            'resource' => fopen('php://memory', 'r'),
        );

        $this->getLogger()->warning('Crazy context data', $context);

        $expected = array('warning Crazy context data');
        $this->assertEquals($expected, $this->getLogs());
    }

Here is the call graph for this function:

testContextExceptionKeyCanBeExceptionOrOtherValues()

Psr\Log\Test\LoggerInterfaceTest::testContextExceptionKeyCanBeExceptionOrOtherValues

(

)

Definition at line 121 of file LoggerInterfaceTest.php.

References Psr\Log\Test\LoggerInterfaceTest\getLogger(), and Psr\Log\Test\LoggerInterfaceTest\getLogs().

    {
        $logger = $this->getLogger();
        $logger->warning('Random message', array('exception' => 'oops'));
        $logger->critical('Uncaught Exception!', array('exception' => new \LogicException('Fail')));

        $expected = array(
            'warning Random message',
            'critical Uncaught Exception!'
        );
        $this->assertEquals($expected, $this->getLogs());
    }

Here is the call graph for this function:

testContextReplacement()

Psr\Log\Test\LoggerInterfaceTest::testContextReplacement

(

)

Definition at line 76 of file LoggerInterfaceTest.php.

References Psr\Log\Test\LoggerInterfaceTest\getLogger(), and Psr\Log\Test\LoggerInterfaceTest\getLogs().

    {
        $logger = $this->getLogger();
        $logger->info('{Message {nothing} {user} {foo.bar} a}', array('user' => 'Bob', 'foo.bar' => 'Bar'));

        $expected = array('info {Message {nothing} Bob Bar a}');
        $this->assertEquals($expected, $this->getLogs());
    }

Here is the call graph for this function:

testImplements()

Psr\Log\Test\LoggerInterfaceTest::testImplements

(

)

Definition at line 32 of file LoggerInterfaceTest.php.

References Psr\Log\Test\LoggerInterfaceTest\getLogger().

    {
        $this->assertInstanceOf('Psr\Log\LoggerInterface', $this->getLogger());
    }

Here is the call graph for this function:

testLogsAtAllLevels()

Psr\Log\Test\LoggerInterfaceTest::testLogsAtAllLevels	(		$level,
			$message
	)

provideLevelsAndMessages

Definition at line 40 of file LoggerInterfaceTest.php.

References $message, Psr\Log\Test\LoggerInterfaceTest\getLogger(), and Psr\Log\Test\LoggerInterfaceTest\getLogs().

    {
        $logger = $this->getLogger();
        $logger->{$level}($message, array('user' => 'Bob'));
        $logger->log($level, $message, array('user' => 'Bob'));

        $expected = array(
            $level.' message of level '.$level.' with context: Bob',
            $level.' message of level '.$level.' with context: Bob',
        );
        $this->assertEquals($expected, $this->getLogs());
    }

Here is the call graph for this function:

testObjectCastToString()

Psr\Log\Test\LoggerInterfaceTest::testObjectCastToString

(

)

Definition at line 85 of file LoggerInterfaceTest.php.

References Psr\Log\Test\LoggerInterfaceTest\getLogger(), Psr\Log\Test\LoggerInterfaceTest\getLogs(), and Sabre\Event\once().

    {
        if (method_exists($this, 'createPartialMock')) {
            $dummy = $this->createPartialMock('Psr\Log\Test\DummyTest', array('__toString'));
        } else {
            $dummy = $this->getMock('Psr\Log\Test\DummyTest', array('__toString'));
        }
        $dummy->expects($this->once())
            ->method('__toString')
            ->will($this->returnValue('DUMMY'));

        $this->getLogger()->warning($dummy);

        $expected = array('warning DUMMY');
        $this->assertEquals($expected, $this->getLogs());
    }

Here is the call graph for this function:

testThrowsOnInvalidLevel()

Psr\Log\Test\LoggerInterfaceTest::testThrowsOnInvalidLevel

(

)

Definition at line 70 of file LoggerInterfaceTest.php.

References Psr\Log\Test\LoggerInterfaceTest\getLogger().

    {
        $logger = $this->getLogger();
        $logger->log('invalid level', 'Foo');
    }

Here is the call graph for this function:

---

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

• libs/composer/vendor/psr/log/Psr/Log/Test/LoggerInterfaceTest.php