Functional tests

nikophil · nikophil · commit 02ff62431e1d · 2018-09-20T20:37:23.000+02:00
diff --git a/src/Maker/MakeAuthenticator.php b/src/Maker/MakeAuthenticator.php
@@ -106,7 +106,7 @@ public function interact(InputInterface $input, ConsoleStyle $io, Command $comma
             function ($answer) {
                 Validator::notBlank($answer);
 
-                return Validator::validateClassDoesNotExist(
+                return Validator::classDoesNotExist(
                     $this->generator->createClassNameDetails(
                         $answer,
                         'Security\\'
@@ -149,7 +149,12 @@ public function generate(InputInterface $input, ConsoleStyle $io, Generator $gen
             self::AUTH_TYPE_FORM_LOGIN === $input->getArgument('authenticator-type') ?
                 ($this->doctrineHelper->isClassAMappedEntity($input->getArgument('user-class')) ? 'authenticator/LoginFormEntityAuthenticator.tpl.php' : 'authenticator/LoginFormNotEntityAuthenticator.tpl.php')
                 : 'authenticator/Empty.tpl.php',
-            []
+            $input->hasArgument('user-class') ?
+                [
+                    'user_fully_qualified_class_name' => $input->getArgument('user-class'),
+                    'user_class_name' => substr(strrchr($input->getArgument('user-class'), '\\'), 1),
+                ]
+                : []
         );
 
         // update security.yaml with guard config
diff --git a/src/Resources/skeleton/authenticator/LoginFormEntityAuthenticator.tpl.php b/src/Resources/skeleton/authenticator/LoginFormEntityAuthenticator.tpl.php
@@ -2,7 +2,7 @@
 
 namespace <?= $namespace ?>;
 
-use App\Entity\User;
+use <?= $user_fully_qualified_class_name ?>;
 use Doctrine\ORM\EntityManagerInterface;
 use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\HttpFoundation\Request;
@@ -62,7 +62,7 @@ public function getUser($credentials, UserProviderInterface $userProvider)
             throw new InvalidCsrfTokenException();
         }
 
-        return $this->entityManager->getRepository(User::class)->findOneBy(['email' => $credentials['email']]);
+        return $this->entityManager->getRepository(<?= $user_class_name ?>::class)->findOneBy(['email' => $credentials['email']]);
     }
 
     public function checkCredentials($credentials, UserInterface $user)
diff --git a/src/Resources/skeleton/authenticator/LoginFormNotEntityAuthenticator.tpl.php b/src/Resources/skeleton/authenticator/LoginFormNotEntityAuthenticator.tpl.php
@@ -2,7 +2,6 @@
 
 namespace <?= $namespace ?>;
 
-use App\Entity\User;
 use Symfony\Component\HttpFoundation\RedirectResponse;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\Routing\RouterInterface;
diff --git a/src/Resources/skeleton/authenticator/SecurityController.tpl.php b/src/Resources/skeleton/authenticator/SecurityController.tpl.php
@@ -2,7 +2,7 @@
 
 namespace App\Controller;
 
-use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Bundle\FrameworkBundle\Controller\<?= $parent_class_name; ?>;
 use Symfony\Component\Routing\Annotation\Route;
 use Symfony\Component\Security\Http\Authentication\AuthenticationUtils;
 
diff --git a/src/Security/InteractiveSecurityHelper.php b/src/Security/InteractiveSecurityHelper.php
@@ -89,12 +89,8 @@ public static function guessUserClass(SymfonyStyle $io, array $securityData): st
  (It has to be handled by one of the firewall\'s providers)',
                 class_exists('App\\Entity\\User') && isset(class_implements('App\\Entity\\User')[UserInterface::class]) ? 'App\\Entity\\User'
                     : class_exists('App\\Security\\User') && isset(class_implements('App\\Security\\User')[UserInterface::class]) ? 'App\\Security\\User' : null,
-                [Validator::class, 'classExists']
+                [Validator::class, 'classIsUserInterface']
             );
-
-            if (!isset(class_implements($userClass)[UserInterface::class])) {
-                throw new RuntimeCommandException(sprintf('The class "%s" doesn\'t implement "%s"', $userClass, UserInterface::class));
-            }
         }
 
         return $userClass;
diff --git a/src/Validator.php b/src/Validator.php
@@ -13,6 +13,7 @@
 
 use Doctrine\Common\Persistence\ManagerRegistry;
 use Symfony\Bundle\MakerBundle\Exception\RuntimeCommandException;
+use Symfony\Component\Security\Core\User\UserInterface;
 
 /**
  * @author Javier Eguiluz <javier.eguiluz@gmail.com>
@@ -185,7 +186,7 @@ public static function entityExists(string $className = null, array $entities =
         return $className;
     }
 
-    public static function validateClassDoesNotExist($className)
+    public static function classDoesNotExist($className)
     {
         self::notBlank($className);
 
@@ -195,4 +196,15 @@ public static function validateClassDoesNotExist($className)
 
         return $className;
     }
+
+    public static function classIsUserInterface($userClassName)
+    {
+        self::classExists($userClassName);
+
+        if (!isset(class_implements($userClassName)[UserInterface::class])) {
+            throw new RuntimeCommandException(sprintf('The class "%s" doesn\'t implement "%s"', $userClassName, UserInterface::class));
+        }
+
+        return $userClassName;
+    }
 }
diff --git a/tests/Maker/FunctionalTest.php b/tests/Maker/FunctionalTest.php
@@ -396,7 +396,7 @@ function (string $output, string $directory) {
                 ),
         ];
 
-        yield 'auth_login_form' => [
+        yield 'auth_login_form_user_entity' => [
             MakerTestDetails::createTest(
                 $this->getMakerInstance(MakeAuthenticator::class),
                 [
@@ -410,7 +410,62 @@ function (string $output, string $directory) {
             )
                 ->addExtraDependencies('doctrine')
                 ->addExtraDependencies('security')
-                ->setFixtureFilesPath(__DIR__.'/../fixtures/MakeAuthenticatorLoginForm'),
+                ->setFixtureFilesPath(__DIR__.'/../fixtures/MakeAuthenticatorLoginFormUserEntity')
+                ->assert(
+                    function (string $output, string $directory) {
+                        $this->assertContains('Success', $output);
+
+                        $fs = new Filesystem();
+                        $this->assertTrue($fs->exists(sprintf('%s/src/Controller/SecurityController.php', $directory)));
+                        $this->assertTrue($fs->exists(sprintf('%s/templates/security/login.html.twig', $directory)));
+                        $this->assertTrue($fs->exists(sprintf('%s/src/Security/AppCustomAuthenticator.php', $directory)));
+                    }
+                ),
+        ];
+
+        yield 'auth_login_form_user_not_entity' => [
+            MakerTestDetails::createTest(
+                $this->getMakerInstance(MakeAuthenticator::class),
+                [
+                    // authenticator type => login-form
+                    1,
+                    // class name
+                    'AppCustomAuthenticator',
+                    // controller name
+                    'SecurityController',
+                    // user class
+                    'App\Security\User'
+                ]
+            )
+                ->addExtraDependencies('security')
+                ->setFixtureFilesPath(__DIR__.'/../fixtures/MakeAuthenticatorLoginFormUserNotEntity')
+                ->assert(
+                    function (string $output) {
+                        $this->assertContains('Success', $output);
+                    }
+                ),
+        ];
+
+        yield 'auth_login_form_existing_controller' => [
+            MakerTestDetails::createTest(
+                $this->getMakerInstance(MakeAuthenticator::class),
+                [
+                    // authenticator type => login-form
+                    1,
+                    // class name
+                    'AppCustomAuthenticator',
+                    // controller name
+                    'SecurityController'
+                ]
+            )
+                ->addExtraDependencies('doctrine')
+                ->addExtraDependencies('security')
+                ->setFixtureFilesPath(__DIR__.'/../fixtures/MakeAuthenticatorLoginFormExistingController')
+                ->assert(
+                    function (string $output) {
+                        $this->assertContains('Success', $output);
+                    }
+                ),
         ];
 
         yield 'user_security_entity_with_password' => [MakerTestDetails::createTest(
diff --git a/tests/fixtures/MakeAuthenticatorLoginFormExistingController/config/packages/security.yaml b/tests/fixtures/MakeAuthenticatorLoginFormExistingController/config/packages/security.yaml
diff --git a/tests/fixtures/MakeAuthenticatorLoginFormExistingController/src/Controller/SecurityController.php b/tests/fixtures/MakeAuthenticatorLoginFormExistingController/src/Controller/SecurityController.php
@@ -0,0 +1,9 @@
+<?php
+
+namespace App\Controller;
+
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+
+class SecurityController extends AbstractController
+{
+}
diff --git a/tests/fixtures/MakeAuthenticatorLoginFormExistingController/src/Entity/User.php b/tests/fixtures/MakeAuthenticatorLoginFormExistingController/src/Entity/User.php
@@ -6,7 +6,7 @@
 use Symfony\Component\Security\Core\User\UserInterface;
 
 /**
- * @ORM\Entity(repositoryClass="App\Repository\UserRepository")
+ * @ORM\Entity()
  */
 class User implements UserInterface
 {
diff --git a/tests/fixtures/MakeAuthenticatorLoginFormUserEntity/config/packages/security.yaml b/tests/fixtures/MakeAuthenticatorLoginFormUserEntity/config/packages/security.yaml
@@ -0,0 +1,32 @@
+security:
+    encoders:
+        App\Security\User:
+            algorithm: argon2i
+
+    # https://symfony.com/doc/current/security.html#where-do-users-come-from-user-providers
+    providers:
+        app_user_provider:
+            entity:
+                class: App\Entity\User
+                property: email
+
+    firewalls:
+        dev:
+            pattern: ^/(_(profiler|wdt)|css|images|js)/
+            security: false
+        main:
+            anonymous: true
+
+            # activate different ways to authenticate
+
+            # http_basic: true
+            # https://symfony.com/doc/current/security.html#a-configuring-how-your-users-will-authenticate
+
+            # form_login: true
+            # https://symfony.com/doc/current/security/form_login_setup.html
+
+    # Easy way to control access for large sections of your site
+    # Note: Only the *first* access control that matches will be used
+    access_control:
+    # - { path: ^/admin, roles: ROLE_ADMIN }
+    # - { path: ^/profile, roles: ROLE_USER }
diff --git a/tests/fixtures/MakeAuthenticatorLoginFormUserEntity/src/Entity/User.php b/tests/fixtures/MakeAuthenticatorLoginFormUserEntity/src/Entity/User.php
@@ -0,0 +1,113 @@
+<?php
+
+namespace App\Entity;
+
+use Doctrine\ORM\Mapping as ORM;
+use Symfony\Component\Security\Core\User\UserInterface;
+
+/**
+ * @ORM\Entity()
+ */
+class User implements UserInterface
+{
+    /**
+     * @ORM\Id()
+     * @ORM\GeneratedValue()
+     * @ORM\Column(type="integer")
+     */
+    private $id;
+
+    /**
+     * @ORM\Column(type="string", length=180, unique=true)
+     */
+    private $email;
+
+    /**
+     * @ORM\Column(type="json")
+     */
+    private $roles = [];
+
+    /**
+     * @var string The hashed password
+     * @ORM\Column(type="string")
+     */
+    private $password;
+
+    public function getId()
+    {
+        return $this->id;
+    }
+
+    public function getEmail()
+    {
+        return $this->email;
+    }
+
+    public function setEmail(string $email): self
+    {
+        $this->email = $email;
+
+        return $this;
+    }
+
+    /**
+     * A visual identifier that represents this user.
+     *
+     * @see UserInterface
+     */
+    public function getUsername(): string
+    {
+        return (string) $this->email;
+    }
+
+    /**
+     * @see UserInterface
+     */
+    public function getRoles(): array
+    {
+        $roles = $this->roles;
+        // guarantee every user at least has ROLE_USER
+        $roles[] = 'ROLE_USER';
+
+        return array_unique($roles);
+    }
+
+    public function setRoles(array $roles): self
+    {
+        $this->roles = $roles;
+
+        return $this;
+    }
+
+    /**
+     * @see UserInterface
+     */
+    public function getPassword(): string
+    {
+        return (string) $this->password;
+    }
+
+    public function setPassword(string $password): self
+    {
+        $this->password = $password;
+
+        return $this;
+    }
+
+    /**
+     * @see UserInterface
+     */
+    public function getSalt()
+    {
+        // not needed when using the "bcrypt" algorithm in security.yaml
+    }
+
+    /**
+     * @see UserInterface
+     */
+    public function eraseCredentials()
+    {
+        // If you store any temporary, sensitive data on the user, clear it here
+        // $this->plainPassword = null;
+    }
+}
diff --git a/tests/fixtures/MakeAuthenticatorLoginFormUserNotEntity/config/packages/security.yaml b/tests/fixtures/MakeAuthenticatorLoginFormUserNotEntity/config/packages/security.yaml
@@ -0,0 +1,30 @@
+security:
+    encoders:
+        App\Security\User:
+            algorithm: argon2i
+
+    # https://symfony.com/doc/current/security.html#where-do-users-come-from-user-providers
+    providers:
+        app_user_provider:
+            id: App\Security\UserProvider
+
+    firewalls:
+        dev:
+            pattern: ^/(_(profiler|wdt)|css|images|js)/
+            security: false
+        main:
+            anonymous: true
+
+            # activate different ways to authenticate
+
+            # http_basic: true
+            # https://symfony.com/doc/current/security.html#a-configuring-how-your-users-will-authenticate
+
+            # form_login: true
+            # https://symfony.com/doc/current/security/form_login_setup.html
+
+    # Easy way to control access for large sections of your site
+    # Note: Only the *first* access control that matches will be used
+    access_control:
+    # - { path: ^/admin, roles: ROLE_ADMIN }
+    # - { path: ^/profile, roles: ROLE_USER }
diff --git a/tests/fixtures/MakeAuthenticatorLoginFormUserNotEntity/src/Security/User.php b/tests/fixtures/MakeAuthenticatorLoginFormUserNotEntity/src/Security/User.php
diff --git a/tests/fixtures/MakeAuthenticatorLoginFormUserNotEntity/src/Security/UserProvider.php b/tests/fixtures/MakeAuthenticatorLoginFormUserNotEntity/src/Security/UserProvider.php

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,7 @@`
`2`	`2`
`3`	`3`	`namespace <?= $namespace ?>;`
`4`	`4`
`5`		`-use App\Entity\User;`
	`5`	`+use <?= $user_fully_qualified_class_name ?>;`
`6`	`6`	`use Doctrine\ORM\EntityManagerInterface;`
`7`	`7`	`use Symfony\Component\HttpFoundation\RedirectResponse;`
`8`	`8`	`use Symfony\Component\HttpFoundation\Request;`
`@@ -62,7 +62,7 @@ public function getUser($credentials, UserProviderInterface $userProvider)`
`62`	`62`	`throw new InvalidCsrfTokenException();`
`63`	`63`	`}`
`64`	`64`
`65`		`- return $this->entityManager->getRepository(User::class)->findOneBy(['email' => $credentials['email']]);`
	`65`	`+ return $this->entityManager->getRepository(<?= $user_class_name ?>::class)->findOneBy(['email' => $credentials['email']]);`
`66`	`66`	`}`
`67`	`67`
`68`	`68`	`public function checkCredentials($credentials, UserInterface $user)`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`use Symfony\Component\Security\Core\User\UserInterface;`
`7`	`7`
`8`	`8`	`/**`
`9`		`- * @ORM\Entity(repositoryClass="App\Repository\UserRepository")`
	`9`	`+ * @ORM\Entity()`
`10`	`10`	`*/`
`11`	`11`	`class User implements UserInterface`
`12`	`12`	`{`