minor #54785 Remove calls to TestCase::iniSet() and calls to deprec…

…ated methods of `MockBuilder` (alexandre-daubois) This PR was merged into the 5.4 branch. Discussion ---------- Remove calls to `TestCase::iniSet()` and calls to deprecated methods of `MockBuilder` | Q | A | ------------- | --- | Branch? | 5.4 | Bug fix? | no | New feature? | no | Deprecations? | no | Issues | - | License | MIT Last round (before new deprecations 🙂). All deprecations [listed here](https://github.com/sebastianbergmann/phpunit/blob/main/DEPRECATIONS.md) should be gone. Commits ------- 4d5065d Remove calls to `TestCase::iniSet()` and calls to deprecated methods of `MockBuilder`
symfony · May 15, 2024 · ac30c7e · ac30c7e
2 parents 58e1082 + 4d5065d
commit ac30c7e
Show file tree

Hide file tree

Showing 26 changed files with 304 additions and 119 deletions.
diff --git a/src/Symfony/Bridge/Doctrine/Tests/Fixtures/MockableRepository.php b/src/Symfony/Bridge/Doctrine/Tests/Fixtures/MockableRepository.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\Doctrine\Tests\Fixtures;
+
+use Doctrine\ORM\EntityRepository;
+
+class MockableRepository extends EntityRepository
+{
+    public function findByCustom()
+    {
+    }
+}
diff --git a/src/Symfony/Bridge/Doctrine/Tests/Validator/Constraints/UniqueEntityValidatorTest.php b/src/Symfony/Bridge/Doctrine/Tests/Validator/Constraints/UniqueEntityValidatorTest.php
@@ -28,6 +28,7 @@
 use Symfony\Bridge\Doctrine\Tests\Fixtures\DoubleNameEntity;
 use Symfony\Bridge\Doctrine\Tests\Fixtures\DoubleNullableNameEntity;
 use Symfony\Bridge\Doctrine\Tests\Fixtures\Employee;
+use Symfony\Bridge\Doctrine\Tests\Fixtures\MockableRepository;
 use Symfony\Bridge\Doctrine\Tests\Fixtures\Person;
 use Symfony\Bridge\Doctrine\Tests\Fixtures\SingleIntIdEntity;
 use Symfony\Bridge\Doctrine\Tests\Fixtures\SingleIntIdNoToStringEntity;
@@ -97,14 +98,10 @@ protected function createRegistryMock($em = null)
 
     protected function createRepositoryMock()
     {
-        $repository = $this->getMockBuilder(EntityRepository::class)
+        return $this->getMockBuilder(MockableRepository::class)
             ->disableOriginalConstructor()
-            ->onlyMethods(['find', 'findAll', 'findOneBy', 'findBy', 'getClassName'])
-            ->addMethods(['findByCustom'])
-            ->getMock()
-        ;
-
-        return $repository;
+            ->onlyMethods(['find', 'findAll', 'findOneBy', 'findBy', 'getClassName', 'findByCustom'])
+            ->getMock();
     }
 
     protected function createEntityManagerMock($repositoryMock)

diff --git a/src/Symfony/Bridge/Twig/Tests/Extension/HttpKernelExtensionTest.php b/src/Symfony/Bridge/Twig/Tests/Extension/HttpKernelExtensionTest.php
@@ -31,14 +31,14 @@ class HttpKernelExtensionTest extends TestCase
     public function testFragmentWithError()
     {
         $this->expectException(\Twig\Error\RuntimeError::class);
-        $renderer = $this->getFragmentHandler($this->throwException(new \Exception('foo')));
+        $renderer = $this->getFragmentHandler(new \Exception('foo'));
 
         $this->renderTemplate($renderer);
     }
 
     public function testRenderFragment()
     {
-        $renderer = $this->getFragmentHandler($this->returnValue(new Response('html')));
+        $renderer = $this->getFragmentHandler(new Response('html'));
 
         $response = $this->renderTemplate($renderer);
 
@@ -87,11 +87,17 @@ public function testGenerateFragmentUri()
         $this->assertSame('/_fragment?_hash=PP8%2FeEbn1pr27I9wmag%2FM6jYGVwUZ0l2h0vhh2OJ6CI%3D&amp;_path=template%3Dfoo.html.twig%26_format%3Dhtml%26_locale%3Den%26_controller%3DSymfonyBundleFrameworkBundleControllerTemplateController%253A%253AtemplateAction', $twig->render('index'));
     }
 
-    protected function getFragmentHandler($return)
+    protected function getFragmentHandler($returnOrException): FragmentHandler
     {
         $strategy = $this->createMock(FragmentRendererInterface::class);
         $strategy->expects($this->once())->method('getName')->willReturn('inline');
-        $strategy->expects($this->once())->method('render')->will($return);
+
+        $mocker = $strategy->expects($this->once())->method('render');
+        if ($returnOrException instanceof \Exception) {
+            $mocker->willThrowException($returnOrException);
+        } else {
+            $mocker->willReturn($returnOrException);
+        }
 
         $context = $this->createMock(RequestStack::class);
 

diff --git a/src/Symfony/Bridge/Twig/Tests/Extension/RuntimeLoaderProvider.php b/src/Symfony/Bridge/Twig/Tests/Extension/RuntimeLoaderProvider.php
@@ -20,9 +20,9 @@ trait RuntimeLoaderProvider
     protected function registerTwigRuntimeLoader(Environment $environment, FormRenderer $renderer)
     {
         $loader = $this->createMock(RuntimeLoaderInterface::class);
-        $loader->expects($this->any())->method('load')->will($this->returnValueMap([
+        $loader->expects($this->any())->method('load')->willReturnMap([
             ['Symfony\Component\Form\FormRenderer', $renderer],
-        ]));
+        ]);
         $environment->addRuntimeLoader($loader);
     }
 }
diff --git a/src/Symfony/Component/Console/Tests/ApplicationTest.php b/src/Symfony/Component/Console/Tests/ApplicationTest.php
@@ -41,6 +41,7 @@
 use Symfony\Component\Console\SignalRegistry\SignalRegistry;
 use Symfony\Component\Console\Terminal;
 use Symfony\Component\Console\Tester\ApplicationTester;
+use Symfony\Component\Console\Tests\Fixtures\MockableAppliationWithTerminalWidth;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\EventDispatcher\EventDispatcher;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
@@ -876,7 +877,9 @@ public function testRenderExceptionEscapesLines()
 
     public function testRenderExceptionLineBreaks()
     {
-        $application = $this->getMockBuilder(Application::class)->addMethods(['getTerminalWidth'])->getMock();
+        $application = $this->getMockBuilder(MockableAppliationWithTerminalWidth::class)
+            ->onlyMethods(['getTerminalWidth'])
+            ->getMock();
         $application->setAutoExit(false);
         $application->expects($this->any())
             ->method('getTerminalWidth')

diff --git a/src/Symfony/Component/Console/Tests/Fixtures/MockableAppliationWithTerminalWidth.php b/src/Symfony/Component/Console/Tests/Fixtures/MockableAppliationWithTerminalWidth.php
@@ -0,0 +1,22 @@
+<?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\Component\Console\Tests\Fixtures;
+
+use Symfony\Component\Console\Application;
+
+class MockableAppliationWithTerminalWidth extends Application
+{
+    public function getTerminalWidth(): int
+    {
+        return 0;
+    }
+}
diff --git a/src/Symfony/Component/Form/Test/Traits/ValidatorExtensionTrait.php b/src/Symfony/Component/Form/Test/Traits/ValidatorExtensionTrait.php
@@ -36,8 +36,8 @@ protected function getValidatorExtension(): ValidatorExtension
 
         $this->validator = $this->createMock(ValidatorInterface::class);
         $metadata = $this->getMockBuilder(ClassMetadata::class)->setConstructorArgs([''])->onlyMethods(['addPropertyConstraint'])->getMock();
-        $this->validator->expects($this->any())->method('getMetadataFor')->will($this->returnValue($metadata));
-        $this->validator->expects($this->any())->method('validate')->will($this->returnValue(new ConstraintViolationList()));
+        $this->validator->expects($this->any())->method('getMetadataFor')->willReturn($metadata);
+        $this->validator->expects($this->any())->method('validate')->willReturn(new ConstraintViolationList());
 
         return new ValidatorExtension($this->validator, false);
     }

diff --git a/...nt/Form/Tests/Extension/Core/DataTransformer/DateTimeToLocalizedStringTransformerTest.php b/...nt/Form/Tests/Extension/Core/DataTransformer/DateTimeToLocalizedStringTransformerTest.php
@@ -25,14 +25,17 @@ class DateTimeToLocalizedStringTransformerTest extends BaseDateTimeTransformerTe
     protected $dateTimeWithoutSeconds;
     private $defaultLocale;
 
+    private $initialTestCaseUseException;
+    private $initialTestCaseErrorLevel;
+
     protected function setUp(): void
     {
         parent::setUp();
 
         // Normalize intl. configuration settings.
         if (\extension_loaded('intl')) {
-            $this->iniSet('intl.use_exceptions', 0);
-            $this->iniSet('intl.error_level', 0);
+            $this->initialTestCaseUseException = ini_set('intl.use_exceptions', 0);
+            $this->initialTestCaseErrorLevel = ini_set('intl.error_level', 0);
         }
 
         // Since we test against "de_AT", we need the full implementation
@@ -50,6 +53,11 @@ protected function tearDown(): void
         $this->dateTime = null;
         $this->dateTimeWithoutSeconds = null;
         \Locale::setDefault($this->defaultLocale);
+
+        if (\extension_loaded('intl')) {
+            ini_set('intl.use_exceptions', $this->initialTestCaseUseException);
+            ini_set('intl.error_level', $this->initialTestCaseUseException);
+        }
     }
 
     public static function dataProvider()
@@ -339,11 +347,15 @@ public function testReverseTransformWrapsIntlErrorsWithErrorLevel()
             $this->markTestSkipped('intl extension is not loaded');
         }
 
-        $this->iniSet('intl.error_level', \E_WARNING);
+        $errorLevel = ini_set('intl.error_level', \E_WARNING);
 
-        $this->expectException(TransformationFailedException::class);
-        $transformer = new DateTimeToLocalizedStringTransformer();
-        $transformer->reverseTransform('12345');
+        try {
+            $this->expectException(TransformationFailedException::class);
+            $transformer = new DateTimeToLocalizedStringTransformer();
+            $transformer->reverseTransform('12345');
+        } finally {
+            ini_set('intl.error_level', $errorLevel);
+        }
     }
 
     public function testReverseTransformWrapsIntlErrorsWithExceptions()
@@ -352,11 +364,15 @@ public function testReverseTransformWrapsIntlErrorsWithExceptions()
             $this->markTestSkipped('intl extension is not loaded');
         }
 
-        $this->iniSet('intl.use_exceptions', 1);
+        $initialUseExceptions = ini_set('intl.use_exceptions', 1);
 
-        $this->expectException(TransformationFailedException::class);
-        $transformer = new DateTimeToLocalizedStringTransformer();
-        $transformer->reverseTransform('12345');
+        try {
+            $this->expectException(TransformationFailedException::class);
+            $transformer = new DateTimeToLocalizedStringTransformer();
+            $transformer->reverseTransform('12345');
+        } finally {
+            ini_set('intl.use_exceptions', $initialUseExceptions);
+        }
     }
 
     public function testReverseTransformWrapsIntlErrorsWithExceptionsAndErrorLevel()
@@ -365,12 +381,17 @@ public function testReverseTransformWrapsIntlErrorsWithExceptionsAndErrorLevel()
             $this->markTestSkipped('intl extension is not loaded');
         }
 
-        $this->iniSet('intl.use_exceptions', 1);
-        $this->iniSet('intl.error_level', \E_WARNING);
+        $initialUseExceptions = ini_set('intl.use_exceptions', 1);
+        $initialErrorLevel = ini_set('intl.error_level', \E_WARNING);
 
-        $this->expectException(TransformationFailedException::class);
-        $transformer = new DateTimeToLocalizedStringTransformer();
-        $transformer->reverseTransform('12345');
+        try {
+            $this->expectException(TransformationFailedException::class);
+            $transformer = new DateTimeToLocalizedStringTransformer();
+            $transformer->reverseTransform('12345');
+        } finally {
+            ini_set('intl.use_exceptions', $initialUseExceptions);
+            ini_set('intl.error_level', $initialErrorLevel);
+        }
     }
 
     protected function createDateTimeTransformer(?string $inputTimezone = null, ?string $outputTimezone = null): BaseDateTimeTransformer

diff --git a/src/Symfony/Component/HttpFoundation/Tests/Session/Storage/NativeSessionStorageTest.php b/src/Symfony/Component/HttpFoundation/Tests/Session/Storage/NativeSessionStorageTest.php
@@ -34,10 +34,14 @@ class NativeSessionStorageTest extends TestCase
 {
     private $savePath;
 
+    private $initialSessionSaveHandler;
+    private $initialSessionSavePath;
+
     protected function setUp(): void
     {
-        $this->iniSet('session.save_handler', 'files');
-        $this->iniSet('session.save_path', $this->savePath = sys_get_temp_dir().'/sftest');
+        $this->initialSessionSaveHandler = ini_set('session.save_handler', 'files');
+        $this->initialSessionSavePath = ini_set('session.save_path', $this->savePath = sys_get_temp_dir().'/sftest');
+
         if (!is_dir($this->savePath)) {
             mkdir($this->savePath);
         }
@@ -52,6 +56,8 @@ protected function tearDown(): void
         }
 
         $this->savePath = null;
+        ini_set('session.save_handler', $this->initialSessionSaveHandler);
+        ini_set('session.save_path', $this->initialSessionSavePath);
     }
 
     protected function getStorage(array $options = []): NativeSessionStorage
@@ -154,18 +160,26 @@ public function testRegenerationFailureDoesNotFlagStorageAsStarted()
 
     public function testDefaultSessionCacheLimiter()
     {
-        $this->iniSet('session.cache_limiter', 'nocache');
+        $initialLimiter = ini_set('session.cache_limiter', 'nocache');
 
-        new NativeSessionStorage();
-        $this->assertEquals('', \ini_get('session.cache_limiter'));
+        try {
+            new NativeSessionStorage();
+            $this->assertEquals('', \ini_get('session.cache_limiter'));
+        } finally {
+            ini_set('session.cache_limiter', $initialLimiter);
+        }
     }
 
     public function testExplicitSessionCacheLimiter()
     {
-        $this->iniSet('session.cache_limiter', 'nocache');
+        $initialLimiter = ini_set('session.cache_limiter', 'nocache');
 
-        new NativeSessionStorage(['cache_limiter' => 'public']);
-        $this->assertEquals('public', \ini_get('session.cache_limiter'));
+        try {
+            new NativeSessionStorage(['cache_limiter' => 'public']);
+            $this->assertEquals('public', \ini_get('session.cache_limiter'));
+        } finally {
+            ini_set('session.cache_limiter', $initialLimiter);
+        }
     }
 
     public function testCookieOptions()
@@ -208,20 +222,25 @@ public function testSessionOptions()
 
     public function testSetSaveHandler()
     {
-        $this->iniSet('session.save_handler', 'files');
-        $storage = $this->getStorage();
-        $storage->setSaveHandler();
-        $this->assertInstanceOf(SessionHandlerProxy::class, $storage->getSaveHandler());
-        $storage->setSaveHandler(null);
-        $this->assertInstanceOf(SessionHandlerProxy::class, $storage->getSaveHandler());
-        $storage->setSaveHandler(new SessionHandlerProxy(new NativeFileSessionHandler()));
-        $this->assertInstanceOf(SessionHandlerProxy::class, $storage->getSaveHandler());
-        $storage->setSaveHandler(new NativeFileSessionHandler());
-        $this->assertInstanceOf(SessionHandlerProxy::class, $storage->getSaveHandler());
-        $storage->setSaveHandler(new SessionHandlerProxy(new NullSessionHandler()));
-        $this->assertInstanceOf(SessionHandlerProxy::class, $storage->getSaveHandler());
-        $storage->setSaveHandler(new NullSessionHandler());
-        $this->assertInstanceOf(SessionHandlerProxy::class, $storage->getSaveHandler());
+        $initialSaveHandler = ini_set('session.save_handler', 'files');
+
+        try {
+            $storage = $this->getStorage();
+            $storage->setSaveHandler();
+            $this->assertInstanceOf(SessionHandlerProxy::class, $storage->getSaveHandler());
+            $storage->setSaveHandler(null);
+            $this->assertInstanceOf(SessionHandlerProxy::class, $storage->getSaveHandler());
+            $storage->setSaveHandler(new SessionHandlerProxy(new NativeFileSessionHandler()));
+            $this->assertInstanceOf(SessionHandlerProxy::class, $storage->getSaveHandler());
+            $storage->setSaveHandler(new NativeFileSessionHandler());
+            $this->assertInstanceOf(SessionHandlerProxy::class, $storage->getSaveHandler());
+            $storage->setSaveHandler(new SessionHandlerProxy(new NullSessionHandler()));
+            $this->assertInstanceOf(SessionHandlerProxy::class, $storage->getSaveHandler());
+            $storage->setSaveHandler(new NullSessionHandler());
+            $this->assertInstanceOf(SessionHandlerProxy::class, $storage->getSaveHandler());
+        } finally {
+            ini_set('session.save_handler', $initialSaveHandler);
+        }
     }
 
     public function testStarted()

diff --git a/src/Symfony/Component/HttpFoundation/Tests/Session/Storage/PhpBridgeSessionStorageTest.php b/src/Symfony/Component/HttpFoundation/Tests/Session/Storage/PhpBridgeSessionStorageTest.php
@@ -30,10 +30,14 @@ class PhpBridgeSessionStorageTest extends TestCase
 {
     private $savePath;
 
+    private $initialSessionSaveHandler;
+    private $initialSessionSavePath;
+
     protected function setUp(): void
     {
-        $this->iniSet('session.save_handler', 'files');
-        $this->iniSet('session.save_path', $this->savePath = sys_get_temp_dir().'/sftest');
+        $this->initialSessionSaveHandler = ini_set('session.save_handler', 'files');
+        $this->initialSessionSavePath = ini_set('session.save_path', $this->savePath = sys_get_temp_dir().'/sftest');
+
         if (!is_dir($this->savePath)) {
             mkdir($this->savePath);
         }
@@ -48,6 +52,8 @@ protected function tearDown(): void
         }
 
         $this->savePath = null;
+        ini_set('session.save_handler', $this->initialSessionSaveHandler);
+        ini_set('session.save_path', $this->initialSessionSavePath);
     }
 
     protected function getStorage(): PhpBridgeSessionStorage