[Tests] Migrate tests to static data providers

Author: alexandre-daubois

Tests/EventListener/PasswordMigratingListenerTest.php

@@ -15,20 +15,20 @@
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\PasswordHasher\Hasher\PasswordHasherFactoryInterface;
 use Symfony\Component\PasswordHasher\PasswordHasherInterface;
-use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
 use Symfony\Component\Security\Core\User\InMemoryUser;
 use Symfony\Component\Security\Core\User\PasswordAuthenticatedUserInterface;
 use Symfony\Component\Security\Core\User\PasswordUpgraderInterface;
 use Symfony\Component\Security\Core\User\UserInterface;
 use Symfony\Component\Security\Core\User\UserProviderInterface;
-use Symfony\Component\Security\Http\Authenticator\AuthenticatorInterface;
 use Symfony\Component\Security\Http\Authenticator\Passport\Badge\PasswordUpgradeBadge;
 use Symfony\Component\Security\Http\Authenticator\Passport\Badge\UserBadge;
 use Symfony\Component\Security\Http\Authenticator\Passport\PassportInterface;
 use Symfony\Component\Security\Http\Authenticator\Passport\SelfValidatingPassport;
 use Symfony\Component\Security\Http\Authenticator\Passport\UserPassportInterface;
 use Symfony\Component\Security\Http\Event\LoginSuccessEvent;
 use Symfony\Component\Security\Http\EventListener\PasswordMigratingListener;
+use Symfony\Component\Security\Http\Tests\Fixtures\DummyAuthenticator;
+use Symfony\Component\Security\Http\Tests\Fixtures\DummyToken;
 
 class PasswordMigratingListenerTest extends TestCase
 {
@@ -58,13 +58,13 @@ public function testUnsupportedEvents($event)
         $this->listener->onLoginSuccess($event);
     }
 
-    public function provideUnsupportedEvents()
+    public static function provideUnsupportedEvents()
     {
         // no password upgrade badge
-        yield [$this->createEvent(new SelfValidatingPassport(new UserBadge('test', function () { return $this->createMock(UserInterface::class); })))];
+        yield [self::createEvent(new SelfValidatingPassport(new UserBadge('test', function () { return $this->createMock(UserInterface::class); })))];
 
         // blank password
-        yield [$this->createEvent(new SelfValidatingPassport(new UserBadge('test', function () { return $this->createMock(TestPasswordAuthenticatedUser::class); }), [new PasswordUpgradeBadge('', $this->createPasswordUpgrader())]))];
+        yield [self::createEvent(new SelfValidatingPassport(new UserBadge('test', function () { return new DummyTestPasswordAuthenticatedUser(); }), [new PasswordUpgradeBadge('', self::createPasswordUpgrader())]))];
     }
 
     /**
@@ -96,7 +96,7 @@ public function testUnsupportedPassport()
 
     public function testUpgradeWithUpgrader()
     {
-        $passwordUpgrader = $this->createPasswordUpgrader();
+        $passwordUpgrader = $this->getMockForAbstractClass(TestMigratingUserProvider::class);
         $passwordUpgrader->expects($this->once())
             ->method('upgradePassword')
             ->with($this->user, 'new-hash')
@@ -133,14 +133,14 @@ public function testUserWithoutPassword()
         $this->listener->onLoginSuccess($event);
     }
 
-    private function createPasswordUpgrader()
+    private static function createPasswordUpgrader()
     {
-        return $this->getMockForAbstractClass(TestMigratingUserProvider::class);
+        return new DummyTestMigratingUserProvider();
     }
 
-    private function createEvent(PassportInterface $passport)
+    private static function createEvent(PassportInterface $passport)
     {
-        return new LoginSuccessEvent($this->createMock(AuthenticatorInterface::class), $passport, $this->createMock(TokenInterface::class), new Request(), null, 'main');
+        return new LoginSuccessEvent(new DummyAuthenticator(), $passport, new DummyToken(), new Request(), null, 'main');
     }
 }
 
@@ -151,9 +151,62 @@ abstract public function upgradePassword(PasswordAuthenticatedUserInterface $use
     abstract public function loadUserByIdentifier(string $identifier): UserInterface;
 }
 
+class DummyTestMigratingUserProvider extends TestMigratingUserProvider
+{
+    public function upgradePassword(PasswordAuthenticatedUserInterface $user, string $newHashedPassword): void
+    {
+    }
+
+    public function loadUserByIdentifier(string $identifier): UserInterface
+    {
+    }
+
+    public function refreshUser(UserInterface $user)
+    {
+    }
+
+    public function supportsClass(string $class)
+    {
+    }
+
+    public function loadUserByUsername(string $username)
+    {
+    }
+}
+
 abstract class TestPasswordAuthenticatedUser implements UserInterface, PasswordAuthenticatedUserInterface
 {
     abstract public function getPassword(): ?string;
 
     abstract public function getSalt(): ?string;
 }
+
+class DummyTestPasswordAuthenticatedUser extends TestPasswordAuthenticatedUser
+{
+    public function getPassword(): ?string
+    {
+        return null;
+    }
+
+    public function getSalt(): ?string
+    {
+        return null;
+    }
+
+    public function getRoles(): array
+    {
+        return [];
+    }
+
+    public function eraseCredentials()
+    {
+    }
+
+    public function getUsername()
+    {
+    }
+
+    public function getUserIdentifier(): string
+    {
+    }
+}

Tests/Fixtures/DummyAuthenticator.php

@@ -0,0 +1,53 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Security\Http\Tests\Fixtures;
+
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
+use Symfony\Component\Security\Core\Exception\AuthenticationException;
+use Symfony\Component\Security\Http\Authenticator\AuthenticatorInterface;
+use Symfony\Component\Security\Http\Authenticator\Passport\Passport;
+use Symfony\Component\Security\Http\Authenticator\Passport\PassportInterface;
+
+/**
+ * @author Alexandre Daubois <alex.daubois@gmail.com>
+ */
+class DummyAuthenticator implements AuthenticatorInterface
+{
+    public function supports(Request $request): ?bool
+    {
+        return null;
+    }
+
+    public function authenticate(Request $request): Passport
+    {
+    }
+
+    public function createToken(Passport $passport, string $firewallName): TokenInterface
+    {
+    }
+
+    public function onAuthenticationSuccess(Request $request, TokenInterface $token, string $firewallName): ?Response
+    {
+        return null;
+    }
+
+    public function onAuthenticationFailure(Request $request, AuthenticationException $exception): ?Response
+    {
+        return null;
+    }
+
+    public function createAuthenticatedToken(PassportInterface $passport, string $firewallName): TokenInterface
+    {
+    }
+}

Tests/Fixtures/DummyToken.php

@@ -0,0 +1,101 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\Security\Http\Tests\Fixtures;
+
+use Symfony\Component\Security\Core\Authentication\Token\TokenInterface;
+use Symfony\Component\Security\Core\User\UserInterface;
+
+/**
+ * @author Alexandre Daubois <alex.daubois@gmail.com>
+ */
+class DummyToken implements TokenInterface
+{
+    public function serialize()
+    {
+    }
+
+    public function unserialize($data)
+    {
+    }
+
+    public function __toString(): string
+    {
+    }
+
+    public function getRoleNames(): array
+    {
+    }
+
+    public function getCredentials(): mixed
+    {
+    }
+
+    public function getUser(): ?UserInterface
+    {
+    }
+
+    public function setUser($user)
+    {
+    }
+
+    public function isAuthenticated(): bool
+    {
+    }
+
+    public function setAuthenticated(bool $isAuthenticated)
+    {
+    }
+
+    public function eraseCredentials(): void
+    {
+    }
+
+    public function getAttributes(): array
+    {
+    }
+
+    public function setAttributes(array $attributes): void
+    {
+    }
+
+    public function hasAttribute(string $name): bool
+    {
+    }
+
+    public function getAttribute(string $name): mixed
+    {
+    }
+
+    public function setAttribute(string $name, $value): void
+    {
+    }
+
+    public function getUsername(): string
+    {
+    }
+
+    public function getUserIdentifier(): string
+    {
+    }
+
+    public function __serialize(): array
+    {
+    }
+
+    public function __unserialize(array $data): void
+    {
+    }
+
+    public function __call(string $name, array $arguments)
+    {
+    }
+}