ENGCOM-7198: Implement ActionInterface for /version/ #27425

 - Merge Pull Request #27425 from lbajsarowicz/magento2:refactor/version-index-index
 - Merged commits:
   1. e849f39
   2. a67d063

Author: magento-engcom-team

app/code/Magento/Version/Controller/Index/Index.php

@@ -1,58 +1,61 @@
 <?php
 /**
- *
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
 declare(strict_types=1);
 
 namespace Magento\Version\Controller\Index;
 
-use Magento\Framework\App\Action\Action;
-use Magento\Framework\App\Action\Context;
-use Magento\Framework\App\Action\HttpGetActionInterface as HttpGetActionInterface;
+use Magento\Framework\App\Action\HttpGetActionInterface;
 use Magento\Framework\App\ProductMetadataInterface;
+use Magento\Framework\Controller\Result\RawFactory as RawResponseFactory;
 
 /**
- * Magento Version controller
+ * Magento Version controller: Sets the response body to ProductName/Major.MinorVersion (Edition).
  */
-class Index extends Action implements HttpGetActionInterface
+class Index implements HttpGetActionInterface
 {
     const DEV_PREFIX = 'dev-';
 
     /**
      * @var ProductMetadataInterface
      */
-    protected $productMetadata;
+    private $productMetadata;
 
     /**
-     * @param Context $context
+     * @var RawResponseFactory
+     */
+    private $rawFactory;
+
+    /**
+     * @param RawResponseFactory $rawFactory
      * @param ProductMetadataInterface $productMetadata
      */
-    public function __construct(Context $context, ProductMetadataInterface $productMetadata)
+    public function __construct(RawResponseFactory $rawFactory, ProductMetadataInterface $productMetadata)
     {
+        $this->rawFactory = $rawFactory;
         $this->productMetadata = $productMetadata;
-        parent::__construct($context);
     }
 
     /**
-     * Sets the response body to ProductName/Major.MinorVersion (Edition).
-     *
-     * @return void
+     * @inheritDoc
      */
-    public function execute(): void
+    public function execute()
     {
+        $rawResponse = $this->rawFactory->create();
+
         $version = $this->productMetadata->getVersion();
         $versionParts = explode('.', $version);
-        if ($this->isGitBasedInstallation($version) || !$this->isCorrectVersion($versionParts)) {
-            return;
+        if (!$this->isGitBasedInstallation($version) && $this->isCorrectVersion($versionParts)) {
+            $rawResponse->setContents(
+                $this->productMetadata->getName() . '/' .
+                $this->getMajorMinorVersion($versionParts) .
+                ' (' . $this->productMetadata->getEdition() . ')'
+            );
         }
 
-        $this->getResponse()->setBody(
-            $this->productMetadata->getName() . '/' .
-            $this->getMajorMinorVersion($versionParts) .
-            ' (' . $this->productMetadata->getEdition() . ')'
-        );
+        return $rawResponse;
     }
 
     /**

app/code/Magento/Version/Test/Unit/Controller/Index/IndexTest.php

@@ -7,67 +7,43 @@
 
 namespace Magento\Version\Test\Unit\Controller\Index;
 
-use Magento\Framework\App\Action\Context;
 use Magento\Framework\App\ProductMetadataInterface;
 use Magento\Framework\App\ResponseInterface;
-use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
+use Magento\Framework\Controller\Result\Raw;
+use Magento\Framework\Controller\Result\RawFactory;
 use Magento\Version\Controller\Index\Index as VersionIndex;
+use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 
 class IndexTest extends TestCase
 {
-    /**
-     * @var VersionIndex
-     */
-    private $model;
-
-    /**
-     * @var Context
-     */
-    private $contextMock;
+    /** @var VersionIndex */
+    private $versionController;
 
-    /**
-     * @var ProductMetadataInterface
-     */
+    /** @var MockObject|ProductMetadataInterface */
     private $productMetadataMock;
 
-    /**
-     * @var ResponseInterface
-     */
-    private $responseMock;
+    /** @var MockObject|RawFactory */
+    private $rawResponseFactoryMock;
+
+    /** @var MockObject|Raw */
+    private $rawResponseMock;
 
     /**
      * Prepare test preconditions
      */
     protected function setUp()
     {
-        $this->contextMock = $this->getMockBuilder(Context::class)
-            ->disableOriginalConstructor()
-            ->getMock();
-
         $this->productMetadataMock = $this->getMockBuilder(ProductMetadataInterface::class)
             ->disableOriginalConstructor()
             ->setMethods(['getName', 'getEdition', 'getVersion'])
             ->getMock();
 
-        $this->responseMock = $this->getMockBuilder(ResponseInterface::class)
-            ->disableOriginalConstructor()
-            ->setMethods(['setBody', 'sendResponse'])
-            ->getMock();
-
-        $this->contextMock->expects($this->any())
-            ->method('getResponse')
-            ->willReturn($this->responseMock);
-
-        $objectManager = new ObjectManager($this);
+        $this->rawResponseFactoryMock = $this->createPartialMock(RawFactory::class, ['create']);
+        $this->rawResponseMock = $this->createPartialMock(Raw::class, ['setContents']);
+        $this->rawResponseFactoryMock->method('create')->willReturn($this->rawResponseMock);
 
-        $this->model = $objectManager->getObject(
-            VersionIndex::class,
-            [
-                'context' => $this->contextMock,
-                'productMetadata' => $this->productMetadataMock
-            ]
-        );
+        $this->versionController = new VersionIndex($this->rawResponseFactoryMock, $this->productMetadataMock);
     }
 
     /**
@@ -79,10 +55,10 @@ public function testGitBasedInstallationDoesNotReturnVersion(): void
             ->method('getVersion')
             ->willReturn('dev-2.3');
 
-        $this->responseMock->expects($this->never())
-            ->method('setBody');
+        $this->rawResponseMock->expects($this->never())
+            ->method('setContents');
 
-        $this->assertNull($this->model->execute());
+        $this->versionController->execute();
     }
 
     /**
@@ -94,10 +70,10 @@ public function testCommunityVersionDisplaysMajorMinorVersionAndEditionName(): v
         $this->productMetadataMock->expects($this->any())->method('getEdition')->willReturn('Community');
         $this->productMetadataMock->expects($this->any())->method('getName')->willReturn('Magento');
 
-        $this->responseMock->expects($this->once())->method('setBody')
+        $this->rawResponseMock->expects($this->once())->method('setContents')
             ->with('Magento/2.3 (Community)')
             ->will($this->returnSelf());
 
-        $this->model->execute();
+        $this->versionController->execute();
     }
 }