Add TokenProcessor

maidmaid · maidmaid · commit 26b9d1ff4268 · 2017-07-01T11:16:16.000+02:00
diff --git a/src/Symfony/Bridge/Monolog/Processor/TokenProcessor.php b/src/Symfony/Bridge/Monolog/Processor/TokenProcessor.php
@@ -0,0 +1,44 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\Monolog\Processor;
+
+use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
+use Symfony\Component\Security\Core\Role\RoleInterface;
+
+/**
+ * Adds the current security token to the log entry.
+ *
+ * @author Dany Maillard <danymaillard93b@gmail.com>
+ */
+class TokenProcessor
+{
+    private $tokenStorage;
+
+    public function __construct(TokenStorageInterface $tokenStorage)
+    {
+        $this->tokenStorage = $tokenStorage;
+    }
+
+    public function __invoke(array $records)
+    {
+        $records['extra']['token'] = null;
+        if (null !== $token = $this->tokenStorage->getToken()) {
+            $records['extra']['token'] = array(
+                'username' => $token->getUsername(),
+                'authenticated' => $token->isAuthenticated(),
+                'roles' => array_map(function (RoleInterface $role) { return $role->getRole(); }, $token->getRoles()),
+            );
+        }
+
+        return $records;
+    }
+}
diff --git a/src/Symfony/Bridge/Monolog/Tests/Processor/TokenProcessorTest.php b/src/Symfony/Bridge/Monolog/Tests/Processor/TokenProcessorTest.php
@@ -0,0 +1,43 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\Monolog\Tests\Processor;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Bridge\Monolog\Processor\TokenProcessor;
+use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
+use Symfony\Component\Security\Core\Authentication\Token\UsernamePasswordToken;
+use Symfony\Component\Security\Core\Role\RoleInterface;
+
+/**
+ * Tests the TokenProcessor.
+ *
+ * @author Dany Maillard <danymaillard93b@gmail.com>
+ */
+class TokenProcessorTest extends TestCase
+{
+    public function testProcessor()
+    {
+        $token = new UsernamePasswordToken('user', 'password', 'provider', array('ROLE_USER'));
+        $tokenStorage = $this->getMockBuilder(TokenStorageInterface::class)->getMock();
+        $tokenStorage->method('getToken')->willReturn($token);
+
+        $processor = new TokenProcessor($tokenStorage);
+        $record = array('extra' => array());
+        $record = $processor($record);
+
+        $this->assertArrayHasKey('token', $record['extra']);
+        $this->assertEquals($token->getUsername(), $record['extra']['token']['username']);
+        $this->assertEquals($token->isAuthenticated(), $record['extra']['token']['authenticated']);
+        $roles = array_map(function (RoleInterface $role) { return $role->getRole(); }, $token->getRoles());
+        $this->assertEquals($roles, $record['extra']['token']['roles']);
+    }
+}
diff --git a/src/Symfony/Bridge/Monolog/composer.json b/src/Symfony/Bridge/Monolog/composer.json
@@ -23,6 +23,7 @@
     "require-dev": {
         "symfony/console": "~2.8|~3.0|~4.0",
         "symfony/event-dispatcher": "~2.8|~3.0|~4.0",
+        "symfony/security-core": "~2.8|~3.0",
         "symfony/var-dumper": "~3.3|~4.0"
     },
     "conflict": {
