Add tests for scheduler macro

Author: stayallive

test/Sentry/Features/ConsoleIntegrationTest.php

@@ -2,31 +2,95 @@
 
 namespace Sentry\Features;
 
+use Illuminate\Console\Scheduling\Schedule;
+use RuntimeException;
+use Sentry\CheckInStatus;
 use Sentry\Laravel\Tests\TestCase;
 use Illuminate\Console\Scheduling\Event;
 
 class ConsoleIntegrationTest extends TestCase
 {
-    public function setUp(): void
+    public function testScheduleMacro(): void
     {
-        if (!method_exists(Event::class, 'flushMacros')) {
-            $this->markTestSkipped('Macroable::flushMacros() is not available in this Laravel version.');
-        }
+        /** @var Event $scheduledEvent */
+        $scheduledEvent = $this->getScheduler()->call(function () {})->sentryMonitor('test-monitor');
+
+        $scheduledEvent->run($this->app);
+
+        // We expect a total of 2 events to be sent to Sentry:
+        // 1. The start check-in event
+        // 2. The finish check-in event
+        $this->assertEquals(2, $this->getEventsCount());
+
+        $finishCheckInEvent = $this->getLastEvent();
+
+        $this->assertNotNull($finishCheckInEvent->getCheckIn());
+        $this->assertEquals('test-monitor', $finishCheckInEvent->getCheckIn()->getMonitorSlug());
+        $this->assertEquals(CheckInStatus::ok(), $finishCheckInEvent->getCheckIn()->getStatus());
+    }
+
+    public function testScheduleMacroAutomaticSlug(): void
+    {
+        /** @var Event $scheduledEvent */
+        $scheduledEvent = $this->getScheduler()->command('inspire')->sentryMonitor();
 
-        parent::setUp(); // TODO: Change the autogenerated stub
+        $scheduledEvent->run($this->app);
+
+        // We expect a total of 2 events to be sent to Sentry:
+        // 1. The start check-in event
+        // 2. The finish check-in event
+        $this->assertEquals(2, $this->getEventsCount());
+
+        $finishCheckInEvent = $this->getLastEvent();
+
+        $this->assertNotNull($finishCheckInEvent->getCheckIn());
+        $this->assertEquals('scheduled_artisan-inspire', $finishCheckInEvent->getCheckIn()->getMonitorSlug());
+    }
+
+    public function testScheduleMacroWithoutSlugOrCommandName(): void
+    {
+        $this->expectException(RuntimeException::class);
+
+        $this->getScheduler()->call(function () {})->sentryMonitor();
     }
 
-    public function testArtisanCommandIsRegistered(): void
+    public function testScheduleMacroWithoutDsnSet(): void
     {
+        $this->resetApplicationWithConfig([
+            'sentry.dsn' => null,
+        ]);
+
+        /** @var Event $scheduledEvent */
+        $scheduledEvent = $this->getScheduler()->call('inspire')->sentryMonitor('test-monitor');
+
+        $scheduledEvent->callBeforeCallbacks($this->app);
+
+        $this->assertEquals(0, $this->getEventsCount());
+
+        $scheduledEvent->finish($this->app, 0);
+
+        $this->assertEquals(0, $this->getEventsCount());
+    }
+
+    public function testScheduleMacroIsRegistered(): void
+    {
+        if (!method_exists(Event::class, 'flushMacros')) {
+            $this->markTestSkipped('Macroable::flushMacros() is not available in this Laravel version.');
+        }
+
         Event::flushMacros();
 
         $this->refreshApplication();
 
         $this->assertTrue(Event::hasMacro('sentryMonitor'));
     }
 
-    public function testArtisanCommandIsRegisteredWithoutDsnSet(): void
+    public function testScheduleMacroIsRegisteredWithoutDsnSet(): void
     {
+        if (!method_exists(Event::class, 'flushMacros')) {
+            $this->markTestSkipped('Macroable::flushMacros() is not available in this Laravel version.');
+        }
+
         Event::flushMacros();
 
         $this->resetApplicationWithConfig([
@@ -35,4 +99,9 @@ public function testArtisanCommandIsRegisteredWithoutDsnSet(): void
 
         $this->assertTrue(Event::hasMacro('sentryMonitor'));
     }
+
+    private function getScheduler(): Schedule
+    {
+        return $this->app->make(Schedule::class);
+    }
 }

test/Sentry/IntegrationTest.php

@@ -153,9 +153,9 @@ public function testExceptionReportedUsingReportHelperIsNotMarkedAsUnhandled():
 
         report($testException);
 
-        $this->assertCount(1, $this->lastSentryEvents);
+        $this->assertEquals(1, $this->getEventsCount());
 
-        [, $hint] = $this->lastSentryEvents[0];
+        $hint = $this->getLastEventHint();
 
         $this->assertEquals($testException, $hint->exception);
         $this->assertNotNull($hint->mechanism);
@@ -168,9 +168,9 @@ public function testExceptionIsNotMarkedAsUnhandled(): void
 
         Integration::captureUnhandledException($testException);
 
-        $this->assertCount(1, $this->lastSentryEvents);
+        $this->assertEquals(1, $this->getEventsCount());
 
-        [, $hint] = $this->lastSentryEvents[0];
+        $hint = $this->getLastEventHint();
 
         $this->assertEquals($testException, $hint->exception);
         $this->assertNotNull($hint->mechanism);

test/Sentry/TestCase.php

@@ -8,6 +8,7 @@
 use Sentry\ClientInterface;
 use Sentry\Event;
 use Sentry\EventHint;
+use Sentry\EventType;
 use Sentry\State\Scope;
 use ReflectionProperty;
 use Sentry\Laravel\Tracing;
@@ -17,20 +18,30 @@
 
 abstract class TestCase extends LaravelTestCase
 {
+    private static $hasSetupGlobalEventProcessor = false;
+
     protected $setupConfig = [
         // Set config here before refreshing the app to set it in the container before Sentry is loaded
         // or use the `$this->resetApplicationWithConfig([ /* config */ ]);` helper method
     ];
 
     /** @var array<int, array{0: Event, 1: EventHint|null}> */
-    protected $lastSentryEvents = [];
+    protected static $lastSentryEvents = [];
 
     protected function getEnvironmentSetUp($app): void
     {
-        $this->lastSentryEvents = [];
+        self::$lastSentryEvents = [];
+
+        $this->setupGlobalEventProcessor();
 
-        $app['config']->set('sentry.before_send', function (Event $event, ?EventHint $hint) {
-            $this->lastSentryEvents[] = [$event, $hint];
+        $app['config']->set('sentry.before_send', static function (Event $event, ?EventHint $hint) {
+            self::$lastSentryEvents[] = [$event, $hint];
+
+            return null;
+        });
+
+        $app['config']->set('sentry.before_send_transaction', static function (Event $event, ?EventHint $hint) {
+            self::$lastSentryEvents[] = [$event, $hint];
 
             return null;
         });
@@ -110,10 +121,44 @@ protected function getLastBreadcrumb(): ?Breadcrumb
 
     protected function getLastEvent(): ?Event
     {
-        if (empty($this->lastSentryEvents)) {
+        if (empty(self::$lastSentryEvents)) {
             return null;
         }
 
-        return end($this->lastSentryEvents)[0];
+        return end(self::$lastSentryEvents)[0];
+    }
+
+    protected function getLastEventHint(): ?EventHint
+    {
+        if (empty(self::$lastSentryEvents)) {
+            return null;
+        }
+
+        return end(self::$lastSentryEvents)[1];
+    }
+
+    protected function getEventsCount(): int
+    {
+        return count(self::$lastSentryEvents);
+    }
+
+    private function setupGlobalEventProcessor(): void
+    {
+        if (self::$hasSetupGlobalEventProcessor) {
+            return;
+        }
+
+        Scope::addGlobalEventProcessor(static function (Event $event, ?EventHint $hint) {
+            // Regular events and transactions are handled by the `before_send` and `before_send_transaction` callbacks
+            if (in_array($event->getType(), [EventType::event(), EventType::transaction()], true)) {
+                return $event;
+            }
+
+            self::$lastSentryEvents[] = [$event, $hint];
+
+            return null;
+        });
+
+        self::$hasSetupGlobalEventProcessor = true;
     }
 }