Also trigger a warning for a data provider method that has a #[Test] attribute

Author: sebastianbergmann

src/Metadata/Api/DataProvider.php

@@ -15,7 +15,6 @@
 use function assert;
 use function explode;
 use function get_debug_type;
-use function is_a;
 use function is_array;
 use function is_int;
 use function is_string;
@@ -27,7 +26,6 @@
 use function rtrim;
 use function sprintf;
 use function str_replace;
-use function str_starts_with;
 use function strlen;
 use function substr;
 use function trim;
@@ -36,12 +34,12 @@
 use PHPUnit\Event\TestData\MoreThanOneDataSetFromDataProviderException;
 use PHPUnit\Event\TestData\TestDataCollection;
 use PHPUnit\Framework\InvalidDataProviderException;
-use PHPUnit\Framework\TestCase;
 use PHPUnit\Metadata\DataProvider as DataProviderMetadata;
 use PHPUnit\Metadata\MetadataCollection;
 use PHPUnit\Metadata\Parser\Registry as MetadataRegistry;
 use PHPUnit\Metadata\TestWith;
 use PHPUnit\Util\Reflection;
+use PHPUnit\Util\Test;
 use ReflectionClass;
 use ReflectionMethod;
 use Throwable;
@@ -109,19 +107,6 @@ private function dataProvidedByMethods(string $className, string $methodName, Me
         foreach ($dataProvider as $_dataProvider) {
             assert($_dataProvider instanceof DataProviderMetadata);
 
-            if (is_a($_dataProvider->className(), TestCase::class, true) &&
-                str_starts_with($_dataProvider->methodName(), 'test')) {
-                Event\Facade::emitter()->testRunnerTriggeredPhpunitWarning(
-                    sprintf(
-                        'The name of the data provider method %s::%s() used by test method %s::%s() begins with "test", therefore PHPUnit also treats it as a test method',
-                        $_dataProvider->className(),
-                        $_dataProvider->methodName(),
-                        $className,
-                        $methodName,
-                    ),
-                );
-            }
-
             $dataProviderMethod = new Event\Code\ClassMethod($_dataProvider->className(), $_dataProvider->methodName());
 
             Event\Facade::emitter()->dataProviderMethodCalled(
@@ -134,6 +119,19 @@ private function dataProvidedByMethods(string $className, string $methodName, Me
             try {
                 $class  = new ReflectionClass($_dataProvider->className());
                 $method = $class->getMethod($_dataProvider->methodName());
+
+                if (Test::isTestMethod($method)) {
+                    Event\Facade::emitter()->testRunnerTriggeredPhpunitWarning(
+                        sprintf(
+                            'Method %s::%s() used by test method %s::%s() is also a test method',
+                            $_dataProvider->className(),
+                            $_dataProvider->methodName(),
+                            $className,
+                            $methodName,
+                        ),
+                    );
+                }
+
                 $object = null;
 
                 if (!$method->isPublic()) {

tests/_files/DataProviderMethodHasTestAttributeTest.php

@@ -0,0 +1,29 @@
+<?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;
+
+use PHPUnit\Framework\Attributes\DataProvider;
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+
+final class DataProviderMethodHasTestAttributeTest extends TestCase
+{
+    #[Test]
+    public static function provider(): array
+    {
+        return [[true]];
+    }
+
+    #[DataProvider('provider')]
+    public function testOne(bool $b): void
+    {
+        $this->assertTrue($b);
+    }
+}

tests/end-to-end/data-provider/warning-when-data-provider-method-has-test-attribute.phpt

@@ -0,0 +1,42 @@
+--TEST--
+phpunit ../../_files/DataProviderMethodHasTestAttributeTest.php
+--FILE--
+<?php declare(strict_types=1);
+$_SERVER['argv'][] = '--do-not-cache-result';
+$_SERVER['argv'][] = '--no-configuration';
+$_SERVER['argv'][] = '--debug';
+$_SERVER['argv'][] = __DIR__ . '/../../_files/DataProviderMethodHasTestAttributeTest.php';
+
+require_once __DIR__ . '/../../bootstrap.php';
+
+(new PHPUnit\TextUI\Application)->run($_SERVER['argv']);
+--EXPECTF--
+PHPUnit Started (PHPUnit %s using %s)
+Test Runner Configured
+Data Provider Method Called (PHPUnit\TestFixture\DataProviderMethodHasTestAttributeTest::provider for test method PHPUnit\TestFixture\DataProviderMethodHasTestAttributeTest::testOne)
+Test Runner Triggered Warning (Method PHPUnit\TestFixture\DataProviderMethodHasTestAttributeTest::provider() used by test method PHPUnit\TestFixture\DataProviderMethodHasTestAttributeTest::testOne() is also a test method)
+Data Provider Method Finished for PHPUnit\TestFixture\DataProviderMethodHasTestAttributeTest::testOne:
+- PHPUnit\TestFixture\DataProviderMethodHasTestAttributeTest::provider
+Test Suite Loaded (2 tests)
+Event Facade Sealed
+Test Runner Started
+Test Suite Sorted
+Test Runner Execution Started (2 tests)
+Test Suite Started (PHPUnit\TestFixture\DataProviderMethodHasTestAttributeTest, 2 tests)
+Test Preparation Started (PHPUnit\TestFixture\DataProviderMethodHasTestAttributeTest::provider)
+Test Prepared (PHPUnit\TestFixture\DataProviderMethodHasTestAttributeTest::provider)
+Test Passed (PHPUnit\TestFixture\DataProviderMethodHasTestAttributeTest::provider)
+Test Considered Risky (PHPUnit\TestFixture\DataProviderMethodHasTestAttributeTest::provider)
+This test did not perform any assertions
+Test Finished (PHPUnit\TestFixture\DataProviderMethodHasTestAttributeTest::provider)
+Test Suite Started (PHPUnit\TestFixture\DataProviderMethodHasTestAttributeTest::testOne, 1 test)
+Test Preparation Started (PHPUnit\TestFixture\DataProviderMethodHasTestAttributeTest::testOne#0)
+Test Prepared (PHPUnit\TestFixture\DataProviderMethodHasTestAttributeTest::testOne#0)
+Assertion Succeeded (Constraint: is true, Value: true)
+Test Passed (PHPUnit\TestFixture\DataProviderMethodHasTestAttributeTest::testOne#0)
+Test Finished (PHPUnit\TestFixture\DataProviderMethodHasTestAttributeTest::testOne#0)
+Test Suite Finished (PHPUnit\TestFixture\DataProviderMethodHasTestAttributeTest::testOne, 1 test)
+Test Suite Finished (PHPUnit\TestFixture\DataProviderMethodHasTestAttributeTest, 2 tests)
+Test Runner Execution Finished
+Test Runner Finished
+PHPUnit Finished (Shell Exit Code: 1)

tests/end-to-end/data-provider/warning-when-data-provider-method-name-begins-with-test.phpt

@@ -13,8 +13,8 @@ require_once __DIR__ . '/../../bootstrap.php';
 --EXPECTF--
 PHPUnit Started (PHPUnit %s using %s)
 Test Runner Configured
-Test Runner Triggered Warning (The name of the data provider method PHPUnit\TestFixture\DataProviderMethodNameStartsWithTestTest::testProvider() used by test method PHPUnit\TestFixture\DataProviderMethodNameStartsWithTestTest::testOne() begins with "test", therefore PHPUnit also treats it as a test method)
 Data Provider Method Called (PHPUnit\TestFixture\DataProviderMethodNameStartsWithTestTest::testProvider for test method PHPUnit\TestFixture\DataProviderMethodNameStartsWithTestTest::testOne)
+Test Runner Triggered Warning (Method PHPUnit\TestFixture\DataProviderMethodNameStartsWithTestTest::testProvider() used by test method PHPUnit\TestFixture\DataProviderMethodNameStartsWithTestTest::testOne() is also a test method)
 Data Provider Method Finished for PHPUnit\TestFixture\DataProviderMethodNameStartsWithTestTest::testOne:
 - PHPUnit\TestFixture\DataProviderMethodNameStartsWithTestTest::testProvider
 Test Suite Loaded (2 tests)