Improve E2E tests for the Performance Monitoring feature (#517)

Jean85 · web-flow · commit c5caac2ad539 · 2021-07-07T20:31:41.000+02:00
diff --git a/.github/workflows/tests.yaml b/.github/workflows/tests.yaml
@@ -23,13 +23,17 @@ jobs:
           - '7.3'
           - '7.2'
         sentry_constraint: [false]
+        dbal_constraint: [false]
         symfony_constraint: ['']
         experimental: [false]
         include:
 #          - description: 'sentry/sentry dev-develop'
 #            php: '7.4'
 #            sentry_constraint: 'dev-develop'
 #            experimental: true
+          - description: 'DBAL 2'
+            php: '7.4'
+            dbal_constraint: '^2.13'
           - description: 'Symfony 4.4'
             php: '7.3'
             symfony_constraint: 4.4.*
@@ -41,6 +45,7 @@ jobs:
           - description: 'prefer lowest'
             php: '7.2'
             composer_option: '--prefer-lowest'
+            symfony_constraint: ^3.4.44
             env:
               SYMFONY_DEPRECATIONS_HELPER: disabled
 
@@ -61,6 +66,8 @@ jobs:
         run: composer global require --no-progress --no-scripts --no-plugins symfony/flex
       - run: composer remove --dev symfony/messenger --no-update
         if: matrix.symfony_constraint == '3.4.*' || matrix.composer_option == '--prefer-lowest'
+      - run: composer require --dev doctrine/dbal ${{ matrix.dbal_constraint }} --no-update
+        if: matrix.dbal_constraint
       - run: composer update --no-progress --ansi ${{ matrix.composer_option }}
       - run: composer require sentry/sentry dev-develop
         if: matrix.sentry_constraint == 'dev-develop'
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -115,11 +115,6 @@ parameters:
 			count: 1
 			path: src/aliases.php
 
-		-
-			message: "#^Class Symfony\\\\Bundle\\\\FrameworkBundle\\\\Client not found\\.$#"
-			count: 1
-			path: tests/End2End/End2EndTest.php
-
 		-
 			message: "#^Call to method getException\\(\\) on an unknown class Symfony\\\\Component\\\\HttpKernel\\\\Event\\\\GetResponseForExceptionEvent\\.$#"
 			count: 1
diff --git a/tests/Command/SentryTestCommandTest.php b/tests/Command/SentryTestCommandTest.php
@@ -17,6 +17,14 @@
 
 class SentryTestCommandTest extends BaseTestCase
 {
+    protected function tearDown(): void
+    {
+        parent::tearDown();
+
+        // reset current Hub to avoid leaking the mock outside of this tests
+        SentrySdk::init();
+    }
+
     public function testExecuteSuccessfully(): void
     {
         $options = new Options(['dsn' => 'http://public:secret@example.com/sentry/1']);
diff --git a/tests/End2End/App/Controller/TracingController.php b/tests/End2End/App/Controller/TracingController.php
@@ -0,0 +1,52 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sentry\SentryBundle\Tests\End2End\App\Controller;
+
+use Doctrine\DBAL\Connection;
+use Sentry\State\HubInterface;
+use Sentry\Tracing\SpanContext;
+use Symfony\Component\HttpFoundation\Response;
+
+class TracingController
+{
+    /**
+     * @var HubInterface
+     */
+    private $hub;
+
+    /**
+     * @var Connection|null
+     */
+    private $connection;
+
+    public function __construct(HubInterface $hub, Connection $connection = null)
+    {
+        $this->hub = $hub;
+        $this->connection = $connection;
+    }
+
+    public function pingDatabase(): Response
+    {
+        $this->hub->setSpan(
+            $this->hub->getSpan()
+                ->startChild($this->createSpan())
+        );
+
+        if ($this->connection) {
+            $this->connection->executeQuery('SELECT 1');
+        }
+
+        return new Response('Success');
+    }
+
+    private function createSpan(): SpanContext
+    {
+        $spanContext = new SpanContext();
+        $spanContext->setOp('mock.span');
+        $spanContext->setDescription('mocked subspan');
+
+        return $spanContext;
+    }
+}
diff --git a/tests/End2End/App/Kernel.php b/tests/End2End/App/Kernel.php
@@ -4,6 +4,7 @@
 
 namespace Sentry\SentryBundle\Tests\End2End\App;
 
+use Doctrine\Bundle\DoctrineBundle\DoctrineBundle;
 use Symfony\Component\Config\Loader\LoaderInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\BundleInterface;
@@ -12,25 +13,44 @@
 
 class Kernel extends SymfonyKernel
 {
+    /**
+     * @var string
+     */
+    private static $cacheDir = null;
+
     /**
      * @return BundleInterface[]
      */
     public function registerBundles(): array
     {
-        return [
+        $bundles = [
             new \Symfony\Bundle\FrameworkBundle\FrameworkBundle(),
             new \Symfony\Bundle\MonologBundle\MonologBundle(),
             new \Sentry\SentryBundle\SentryBundle(),
         ];
+
+        if (class_exists(DoctrineBundle::class)) {
+            $bundles[] = new DoctrineBundle();
+        }
+
+        return $bundles;
     }
 
     public function registerContainerConfiguration(LoaderInterface $loader): void
     {
         $loader->load(__DIR__ . '/config.yml');
 
+        if (self::VERSION_ID >= 50000) {
+            $loader->load(__DIR__ . '/deprecations_for_5.yml');
+        }
+
         if (interface_exists(MessageBusInterface::class) && self::VERSION_ID >= 40300) {
             $loader->load(__DIR__ . '/messenger.yml');
         }
+
+        if (class_exists(DoctrineBundle::class)) {
+            $loader->load(__DIR__ . '/doctrine.yml');
+        }
     }
 
     protected function build(ContainerBuilder $container): void
@@ -39,4 +59,13 @@ protected function build(ContainerBuilder $container): void
 
         parent::build($container);
     }
+
+    public function getCacheDir(): string
+    {
+        if (null === self::$cacheDir) {
+            self::$cacheDir = sys_get_temp_dir() . \DIRECTORY_SEPARATOR . uniqid('sentry-symfony-');
+        }
+
+        return self::$cacheDir;
+    }
 }
diff --git a/tests/End2End/App/KernelWithTracing.php b/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');
+    }
+}
diff --git a/tests/End2End/App/config.yml b/tests/End2End/App/config.yml
@@ -1,7 +1,10 @@
 sentry:
+  tracing:
+    enabled: true
   options:
     capture_silenced_errors: true
     error_types: E_ALL & ~E_USER_DEPRECATED
+    traces_sample_rate: 0
 
 framework:
   router: { resource: "%routing_config_dir%/routing.yml" }
diff --git a/tests/End2End/App/deprecations_for_5.yml b/tests/End2End/App/deprecations_for_5.yml
@@ -0,0 +1,3 @@
+framework:
+  router:
+    utf8: true
diff --git a/tests/End2End/App/doctrine.yml b/tests/End2End/App/doctrine.yml
@@ -0,0 +1,3 @@
+doctrine:
+  dbal:
+    url: 'sqlite:///%kernel.cache_dir%/data.db'
diff --git a/tests/End2End/App/routing.yml b/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' }
diff --git a/tests/End2End/App/tracing.yml b/tests/End2End/App/tracing.yml
@@ -0,0 +1,13 @@
+sentry:
+  tracing:
+    enabled: true
+  options:
+    traces_sample_rate: 1
+
+services:
+  Sentry\SentryBundle\Tests\End2End\App\Controller\TracingController:
+    arguments:
+      $hub: '@Sentry\State\HubInterface'
+      $connection: '@?doctrine.dbal.default_connection'
+    tags:
+      - { name: controller.service_arguments }
diff --git a/tests/End2End/End2EndTest.php b/tests/End2End/End2EndTest.php
@@ -18,7 +18,7 @@
 use Symfony\Component\HttpKernel\KernelInterface;
 use Symfony\Component\Messenger\MessageBusInterface;
 
-if (!class_exists(KernelBrowser::class)) {
+if (!class_exists(KernelBrowser::class) && class_exists(Client::class)) {
     class_alias(Client::class, KernelBrowser::class);
 }
 
diff --git a/tests/End2End/StubTransportFactory.php b/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';
                 }
diff --git a/tests/End2End/TracingEnd2EndTest.php b/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);
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,14 @@`
`17`	`17`
`18`	`18`	`class SentryTestCommandTest extends BaseTestCase`
`19`	`19`	`{`
	`20`	`+ protected function tearDown(): void`
	`21`	`+ {`
	`22`	`+ parent::tearDown();`
	`23`	`+`
	`24`	`+ // reset current Hub to avoid leaking the mock outside of this tests`
	`25`	`+ SentrySdk::init();`
	`26`	`+ }`
	`27`	`+`
`20`	`28`	`public function testExecuteSuccessfully(): void`
`21`	`29`	`{`
`22`	`30`	`$options = new Options(['dsn' => 'http://public:[email protected]/sentry/1']);`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+framework:`
	`2`	`+ router:`
	`3`	`+ utf8: true`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+doctrine:`
	`2`	`+ dbal:`
	`3`	`+ url: 'sqlite:///%kernel.cache_dir%/data.db'`