Add and End2End test for tracing

Author: Jean85

tests/End2End/App/Controller/TracingController.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\SentryBundle\Tests\End2End\App\Controller;
+
+use Doctrine\DBAL\Connection;
+use Symfony\Component\HttpFoundation\Response;
+
+class TracingController
+{
+    /**
+     * @var Connection
+     */
+    private $connection;
+
+    public function __construct(Connection $connection)
+    {
+        $this->connection = $connection;
+    }
+
+    public function pingDatabase(): Response
+    {
+        $this->connection->executeQuery('SELECT 1');
+
+        return new Response('Success');
+    }
+}

tests/End2End/App/KernelWithTracing.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\SentryBundle\Tests\End2End\App;
+
+use Symfony\Component\Config\Loader\LoaderInterface;
+
+class KernelWithTracing extends Kernel
+{
+    public function registerContainerConfiguration(LoaderInterface $loader): void
+    {
+        parent::registerContainerConfiguration($loader);
+
+        $loader->load(__DIR__ . '/tracing.yml');
+    }
+}

tests/End2End/App/routing.yml

@@ -29,3 +29,7 @@ dispatch:
 dispatch_unrecoverable:
   path: /dispatch-unrecoverable-message
   defaults: { _controller: 'Sentry\SentryBundle\Tests\End2End\App\Controller\MessengerController::dispatchUnrecoverableMessage' }
+
+tracing_ping_database:
+  path: /tracing/ping-database
+  defaults: { _controller: 'Sentry\SentryBundle\Tests\End2End\App\Controller\TracingController::pingDatabase' }

tests/End2End/App/tracing.yml

@@ -0,0 +1,12 @@
+sentry:
+  tracing:
+    enabled: true
+  options:
+    traces_sample_rate: 1
+
+services:
+  Sentry\SentryBundle\Tests\End2End\App\Controller\TracingController:
+    arguments:
+      - '@doctrine.dbal.default_connection'
+    tags:
+      - controller.service_arguments

tests/End2End/End2EndTest.php

@@ -19,6 +19,7 @@
 use Symfony\Component\Messenger\MessageBusInterface;
 
 if (!class_exists(KernelBrowser::class)) {
+    /** @phpstan-ignore-next-line */
     class_alias(Client::class, KernelBrowser::class);
 }
 

tests/End2End/StubTransportFactory.php

@@ -34,6 +34,11 @@ public function send(Event $event): PromiseInterface
                     $message = $event->getMessage();
                 } elseif ($event->getExceptions()) {
                     $message = $event->getExceptions()[0]->getValue();
+                } elseif ($event->getTransaction()) {
+                    $message = 'TRACING: ' . $event->getTransaction();
+                    foreach ($event->getSpans() as $i => $span) {
+                        $message .= \PHP_EOL . $i . ') ' . $span->getDescription();
+                    }
                 } else {
                     $message = 'NO MESSAGE NOR EXCEPTIONS';
                 }

tests/End2End/TracingEnd2EndTest.php

@@ -0,0 +1,71 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\SentryBundle\Tests\End2End;
+
+use Sentry\SentryBundle\Tests\End2End\App\KernelWithTracing;
+use Sentry\State\HubInterface;
+use Symfony\Bundle\FrameworkBundle\Client;
+use Symfony\Bundle\FrameworkBundle\KernelBrowser;
+use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
+use Symfony\Component\HttpFoundation\Response;
+
+if (!class_exists(KernelBrowser::class)) {
+    /** @phpstan-ignore-next-line */
+    class_alias(Client::class, KernelBrowser::class);
+}
+
+class TracingEnd2EndTest extends WebTestCase
+{
+    public const SENT_EVENTS_LOG = '/tmp/sentry_e2e_test_sent_events.log';
+
+    protected static function getKernelClass(): string
+    {
+        return KernelWithTracing::class;
+    }
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        file_put_contents(self::SENT_EVENTS_LOG, '');
+    }
+
+    public function testTracingWithDoctrineConnectionPing(): void
+    {
+        $client = static::createClient(['debug' => false]);
+
+        $client->request('GET', '/tracing/ping-database');
+
+        $response = $client->getResponse();
+
+        $this->assertInstanceOf(Response::class, $response);
+        $this->assertSame(200, $response->getStatusCode());
+
+        $this->assertLastEventIdIsNotNull($client);
+        $this->assertTracingEventCount(1);
+    }
+
+    private function assertLastEventIdIsNotNull(KernelBrowser $client): void
+    {
+        $container = $client->getContainer();
+        $this->assertNotNull($container);
+
+        $hub = $container->get('test.hub');
+        $this->assertInstanceOf(HubInterface::class, $hub);
+
+        $this->assertNotNull($hub->getLastEventId(), 'Last error not captured');
+    }
+
+    private function assertTracingEventCount(int $expectedCount): void
+    {
+        $events = file_get_contents(self::SENT_EVENTS_LOG);
+        $this->assertNotFalse($events, 'Cannot read sent events log');
+        $listOfTracingEvents = array_filter(explode(StubTransportFactory::SEPARATOR, trim($events)), static function (string $elem) {
+            return str_contains('TRACING', $elem);
+        });
+
+        $this->assertCount($expectedCount, $listOfTracingEvents, 'Wrong number of tracing events sent: ' . \PHP_EOL . $events);
+    }
+}