[make:user] implement getUserIdentifier if required

src/Maker/MakeUser.php

@@ -33,6 +33,7 @@
 use Symfony\Component\Console\Input\InputOption;
 use Symfony\Component\Security\Core\Encoder\Argon2iPasswordEncoder;
 use Symfony\Component\Security\Core\Encoder\NativePasswordEncoder;
+use Symfony\Component\Security\Core\Exception\UserNotFoundException;
 use Symfony\Component\Security\Core\User\PasswordUpgraderInterface;
 use Symfony\Component\Yaml\Yaml;
 
@@ -171,6 +172,7 @@ public function generate(InputInterface $input, ConsoleStyle $io, Generator $gen
                 $userClassConfiguration->getUserProviderClass(),
                 'security/UserProvider.tpl.php',
                 [
+                    'uses_user_identifier' => class_exists(UserNotFoundException::class),
                     'user_short_name' => $userClassNameDetails->getShortName(),
                 ]
             );

src/Resources/skeleton/security/UserProvider.tpl.php

@@ -3,7 +3,7 @@
 namespace <?= $namespace; ?>;
 
 use Symfony\Component\Security\Core\Exception\UnsupportedUserException;
-use Symfony\Component\Security\Core\Exception\UsernameNotFoundException;
+use Symfony\Component\Security\Core\Exception\<?= $uses_user_identifier ? 'UserNotFoundException' : 'UsernameNotFoundException' ?>;
 <?= ($password_upgrader = interface_exists('Symfony\Component\Security\Core\User\PasswordUpgraderInterface')) ? "use Symfony\Component\Security\Core\User\PasswordUpgraderInterface;\n" : '' ?>
 use Symfony\Component\Security\Core\User\UserInterface;
 use Symfony\Component\Security\Core\User\UserProviderInterface;
@@ -17,17 +17,15 @@ class <?= $class_name ?> implements UserProviderInterface<?= $password_upgrader
      * If you're not using these features, you do not need to implement
      * this method.
      *
-     * @return UserInterface
-     *
-     * @throws UsernameNotFoundException if the user is not found
+     * @throws <?= $uses_user_identifier ? 'UserNotFoundException' :  'UsernameNotFoundException' ?> if the user is not found
      */
-    public function loadUserByUsername($username)
+    public function <?= $uses_user_identifier ? 'loadUserByIdentifier($identifier)' : 'loadUserByUsername($username)' ?>: UserInterface
     {
-        // Load a User object from your data source or throw UsernameNotFoundException.
-        // The $username argument may not actually be a username:
-        // it is whatever value is being returned by the getUsername()
+        // Load a User object from your data source or throw <?= $uses_user_identifier ? 'UserNotFoundException' :  'UsernameNotFoundException' ?>.
+        // The <?= $uses_user_identifier ? '$identifier' :  '$username' ?> argument may not actually be a username:
+        // it is whatever value is being returned by the <?= $uses_user_identifier ? 'getUserIdentifier' :  'getUsername' ?>()
         // method in your User class.
-        throw new \Exception('TODO: fill in loadUserByUsername() inside '.__FILE__);
+        throw new \Exception('TODO: fill in <?= $uses_user_identifier ? 'loadUserByIdentifier()' : 'loadUserByUsername()' ?> inside '.__FILE__);
     }
 
     /**

src/Security/UserClassBuilder.php

@@ -14,6 +14,7 @@
 use PhpParser\Node;
 use Symfony\Bundle\MakerBundle\Util\ClassSourceManipulator;
 use Symfony\Component\HttpKernel\Kernel;
+use Symfony\Component\Security\Core\User\InMemoryUser;
 use Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface;
 use Symfony\Component\Security\Core\User\UserInterface;
 
@@ -67,7 +68,7 @@ private function addPasswordImplementation(ClassSourceManipulator $manipulator,
         $this->addGetPassword($manipulator, $userClassConfig);
     }
 
-    private function addGetUsername(ClassSourceManipulator $manipulator, UserClassConfiguration $userClassConfig)
+    private function addGetUsername(ClassSourceManipulator $manipulator, UserClassConfiguration $userClassConfig): void
     {
         if ($userClassConfig->isEntity()) {
             // add entity property
@@ -97,10 +98,17 @@ private function addGetUsername(ClassSourceManipulator $manipulator, UserClassCo
             );
         }
 
+        $getterIdentifierName = 'getUsername';
+
+        // Check if we're using Symfony 5.3+ - UserInterface::getUsername() was replaced with UserInterface::getUserIdentifier()
+        if (class_exists(InMemoryUser::class)) {
+            $getterIdentifierName = 'getUserIdentifier';
+        }
+
         // define getUsername (if it was defined above, this will override)
         $manipulator->addAccessorMethod(
             $userClassConfig->getIdentityPropertyName(),
-            'getUsername',
+            $getterIdentifierName,
             'string',
             false,
             [

tests/Security/UserClassBuilderTest.php

@@ -16,75 +16,175 @@
 use Symfony\Bundle\MakerBundle\Security\UserClassConfiguration;
 use Symfony\Bundle\MakerBundle\Util\ClassSourceManipulator;
 use Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface;
+use Symfony\Component\Security\Core\User\User;
 
 class UserClassBuilderTest extends TestCase
 {
     /**
      * @dataProvider getUserInterfaceTests
      */
-    public function testAddUserInterfaceImplementation(UserClassConfiguration $userClassConfig, string $expectedFilename)
+    public function testAddUserInterfaceImplementation(UserClassConfiguration $userClassConfig, string $expectedFilename): void
     {
-        $sourceFilename = __DIR__.'/fixtures/source/'.($userClassConfig->isEntity() ? 'UserEntity.php' : 'UserModel.php');
+        if (!interface_exists(PasswordAuthenticatedUserInterface::class)) {
+            self::markTestSkipped('Requires Symfony >= 5.3');
+        }
 
-        $manipulator = new ClassSourceManipulator(
-            file_get_contents($sourceFilename),
-            true
-        );
+        $manipulator = $this->getClassSourceManipulator($userClassConfig);
 
         $classBuilder = new UserClassBuilder();
         $classBuilder->addUserInterfaceImplementation($manipulator, $userClassConfig);
 
-        $expectedPath = __DIR__.'/fixtures/expected';
+        $expectedPath = $this->getExpectedPath($expectedFilename);
 
-        // Can be removed when < Symfony 6 support is dropped.
-        if (!interface_exists(PasswordAuthenticatedUserInterface::class)) {
-            $expectedPath = sprintf('%s/legacy', $expectedPath);
-        }
+        self::assertStringEqualsFile($expectedPath, $manipulator->getSourceCode());
+    }
 
-        $expectedPath = sprintf('%s/%s', $expectedPath, $expectedFilename);
+    public function getUserInterfaceTests(): \Generator
+    {
+        yield 'entity_with_email_as_identifier' => [
+            new UserClassConfiguration(true, 'email', true),
+            'UserEntityWithEmailAsIdentifier.php',
+        ];
 
-        if (!file_exists($expectedPath)) {
-            throw new \Exception(sprintf('Expected file missing: "%s"', $expectedPath));
+        yield 'entity_with_password' => [
+            new UserClassConfiguration(true, 'userIdentifier', true),
+            'UserEntityWithPassword.php',
+        ];
+
+        yield 'entity_with_user_identifier_as_identifier' => [
+            new UserClassConfiguration(true, 'user_identifier', true),
+            'UserEntityWithUser_IdentifierAsIdentifier.php',
+        ];
+
+        yield 'entity_without_password' => [
+            new UserClassConfiguration(true, 'userIdentifier', false),
+            'UserEntityWithoutPassword.php',
+        ];
+
+        yield 'model_with_email_as_identifier' => [
+            new UserClassConfiguration(false, 'email', true),
+            'UserModelWithEmailAsIdentifier.php',
+        ];
+
+        yield 'model_with_password' => [
+            new UserClassConfiguration(false, 'userIdentifier', true),
+            'UserModelWithPassword.php',
+        ];
+
+        yield 'model_without_password' => [
+            new UserClassConfiguration(false, 'userIdentifier', false),
+            'UserModelWithoutPassword.php',
+        ];
+    }
+
+    /**
+     * Covers Symfony <= 5.2 UserInterface::getUsername().
+     *
+     * In Symfony 5.3, getUsername was replaced with getUserIdentifier()
+     *
+     * @dataProvider legacyUserInterfaceGetUsernameDataProvider
+     */
+    public function testLegacyUserInterfaceGetUsername(UserClassConfiguration $userClassConfig, string $expectedFilename): void
+    {
+        if (method_exists(User::class, 'getUserIdentifier')) {
+            self::markTestSkipped();
         }
 
-        $this->assertSame(file_get_contents($expectedPath), $manipulator->getSourceCode());
+        $manipulator = $this->getClassSourceManipulator($userClassConfig);
+
+        $classBuilder = new UserClassBuilder();
+        $classBuilder->addUserInterfaceImplementation($manipulator, $userClassConfig);
+
+        $expectedPath = $this->getExpectedPath($expectedFilename, 'legacy_get_username');
+
+        self::assertStringEqualsFile($expectedPath, $manipulator->getSourceCode());
     }
 
-    public function getUserInterfaceTests()
+    public function legacyUserInterfaceGetUsernameDataProvider(): \Generator
     {
-        yield 'entity_email_password' => [
-            new UserClassConfiguration(true, 'email', true),
-            'UserEntityEmailWithPassword.php',
+        yield 'entity_with_get_username' => [
+            new UserClassConfiguration(true, 'username', false),
+            'UserEntityGetUsername.php',
         ];
 
-        yield 'entity_username_password' => [
-            new UserClassConfiguration(true, 'username', true),
-            'UserEntityUsernameWithPassword.php',
+        yield 'model_with_get_username' => [
+            new UserClassConfiguration(false, 'username', false),
+            'UserModelGetUsername.php',
         ];
 
-        yield 'entity_user_name_password' => [
-            new UserClassConfiguration(true, 'user_name', true),
-            'UserEntityUser_nameWithPassword.php',
+        yield 'model_with_email_as_username' => [
+            new UserClassConfiguration(false, 'email', false),
+            'UserModelWithEmailAsUsername.php',
         ];
+    }
 
-        yield 'entity_username_no_password' => [
-            new UserClassConfiguration(true, 'username', false),
-            'UserEntityUsernameNoPassword.php',
+    /**
+     * Covers Symfony <= 5.2 UserInterface::getPassword().
+     *
+     * In Symfony 5.3, getPassword was moved from UserInterface::class to the
+     * new PasswordAuthenticatedUserInterface::class.
+     *
+     * @dataProvider legacyUserInterfaceGetPasswordDataProvider
+     */
+    public function testLegacyUserInterfaceGetPassword(UserClassConfiguration $userClassConfig, string $expectedFilename): void
+    {
+        if (interface_exists(PasswordAuthenticatedUserInterface::class)) {
+            self::markTestSkipped();
+        }
+
+        $manipulator = $this->getClassSourceManipulator($userClassConfig);
+
+        $classBuilder = new UserClassBuilder();
+        $classBuilder->addUserInterfaceImplementation($manipulator, $userClassConfig);
+
+        $expectedPath = $this->getExpectedPath($expectedFilename, 'legacy_get_password');
+
+        self::assertStringEqualsFile($expectedPath, $manipulator->getSourceCode());
+    }
+
+    public function legacyUserInterfaceGetPasswordDataProvider(): \Generator
+    {
+        yield 'entity_with_password' => [
+            new UserClassConfiguration(true, 'username', true),
+            'UserEntityWithPassword.php',
         ];
 
-        yield 'model_email_password' => [
-            new UserClassConfiguration(false, 'email', true),
-            'UserModelEmailWithPassword.php',
+        yield 'entity_without_password' => [
+            new UserClassConfiguration(true, 'username', false),
+            'UserEntityNoPassword.php',
         ];
 
-        yield 'model_username_password' => [
+        yield 'model_with_password' => [
             new UserClassConfiguration(false, 'username', true),
-            'UserModelUsernameWithPassword.php',
+            'UserModelWithPassword.php',
         ];
 
-        yield 'model_username_no_password' => [
+        yield 'model_without_password' => [
             new UserClassConfiguration(false, 'username', false),
-            'UserModelUsernameNoPassword.php',
+            'UserModelNoPassword.php',
         ];
     }
+
+    private function getClassSourceManipulator(UserClassConfiguration $userClassConfiguration): ClassSourceManipulator
+    {
+        $sourceFilename = __DIR__.'/fixtures/source/'.($userClassConfiguration->isEntity() ? 'UserEntity.php' : 'UserModel.php');
+
+        return new ClassSourceManipulator(
+            file_get_contents($sourceFilename),
+            true
+        );
+    }
+
+    private function getExpectedPath(string $expectedFilename, string $subDirectory = null): string
+    {
+        $basePath = __DIR__.'/fixtures/expected';
+
+        $expectedPath = null === $subDirectory ? sprintf('%s/%s', $basePath, $expectedFilename) : sprintf('%s/%s/%s', $basePath, $subDirectory, $expectedFilename);
+
+        if (!file_exists($expectedPath)) {
+            throw new \Exception(sprintf('Expected file missing: "%s"', $expectedPath));
+        }
+
+        return $expectedPath;
+    }
 }

tests/Security/fixtures/expected/UserEntityEmailWithPassword.php → tests/Security/fixtures/expected/UserEntityWithEmailAsIdentifier.php

@@ -56,7 +56,7 @@ public function setEmail(string $email): self
      *
      * @see UserInterface
      */
-    public function getUsername(): string
+    public function getUserIdentifier(): string
     {
         return (string) $this->email;
     }

tests/Security/fixtures/expected/UserEntityUser_nameWithPassword.php → tests/Security/fixtures/expected/UserEntityWithPassword.php

@@ -21,7 +21,7 @@ class User implements UserInterface, PasswordAuthenticatedUserInterface
     /**
      * @ORM\Column(type="string", length=180, unique=true)
      */
-    private $user_name;
+    private $userIdentifier;
 
     /**
      * @ORM\Column(type="json")
@@ -44,14 +44,14 @@ public function getId(): ?int
      *
      * @see UserInterface
      */
-    public function getUsername(): string
+    public function getUserIdentifier(): string
     {
-        return (string) $this->user_name;
+        return (string) $this->userIdentifier;
     }
 
-    public function setUserName(string $user_name): self
+    public function setUserIdentifier(string $userIdentifier): self
     {
-        $this->user_name = $user_name;
+        $this->userIdentifier = $userIdentifier;
 
         return $this;
     }

tests/Security/fixtures/expected/UserEntityUsernameWithPassword.php → tests/Security/fixtures/expected/UserEntityWithUser_IdentifierAsIdentifier.php

@@ -21,7 +21,7 @@ class User implements UserInterface, PasswordAuthenticatedUserInterface
     /**
      * @ORM\Column(type="string", length=180, unique=true)
      */
-    private $username;
+    private $user_identifier;
 
     /**
      * @ORM\Column(type="json")
@@ -44,14 +44,14 @@ public function getId(): ?int
      *
      * @see UserInterface
      */
-    public function getUsername(): string
+    public function getUserIdentifier(): string
     {
-        return (string) $this->username;
+        return (string) $this->user_identifier;
     }
 
-    public function setUsername(string $username): self
+    public function setUserIdentifier(string $user_identifier): self
     {
-        $this->username = $username;
+        $this->user_identifier = $user_identifier;
 
         return $this;
     }