3 namespace Psr\Log\Test
;
5 use Psr\Log\LoggerInterface
;
9 * Provides a base test class for ensuring compliance with the LoggerInterface.
11 * Implementors can extend the class and implement abstract methods to run this
12 * as part of their test suite.
14 abstract class LoggerInterfaceTest
extends \PHPUnit_Framework_TestCase
17 * @return LoggerInterface
19 abstract public function getLogger();
22 * This must return the log messages in order.
24 * The simple formatting of the messages is: "<LOG LEVEL> <MESSAGE>".
26 * Example ->error('Foo') would yield "error Foo".
30 abstract public function getLogs();
32 public function testImplements()
34 $this->assertInstanceOf('Psr\Log\LoggerInterface', $this->getLogger());
38 * @dataProvider provideLevelsAndMessages
40 public function testLogsAtAllLevels($level, $message)
42 $logger = $this->getLogger();
43 $logger->{$level}($message, array('user' => 'Bob'));
44 $logger->log($level, $message, array('user' => 'Bob'));
47 $level.' message of level '.$level.' with context: Bob',
48 $level.' message of level '.$level.' with context: Bob',
50 $this->assertEquals($expected, $this->getLogs());
53 public function provideLevelsAndMessages()
56 LogLevel
::EMERGENCY
=> array(LogLevel
::EMERGENCY
, 'message of level emergency with context: {user}'),
57 LogLevel
::ALERT
=> array(LogLevel
::ALERT
, 'message of level alert with context: {user}'),
58 LogLevel
::CRITICAL
=> array(LogLevel
::CRITICAL
, 'message of level critical with context: {user}'),
59 LogLevel
::ERROR
=> array(LogLevel
::ERROR
, 'message of level error with context: {user}'),
60 LogLevel
::WARNING
=> array(LogLevel
::WARNING
, 'message of level warning with context: {user}'),
61 LogLevel
::NOTICE
=> array(LogLevel
::NOTICE
, 'message of level notice with context: {user}'),
62 LogLevel
::INFO
=> array(LogLevel
::INFO
, 'message of level info with context: {user}'),
63 LogLevel
::DEBUG
=> array(LogLevel
::DEBUG
, 'message of level debug with context: {user}'),
68 * @expectedException \Psr\Log\InvalidArgumentException
70 public function testThrowsOnInvalidLevel()
72 $logger = $this->getLogger();
73 $logger->log('invalid level', 'Foo');
76 public function testContextReplacement()
78 $logger = $this->getLogger();
79 $logger->info('{Message {nothing} {user} {foo.bar} a}', array('user' => 'Bob', 'foo.bar' => 'Bar'));
81 $expected = array('info {Message {nothing} Bob Bar a}');
82 $this->assertEquals($expected, $this->getLogs());
85 public function testObjectCastToString()
87 if (method_exists($this, 'createPartialMock')) {
88 $dummy = $this->createPartialMock('Psr\Log\Test\DummyTest', array('__toString'));
90 $dummy = $this->getMock('Psr\Log\Test\DummyTest', array('__toString'));
92 $dummy->expects($this->once())
93 ->method('__toString')
94 ->will($this->returnValue('DUMMY'));
96 $this->getLogger()->warning($dummy);
98 $expected = array('warning DUMMY');
99 $this->assertEquals($expected, $this->getLogs());
102 public function testContextCanContainAnything()
110 'nested' => array('with object' => new DummyTest
),
111 'object' => new \DateTime
,
112 'resource' => fopen('php://memory', 'r'),
115 $this->getLogger()->warning('Crazy context data', $context);
117 $expected = array('warning Crazy context data');
118 $this->assertEquals($expected, $this->getLogs());
121 public function testContextExceptionKeyCanBeExceptionOrOtherValues()
123 $logger = $this->getLogger();
124 $logger->warning('Random message', array('exception' => 'oops'));
125 $logger->critical('Uncaught Exception!', array('exception' => new \
LogicException('Fail')));
128 'warning Random message',
129 'critical Uncaught Exception!'
131 $this->assertEquals($expected, $this->getLogs());
137 public function __toString()