unit tests

Author: nikophil

src/Security/SecurityControllerBuilder.php

@@ -63,5 +63,6 @@ public function addLogoutMethod(ClassSourceManipulator $manipulator)
 CODE
         );
         $manipulator->addMethodBuilder($loginMethodBuilder);
+        $manipulator->addUseStatementIfNecessary('Symfony\\Component\\Routing\\Annotation\\Route');
     }
 }

tests/Security/InteractiveSecurityHelperTest.php

@@ -120,4 +120,37 @@ public function getEntryPointTests()
             'main',
         ];
     }
+
+    /**
+     * @dataProvider getUserClassTests
+     */
+    public function testGuessUserClass(array $securityData, string $expectedUserClass, bool $userClassAutomaticallyGuessed)
+    {
+        /** @var SymfonyStyle|\PHPUnit_Framework_MockObject_MockObject $io */
+        $io = $this->createMock(SymfonyStyle::class);
+        $io->expects($this->exactly(true === $userClassAutomaticallyGuessed ? 0 : 1))
+            ->method('ask')
+            ->willReturn($expectedUserClass);
+
+        $helper = new InteractiveSecurityHelper();
+        $this->assertEquals(
+            $expectedUserClass,
+            $helper->guessUserClass($io, $securityData)
+        );
+    }
+
+    public function getUserClassTests()
+    {
+        yield 'user_from_provider' => [
+            ['security' => ['providers' => ['app_provider' => ['entity' => ['class' => 'App\\Entity\\User']]]]],
+            'App\\Entity\\User',
+            true,
+        ];
+
+        yield 'user_asked_user' => [
+            ['security' => ['providers' => []]],
+            'App\\Entity\\User',
+            false,
+        ];
+    }
 }

tests/Security/SecurityControllerBuilderTest.php

@@ -0,0 +1,35 @@
+<?php
+
+namespace Symfony\Bundle\MakerBundle\Tests\Security;
+
+use PHPUnit\Framework\TestCase;
+use Symfony\Bundle\MakerBundle\Security\SecurityControllerBuilder;
+use Symfony\Bundle\MakerBundle\Util\ClassSourceManipulator;
+
+class SecurityControllerBuilderTest extends TestCase
+{
+    public function testAddLoginMethod()
+    {
+        $source         = file_get_contents(__DIR__.'/fixtures/source/SecurityController.php');
+        $expectedSource = file_get_contents(__DIR__.'/fixtures/expected/SecurityController_login.php');
+
+        $manipulator = new ClassSourceManipulator($source);
+
+        $securityControllerBuilder = new SecurityControllerBuilder();
+        $securityControllerBuilder->addLoginMethod($manipulator);
+
+        $this->assertSame($expectedSource, $manipulator->getSourceCode());
+    }
+    public function testAddLogoutMethod()
+    {
+        $source         = file_get_contents(__DIR__.'/fixtures/source/SecurityController.php');
+        $expectedSource = file_get_contents(__DIR__.'/fixtures/expected/SecurityController_logout.php');
+
+        $manipulator = new ClassSourceManipulator($source);
+
+        $securityControllerBuilder = new SecurityControllerBuilder();
+        $securityControllerBuilder->addLogoutMethod($manipulator);
+
+        $this->assertSame($expectedSource, $manipulator->getSourceCode());
+    }
+}

tests/Security/fixtures/expected/SecurityController_login.php

@@ -0,0 +1,24 @@
+<?php
+
+namespace App\Controller;
+
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Routing\Annotation\Route;
+use Symfony\Component\Security\Http\Authentication\AuthenticationUtils;
+
+class SecurityController extends AbstractController
+{
+    /**
+     * @Route("/login", name="app_login")
+     */
+    public function login(AuthenticationUtils $authenticationUtils): Response
+    {
+        // get the login error if there is one
+        $error = $authenticationUtils->getLastAuthenticationError();
+        // last username entered by the user
+        $lastUsername = $authenticationUtils->getLastUsername();
+
+        return $this->render('security/login.html.twig', ['last_username' => $lastUsername, 'error' => $error]);
+    }
+}

tests/Security/fixtures/expected/SecurityController_logout.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace App\Controller;
+
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+use Symfony\Component\Routing\Annotation\Route;
+
+class SecurityController extends AbstractController
+{
+    /**
+     * @Route("/logout", name="app_logout")
+     */
+    public function logout()
+    {
+        throw new \Exception('will be intercepted before getting here');
+    }
+}

tests/Security/fixtures/source/SecurityController.php

@@ -0,0 +1,9 @@
+<?php
+
+namespace App\Controller;
+
+use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
+
+class SecurityController extends AbstractController
+{
+}

tests/Util/ClassSourceManipulatorTest.php

@@ -542,4 +542,27 @@ public function testAddInterface()
 
         $this->assertSame($expectedSource, $manipulator->getSourceCode());
     }
+
+    public function testAddMethodWithBody()
+    {
+        $source = file_get_contents(__DIR__.'/fixtures/source/EmptyController.php');
+        $expectedSource = file_get_contents(__DIR__.'/fixtures/add_method/Controller_with_action.php');
+
+        $manipulator = new ClassSourceManipulator($source);
+
+        $methodBuilder = $manipulator->createMethodBuilder('action', 'JsonResponse', false, ['@Route("/action", name="app_action")']);
+        $methodBuilder->addParam(
+            (new \PhpParser\Builder\Param('param'))->setTypeHint('string')
+        );
+        $manipulator->addMethodBody($methodBuilder, <<<'CODE'
+<?php
+return new JsonResponse(['param' => $param]);
+CODE
+        );
+        $manipulator->addMethodBuilder($methodBuilder);
+        $manipulator->addUseStatementIfNecessary('Symfony\\Component\\HttpFoundation\\JsonResponse');
+        $manipulator->addUseStatementIfNecessary('Symfony\\Component\\Routing\\Annotation\\Route');
+
+        $this->assertSame($expectedSource, $manipulator->getSourceCode());
+    }
 }

tests/Util/fixtures/add_method/Controller_with_action.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace App\Controller;
+
+use Symfony\Component\HttpFoundation\JsonResponse;
+use Symfony\Component\Routing\Annotation\Route;
+
+class EmptyController
+{
+    /**
+     * @Route("/action", name="app_action")
+     */
+    public function action(string $param): JsonResponse
+    {
+        return new JsonResponse(['param' => $param]);
+    }
+}

tests/Util/fixtures/source/EmptyController.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace App\Controller;
+
+class EmptyController
+{
+}

tests/fixtures/MakeAuthenticatorLoginFormExistingController/config/packages/security.yaml

@@ -1,7 +1,7 @@
 security:
     encoders:
         App\Security\User:
-            algorithm: argon2i
+            algorithm: bcrypt
 
     # https://symfony.com/doc/current/security.html#where-do-users-come-from-user-providers
     providers: