Maintain | Merge branch 1.4 into master

hwi · Dec 7, 2021 · ab1bf5f · ab1bf5f
1 parent 28ce4a7
commit ab1bf5f
Show file tree

Hide file tree

Showing 28 changed files with 73 additions and 71 deletions.
diff --git a/DependencyInjection/Security/Factory/OAuthAuthenticatorFactory.php b/DependencyInjection/Security/Factory/OAuthAuthenticatorFactory.php
@@ -143,6 +143,7 @@ protected function createEntryPoint($container, $id, $config, ?string $defaultEn
      */
     protected function createListener(ContainerBuilder $container, string $id, array $config, string $userProvider): string
     {
+        // @phpstan-ignore-next-line Symfony <5.4 BC layer
         $listenerId = parent::createListener($container, $id, $config, $userProvider);
 
         $checkPaths = $config['resource_owners'];

diff --git a/HWIOAuthBundle.php b/HWIOAuthBundle.php
@@ -37,9 +37,9 @@ public function build(ContainerBuilder $container)
         /** @var SecurityExtension $extension */
         $extension = $container->getExtension('security');
 
-        // Symfony < 5.4 BC layer
         if (interface_exists(AuthenticationProviderInterface::class)) {
-            $extension->addSecurityListenerFactory(new OAuthFactory()); // @phpstan-ignore-this-line Symfony < 5.4 BC layer
+            // @phpstan-ignore-next-line Symfony < 5.4 BC layer
+            $extension->addSecurityListenerFactory(new OAuthFactory());
         } else {
             $extension->addAuthenticatorFactory(new OAuthAuthenticatorFactory());
         }

diff --git a/Security/Core/Authentication/Token/AbstractOAuthToken.php b/Security/Core/Authentication/Token/AbstractOAuthToken.php
@@ -69,7 +69,7 @@ public function __construct($accessToken, array $roles = [])
 
         // required for compatibility with Symfony 5.4
         if (method_exists($this, 'setAuthenticated')) {
-            parent::setAuthenticated(\count($roles) > 0, false);
+            $this->setAuthenticated(\count($roles) > 0, false);
         }
     }
 

diff --git a/Security/Core/User/EntityUserProvider.php b/Security/Core/User/EntityUserProvider.php
@@ -114,7 +114,9 @@ public function refreshUser(UserInterface $user)
         }
 
         $userId = $accessor->getValue($user, $identifier);
-        $username = $user->getUsername();
+
+        // @phpstan-ignore-next-line Symfony <5.4 BC layer
+        $username = method_exists($user, 'getUserIdentifier') ? $user->getUserIdentifier() : $user->getUsername();
 
         if (null === $user = $this->findUser([$identifier => $userId])) {
             throw $this->createUserNotFoundException($username, sprintf('User with ID "%d" could not be reloaded.', $userId));
@@ -148,9 +150,13 @@ private function createUserNotFoundException(string $username, string $message)
             $exception = new UserNotFoundException($message);
             $exception->setUserIdentifier($username);
         } else {
+            if (!class_exists(UsernameNotFoundException::class)) {
+                throw new \RuntimeException('Unsupported Symfony version used!');
+            }
+
             $exception = new UsernameNotFoundException($message);
             if (method_exists($exception, 'setUsername')) {
-                $exception->setUsername($username);
+                $exception->setUsername($username); // @phpstan-ignore-this-line Symfony <5.4 BC layer
             }
         }
 

diff --git a/Security/Core/User/OAuthUser.php b/Security/Core/User/OAuthUser.php
@@ -25,9 +25,6 @@ public function __construct(string $username)
         $this->username = $username;
     }
 
-    /**
-     * @return string
-     */
     public function getUserIdentifier(): string
     {
         return $this->username;
@@ -41,43 +38,31 @@ public function getRoles(): array
         return ['ROLE_USER', 'ROLE_OAUTH_USER'];
     }
 
-    /**
-     * @return string|null
-     */
     public function getPassword(): ?string
     {
         return null;
     }
 
-    /**
-     * @return string|null
-     */
     public function getSalt(): ?string
     {
         return null;
     }
 
-    /**
-     * @return string
-     */
     public function getUsername(): string
     {
         return $this->getUserIdentifier();
     }
 
-    /**
-     * @return bool
-     */
     public function eraseCredentials(): bool
     {
         return true;
     }
 
-    /**
-     * @return bool
-     */
     public function equals(UserInterface $user): bool
     {
-        return $user->getUsername() === $this->username;
+        // @phpstan-ignore-next-line Symfony <5.4 BC layer
+        $username = method_exists($user, 'getUserIdentifier') ? $user->getUserIdentifier() : $user->getUsername();
+
+        return $username === $this->username;
     }
 }
diff --git a/Security/Core/User/OAuthUserProvider.php b/Security/Core/User/OAuthUserProvider.php
@@ -53,7 +53,10 @@ public function refreshUser(UserInterface $user)
             throw new UnsupportedUserException(sprintf('Unsupported user class "%s"', \get_class($user)));
         }
 
-        return $this->loadUserByUsername($user->getUsername());
+        // @phpstan-ignore-next-line Symfony <5.4 BC layer
+        $username = method_exists($user, 'getUserIdentifier') ? $user->getUserIdentifier() : $user->getUsername();
+
+        return $this->loadUserByUsername($username);
     }
 
     /**

diff --git a/Security/Http/Authenticator/OAuthAuthenticator.php b/Security/Http/Authenticator/OAuthAuthenticator.php
@@ -152,18 +152,14 @@ public function authenticate(Request $request): Passport
         return new SelfValidatingPassport(
             class_exists(UserBadge::class)
                 ? new UserBadge(
+                    // @phpstan-ignore-next-line Symfony <5.4 BC layer
                     method_exists($user, 'getUserIdentifier') ? $user->getUserIdentifier() : $user->getUsername(),
                     static function () use ($user) { return $user; }
                 )
                 : $user
         );
     }
 
-    public function createToken(PassportInterface $passport, string $firewallName): TokenInterface
-    {
-        return $this->createAuthenticatedToken($passport, $firewallName);
-    }
-
     /**
      * @param Passport|SelfValidatingPassport $passport
      */

diff --git a/Templating/Helper/OAuthHelper.php b/Templating/Helper/OAuthHelper.php
@@ -79,6 +79,7 @@ private function getMainRequest(): ?Request
             return $this->requestStack->getMainRequest(); // Symfony 5.3+
         }
 
+        // @phpstan-ignore-next-line
         return $this->requestStack->getMasterRequest();
     }
 }
diff --git a/Test/Fixtures/ResourceOwner/OAuth1ResourceOwnerStub.php b/Test/Fixtures/ResourceOwner/OAuth1ResourceOwnerStub.php
@@ -11,7 +11,7 @@
  * file that was distributed with this source code.
  */
 
-namespace HWI\Bundle\OAuthBundle\Test\OAuth\ResourceOwner;
+namespace HWI\Bundle\OAuthBundle\Test\Fixtures\ResourceOwner;
 
 use HWI\Bundle\OAuthBundle\OAuth\ResourceOwner\GenericOAuth1ResourceOwner;
 

diff --git a/Test/Fixtures/ResourceOwner/OAuth2ResourceOwnerStub.php b/Test/Fixtures/ResourceOwner/OAuth2ResourceOwnerStub.php
@@ -11,7 +11,7 @@
  * file that was distributed with this source code.
  */
 
-namespace HWI\Bundle\OAuthBundle\Test\OAuth\ResourceOwner;
+namespace HWI\Bundle\OAuthBundle\Test\Fixtures\ResourceOwner;
 
 use HWI\Bundle\OAuthBundle\OAuth\ResourceOwner\GenericOAuth2ResourceOwner;
 

diff --git a/Test/OAuth/ResourceOwner/GenericOAuth2ResourceOwnerTestCase.php b/Test/OAuth/ResourceOwner/GenericOAuth2ResourceOwnerTestCase.php
@@ -166,8 +166,8 @@ public function testGetState(): void
             ->willReturn(serialize(new State(['state' => 'some-state'])));
 
         $state = $resourceOwner->getState();
-        self::assertEquals($state->get('initial_state_param_1'), 'value');
-        self::assertEquals($state->get('state'), 'some-state');
+        self::assertEquals('value', $state->get('initial_state_param_1'));
+        self::assertEquals('some-state', $state->get('state'));
     }
 
     public function testGetStateWithoutStoredValues(): void
@@ -207,7 +207,7 @@ public function testGetAuthorizationUrlWithEnabledCsrf(): void
     /**
      * @dataProvider provideAccessTokenData
      */
-    public function testGetAccessToken(string $response, string $contentType)
+    public function testGetAccessToken(string $response, string $contentType): void
     {
         $resourceOwner = $this->createResourceOwner(
             [],
@@ -293,7 +293,7 @@ public function testGetAccessTokenErrorResponse(): void
     /**
      * @dataProvider provideRefreshToken
      */
-    public function testRefreshAccessToken($response, $contentType)
+    public function testRefreshAccessToken($response, $contentType): void
     {
         $resourceOwner = $this->createResourceOwner(
             [],
@@ -320,7 +320,7 @@ public function provideRefreshToken(): iterable
     /**
      * @dataProvider provideInvalidRefreshToken
      */
-    public function testRefreshAccessTokenInvalid(string $response, string $exceptionClass)
+    public function testRefreshAccessTokenInvalid(string $response, string $exceptionClass): void
     {
         $this->expectException($exceptionClass);
 

diff --git a/Test/OAuth/ResourceOwner/ResourceOwnerTestCase.php b/Test/OAuth/ResourceOwner/ResourceOwnerTestCase.php
@@ -15,6 +15,8 @@
 use HWI\Bundle\OAuthBundle\OAuth\ResourceOwner\GenericOAuth1ResourceOwner;
 use HWI\Bundle\OAuthBundle\OAuth\ResourceOwner\GenericOAuth2ResourceOwner;
 use HWI\Bundle\OAuthBundle\OAuth\ResourceOwnerInterface;
+use HWI\Bundle\OAuthBundle\Test\Fixtures\ResourceOwner\OAuth1ResourceOwnerStub;
+use HWI\Bundle\OAuthBundle\Test\Fixtures\ResourceOwner\OAuth2ResourceOwnerStub;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\HttpClient\MockHttpClient;

diff --git a/Tests/App/Form/RegistrationFormType.php b/Tests/App/Form/RegistrationFormType.php
@@ -62,7 +62,7 @@ public function configureOptions(OptionsResolver $resolver)
     /**
      * {@inheritdoc}
      */
-    public function getBlockPrefix()
+    public function getBlockPrefix(): string
     {
         return 'registration';
     }

diff --git a/Tests/Controller/AbstractConnectControllerTest.php b/Tests/Controller/AbstractConnectControllerTest.php
@@ -20,6 +20,7 @@
 use HWI\Bundle\OAuthBundle\Security\Http\ResourceOwnerMapLocator;
 use HWI\Bundle\OAuthBundle\Security\OAuthUtils;
 use HWI\Bundle\OAuthBundle\Test\Fixtures\CustomUserResponse;
+use HWI\Bundle\OAuthBundle\Tests\App\Form\RegistrationFormType;
 use HWI\Bundle\OAuthBundle\Tests\Fixtures\CustomOAuthToken;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;

diff --git a/Tests/OAuth/ResourceOwner/AppleResourceOwnerTest.php b/Tests/OAuth/ResourceOwner/AppleResourceOwnerTest.php
@@ -12,6 +12,7 @@
 namespace HWI\Bundle\OAuthBundle\Tests\OAuth\ResourceOwner;
 
 use HWI\Bundle\OAuthBundle\OAuth\ResourceOwner\AppleResourceOwner;
+use HWI\Bundle\OAuthBundle\OAuth\Response\AbstractUserResponse;
 use HWI\Bundle\OAuthBundle\Test\Fixtures\CustomUserResponse;
 use HWI\Bundle\OAuthBundle\Test\OAuth\ResourceOwner\GenericOAuth2ResourceOwnerTestCase;
 use Symfony\Component\HttpFoundation\Request;

diff --git a/Tests/OAuth/ResourceOwner/Auth0ResourceOwnerTest.php b/Tests/OAuth/ResourceOwner/Auth0ResourceOwnerTest.php
@@ -12,9 +12,8 @@
 namespace HWI\Bundle\OAuthBundle\Tests\OAuth\ResourceOwner;
 
 use HWI\Bundle\OAuthBundle\OAuth\ResourceOwner\Auth0ResourceOwner;
-use HWI\Bundle\OAuthBundle\Test\OAuth\ResourceOwner\GenericOAuth2ResourceOwnerTestCase;
 use HWI\Bundle\OAuthBundle\OAuth\ResourceOwnerInterface;
-use Symfony\Component\HttpFoundation\Request;
+use HWI\Bundle\OAuthBundle\Test\OAuth\ResourceOwner\GenericOAuth2ResourceOwnerTestCase;
 use Symfony\Component\Security\Http\HttpUtils;
 
 final class Auth0ResourceOwnerTest extends GenericOAuth2ResourceOwnerTestCase

diff --git a/Tests/OAuth/ResourceOwner/AzureResourceOwnerTest.php b/Tests/OAuth/ResourceOwner/AzureResourceOwnerTest.php
@@ -14,7 +14,7 @@
 use HWI\Bundle\OAuthBundle\OAuth\Exception\HttpTransportException;
 use HWI\Bundle\OAuthBundle\OAuth\ResourceOwner\AzureResourceOwner;
 use HWI\Bundle\OAuthBundle\OAuth\Response\AbstractUserResponse;
-use HWI\Bundle\OAuthBundle\Tests\Fixtures\CustomUserResponse;
+use HWI\Bundle\OAuthBundle\Test\Fixtures\CustomUserResponse;
 use HWI\Bundle\OAuthBundle\Test\OAuth\ResourceOwner\GenericOAuth2ResourceOwnerTestCase;
 
 final class AzureResourceOwnerTest extends GenericOAuth2ResourceOwnerTestCase

diff --git a/Tests/OAuth/ResourceOwner/GitHubResourceOwnerTest.php b/Tests/OAuth/ResourceOwner/GitHubResourceOwnerTest.php
@@ -13,8 +13,8 @@
 
 use HWI\Bundle\OAuthBundle\OAuth\ResourceOwner\GitHubResourceOwner;
 use HWI\Bundle\OAuthBundle\OAuth\Response\AbstractUserResponse;
-use HWI\Bundle\OAuthBundle\Test\OAuth\ResourceOwner\GenericOAuth2ResourceOwnerTestCase;
 use HWI\Bundle\OAuthBundle\Test\Fixtures\CustomUserResponse;
+use HWI\Bundle\OAuthBundle\Test\OAuth\ResourceOwner\GenericOAuth2ResourceOwnerTestCase;
 
 final class GitHubResourceOwnerTest extends GenericOAuth2ResourceOwnerTestCase
 {

diff --git a/Tests/OAuth/ResourceOwner/LinkedinResourceOwnerTest.php b/Tests/OAuth/ResourceOwner/LinkedinResourceOwnerTest.php
@@ -13,8 +13,8 @@
 
 use HWI\Bundle\OAuthBundle\OAuth\ResourceOwner\LinkedinResourceOwner;
 use HWI\Bundle\OAuthBundle\OAuth\Response\AbstractUserResponse;
-use HWI\Bundle\OAuthBundle\Test\OAuth\ResourceOwner\GenericOAuth2ResourceOwnerTestCase;
 use HWI\Bundle\OAuthBundle\Test\Fixtures\CustomUserResponse;
+use HWI\Bundle\OAuthBundle\Test\OAuth\ResourceOwner\GenericOAuth2ResourceOwnerTestCase;
 
 final class LinkedinResourceOwnerTest extends GenericOAuth2ResourceOwnerTestCase
 {

diff --git a/Tests/OAuth/ResourceOwner/SinaWeiboResourceOwnerTest.php b/Tests/OAuth/ResourceOwner/SinaWeiboResourceOwnerTest.php
@@ -14,8 +14,8 @@
 use HWI\Bundle\OAuthBundle\OAuth\Exception\HttpTransportException;
 use HWI\Bundle\OAuthBundle\OAuth\ResourceOwner\SinaWeiboResourceOwner;
 use HWI\Bundle\OAuthBundle\OAuth\Response\AbstractUserResponse;
-use HWI\Bundle\OAuthBundle\Test\OAuth\ResourceOwner\GenericOAuth2ResourceOwnerTestCase;
 use HWI\Bundle\OAuthBundle\Test\Fixtures\CustomUserResponse;
+use HWI\Bundle\OAuthBundle\Test\OAuth\ResourceOwner\GenericOAuth2ResourceOwnerTestCase;
 
 final class SinaWeiboResourceOwnerTest extends GenericOAuth2ResourceOwnerTestCase
 {

diff --git a/Tests/OAuth/ResourceOwner/YahooResourceOwnerTest.php b/Tests/OAuth/ResourceOwner/YahooResourceOwnerTest.php
@@ -13,9 +13,9 @@
 
 use HWI\Bundle\OAuthBundle\OAuth\ResourceOwner\YahooResourceOwner;
 use HWI\Bundle\OAuthBundle\Test\Fixtures\CustomUserResponse;
-use HWI\Bundle\OAuthBundle\Test\OAuth\ResourceOwner\GenericOAuth1ResourceOwnerTestCase;
+use HWI\Bundle\OAuthBundle\Test\OAuth\ResourceOwner\GenericOAuth2ResourceOwnerTestCase;
 
-final class YahooResourceOwnerTest extends GenericOAuth1ResourceOwnerTestCase
+final class YahooResourceOwnerTest extends GenericOAuth2ResourceOwnerTestCase
 {
     protected string $resourceOwnerClass = YahooResourceOwner::class;
     protected string $userResponse = <<<json

diff --git a/Tests/Security/Core/Authentication/Provider/OAuthProviderTest.php b/Tests/Security/Core/Authentication/Provider/OAuthProviderTest.php
@@ -26,7 +26,6 @@
 use Symfony\Component\Security\Core\Authentication\Provider\AuthenticationProviderInterface;
 use Symfony\Component\Security\Core\Authentication\Token\Storage\TokenStorageInterface;
 use Symfony\Component\Security\Core\User\UserCheckerInterface;
-use Symfony\Component\Security\Core\User\UserInterface;
 use Symfony\Component\Security\Http\HttpUtils;
 
 /**

diff --git a/Tests/Security/Core/Authentication/Token/OAuthTokenTest.php b/Tests/Security/Core/Authentication/Token/OAuthTokenTest.php
@@ -15,7 +15,6 @@
 use HWI\Bundle\OAuthBundle\Security\Core\Exception\AccountNotLinkedException;
 use HWI\Bundle\OAuthBundle\Tests\Fixtures\User;
 use PHPUnit\Framework\TestCase;
-use Symfony\Component\Security\Core\User\UserInterface;
 
 final class OAuthTokenTest extends TestCase
 {

diff --git a/Tests/Security/Core/User/EntityUserProviderTest.php b/Tests/Security/Core/User/EntityUserProviderTest.php
@@ -51,12 +51,7 @@ public function testLoadUserByIdentifierThrowsExceptionWhenUserIsNotFound(): voi
 
     public function testLoadUserByUsernameThrowsExceptionWhenUserIsNull(): void
     {
-        if (class_exists(UserNotFoundException::class)) {
-            $this->expectException(UserNotFoundException::class);
-        } else {
-            $this->expectException(UsernameNotFoundException::class);
-        }
-
+        $this->assertUserNotFoundException();
         $this->expectExceptionMessage("User 'asm89' not found.");
 
         $provider = $this->createEntityUserProvider();
@@ -74,12 +69,7 @@ public function testLoadUserByOAuthUserResponseThrowsExceptionWhenNoPropertyIsCo
 
     public function testLoadUserByOAuthUserResponseThrowsExceptionWhenUserIsNull(): void
     {
-        if (class_exists(UserNotFoundException::class)) {
-            $this->expectException(UserNotFoundException::class);
-        } else {
-            $this->expectException(UsernameNotFoundException::class);
-        }
-
+        $this->assertUserNotFoundException();
         $this->expectExceptionMessage("User 'asm89' not found.");
 
         $userResponseMock = $this->createUserResponseMock('asm89', 'github');
@@ -102,12 +92,7 @@ public function testLoadUserByOAuthUserResponse(): void
 
     public function testRefreshUserThrowsExceptionWhenUserIsNull(): void
     {
-        if (class_exists(UserNotFoundException::class)) {
-            $this->expectException(UserNotFoundException::class);
-        } else {
-            $this->expectException(UsernameNotFoundException::class);
-        }
-
+        $this->assertUserNotFoundException();
         $this->expectExceptionMessage('User with ID "1" could not be reloaded.');
 
         $provider = $this->createEntityUserProvider();
@@ -197,4 +182,18 @@ private function createUserResponseMock($username = null, $resourceOwnerName = n
 
         return $responseMock;
     }
+
+    private function assertUserNotFoundException(): void
+    {
+        if (class_exists(UserNotFoundException::class)) {
+            $this->expectException(UserNotFoundException::class);
+        } else {
+            if (!class_exists(UsernameNotFoundException::class)) {
+                $this->markTestSkipped('Requires Symfony <5.4');
+            }
+
+            // @phpstan-ignore-next-line Symfony <5.4 BC layer
+            $this->expectException(UsernameNotFoundException::class);
+        }
+    }
 }
diff --git a/Tests/Security/Core/User/OAuthUserProviderTest.php b/Tests/Security/Core/User/OAuthUserProviderTest.php
@@ -34,6 +34,7 @@ public function testLoadUserByUsernameOrIdentifier(): void
             $user = $this->provider->loadUserByUsername('asm89');
 
             $this->assertInstanceOf(OAuthUser::class, $user);
+            // @phpstan-ignore-next-line Symfony < 5.4 BC layer
             $this->assertEquals('asm89', $user->getUsername());
         } else {
             $user = $this->provider->loadUserByIdentifier('asm89');
@@ -89,6 +90,7 @@ public function testLoadUserByOAuthUserResponse(): void
         $this->assertInstanceOf(OAuthUser::class, $user);
 
         if (method_exists($this->provider, 'loadUserByUsername')) {
+            // @phpstan-ignore-next-line Symfony < 5.4 BC layer
             $this->assertEquals('asm89', $user->getUsername());
         } else {
             $this->assertEquals('asm89', $user->getUserIdentifier());