feature symfony#59384 [PhpUnitBridge] Enable configuring mock namespaces with attributes (HypeMC)

This PR was merged into the 7.3 branch.

Discussion
----------

[PhpUnitBridge] Enable configuring mock namespaces with attributes

| Q             | A
| ------------- | ---
| Branch?       | 7.3
| Bug fix?      | no
| New feature?  | yes
| Deprecations? | no
| Issues        | -
| License       | MIT

This PR adds the ability to configure clock and DNS mock namespaces through attributes, removing the need to add them to `phpunit.xml`:

```php
#[DnsSensitive(Foo::class)]
class FooTest extends KernelTestCase
{
    #[TimeSensitive(Bar::class)]
    public function testFoo()
    {
        // ...
    }
}
```

Commits
-------

130cc26 [PhpUnitBridge] Enable configuring mock ns with attributes

Author: nicolas-grekas

.github/workflows/phpunit-bridge.yml

@@ -35,4 +35,4 @@ jobs:
           php-version: "7.2"
 
       - name: Lint
-        run: find ./src/Symfony/Bridge/PhpUnit -name '*.php' | grep -v -e /Tests/ -e ForV7 -e ForV8 -e ForV9 -e ConstraintLogicTrait | parallel -j 4 php -l {}
+        run: find ./src/Symfony/Bridge/PhpUnit -name '*.php' | grep -v -e /Tests/ -e /Attribute/ -e /Extension/ -e /Metadata/ -e ForV7 -e ForV8 -e ForV9 -e ConstraintLogicTrait | parallel -j 4 php -l {}

src/Symfony/Bridge/PhpUnit/Attribute/DnsSensitive.php

@@ -0,0 +1,21 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\PhpUnit\Attribute;
+
+#[\Attribute(\Attribute::TARGET_CLASS | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
+final class DnsSensitive
+{
+    public function __construct(
+        public readonly ?string $class = null,
+    ) {
+    }
+}

src/Symfony/Bridge/PhpUnit/Attribute/TimeSensitive.php

@@ -0,0 +1,21 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\PhpUnit\Attribute;
+
+#[\Attribute(\Attribute::TARGET_CLASS | \Attribute::TARGET_METHOD | \Attribute::IS_REPEATABLE)]
+final class TimeSensitive
+{
+    public function __construct(
+        public readonly ?string $class = null,
+    ) {
+    }
+}

src/Symfony/Bridge/PhpUnit/CHANGELOG.md

@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+7.3
+---
+
+ * Enable configuring clock and DNS mock namespaces with attributes
+
 7.2
 ---
 

src/Symfony/Bridge/PhpUnit/Extension/DisableClockMockSubscriber.php

@@ -15,13 +15,20 @@
 use PHPUnit\Event\Test\Finished;
 use PHPUnit\Event\Test\FinishedSubscriber;
 use PHPUnit\Metadata\Group;
+use Symfony\Bridge\PhpUnit\Attribute\TimeSensitive;
 use Symfony\Bridge\PhpUnit\ClockMock;
+use Symfony\Bridge\PhpUnit\Metadata\AttributeReader;
 
 /**
  * @internal
  */
 class DisableClockMockSubscriber implements FinishedSubscriber
 {
+    public function __construct(
+        private AttributeReader $reader,
+    ) {
+    }
+
     public function notify(Finished $event): void
     {
         $test = $event->test();
@@ -33,7 +40,12 @@ public function notify(Finished $event): void
         foreach ($test->metadata() as $metadata) {
             if ($metadata instanceof Group && 'time-sensitive' === $metadata->groupName()) {
                 ClockMock::withClockMock(false);
+                break;
             }
         }
+
+        if ($this->reader->forClassAndMethod($test->className(), $test->methodName(), TimeSensitive::class)) {
+            ClockMock::withClockMock(false);
+        }
     }
 }

src/Symfony/Bridge/PhpUnit/Extension/DisableDnsMockSubscriber.php

@@ -15,13 +15,20 @@
 use PHPUnit\Event\Test\Finished;
 use PHPUnit\Event\Test\FinishedSubscriber;
 use PHPUnit\Metadata\Group;
+use Symfony\Bridge\PhpUnit\Attribute\DnsSensitive;
 use Symfony\Bridge\PhpUnit\DnsMock;
+use Symfony\Bridge\PhpUnit\Metadata\AttributeReader;
 
 /**
  * @internal
  */
 class DisableDnsMockSubscriber implements FinishedSubscriber
 {
+    public function __construct(
+        private AttributeReader $reader,
+    ) {
+    }
+
     public function notify(Finished $event): void
     {
         $test = $event->test();
@@ -33,7 +40,12 @@ public function notify(Finished $event): void
         foreach ($test->metadata() as $metadata) {
             if ($metadata instanceof Group && 'dns-sensitive' === $metadata->groupName()) {
                 DnsMock::withMockedHosts([]);
+                break;
             }
         }
+
+        if ($this->reader->forClassAndMethod($test->className(), $test->methodName(), DnsSensitive::class)) {
+            DnsMock::withMockedHosts([]);
+        }
     }
 }

src/Symfony/Bridge/PhpUnit/Extension/EnableClockMockSubscriber.php

@@ -15,13 +15,20 @@
 use PHPUnit\Event\Test\PreparationStarted;
 use PHPUnit\Event\Test\PreparationStartedSubscriber;
 use PHPUnit\Metadata\Group;
+use Symfony\Bridge\PhpUnit\Attribute\TimeSensitive;
 use Symfony\Bridge\PhpUnit\ClockMock;
+use Symfony\Bridge\PhpUnit\Metadata\AttributeReader;
 
 /**
  * @internal
  */
 class EnableClockMockSubscriber implements PreparationStartedSubscriber
 {
+    public function __construct(
+        private AttributeReader $reader,
+    ) {
+    }
+
     public function notify(PreparationStarted $event): void
     {
         $test = $event->test();
@@ -33,7 +40,12 @@ public function notify(PreparationStarted $event): void
         foreach ($test->metadata() as $metadata) {
             if ($metadata instanceof Group && 'time-sensitive' === $metadata->groupName()) {
                 ClockMock::withClockMock(true);
+                break;
             }
         }
+
+        if ($this->reader->forClassAndMethod($test->className(), $test->methodName(), TimeSensitive::class)) {
+            ClockMock::withClockMock(true);
+        }
     }
 }

src/Symfony/Bridge/PhpUnit/Extension/RegisterClockMockSubscriber.php

@@ -15,13 +15,20 @@
 use PHPUnit\Event\TestSuite\Loaded;
 use PHPUnit\Event\TestSuite\LoadedSubscriber;
 use PHPUnit\Metadata\Group;
+use Symfony\Bridge\PhpUnit\Attribute\TimeSensitive;
 use Symfony\Bridge\PhpUnit\ClockMock;
+use Symfony\Bridge\PhpUnit\Metadata\AttributeReader;
 
 /**
  * @internal
  */
 class RegisterClockMockSubscriber implements LoadedSubscriber
 {
+    public function __construct(
+        private AttributeReader $reader,
+    ) {
+    }
+
     public function notify(Loaded $event): void
     {
         foreach ($event->testSuite()->tests() as $test) {
@@ -34,6 +41,10 @@ public function notify(Loaded $event): void
                     ClockMock::register($test->className());
                 }
             }
+
+            foreach ($this->reader->forClassAndMethod($test->className(), $test->methodName(), TimeSensitive::class) as $attribute) {
+                ClockMock::register($attribute->class ?? $test->className());
+            }
         }
     }
 }

src/Symfony/Bridge/PhpUnit/Extension/RegisterDnsMockSubscriber.php

@@ -15,13 +15,20 @@
 use PHPUnit\Event\TestSuite\Loaded;
 use PHPUnit\Event\TestSuite\LoadedSubscriber;
 use PHPUnit\Metadata\Group;
+use Symfony\Bridge\PhpUnit\Attribute\DnsSensitive;
 use Symfony\Bridge\PhpUnit\DnsMock;
+use Symfony\Bridge\PhpUnit\Metadata\AttributeReader;
 
 /**
  * @internal
  */
 class RegisterDnsMockSubscriber implements LoadedSubscriber
 {
+    public function __construct(
+        private AttributeReader $reader,
+    ) {
+    }
+
     public function notify(Loaded $event): void
     {
         foreach ($event->testSuite()->tests() as $test) {
@@ -34,6 +41,10 @@ public function notify(Loaded $event): void
                     DnsMock::register($test->className());
                 }
             }
+
+            foreach ($this->reader->forClassAndMethod($test->className(), $test->methodName(), DnsSensitive::class) as $attribute) {
+                DnsMock::register($attribute->class ?? $test->className());
+            }
         }
     }
 }

src/Symfony/Bridge/PhpUnit/Metadata/AttributeReader.php

@@ -0,0 +1,78 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\PhpUnit\Metadata;
+
+/**
+ * @template T of object
+ */
+final class AttributeReader
+{
+    /**
+     * @var array<string, array<class-string<T>, list<T>>>
+     */
+    private array $cache = [];
+
+    /**
+     * @param class-string    $className
+     * @param class-string<T> $name
+     *
+     * @return list<T>
+     */
+    public function forClass(string $className, string $name): array
+    {
+        $attributes = $this->cache[$className] ??= $this->readAttributes(new \ReflectionClass($className));
+
+        return $attributes[$name] ?? [];
+    }
+
+    /**
+     * @param class-string    $className
+     * @param class-string<T> $name
+     *
+     * @return list<T>
+     */
+    public function forMethod(string $className, string $methodName, string $name): array
+    {
+        $attributes = $this->cache[$className.'::'.$methodName] ??= $this->readAttributes(new \ReflectionMethod($className, $methodName));
+
+        return $attributes[$name] ?? [];
+    }
+
+    /**
+     * @param class-string    $className
+     * @param class-string<T> $name
+     *
+     * @return list<T>
+     */
+    public function forClassAndMethod(string $className, string $methodName, string $name): array
+    {
+        return [
+            ...$this->forClass($className, $name),
+            ...$this->forMethod($className, $methodName, $name),
+        ];
+    }
+
+    private function readAttributes(\ReflectionClass|\ReflectionMethod $reflection): array
+    {
+        $attributeInstances = [];
+
+        foreach ($reflection->getAttributes() as $attribute) {
+            if (!str_starts_with($name = $attribute->getName(), 'Symfony\\Bridge\\PhpUnit\\Attribute\\')) {
+                continue;
+            }
+
+            $attributeInstances[$name][] = $attribute->newInstance();
+        }
+
+        return $attributeInstances;
+    }
+}