* * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace Symfony\Component\HttpKernel\Tests\DataCollector; use PHPUnit\Framework\TestCase; use Symfony\Component\ErrorHandler\Exception\SilencedErrorContext; use Symfony\Component\HttpFoundation\Request; use Symfony\Component\HttpFoundation\RequestStack; use Symfony\Component\HttpFoundation\Response; use Symfony\Component\HttpKernel\DataCollector\LoggerDataCollector; use Symfony\Component\HttpKernel\Log\DebugLoggerInterface; use Symfony\Component\VarDumper\Cloner\Data; class LoggerDataCollectorTest extends TestCase { public function testCollectWithUnexpectedFormat() { $logger = $this ->getMockBuilder(DebugLoggerInterface::class) ->onlyMethods(['countErrors', 'getLogs', 'clear']) ->getMock(); $logger->expects($this->once())->method('countErrors')->willReturn(123); $logger->expects($this->exactly(2))->method('getLogs')->willReturn([]); $c = new LoggerDataCollector($logger, __DIR__.'/'); $c->lateCollect(); $compilerLogs = $c->getCompilerLogs()->getValue('message'); $this->assertSame([ ['message' => 'Removed service "Psr\Container\ContainerInterface"; reason: private alias.'], ['message' => 'Removed service "Symfony\Component\DependencyInjection\ContainerInterface"; reason: private alias.'], ], $compilerLogs['Symfony\Component\DependencyInjection\Compiler\RemovePrivateAliasesPass']); $this->assertSame([ ['message' => 'Some custom logging message'], ['message' => 'With ending :'], ], $compilerLogs['Unknown Compiler Pass']); } public function testCollectFromDeprecationsLog() { $containerPathPrefix = __DIR__.'/'; $path = $containerPathPrefix.'Deprecations.log'; touch($path); file_put_contents($path, serialize([[ 'type' => 16384, 'message' => 'The "Symfony\Bundle\FrameworkBundle\Controller\Controller" class is deprecated since Symfony 4.2, use Symfony\Bundle\FrameworkBundle\Controller\AbstractController instead.', 'file' => '/home/hamza/projet/contrib/sf/vendor/symfony/framework-bundle/Controller/Controller.php', 'line' => 17, 'trace' => [[ 'file' => '/home/hamza/projet/contrib/sf/src/Controller/DefaultController.php', 'line' => 9, 'function' => 'spl_autoload_call', ]], 'count' => 1, ]])); $logger = $this ->getMockBuilder(DebugLoggerInterface::class) ->onlyMethods(['countErrors', 'getLogs', 'clear']) ->getMock(); $logger->expects($this->once())->method('countErrors')->willReturn(0); $logger->expects($this->exactly(2))->method('getLogs')->willReturn([]); $c = new LoggerDataCollector($logger, $containerPathPrefix); $c->lateCollect(); $processedLogs = $c->getProcessedLogs(); $this->assertCount(1, $processedLogs); $this->assertEquals($processedLogs[0]['type'], 'deprecation'); $this->assertEquals($processedLogs[0]['errorCount'], 1); $this->assertEquals($processedLogs[0]['timestamp'], (new \DateTimeImmutable())->setTimestamp(filemtime($path))->format(\DateTimeInterface::RFC3339_EXTENDED)); $this->assertEquals($processedLogs[0]['priority'], 100); $this->assertEquals($processedLogs[0]['priorityName'], 'DEBUG'); $this->assertNull($processedLogs[0]['channel']); $this->assertInstanceOf(Data::class, $processedLogs[0]['message']); $this->assertInstanceOf(Data::class, $processedLogs[0]['context']); @unlink($path); } public function testWithMainRequest() { $mainRequest = new Request(); $stack = new RequestStack(); $stack->push($mainRequest); $logger = $this ->getMockBuilder(DebugLoggerInterface::class) ->onlyMethods(['countErrors', 'getLogs', 'clear']) ->getMock(); $logger->expects($this->once())->method('countErrors')->with(null); $logger->expects($this->exactly(2))->method('getLogs')->with(null)->willReturn([]); $c = new LoggerDataCollector($logger, __DIR__.'/', $stack); $c->collect($mainRequest, new Response()); $c->lateCollect(); } public function testWithSubRequest() { $mainRequest = new Request(); $subRequest = new Request(); $stack = new RequestStack(); $stack->push($mainRequest); $stack->push($subRequest); $logger = $this ->getMockBuilder(DebugLoggerInterface::class) ->onlyMethods(['countErrors', 'getLogs', 'clear']) ->getMock(); $logger->expects($this->once())->method('countErrors')->with($subRequest); $logger->expects($this->exactly(2))->method('getLogs')->with($subRequest)->willReturn([]); $c = new LoggerDataCollector($logger, __DIR__.'/', $stack); $c->collect($subRequest, new Response()); $c->lateCollect(); } /** * @dataProvider getCollectTestData */ public function testCollect($nb, $logs, $expectedLogs, $expectedDeprecationCount, $expectedScreamCount, $expectedPriorities = null) { $logger = $this ->getMockBuilder(DebugLoggerInterface::class) ->onlyMethods(['countErrors', 'getLogs', 'clear']) ->getMock(); $logger->expects($this->once())->method('countErrors')->willReturn($nb); $logger->expects($this->exactly(2))->method('getLogs')->willReturn($logs); $c = new LoggerDataCollector($logger); $c->lateCollect(); $this->assertEquals('logger', $c->getName()); $this->assertEquals($nb, $c->countErrors()); $logs = array_map(function ($v) { if (isset($v['context']['exception'])) { $e = &$v['context']['exception']; $e = isset($e["\0*\0message"]) ? [$e["\0*\0message"], $e["\0*\0severity"]] : [$e["\0Symfony\Component\ErrorHandler\Exception\SilencedErrorContext\0severity"]]; } return $v; }, $c->getLogs()->getValue(true)); $this->assertEquals($expectedLogs, $logs); $this->assertEquals($expectedDeprecationCount, $c->countDeprecations()); $this->assertEquals($expectedScreamCount, $c->countScreams()); if (isset($expectedPriorities)) { $this->assertSame($expectedPriorities, $c->getPriorities()->getValue(true)); } } public function testReset() { $logger = $this ->getMockBuilder(DebugLoggerInterface::class) ->onlyMethods(['countErrors', 'getLogs', 'clear']) ->getMock(); $logger->expects($this->once())->method('clear'); $c = new LoggerDataCollector($logger); $c->reset(); } public static function getCollectTestData() { yield 'simple log' => [ 1, [['message' => 'foo', 'context' => [], 'priority' => 100, 'priorityName' => 'DEBUG']], [['message' => 'foo', 'context' => [], 'priority' => 100, 'priorityName' => 'DEBUG']], 0, 0, ]; yield 'log with a context' => [ 1, [['message' => 'foo', 'context' => ['foo' => 'bar'], 'priority' => 100, 'priorityName' => 'DEBUG']], [['message' => 'foo', 'context' => ['foo' => 'bar'], 'priority' => 100, 'priorityName' => 'DEBUG']], 0, 0, ]; if (!class_exists(SilencedErrorContext::class)) { return; } yield 'logs with some deprecations' => [ 1, [ ['message' => 'foo3', 'context' => ['exception' => new \ErrorException('warning', 0, \E_USER_WARNING)], 'priority' => 100, 'priorityName' => 'DEBUG'], ['message' => 'foo', 'context' => ['exception' => new \ErrorException('deprecated', 0, \E_DEPRECATED)], 'priority' => 100, 'priorityName' => 'DEBUG'], ['message' => 'foo2', 'context' => ['exception' => new \ErrorException('deprecated', 0, \E_USER_DEPRECATED)], 'priority' => 100, 'priorityName' => 'DEBUG'], ], [ ['message' => 'foo3', 'context' => ['exception' => ['warning', \E_USER_WARNING]], 'priority' => 100, 'priorityName' => 'DEBUG'], ['message' => 'foo', 'context' => ['exception' => ['deprecated', \E_DEPRECATED]], 'priority' => 100, 'priorityName' => 'DEBUG', 'errorCount' => 1, 'scream' => false], ['message' => 'foo2', 'context' => ['exception' => ['deprecated', \E_USER_DEPRECATED]], 'priority' => 100, 'priorityName' => 'DEBUG', 'errorCount' => 1, 'scream' => false], ], 2, 0, [100 => ['count' => 3, 'name' => 'DEBUG']], ]; yield 'logs with some silent errors' => [ 1, [ ['message' => 'foo3', 'context' => ['exception' => new \ErrorException('warning', 0, \E_USER_WARNING)], 'priority' => 100, 'priorityName' => 'DEBUG'], ['message' => 'foo3', 'context' => ['exception' => new SilencedErrorContext(\E_USER_WARNING, __FILE__, __LINE__)], 'priority' => 100, 'priorityName' => 'DEBUG'], ['message' => '0', 'context' => ['exception' => new SilencedErrorContext(\E_USER_WARNING, __FILE__, __LINE__)], 'priority' => 100, 'priorityName' => 'DEBUG'], ], [ ['message' => 'foo3', 'context' => ['exception' => ['warning', \E_USER_WARNING]], 'priority' => 100, 'priorityName' => 'DEBUG'], ['message' => 'foo3', 'context' => ['exception' => [\E_USER_WARNING]], 'priority' => 100, 'priorityName' => 'DEBUG', 'errorCount' => 1, 'scream' => true], ['message' => '0', 'context' => ['exception' => [\E_USER_WARNING]], 'priority' => 100, 'priorityName' => 'DEBUG', 'errorCount' => 1, 'scream' => true], ], 0, 2, ]; } }