使用私有方法在Symfony中测试服务

时间:2018-11-03 09:25:55

标签: phpunit symfony4 phpunit-testing prophecy

我试图在服务中测试公共方法,但是它调用了另一个私有方法。

这是一个测试班

<?php

use App\Core\Application\Service\Files\UploadedFileService;
use PHPUnit\Framework\TestCase;
use Symfony\Component\DependencyInjection\ParameterBag\ParameterBagInterface;
use App\Core\Infrastructure\FileStorage\Services\ImagePath;
use App\Core\Infrastructure\FileStorage\Services\ImageResizeGenerator;
use Symfony\Component\Routing\RouterInterface;

class UploadedFileServiceTest extends TestCase
{
    /** @var UploadedFileService */
    private $instance;

    private $parameterHandler;
    private $router;
    private $imageResizeGenerator;
    private $imagePath;

    public function setUp()
    {
        parent::setUp();

        $this->parameterHandler     = $this->prophesize(ParameterBagInterface::class);
        $this->router               = $this->prophesize(RouterInterface::class);
        $this->imageResizeGenerator = $this->prophesize(ImageResizeGenerator::class);
        $this->imagePath            = $this->prophesize(ImagePath::class);

        $this->instance = new UploadedFileService(
            $this->parameterHandler->reveal(),
            $this->router->reveal(),
            $this->imageResizeGenerator->reveal(),
            $this->imagePath->reveal()
        );
    }

    public function testGetDefaultImageResponse()
    {
        $result = $this->instance->getDefaultImageResponse('user');
    }

}

当我运行 testGetDefaultImageResponse 测试时,出现控制台日志错误。

这是经过测试的功能

/**
 * @param string $entity
 *
 * @return Response
 */
public function getDefaultImageResponse(string $entity)
{
    return new Response(
        $this->getDefaultImage($entity),
        Response::HTTP_OK,
        ['Content-type' => 'image/jpg']
    );
}

真正的问题出在 getDefaultImage() 哪个抛出错误

  

file_get_contents():文件名不能为空

这是私有方法的内容

/**
 * @param string $entity
 *
 * @return bool|string
 */
private function getDefaultImage(string $entity)
{
    switch ($entity) {
        case 'entity1':
            return file_get_contents($this->parameterHandler->get('images.default_avatar'));
        case 'entity3':
            return file_get_contents($this->parameterHandler->get('images.default_logo'));
    }

    return file_get_contents($this->parameterHandler->get('images.default_avatar'));
}

如何将数据设置为 $ this-> parameterHandler-> get('images.default_avatar')

我在哪里运行测试出错?我必须承认我是单元测试中的新秀。

1 个答案:

答案 0 :(得分:1)

问题在于您的测试模拟程序(在本例中为 ParameterHandler 先知)以默认行为模拟方法 get ,返回null。尚未告知调用方法时该怎么办,因此 file_get_contents()将不会收到文件路径。

首先,您必须告诉您的先知返回正确的文件路径:

    $this->parameterHandler = $this->prophesize(ParameterBagInterface::class);
    $this->parameterHandler->get('images.default_avatar')->willReturn('/your/path/avatar.jpg');

现在,如果使用参数 images.default_avatar调用方法 get(),这将告诉先知返回 /your/path/avatar.jpg 。如果您能够正确配置默认头像的路径,则应该可以使用。

您甚至可以告诉先知,必须通过添加-> shouldBeCalled()来调用此方法,但随后您将测试实际测试类的内部(该类型有优缺点)测试,并取决于测试用例):

    $this->parameterHandler->get('images.default_avatar')->willReturn('/your/path/avatar.jpg')->shouldBeCalled();

下一个挑战可能是将对 file_get_contents()的调用抽象到一个新类中,该类也可以被模拟(例如,出于速度和内存原因)。