Merge remote-tracking branch 'origin/B2B-2058' into B2B-2022

Author: avattam06

app/code/Magento/RemoteStorage/etc/di.xml

@@ -96,6 +96,11 @@
             <argument name="filesystem" xsi:type="object">fullRemoteFilesystem</argument>
         </arguments>
     </type>
+    <type name="Magento\Framework\File\Name">
+        <arguments>
+            <argument name="filesystem" xsi:type="object">fullRemoteFilesystem</argument>
+        </arguments>
+    </type>
     <type name="Magento\Framework\Image\Adapter\AbstractAdapter">
         <plugin name="remoteImageFile" type="Magento\RemoteStorage\Plugin\Image" sortOrder="10"/>
     </type>

dev/tests/integration/testsuite/Magento/Framework/File/NameTest.php

@@ -0,0 +1,71 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Framework\File;
+
+use Magento\Framework\App\Filesystem\DirectoryList;
+use Magento\TestFramework\Helper\Bootstrap;
+use Magento\Framework\Filesystem;
+
+/**
+ * Test for \Magento\Framework\File\Name
+ */
+class NameTest extends \PHPUnit\Framework\TestCase
+{
+    /**
+     * @var Name
+     */
+    private $nameModel;
+
+    /**
+     * @var Filesystem
+     */
+    private $fileSystem;
+
+    /**
+     * @inheritdoc
+     */
+    protected function setUp(): void
+    {
+        $objectManager = Bootstrap::getObjectManager();
+        $this->fileSystem = $objectManager->get(\Magento\Framework\Filesystem::class);
+        $this->nameModel = $objectManager->get(Name::class);
+    }
+
+    /**
+     * @param string $destinationFile
+     * @param string $expectedFileName
+     * @return void
+     *
+     * @throws \Magento\Framework\Exception\FileSystemException
+     *
+     * @magentoDataFixture Magento/Framework/File/_files/framework_file_name.php
+     * @dataProvider getNewFileNameDataProvider
+     */
+    public function testGetNewFileName($directory, $destinationFile, $expectedFileName)
+    {
+        $directory = $this->fileSystem->getDirectoryWrite($directory);
+        $path = $directory->getAbsolutePath('image/' . $destinationFile);
+        $name = $this->nameModel->getNewFileName($path);
+        $this->assertEquals($expectedFileName, $name);
+    }
+
+    /**
+     * Data provider for testGetNewFileName
+     * @return array
+     */
+    public function getNewFileNameDataProvider()
+    {
+        return [
+            [DirectoryList::VAR_DIR, 'image.jpg', 'image.jpg'],
+            [DirectoryList::VAR_DIR, 'image_one.jpg', 'image_one_1.jpg'],
+            [DirectoryList::MEDIA, 'image.jpg', 'image.jpg'],
+            [DirectoryList::MEDIA, 'image_one.jpg', 'image_one_1.jpg'],
+            [DirectoryList::MEDIA, 'image_two.jpg', 'image_two_2.jpg']
+        ];
+    }
+}

dev/tests/integration/testsuite/Magento/Framework/File/_files/framework_file_name.php

@@ -0,0 +1,28 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+use Magento\Framework\App\Filesystem\DirectoryList;
+
+$objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
+
+/** @var $mediaDirectory \Magento\Framework\Filesystem\Directory\WriteInterface */
+$mediaDirectory = $objectManager->get(\Magento\Framework\Filesystem::class)->getDirectoryWrite(DirectoryList::MEDIA);
+/** @var $varDirectory \Magento\Framework\Filesystem\Directory\WriteInterface */
+$varDirectory = $objectManager->get(\Magento\Framework\Filesystem::class)->getDirectoryWrite(DirectoryList::VAR_DIR);
+$dir = 'image';
+$mediaDirectory->create($dir);
+$imageContent = file_get_contents(__DIR__ . DIRECTORY_SEPARATOR . 'magento_small_image.jpg');
+
+$mediaDriver = $mediaDirectory->getDriver();
+$mediaDriver->filePutContents($mediaDirectory->getAbsolutePath($dir . '/image_one.jpg'), $imageContent);
+$mediaDriver->filePutContents($mediaDirectory->getAbsolutePath($dir . '/image_two.jpg'), $imageContent);
+$mediaDriver->filePutContents($mediaDirectory->getAbsolutePath($dir . '/image_two_1.jpg'), $imageContent);
+
+$varDirectory->create($dir);
+$varDirectory->getDriver()->filePutContents($varDirectory->getAbsolutePath($dir . '/image_one.jpg'), $imageContent);
+
+unset($imageContent);

dev/tests/integration/testsuite/Magento/Framework/File/_files/framework_file_name_rollback.php

@@ -0,0 +1,19 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+use Magento\Framework\App\Filesystem\DirectoryList;
+
+$fileSystem = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()->get(
+    \Magento\Framework\Filesystem::class
+);
+/** @var \Magento\Framework\Filesystem\Directory\WriteInterface $mediaDirectory */
+$mediaDirectory = $fileSystem->getDirectoryWrite(DirectoryList::MEDIA);
+/** @var \Magento\Framework\Filesystem\Directory\WriteInterface $varDirectory */
+$varDirectory = $fileSystem->getDirectoryWrite(DirectoryList::VAR_DIR);
+
+$mediaDirectory->delete('image');
+$varDirectory->delete('image');

dev/tests/integration/testsuite/Magento/Framework/File/_files/magento_small_image.jpg

@@ -8,57 +8,84 @@
 namespace Magento\Framework\File;
 
 use Magento\Framework\App\Filesystem\DirectoryList;
+use Magento\Framework\App\ObjectManager;
 use Magento\Framework\Exception\FileSystemException;
-use Magento\Framework\Validation\ValidationException;
+use Magento\Framework\Filesystem;
+use \Magento\Framework\Filesystem\DriverInterface;
 
 /**
  * Utility for generating a unique file name
  */
 class Name
 {
     /**
-     * Get new file name if the given name is in use
+     * @var Filesystem
+     */
+    private $filesystem;
+
+    /**
+     * @param Filesystem|null $filesystem
+     */
+    public function __construct(Filesystem $filesystem = null)
+    {
+        $this->filesystem = $filesystem ?: ObjectManager::getInstance()->get(Filesystem::class);
+    }
+
+    /**
+     * Gets new file name if the given name is in use
      *
      * @param string $destinationFile
      * @return string
+     * @throws \Magento\Framework\Exception\FileSystemException
      */
     public function getNewFileName(string $destinationFile)
     {
         $fileInfo = $this->getPathInfo($destinationFile);
-        if ($this->fileExist($destinationFile)) {
-            $index = 1;
-            $baseName = $fileInfo['filename'] . '.' . $fileInfo['extension'];
-            while ($this->fileExist($fileInfo['dirname'] . '/' . $baseName)) {
-                $baseName = $fileInfo['filename'] . '_' . $index . '.' . $fileInfo['extension'];
-                $index++;
-            }
-            $destFileName = $baseName;
-        } else {
-            return $fileInfo['basename'];
+        $driver = $this->filesystem->getDirectoryWrite(
+            DirectoryList::ROOT,
+            Filesystem\DriverPool::FILE
+        )->getDriver();
+
+        if ($driver->isExists($destinationFile)) {
+            return $this->generateFileName($driver, $fileInfo);
         }
 
-        return $destFileName;
+        /**
+         * Try with non-local driver.
+         */
+        $driver = $this->filesystem->getDirectoryWrite(DirectoryList::ROOT)->getDriver();
+
+        return $driver->isExists($destinationFile)
+            ? $this->generateFileName($driver, $fileInfo)
+            : $fileInfo['basename'];
     }
 
     /**
-     * Get the path information from a given file
+     * Generates new file name until file with provided name doesn't exist
      *
-     * @param string $destinationFile
-     * @return string|string[]
+     * @param DriverInterface $driver
+     * @param string $fileInfo
+     * @param int $index
+     * @return string
+     * @throws FileSystemException
      */
-    private function getPathInfo(string $destinationFile)
+    private function generateFileName($driver, $fileInfo, $index = 1)
     {
-        return pathinfo($destinationFile);
+        $baseName = $fileInfo['filename'] . '_' . $index . '.' . $fileInfo['extension'];
+        if ($driver->isExists($fileInfo['dirname'] . '/' . $baseName)) {
+            return $this->generateFileName($driver, $fileInfo, ++$index);
+        }
+        return $baseName;
     }
 
     /**
-     * Check to see if a given file exists
+     * Gets the path information from a given file
      *
      * @param string $destinationFile
-     * @return bool
+     * @return string|string[]
      */
-    private function fileExist(string $destinationFile)
+    private function getPathInfo(string $destinationFile)
     {
-        return file_exists($destinationFile);
+        return pathinfo($destinationFile);
     }
 }