Relate deprecations from DataProvider with corresponding tests

Author: staabm

src/Framework/TestBuilder.php

@@ -21,6 +21,7 @@
 use PHPUnit\Metadata\ExcludeStaticPropertyFromBackup;
 use PHPUnit\Metadata\Parser\Registry as MetadataRegistry;
 use PHPUnit\Metadata\PreserveGlobalState;
+use PHPUnit\Runner\ErrorHandler;
 use PHPUnit\TextUI\Configuration\Registry as ConfigurationRegistry;
 use ReflectionClass;
 
@@ -45,7 +46,12 @@ public function build(ReflectionClass $theClass, string $methodName, array $grou
         $data = null;
 
         if ($this->requirementsSatisfied($className, $methodName)) {
-            $data = (new DataProvider)->providedData($className, $methodName);
+            try {
+                ErrorHandler::instance()->enterTestCaseContext($methodName);
+                $data = (new DataProvider)->providedData($className, $methodName);
+            } finally {
+                ErrorHandler::instance()->leaveTestCaseContext();
+            }
         }
 
         if ($data !== null) {

src/Framework/TestRunner/TestRunner.php

@@ -81,7 +81,7 @@ public function run(TestCase $test): void
         $skipped    = false;
 
         if ($this->shouldErrorHandlerBeUsed($test)) {
-            ErrorHandler::instance()->enable();
+            ErrorHandler::instance()->enable($test);
         }
 
         $collectCodeCoverage = CodeCoverage::instance()->isActive() &&

src/Runner/ErrorHandler.php

@@ -36,6 +36,7 @@
 use PHPUnit\Event\Code\IssueTrigger\IssueTrigger;
 use PHPUnit\Event\Code\NoTestCaseObjectOnCallStackException;
 use PHPUnit\Event\Code\TestMethod;
+use PHPUnit\Framework\TestCase;
 use PHPUnit\Runner\Baseline\Baseline;
 use PHPUnit\Runner\Baseline\Issue;
 use PHPUnit\TextUI\Configuration\Registry;
@@ -63,6 +64,12 @@ final class ErrorHandler
      */
     private array $globalDeprecations = [];
 
+    /**
+     * @var array<string, list<array{int, string, string, int}>>
+     */
+    private array $testCaseContextDeprecations = [];
+    private ?string $testCaseContext           = null;
+
     /**
      * @var ?array{functions: list<non-empty-string>, methods: list<array{className: class-string, methodName: non-empty-string}>}
      */
@@ -207,7 +214,11 @@ public function __invoke(int $errorNumber, string $errorString, string $errorFil
 
     public function deprecationHandler(int $errorNumber, string $errorString, string $errorFile, int $errorLine): bool
     {
-        $this->globalDeprecations[] = [$errorNumber, $errorString, $errorFile, $errorLine];
+        if ($this->testCaseContext !== null) {
+            $this->testCaseContextDeprecations[$this->testCaseContext][] = [$errorNumber, $errorString, $errorFile, $errorLine];
+        } else {
+            $this->globalDeprecations[] = [$errorNumber, $errorString, $errorFile, $errorLine];
+        }
 
         return true;
     }
@@ -222,7 +233,7 @@ public function restoreDeprecationHandler(): void
         restore_error_handler();
     }
 
-    public function enable(): void
+    public function enable(TestCase $test): void
     {
         if ($this->enabled) {
             return;
@@ -239,7 +250,7 @@ public function enable(): void
         $this->enabled                     = true;
         $this->originalErrorReportingLevel = error_reporting();
 
-        $this->triggerGlobalDeprecations();
+        $this->triggerGlobalDeprecations($test);
 
         error_reporting($this->originalErrorReportingLevel & self::UNHANDLEABLE_LEVELS);
     }
@@ -271,6 +282,16 @@ public function useDeprecationTriggers(array $deprecationTriggers): void
         $this->deprecationTriggers = $deprecationTriggers;
     }
 
+    public function enterTestCaseContext(string $methodName): void
+    {
+        $this->testCaseContext = $methodName;
+    }
+
+    public function leaveTestCaseContext(): void
+    {
+        $this->testCaseContext = null;
+    }
+
     /**
      * @param non-empty-string $file
      * @param positive-int     $line
@@ -450,10 +471,14 @@ private function stackTrace(): string
         return $buffer;
     }
 
-    private function triggerGlobalDeprecations(): void
+    private function triggerGlobalDeprecations(TestCase $test): void
     {
         foreach ($this->globalDeprecations ?? [] as $d) {
             $this->__invoke(...$d);
         }
+
+        foreach ($this->testCaseContextDeprecations[$test->name()] ?? [] as $d) {
+            $this->__invoke(...$d);
+        }
     }
 }

tests/end-to-end/regression/6279.phpt

@@ -0,0 +1,27 @@
+--TEST--
+https://github.com/sebastianbergmann/phpunit/issues/6279
+--FILE--
+<?php declare(strict_types=1);
+$_SERVER['argv'][] = '--do-not-cache-result';
+$_SERVER['argv'][] = '--no-configuration';
+$_SERVER['argv'][] = '--display-deprecations';
+$_SERVER['argv'][] = __DIR__ . '/6279/TriggersDeprecationInDataProviderTest.php';
+
+require_once __DIR__ . '/../../bootstrap.php';
+(new PHPUnit\TextUI\Application)->run($_SERVER['argv']);
+--EXPECTF--
+PHPUnit %s by Sebastian Bergmann and contributors.
+
+Runtime: %s
+
+.D.                                                                 3 / 3 (100%)
+
+Time: %s, Memory: %s
+
+1 test triggered 1 deprecation:
+
+1) %s/end-to-end/regression/6279/TriggersDeprecationInDataProviderTest.php:24
+some deprecation
+
+OK, but there were issues!
+Tests: 3, Assertions: 3, Deprecations: 1.

tests/end-to-end/regression/6279/TriggersDeprecationInDataProviderTest.php

@@ -0,0 +1,47 @@
+<?php
+
+declare(strict_types=1);
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace PHPUnit\TestFixture\Issue6279;
+
+use const E_USER_DEPRECATED;
+use function trigger_error;
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+
+class TriggersDeprecationInDataProviderTest extends TestCase
+{
+    public static function dataProvider(): iterable
+    {
+        @trigger_error('some deprecation', E_USER_DEPRECATED);
+
+        yield [true];
+    }
+
+    #[Test]
+    public function method1(): void
+    {
+        $this->assertTrue(true);
+    }
+
+    #[Test]
+    #[DataProvider('dataProvider')]
+    public function method2(bool $value): void
+    {
+        $this->assertTrue($value);
+    }
+
+    #[Test]
+    public function method3(): void
+    {
+        $this->assertTrue(true);
+    }
+}