Closes #6119

Author: sebastianbergmann

ChangeLog-10.5.md

@@ -7,6 +7,7 @@ All notable changes of the PHPUnit 10.5 release series are documented in this fi
 ### Changed
 
 * [#6117](https://github.com/sebastianbergmann/phpunit/issues/6117): Include source location information for issues triggered during test in `--debug` output
+* [#6119](https://github.com/sebastianbergmann/phpunit/issues/6119): Improve message for errors that occur while parsing attributes
 
 ## [10.5.44] - 2025-01-31
 

src/Metadata/Exception/InvalidAttributeException.php

@@ -0,0 +1,45 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <sebastian@phpunit.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace PHPUnit\Metadata;
+
+use const PHP_EOL;
+use function sprintf;
+use PHPUnit\Exception;
+use RuntimeException;
+
+/**
+ * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
+ *
+ * @internal This class is not covered by the backward compatibility promise for PHPUnit
+ */
+final class InvalidAttributeException extends RuntimeException implements Exception
+{
+    /**
+     * @param non-empty-string $attributeName
+     * @param non-empty-string $target
+     * @param non-empty-string $file
+     * @param positive-int     $line
+     * @param non-empty-string $message
+     */
+    public function __construct(string $attributeName, string $target, string $file, int $line, string $message)
+    {
+        parent::__construct(
+            sprintf(
+                'Invalid attribute %s for %s in %s:%d%s%s',
+                $attributeName,
+                $target,
+                $file,
+                $line,
+                PHP_EOL,
+                $message,
+            ),
+        );
+    }
+}

src/Metadata/Parser/AttributeParser.php

@@ -15,6 +15,7 @@
 use function json_decode;
 use function method_exists;
 use function str_starts_with;
+use Error;
 use PHPUnit\Framework\Attributes\After;
 use PHPUnit\Framework\Attributes\AfterClass;
 use PHPUnit\Framework\Attributes\BackupGlobals;
@@ -68,6 +69,7 @@
 use PHPUnit\Framework\Attributes\UsesClass;
 use PHPUnit\Framework\Attributes\UsesFunction;
 use PHPUnit\Framework\Attributes\WithoutErrorHandler;
+use PHPUnit\Metadata\InvalidAttributeException;
 use PHPUnit\Metadata\Metadata;
 use PHPUnit\Metadata\MetadataCollection;
 use PHPUnit\Metadata\Version\ConstraintRequirement;
@@ -88,9 +90,10 @@ public function forClass(string $className): MetadataCollection
     {
         assert(class_exists($className));
 
-        $result = [];
+        $reflector = new ReflectionClass($className);
+        $result    = [];
 
-        foreach ((new ReflectionClass($className))->getAttributes() as $attribute) {
+        foreach ($reflector->getAttributes() as $attribute) {
             if (!str_starts_with($attribute->getName(), 'PHPUnit\\Framework\\Attributes\\')) {
                 continue;
             }
@@ -99,7 +102,17 @@ public function forClass(string $className): MetadataCollection
                 continue;
             }
 
-            $attributeInstance = $attribute->newInstance();
+            try {
+                $attributeInstance = $attribute->newInstance();
+            } catch (Error $e) {
+                throw new InvalidAttributeException(
+                    $attribute->getName(),
+                    'class ' . $className,
+                    $reflector->getFileName(),
+                    $reflector->getStartLine(),
+                    $e->getMessage(),
+                );
+            }
 
             switch ($attribute->getName()) {
                 case BackupGlobals::class:
@@ -346,9 +359,10 @@ public function forMethod(string $className, string $methodName): MetadataCollec
         assert(class_exists($className));
         assert(method_exists($className, $methodName));
 
-        $result = [];
+        $reflector = new ReflectionMethod($className, $methodName);
+        $result    = [];
 
-        foreach ((new ReflectionMethod($className, $methodName))->getAttributes() as $attribute) {
+        foreach ($reflector->getAttributes() as $attribute) {
             if (!str_starts_with($attribute->getName(), 'PHPUnit\\Framework\\Attributes\\')) {
                 continue;
             }
@@ -357,7 +371,17 @@ public function forMethod(string $className, string $methodName): MetadataCollec
                 continue;
             }
 
-            $attributeInstance = $attribute->newInstance();
+            try {
+                $attributeInstance = $attribute->newInstance();
+            } catch (Error $e) {
+                throw new InvalidAttributeException(
+                    $attribute->getName(),
+                    'method ' . $className . '::' . $methodName . '()',
+                    $reflector->getFileName(),
+                    $reflector->getStartLine(),
+                    $e->getMessage(),
+                );
+            }
 
             switch ($attribute->getName()) {
                 case After::class:

tests/_files/Metadata/Attribute/tests/DuplicateSmallAttributeTest.php

@@ -0,0 +1,22 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <sebastian@phpunit.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace PHPUnit\TestFixture\Metadata\Attribute;
+
+use PHPUnit\Framework\Attributes\Small;
+use PHPUnit\Framework\TestCase;
+
+#[Small]
+#[Small]
+final class DuplicateSmallAttributeTest extends TestCase
+{
+    public function testOne(): void
+    {
+    }
+}

tests/_files/Metadata/Attribute/tests/DuplicateTestAttributeTest.php

@@ -0,0 +1,22 @@
+<?php declare(strict_types=1);
+/*
+ * This file is part of PHPUnit.
+ *
+ * (c) Sebastian Bergmann <sebastian@phpunit.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+namespace PHPUnit\TestFixture\Metadata\Attribute;
+
+use PHPUnit\Framework\Attributes\Test;
+use PHPUnit\Framework\TestCase;
+
+final class DuplicateTestAttributeTest extends TestCase
+{
+    #[Test]
+    #[Test]
+    public function testOne(): void
+    {
+    }
+}

tests/unit/Metadata/Parser/AttributeParserTest.php

@@ -62,6 +62,7 @@
 use PHPUnit\Framework\Attributes\UsesClass;
 use PHPUnit\Framework\Attributes\UsesFunction;
 use PHPUnit\Framework\Attributes\WithoutErrorHandler;
+use PHPUnit\Metadata\InvalidAttributeException;
 
 #[CoversClass(AttributeParser::class)]
 #[CoversClass(AfterClass::class)]
@@ -92,6 +93,7 @@
 #[CoversClass(IgnoreClassForCodeCoverage::class)]
 #[CoversClass(IgnoreFunctionForCodeCoverage::class)]
 #[CoversClass(IgnoreMethodForCodeCoverage::class)]
+#[CoversClass(InvalidAttributeException::class)]
 #[CoversClass(Large::class)]
 #[CoversClass(Medium::class)]
 #[CoversClass(PostCondition::class)]

tests/unit/Metadata/Parser/AttributeParserTestCase.php

@@ -14,6 +14,7 @@
 use PHPUnit\Framework\TestCase;
 use PHPUnit\Metadata\DependsOnClass;
 use PHPUnit\Metadata\DependsOnMethod;
+use PHPUnit\Metadata\InvalidAttributeException;
 use PHPUnit\Metadata\RequiresPhp;
 use PHPUnit\Metadata\RequiresPhpExtension;
 use PHPUnit\Metadata\RequiresPhpunit;
@@ -26,6 +27,8 @@
 use PHPUnit\TestFixture\Metadata\Attribute\CoversTest;
 use PHPUnit\TestFixture\Metadata\Attribute\DependencyTest;
 use PHPUnit\TestFixture\Metadata\Attribute\DoesNotPerformAssertionsTest;
+use PHPUnit\TestFixture\Metadata\Attribute\DuplicateSmallAttributeTest;
+use PHPUnit\TestFixture\Metadata\Attribute\DuplicateTestAttributeTest;
 use PHPUnit\TestFixture\Metadata\Attribute\Example;
 use PHPUnit\TestFixture\Metadata\Attribute\GroupTest;
 use PHPUnit\TestFixture\Metadata\Attribute\IgnoreCodeCoverageTest;
@@ -934,5 +937,19 @@ public function test_ignores_attributes_in_PHPUnit_namespace_that_do_not_exist()
         $this->assertTrue($metadata->isEmpty());
     }
 
+    public function test_handles_ReflectionException_raised_when_instantiating_attribute_on_class(): void
+    {
+        $this->expectException(InvalidAttributeException::class);
+
+        $this->parser()->forClass(DuplicateSmallAttributeTest::class);
+    }
+
+    public function test_handles_ReflectionException_raised_when_instantiating_attribute_on_method(): void
+    {
+        $this->expectException(InvalidAttributeException::class);
+
+        $this->parser()->forMethod(DuplicateTestAttributeTest::class, 'testOne');
+    }
+
     abstract protected function parser(): Parser;
 }