Use typed properties in tests as much as possible

nicolas-grekas · nicolas-grekas · commit 4ca59ad3a443 · 2023-07-25T10:53:33.000+02:00
diff --git a/Tests/Authentication/AuthenticatorManagerTest.php b/Tests/Authentication/AuthenticatorManagerTest.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Security\Http\Tests\Authentication;
 
+use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Psr\Log\AbstractLogger;
 use Psr\Log\LoggerInterface;
@@ -37,12 +38,12 @@
 
 class AuthenticatorManagerTest extends TestCase
 {
-    private $tokenStorage;
-    private $eventDispatcher;
-    private $request;
-    private $user;
-    private $token;
-    private $response;
+    private MockObject&TokenStorageInterface $tokenStorage;
+    private EventDispatcher $eventDispatcher;
+    private Request $request;
+    private InMemoryUser $user;
+    private MockObject&TokenInterface $token;
+    private Response $response;
 
     protected function setUp(): void
     {
@@ -343,7 +344,7 @@ public function testLogsUseTheDecoratedAuthenticatorWhenItIsTraceable()
             ->willReturn($this->response);
 
         $logger = new class() extends AbstractLogger {
-            public $logContexts = [];
+            public array $logContexts = [];
 
             public function log($level, $message, array $context = []): void
             {
diff --git a/Tests/Authentication/DefaultAuthenticationFailureHandlerTest.php b/Tests/Authentication/DefaultAuthenticationFailureHandlerTest.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Security\Http\Tests\Authentication;
 
+use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Psr\Log\LoggerInterface;
 use Symfony\Component\HttpFoundation\ParameterBag;
@@ -26,13 +27,13 @@
 
 class DefaultAuthenticationFailureHandlerTest extends TestCase
 {
-    private $httpKernel;
-    private $httpUtils;
-    private $logger;
-    private $request;
-    private $response;
-    private $session;
-    private $exception;
+    private MockObject&HttpKernelInterface $httpKernel;
+    private MockObject&HttpUtils $httpUtils;
+    private MockObject&LoggerInterface $logger;
+    private Request $request;
+    private Response $response;
+    private MockObject&SessionInterface $session;
+    private AuthenticationException $exception;
 
     protected function setUp(): void
     {
diff --git a/Tests/Authenticator/AbstractLoginFormAuthenticatorTest.php b/Tests/Authenticator/AbstractLoginFormAuthenticatorTest.php
@@ -98,7 +98,7 @@ public static function provideSupportsData(): iterable
 
 class ConcreteFormAuthenticator extends AbstractLoginFormAuthenticator
 {
-    private $loginUrl;
+    private string $loginUrl;
 
     public function __construct(string $loginUrl)
     {
diff --git a/Tests/Authenticator/FormLoginAuthenticatorTest.php b/Tests/Authenticator/FormLoginAuthenticatorTest.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Security\Http\Tests\Authenticator;
 
+use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Session\SessionInterface;
@@ -28,11 +29,10 @@
 
 class FormLoginAuthenticatorTest extends TestCase
 {
-    private $userProvider;
-    private $successHandler;
-    private $failureHandler;
-    /** @var FormLoginAuthenticator */
-    private $authenticator;
+    private InMemoryUserProvider $userProvider;
+    private MockObject&AuthenticationSuccessHandlerInterface $successHandler;
+    private MockObject&AuthenticationFailureHandlerInterface $failureHandler;
+    private FormLoginAuthenticator $authenticator;
 
     protected function setUp(): void
     {
diff --git a/Tests/Authenticator/HttpBasicAuthenticatorTest.php b/Tests/Authenticator/HttpBasicAuthenticatorTest.php
@@ -24,20 +24,19 @@
 
 class HttpBasicAuthenticatorTest extends TestCase
 {
-    private $userProvider;
-    private $hasherFactory;
-    private $hasher;
-    private $authenticator;
+    private InMemoryUserProvider $userProvider;
+    private HttpBasicAuthenticator $authenticator;
 
     protected function setUp(): void
     {
         $this->userProvider = new InMemoryUserProvider();
-        $this->hasherFactory = $this->createMock(PasswordHasherFactoryInterface::class);
-        $this->hasher = $this->createMock(PasswordHasherInterface::class);
-        $this->hasherFactory
+
+        $hasherFactory = $this->createMock(PasswordHasherFactoryInterface::class);
+        $hasher = $this->createMock(PasswordHasherInterface::class);
+        $hasherFactory
             ->expects($this->any())
             ->method('getPasswordHasher')
-            ->willReturn($this->hasher);
+            ->willReturn($hasher);
 
         $this->authenticator = new HttpBasicAuthenticator('test', $this->userProvider);
     }
diff --git a/Tests/Authenticator/InMemoryAccessTokenHandler.php b/Tests/Authenticator/InMemoryAccessTokenHandler.php
@@ -20,7 +20,7 @@ class InMemoryAccessTokenHandler implements AccessTokenHandlerInterface
     /**
      * @var array<string, UserBadge>
      */
-    private $accessTokens = [];
+    private array $accessTokens = [];
 
     public function getUserBadgeFrom(string $accessToken): UserBadge
     {
diff --git a/Tests/Authenticator/JsonLoginAuthenticatorTest.php b/Tests/Authenticator/JsonLoginAuthenticatorTest.php
@@ -29,9 +29,8 @@ class JsonLoginAuthenticatorTest extends TestCase
 {
     use ExpectDeprecationTrait;
 
-    private $userProvider;
-    /** @var JsonLoginAuthenticator */
-    private $authenticator;
+    private InMemoryUserProvider $userProvider;
+    private JsonLoginAuthenticator $authenticator;
 
     protected function setUp(): void
     {
diff --git a/Tests/Authenticator/LoginLinkAuthenticatorTest.php b/Tests/Authenticator/LoginLinkAuthenticatorTest.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Security\Http\Tests\Authenticator;
 
+use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\Security\Core\User\UserInterface;
@@ -27,11 +28,10 @@
 
 class LoginLinkAuthenticatorTest extends TestCase
 {
-    private $loginLinkHandler;
-    private $successHandler;
-    private $failureHandler;
-    /** @var LoginLinkAuthenticator */
-    private $authenticator;
+    private MockObject&LoginLinkHandlerInterface $loginLinkHandler;
+    private MockObject&AuthenticationSuccessHandlerInterface $successHandler;
+    private MockObject&AuthenticationFailureHandlerInterface $failureHandler;
+    private LoginLinkAuthenticator $authenticator;
 
     protected function setUp(): void
     {
diff --git a/Tests/Authenticator/RememberMeAuthenticatorTest.php b/Tests/Authenticator/RememberMeAuthenticatorTest.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Security\Http\Tests\Authenticator;
 
+use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\HttpFoundation\Cookie;
 use Symfony\Component\HttpFoundation\Request;
@@ -25,9 +26,9 @@
 
 class RememberMeAuthenticatorTest extends TestCase
 {
-    private $rememberMeHandler;
-    private $tokenStorage;
-    private $authenticator;
+    private MockObject&RememberMeHandlerInterface $rememberMeHandler;
+    private TokenStorage $tokenStorage;
+    private RememberMeAuthenticator $authenticator;
 
     protected function setUp(): void
     {
diff --git a/Tests/Authenticator/X509AuthenticatorTest.php b/Tests/Authenticator/X509AuthenticatorTest.php
@@ -20,8 +20,8 @@
 
 class X509AuthenticatorTest extends TestCase
 {
-    private $userProvider;
-    private $authenticator;
+    private InMemoryUserProvider $userProvider;
+    private X509Authenticator $authenticator;
 
     protected function setUp(): void
     {
diff --git a/Tests/EventListener/CheckCredentialsListenerTest.php b/Tests/EventListener/CheckCredentialsListenerTest.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Security\Http\Tests\EventListener;
 
+use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\PasswordHasher\Hasher\PasswordHasherFactoryInterface;
 use Symfony\Component\PasswordHasher\PasswordHasherInterface;
@@ -28,9 +29,9 @@
 
 class CheckCredentialsListenerTest extends TestCase
 {
-    private $hasherFactory;
-    private $listener;
-    private $user;
+    private MockObject&PasswordHasherFactoryInterface $hasherFactory;
+    private CheckCredentialsListener $listener;
+    private InMemoryUser $user;
 
     protected function setUp(): void
     {
diff --git a/Tests/EventListener/CheckRememberMeConditionsListenerTest.php b/Tests/EventListener/CheckRememberMeConditionsListenerTest.php
@@ -26,9 +26,9 @@
 
 class CheckRememberMeConditionsListenerTest extends TestCase
 {
-    private $listener;
-    private $request;
-    private $response;
+    private CheckRememberMeConditionsListener $listener;
+    private Request $request;
+    private Response $response;
 
     protected function setUp(): void
     {
@@ -59,6 +59,7 @@ public function testSuccessfulJsonLoginWithoutSupportingAuthenticator()
     public function testSuccessfulLoginWithoutRequestParameter()
     {
         $this->request = Request::create('/login');
+        $this->response = new Response();
         $passport = $this->createPassport([new RememberMeBadge()]);
 
         $this->listener->onSuccessfulLogin($this->createLoginSuccessfulEvent($passport));
diff --git a/Tests/EventListener/CsrfProtectionListenerTest.php b/Tests/EventListener/CsrfProtectionListenerTest.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Security\Http\Tests\EventListener;
 
+use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Security\Core\Exception\InvalidCsrfTokenException;
 use Symfony\Component\Security\Core\User\InMemoryUser;
@@ -25,8 +26,8 @@
 
 class CsrfProtectionListenerTest extends TestCase
 {
-    private $csrfTokenManager;
-    private $listener;
+    private MockObject&CsrfTokenManagerInterface $csrfTokenManager;
+    private CsrfProtectionListener $listener;
 
     protected function setUp(): void
     {
diff --git a/Tests/EventListener/LoginThrottlingListenerTest.php b/Tests/EventListener/LoginThrottlingListenerTest.php
@@ -28,8 +28,8 @@
 
 class LoginThrottlingListenerTest extends TestCase
 {
-    private $requestStack;
-    private $listener;
+    private RequestStack $requestStack;
+    private LoginThrottlingListener $listener;
 
     protected function setUp(): void
     {
diff --git a/Tests/EventListener/PasswordMigratingListenerTest.php b/Tests/EventListener/PasswordMigratingListenerTest.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Security\Http\Tests\EventListener;
 
+use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\PasswordHasher\Hasher\PasswordHasherFactoryInterface;
@@ -31,9 +32,9 @@
 
 class PasswordMigratingListenerTest extends TestCase
 {
-    private $hasherFactory;
-    private $listener;
-    private $user;
+    private MockObject&PasswordHasherFactoryInterface $hasherFactory;
+    private PasswordMigratingListener $listener;
+    private UserInterface&PasswordAuthenticatedUserInterface $user;
 
     protected function setUp(): void
     {
diff --git a/Tests/EventListener/RememberMeListenerTest.php b/Tests/EventListener/RememberMeListenerTest.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Security\Http\Tests\EventListener;
 
+use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
@@ -27,10 +28,10 @@
 
 class RememberMeListenerTest extends TestCase
 {
-    private $rememberMeHandler;
-    private $listener;
-    private $request;
-    private $response;
+    private MockObject&RememberMeHandlerInterface $rememberMeHandler;
+    private RememberMeListener $listener;
+    private Request $request;
+    private Response $response;
 
     protected function setUp(): void
     {
diff --git a/Tests/EventListener/SessionStrategyListenerTest.php b/Tests/EventListener/SessionStrategyListenerTest.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Security\Http\Tests\EventListener;
 
+use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Session\SessionInterface;
@@ -25,10 +26,10 @@
 
 class SessionStrategyListenerTest extends TestCase
 {
-    private $sessionAuthenticationStrategy;
-    private $listener;
-    private $request;
-    private $token;
+    private MockObject&SessionAuthenticationStrategyInterface $sessionAuthenticationStrategy;
+    private SessionStrategyListener $listener;
+    private Request $request;
+    private NullToken $token;
 
     protected function setUp(): void
     {
diff --git a/Tests/EventListener/UserCheckerListenerTest.php b/Tests/EventListener/UserCheckerListenerTest.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Security\Http\Tests\EventListener;
 
+use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Security\Core\Event\AuthenticationSuccessEvent;
 use Symfony\Component\Security\Core\User\InMemoryUser;
@@ -25,9 +26,9 @@
 
 class UserCheckerListenerTest extends TestCase
 {
-    private $userChecker;
-    private $listener;
-    private $user;
+    private MockObject&UserCheckerInterface $userChecker;
+    private UserCheckerListener $listener;
+    private InMemoryUser $user;
 
     protected function setUp(): void
     {
diff --git a/Tests/EventListener/UserProviderListenerTest.php b/Tests/EventListener/UserProviderListenerTest.php
@@ -22,8 +22,8 @@
 
 class UserProviderListenerTest extends TestCase
 {
-    private $userProvider;
-    private $listener;
+    private InMemoryUserProvider $userProvider;
+    private UserProviderListener $listener;
 
     protected function setUp(): void
     {
diff --git a/Tests/Firewall/ContextListenerTest.php b/Tests/Firewall/ContextListenerTest.php
diff --git a/Tests/Firewall/SwitchUserListenerTest.php b/Tests/Firewall/SwitchUserListenerTest.php
diff --git a/Tests/LoginLink/LoginLinkHandlerTest.php b/Tests/LoginLink/LoginLinkHandlerTest.php
diff --git a/Tests/Logout/LogoutUrlGeneratorTest.php b/Tests/Logout/LogoutUrlGeneratorTest.php
diff --git a/Tests/RememberMe/PersistentRememberMeHandlerTest.php b/Tests/RememberMe/PersistentRememberMeHandlerTest.php
diff --git a/Tests/RememberMe/SignatureRememberMeHandlerTest.php b/Tests/RememberMe/SignatureRememberMeHandlerTest.php

Original file line number	Diff line number	Diff line change
`@@ -98,7 +98,7 @@ public static function provideSupportsData(): iterable`
`98`	`98`
`99`	`99`	`class ConcreteFormAuthenticator extends AbstractLoginFormAuthenticator`
`100`	`100`	`{`
`101`		`- private $loginUrl;`
	`101`	`+ private string $loginUrl;`
`102`	`102`
`103`	`103`	`public function __construct(string $loginUrl)`
`104`	`104`	`{`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@ class InMemoryAccessTokenHandler implements AccessTokenHandlerInterface`
`20`	`20`	`/**`
`21`	`21`	`* @var array<string, UserBadge>`
`22`	`22`	`*/`
`23`		`- private $accessTokens = [];`
	`23`	`+ private array $accessTokens = [];`
`24`	`24`
`25`	`25`	`public function getUserBadgeFrom(string $accessToken): UserBadge`
`26`	`26`	`{`
Original file line number	Diff line number	Diff line change
`@@ -29,9 +29,8 @@ class JsonLoginAuthenticatorTest extends TestCase`
`29`	`29`	`{`
`30`	`30`	`use ExpectDeprecationTrait;`
`31`	`31`
`32`		`- private $userProvider;`
`33`		`- /** @var JsonLoginAuthenticator */`
`34`		`- private $authenticator;`
	`32`	`+ private InMemoryUserProvider $userProvider;`
	`33`	`+ private JsonLoginAuthenticator $authenticator;`
`35`	`34`
`36`	`35`	`protected function setUp(): void`
`37`	`36`	`{`
Original file line number	Diff line number	Diff line change
`@@ -20,8 +20,8 @@`
`20`	`20`
`21`	`21`	`class X509AuthenticatorTest extends TestCase`
`22`	`22`	`{`
`23`		`- private $userProvider;`
`24`		`- private $authenticator;`
	`23`	`+ private InMemoryUserProvider $userProvider;`
	`24`	`+ private X509Authenticator $authenticator;`
`25`	`25`
`26`	`26`	`protected function setUp(): void`
`27`	`27`	`{`
Original file line number	Diff line number	Diff line change
`@@ -26,9 +26,9 @@`
`26`	`26`
`27`	`27`	`class CheckRememberMeConditionsListenerTest extends TestCase`
`28`	`28`	`{`
`29`		`- private $listener;`
`30`		`- private $request;`
`31`		`- private $response;`
	`29`	`+ private CheckRememberMeConditionsListener $listener;`
	`30`	`+ private Request $request;`
	`31`	`+ private Response $response;`
`32`	`32`
`33`	`33`	`protected function setUp(): void`
`34`	`34`	`{`
`@@ -59,6 +59,7 @@ public function testSuccessfulJsonLoginWithoutSupportingAuthenticator()`
`59`	`59`	`public function testSuccessfulLoginWithoutRequestParameter()`
`60`	`60`	`{`
`61`	`61`	`$this->request = Request::create('/login');`
	`62`	`+ $this->response = new Response();`
`62`	`63`	`$passport = $this->createPassport([new RememberMeBadge()]);`
`63`	`64`
`64`	`65`	`$this->listener->onSuccessfulLogin($this->createLoginSuccessfulEvent($passport));`
Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Component\Security\Http\Tests\EventListener;`
`13`	`13`
	`14`	`+use PHPUnit\Framework\MockObject\MockObject;`
`14`	`15`	`use PHPUnit\Framework\TestCase;`
`15`	`16`	`use Symfony\Component\Security\Core\Exception\InvalidCsrfTokenException;`
`16`	`17`	`use Symfony\Component\Security\Core\User\InMemoryUser;`
`@@ -25,8 +26,8 @@`
`25`	`26`
`26`	`27`	`class CsrfProtectionListenerTest extends TestCase`
`27`	`28`	`{`
`28`		`- private $csrfTokenManager;`
`29`		`- private $listener;`
	`29`	`+ private MockObject&CsrfTokenManagerInterface $csrfTokenManager;`
	`30`	`+ private CsrfProtectionListener $listener;`
`30`	`31`
`31`	`32`	`protected function setUp(): void`
`32`	`33`	`{`
Original file line number	Diff line number	Diff line change
`@@ -28,8 +28,8 @@`
`28`	`28`
`29`	`29`	`class LoginThrottlingListenerTest extends TestCase`
`30`	`30`	`{`
`31`		`- private $requestStack;`
`32`		`- private $listener;`
	`31`	`+ private RequestStack $requestStack;`
	`32`	`+ private LoginThrottlingListener $listener;`
`33`	`33`
`34`	`34`	`protected function setUp(): void`
`35`	`35`	`{`
Original file line number	Diff line number	Diff line change
`@@ -22,8 +22,8 @@`
`22`	`22`
`23`	`23`	`class UserProviderListenerTest extends TestCase`
`24`	`24`	`{`
`25`		`- private $userProvider;`
`26`		`- private $listener;`
	`25`	`+ private InMemoryUserProvider $userProvider;`
	`26`	`+ private UserProviderListener $listener;`
`27`	`27`
`28`	`28`	`protected function setUp(): void`
`29`	`29`	`{`