如何在PHPUnit中强制指定Attachment的setPath方法设置指定路径？

问题场景 #

我在测试一个调用createAttachment方法的API，该方法内部直接实例化Attachment实体并调用setPath设置动态生成的路径，但这个路径不符合测试预期。由于Attachment是方法内new出来的，无法直接Mock，需要找到办法让Attachment最终保存的path是我指定的值。

相关代码如下：

被测试的方法 #

public function createAttachment(string $type, int $id, UploadedFile $file)
{
     // 其他逻辑
     $attachment = new Attachment();
     $attachment->setPath($uploadDir . DIRECTORY_SEPARATOR . $filenamePath);
     // 其他逻辑
     $this->em->persist($attachment);
     $this->em->flush();
}

Attachment实体（部分代码） #

class Attachment {

    private ?string $path;

    public function setPath(?string $path): self
    {
        $this->path = $path;

        return $this;
    }
}

解决方案 #

方案1：引入工厂模式（推荐，解耦测试友好） #

修改生产代码，把Attachment的实例化逻辑抽成一个工厂类，通过依赖注入注入到当前类中。这样测试时可以Mock工厂，返回一个被控制的Attachment实例。

步骤1：创建Attachment工厂

interface AttachmentFactoryInterface
{
    public function create(): Attachment;
}

class AttachmentFactory implements AttachmentFactoryInterface
{
    public function create(): Attachment
    {
        return new Attachment();
    }
}

步骤2：修改被测试类的依赖注入和createAttachment方法

// 被测试类的构造函数注入工厂
public function __construct(
    private EntityManagerInterface $em,
    private AttachmentFactoryInterface $attachmentFactory
) {}

public function createAttachment(string $type, int $id, UploadedFile $file)
{
     // 其他逻辑
     $attachment = $this->attachmentFactory->create(); // 用工厂创建实例
     $attachment->setPath($uploadDir . DIRECTORY_SEPARATOR . $filenamePath);
     // 其他逻辑
     $this->em->persist($attachment);
     $this->em->flush();
}

步骤3：测试中Mock工厂和Attachment

// 测试代码
public function testCreateAttachmentWithCustomPath()
{
    // Mock Attachment实例，强制setPath使用指定值
    $mockAttachment = $this->createMock(Attachment::class);
    $mockAttachment->method('setPath')
        ->with($this->equalTo('/expected/test/path'))
        ->willReturnSelf();

    // Mock工厂，返回我们的Mock Attachment
    $mockFactory = $this->createMock(AttachmentFactoryInterface::class);
    $mockFactory->method('create')
        ->willReturn($mockAttachment);

    // 注入Mock工厂到被测试类
    $service = new YourService($this->getMockEntityManager(), $mockFactory);
    $service->createAttachment('type', 1, $this->createMock(UploadedFile::class));

    // 后续断言逻辑，比如验证persist被调用等
}

优点：从根本上解耦了实例化逻辑，让代码更具扩展性和可测试性，符合SOLID原则。
缺点：需要修改生产代码，但属于良性重构。

方案2：使用反射修改私有属性（应急方案） #

如果暂时不想修改生产代码，可以用PHP的反射机制直接修改Attachment的私有$path属性，绕过setPath的调用。

public function testCreateAttachmentWithCustomPath()
{
    // 执行被测试方法前，捕获Attachment实例
    $emMock = $this->createMock(EntityManagerInterface::class);
    $emMock->method('persist')
        ->willReturnCallback(function (Attachment $attachment) {
            // 用反射修改$path属性
            $reflection = new ReflectionClass($attachment);
            $pathProperty = $reflection->getProperty('path');
            $pathProperty->setAccessible(true);
            $pathProperty->setValue($attachment, '/expected/test/path');
        });

    $service = new YourService($emMock);
    $service->createAttachment('type', 1, $this->createMock(UploadedFile::class));

    // 断言逻辑
}

优点：不需要修改生产代码，快速实现测试需求。
缺点：依赖Attachment的内部私有属性结构，后续实体代码变更（比如属性名修改）会导致测试失败，属于hack手段，不推荐长期使用。

方案3：调整测试环境的路径配置（最简单场景） #

如果$uploadDir是可配置的参数（比如来自环境变量或配置文件），可以直接在测试环境中将$uploadDir设置为预期的路径，这样动态生成的路径自然符合测试要求。

比如在测试bootstrap文件或测试用例中：

// 设置测试环境的上传目录
putenv('UPLOAD_DIR=/expected/test/path');
// 或者通过配置类注入
$config->set('upload_dir', '/expected/test/path');

优点：零代码修改，实现成本最低。
缺点：仅适用于路径生成逻辑依赖外部配置的场景，如果$uploadDir是硬编码的则无法使用。

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