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

Question

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

我想查看由函数生成的电子邮件正文。

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;
    }
}

电子邮件Service.php

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

所以我为 emailService 和电子邮件创建了一个存根 class。但我无法验证电子邮件的正文。我也无法检查 $email->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 中你不能对创建的对象进行这种断言（甚至在你在规范文件中创建它们的存根或模拟上）：你唯一可以匹配的是 SUS（S ystem Under Spec) 及其返回值（如果有）。

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

---

从我的角度来看有什么问题

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% 肯定这种方法：我希望所有读者都清楚。