ACP2E-2970: Old media gallery fails to render images when a 0-byte image is placed in the directory

Author: thiaramus

app/code/Magento/Cms/Test/Unit/Model/Wysiwyg/Images/StorageTest.php

@@ -16,6 +16,8 @@
 use Magento\Cms\Model\Wysiwyg\Images\Storage\CollectionFactory;
 use Magento\Framework\App\Config\ScopeConfigInterface;
 use Magento\Framework\App\Filesystem\DirectoryList;
+use Magento\Framework\DataObject;
+use Magento\Framework\Exception\FileSystemException;
 use Magento\Framework\Exception\LocalizedException;
 use Magento\Framework\Filesystem;
 use Magento\Framework\Filesystem\Directory\Write;
@@ -31,6 +33,7 @@
 use Magento\MediaStorage\Model\File\UploaderFactory;
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
+use Psr\Log\LoggerInterface;
 
 /**
  * @SuppressWarnings(PHPMD.LongVariable)
@@ -141,6 +144,16 @@ class StorageTest extends TestCase
      */
     private $fileMock;
 
+    /**
+     * @var LoggerInterface|MockObject
+     */
+    private $loggerMock;
+
+    /**
+     * @var Repository|MockObject
+     */
+    private $assetRepo;
+
     /**
      * @var array
      */
@@ -206,7 +219,7 @@ function ($path) {
         $this->adapterFactoryMock = $this->createMock(AdapterFactory::class);
         $this->imageHelperMock = $this->createPartialMock(
             Images::class,
-            ['getStorageRoot', 'getCurrentPath']
+            ['getStorageRoot', 'getCurrentPath', 'getCurrentUrl']
         );
         $this->imageHelperMock->expects(
             $this->any()
@@ -234,6 +247,12 @@ function ($path) {
             Database::class
         );
 
+        $this->loggerMock = $this->getMockBuilder(LoggerInterface::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $this->assetRepo = $this->createMock(Repository::class);
+
         $this->uploaderFactoryMock = $this->getMockBuilder(UploaderFactory::class)
             ->disableOriginalConstructor()
             ->getMock();
@@ -284,7 +303,7 @@ function ($path) {
                 'coreFileStorageDb' => $this->coreFileStorageMock,
                 'filesystem' => $this->filesystemMock,
                 'imageFactory' => $this->adapterFactoryMock,
-                'assetRepo' => $this->createMock(Repository::class),
+                'assetRepo' => $this->assetRepo,
                 'storageCollectionFactory' => $this->storageCollectionFactoryMock,
                 'storageFileFactory' => $this->storageFileFactoryMock,
                 'storageDatabaseFactory' => $this->storageDatabaseFactoryMock,
@@ -299,7 +318,8 @@ function ($path) {
                 'data' => [],
                 'file' => $this->fileMock,
                 'ioFile' => $this->ioFileMock,
-                'coreConfig' => $this->coreConfigMock
+                'coreConfig' => $this->coreConfigMock,
+                'logger' => $this->loggerMock
             ]
         );
     }
@@ -368,6 +388,130 @@ public function testGetDirsCollectionCreateSubDirectories()
         );
     }
 
+    /**
+     * Test getFilesCollection() with the set of valid and invalid files
+     *
+     * @return void
+     * @throws LocalizedException
+     * @throws FileSystemException
+     * @dataProvider fileItemsDataProvider
+     */
+    public function testGetFilesCollection(
+        int $timesWarningTriggered,
+        string $thumbnailPath,
+        DataObject $imageItem
+    ) {
+        /** @var StorageCollection|MockObject $storageCollectionMock */
+        $storageCollectionMock = $this->getMockBuilder(StorageCollection::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+        $storageCollectionMock->expects($this->once())
+            ->method('setCollectDirs')
+            ->willReturnSelf();
+        $storageCollectionMock->expects($this->once())
+            ->method('setCollectFiles')
+            ->willReturnSelf();
+        $storageCollectionMock->expects($this->once())
+            ->method('setCollectRecursively')
+            ->willReturnSelf();
+        $storageCollectionMock->expects($this->once())
+            ->method('setOrder')
+            ->willReturnSelf();
+        $storageCollectionMock->method('getIterator')
+            ->willReturn(new \ArrayIterator([$imageItem]));
+
+        $this->storageCollectionFactoryMock->expects($this->once())
+            ->method('create')
+            ->willReturn($storageCollectionMock);
+
+        $this->driverMock->expects(self::once())
+            ->method('stat')
+            ->willReturn($imageItem->toArray());
+
+        $this->assetRepo->expects($this->exactly($timesWarningTriggered))
+            ->method('getUrl')
+            ->willReturn($thumbnailPath);
+
+        $this->loggerMock->expects($this->exactly($timesWarningTriggered))
+            ->method('warning')
+            ->with(
+                sprintf(
+                    "The image %s is invalid and cannot be displayed in the gallery.",
+                    $imageItem->getBasename()
+                )
+            );
+
+        $this->imagesStorage->getFilesCollection('/webroot/pub/media/', 'image');
+    }
+
+    /**
+     * Returns a set of valid and invalid image files
+     *
+     * @return array[]
+     */
+    public function fileItemsDataProvider()
+    {
+        return [
+            // Images files with the size of 0 bytes should generate proper warnings
+            [
+                'timesWarningTriggered' => 1,
+                'thumbnailPath' => Storage::THUMB_PLACEHOLDER_PATH_SUFFIX,
+                'imageItem' =>
+                    new DataObject(
+                        [
+                            'mtime' => 0,
+                            'size' => 0,
+                            'filename' => '/webroot/pub/media/wysiwyg/zero-bytes.jpg',
+                            'basename' => 'zero-bytes.jpg',
+                            'id' => 1,
+                            'name' => 'zero-bytes.jpg',
+                            'short_name' => 'zero-bytes.jpg',
+                            'url' => 'https://magento.local/pub/media/wysiwyg/zero-bytes.jpg',
+                            'mime_type' => 'image/jpeg'
+                        ]
+                    )
+            ],
+            // Images files with incorrect not allowed extensions should generate proper warnings
+            [
+                'timesWarningTriggered' => 1,
+                'thumbnailPath' => Storage::THUMB_PLACEHOLDER_PATH_SUFFIX,
+                'imageItem' =>
+                    new DataObject(
+                        [
+                            'mtime' => 0,
+                            'size' => 1024,
+                            'filename' => '/webroot/pub/media/wysiwyg/wrong-image.exe',
+                            'basename' => 'wrong-image.exe',
+                            'id' => 1,
+                            'name' => 'wrong-image.exe',
+                            'short_name' => 'wrong-image.exe',
+                            'url' => 'https://magento.local/pub/media/wysiwyg/wrong-image.exe',
+                            'mime_type' => 'image/jpeg'
+                        ]
+                    )
+            ],
+            // Images with non-zero size and allowed extension should not generate warnings
+            [
+                'timesWarningTriggered' => 0,
+                'thumbnailPath' => '',
+                'imageItem' =>
+                    new DataObject(
+                        [
+                            'mtime' => 0,
+                            'size' => 1024,
+                            'filename' => '/webroot/pub/media/wysiwyg/image.jpg',
+                            'basename' => 'image.jpg',
+                            'id' => 1,
+                            'name' => 'image.jpg',
+                            'short_name' => 'image.jpg',
+                            'url' => 'https://magento.local/pub/media/wysiwyg/image.jpg',
+                            'mime_type' => 'image/jpeg'
+                        ]
+                    )
+            ],
+        ];
+    }
+
     /**
      * @param $path
      * @param $callNum
@@ -432,7 +576,7 @@ public static function dirsCollectionDataProvider()
     protected function generalTestGetDirsCollection(string $path, int $callNum, string $dirsFilter)
     {
         /** @var StorageCollection|MockObject $storageCollectionMock */
-        $storageCollectionMock = $this->getMockBuilder(\Magento\Cms\Model\Wysiwyg\Images\Storage\Collection::class)
+        $storageCollectionMock = $this->getMockBuilder(StorageCollection::class)
             ->disableOriginalConstructor()
             ->getMock();
         $storageCollectionMock->expects($this->once())