Fix #19872 - replace hardcoded pub path with getRelativePath call

Author: Bartlomiejsz

app/code/Magento/Catalog/Model/Category/FileInfo.php

@@ -43,6 +43,11 @@ class FileInfo
      */
     private $baseDirectory;
 
+    /**
+     * @var ReadInterface
+     */
+    private $pubDirectory;
+
     /**
      * @param Filesystem $filesystem
      * @param Mime $mime
@@ -82,6 +87,20 @@ private function getBaseDirectory()
         return $this->baseDirectory;
     }
 
+    /**
+     * Get Pub Directory read instance
+     *
+     * @return ReadInterface
+     */
+    private function getPubDirectory()
+    {
+        if (!isset($this->pubDirectory)) {
+            $this->pubDirectory = $this->filesystem->getDirectoryRead(DirectoryList::PUB);
+        }
+
+        return $this->pubDirectory;
+    }
+
     /**
      * Retrieve MIME type of requested file
      *
@@ -174,11 +193,13 @@ public function isBeginsWithMediaDirectoryPath($fileName)
      */
     private function getMediaDirectoryPathRelativeToBaseDirectoryPath(string $filePath = '')
     {
-        $baseDirectoryPath = $this->getBaseDirectory()->getAbsolutePath();
+        $baseDirectory = $this->getBaseDirectory();
+        $baseDirectoryPath = $baseDirectory->getAbsolutePath();
         $mediaDirectoryPath = $this->getMediaDirectory()->getAbsolutePath();
+        $pubDirectoryPath = $this->getPubDirectory()->getAbsolutePath();
 
         $mediaDirectoryRelativeSubpath = substr($mediaDirectoryPath, strlen($baseDirectoryPath));
-        $pubDirectory = 'pub' . DIRECTORY_SEPARATOR;
+        $pubDirectory = $baseDirectory->getRelativePath($pubDirectoryPath);
 
         if (strpos($mediaDirectoryRelativeSubpath, $pubDirectory) === 0 && strpos($filePath, $pubDirectory) !== 0) {
             $mediaDirectoryRelativeSubpath = substr($mediaDirectoryRelativeSubpath, strlen($pubDirectory));

app/code/Magento/Catalog/Test/Unit/Model/Category/FileInfoTest.php

@@ -11,29 +11,36 @@
 use Magento\Framework\Filesystem;
 use Magento\Framework\Filesystem\Directory\WriteInterface;
 use Magento\Framework\Filesystem\Directory\ReadInterface;
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
 
-class FileInfoTest extends \PHPUnit\Framework\TestCase
+class FileInfoTest extends TestCase
 {
     /**
-     * @var Filesystem|\PHPUnit_Framework_MockObject_MockObject
+     * @var Filesystem|MockObject
      */
     private $filesystem;
 
     /**
-     * @var Mime|\PHPUnit_Framework_MockObject_MockObject
+     * @var Mime|MockObject
      */
     private $mime;
 
     /**
-     * @var WriteInterface|\PHPUnit_Framework_MockObject_MockObject
+     * @var WriteInterface|MockObject
      */
     private $mediaDirectory;
 
     /**
-     * @var ReadInterface|\PHPUnit_Framework_MockObject_MockObject
+     * @var ReadInterface|MockObject
      */
     private $baseDirectory;
 
+    /**
+     * @var ReadInterface|MockObject
+     */
+    private $pubDirectory;
+
     /**
      * @var FileInfo
      */
@@ -44,31 +51,42 @@ protected function setUp()
         $this->mediaDirectory = $this->getMockBuilder(WriteInterface::class)
             ->getMockForAbstractClass();
 
-        $this->baseDirectory = $this->getMockBuilder(ReadInterface::class)
+        $this->baseDirectory = $baseDirectory = $this->getMockBuilder(ReadInterface::class)
+            ->getMockForAbstractClass();
+
+        $this->pubDirectory = $pubDirectory = $this->getMockBuilder(ReadInterface::class)
             ->getMockForAbstractClass();
 
         $this->filesystem = $this->getMockBuilder(Filesystem::class)
             ->disableOriginalConstructor()
             ->getMock();
-        $this->filesystem->expects($this->any())
-            ->method('getDirectoryWrite')
+
+        $this->filesystem->method('getDirectoryWrite')
             ->with(DirectoryList::MEDIA)
             ->willReturn($this->mediaDirectory);
 
-        $this->filesystem->expects($this->any())
-            ->method('getDirectoryRead')
-            ->with(DirectoryList::ROOT)
-            ->willReturn($this->baseDirectory);
+        $this->filesystem->method('getDirectoryRead')
+            ->willReturnCallback(function ($arg) use ($baseDirectory, $pubDirectory) {
+                if ($arg === DirectoryList::PUB) {
+                    return $pubDirectory;
+                }
+                return $baseDirectory;
+            });
 
         $this->mime = $this->getMockBuilder(Mime::class)
             ->disableOriginalConstructor()
             ->getMock();
 
-        $this->baseDirectory->expects($this->any())
-            ->method('getAbsolutePath')
-            ->with(null)
+        $this->baseDirectory->method('getAbsolutePath')
             ->willReturn('/a/b/c/');
 
+        $this->baseDirectory->method('getRelativePath')
+            ->with('/a/b/c/pub/')
+            ->willReturn('pub/');
+
+        $this->pubDirectory->method('getAbsolutePath')
+            ->willReturn('/a/b/c/pub/');
+
         $this->model = new FileInfo(
             $this->filesystem,
             $this->mime
@@ -113,13 +131,11 @@ public function testGetStat()
 
         $expected = ['size' => 1];
 
-        $this->mediaDirectory->expects($this->any())
-            ->method('getAbsolutePath')
+        $this->mediaDirectory->method('getAbsolutePath')
             ->with(null)
             ->willReturn('/a/b/c/pub/media/');
 
-        $this->mediaDirectory->expects($this->once())
-            ->method('stat')
+        $this->mediaDirectory->method('stat')
             ->with($mediaPath . $fileName)
             ->willReturn($expected);
 
@@ -137,12 +153,10 @@ public function testGetStat()
      */
     public function testIsExist($fileName, $fileMediaPath)
     {
-        $this->mediaDirectory->expects($this->any())
-            ->method('getAbsolutePath')
+        $this->mediaDirectory->method('getAbsolutePath')
             ->willReturn('/a/b/c/pub/media/');
 
-        $this->mediaDirectory->expects($this->once())
-            ->method('isExist')
+        $this->mediaDirectory->method('isExist')
             ->with($fileMediaPath)
             ->willReturn(true);
 
@@ -165,8 +179,7 @@ public function isExistProvider()
      */
     public function testIsBeginsWithMediaDirectoryPath($fileName, $expected)
     {
-        $this->mediaDirectory->expects($this->any())
-            ->method('getAbsolutePath')
+        $this->mediaDirectory->method('getAbsolutePath')
             ->willReturn('/a/b/c/pub/media/');
 
         $this->assertEquals($expected, $this->model->isBeginsWithMediaDirectoryPath($fileName));