Refactor and unit test for issue 25893

Author: edenduong

app/code/Magento/Cms/Controller/Adminhtml/Wysiwyg/Directive.php

@@ -13,6 +13,14 @@
 use Magento\Cms\Model\Template\Filter;
 use Magento\Cms\Model\Wysiwyg\Config;
 use Magento\Framework\App\Action\HttpGetActionInterface;
+use Magento\Framework\Image\Adapter\AdapterInterface;
+use Magento\Framework\Image\AdapterFactory;
+use Psr\Log\LoggerInterface;
+use Magento\Framework\Url\DecoderInterface;
+use Magento\Framework\Controller\Result\Raw;
+use Magento\Framework\Controller\Result\RawFactory;
+use Magento\Backend\App\Action\Context;
+use Magento\Framework\App\ObjectManager;
 
 /**
  * Process template text for wysiwyg editor.
@@ -30,61 +38,93 @@ class Directive extends Action implements HttpGetActionInterface
     const ADMIN_RESOURCE = 'Magento_Cms::media_gallery';
 
     /**
-     * @var \Magento\Framework\Url\DecoderInterface
+     * @var DecoderInterface
      */
     protected $urlDecoder;
 
     /**
-     * @var \Magento\Framework\Controller\Result\RawFactory
+     * @var RawFactory
      */
     protected $resultRawFactory;
 
     /**
-     * @param Action\Context $context
-     * @param \Magento\Framework\Url\DecoderInterface $urlDecoder
-     * @param \Magento\Framework\Controller\Result\RawFactory $resultRawFactory
+     * @var LoggerInterface
+     */
+    private $logger;
+
+    /**
+     * @var AdapterFactory
+     */
+    private $adapterFactory;
+
+    /**
+     * @var Config
+     */
+    private $config;
+
+    /**
+     * @var Filter
+     */
+    private $filter;
+
+    /**
+     * Constructor
+     *
+     * @param Context $context
+     * @param DecoderInterface $urlDecoder
+     * @param RawFactory $resultRawFactory
+     * @param AdapterFactory|null $adapterFactory
+     * @param LoggerInterface|null $logger
+     * @param Config|null $config
+     * @param Filter|null $filter
      */
     public function __construct(
-        Action\Context $context,
-        \Magento\Framework\Url\DecoderInterface $urlDecoder,
-        \Magento\Framework\Controller\Result\RawFactory $resultRawFactory
+        Context $context,
+        DecoderInterface $urlDecoder,
+        RawFactory $resultRawFactory,
+        AdapterFactory $adapterFactory = null,
+        LoggerInterface $logger = null,
+        Config $config = null,
+        Filter $filter = null
     ) {
         parent::__construct($context);
         $this->urlDecoder = $urlDecoder;
         $this->resultRawFactory = $resultRawFactory;
+        $this->adapterFactory = $adapterFactory ?: ObjectManager::getInstance()->get(AdapterFactory::class);
+        $this->logger = $logger ?: ObjectManager::getInstance()->get(LoggerInterface::class);
+        $this->config = $config ?: ObjectManager::getInstance()->get(Config::class);
+        $this->filter = $filter ?: ObjectManager::getInstance()->get(Filter::class);
     }
 
     /**
      * Template directives callback
      *
-     * @return \Magento\Framework\Controller\Result\Raw
+     * @return Raw
      */
     public function execute()
     {
         $directive = $this->getRequest()->getParam('___directive');
         $directive = $this->urlDecoder->decode($directive);
         try {
             /** @var Filter $filter */
-            $filter = $this->_objectManager->create(Filter::class);
-            $imagePath = $filter->filter($directive);
-            /** @var \Magento\Framework\Image\Adapter\AdapterInterface $image */
-            $image = $this->_objectManager->get(\Magento\Framework\Image\AdapterFactory::class)->create();
-            /** @var \Magento\Framework\Controller\Result\Raw $resultRaw */
+            $imagePath = $this->filter->filter($directive);
+            /** @var AdapterInterface $image */
+            $image = $this->adapterFactory->create();
+            /** @var Raw $resultRaw */
             $resultRaw = $this->resultRawFactory->create();
             $image->open($imagePath);
             $resultRaw->setHeader('Content-Type', $image->getMimeType());
             $resultRaw->setContents($image->getImage());
         } catch (\Exception $e) {
             /** @var Config $config */
-            $config = $this->_objectManager->get(Config::class);
-            $imagePath = $config->getSkinImagePlaceholderPath();
+            $imagePath = $this->config->getSkinImagePlaceholderPath();
             try {
                 $image->open($imagePath);
                 $resultRaw->setHeader('Content-Type', $image->getMimeType());
                 $resultRaw->setContents($image->getImage());
-                $this->_objectManager->get(\Psr\Log\LoggerInterface::class)->critical($e);
+                $this->logger->warning($e);
             } catch (\Exception $e) {
-                $this->_objectManager->get(\Psr\Log\LoggerInterface::class)->critical($e);
+                $this->logger->warning($e);
             }
         }
         return $resultRaw;

app/code/Magento/Cms/Test/Unit/Controller/Adminhtml/Wysiwyg/DirectiveTest.php

@@ -151,7 +151,11 @@ protected function setUp()
             [
                 'context' => $this->actionContextMock,
                 'urlDecoder' => $this->urlDecoderMock,
-                'resultRawFactory' => $this->rawFactoryMock
+                'resultRawFactory' => $this->rawFactoryMock,
+                'adapterFactory' => $this->imageAdapterFactoryMock,
+                'logger' => $this->loggerMock,
+                'config' => $this->wysiwygConfigMock,
+                'filter' => $this->templateFilterMock
             ]
         );
     }
@@ -228,7 +232,7 @@ public function testExecuteException()
             ->method('getImage')
             ->willReturn($imageBody);
         $this->loggerMock->expects($this->once())
-            ->method('critical')
+            ->method('warning')
             ->with($exception);
         $this->rawFactoryMock->expects($this->any())
             ->method('create')
@@ -253,23 +257,12 @@ protected function prepareExecuteTest()
             ->method('decode')
             ->with($directiveParam)
             ->willReturn($directive);
-        $this->objectManagerMock->expects($this->once())
-            ->method('create')
-            ->with(\Magento\Cms\Model\Template\Filter::class)
-            ->willReturn($this->templateFilterMock);
+
         $this->templateFilterMock->expects($this->once())
             ->method('filter')
             ->with($directive)
             ->willReturn(self::IMAGE_PATH);
-        $this->objectManagerMock->expects($this->any())
-            ->method('get')
-            ->willReturnMap(
-                [
-                    [\Magento\Framework\Image\AdapterFactory::class, $this->imageAdapterFactoryMock],
-                    [\Magento\Cms\Model\Wysiwyg\Config::class, $this->wysiwygConfigMock],
-                    [\Psr\Log\LoggerInterface::class, $this->loggerMock]
-                ]
-            );
+
         $this->imageAdapterFactoryMock->expects($this->once())
             ->method('create')
             ->willReturn($this->imageAdapterMock);
@@ -301,7 +294,7 @@ public function testExecuteWithDeletedImage()
             ->willThrowException($exception);
 
         $this->loggerMock->expects($this->once())
-            ->method('critical')
+            ->method('warning')
             ->with($exception);
 
         $this->wysiwygDirective->execute();