unit-testing - 如何以正确的状态对对象进行单元测试？

Question

假设有这样的函数:

function a() 
{
    $entity = $this->getEntity();

    $entity->setSomePrivateVar();

    $service = $this->getService();

    $service->doSomething($entity);

}

我想测试一下

 $service->doSomething($entity);

使用正确的 $entity 调用。

$entity 调用 setSomePrivateVar()

在实际的应用程序代码中我做了这样的事情:

获取实体的模拟并测试调用了 setSomePrivateVar。

模拟 $service 并测试是否使用参数 $entity 调用了 doSomething()。

看起来不错。

但问题是 - 如果我重构代码并首先在服务上调用 doSomething()，然后在 $entity 上调用 setSomePrivateVar()，测试仍然会通过。

但是函数现在是错误的，因为 doSomething 依赖于由 setSomePrivateVar() 设置的 $entity 私有(private)字段。

例如我会重构为:

function a() 
{
    $entity = $this->getEntity();

    $service = $this->getService();

    $service->doSomething($entity);

    // this line moved
    $entity->setSomePrivateVar();

}

所以看起来 PhpUnit 没有检查 $entity 私有(private)字段。例如，如果它是数组，那么 with() 函数会发现传递的数组与预期的不一样。

那么我如何测试 doSomething() 是否以正确的状态获取 $entity(在将实体传递给 doSomething() 之前调用了 setSomePrivateVar() )？

也许 $entity 被 mock 与此有关。

更新现实世界的例子

public function setNotifyUsers(AnnualConsolidation $consolidation, $status)
{
    $consolidation->setNotifyUsers($status);    // if move this method after the flush(), tesst does not fail

    $this->entityManager->persist($consolidation);
    $this->entityManager->flush();
}


public function testNotifyUsers()
{
    $consolidation = $this->getMockBuilder(AnnualConsolidation::class)
        ->setMethods(['setNotifyUsers'])
        ->getMock();

    $consolidation
        ->expects($this->once())
        ->method('setNotifyUsers')
    ;

    $this->entityManager
        ->expects($this->at(0))
        ->method('persist')
        ->with($consolidation)
    ;

    $this->entityManager
        ->expects($this->at(1))
        ->method('flush')
    ;

    /** @var AnnualConsolidation $consolidation */
    $this->consolidationsService->setNotifyUsers($consolidation, true);
}

我们正在讨论以这种方式测试 setNotifyUsers 方法是否更好。我试图在不访问数据库的情况下进行测试。有人认为这可能需要通过命中数据库进行测试，因为如果在不更改逻辑的情况下重构方法，则可能需要测试才能重构。另一方面 - 这种方法不太可能被重构那么多。

但也许还有一种方法可以只测试在 persist() 之后调用 flush() 而无需告诉索引，因为在其他示例中，可能需要在添加一些调用之后更新 persist 之前的索引，因此可能是太多的工作无法保持测试正常进行。

但是对于这个主题 - 首先我想知道如何让测试失败 - 如果我在 flush() 之后移动 setNotifyUsers。 测试不会失败。如果我们使用命中数据库进行测试 - 我们会看到 $consolidation status 没有更新。

一个人被告知要检查、断言传递给 persist 方法的内容。我还没有尝试过，但我不确定在模拟 $consolidation 上这是否可行。模拟 $consolidation 是否具有真实 $consolidation 所具有的某种状态？

Answer 1

正如你在问题中所说的

One guy told to check, assert what is passed to the persist method.

这将是可行的方法，但您的代码使它变得相当困难，我认为您应该重构一下以使代码可测试。

首先，您的方法称为“setNotifyUsers”，但它实际上执行了 2 个操作，它在合并对象上调用 setNotifyUsers 并保存/保留此数据。在我看来，这些是 2 个不同的 Action ，应该属于 2 个不同的方法。如果你这样写它可以帮助你的测试:

public function setNotifyUsers(AnnualConsolidation $consolidation, $status) {
  $consolidation->setNotifyUsers($status);    
}

public function persistConsolidation(AnnualConsolidation $consolidation) {
  $this->entityManager->persist($consolidation);
  $this->entityManager->flush();
}

您可以分别测试 setNotifyUser 和 persistConsolidation 并为调用这些函数的部分(使用 consolidationsService 的方法)编写功能测试然后您可以使用 at() 功能来查看这些函数的调用顺序是否正确。

但是:其次，您将状态作为此功能的合并，作为将它们加在一起的唯一理由。我不认为类似的东西属于服务，而是属于方法调用该服务。移动该功能将再次给您带来麻烦，因为您无法测试调用它们的顺序。

但是您不需要使用 mockBuilder 来制作测试替身。除了使用 $this->getMockBuilder 之外，您还可以创建一个 FakeConsolidation 来实际为您保存数据

然后您还需要 AnnualConsolidation 的模拟，因为您希望能够检查该值是否设置正确。

class FakeConsolidation extends AnnualConsolidation {

  protected $id; 
  proteced $status;

  public function getId() {
    return $this->id;
  }

  public function setId($id) {
     $this->id = $id;
  }

  public function setNotifyUsers($status) {
    $this->status = $status;
  }

  public function shouldNotifyUsers() {
    $this->status
  } 
}

现在，因为您将向具有状态的持久对象提供一个对象，我们可以在“with”部分检查该状态。

当然，我不确切知道您的代码是如何构建的，所以我做了一些假设，只是在需要的地方进行调整并使用您拥有的接口(interface)。

像这样你甚至可以测试你在这个问题中展示的代码:

class SomethingTest extends PHPUnit_Framework_TestCase {
  private $consolidationsService;
  private $entityManager;

  /**
   * {@inheritdoc}
   */
  public function setUp() {
    $this->entityManager = $this->getMockBuilder(EntityManager::class)->getMock();
    $this->consolidationsService = new ConsolidationsService($this->entityManager);
  }

  public function testNotifyUsers() {
    $consolidation = new FakeConsolidation();
    $consolidation->setId(1);
    $this->entityManager
      ->expects($this->at(0))
      ->method('persist')
      ->with($this->callback(
          function($savedConsolidation) {
            return $savedConsolidation->shouldNotifyUsers() === true;
          }
      ));

    $this->entityManager
      ->expects($this->at(1))
      ->method('flush');

    /** @var AnnualConsolidation $consolidation */
    $this->consolidationsService->setNotifyUsers($consolidation, TRUE);
  }

}

现在，当您将 setNotifyUsers 移动到 persist 下方时

with($this->callback(
              function($savedConsolidation) {
                return $savedConsolidation->shouldNotifyUsers() === true;
              }
          )); 

您的测试将失败，因为状态尚未设置。