93 lines
5.1 KiB
PHP
93 lines
5.1 KiB
PHP
<?php
|
|
|
|
namespace Google\Site_Kit_Dependencies\Psr\Log\Test;
|
|
|
|
use Google\Site_Kit_Dependencies\Psr\Log\LoggerInterface;
|
|
use Google\Site_Kit_Dependencies\Psr\Log\LogLevel;
|
|
use Google\Site_Kit_Dependencies\PHPUnit\Framework\TestCase;
|
|
/**
|
|
* 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.
|
|
*/
|
|
abstract class LoggerInterfaceTest extends \Google\Site_Kit_Dependencies\PHPUnit\Framework\TestCase
|
|
{
|
|
/**
|
|
* @return LoggerInterface
|
|
*/
|
|
public abstract function getLogger();
|
|
/**
|
|
* 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".
|
|
*
|
|
* @return string[]
|
|
*/
|
|
public abstract function getLogs();
|
|
public function testImplements()
|
|
{
|
|
$this->assertInstanceOf('Google\\Site_Kit_Dependencies\\Psr\\Log\\LoggerInterface', $this->getLogger());
|
|
}
|
|
/**
|
|
* @dataProvider provideLevelsAndMessages
|
|
*/
|
|
public function testLogsAtAllLevels($level, $message)
|
|
{
|
|
$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());
|
|
}
|
|
public function provideLevelsAndMessages()
|
|
{
|
|
return array(\Google\Site_Kit_Dependencies\Psr\Log\LogLevel::EMERGENCY => array(\Google\Site_Kit_Dependencies\Psr\Log\LogLevel::EMERGENCY, 'message of level emergency with context: {user}'), \Google\Site_Kit_Dependencies\Psr\Log\LogLevel::ALERT => array(\Google\Site_Kit_Dependencies\Psr\Log\LogLevel::ALERT, 'message of level alert with context: {user}'), \Google\Site_Kit_Dependencies\Psr\Log\LogLevel::CRITICAL => array(\Google\Site_Kit_Dependencies\Psr\Log\LogLevel::CRITICAL, 'message of level critical with context: {user}'), \Google\Site_Kit_Dependencies\Psr\Log\LogLevel::ERROR => array(\Google\Site_Kit_Dependencies\Psr\Log\LogLevel::ERROR, 'message of level error with context: {user}'), \Google\Site_Kit_Dependencies\Psr\Log\LogLevel::WARNING => array(\Google\Site_Kit_Dependencies\Psr\Log\LogLevel::WARNING, 'message of level warning with context: {user}'), \Google\Site_Kit_Dependencies\Psr\Log\LogLevel::NOTICE => array(\Google\Site_Kit_Dependencies\Psr\Log\LogLevel::NOTICE, 'message of level notice with context: {user}'), \Google\Site_Kit_Dependencies\Psr\Log\LogLevel::INFO => array(\Google\Site_Kit_Dependencies\Psr\Log\LogLevel::INFO, 'message of level info with context: {user}'), \Google\Site_Kit_Dependencies\Psr\Log\LogLevel::DEBUG => array(\Google\Site_Kit_Dependencies\Psr\Log\LogLevel::DEBUG, 'message of level debug with context: {user}'));
|
|
}
|
|
/**
|
|
* @expectedException \Psr\Log\InvalidArgumentException
|
|
*/
|
|
public function testThrowsOnInvalidLevel()
|
|
{
|
|
$logger = $this->getLogger();
|
|
$logger->log('invalid level', 'Foo');
|
|
}
|
|
public function testContextReplacement()
|
|
{
|
|
$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());
|
|
}
|
|
public function testObjectCastToString()
|
|
{
|
|
if (\method_exists($this, 'createPartialMock')) {
|
|
$dummy = $this->createPartialMock('Google\\Site_Kit_Dependencies\\Psr\\Log\\Test\\DummyTest', array('__toString'));
|
|
} else {
|
|
$dummy = $this->getMock('Google\\Site_Kit_Dependencies\\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());
|
|
}
|
|
public function testContextCanContainAnything()
|
|
{
|
|
$closed = \fopen('php://memory', 'r');
|
|
\fclose($closed);
|
|
$context = array('bool' => \true, 'null' => null, 'string' => 'Foo', 'int' => 0, 'float' => 0.5, 'nested' => array('with object' => new \Google\Site_Kit_Dependencies\Psr\Log\Test\DummyTest()), 'object' => new \DateTime(), 'resource' => \fopen('php://memory', 'r'), 'closed' => $closed);
|
|
$this->getLogger()->warning('Crazy context data', $context);
|
|
$expected = array('warning Crazy context data');
|
|
$this->assertEquals($expected, $this->getLogs());
|
|
}
|
|
public function testContextExceptionKeyCanBeExceptionOrOtherValues()
|
|
{
|
|
$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());
|
|
}
|
|
}
|