add controller test

Author: Litarnus

src/SentryBundle.php

@@ -5,10 +5,10 @@
 namespace Sentry\SentryBundle;
 
 use Sentry\SentryBundle\DependencyInjection\Compiler\AddLoginListenerTagPass;
+use Sentry\SentryBundle\DependencyInjection\Compiler\BufferFlushPass;
 use Sentry\SentryBundle\DependencyInjection\Compiler\CacheTracingPass;
 use Sentry\SentryBundle\DependencyInjection\Compiler\DbalTracingPass;
 use Sentry\SentryBundle\DependencyInjection\Compiler\HttpClientTracingPass;
-use Sentry\SentryBundle\DependencyInjection\Compiler\BufferFlushPass;
 use Symfony\Component\DependencyInjection\Compiler\PassConfig;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\Bundle;

tests/End2End/App/Controller/BufferFlushController.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\SentryBundle\Tests\End2End\App\Controller;
+
+use Psr\Log\LoggerInterface;
+use Symfony\Component\HttpFoundation\Response;
+
+class BufferFlushController
+{
+    /**
+     * @var LoggerInterface
+     */
+    private $logger;
+
+    public function __construct(LoggerInterface $logger)
+    {
+        $this->logger = $logger;
+    }
+
+    public function testBufferFlush(): Response
+    {
+        $this->logger->notice('Test notice message');
+        $this->logger->warning('Test warning message');
+        $this->logger->error('Test error message');
+
+        return new Response('OK');
+    }
+}

tests/End2End/App/config.yml

@@ -33,6 +33,11 @@ services:
     tags:
       - controller.service_arguments
 
+  Sentry\SentryBundle\Tests\End2End\App\Controller\BufferFlushController:
+    autowire: true
+    tags:
+      - controller.service_arguments
+
   Sentry\SentryBundle\Tests\End2End\App\Command\MainCommand:
     tags: [{ name: 'console.command', command: 'main-command' }]
 
@@ -42,3 +47,12 @@ monolog:
       type:  stream
       path:  "%kernel.logs_dir%/%kernel.environment%.log"
       level: debug
+    sentry:
+      type: sentry
+      level: warning
+      hub_id: 'Sentry\State\HubInterface'
+    sentry_buffer:
+      type: buffer
+      handler: sentry
+      level: notice
+      buffer_size: 50

tests/End2End/App/routing.yml

@@ -41,3 +41,7 @@ tracing_ping_database:
 tracing_ignored_transaction:
   path: /tracing/ignored-transaction
   defaults: { _controller: 'Sentry\SentryBundle\Tests\End2End\App\Controller\TracingController::ignoredTransaction' }
+
+buffer_flush:
+  path: /buffer-flush
+  defaults: { _controller: 'Sentry\SentryBundle\Tests\End2End\App\Controller\BufferFlushController::testBufferFlush' }

tests/End2End/BufferFlushEnd2EndTest.php

@@ -0,0 +1,55 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\SentryBundle\Tests\End2End;
+
+use Sentry\SentryBundle\Tests\End2End\App\Kernel;
+use Symfony\Bundle\FrameworkBundle\Client;
+use Symfony\Bundle\FrameworkBundle\KernelBrowser;
+use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
+
+if (!class_exists(KernelBrowser::class) && class_exists(Client::class)) {
+    class_alias(Client::class, KernelBrowser::class);
+}
+
+/**
+ * @runTestsInSeparateProcesses
+ */
+class BufferFlushEnd2EndTest extends WebTestCase
+{
+    protected static function getKernelClass(): string
+    {
+        return Kernel::class;
+    }
+
+    /**
+     * Test that log messages from a controller action are properly flushed after kernel termination.
+     */
+    public function testLogMessagesAvailableAfterKernelTermination(): void
+    {
+        StubTransport::$events = [];
+
+        $client = static::createClient(['debug' => false]);
+
+        $client->request('GET', '/buffer-flush');
+
+        $this->assertResponseIsSuccessful();
+        $this->assertEquals('OK', $client->getResponse()->getContent());
+
+        $events = StubTransport::$events;
+
+        $this->assertCount(2, $events);
+
+        $foundMessages = [];
+
+        foreach ($events as $event) {
+            if ($event->getMessage()) {
+                $foundMessages[] = $event->getMessage();
+            }
+        }
+
+        $this->assertContains('Test warning message', $foundMessages);
+        $this->assertContains('Test error message', $foundMessages);
+    }
+}