minor #51067 Use typed properties in tests as much as possible (nicolas-grekas)

nicolas-grekas · nicolas-grekas · commit db2985e3abfa · 2023-07-25T11:47:24.000+02:00
This PR was merged into the 6.4 branch.

Discussion
----------

Use typed properties in tests as much as possible

| Q             | A
| ------------- | ---
| Branch?       | 6.4
| Bug fix?      | no
| New feature?  | no
| Deprecations? | no
| Tickets       | -
| License       | MIT
| Doc PR        | -

Commits
-------

4ad506b085 Use typed properties in tests as much as possible
diff --git a/Tests/Command/AboutCommand/AboutCommandTest.php b/Tests/Command/AboutCommand/AboutCommandTest.php
@@ -21,8 +21,7 @@
 
 class AboutCommandTest extends TestCase
 {
-    /** @var Filesystem */
-    private $fs;
+    private Filesystem $fs;
 
     protected function setUp(): void
     {
diff --git a/Tests/Command/CachePoolClearCommandTest.php b/Tests/Command/CachePoolClearCommandTest.php
@@ -23,7 +23,7 @@
 
 class CachePoolClearCommandTest extends TestCase
 {
-    private $cachePool;
+    private CacheItemPoolInterface $cachePool;
 
     protected function setUp(): void
     {
diff --git a/Tests/Command/CachePoolDeleteCommandTest.php b/Tests/Command/CachePoolDeleteCommandTest.php
@@ -24,7 +24,7 @@
 
 class CachePoolDeleteCommandTest extends TestCase
 {
-    private $cachePool;
+    private MockObject&CacheItemPoolInterface $cachePool;
 
     protected function setUp(): void
     {
diff --git a/Tests/Command/TranslationDebugCommandTest.php b/Tests/Command/TranslationDebugCommandTest.php
@@ -28,8 +28,8 @@
 
 class TranslationDebugCommandTest extends TestCase
 {
-    private $fs;
-    private $translationDir;
+    private Filesystem $fs;
+    private string $translationDir;
 
     public function testDebugMissingMessages()
     {
diff --git a/Tests/Command/TranslationUpdateCommandCompletionTest.php b/Tests/Command/TranslationUpdateCommandCompletionTest.php
@@ -27,8 +27,8 @@
 
 class TranslationUpdateCommandCompletionTest extends TestCase
 {
-    private $fs;
-    private $translationDir;
+    private Filesystem $fs;
+    private string $translationDir;
 
     /**
      * @dataProvider provideCompletionSuggestions
diff --git a/Tests/Command/TranslationUpdateCommandTest.php b/Tests/Command/TranslationUpdateCommandTest.php
@@ -26,8 +26,8 @@
 
 class TranslationUpdateCommandTest extends TestCase
 {
-    private $fs;
-    private $translationDir;
+    private Filesystem $fs;
+    private string $translationDir;
 
     public function testDumpMessagesAndCleanWithDeprecatedCommandName()
     {
diff --git a/Tests/Command/XliffLintCommandTest.php b/Tests/Command/XliffLintCommandTest.php
@@ -29,7 +29,7 @@
  */
 class XliffLintCommandTest extends TestCase
 {
-    private $files;
+    private array $files;
 
     public function testGetHelp()
     {
diff --git a/Tests/Command/YamlLintCommandTest.php b/Tests/Command/YamlLintCommandTest.php
@@ -28,7 +28,7 @@
  */
 class YamlLintCommandTest extends TestCase
 {
-    private $files;
+    private array $files;
 
     public function testLintCorrectFile()
     {
diff --git a/Tests/Console/Descriptor/AbstractDescriptorTestCase.php b/Tests/Console/Descriptor/AbstractDescriptorTestCase.php
@@ -26,7 +26,7 @@
 
 abstract class AbstractDescriptorTestCase extends TestCase
 {
-    private $colSize;
+    private string|false $colSize;
 
     protected function setUp(): void
     {
diff --git a/Tests/Console/Descriptor/TextDescriptorTest.php b/Tests/Console/Descriptor/TextDescriptorTest.php
@@ -17,7 +17,7 @@
 
 class TextDescriptorTest extends AbstractDescriptorTestCase
 {
-    private static $fileLinkFormatter;
+    private static ?FileLinkFormatter $fileLinkFormatter = null;
 
     protected static function getDescriptor()
     {
diff --git a/Tests/Controller/TestAbstractController.php b/Tests/Controller/TestAbstractController.php
@@ -16,7 +16,7 @@
 
 class TestAbstractController extends AbstractController
 {
-    private $throwOnUnexpectedService;
+    private bool $throwOnUnexpectedService;
 
     public function __construct($throwOnUnexpectedService = true)
     {
diff --git a/Tests/DependencyInjection/Compiler/DataCollectorTranslatorPassTest.php b/Tests/DependencyInjection/Compiler/DataCollectorTranslatorPassTest.php
@@ -22,8 +22,8 @@
 
 class DataCollectorTranslatorPassTest extends TestCase
 {
-    private $container;
-    private $dataCollectorTranslatorPass;
+    private ContainerBuilder $container;
+    private DataCollectorTranslatorPass $dataCollectorTranslatorPass;
 
     protected function setUp(): void
     {
diff --git a/Tests/DependencyInjection/Compiler/WorkflowGuardListenerPassTest.php b/Tests/DependencyInjection/Compiler/WorkflowGuardListenerPassTest.php
@@ -23,8 +23,8 @@
 
 class WorkflowGuardListenerPassTest extends TestCase
 {
-    private $container;
-    private $compilerPass;
+    private ContainerBuilder $container;
+    private WorkflowGuardListenerPass $compilerPass;
 
     protected function setUp(): void
     {
diff --git a/Tests/DependencyInjection/FrameworkExtensionTestCase.php b/Tests/DependencyInjection/FrameworkExtensionTestCase.php
@@ -95,7 +95,7 @@ abstract class FrameworkExtensionTestCase extends TestCase
 {
     use ExpectDeprecationTrait;
 
-    private static $containerCache = [];
+    private static array $containerCache = [];
 
     abstract protected function loadFromFile(ContainerBuilder $container, $file);
 
diff --git a/Tests/Fixtures/Messenger/DummyMessage.php b/Tests/Fixtures/Messenger/DummyMessage.php
@@ -4,7 +4,7 @@
 
 class DummyMessage implements DummyMessageInterface
 {
-    private $message;
+    private string $message;
 
     public function __construct(string $message)
     {
diff --git a/Tests/Functional/Bundle/LegacyBundle/Entity/LegacyPerson.php b/Tests/Functional/Bundle/LegacyBundle/Entity/LegacyPerson.php
@@ -13,8 +13,8 @@
 
 class LegacyPerson
 {
-    public $name;
-    public $age;
+    public string $name;
+    public string $age;
 
     public function __construct(string $name, string $age)
     {
diff --git a/Tests/Functional/Bundle/ModernBundle/src/Entity/ModernPerson.php b/Tests/Functional/Bundle/ModernBundle/src/Entity/ModernPerson.php
@@ -13,8 +13,8 @@
 
 class ModernPerson
 {
-    public $name;
-    public $age;
+    public string $name;
+    public string $age;
 
     public function __construct(string $name, string $age)
     {
diff --git a/Tests/Functional/Bundle/TestBundle/AutowiringTypes/AutowiredServices.php b/Tests/Functional/Bundle/TestBundle/AutowiringTypes/AutowiredServices.php
@@ -17,9 +17,9 @@
 
 class AutowiredServices
 {
-    private $annotationReader;
-    private $dispatcher;
-    private $cachePool;
+    private ?Reader $annotationReader;
+    private EventDispatcherInterface $dispatcher;
+    private CacheItemPoolInterface $cachePool;
 
     public function __construct(Reader $annotationReader = null, EventDispatcherInterface $dispatcher, CacheItemPoolInterface $cachePool)
     {
diff --git a/Tests/Functional/Bundle/TestBundle/Controller/FragmentController.php b/Tests/Functional/Bundle/TestBundle/Controller/FragmentController.php
@@ -52,7 +52,7 @@ public function fragmentUriAction(Request $request, FragmentUriGeneratorInterfac
 
 class Bar
 {
-    private $bar = 'bar';
+    private string $bar = 'bar';
 
     public function getBar()
     {
diff --git a/Tests/Functional/Bundle/TestBundle/Controller/SecurityController.php b/Tests/Functional/Bundle/TestBundle/Controller/SecurityController.php
@@ -18,7 +18,7 @@
 
 class SecurityController implements ServiceSubscriberInterface
 {
-    private $container;
+    private ContainerInterface $container;
 
     public function __construct(ContainerInterface $container)
     {
diff --git a/Tests/Functional/Bundle/TestBundle/DependencyInjection/Configuration.php b/Tests/Functional/Bundle/TestBundle/DependencyInjection/Configuration.php
@@ -11,14 +11,15 @@
 
 namespace Symfony\Bundle\FrameworkBundle\Tests\Functional\Bundle\TestBundle\DependencyInjection;
 
+use Symfony\Bundle\FrameworkBundle\Tests\Functional\Bundle\TestBundle\DependencyInjection\Config\CustomConfig;
 use Symfony\Component\Config\Definition\Builder\TreeBuilder;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
 
 class Configuration implements ConfigurationInterface
 {
-    private $customConfig;
+    private ?CustomConfig $customConfig;
 
-    public function __construct($customConfig = null)
+    public function __construct(CustomConfig $customConfig = null)
     {
         $this->customConfig = $customConfig;
     }
diff --git a/Tests/Functional/Bundle/TestBundle/DependencyInjection/TestExtension.php b/Tests/Functional/Bundle/TestBundle/DependencyInjection/TestExtension.php
@@ -11,15 +11,15 @@
 
 namespace Symfony\Bundle\FrameworkBundle\Tests\Functional\Bundle\TestBundle\DependencyInjection;
 
+use Symfony\Bundle\FrameworkBundle\Tests\Functional\Bundle\TestBundle\DependencyInjection\Config\CustomConfig;
 use Symfony\Component\Config\Definition\ConfigurationInterface;
-use Symfony\Component\DependencyInjection\Alias;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\DependencyInjection\Extension\Extension;
 use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
 
 class TestExtension extends Extension implements PrependExtensionInterface
 {
-    private $customConfig;
+    private ?CustomConfig $customConfig = null;
 
     public function load(array $configs, ContainerBuilder $container): void
     {
@@ -37,7 +37,7 @@ public function getConfiguration(array $config, ContainerBuilder $container): ?C
         return new Configuration($this->customConfig);
     }
 
-    public function setCustomConfig($customConfig): void
+    public function setCustomConfig(CustomConfig $customConfig): void
     {
         $this->customConfig = $customConfig;
     }
diff --git a/Tests/Functional/Bundle/TestBundle/Slugger/SlugConstructArgService.php b/Tests/Functional/Bundle/TestBundle/Slugger/SlugConstructArgService.php
@@ -15,7 +15,7 @@
 
 class SlugConstructArgService
 {
-    private $slugger;
+    private SluggerInterface $slugger;
 
     public function __construct(SluggerInterface $slugger)
     {
diff --git a/Tests/Functional/Bundle/TestBundle/TestServiceContainer/PublicService.php b/Tests/Functional/Bundle/TestBundle/TestServiceContainer/PublicService.php
@@ -13,9 +13,8 @@
 
 class PublicService
 {
-    private $nonPublicService;
-
-    private $privateService;
+    private NonPublicService $nonPublicService;
+    private PrivateService $privateService;
 
     public function __construct(NonPublicService $nonPublicService, PrivateService $privateService)
     {
diff --git a/Tests/Functional/Bundle/TestBundle/TransDebug/TransConstructArgService.php b/Tests/Functional/Bundle/TestBundle/TransDebug/TransConstructArgService.php
@@ -15,7 +15,7 @@
 
 class TransConstructArgService
 {
-    private $translator;
+    private TranslatorInterface $translator;
 
     public function __construct(TranslatorInterface $translator)
     {
diff --git a/Tests/Functional/Bundle/TestBundle/TransDebug/TransMethodCallsService.php b/Tests/Functional/Bundle/TestBundle/TransDebug/TransMethodCallsService.php
@@ -15,7 +15,7 @@
 
 class TransMethodCallsService
 {
-    private $translator;
+    private TranslatorInterface $translator;
 
     public function setTranslator(TranslatorInterface $translator): void
     {
diff --git a/Tests/Functional/Bundle/TestBundle/TransDebug/TransPropertyService.php b/Tests/Functional/Bundle/TestBundle/TransDebug/TransPropertyService.php
@@ -15,8 +15,7 @@
 
 class TransPropertyService
 {
-    /** @var TranslatorInterface */
-    public $translator;
+    public TranslatorInterface $translator;
 
     public function hello(): string
     {
diff --git a/Tests/Functional/Bundle/TestBundle/TransDebug/TransSubscriberService.php b/Tests/Functional/Bundle/TestBundle/TransDebug/TransSubscriberService.php
@@ -17,7 +17,7 @@
 
 class TransSubscriberService implements ServiceSubscriberInterface
 {
-    private $container;
+    private ContainerInterface $container;
 
     public function __construct(ContainerInterface $container)
     {
diff --git a/Tests/Functional/DebugAutowiringCommandTest.php b/Tests/Functional/DebugAutowiringCommandTest.php
@@ -33,7 +33,7 @@ public function testBasicFunctionality()
         $application->setAutoExit(false);
 
         $tester = new ApplicationTester($application);
-        $tester->run(['command' => 'debug:autowiring']);
+        $tester->run(['command' => 'debug:autowiring'], ['decorated' => false]);
 
         $this->assertStringContainsString(HttpKernelInterface::class, $tester->getDisplay());
         $this->assertStringContainsString('alias:http_kernel', $tester->getDisplay());
diff --git a/Tests/Functional/MailerTest.php b/Tests/Functional/MailerTest.php
@@ -41,12 +41,9 @@ public function testEnvelopeListener()
         $logger = self::getContainer()->get('logger');
 
         $testTransport = new class($eventDispatcher, $logger, $onDoSend) extends AbstractTransport {
-            /**
-             * @var callable
-             */
-            private $onDoSend;
+            private \Closure $onDoSend;
 
-            public function __construct(EventDispatcherInterface $eventDispatcher, LoggerInterface $logger, callable $onDoSend)
+            public function __construct(EventDispatcherInterface $eventDispatcher, LoggerInterface $logger, \Closure $onDoSend)
             {
                 parent::__construct($eventDispatcher, $logger);
                 $this->onDoSend = $onDoSend;
diff --git a/Tests/Functional/RouterDebugCommandTest.php b/Tests/Functional/RouterDebugCommandTest.php
@@ -20,7 +20,7 @@
  */
 class RouterDebugCommandTest extends AbstractWebTestCase
 {
-    private $application;
+    private Application $application;
 
     protected function setUp(): void
     {
diff --git a/Tests/Functional/TranslationDebugCommandTest.php b/Tests/Functional/TranslationDebugCommandTest.php
@@ -20,7 +20,7 @@
  */
 class TranslationDebugCommandTest extends AbstractWebTestCase
 {
-    private $application;
+    private Application $application;
 
     protected function setUp(): void
     {
diff --git a/Tests/Functional/app/AppKernel.php b/Tests/Functional/app/AppKernel.php
@@ -28,9 +28,9 @@
  */
 class AppKernel extends Kernel implements ExtensionInterface, ConfigurationInterface
 {
-    private $varDir;
-    private $testCase;
-    private $rootConfig;
+    private string $varDir;
+    private string $testCase;
+    private string $rootConfig;
 
     public function __construct($varDir, $testCase, $rootConfig, $environment, $debug)
     {
diff --git a/Tests/Kernel/ConcreteMicroKernel.php b/Tests/Kernel/ConcreteMicroKernel.php
@@ -27,7 +27,7 @@ class ConcreteMicroKernel extends Kernel implements EventSubscriberInterface
 {
     use MicroKernelTrait;
 
-    private $cacheDir;
+    private string $cacheDir;
 
     public function onKernelException(ExceptionEvent $event)
     {
diff --git a/Tests/Kernel/MicroKernelTraitTest.php b/Tests/Kernel/MicroKernelTraitTest.php
@@ -30,7 +30,7 @@
 
 class MicroKernelTraitTest extends TestCase
 {
-    private $kernel;
+    private ?Kernel $kernel = null;
 
     protected function tearDown(): void
     {
@@ -144,7 +144,7 @@ abstract class MinimalKernel extends Kernel
 {
     use MicroKernelTrait;
 
-    private $cacheDir;
+    private string $cacheDir;
 
     public function __construct(string $cacheDir)
     {
diff --git a/Tests/Kernel/flex-style/src/FlexStyleMicroKernel.php b/Tests/Kernel/flex-style/src/FlexStyleMicroKernel.php
@@ -27,7 +27,7 @@ class FlexStyleMicroKernel extends Kernel
         configureRoutes as traitConfigureRoutes;
     }
 
-    private $cacheDir;
+    private string $cacheDir;
 
     public function halloweenAction(\stdClass $o)
     {
diff --git a/Tests/Secrets/DotenvVaultTest.php b/Tests/Secrets/DotenvVaultTest.php
diff --git a/Tests/Secrets/SodiumVaultTest.php b/Tests/Secrets/SodiumVaultTest.php
diff --git a/Tests/Translation/TranslatorTest.php b/Tests/Translation/TranslatorTest.php

Original file line number	Diff line number	Diff line change
`@@ -21,8 +21,7 @@`
`21`	`21`
`22`	`22`	`class AboutCommandTest extends TestCase`
`23`	`23`	`{`
`24`		`- /** @var Filesystem */`
`25`		`- private $fs;`
	`24`	`+ private Filesystem $fs;`
`26`	`25`
`27`	`26`	`protected function setUp(): void`
`28`	`27`	`{`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@`
`23`	`23`
`24`	`24`	`class CachePoolClearCommandTest extends TestCase`
`25`	`25`	`{`
`26`		`- private $cachePool;`
	`26`	`+ private CacheItemPoolInterface $cachePool;`
`27`	`27`
`28`	`28`	`protected function setUp(): void`
`29`	`29`	`{`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@`
`24`	`24`
`25`	`25`	`class CachePoolDeleteCommandTest extends TestCase`
`26`	`26`	`{`
`27`		`- private $cachePool;`
	`27`	`+ private MockObject&CacheItemPoolInterface $cachePool;`
`28`	`28`
`29`	`29`	`protected function setUp(): void`
`30`	`30`	`{`
Original file line number	Diff line number	Diff line change
`@@ -28,8 +28,8 @@`
`28`	`28`
`29`	`29`	`class TranslationDebugCommandTest extends TestCase`
`30`	`30`	`{`
`31`		`- private $fs;`
`32`		`- private $translationDir;`
	`31`	`+ private Filesystem $fs;`
	`32`	`+ private string $translationDir;`
`33`	`33`
`34`	`34`	`public function testDebugMissingMessages()`
`35`	`35`	`{`
Original file line number	Diff line number	Diff line change
`@@ -27,8 +27,8 @@`
`27`	`27`
`28`	`28`	`class TranslationUpdateCommandCompletionTest extends TestCase`
`29`	`29`	`{`
`30`		`- private $fs;`
`31`		`- private $translationDir;`
	`30`	`+ private Filesystem $fs;`
	`31`	`+ private string $translationDir;`
`32`	`32`
`33`	`33`	`/**`
`34`	`34`	`* @dataProvider provideCompletionSuggestions`
Original file line number	Diff line number	Diff line change
`@@ -26,8 +26,8 @@`
`26`	`26`
`27`	`27`	`class TranslationUpdateCommandTest extends TestCase`
`28`	`28`	`{`
`29`		`- private $fs;`
`30`		`- private $translationDir;`
	`29`	`+ private Filesystem $fs;`
	`30`	`+ private string $translationDir;`
`31`	`31`
`32`	`32`	`public function testDumpMessagesAndCleanWithDeprecatedCommandName()`
`33`	`33`	`{`
Original file line number	Diff line number	Diff line change
`@@ -29,7 +29,7 @@`
`29`	`29`	`*/`
`30`	`30`	`class XliffLintCommandTest extends TestCase`
`31`	`31`	`{`
`32`		`- private $files;`
	`32`	`+ private array $files;`
`33`	`33`
`34`	`34`	`public function testGetHelp()`
`35`	`35`	`{`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@`
`28`	`28`	`*/`
`29`	`29`	`class YamlLintCommandTest extends TestCase`
`30`	`30`	`{`
`31`		`- private $files;`
	`31`	`+ private array $files;`
`32`	`32`
`33`	`33`	`public function testLintCorrectFile()`
`34`	`34`	`{`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@`
`26`	`26`
`27`	`27`	`abstract class AbstractDescriptorTestCase extends TestCase`
`28`	`28`	`{`
`29`		`- private $colSize;`
	`29`	`+ private string\|false $colSize;`
`30`	`30`
`31`	`31`	`protected function setUp(): void`
`32`	`32`	`{`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@`
`17`	`17`
`18`	`18`	`class TextDescriptorTest extends AbstractDescriptorTestCase`
`19`	`19`	`{`
`20`		`- private static $fileLinkFormatter;`
	`20`	`+ private static ?FileLinkFormatter $fileLinkFormatter = null;`
`21`	`21`
`22`	`22`	`protected static function getDescriptor()`
`23`	`23`	`{`