Improve coverage

Author: dunglas

src/Bridge/Doctrine/EventListener/PurgeHttpCacheListener.php

@@ -49,6 +49,9 @@ public function __construct(PurgerInterface $purger, IriConverterInterface $iriC
         $this->propertyAccessor = $propertyAccessor ?? PropertyAccess::createPropertyAccessor();
     }
 
+    /**
+     * Collects tags from the previous and the current version of the updated entities to purge related documents.
+     */
     public function preUpdate(PreUpdateEventArgs $eventArgs)
     {
         $object = $eventArgs->getObject();
@@ -67,6 +70,9 @@ public function preUpdate(PreUpdateEventArgs $eventArgs)
         }
     }
 
+    /**
+     * Collects tags from inserted and deleted entities, including relations.
+     */
     public function onFlush(OnFlushEventArgs $eventArgs)
     {
         $em = $eventArgs->getEntityManager();
@@ -88,6 +94,9 @@ public function onFlush(OnFlushEventArgs $eventArgs)
         }
     }
 
+    /**
+     * Purges tags collected during this request, and clears the tag list.
+     */
     public function postFlush()
     {
         $this->purger->purge($this->tags);

tests/Bridge/Doctrine/EventListener/PurgeHttpCacheListenerTest.php

@@ -18,8 +18,10 @@
 use ApiPlatform\Core\Bridge\Doctrine\EventListener\PurgeHttpCacheListener;
 use ApiPlatform\Core\HttpCache\PurgerInterface;
 use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Dummy;
+use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\RelatedDummy;
 use Doctrine\ORM\EntityManagerInterface;
 use Doctrine\ORM\Event\OnFlushEventArgs;
+use Doctrine\ORM\Event\PreUpdateEventArgs;
 use Doctrine\ORM\Mapping\ClassMetadata;
 use Doctrine\ORM\UnitOfWork;
 use Prophecy\Argument;
@@ -29,7 +31,7 @@
  */
 class PurgeHttpCacheListenerTest extends \PHPUnit_Framework_TestCase
 {
-    public function test()
+    public function testOnFlush()
     {
         $toInsert1 = new Dummy();
         $toInsert2 = new Dummy();
@@ -71,4 +73,41 @@ public function test()
         $listener->onFlush($eventArgs);
         $listener->postFlush();
     }
+
+    public function testPreUpdate()
+    {
+        $oldRelatedDummy = new RelatedDummy();
+        $oldRelatedDummy->setId(1);
+
+        $newRelatedDummy = new RelatedDummy();
+        $newRelatedDummy->setId(2);
+
+        $dummy = new Dummy();
+        $dummy->setId(1);
+
+        $purgerProphecy = $this->prophesize(PurgerInterface::class);
+        $purgerProphecy->purge(['/dummies' => '/dummies', '/dummies/1' => '/dummies/1', '/related_dummies/old' => '/related_dummies/old', '/related_dummies/new' => '/related_dummies/new'])->shouldBeCalled();
+
+        $iriConverterProphecy = $this->prophesize(IriConverterInterface::class);
+        $iriConverterProphecy->getIriFromResourceClass(Dummy::class)->willReturn('/dummies')->shouldBeCalled();
+        $iriConverterProphecy->getIriFromItem($dummy)->willReturn('/dummies/1')->shouldBeCalled();
+        $iriConverterProphecy->getIriFromItem($oldRelatedDummy)->willReturn('/related_dummies/old')->shouldBeCalled();
+        $iriConverterProphecy->getIriFromItem($newRelatedDummy)->willReturn('/related_dummies/new')->shouldBeCalled();
+
+        $resourceClassResolverProphecy = $this->prophesize(ResourceClassResolverInterface::class);
+        $resourceClassResolverProphecy->getResourceClass(Argument::type(Dummy::class))->willReturn(Dummy::class)->shouldBeCalled();
+
+        $emProphecy = $this->prophesize(EntityManagerInterface::class);
+
+        $classMetadata = new ClassMetadata(Dummy::class);
+        $classMetadata->mapManyToOne(['fieldName' => 'relatedDummy', 'targetEntity' => RelatedDummy::class]);
+        $emProphecy->getClassMetadata(Dummy::class)->willReturn($classMetadata)->shouldBeCalled();
+
+        $changeSet = ['relatedDummy' => [$oldRelatedDummy, $newRelatedDummy]];
+        $eventArgs = new PreUpdateEventArgs($dummy, $emProphecy->reveal(), $changeSet);
+
+        $listener = new PurgeHttpCacheListener($purgerProphecy->reveal(), $iriConverterProphecy->reveal(), $resourceClassResolverProphecy->reveal());
+        $listener->preUpdate($eventArgs);
+        $listener->postFlush();
+    }
 }