#32922 Add logic check only import css from enabled modules

Add test coverage

Author: ihor-sviziev

lib/internal/Magento/Framework/Css/Test/Unit/PreProcessor/Instruction/MagentoImportTest.php

@@ -10,6 +10,7 @@
 use Magento\Framework\Css\PreProcessor\ErrorHandlerInterface;
 use Magento\Framework\Css\PreProcessor\Instruction\Import;
 use Magento\Framework\Css\PreProcessor\Instruction\MagentoImport;
+use Magento\Framework\Module\Manager as ModuleManager;
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
 use Magento\Framework\View\Asset\File;
 use Magento\Framework\View\Asset\File\FallbackContext;
@@ -30,32 +31,37 @@ class MagentoImportTest extends TestCase
     /**
      * @var DesignInterface|MockObject
      */
-    private $design;
+    private $designMock;
 
     /**
      * @var CollectorInterface|MockObject
      */
-    private $fileSource;
+    private $fileSourceMock;
 
     /**
      * @var ErrorHandlerInterface|MockObject
      */
-    private $errorHandler;
+    private $errorHandlerMock;
 
     /**
      * @var File|MockObject
      */
-    private $asset;
+    private $assetMock;
 
     /**
      * @var Repository|MockObject
      */
-    private $assetRepo;
+    private $assetRepoMock;
 
     /**
      * @var ThemeProviderInterface|MockObject
      */
-    private $themeProvider;
+    private $themeProviderMock;
+
+    /**
+     * @var ModuleManager|MockObject
+     */
+    private $moduleManagerMock;
 
     /**
      * @var Import
@@ -64,21 +70,23 @@ class MagentoImportTest extends TestCase
 
     protected function setUp(): void
     {
-        $this->design = $this->getMockForAbstractClass(DesignInterface::class);
-        $this->fileSource = $this->getMockForAbstractClass(CollectorInterface::class);
-        $this->errorHandler = $this->getMockForAbstractClass(
-            ErrorHandlerInterface::class
-        );
-        $this->asset = $this->createMock(File::class);
-        $this->asset->expects($this->any())->method('getContentType')->willReturn('css');
-        $this->assetRepo = $this->createMock(Repository::class);
-        $this->themeProvider = $this->getMockForAbstractClass(ThemeProviderInterface::class);
+        $this->designMock = $this->getMockForAbstractClass(DesignInterface::class);
+        $this->fileSourceMock = $this->getMockForAbstractClass(CollectorInterface::class);
+        $this->errorHandlerMock = $this->getMockForAbstractClass(ErrorHandlerInterface::class);
+        $this->assetMock = $this->createMock(File::class);
+        $this->assetMock->expects($this->any())->method('getContentType')->willReturn('css');
+        $this->assetRepoMock = $this->createMock(Repository::class);
+        $this->themeProviderMock = $this->getMockForAbstractClass(ThemeProviderInterface::class);
+        $this->moduleManagerMock = $this->createMock(ModuleManager::class);
+
         $this->object = (new ObjectManager($this))->getObject(MagentoImport::class, [
-            'design' => $this->design,
-            'fileSource' => $this->fileSource,
-            'errorHandler' => $this->errorHandler,
-            'assetRepo' => $this->assetRepo,
-            'themeProvider' => $this->themeProvider
+            'design' => $this->designMock,
+            'fileSource' => $this->fileSourceMock,
+            'errorHandler' => $this->errorHandlerMock,
+            'assetRepo' => $this->assetRepoMock,
+            'moduleManager' => $this->moduleManagerMock,
+            // Mocking private property
+            'themeProvider' => $this->themeProviderMock,
         ]);
     }
 
@@ -88,24 +96,32 @@ protected function setUp(): void
      * @param string $resolvedPath
      * @param array $foundFiles
      * @param string $expectedContent
+     * @param array $enabledModules
      *
      * @dataProvider processDataProvider
      */
-    public function testProcess($originalContent, $foundPath, $resolvedPath, $foundFiles, $expectedContent)
+    public function testProcess(
+        string $originalContent,
+        string $foundPath,
+        string $resolvedPath,
+        array $foundFiles,
+        string $expectedContent,
+        array $enabledModules
+    ): void
     {
-        $chain = new Chain($this->asset, $originalContent, 'css', 'path');
+        $chain = new Chain($this->assetMock, $originalContent, 'css', 'path');
         $relatedAsset = $this->createMock(File::class);
         $relatedAsset->expects($this->once())
             ->method('getFilePath')
             ->willReturn($resolvedPath);
         $context = $this->createMock(FallbackContext::class);
-        $this->assetRepo->expects($this->once())
+        $this->assetRepoMock->expects($this->once())
             ->method('createRelated')
-            ->with($foundPath, $this->asset)
+            ->with($foundPath, $this->assetMock)
             ->willReturn($relatedAsset);
         $relatedAsset->expects($this->once())->method('getContext')->willReturn($context);
         $theme = $this->getMockForAbstractClass(ThemeInterface::class);
-        $this->themeProvider->expects($this->once())->method('getThemeByFullPath')->willReturn($theme);
+        $this->themeProviderMock->expects($this->once())->method('getThemeByFullPath')->willReturn($theme);
         $files = [];
         foreach ($foundFiles as $file) {
             $fileObject = $this->createMock(\Magento\Framework\View\File::class);
@@ -117,10 +133,16 @@ public function testProcess($originalContent, $foundPath, $resolvedPath, $foundF
                 ->willReturn($file['filename']);
             $files[] = $fileObject;
         }
-        $this->fileSource->expects($this->once())
+        $this->fileSourceMock->expects($this->once())
             ->method('getFiles')
             ->with($theme, $resolvedPath)
             ->willReturn($files);
+
+        $this->moduleManagerMock->expects($this->any())->method('isEnabled')
+            ->willReturnCallback(function ($moduleName) use ($enabledModules) {
+                return in_array($moduleName, $enabledModules, true);
+            });
+
         $this->object->process($chain);
         $this->assertEquals($expectedContent, $chain->getContent());
         $this->assertEquals('css', $chain->getContentType());
@@ -129,7 +151,7 @@ public function testProcess($originalContent, $foundPath, $resolvedPath, $foundF
     /**
      * @return array
      */
-    public function processDataProvider()
+    public function processDataProvider(): array
     {
         return [
             'non-modular notation' => [
@@ -141,6 +163,7 @@ public function processDataProvider()
                     ['module' => null, 'filename' => 'theme/some/file.css'],
                 ],
                 "@import 'some/file.css';\n@import 'some/file.css';\n",
+                [],
             ],
             'modular' => [
                 '//@magento_import "Magento_Module::some/file.css";',
@@ -151,6 +174,29 @@ public function processDataProvider()
                     ['module' => 'Magento_Two', 'filename' => 'some/file.css'],
                 ],
                 "@import 'Magento_Module::some/file.css';\n@import 'Magento_Two::some/file.css';\n",
+                ['Magento_Module', 'Magento_Two'],
+            ],
+            'modular with disabled module' => [
+                '//@magento_import "Magento_Module::some/file.css";',
+                'Magento_Module::some/file.css',
+                'some/file.css',
+                [
+                    ['module' => 'Magento_Module', 'filename' => 'some/file.css'],
+                    ['module' => 'Magento_Two', 'filename' => 'some/file.css'],
+                ],
+                "@import 'Magento_Two::some/file.css';\n",
+                ['Magento_Two'],
+            ],
+            'modular with disabled all modules' => [
+                '//@magento_import "Magento_Module::some/file.css";',
+                'Magento_Module::some/file.css',
+                'some/file.css',
+                [
+                    ['module' => 'Magento_Module', 'filename' => 'some/file.css'],
+                    ['module' => 'Magento_Two', 'filename' => 'some/file.css'],
+                ],
+                '',
+                [],
             ],
             'non-modular reference notation' => [
                 '//@magento_import (reference) "some/file.css";',
@@ -161,6 +207,7 @@ public function processDataProvider()
                     ['module' => null, 'filename' => 'theme/some/file.css'],
                 ],
                 "@import (reference) 'some/file.css';\n@import (reference) 'some/file.css';\n",
+                [],
             ],
             'modular reference' => [
                 '//@magento_import (reference) "Magento_Module::some/file.css";',
@@ -172,35 +219,58 @@ public function processDataProvider()
                 ],
                 "@import (reference) 'Magento_Module::some/file.css';\n" .
                 "@import (reference) 'Magento_Two::some/file.css';\n",
+                ['Magento_Module', 'Magento_Two'],
+            ],
+            'modular reference with disabled module' => [
+                '//@magento_import (reference) "Magento_Module::some/file.css";',
+                'Magento_Module::some/file.css',
+                'some/file.css',
+                [
+                    ['module' => 'Magento_Module', 'filename' => 'some/file.css'],
+                    ['module' => 'Magento_Two', 'filename' => 'some/file.css'],
+                ],
+                "@import (reference) 'Magento_Module::some/file.css';\n",
+                ['Magento_Module'],
+            ],
+            'modular reference with disabled all modules' => [
+                '//@magento_import (reference) "Magento_Module::some/file.css";',
+                'Magento_Module::some/file.css',
+                'some/file.css',
+                [
+                    ['module' => 'Magento_Module', 'filename' => 'some/file.css'],
+                    ['module' => 'Magento_Two', 'filename' => 'some/file.css'],
+                ],
+                '',
+                [],
             ],
         ];
     }
 
-    public function testProcessNoImport()
+    public function testProcessNoImport(): void
     {
         $originalContent = 'color: #000000;';
         $expectedContent = 'color: #000000;';
-        $chain = new Chain($this->asset, $originalContent, 'css', 'orig');
-        $this->assetRepo->expects($this->never())
+        $chain = new Chain($this->assetMock, $originalContent, 'css', 'orig');
+        $this->assetRepoMock->expects($this->never())
             ->method('createRelated');
         $this->object->process($chain);
         $this->assertEquals($expectedContent, $chain->getContent());
         $this->assertEquals('css', $chain->getContentType());
     }
 
-    public function testProcessException()
+    public function testProcessException(): void
     {
         $chain = new Chain(
-            $this->asset,
+            $this->assetMock,
             '//@magento_import "some/file.css";',
             'css',
             'path'
         );
         $exception = new \LogicException('Error happened');
-        $this->assetRepo->expects($this->once())
+        $this->assetRepoMock->expects($this->once())
             ->method('createRelated')
             ->willThrowException($exception);
-        $this->errorHandler->expects($this->once())
+        $this->errorHandlerMock->expects($this->once())
             ->method('processException')
             ->with($exception);
         $this->object->process($chain);