Add stack trace to Test\DeprecationTriggered event

Author: sebastianbergmann

src/Event/Emitter/DispatchingEmitter.php

@@ -791,11 +791,12 @@ public function testTriggeredPhpDeprecation(Code\Test $test, string $message, st
      * @param non-empty-string $message
      * @param non-empty-string $file
      * @param positive-int     $line
+     * @param non-empty-string $stackTrace
      *
      * @throws InvalidArgumentException
      * @throws UnknownEventTypeException
      */
-    public function testTriggeredDeprecation(Code\Test $test, string $message, string $file, int $line, bool $suppressed, bool $ignoredByBaseline, bool $ignoredByTest, IssueTrigger $trigger): void
+    public function testTriggeredDeprecation(Code\Test $test, string $message, string $file, int $line, bool $suppressed, bool $ignoredByBaseline, bool $ignoredByTest, IssueTrigger $trigger, string $stackTrace): void
     {
         $this->dispatcher->dispatch(
             new Test\DeprecationTriggered(
@@ -808,6 +809,7 @@ public function testTriggeredDeprecation(Code\Test $test, string $message, strin
                 $ignoredByBaseline,
                 $ignoredByTest,
                 $trigger,
+                $stackTrace,
             ),
         );
     }

src/Event/Emitter/Emitter.php

@@ -190,8 +190,9 @@ public function testTriggeredPhpDeprecation(Code\Test $test, string $message, st
      * @param non-empty-string $message
      * @param non-empty-string $file
      * @param positive-int     $line
+     * @param non-empty-string $stackTrace
      */
-    public function testTriggeredDeprecation(Code\Test $test, string $message, string $file, int $line, bool $suppressed, bool $ignoredByBaseline, bool $ignoredByTest, IssueTrigger $trigger): void;
+    public function testTriggeredDeprecation(Code\Test $test, string $message, string $file, int $line, bool $suppressed, bool $ignoredByBaseline, bool $ignoredByTest, IssueTrigger $trigger, string $stackTrace): void;
 
     /**
      * @param non-empty-string $message

src/Event/Events/Test/Issue/DeprecationTriggered.php

@@ -46,12 +46,18 @@
     private bool $ignoredByTest;
     private IssueTrigger $trigger;
 
+    /**
+     * @var non-empty-string
+     */
+    private string $stackTrace;
+
     /**
      * @param non-empty-string $message
      * @param non-empty-string $file
      * @param positive-int     $line
+     * @param non-empty-string $stackTrace
      */
-    public function __construct(Telemetry\Info $telemetryInfo, Test $test, string $message, string $file, int $line, bool $suppressed, bool $ignoredByBaseline, bool $ignoredByTest, IssueTrigger $trigger)
+    public function __construct(Telemetry\Info $telemetryInfo, Test $test, string $message, string $file, int $line, bool $suppressed, bool $ignoredByBaseline, bool $ignoredByTest, IssueTrigger $trigger, string $stackTrace)
     {
         $this->telemetryInfo     = $telemetryInfo;
         $this->test              = $test;
@@ -62,6 +68,7 @@ public function __construct(Telemetry\Info $telemetryInfo, Test $test, string $m
         $this->ignoredByBaseline = $ignoredByBaseline;
         $this->ignoredByTest     = $ignoredByTest;
         $this->trigger           = $trigger;
+        $this->stackTrace        = $stackTrace;
     }
 
     public function telemetryInfo(): Telemetry\Info
@@ -118,6 +125,14 @@ public function trigger(): IssueTrigger
         return $this->trigger;
     }
 
+    /**
+     * @return non-empty-string
+     */
+    public function stackTrace(): string
+    {
+        return $this->stackTrace;
+    }
+
     public function asString(): string
     {
         $message = $this->message;

src/Runner/ErrorHandler.php

@@ -32,6 +32,7 @@
 use function error_reporting;
 use function restore_error_handler;
 use function set_error_handler;
+use function sprintf;
 use PHPUnit\Event;
 use PHPUnit\Event\Code\IssueTrigger\IssueTrigger;
 use PHPUnit\Event\Code\NoTestCaseObjectOnCallStackException;
@@ -175,6 +176,7 @@ public function __invoke(int $errorNumber, string $errorString, string $errorFil
                     $ignoredByBaseline,
                     $ignoredByTest,
                     $this->trigger($test, true),
+                    $this->stackTrace(),
                 );
 
                 break;
@@ -388,4 +390,27 @@ private function frameIsMethod(array $frame, array $method): bool
             isset($frame['function']) &&
             $frame['function'] === $method['methodName'];
     }
+
+    /**
+     * @return non-empty-string
+     */
+    private function stackTrace(): string
+    {
+        $buffer      = '';
+        $excludeList = new ExcludeList(true);
+
+        foreach ($this->errorStackTrace() as $frame) {
+            if ($excludeList->isExcluded($frame['file'])) {
+                continue;
+            }
+
+            $buffer .= sprintf(
+                "%s:%s\n",
+                $frame['file'],
+                $frame['line'] ?? '?',
+            );
+        }
+
+        return $buffer;
+    }
 }

tests/unit/Event/Events/Test/Issue/DeprecationTriggeredTest.php

@@ -30,6 +30,7 @@ public function testConstructorSetsValues(): void
         $ignoredByBaseline = false;
         $ignoredByTest     = false;
         $trigger           = IssueTrigger::unknown();
+        $stackTrace        = 'stack trace';
 
         $event = new DeprecationTriggered(
             $telemetryInfo,
@@ -41,6 +42,7 @@ public function testConstructorSetsValues(): void
             $ignoredByBaseline,
             $ignoredByTest,
             $trigger,
+            $stackTrace,
         );
 
         $this->assertSame($telemetryInfo, $event->telemetryInfo());
@@ -53,6 +55,7 @@ public function testConstructorSetsValues(): void
         $this->assertSame($ignoredByTest, $event->ignoredByTest());
         $this->assertSame('Test Triggered Deprecation (FooTest::testBar, unknown if issue was triggered in first-party code or third-party code)' . PHP_EOL . 'message', $event->asString());
         $this->assertSame($trigger, $event->trigger());
+        $this->assertSame($stackTrace, $event->stackTrace());
     }
 
     public function testCanBeIgnoredByBaseline(): void
@@ -67,6 +70,7 @@ public function testCanBeIgnoredByBaseline(): void
             true,
             false,
             IssueTrigger::unknown(),
+            'stack trace',
         );
 
         $this->assertTrue($event->ignoredByBaseline());
@@ -85,6 +89,7 @@ public function testCanBeIgnoredByTest(): void
             false,
             true,
             IssueTrigger::unknown(),
+            'stack trace',
         );
 
         $this->assertTrue($event->ignoredByTest());
@@ -103,6 +108,7 @@ public function testCanBeSuppressed(): void
             false,
             false,
             IssueTrigger::unknown(),
+            'stack trace',
         );
 
         $this->assertTrue($event->wasSuppressed());