magento#1824 update SaveImageTest

Author: Viktor Kopin

AdobeStockImage/Test/Integration/Model/SaveImageTest.php

@@ -14,10 +14,9 @@
 use Magento\Framework\Api\Search\Document;
 use Magento\Framework\Api\SearchCriteriaBuilder;
 use Magento\Framework\App\Filesystem\DirectoryList;
-use Magento\Framework\Exception\IntegrationException;
 use Magento\Framework\Filesystem;
 use Magento\Framework\Filesystem\Driver\Https;
-use Magento\Framework\Filesystem\DriverInterface;
+use Magento\MediaGalleryApi\Api\GetAssetsByPathsInterface;
 use Magento\TestFramework\Helper\Bootstrap;
 use PHPUnit\Framework\TestCase;
 
@@ -26,32 +25,47 @@
  */
 class SaveImageTest extends TestCase
 {
-    const URL_FIELD = 'thumbnail_240_url';
-
-    /**
-     * @var SaveImageInterface
-     */
-    private $saveImage;
-
-    /**
-     * @var DriverInterface
-     */
-    private $driver;
-
     /**
      * @var Filesystem
      */
     private $fileSystem;
 
     /**
-     * @var AssetRepositoryInterface
+     * @inheritdoc
      */
-    private $assetRepository;
+    protected function setUp(): void
+    {
+        $this->fileSystem = Bootstrap::getObjectManager()->get(Filesystem::class);
+        Bootstrap::getObjectManager()->configure([
+            'preferences' => [
+                Https::class => HttpsDriverMock::class
+            ]
+        ]);
+    }
 
     /**
-     * @var SearchCriteriaBuilder
+     * Test with image.
+     *
+     * @param array $documentData
+     * @param string $sourceFile
+     * @param string $destinationPath
+     * @return void
+     * @dataProvider getSaveTestDataProvider
      */
-    private $criteriaBuilder;
+    public function testSave(array $documentData, string $sourceFile, string $destinationPath): void
+    {
+        $this->deleteImage($destinationPath);
+        $document = $this->getDocument($documentData);
+        $saveImage = Bootstrap::getObjectManager()->create(SaveImageInterface::class);
+        $saveImage->execute(
+            $document,
+            $this->getImageFilePath($sourceFile),
+            $destinationPath
+        );
+        $this->assertImageSavedToDirectory($destinationPath);
+        $this->assertAssets($destinationPath, $documentData);
+        $this->deleteImage($destinationPath);
+    }
 
     /**
      * @return array
@@ -64,93 +78,98 @@ public function getSaveTestDataProvider(): array
                     'id' => 1,
                     'comp_url' => 'https://test.url/magento-logo.png',
                     'width' => 110,
-                    'title' => 'test',
+                    'title' => 'test adobe image title',
                     'content_type' => 'image/png',
                     'height' => 210,
                     'some_bool_param' => false,
                     'some_nullable_param' => null,
                     'extension_attributes' => [
-                        'title' => 'test',
+                        'title' => 'test adobe image title',
                         'is_downloaded' => 0,
                         'is_licensed_locally' => 0,
                         'thumbnail_240_url' => 'https://test.url/magento-logo.png',
-                        'creator_id' => 1122,
+                        'creator_id' => random_int(0, 2147483647),
                         'creator_name' => 'Test',
                         'path' => 'catalog/category/tmp.png',
                         'content_type' => 'image/png',
                         'category' => [
-                            'id' => 1,
+                            'id' => random_int(0, 2147483647),
                             'name' => 'Test'
                         ],
                     ]
                 ],
                 'sourcePath' => 'magento-logo.png',
-                'destinationPath' => 'catalog/category/tmp.png',
+                'destinationPath' => 'catalog/category/adobe-stock-save-image-test.png',
             ]
         ];
     }
 
     /**
-     * @inheritdoc
+     * Document for save.
+     *
+     * @param array $documentData
+     * @return Document
      */
-    protected function setUp(): void
+    private function getDocument(array $documentData): Document
     {
-        $this->driver = Bootstrap::getObjectManager()->get(DriverInterface::class);
-        $this->fileSystem = Bootstrap::getObjectManager()->get(Filesystem::class);
-        $this->assetRepository = Bootstrap::getObjectManager()->get(AssetRepositoryInterface::class);
-        $this->criteriaBuilder = Bootstrap::getObjectManager()->get(SearchCriteriaBuilder::class);
-        Bootstrap::getObjectManager()->configure([
-            'preferences' => [
-                Https::class => HttpsDriverMock::class
-            ]
-        ]);
-        $this->saveImage = Bootstrap::getObjectManager()->create(SaveImageInterface::class);
+        $document = new Document($documentData);
+        $this->addAttributes($document, $documentData['extension_attributes']);
+        return $document;
     }
 
     /**
-     * Test with image.
+     * Check if image saved by destination path
      *
-     * @param array $documentData
-     * @param string $sourceFile
      * @param string $destinationPath
      * @return void
-     * @dataProvider getSaveTestDataProvider
      */
-    public function testSave(array $documentData, string $sourceFile, string $destinationPath): void
+    private function assertImageSavedToDirectory(string $destinationPath): void
     {
-        $this->deleteImage($destinationPath);
-        $document = $this->getDocument($documentData);
-        $mediaDir = $this->fileSystem->getDirectoryWrite(DirectoryList::MEDIA);
-        $this->saveImage->execute(
-            $document,
-            $this->getImageFilePath($sourceFile),
-            $mediaDir->getAbsolutePath($destinationPath)
-        );
         self::assertTrue(
             $this->fileSystem->getDirectoryRead(DirectoryList::MEDIA)->isExist($destinationPath),
             'File was not saved by destination'
         );
-        $searchCriteria = $this->criteriaBuilder
-            ->addFilter('creator_id', $document->getCustomAttribute('creator_id')->getValue(), 'eq')
-            ->create();
-        self::assertNotEmpty(
-            $this->assetRepository->getList($searchCriteria),
-            'Image asset was not saved'
-        );
-        $this->deleteImage($destinationPath);
     }
 
     /**
-     * Document for save.
+     * Assert saved assets data
      *
+     * @param string $destinationPath
      * @param array $documentData
-     * @return Document
+     * @return void
      */
-    private function getDocument(array $documentData): Document
+    private function assertAssets(string $destinationPath, array $documentData): void
     {
-        $document = new Document($documentData);
-        $this->addAttributes($document, $documentData['extension_attributes']);
-        return $document;
+        $galleryAssets = Bootstrap::getObjectManager()->get(GetAssetsByPathsInterface::class);
+        $mediaAssets = $galleryAssets->execute([$destinationPath]);
+        self::assertCount(1, $mediaAssets, 'Wrong gallery assets count');
+        self::assertEquals(
+            $documentData['extension_attributes']['title'],
+            $mediaAssets[0]->getTitle(),
+            'Wrong gallery assets image title saved'
+        );
+        $criteriaBuilder = Bootstrap::getObjectManager()->get(SearchCriteriaBuilder::class);
+        $searchCriteria = $criteriaBuilder
+            ->addFilter('media_gallery_id', $mediaAssets[0]->getId())
+            ->create();
+        /** @var AssetRepositoryInterface $stockAssets */
+        $stockAssets = Bootstrap::getObjectManager()->get(AssetRepositoryInterface::class);
+        $items = $stockAssets->getList($searchCriteria)->getItems();
+        self::assertNotEmpty(
+            $items,
+            'Image asset was not saved'
+        );
+        $item = reset($items);
+        self::assertEquals(
+            $documentData['extension_attributes']['creator_id'],
+            $item->getCreatorId(),
+            'Wrong stock asset creator id saved'
+        );
+        self::assertEquals(
+            $documentData['extension_attributes']['category']['id'],
+            $item->getCategoryId(),
+            'Wrong stock asset category id saved'
+        );
     }
 
     /**
@@ -163,11 +182,11 @@ private function getDocument(array $documentData): Document
     private function addAttributes(Document $document, array $attributes): Document
     {
         $customAttributes = $document->getCustomAttributes();
-        $attributeValueFactory = Bootstrap::getObjectManager()->create(
+        $valueFactory = Bootstrap::getObjectManager()->create(
             AttributeValueFactory::class
         );
         foreach ($attributes as $code => $value) {
-            $attribute = $attributeValueFactory->create();
+            $attribute = $valueFactory->create();
             $attribute->setAttributeCode($code);
             $attribute->setValue($value);
             $customAttributes[$code] = $attribute;
@@ -186,15 +205,14 @@ private function addAttributes(Document $document, array $attributes): Document
      */
     private function getImageFilePath(string $filename): string
     {
-        return dirname(__DIR__, 1)
-            . DIRECTORY_SEPARATOR
-            . implode(
-                DIRECTORY_SEPARATOR,
-                [
-                    '_files',
-                    $filename
-                ]
-            );
+        return implode(
+            DIRECTORY_SEPARATOR,
+            [
+                dirname(__DIR__, 1),
+                '_files',
+                $filename
+            ]
+        );
     }
 
     /**
@@ -205,9 +223,6 @@ private function getImageFilePath(string $filename): string
      */
     private function deleteImage(string $destinationPath): void
     {
-        $mediaDir = $this->fileSystem->getDirectoryWrite(DirectoryList::MEDIA);
-        if ($mediaDir->isExist($destinationPath)) {
-            $this->driver->deleteFile($mediaDir->getAbsolutePath($destinationPath));
-        }
+        $this->fileSystem->getDirectoryWrite(DirectoryList::MEDIA)->delete($destinationPath);
     }
 }