Symfony 6.1中实体自定义验证器的单元测试无法正常运行

测试失败的核心原因 #

你的测试代码存在三个关键问题：

1. 属性名不匹配：Person类的属性是$personId，但测试中构造函数传的是'person'，导致$personId未被正确赋值，验证器不会触发。
2. 未满足NotNull约束：$houseId带有#[Assert\NotNull]注解，测试中未赋值会触发该约束的违规，导致违规数为2而非1，断言失败。
3. 未Mock自定义验证器的依赖：自定义验证器（如PersonExists）通常依赖Repository等服务，直接调用Validator会因依赖缺失或真实数据干扰导致验证结果不符合预期。

正确的单元测试实现 #

1. 基础测试环境配置 #

首先在测试类中Mock自定义验证器的依赖，并配置Validator组件：

use App\Entity\Person;
use App\Validator\PersonExistsValidator;
use App\Repository\PersonRepository;
use App\Validator\HouseExistsValidator;
use App\Repository\HouseRepository;
use Symfony\Component\Validator\Validation;
use Symfony\Component\Validator\Validator\ValidatorInterface;
use PHPUnit\Framework\TestCase;

class PersonValidationTest extends TestCase
{
    private ValidatorInterface $validator;
    private PersonRepository $personRepoMock;
    private HouseRepository $houseRepoMock;

    protected function setUp(): void
    {
        // Mock PersonRepository，模拟查询逻辑
        $this->personRepoMock = $this->createMock(PersonRepository::class);
        
        // Mock HouseRepository，默认返回存在的House（用于隔离测试PersonExists）
        $this->houseRepoMock = $this->createMock(HouseRepository::class);
        $this->houseRepoMock->method('find')
            ->with('valid-house-id')
            ->willReturn(new \stdClass()); // 返回任意非null对象表示存在

        // 初始化自定义验证器并注入Mock依赖
        $personExistsValidator = new PersonExistsValidator($this->personRepoMock);
        $houseExistsValidator = new HouseExistsValidator($this->houseRepoMock);

        // 注册验证器到Validator组件
        $this->validator = Validation::createValidatorBuilder()
            ->addValidator($personExistsValidator)
            ->addValidator($houseExistsValidator)
            ->getValidator();
    }
}

2. 测试PersonId不存在的场景 #

public function testPersonIdNonExistentTriggersViolation(): void
{
    // 配置Mock：传入不存在的ID时返回null
    $this->personRepoMock->method('find')
        ->with('non-existent-library-id')
        ->willReturn(null);

    // 正确初始化Person对象，满足HouseId的NotNull约束
    $person = new Person();
    $person->setPersonId('non-existent-library-id');
    $person->setHouseId('valid-house-id');

    $violations = $this->validator->validate($person);

    // 断言验证结果
    $this->assertCount(1, $violations);
    $this->assertSame('Person not found', $violations[0]->getMessage());
    $this->assertSame('personId', $violations[0]->getPropertyPath());
}

3. 测试HouseId不存在的场景 #

public function testHouseIdNonExistentTriggersViolation(): void
{
    // 配置Mock：传入不存在的House ID时返回null
    $this->houseRepoMock->method('find')
        ->with('non-existent-house-id')
        ->willReturn(null);

    $person = new Person();
    $person->setPersonId('valid-person-id');
    $person->setHouseId('non-existent-house-id');

    $violations = $this->validator->validate($person);

    $this->assertCount(1, $violations);
    $this->assertSame('House not found', $violations[0]->getMessage());
    $this->assertSame('houseId', $violations[0]->getPropertyPath());
}

4. 测试HouseId为null的场景 #

public function testHouseIdNullTriggersNotNullViolation(): void
{
    $person = new Person();
    $person->setPersonId('valid-person-id');
    // 不设置HouseId，保持null

    $violations = $this->validator->validate($person);

    $this->assertCount(1, $violations);
    $this->assertSame('This value should not be null.', $violations[0]->getMessage());
    $this->assertSame('houseId', $violations[0]->getPropertyPath());
}

关键注意事项 #

• 属性赋值要准确：确保测试中给Person对象的属性名与类定义一致，若使用构造函数注入，需确认构造函数参数对应正确属性。
• 隔离测试场景：每个测试用例只验证一个约束，避免多个违规干扰断言结果。
• Mock依赖要精准：根据测试场景配置Mock的返回值，确保自定义验证器的逻辑能被正确触发。

内容的提问来源于stack exchange，提问作者Geek