support ClockMock and DnsMock with PHPUnit 10+

xabbuh · xabbuh · commit 3dd81e9b2843 · 2024-10-08T13:05:03.000+02:00
diff --git a/src/Symfony/Bridge/PhpUnit/Extension/DisableClockMockSubscriber.php b/src/Symfony/Bridge/PhpUnit/Extension/DisableClockMockSubscriber.php
@@ -0,0 +1,34 @@
+<?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\Extension;
+
+use PHPUnit\Event\Test\Finished;
+use PHPUnit\Event\Test\FinishedSubscriber;
+use PHPUnit\Metadata\Group;
+use Symfony\Bridge\PhpUnit\ClockMock;
+
+/**
+ * @internal
+ */
+class DisableClockMockSubscriber implements FinishedSubscriber
+{
+    public function notify(Finished $event): void
+    {
+        $test = $event->test();
+
+        foreach ($test->metadata() as $metadata) {
+            if ($metadata instanceof Group && 'time-sensitive' === $metadata->groupName()) {
+                ClockMock::withClockMock(false);
+            }
+        }
+    }
+}
diff --git a/src/Symfony/Bridge/PhpUnit/Extension/DisableDnsMockSubscriber.php b/src/Symfony/Bridge/PhpUnit/Extension/DisableDnsMockSubscriber.php
@@ -0,0 +1,34 @@
+<?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\Extension;
+
+use PHPUnit\Event\Test\Finished;
+use PHPUnit\Event\Test\FinishedSubscriber;
+use PHPUnit\Metadata\Group;
+use Symfony\Bridge\PhpUnit\DnsMock;
+
+/**
+ * @internal
+ */
+class DisableDnsMockSubscriber implements FinishedSubscriber
+{
+    public function notify(Finished $event): void
+    {
+        $test = $event->test();
+
+        foreach ($test->metadata() as $metadata) {
+            if ($metadata instanceof Group && 'dns-sensitive' === $metadata->groupName()) {
+                DnsMock::withMockedHosts([]);
+            }
+        }
+    }
+}
diff --git a/src/Symfony/Bridge/PhpUnit/Extension/EnableClockMockSubscriber.php b/src/Symfony/Bridge/PhpUnit/Extension/EnableClockMockSubscriber.php
@@ -0,0 +1,34 @@
+<?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\Extension;
+
+use PHPUnit\Event\Test\PreparationStarted;
+use PHPUnit\Event\Test\PreparationStartedSubscriber;
+use PHPUnit\Metadata\Group;
+use Symfony\Bridge\PhpUnit\ClockMock;
+
+/**
+ * @internal
+ */
+class EnableClockMockSubscriber implements PreparationStartedSubscriber
+{
+    public function notify(PreparationStarted $event): void
+    {
+        $test = $event->test();
+
+        foreach ($test->metadata() as $metadata) {
+            if ($metadata instanceof Group && 'time-sensitive' === $metadata->groupName()) {
+                ClockMock::withClockMock(true);
+            }
+        }
+    }
+}
diff --git a/src/Symfony/Bridge/PhpUnit/Extension/RegisterClockMockSubscriber.php b/src/Symfony/Bridge/PhpUnit/Extension/RegisterClockMockSubscriber.php
@@ -0,0 +1,34 @@
+<?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\Extension;
+
+use PHPUnit\Event\TestSuite\Loaded;
+use PHPUnit\Event\TestSuite\LoadedSubscriber;
+use PHPUnit\Metadata\Group;
+use Symfony\Bridge\PhpUnit\ClockMock;
+
+/**
+ * @internal
+ */
+class RegisterClockMockSubscriber implements LoadedSubscriber
+{
+    public function notify(Loaded $event): void
+    {
+        foreach ($event->testSuite()->tests() as $test) {
+            foreach ($test->metadata() as $metadata) {
+                if ($metadata instanceof Group && 'time-sensitive' === $metadata->groupName()) {
+                    ClockMock::register($test->className());
+                }
+            }
+        }
+    }
+}
diff --git a/src/Symfony/Bridge/PhpUnit/Extension/RegisterDnsMockSubscriber.php b/src/Symfony/Bridge/PhpUnit/Extension/RegisterDnsMockSubscriber.php
@@ -0,0 +1,34 @@
+<?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\Extension;
+
+use PHPUnit\Event\TestSuite\Loaded;
+use PHPUnit\Event\TestSuite\LoadedSubscriber;
+use PHPUnit\Metadata\Group;
+use Symfony\Bridge\PhpUnit\DnsMock;
+
+/**
+ * @internal
+ */
+class RegisterDnsMockSubscriber implements LoadedSubscriber
+{
+    public function notify(Loaded $event): void
+    {
+        foreach ($event->testSuite()->tests() as $test) {
+            foreach ($test->metadata() as $metadata) {
+                if ($metadata instanceof Group && 'dns-sensitive' === $metadata->groupName()) {
+                    DnsMock::register($test->className());
+                }
+            }
+        }
+    }
+}
diff --git a/src/Symfony/Bridge/PhpUnit/Extension/SymfonyExtension.php b/src/Symfony/Bridge/PhpUnit/Extension/SymfonyExtension.php
@@ -0,0 +1,44 @@
+<?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\Extension;
+
+use PHPUnit\Runner\Extension\Extension;
+use PHPUnit\Runner\Extension\Facade;
+use PHPUnit\Runner\Extension\ParameterCollection;
+use PHPUnit\TextUI\Configuration\Configuration;
+use Symfony\Bridge\PhpUnit\ClockMock;
+use Symfony\Bridge\PhpUnit\DnsMock;
+
+class SymfonyExtension implements Extension
+{
+    public function bootstrap(Configuration $configuration, Facade $facade, ParameterCollection $parameters): void
+    {
+        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());
+
+        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());
+    }
+}
