ENGCOM-7220: Implement ActionInterface for /search/term/popular #27462

 - Merge Pull Request #27462 from Bartlomiejsz/magento2:feature/action_interface_search_term_popular
 - Merged commits:
   1. 89abdaf
   2. 8e93b14
   3. d073d72

Author: magento-engcom-team

app/code/Magento/Search/Controller/Term/Popular.php

@@ -3,59 +3,78 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Search\Controller\Term;
 
-use Magento\Framework\App\Action\Action;
-use Magento\Framework\App\Action\Context;
+use Magento\Framework\App\Action\HttpGetActionInterface;
 use Magento\Framework\App\Config\ScopeConfigInterface;
-use Magento\Framework\App\RequestInterface;
+use Magento\Framework\Controller\Result\ForwardFactory as ResultForwardFactory;
+use Magento\Framework\View\Result\PageFactory as ResultPageFactory;
 use Magento\Store\Model\ScopeInterface;
-use Magento\Framework\Controller\ResultFactory;
 
-class Popular extends Action
+/**
+ * Popular search terms page
+ */
+class Popular implements HttpGetActionInterface
 {
+    private const XML_PATH_SEO_SEARCH_TERMS = 'catalog/seo/search_terms';
+
     /**
-     * @var \Magento\Framework\App\Config\ScopeConfigInterface
+     * @var ResultForwardFactory
      */
-    protected $scopeConfig;
+    private $resultForwardFactory;
 
     /**
-     * @param \Magento\Framework\App\Action\Context $context
-     * @param \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig
+     * @var ResultPageFactory
      */
-    public function __construct(Context $context, ScopeConfigInterface $scopeConfig)
-    {
+    private $resultPageFactory;
+
+    /**
+     * @var ScopeConfigInterface
+     */
+    private $scopeConfig;
+
+    /**
+     * @param ResultForwardFactory $resultForwardFactory
+     * @param ResultPageFactory $resultPageFactory
+     * @param ScopeConfigInterface $scopeConfig
+     */
+    public function __construct(
+        ResultForwardFactory $resultForwardFactory,
+        ResultPageFactory $resultPageFactory,
+        ScopeConfigInterface $scopeConfig
+    ) {
+        $this->resultForwardFactory = $resultForwardFactory;
+        $this->resultPageFactory = $resultPageFactory;
         $this->scopeConfig = $scopeConfig;
-        parent::__construct($context);
     }
 
     /**
-     * Dispatch request
-     *
-     * @param \Magento\Framework\App\RequestInterface $request
-     * @return \Magento\Framework\App\ResponseInterface
-     * @throws \Magento\Framework\Exception\NotFoundException
+     * @inheritDoc
      */
-    public function dispatch(RequestInterface $request)
+    public function execute()
     {
-        $searchTerms = $this->scopeConfig->getValue(
-            'catalog/seo/search_terms',
-            ScopeInterface::SCOPE_STORE
-        );
-        if (!$searchTerms) {
-            $this->_redirect('noroute');
-            $this->_actionFlag->set('', self::FLAG_NO_DISPATCH, true);
+        if (!$this->checkEnabledSearchTerms()) {
+            $resultForward = $this->resultForwardFactory->create();
+            $resultForward->forward('noroute');
+
+            return $resultForward;
         }
-        return parent::dispatch($request);
+
+        return $this->resultPageFactory->create();
     }
 
     /**
-     * @return \Magento\Framework\View\Result\Page
+     * Check if search terms are enabled
+     *
+     * @return bool
      */
-    public function execute()
+    private function checkEnabledSearchTerms(): bool
     {
-        /** @var \Magento\Framework\View\Result\Page $resultPage */
-        $resultPage = $this->resultFactory->create(ResultFactory::TYPE_PAGE);
-        return $resultPage;
+        return $this->scopeConfig->isSetFlag(
+            self::XML_PATH_SEO_SEARCH_TERMS,
+            ScopeInterface::SCOPE_STORE
+        );
     }
 }

app/code/Magento/Search/Test/Unit/Controller/Term/PopularTest.php

@@ -0,0 +1,103 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Search\Test\Unit\Controller\Term;
+
+use Magento\Framework\App\Config\ScopeConfigInterface;
+use Magento\Framework\Controller\Result\Forward as ResultForward;
+use Magento\Framework\Controller\Result\ForwardFactory as ResultForwardFactory;
+use Magento\Framework\View\Result\Page as ResultPage;
+use Magento\Framework\View\Result\PageFactory as ResultPageFactory;
+use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
+use Magento\Search\Controller\Term\Popular;
+use Magento\Store\Model\ScopeInterface;
+use PHPUnit\Framework\MockObject\MockObject;
+use PHPUnit\Framework\TestCase;
+
+class PopularTest extends TestCase
+{
+    private const XML_PATH_SEO_SEARCH_TERMS = 'catalog/seo/search_terms';
+
+    /**
+     * @var Popular
+     */
+    private $action;
+
+    /**
+     * @var ResultForwardFactory|MockObject
+     */
+    private $resultForwardFactoryMock;
+
+    /**
+     * @var ResultPageFactory|MockObject
+     */
+    private $resultPageFactoryMock;
+
+    /**
+     * @var ScopeConfigInterface|MockObject
+     */
+    private $scopeConfigMock;
+
+    protected function setUp()
+    {
+        $this->resultForwardFactoryMock = $this->getMockBuilder(ResultForwardFactory::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $this->resultPageFactoryMock = $this->getMockBuilder(ResultPageFactory::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $this->scopeConfigMock = $this->getMockBuilder(ScopeConfigInterface::class)
+            ->getMockForAbstractClass();
+
+        $objectManager = new ObjectManager($this);
+        $this->action = $objectManager->getObject(
+            Popular::class,
+            [
+                'resultForwardFactory' => $this->resultForwardFactoryMock,
+                'resultPageFactory' => $this->resultPageFactoryMock,
+                'scopeConfig' => $this->scopeConfigMock
+            ]
+        );
+    }
+
+    public function testResult()
+    {
+        $this->scopeConfigMock->expects($this->once())
+            ->method('isSetFlag')
+            ->with(static::XML_PATH_SEO_SEARCH_TERMS, ScopeInterface::SCOPE_STORE)
+            ->willReturn(true);
+        $resultPageMock = $this->getMockBuilder(ResultPage::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+        $this->resultPageFactoryMock->expects($this->once())
+            ->method('create')
+            ->willReturn($resultPageMock);
+
+        $this->assertSame($resultPageMock, $this->action->execute());
+    }
+
+    public function testResultWithDisabledPage()
+    {
+        $this->scopeConfigMock->expects($this->once())
+            ->method('isSetFlag')
+            ->with(static::XML_PATH_SEO_SEARCH_TERMS, ScopeInterface::SCOPE_STORE)
+            ->willReturn(false);
+        $resultForwardMock = $this->getMockBuilder(ResultForward::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+        $this->resultForwardFactoryMock->expects($this->once())
+            ->method('create')
+            ->willReturn($resultForwardMock);
+        $resultForwardMock->expects($this->once())
+            ->method('forward')
+            ->with('noroute');
+
+        $this->assertSame($resultForwardMock, $this->action->execute());
+    }
+}