单元测试中的 Symfony 自定义存储库类

Question

我正在尝试创建一个单元测试来测试与数据库交互的 Symfony 4 代码。

需要测试的方法包含对自定义存储库类的调用，这会在运行 phpunit 时导致错误：错误：调用未定义的方法 Mock_ObjectRepository_583b1688::findLastRegisteredUsers()

我怀疑问题可能与我调用存储库的方式有关，但不确定如何解决。

测试/UserTest.php

class UserTest extends TestCase
{
    public function testCalculateTotalUsersReturnsInteger()
    {

        $user = new User();
        $user->setFullname('Test');

        // ! This might be what is causing the problem !
        $userRepository = $this->createMock(ObjectRepository::class); 

        $userRepository->expects($this->any())
            ->method('find')
            ->willReturn($user);

        $objectManager = $this->createMock(ObjectManager::class);

        $objectManager->expects($this->any())
            ->method('getRepository')
            ->willReturn($userRepository);

        $userCalculator = new RegistrationHandler($objectManager);
        $result = $registrationHandler->getAccountManager();

        $this->assertInternalType('int', $result);
    }
}

Repository/UserRepository.php

class UserRepository extends EntityRepository
{

    public function findLastRegisteredUsers($maxResults)
    {
        return $this->createQueryBuilder('user')
            ->andWhere('user.customField IS NOT NULL')
            ->addOrderBy('user.id', 'DESC')
            ->setFirstResult(0)
            ->setMaxResults($maxResults)
            ->getQuery()
            ->execute();
    }
}

src/User/UserCalculator.php

// src/User/UserCalculator.php
namespace App\User;

use Doctrine\Common\Persistence\ObjectManager;

class UserCalculator
{
    private $objectManager;

    public function __construct(ObjectManager $objectManager)
    {
        $this->objectManager = $objectManager;
    }

    public function calculateTotalUsers()
    {
        $userRepository = $this->objectManager
            ->getRepository(User::class);

        $users = $userRepository->findLastRegisteredUsers(100);

        // custom code
    }
}

为了清楚起见，自定义 EntityRepository 类的路径是在 User Entity 类中使​​用以下注释指定的

/**
 * @ORM\Entity(repositoryClass="App\Repository\UserRepository")
 */

任何想法如何让测试使用自定义存储库类？ 我想我可能需要更改 $userRepository = $this->createMock(ObjectRepository::class); 例如使用 $this->getMockBuilder() ？

Answer 1

您可以为此目的使用集成测试：

这个类扩展了KernelTestCase

class UserTest extends KernelTestCase
{
    public function testCalculateTotalUsersReturnsInteger()
    {

        self::bootKernel();
        $userCalculator = self::$kernel->getContainer()
        ->get('test.'.UserCalculator::class);


        $result = $userCalculator->calculateTotalUsers();

        $this->assertInternalType('int', $result);
    }
}

在services_test.yml中你需要注册这个服务：

test.App\User\UserCalculator: '@App\User\UserCalculator'

你可以调用你的方法：

 $result = $userCalculator->calculateTotalUsers();
 $this->assertInternalType('int', $result);

并使用 Assert 进行测试。

关于集成测试的文档，我从那里得到了这个例子： https://knpuniversity.com/screencast/phpunit/integration-tests

更新： 如果您想使用 UniTest 进行完全隔离的测试并且遇到错误：正在尝试配置无法配置的方法...

您需要在第一个 mock 中直接模拟您的存储库

$userReppsitory = $this->createMock(UserRepository::class)

并且你需要将方法（'find'）更改为method('findLastRegisteredUsers')

使用 UnitTest 更新

use PHPUnit\Framework\TestCase;
use Doctrine\Common\Persistence\ObjectManager;
use App\User\UserCalculator;
class UserTest extends TestCase
{
     public function testCalculateTotalUsersReturnsInteger()
        {

            $employee = new User();
            $employee->setFullname('test');

            // Now, mock the repository so it returns the mock of the employee
            $employeeRepository = $this->createMock(\App\Repository\UserRepository::class);

            $employeeRepository->expects($this->any())
                ->method('findLastRegisteredUsers')
                ->willReturn($employee);
            // Last, mock the EntityManager to return the mock of the repository
            $objectManager = $this->createMock(ObjectManager::class);

            $objectManager->expects($this->any())
                ->method('getRepository')
                ->willReturn($employeeRepository);

            $userCalculator = new UserCalculator($objectManager);

            $result = $userCalculator->calculateTotalUsers();
        } 
}