test: add/update SecurityConfigUpdaterTest

Author: bechir

src/Security/SecurityConfigUpdater.php

@@ -114,14 +114,15 @@ public function updateForAuthenticator(string $yamlSource, string $firewallName,
 
         if ($supportRememberMe) {
             if (!isset($firewall['remember_me'])) {
+                $firewall['remember_me_empty_line'] = $this->manipulator->createEmptyLine();
                 $firewall['remember_me'] = [
                     'secret' => '%kernel.secret%',
                     'lifetime' => 604800,
                     'path' => '/',
                 ];
                 if (!$alwaysRememberMe) {
                     $firewall['remember_me'][] = $this->manipulator->createCommentLine(' by default, the feature is enabled by checking a checkbox in the');
-                    $firewall['remember_me'][] = $this->manipulator->createCommentLine(' login form (see below), uncomment the following line to always enable it.');
+                    $firewall['remember_me'][] = $this->manipulator->createCommentLine(' login form, uncomment the following line to always enable it.');
                 }
             } else {
                 $firewall['remember_me']['secret'] ??= '%kernel.secret%';

tests/Security/SecurityConfigUpdaterTest.php

@@ -110,13 +110,13 @@ public function getUserClassTests(): \Generator
     /**
      * @dataProvider getAuthenticatorTests
      */
-    public function testUpdateForAuthenticator(string $firewallName, $entryPoint, string $expectedSourceFilename, string $startingSourceFilename, bool $logoutSetup): void
+    public function testUpdateForAuthenticator(string $firewallName, $entryPoint, string $expectedSourceFilename, string $startingSourceFilename, bool $logoutSetup, bool $supportRememberMe, bool $alwaysRememberMe): void
     {
         $this->createLogger();
 
         $updater = new SecurityConfigUpdater($this->ysmLogger);
         $source = file_get_contents(__DIR__.'/yaml_fixtures/source/'.$startingSourceFilename);
-        $actualSource = $updater->updateForAuthenticator($source, $firewallName, $entryPoint, 'App\\Security\\AppCustomAuthenticator', $logoutSetup);
+        $actualSource = $updater->updateForAuthenticator($source, $firewallName, $entryPoint, 'App\\Security\\AppCustomAuthenticator', $logoutSetup, $supportRememberMe, $alwaysRememberMe);
         $expectedSource = file_get_contents(__DIR__.'/yaml_fixtures/expected_authenticator/'.$expectedSourceFilename);
 
         $this->assertSame($expectedSource, $actualSource);
@@ -130,6 +130,8 @@ public function getAuthenticatorTests(): \Generator
             'empty_source.yaml',
             'empty_security.yaml',
             false,
+            false,
+            false,
         ];
 
         yield 'simple_security' => [
@@ -138,6 +140,8 @@ public function getAuthenticatorTests(): \Generator
             'simple_security_source.yaml',
             'simple_security.yaml',
             false,
+            false,
+            false,
         ];
 
         yield 'simple_security_with_firewalls' => [
@@ -146,6 +150,8 @@ public function getAuthenticatorTests(): \Generator
             'simple_security_with_firewalls.yaml',
             'simple_security_with_firewalls.yaml',
             false,
+            false,
+            false,
         ];
 
         yield 'simple_security_with_firewalls_and_authenticator' => [
@@ -154,6 +160,8 @@ public function getAuthenticatorTests(): \Generator
             'simple_security_with_firewalls_and_authenticator.yaml',
             'simple_security_with_firewalls_and_authenticator.yaml',
             false,
+            false,
+            false,
         ];
 
         yield 'simple_security_with_firewalls_and_logout' => [
@@ -162,6 +170,8 @@ public function getAuthenticatorTests(): \Generator
             'simple_security_with_firewalls_and_logout.yaml',
             'simple_security_with_firewalls_and_logout.yaml',
             true,
+            false,
+            false,
         ];
 
         yield 'security_52_with_multiple_authenticators' => [
@@ -170,6 +180,28 @@ public function getAuthenticatorTests(): \Generator
             'multiple_authenticators.yaml',
             'multiple_authenticators.yaml',
             false,
+            false,
+            false,
+        ];
+
+        yield 'simple_security_with_firewalls_and_remember_me_checkbox' => [
+            'main',
+            null,
+            'simple_security_with_firewalls_and_remember_me_checkbox.yaml',
+            'simple_security.yaml',
+            false,
+            true,
+            false,
+        ];
+
+        yield 'simple_security_with_firewalls_and_always_remember_me' => [
+            'main',
+            null,
+            'simple_security_with_firewalls_and_always_remember_me.yaml',
+            'simple_security.yaml',
+            false,
+            true,
+            true,
         ];
     }
 

tests/Security/yaml_fixtures/expected_authenticator/simple_security_with_firewalls_and_always_remember_me.yaml

@@ -0,0 +1,18 @@
+security:
+    enable_authenticator_manager: true
+
+    # https://symfony.com/doc/current/security.html#where-do-users-come-from-user-providers
+    providers:
+        in_memory: { memory: ~ }
+
+    firewalls:
+        dev: ~
+        main:
+            lazy: true
+            custom_authenticator: App\Security\AppCustomAuthenticator
+
+            remember_me:
+                secret: '%kernel.secret%'
+                lifetime: 604800
+                path: /
+                always_remember_me: true

tests/Security/yaml_fixtures/expected_authenticator/simple_security_with_firewalls_and_remember_me_checkbox.yaml

@@ -0,0 +1,20 @@
+security:
+    enable_authenticator_manager: true
+
+    # https://symfony.com/doc/current/security.html#where-do-users-come-from-user-providers
+    providers:
+        in_memory: { memory: ~ }
+
+    firewalls:
+        dev: ~
+        main:
+            lazy: true
+            custom_authenticator: App\Security\AppCustomAuthenticator
+
+            remember_me:
+                secret: '%kernel.secret%'
+                lifetime: 604800
+                path: /
+                # by default, the feature is enabled by checking a checkbox in the
+                # login form, uncomment the following line to always enable it.
+                #always_remember_me: true