Added Symfony 5.3 support (#133)

TavoNiievez · web-flow · commit 3ee80157fac4 · 2021-05-31T20:33:59.000-05:00
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -9,7 +9,7 @@ jobs:
     strategy:
       matrix:
         php: [7.3, 7.4, 8.0]
-        symfony: [4.4, 5.2]
+        symfony: [4.4, 5.3]
 
     steps:
       - name: Checkout code
@@ -31,8 +31,8 @@ jobs:
           path: framework-tests
           ref: 4.4
 
-      - name: Checkout Symfony 5.2 Sample
-        if: matrix.symfony == 5.2
+      - name: Checkout Symfony 5.3 Sample
+        if: matrix.symfony == 5.3
         uses: actions/checkout@v2
         with:
           repository: Codeception/symfony-module-tests
diff --git a/src/Codeception/Module/Symfony/SecurityAssertionsTrait.php b/src/Codeception/Module/Symfony/SecurityAssertionsTrait.php
@@ -4,6 +4,7 @@
 
 namespace Codeception\Module\Symfony;
 
+use Symfony\Component\PasswordHasher\Hasher\UserPasswordHasherInterface;
 use Symfony\Component\Security\Core\Authorization\Voter\AuthenticatedVoter;
 use Symfony\Component\Security\Core\Encoder\UserPasswordEncoderInterface;
 use Symfony\Component\Security\Core\Security;
@@ -64,9 +65,7 @@ public function seeAuthentication(): void
     {
         $security = $this->grabSecurityService();
 
-        $user = $security->getUser();
-
-        if ($user === null) {
+        if (!$user = $security->getUser()) {
             $this->fail('There is no user in session');
         }
 
@@ -88,9 +87,7 @@ public function seeRememberedAuthentication(): void
     {
         $security = $this->grabSecurityService();
 
-        $user = $security->getUser();
-
-        if ($user === null) {
+        if ($security->getUser() === null) {
             $this->fail('There is no user in session');
         }
 
@@ -118,17 +115,19 @@ public function seeUserHasRole(string $role): void
     {
         $security = $this->grabSecurityService();
 
-        $user = $security->getUser();
-
-        if ($user === null) {
+        if (!$user = $security->getUser()) {
             $this->fail('There is no user in session');
         }
 
+        $userIdentifier = method_exists($user, 'getUserIdentifier') ?
+            $user->getUserIdentifier() :
+            $user->getUsername();
+
         $this->assertTrue(
             $security->isGranted($role),
             sprintf(
                 'User %s has no role %s',
-                $user->getUsername(),
+                $userIdentifier,
                 $role
             )
         );
@@ -169,8 +168,7 @@ public function seeUserPasswordDoesNotNeedRehash(UserInterface $user = null): vo
     {
         if ($user === null) {
             $security = $this->grabSecurityService();
-            $user = $security->getUser();
-            if ($user === null) {
+            if (!$user = $security->getUser()) {
                 $this->fail('No user found to validate');
             }
         }
@@ -184,8 +182,17 @@ protected function grabSecurityService(): Security
         return $this->grabService('security.helper');
     }
 
-    protected function grabPasswordHasherService(): UserPasswordEncoderInterface
+    /**
+     * @return UserPasswordHasherInterface|UserPasswordEncoderInterface
+     */
+    protected function grabPasswordHasherService()
     {
-        return $this->grabService('security.user_password_encoder.generic');
+        $hasher = $this->getService('security.password_hasher') ?: $this->getService('security.password_encoder');
+
+        if ($hasher === null) {
+            $this->fail('Password hasher service could not be found.');
+        }
+
+        return $hasher;
     }
 }
diff --git a/src/Codeception/Module/Symfony/SessionAssertionsTrait.php b/src/Codeception/Module/Symfony/SessionAssertionsTrait.php
@@ -34,7 +34,7 @@ trait SessionAssertionsTrait
      */
     public function amLoggedInAs(UserInterface $user, string $firewallName = 'main', $firewallContext = null): void
     {
-        $session = $this->grabSessionService();
+        $session = $this->getCurrentSession();
 
         if ($this->config['guard']) {
             $token = new PostAuthenticationGuardToken($user, $firewallName, $user->getRoles());
@@ -68,7 +68,7 @@ public function amLoggedInAs(UserInterface $user, string $firewallName = 'main',
      */
     public function dontSeeInSession(string $attribute, $value = null): void
     {
-        $session = $this->grabSessionService();
+        $session = $this->getCurrentSession();
 
         if (null === $value) {
             if ($session->has($attribute)) {
@@ -94,7 +94,7 @@ public function logout(): void
             $tokenStorage->setToken();
         }
 
-        $session = $this->grabSessionService();
+        $session = $this->getCurrentSession();
 
         $sessionName = $session->getName();
         $session->invalidate();
@@ -126,7 +126,7 @@ public function logout(): void
      */
     public function seeInSession(string $attribute, $value = null): void
     {
-        $session = $this->grabSessionService();
+        $session = $this->getCurrentSession();
 
         if (!$session->has($attribute)) {
             $this->fail("No session attribute with name '{$attribute}'");
@@ -164,7 +164,7 @@ protected function getTokenStorage(): ?TokenStorageInterface
         return $this->getService('security.token_storage');
     }
 
-    protected function grabSessionService(): SessionInterface
+    protected function getCurrentSession(): SessionInterface
     {
         return $this->grabService('session');
     }

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,7 @@`
`4`	`4`
`5`	`5`	`namespace Codeception\Module\Symfony;`
`6`	`6`
	`7`	`+use Symfony\Component\PasswordHasher\Hasher\UserPasswordHasherInterface;`
`7`	`8`	`use Symfony\Component\Security\Core\Authorization\Voter\AuthenticatedVoter;`
`8`	`9`	`use Symfony\Component\Security\Core\Encoder\UserPasswordEncoderInterface;`
`9`	`10`	`use Symfony\Component\Security\Core\Security;`
`@@ -64,9 +65,7 @@ public function seeAuthentication(): void`
`64`	`65`	`{`
`65`	`66`	`$security = $this->grabSecurityService();`
`66`	`67`
`67`		`- $user = $security->getUser();`
`68`		`-`
`69`		`- if ($user === null) {`
	`68`	`+ if (!$user = $security->getUser()) {`
`70`	`69`	`$this->fail('There is no user in session');`
`71`	`70`	`}`
`72`	`71`
`@@ -88,9 +87,7 @@ public function seeRememberedAuthentication(): void`
`88`	`87`	`{`
`89`	`88`	`$security = $this->grabSecurityService();`
`90`	`89`
`91`		`- $user = $security->getUser();`
`92`		`-`
`93`		`- if ($user === null) {`
	`90`	`+ if ($security->getUser() === null) {`
`94`	`91`	`$this->fail('There is no user in session');`
`95`	`92`	`}`
`96`	`93`
`@@ -118,17 +115,19 @@ public function seeUserHasRole(string $role): void`
`118`	`115`	`{`
`119`	`116`	`$security = $this->grabSecurityService();`
`120`	`117`
`121`		`- $user = $security->getUser();`
`122`		`-`
`123`		`- if ($user === null) {`
	`118`	`+ if (!$user = $security->getUser()) {`
`124`	`119`	`$this->fail('There is no user in session');`
`125`	`120`	`}`
`126`	`121`
	`122`	`+ $userIdentifier = method_exists($user, 'getUserIdentifier') ?`
	`123`	`+ $user->getUserIdentifier() :`
	`124`	`+ $user->getUsername();`
	`125`	`+`
`127`	`126`	`$this->assertTrue(`
`128`	`127`	`$security->isGranted($role),`
`129`	`128`	`sprintf(`
`130`	`129`	`'User %s has no role %s',`
`131`		`- $user->getUsername(),`
	`130`	`+ $userIdentifier,`
`132`	`131`	`$role`
`133`	`132`	`)`
`134`	`133`	`);`
`@@ -169,8 +168,7 @@ public function seeUserPasswordDoesNotNeedRehash(UserInterface $user = null): vo`
`169`	`168`	`{`
`170`	`169`	`if ($user === null) {`
`171`	`170`	`$security = $this->grabSecurityService();`
`172`		`- $user = $security->getUser();`
`173`		`- if ($user === null) {`
	`171`	`+ if (!$user = $security->getUser()) {`
`174`	`172`	`$this->fail('No user found to validate');`
`175`	`173`	`}`
`176`	`174`	`}`
`@@ -184,8 +182,17 @@ protected function grabSecurityService(): Security`
`184`	`182`	`return $this->grabService('security.helper');`
`185`	`183`	`}`
`186`	`184`
`187`		`- protected function grabPasswordHasherService(): UserPasswordEncoderInterface`
	`185`	`+ /**`
	`186`	`+ * @return UserPasswordHasherInterface\|UserPasswordEncoderInterface`
	`187`	`+ */`
	`188`	`+ protected function grabPasswordHasherService()`
`188`	`189`	`{`
`189`		`- return $this->grabService('security.user_password_encoder.generic');`
	`190`	`+ $hasher = $this->getService('security.password_hasher') ?: $this->getService('security.password_encoder');`
	`191`	`+`
	`192`	`+ if ($hasher === null) {`
	`193`	`+ $this->fail('Password hasher service could not be found.');`
	`194`	`+ }`
	`195`	`+`
	`196`	`+ return $hasher;`
`190`	`197`	`}`
`191`	`198`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ trait SessionAssertionsTrait`
`34`	`34`	`*/`
`35`	`35`	`public function amLoggedInAs(UserInterface $user, string $firewallName = 'main', $firewallContext = null): void`
`36`	`36`	`{`
`37`		`- $session = $this->grabSessionService();`
	`37`	`+ $session = $this->getCurrentSession();`
`38`	`38`
`39`	`39`	`if ($this->config['guard']) {`
`40`	`40`	`$token = new PostAuthenticationGuardToken($user, $firewallName, $user->getRoles());`
`@@ -68,7 +68,7 @@ public function amLoggedInAs(UserInterface $user, string $firewallName = 'main',`
`68`	`68`	`*/`
`69`	`69`	`public function dontSeeInSession(string $attribute, $value = null): void`
`70`	`70`	`{`
`71`		`- $session = $this->grabSessionService();`
	`71`	`+ $session = $this->getCurrentSession();`
`72`	`72`
`73`	`73`	`if (null === $value) {`
`74`	`74`	`if ($session->has($attribute)) {`
`@@ -94,7 +94,7 @@ public function logout(): void`
`94`	`94`	`$tokenStorage->setToken();`
`95`	`95`	`}`
`96`	`96`
`97`		`- $session = $this->grabSessionService();`
	`97`	`+ $session = $this->getCurrentSession();`
`98`	`98`
`99`	`99`	`$sessionName = $session->getName();`
`100`	`100`	`$session->invalidate();`
`@@ -126,7 +126,7 @@ public function logout(): void`
`126`	`126`	`*/`
`127`	`127`	`public function seeInSession(string $attribute, $value = null): void`
`128`	`128`	`{`
`129`		`- $session = $this->grabSessionService();`
	`129`	`+ $session = $this->getCurrentSession();`
`130`	`130`
`131`	`131`	`if (!$session->has($attribute)) {`
`132`	`132`	`$this->fail("No session attribute with name '{$attribute}'");`
`@@ -164,7 +164,7 @@ protected function getTokenStorage(): ?TokenStorageInterface`
`164`	`164`	`return $this->getService('security.token_storage');`
`165`	`165`	`}`
`166`	`166`
`167`		`- protected function grabSessionService(): SessionInterface`
	`167`	`+ protected function getCurrentSession(): SessionInterface`
`168`	`168`	`{`
`169`	`169`	`return $this->grabService('session');`
`170`	`170`	`}`