[PhpUnitBridge] Enable configuring mock ns with attributes

HypeMC · HypeMC · commit 54c59f7b5436 · 2025-01-07T09:33:50.000+01:00
diff --git a/.github/workflows/phpunit-bridge.yml b/.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 {}
diff --git a/composer.json b/composer.json
@@ -185,6 +185,7 @@
         "psr-4": {
             "Symfony\\Bridge\\Doctrine\\": "src/Symfony/Bridge/Doctrine/",
             "Symfony\\Bridge\\Monolog\\": "src/Symfony/Bridge/Monolog/",
+            "Symfony\\Bridge\\PhpUnit\\": "src/Symfony/Bridge/PhpUnit/",
             "Symfony\\Bridge\\PsrHttpMessage\\": "src/Symfony/Bridge/PsrHttpMessage/",
             "Symfony\\Bridge\\Twig\\": "src/Symfony/Bridge/Twig/",
             "Symfony\\Bundle\\": "src/Symfony/Bundle/",
diff --git a/src/Symfony/Bridge/PhpUnit/Attribute/DnsSensitive.php b/src/Symfony/Bridge/PhpUnit/Attribute/DnsSensitive.php
@@ -0,0 +1,21 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * 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,
+    ) {
+    }
+}
diff --git a/src/Symfony/Bridge/PhpUnit/Attribute/TimeSensitive.php b/src/Symfony/Bridge/PhpUnit/Attribute/TimeSensitive.php
@@ -0,0 +1,21 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * 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,
+    ) {
+    }
+}
diff --git a/src/Symfony/Bridge/PhpUnit/CHANGELOG.md b/src/Symfony/Bridge/PhpUnit/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+7.3
+---
+
+ * Enable configuring clock and DNS mock namespaces with attributes
+
 7.2
 ---
 
diff --git a/src/Symfony/Bridge/PhpUnit/Extension/DisableClockMockSubscriber.php b/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);
+        }
     }
 }
diff --git a/src/Symfony/Bridge/PhpUnit/Extension/DisableDnsMockSubscriber.php b/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([]);
+        }
     }
 }
diff --git a/src/Symfony/Bridge/PhpUnit/Extension/EnableClockMockSubscriber.php b/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);
+        }
     }
 }
diff --git a/src/Symfony/Bridge/PhpUnit/Extension/RegisterClockMockSubscriber.php b/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);
+            }
         }
     }
 }
diff --git a/src/Symfony/Bridge/PhpUnit/Extension/RegisterDnsMockSubscriber.php b/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);
+            }
         }
     }
 }
diff --git a/src/Symfony/Bridge/PhpUnit/Metadata/AttributeReader.php b/src/Symfony/Bridge/PhpUnit/Metadata/AttributeReader.php
@@ -0,0 +1,78 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * 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;
+    }
+}
diff --git a/src/Symfony/Bridge/PhpUnit/SymfonyExtension.php b/src/Symfony/Bridge/PhpUnit/SymfonyExtension.php
@@ -20,6 +20,7 @@
 use Symfony\Bridge\PhpUnit\Extension\EnableClockMockSubscriber;
 use Symfony\Bridge\PhpUnit\Extension\RegisterClockMockSubscriber;
 use Symfony\Bridge\PhpUnit\Extension\RegisterDnsMockSubscriber;
+use Symfony\Bridge\PhpUnit\Metadata\AttributeReader;
 use Symfony\Component\ErrorHandler\DebugClassLoader;
 
 class SymfonyExtension implements Extension
@@ -30,23 +31,25 @@ public function bootstrap(Configuration $configuration, Facade $facade, Paramete
             DebugClassLoader::enable();
         }
 
+        $reader = new AttributeReader();
+
         if ($parameters->has('clock-mock-namespaces')) {
             foreach (explode(',', $parameters->get('clock-mock-namespaces')) as $namespace) {
                 ClockMock::register($namespace.'\DummyClass');
             }
         }
 
-        $facade->registerSubscriber(new RegisterClockMockSubscriber());
-        $facade->registerSubscriber(new EnableClockMockSubscriber());
-        $facade->registerSubscriber(new DisableClockMockSubscriber());
+        $facade->registerSubscriber(new RegisterClockMockSubscriber($reader));
+        $facade->registerSubscriber(new EnableClockMockSubscriber($reader));
+        $facade->registerSubscriber(new DisableClockMockSubscriber($reader));
 
         if ($parameters->has('dns-mock-namespaces')) {
             foreach (explode(',', $parameters->get('dns-mock-namespaces')) as $namespace) {
                 DnsMock::register($namespace.'\DummyClass');
             }
         }
 
-        $facade->registerSubscriber(new RegisterDnsMockSubscriber());
-        $facade->registerSubscriber(new DisableDnsMockSubscriber());
+        $facade->registerSubscriber(new RegisterDnsMockSubscriber($reader));
+        $facade->registerSubscriber(new DisableDnsMockSubscriber($reader));
     }
 }
diff --git a/src/Symfony/Bridge/PhpUnit/Tests/Fixtures/symfonyextension/tests/bootstrap.php b/src/Symfony/Bridge/PhpUnit/Tests/Fixtures/symfonyextension/tests/bootstrap.php
@@ -21,11 +21,14 @@
 });
 
 require __DIR__.'/../../../../SymfonyExtension.php';
+require __DIR__.'/../../../../Attribute/DnsSensitive.php';
+require __DIR__.'/../../../../Attribute/TimeSensitive.php';
 require __DIR__.'/../../../../Extension/DisableClockMockSubscriber.php';
 require __DIR__.'/../../../../Extension/DisableDnsMockSubscriber.php';
 require __DIR__.'/../../../../Extension/EnableClockMockSubscriber.php';
 require __DIR__.'/../../../../Extension/RegisterClockMockSubscriber.php';
 require __DIR__.'/../../../../Extension/RegisterDnsMockSubscriber.php';
+require __DIR__.'/../../../../Metadata/AttributeReader.php';
 
 if (file_exists(__DIR__.'/../../../../vendor/autoload.php')) {
     require __DIR__.'/../../../../vendor/autoload.php';
diff --git a/src/Symfony/Bridge/PhpUnit/Tests/Metadata/AttributeReaderTest.php b/src/Symfony/Bridge/PhpUnit/Tests/Metadata/AttributeReaderTest.php
diff --git a/src/Symfony/Bridge/PhpUnit/Tests/Metadata/Fixtures/FooBar.php b/src/Symfony/Bridge/PhpUnit/Tests/Metadata/Fixtures/FooBar.php
diff --git a/src/Symfony/Bridge/PhpUnit/Tests/SymfonyExtension.php b/src/Symfony/Bridge/PhpUnit/Tests/SymfonyExtension.php
diff --git a/src/Symfony/Bridge/PhpUnit/Tests/symfonyextension.phpt b/src/Symfony/Bridge/PhpUnit/Tests/symfonyextension.phpt
diff --git a/src/Symfony/Bridge/PhpUnit/Tests/symfonyextensionnotregistered.phpt b/src/Symfony/Bridge/PhpUnit/Tests/symfonyextensionnotregistered.phpt

Original file line number	Diff line number	Diff line change
`@@ -15,13 +15,20 @@`
`15`	`15`	`use PHPUnit\Event\Test\Finished;`
`16`	`16`	`use PHPUnit\Event\Test\FinishedSubscriber;`
`17`	`17`	`use PHPUnit\Metadata\Group;`
	`18`	`+use Symfony\Bridge\PhpUnit\Attribute\TimeSensitive;`
`18`	`19`	`use Symfony\Bridge\PhpUnit\ClockMock;`
	`20`	`+use Symfony\Bridge\PhpUnit\Metadata\AttributeReader;`
`19`	`21`
`20`	`22`	`/**`
`21`	`23`	`* @internal`
`22`	`24`	`*/`
`23`	`25`	`class DisableClockMockSubscriber implements FinishedSubscriber`
`24`	`26`	`{`
	`27`	`+ public function __construct(`
	`28`	`+ private AttributeReader $reader,`
	`29`	`+ ) {`
	`30`	`+ }`
	`31`	`+`
`25`	`32`	`public function notify(Finished $event): void`
`26`	`33`	`{`
`27`	`34`	`$test = $event->test();`
`@@ -33,7 +40,12 @@ public function notify(Finished $event): void`
`33`	`40`	`foreach ($test->metadata() as $metadata) {`
`34`	`41`	`if ($metadata instanceof Group && 'time-sensitive' === $metadata->groupName()) {`
`35`	`42`	`ClockMock::withClockMock(false);`
	`43`	`+ break;`
`36`	`44`	`}`
`37`	`45`	`}`
	`46`	`+`
	`47`	`+ if ($this->reader->forClassAndMethod($test->className(), $test->methodName(), TimeSensitive::class)) {`
	`48`	`+ ClockMock::withClockMock(false);`
	`49`	`+ }`
`38`	`50`	`}`
`39`	`51`	`}`