如何从存根函数参数中获取属性？

Question

我有一项服务，应该创建一个电子邮件类对象并将其传递给第三类（电子邮件发件人）。

我想查看由该功能生成的电子邮件正文。

Service.php

class Service
{
    /** @var EmailService */
    protected $emailService;

    public function __construct(EmailService $emailService)
    {
        $this->emailService = $emailService;
    }

    public function testFunc()
    {
        $email = new Email();
        $email->setBody('abc'); // I want to test this attribute

        $this->emailService->send($email);
    }
}

Email.php：

class Email
{
    protected $body;

    public function setBody($body)
    {
        $this->body = $body;
    }
    public function getBody()
    {
        return $this->body;
    }
}

EmailService.php

interface EmailService
{
    public function send(Email $email);
}

所以我为emailService和email创建了一个存根类。但我无法验证电子邮件的正文。我也无法检查是否调用了$ email-＆gt; setBody（），因为电子邮件是在测试函数内创建的

class ServiceSpec extends ObjectBehavior
{
    function it_creates_email_with_body_abc(EmailService $emailService, Email $email)
    {
        $this->beConstructedWith($emailService);

        $emailService->send($email);
        $email->getBody()->shouldBe('abc');
        $this->testFunc();
    }
}

我明白了：

Call to undefined method Prophecy\Prophecy\MethodProphecy::shouldBe() in /private/tmp/phpspec/spec/App/ServiceSpec.php on line 18 

在真实应用程序中生成正文，所以我想测试，如果它是正确生成的。我怎么能这样做？

Answer 1

在PHPSpec中，您无法对创建的对象进行此类断言（甚至在您在spec文件中创建它们时也会使用存根或模拟）：只有您可以匹配的东西是SUS（ S ystem U nder S pec）及其返回值（如果有）。

我会写一个小指南让你的测试通过和来改善你的设计和可测试性

从我的角度来看是错误的

在new

中使用

Service

为什么错误

Service有两个责任：创建一个Email对象并完成其工作。这打破了SOLID principles的SRP。此外，你失去了对象创建的控制权，正如你所发现的那样，这很难被测试

进行规范传递的解决方法

我建议使用工厂（我将在下面显示）进行此类任务，因为显着提高了可测试性，但在这种情况下，您可以通过重写规范来进行测试，如下所示

class ServiceSpec extends ObjectBehavior
{
    function it_creates_email_with_body_abc(EmailService $emailService) 
    { 
        $this->beConstructedWith($emailService);

        //arrange data
        $email = new Email();
        $email->setBody('abc');

        //assert
        $emailService->send($email)->shouldBeCalled();

        //act
        $this->testFunc();
    }
}

只要setBody在SUS实现中没有改变，这就行了。 但是我不推荐它，因为这应该是PHPSpec观点的气味。

使用工厂

创建工厂

class EmailFactory()
{
    public function createEmail($body)
    {
        $email = new Email();
        $email->setBody($body);

        return $email;
    }
}

及其规格

public function EmailFactorySpec extends ObjectBehavior
{
    function it_is_initializable()
    {
        $this->shouldHaveType(EmailFactory::class);
    }

    function it_creates_email_with_body_content()
    {
        $body = 'abc';
        $email = $this->createEmail($body);

        $email->shouldBeAnInstanceOf(Email::class);
        $email->getBody()->shouldBeEqualTo($body);
    }
}

现在您确定工厂的createEmail符合您的预期。正如您所注意到的，责任在这里被包含在内并且您不必担心其他地方（考虑一种策略，您可以选择如何发送邮件：直接，将它们放入队列等等;如果您使用它们解决它们原始方法，您需要在每个具体策略中测试电子邮件是按照您的预期创建的，而现在您不会这样做。

将工厂集成在SUS

中

class Service
{
    /** @var EmailService */
    protected $emailService;

    /** @var EmailFactory */
    protected $emailFactory;

    public function __construct(
      EmailService $emailService, EmailFactory $emailFactory
    ) {
        $this->emailService = $emailService;
        $this->emailFactory = $emailFactory;
    }

    public function testFunc()
    {
        $email = $this->emailFactory->createEmail('abc');
        $this->emailService->send($email);
    } 
}

最后使规范通过（正确的方式）

function it_creates_email_with_body_abc(
  EmailService $emailService, EmailFactory $emailFactory, Email $mail
) {
    $this->beConstructedWith($emailService);
    // if you need to be sure that body will be 'abc', 
    // otherwise you can use Argument::type('string') wildcard
    $emailFactory->createEmail('abc')->willReturn($email);
    $emailService->send($email)->shouldBeCalled();

    $this->testFunc();
}

我没有尝试过这个例子，可能会有一些错别字，但我对此方法100％肯定：我希望所有读者都清楚。