[Security] Fix return type declarations

derrabus · nicolas-grekas · commit e0d79f71ed79 · 2019-08-26T09:50:50.000+02:00
diff --git a/src/Symfony/Component/HttpKernel/ControllerMetadata/ArgumentMetadata.php b/src/Symfony/Component/HttpKernel/ControllerMetadata/ArgumentMetadata.php
@@ -58,7 +58,7 @@ public function getName()
      *
      * The type is the PHP class in 5.5+ and additionally the basic type in PHP 7.0+.
      *
-     * @return string
+     * @return string|null
      */
     public function getType()
     {
diff --git a/src/Symfony/Component/Security/Core/Tests/Authentication/Provider/DaoAuthenticationProviderTest.php b/src/Symfony/Component/Security/Core/Tests/Authentication/Provider/DaoAuthenticationProviderTest.php
@@ -18,6 +18,9 @@
 
 class DaoAuthenticationProviderTest extends TestCase
 {
+    /**
+     * @group legacy
+     */
     public function testRetrieveUserWhenProviderDoesNotReturnAnUserInterface()
     {
         $this->expectException('Symfony\Component\Security\Core\Exception\AuthenticationServiceException');
diff --git a/src/Symfony/Component/Security/Core/Tests/Authentication/Provider/UserAuthenticationProviderTest.php b/src/Symfony/Component/Security/Core/Tests/Authentication/Provider/UserAuthenticationProviderTest.php
@@ -62,6 +62,9 @@ public function testAuthenticateWhenUsernameIsNotFoundAndHideIsTrue()
         $provider->authenticate($this->getSupportedToken());
     }
 
+    /**
+     * @group legacy
+     */
     public function testAuthenticateWhenProviderDoesNotReturnAnUserInterface()
     {
         $this->expectException('Symfony\Component\Security\Core\Exception\AuthenticationServiceException');
diff --git a/src/Symfony/Component/Security/Guard/Tests/Provider/GuardAuthenticationProviderTest.php b/src/Symfony/Component/Security/Guard/Tests/Provider/GuardAuthenticationProviderTest.php
@@ -12,10 +12,10 @@
 namespace Symfony\Component\Security\Guard\Tests\Provider;
 
 use PHPUnit\Framework\TestCase;
-use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
 use Symfony\Component\Security\Core\User\UserInterface;
 use Symfony\Component\Security\Guard\AuthenticatorInterface;
 use Symfony\Component\Security\Guard\Provider\GuardAuthenticationProvider;
+use Symfony\Component\Security\Guard\Token\GuardTokenInterface;
 use Symfony\Component\Security\Guard\Token\PostAuthenticationGuardToken;
 use Symfony\Component\Security\Guard\Token\PreAuthenticationGuardToken;
 
@@ -68,7 +68,7 @@ public function testAuthenticate()
             ->with($enteredCredentials, $mockedUser)
             // authentication works!
             ->willReturn(true);
-        $authedToken = $this->getMockBuilder(TokenInterface::class)->getMock();
+        $authedToken = $this->getMockBuilder(GuardTokenInterface::class)->getMock();
         $authenticatorB->expects($this->once())
             ->method('createAuthenticatedToken')
             ->with($mockedUser, $providerKey)
@@ -130,7 +130,7 @@ public function testLegacyAuthenticate()
             ->with($enteredCredentials, $mockedUser)
             // authentication works!
             ->willReturn(true);
-        $authedToken = $this->getMockBuilder('Symfony\Component\Security\Core\Authentication\Token\TokenInterface')->getMock();
+        $authedToken = $this->getMockBuilder(GuardTokenInterface::class)->getMock();
         $authenticatorB->expects($this->once())
             ->method('createAuthenticatedToken')
             ->with($mockedUser, $providerKey)
diff --git a/src/Symfony/Component/Security/Http/Authentication/AuthenticationSuccessHandlerInterface.php b/src/Symfony/Component/Security/Http/Authentication/AuthenticationSuccessHandlerInterface.php
@@ -31,7 +31,7 @@ interface AuthenticationSuccessHandlerInterface
      * is called by authentication listeners inheriting from
      * AbstractAuthenticationListener.
      *
-     * @return Response never null
+     * @return Response
      */
     public function onAuthenticationSuccess(Request $request, TokenInterface $token);
 }
diff --git a/src/Symfony/Component/Security/Http/Tests/Authentication/DefaultAuthenticationFailureHandlerTest.php b/src/Symfony/Component/Security/Http/Tests/Authentication/DefaultAuthenticationFailureHandlerTest.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\Security\Http\Tests\Authentication;
 
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\HttpKernelInterface;
 use Symfony\Component\Security\Core\Security;
@@ -62,7 +63,7 @@ public function testForward()
 
     public function testRedirect()
     {
-        $response = new Response();
+        $response = new RedirectResponse('/login');
         $this->httpUtils->expects($this->once())
             ->method('createRedirectResponse')->with($this->request, '/login')
             ->willReturn($response);
diff --git a/src/Symfony/Component/Security/Http/Tests/EntryPoint/FormAuthenticationEntryPointTest.php b/src/Symfony/Component/Security/Http/Tests/EntryPoint/FormAuthenticationEntryPointTest.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\Security\Http\Tests\EntryPoint;
 
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\HttpKernelInterface;
 use Symfony\Component\Security\Http\EntryPoint\FormAuthenticationEntryPoint;
@@ -21,7 +22,7 @@ class FormAuthenticationEntryPointTest extends TestCase
     public function testStart()
     {
         $request = $this->getMockBuilder('Symfony\Component\HttpFoundation\Request')->disableOriginalConstructor()->disableOriginalClone()->getMock();
-        $response = new Response();
+        $response = new RedirectResponse('/the/login/path');
 
         $httpKernel = $this->getMockBuilder('Symfony\Component\HttpKernel\HttpKernelInterface')->getMock();
         $httpUtils = $this->getMockBuilder('Symfony\Component\Security\Http\HttpUtils')->getMock();
diff --git a/src/Symfony/Component/Security/Http/Tests/Firewall/ExceptionListenerTest.php b/src/Symfony/Component/Security/Http/Tests/Firewall/ExceptionListenerTest.php
@@ -72,6 +72,9 @@ public function getAuthenticationExceptionProvider()
         ];
     }
 
+    /**
+     * @group legacy
+     */
     public function testExceptionWhenEntryPointReturnsBadValue()
     {
         $event = $this->createEvent(new AuthenticationException());
diff --git a/src/Symfony/Component/Security/Http/Tests/Firewall/LogoutListenerTest.php b/src/Symfony/Component/Security/Http/Tests/Firewall/LogoutListenerTest.php
@@ -122,6 +122,9 @@ public function testHandleMatchedPathWithoutSuccessHandlerAndCsrfValidation()
         $listener->handle($event);
     }
 
+    /**
+     * @group legacy
+     */
     public function testSuccessHandlerReturnsNonResponse()
     {
         $this->expectException('RuntimeException');
diff --git a/src/Symfony/Component/Security/Http/Tests/Firewall/UsernamePasswordFormAuthenticationListenerTest.php b/src/Symfony/Component/Security/Http/Tests/Firewall/UsernamePasswordFormAuthenticationListenerTest.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\Security\Tests\Http\Firewall;
 
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Event\GetResponseEvent;
@@ -40,6 +41,10 @@ public function testHandleWhenUsernameLength($username, $ok)
             ->method('checkRequestPath')
             ->willReturn(true)
         ;
+        $httpUtils
+            ->method('createRedirectResponse')
+            ->willReturn(new RedirectResponse('/hello'))
+        ;
 
         $failureHandler = $this->getMockBuilder('Symfony\Component\Security\Http\Authentication\AuthenticationFailureHandlerInterface')->getMock();
         $failureHandler
@@ -52,7 +57,7 @@ public function testHandleWhenUsernameLength($username, $ok)
         $authenticationManager
             ->expects($ok ? $this->once() : $this->never())
             ->method('authenticate')
-            ->willReturn(new Response())
+            ->willReturnArgument(0)
         ;
 
         $listener = new UsernamePasswordFormAuthenticationListener(
@@ -61,7 +66,7 @@ public function testHandleWhenUsernameLength($username, $ok)
             $this->getMockBuilder('Symfony\Component\Security\Http\Session\SessionAuthenticationStrategyInterface')->getMock(),
             $httpUtils,
             'TheProviderKey',
-            $this->getMockBuilder('Symfony\Component\Security\Http\Authentication\AuthenticationSuccessHandlerInterface')->getMock(),
+            new DefaultAuthenticationSuccessHandler($httpUtils),
             $failureHandler,
             ['require_previous_session' => false]
         );
diff --git a/src/Symfony/Component/Security/Http/Tests/Logout/DefaultLogoutSuccessHandlerTest.php b/src/Symfony/Component/Security/Http/Tests/Logout/DefaultLogoutSuccessHandlerTest.php
@@ -12,15 +12,15 @@
 namespace Symfony\Component\Security\Http\Tests\Logout;
 
 use PHPUnit\Framework\TestCase;
-use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\Security\Http\Logout\DefaultLogoutSuccessHandler;
 
 class DefaultLogoutSuccessHandlerTest extends TestCase
 {
     public function testLogout()
     {
         $request = $this->getMockBuilder('Symfony\Component\HttpFoundation\Request')->getMock();
-        $response = new Response();
+        $response = new RedirectResponse('/dashboard');
 
         $httpUtils = $this->getMockBuilder('Symfony\Component\Security\Http\HttpUtils')->getMock();
         $httpUtils->expects($this->once())
diff --git a/src/Symfony/Component/Security/Http/Tests/RememberMe/AbstractRememberMeServicesTest.php b/src/Symfony/Component/Security/Http/Tests/RememberMe/AbstractRememberMeServicesTest.php
@@ -39,6 +39,9 @@ public function testAutoLoginReturnsNullWhenNoCookie()
         $this->assertNull($service->autoLogin(new Request()));
     }
 
+    /**
+     * @group legacy
+     */
     public function testAutoLoginThrowsExceptionWhenImplementationDoesNotReturnUserInterface()
     {
         $this->expectException('RuntimeException');

Original file line number	Diff line number	Diff line change
`@@ -58,7 +58,7 @@ public function getName()`
`58`	`58`	`*`
`59`	`59`	`* The type is the PHP class in 5.5+ and additionally the basic type in PHP 7.0+.`
`60`	`60`	`*`
`61`		`- * @return string`
	`61`	`+ * @return string\|null`
`62`	`62`	`*/`
`63`	`63`	`public function getType()`
`64`	`64`	`{`
Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,9 @@`
`18`	`18`
`19`	`19`	`class DaoAuthenticationProviderTest extends TestCase`
`20`	`20`	`{`
	`21`	`+ /**`
	`22`	`+ * @group legacy`
	`23`	`+ */`
`21`	`24`	`public function testRetrieveUserWhenProviderDoesNotReturnAnUserInterface()`
`22`	`25`	`{`
`23`	`26`	`$this->expectException('Symfony\Component\Security\Core\Exception\AuthenticationServiceException');`
Original file line number	Diff line number	Diff line change
`@@ -62,6 +62,9 @@ public function testAuthenticateWhenUsernameIsNotFoundAndHideIsTrue()`
`62`	`62`	`$provider->authenticate($this->getSupportedToken());`
`63`	`63`	`}`
`64`	`64`
	`65`	`+ /**`
	`66`	`+ * @group legacy`
	`67`	`+ */`
`65`	`68`	`public function testAuthenticateWhenProviderDoesNotReturnAnUserInterface()`
`66`	`69`	`{`
`67`	`70`	`$this->expectException('Symfony\Component\Security\Core\Exception\AuthenticationServiceException');`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ interface AuthenticationSuccessHandlerInterface`
`31`	`31`	`* is called by authentication listeners inheriting from`
`32`	`32`	`* AbstractAuthenticationListener.`
`33`	`33`	`*`
`34`		`- * @return Response never null`
	`34`	`+ * @return Response`
`35`	`35`	`*/`
`36`	`36`	`public function onAuthenticationSuccess(Request $request, TokenInterface $token);`
`37`	`37`	`}`
Original file line number	Diff line number	Diff line change
`@@ -72,6 +72,9 @@ public function getAuthenticationExceptionProvider()`
`72`	`72`	`];`
`73`	`73`	`}`
`74`	`74`
	`75`	`+ /**`
	`76`	`+ * @group legacy`
	`77`	`+ */`
`75`	`78`	`public function testExceptionWhenEntryPointReturnsBadValue()`
`76`	`79`	`{`
`77`	`80`	`$event = $this->createEvent(new AuthenticationException());`
Original file line number	Diff line number	Diff line change
`@@ -122,6 +122,9 @@ public function testHandleMatchedPathWithoutSuccessHandlerAndCsrfValidation()`
`122`	`122`	`$listener->handle($event);`
`123`	`123`	`}`
`124`	`124`
	`125`	`+ /**`
	`126`	`+ * @group legacy`
	`127`	`+ */`
`125`	`128`	`public function testSuccessHandlerReturnsNonResponse()`
`126`	`129`	`{`
`127`	`130`	`$this->expectException('RuntimeException');`