[Tests] Aligned VariationPurger unit tests with the changes

ibexa · alongosz · Aug 6, 2025 · Jul 8, 2025 · Jul 8, 2025 · Jul 8, 2025
commit 689887a1191a8afcc91d7b33e8af4131d14651ad
diff --git a/tests/bundle/Core/Imagine/VariationPurger/IOVariationPurgerTest.php b/tests/bundle/Core/Imagine/VariationPurger/IOVariationPurgerTest.php
@@ -4,6 +4,7 @@
  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+declare(strict_types=1);
 
 namespace Ibexa\Tests\Bundle\Core\Imagine\VariationPurger;
 
@@ -14,7 +15,10 @@
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Cache\Adapter\TagAwareAdapterInterface;
 
-class IOVariationPurgerTest extends TestCase
+/**
+ * @covers \Ibexa\Bundle\Core\Imagine\VariationPurger\IOVariationPurger
+ */
+final class IOVariationPurgerTest extends TestCase
 {
     public function testPurgesAliasList(): void
     {

diff --git a/tests/bundle/Core/Imagine/VariationPurger/ImageFileVariationPurgerTest.php b/tests/bundle/Core/Imagine/VariationPurger/ImageFileVariationPurgerTest.php
@@ -4,34 +4,37 @@
  * @copyright Copyright (C) Ibexa AS. All rights reserved.
  * @license For full copyright and license information view LICENSE file distributed with this source code.
  */
+declare(strict_types=1);
 
 namespace Ibexa\Tests\Bundle\Core\Imagine\VariationPurger;
 
 use ArrayIterator;
+use Ibexa\Bundle\Core\Imagine\VariationPurger\ImageFileList;
 use Ibexa\Bundle\Core\Imagine\VariationPurger\ImageFileVariationPurger;
 use Ibexa\Contracts\Core\Variation\VariationPathGenerator;
 use Ibexa\Core\IO\IOServiceInterface;
 use Ibexa\Core\IO\Values\BinaryFile;
+use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 
-class ImageFileVariationPurgerTest extends TestCase
+/**
+ * @covers \Ibexa\Bundle\Core\Imagine\VariationPurger\ImageFileVariationPurger
+ */
+final class ImageFileVariationPurgerTest extends TestCase
 {
-    /** @var \Ibexa\Core\IO\IOServiceInterface|\PHPUnit\Framework\MockObject\MockObject */
-    protected $ioServiceMock;
+    protected IOServiceInterface & MockObject $ioServiceMock;
 
-    /** @var \Ibexa\Contracts\Core\Variation\VariationPathGenerator|\PHPUnit\Framework\MockObject\MockObject */
-    protected $pathGeneratorMock;
+    protected VariationPathGenerator & MockObject $pathGeneratorMock;
 
-    /** @var \Ibexa\Bundle\Core\Imagine\VariationPurger\ImageFileVariationPurger */
-    protected $purger;
+    protected ImageFileVariationPurger $purger;
 
     protected function setUp(): void
     {
         $this->ioServiceMock = $this->createMock(IOServiceInterface::class);
         $this->pathGeneratorMock = $this->createMock(VariationPathGenerator::class);
     }
 
-    public function testIteratesOverItems()
+    public function testIteratesOverItems(): void
     {
         $purger = $this->createPurger(
             [
@@ -53,7 +56,7 @@ public function testIteratesOverItems()
         $purger->purge(['large', 'gallery']);
     }
 
-    public function testPurgesExistingItem()
+    public function testPurgesExistingItem(): void
     {
         $purger = $this->createPurger(
             ['path/to/file.png']
@@ -62,17 +65,17 @@ public function testPurgesExistingItem()
         $this->pathGeneratorMock
             ->expects(self::once())
             ->method('getVariationPath')
-            ->will(self::returnValue('path/to/file_large.png'));
+            ->willReturn('path/to/file_large.png');
 
         $this->ioServiceMock
             ->expects(self::once())
             ->method('exists')
-            ->will(self::returnValue(true));
+            ->willReturn(true);
 
         $this->ioServiceMock
             ->expects(self::once())
             ->method('loadBinaryFile')
-            ->will(self::returnValue(new BinaryFile()));
+            ->willReturn(new BinaryFile());
 
         $this->ioServiceMock
             ->expects(self::once())
@@ -82,7 +85,7 @@ public function testPurgesExistingItem()
         $purger->purge(['large']);
     }
 
-    public function testDoesNotPurgeNotExistingItem()
+    public function testDoesNotPurgeNotExistingItem(): void
     {
         $purger = $this->createPurger(
             ['path/to/file.png']
@@ -91,12 +94,12 @@ public function testDoesNotPurgeNotExistingItem()
         $this->pathGeneratorMock
             ->expects(self::once())
             ->method('getVariationPath')
-            ->will(self::returnValue('path/to/file_large.png'));
+            ->willReturn('path/to/file_large.png');
 
         $this->ioServiceMock
             ->expects(self::once())
             ->method('exists')
-            ->will(self::returnValue(false));
+            ->willReturn(false);
 
         $this->ioServiceMock
             ->expects(self::never())
@@ -109,8 +112,14 @@ public function testDoesNotPurgeNotExistingItem()
         $purger->purge(['large']);
     }
 
-    private function createPurger(array $fileList)
+    /**
+     * @param string[] $fileList
+     */
+    private function createPurger(array $fileList): ImageFileVariationPurger
     {
-        return new ImageFileVariationPurger(new ArrayIterator($fileList), $this->ioServiceMock, $this->pathGeneratorMock);
+        $imageFileList = new class($fileList) extends ArrayIterator implements ImageFileList {
+        };
+
+        return new ImageFileVariationPurger($imageFileList, $this->ioServiceMock, $this->pathGeneratorMock);
     }
 }
diff --git a/tests/bundle/Core/Imagine/VariationPurger/LegacyStorageImageFileListTest.php b/tests/bundle/Core/Imagine/VariationPurger/LegacyStorageImageFileListTest.php
@@ -12,43 +12,39 @@
 use Ibexa\Bundle\Core\Imagine\VariationPurger\LegacyStorageImageFileList;
 use Ibexa\Contracts\Core\SiteAccess\ConfigResolverInterface;
 use Ibexa\Core\IO\IOConfigProvider;
+use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 
-class LegacyStorageImageFileListTest extends TestCase
+/**
+ * @covers \Ibexa\Bundle\Core\Imagine\VariationPurger\LegacyStorageImageFileList
+ */
+final class LegacyStorageImageFileListTest extends TestCase
 {
-    /** @var \Ibexa\Bundle\Core\Imagine\VariationPurger\ImageFileRowReader|\PHPUnit\Framework\MockObject\MockObject */
-    protected $rowReaderMock;
-
-    /** @var \Ibexa\Bundle\Core\Imagine\VariationPurger\LegacyStorageImageFileList */
-    protected $fileList;
-
-    /** @var \Ibexa\Core\IO\IOConfigProvider|\PHPUnit\Framework\MockObject\MockObject */
-    private $ioConfigResolverMock;
+    protected ImageFileRowReader&MockObject $rowReaderMock;
 
-    /** @var \Ibexa\Contracts\Core\SiteAccess\ConfigResolverInterface|\PHPUnit\Framework\MockObject\MockObject */
-    private $configResolverMock;
+    protected LegacyStorageImageFileList $fileList;
 
     protected function setUp(): void
     {
         $this->rowReaderMock = $this->createMock(ImageFileRowReader::class);
-        $this->ioConfigResolverMock = $this->createMock(IOConfigProvider::class);
-        $this->ioConfigResolverMock
+        $ioConfigResolverMock = $this->createMock(IOConfigProvider::class);
+        $ioConfigResolverMock
             ->method('getLegacyUrlPrefix')
             ->willReturn('var/ibexa_demo_site/storage');
-        $this->configResolverMock = $this->createMock(ConfigResolverInterface::class);
-        $this->configResolverMock
+        $configResolverMock = $this->createMock(ConfigResolverInterface::class);
+        $configResolverMock
             ->method('getParameter')
             ->with('image.published_images_dir')
             ->willReturn('images');
 
         $this->fileList = new LegacyStorageImageFileList(
             $this->rowReaderMock,
-            $this->ioConfigResolverMock,
-            $this->configResolverMock
+            $ioConfigResolverMock,
+            $configResolverMock
         );
     }
 
-    public function testIterator()
+    public function testIterator(): void
     {
         $expected = [
             'path/to/1st/image.jpg',
@@ -62,21 +58,36 @@ public function testIterator()
     }
 
     /**
-     * Tests that the iterator transforms the ezimagefile value into a binaryfile id.
+     * Tests that the iterator transforms the ibexa_image_file value into a binary file id.
      */
-    public function testImageIdTransformation()
+    public function testImageIdTransformation(): void
     {
         $this->configureRowReaderMock(['var/ibexa_demo_site/storage/images/path/to/1st/image.jpg']);
         foreach ($this->fileList as $file) {
             self::assertEquals('path/to/1st/image.jpg', $file);
         }
     }
 
-    private function configureRowReaderMock(array $fileList)
+    /**
+     * @param string[] $fileList
+     */
+    private function configureRowReaderMock(array $fileList): void
     {
-        $mockInvocator = $this->rowReaderMock->expects(self::any())->method('getRow');
-        call_user_func_array([$mockInvocator, 'willReturnOnConsecutiveCalls'], $fileList);
+        $fileListCount = count($fileList);
+        // iterator will try to invoke methods one more time to establish its end
+        $expectedIteratorInvocationsCount = $fileListCount + 1;
+
+        $index = 0;
+        $this->rowReaderMock
+            ->expects(self::exactly($expectedIteratorInvocationsCount))
+            ->method('getRow')
+            ->willReturnCallback(static function () use (&$index, $fileList): ?string {
+                return $fileList[$index++] ?? null;
+            });
 
-        $this->rowReaderMock->expects(self::any())->method('getCount')->willReturn(count($fileList));
+        $this->rowReaderMock
+            ->expects(self::exactly($expectedIteratorInvocationsCount))
+            ->method('getCount')
+            ->willReturn($fileListCount);
     }
 }