MAGETWO-98233: Fix incorrect samples behavior

SeruyV · SeruyV · commit 089efd2b7e37 · 2019-04-12T17:21:27.000+03:00
diff --git a/app/code/Magento/Catalog/Model/Product/SalabilityChecker.php b/app/code/Magento/Catalog/Model/Product/SalabilityChecker.php
@@ -0,0 +1,56 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+
+namespace Magento\Catalog\Model\Product;
+
+use Magento\Catalog\Api\ProductRepositoryInterface;
+use Magento\Store\Model\StoreManagerInterface;
+
+/**
+ * Class to check that product is saleable.
+ */
+class SalabilityChecker
+{
+    /**
+     * @var ProductRepositoryInterface
+     */
+    private $productRepository;
+
+    /**
+     * @var StoreManagerInterface
+     */
+    private $storeManager;
+
+    /**
+     * @param ProductRepositoryInterface $productRepository
+     * @param StoreManagerInterface $storeManager
+     */
+    public function __construct(
+        ProductRepositoryInterface $productRepository,
+        StoreManagerInterface $storeManager
+    ) {
+        $this->productRepository = $productRepository;
+        $this->storeManager = $storeManager;
+    }
+
+    /**
+     * Check if product is salable.
+     *
+     * @param int $productId
+     * @param int|null $storeId
+     * @return bool
+     */
+    public function isSalable($productId, $storeId = null)
+    {
+        if ($storeId === null) {
+            $storeId = $this->storeManager->getStore()->getId();
+        }
+        /** @var \Magento\Catalog\Model\Product $product */
+        $product = $this->productRepository->getById($productId, false, $storeId);
+
+        return $product->isSalable();
+    }
+}
diff --git a/app/code/Magento/Downloadable/Controller/Download/LinkSample.php b/app/code/Magento/Downloadable/Controller/Download/LinkSample.php
@@ -6,13 +6,35 @@
  */
 namespace Magento\Downloadable\Controller\Download;
 
+use Magento\Catalog\Model\Product\SalabilityChecker;
 use Magento\Downloadable\Helper\Download as DownloadHelper;
+use Magento\Framework\App\Action\Context;
 use Magento\Framework\App\ResponseInterface;
 
+/**
+ * Class LinkSample executes download sample link action.
+ */
 class LinkSample extends \Magento\Downloadable\Controller\Download
 {
     /**
-     * Download link's sample action
+     * @var SalabilityChecker
+     */
+    private $salabilityChecker;
+
+    /**
+     * @param Context $context
+     * @param SalabilityChecker|null $salabilityChecker
+     */
+    public function __construct(
+        Context $context,
+        SalabilityChecker $salabilityChecker = null
+    ) {
+        parent::__construct($context);
+        $this->salabilityChecker = $salabilityChecker ?: $this->_objectManager->get(SalabilityChecker::class);
+    }
+
+    /**
+     * Download link's sample action.
      *
      * @return ResponseInterface
      * @SuppressWarnings(PHPMD.ExitExpression)
@@ -21,16 +43,16 @@ public function execute()
     {
         $linkId = $this->getRequest()->getParam('link_id', 0);
         /** @var \Magento\Downloadable\Model\Link $link */
-        $link = $this->_objectManager->create('Magento\Downloadable\Model\Link')->load($linkId);
-        if ($link->getId()) {
+        $link = $this->_objectManager->create(\Magento\Downloadable\Model\Link::class)->load($linkId);
+        if ($link->getId() && $this->salabilityChecker->isSalable($link->getProductId())) {
             $resource = '';
             $resourceType = '';
             if ($link->getSampleType() == DownloadHelper::LINK_TYPE_URL) {
                 $resource = $link->getSampleUrl();
                 $resourceType = DownloadHelper::LINK_TYPE_URL;
             } elseif ($link->getSampleType() == DownloadHelper::LINK_TYPE_FILE) {
                 $resource = $this->_objectManager->get(
-                    'Magento\Downloadable\Helper\File'
+                    \Magento\Downloadable\Helper\File::class
                 )->getFilePath(
                     $this->_getLink()->getBaseSamplePath(),
                     $link->getSampleFile()
@@ -46,6 +68,7 @@ public function execute()
                 );
             }
         }
+
         return $this->getResponse()->setRedirect($this->_redirect->getRedirectUrl());
     }
 }
diff --git a/app/code/Magento/Downloadable/Controller/Download/Sample.php b/app/code/Magento/Downloadable/Controller/Download/Sample.php
@@ -6,13 +6,35 @@
  */
 namespace Magento\Downloadable\Controller\Download;
 
+use Magento\Catalog\Model\Product\SalabilityChecker;
 use Magento\Downloadable\Helper\Download as DownloadHelper;
+use Magento\Framework\App\Action\Context;
 use Magento\Framework\App\ResponseInterface;
 
+/**
+ * Class Sample executes download sample action.
+ */
 class Sample extends \Magento\Downloadable\Controller\Download
 {
     /**
-     * Download sample action
+     * @var SalabilityChecker
+     */
+    private $salabilityChecker;
+
+    /**
+     * @param Context $context
+     * @param SalabilityChecker|null $salabilityChecker
+     */
+    public function __construct(
+        Context $context,
+        SalabilityChecker $salabilityChecker = null
+    ) {
+        parent::__construct($context);
+        $this->salabilityChecker = $salabilityChecker ?: $this->_objectManager->get(SalabilityChecker::class);
+    }
+
+    /**
+     * Download sample action.
      *
      * @return ResponseInterface
      * @SuppressWarnings(PHPMD.ExitExpression)
@@ -21,16 +43,16 @@ public function execute()
     {
         $sampleId = $this->getRequest()->getParam('sample_id', 0);
         /** @var \Magento\Downloadable\Model\Sample $sample */
-        $sample = $this->_objectManager->create('Magento\Downloadable\Model\Sample')->load($sampleId);
-        if ($sample->getId()) {
+        $sample = $this->_objectManager->create(\Magento\Downloadable\Model\Sample::class)->load($sampleId);
+        if ($sample->getId() && $this->salabilityChecker->isSalable($sample->getProductId())) {
             $resource = '';
             $resourceType = '';
             if ($sample->getSampleType() == DownloadHelper::LINK_TYPE_URL) {
                 $resource = $sample->getSampleUrl();
                 $resourceType = DownloadHelper::LINK_TYPE_URL;
             } elseif ($sample->getSampleType() == DownloadHelper::LINK_TYPE_FILE) {
                 /** @var \Magento\Downloadable\Helper\File $helper */
-                $helper = $this->_objectManager->get('Magento\Downloadable\Helper\File');
+                $helper = $this->_objectManager->get(\Magento\Downloadable\Helper\File::class);
                 $resource = $helper->getFilePath($sample->getBasePath(), $sample->getSampleFile());
                 $resourceType = DownloadHelper::LINK_TYPE_FILE;
             }
@@ -43,6 +65,7 @@ public function execute()
                 );
             }
         }
+
         return $this->getResponse()->setRedirect($this->_redirect->getRedirectUrl());
     }
 }
diff --git a/app/code/Magento/Downloadable/Test/Unit/Controller/Download/LinkSampleTest.php b/app/code/Magento/Downloadable/Test/Unit/Controller/Download/LinkSampleTest.php
@@ -7,6 +7,11 @@
 
 use Magento\Framework\TestFramework\Unit\Helper\ObjectManager as ObjectManagerHelper;
 
+/**
+ * Unit tests for \Magento\Downloadable\Controller\Download\LinkSample.
+ *
+ * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ */
 class LinkSampleTest extends \PHPUnit_Framework_TestCase
 {
     /** @var \Magento\Downloadable\Controller\Download\LinkSample */
@@ -60,16 +65,21 @@ class LinkSampleTest extends \PHPUnit_Framework_TestCase
      */
     protected $urlInterface;
 
+    /**
+     * @var \Magento\Catalog\Model\Product\SalabilityChecker|\PHPUnit_Framework_MockObject_MockObject
+     */
+    private $salabilityCheckerMock;
+
     /**
      * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
      */
     protected function setUp()
     {
         $this->objectManagerHelper = new ObjectManagerHelper($this);
 
-        $this->request = $this->getMock('Magento\Framework\App\RequestInterface');
+        $this->request = $this->getMock(\Magento\Framework\App\RequestInterface::class);
         $this->response = $this->getMock(
-            '\Magento\Framework\App\ResponseInterface',
+            \Magento\Framework\App\ResponseInterface::class,
             [
                 'setHttpResponseCode',
                 'clearBody',
@@ -81,7 +91,7 @@ protected function setUp()
         );
 
         $this->helperData = $this->getMock(
-            'Magento\Downloadable\Helper\Data',
+            \Magento\Downloadable\Helper\Data::class,
             [
                 'getIsShareable'
             ],
@@ -90,7 +100,7 @@ protected function setUp()
             false
         );
         $this->downloadHelper = $this->getMock(
-            'Magento\Downloadable\Helper\Download',
+            \Magento\Downloadable\Helper\Download::class,
             [
                 'setResource',
                 'getFilename',
@@ -104,7 +114,7 @@ protected function setUp()
             false
         );
         $this->product = $this->getMock(
-            'Magento\Catalog\Model\Product',
+            \Magento\Catalog\Model\Product::class,
             [
                 '_wakeup',
                 'load',
@@ -117,28 +127,28 @@ protected function setUp()
             false
         );
         $this->messageManager = $this->getMock(
-            'Magento\Framework\Message\ManagerInterface',
+            \Magento\Framework\Message\ManagerInterface::class,
             [],
             [],
             '',
             false
         );
         $this->redirect = $this->getMock(
-            'Magento\Framework\App\Response\RedirectInterface',
+            \Magento\Framework\App\Response\RedirectInterface::class,
             [],
             [],
             '',
             false
         );
         $this->urlInterface = $this->getMock(
-            'Magento\Framework\UrlInterface',
+            \Magento\Framework\UrlInterface::class,
             [],
             [],
             '',
             false
         );
         $this->objectManager = $this->getMock(
-            '\Magento\Framework\ObjectManager\ObjectManager',
+            \Magento\Framework\ObjectManager\ObjectManager::class,
             [
                 'create',
                 'get'
@@ -147,39 +157,53 @@ protected function setUp()
             '',
             false
         );
+        $this->salabilityCheckerMock = $this->getMock(
+            \Magento\Catalog\Model\Product\SalabilityChecker::class,
+            ['isSalable'],
+            [],
+            '',
+            false
+        );
         $this->linkSample = $this->objectManagerHelper->getObject(
-            'Magento\Downloadable\Controller\Download\LinkSample',
+            \Magento\Downloadable\Controller\Download\LinkSample::class,
             [
                 'objectManager' => $this->objectManager,
                 'request' => $this->request,
                 'response' => $this->response,
                 'messageManager' => $this->messageManager,
-                'redirect' => $this->redirect
+                'redirect' => $this->redirect,
+                'salabilityChecker' => $this->salabilityCheckerMock,
             ]
         );
     }
 
+    /**
+     * Execute Download link's sample action with Url link.
+     *
+     * @return void
+     */
     public function testExecuteLinkTypeUrl()
     {
-        $linkMock = $this->getMockBuilder('Magento\Downloadable\Model\Link')
+        $linkMock = $this->getMockBuilder(\Magento\Downloadable\Model\Link::class)
             ->disableOriginalConstructor()
             ->setMethods(['getId', 'load', 'getSampleType', 'getSampleUrl'])
             ->getMock();
 
         $this->request->expects($this->once())->method('getParam')->with('link_id', 0)->willReturn('some_link_id');
         $this->objectManager->expects($this->once())
             ->method('create')
-            ->with('Magento\Downloadable\Model\Link')
+            ->with(\Magento\Downloadable\Model\Link::class)
             ->willReturn($linkMock);
         $linkMock->expects($this->once())->method('load')->with('some_link_id')->willReturnSelf();
         $linkMock->expects($this->once())->method('getId')->willReturn('some_link_id');
+        $this->salabilityCheckerMock->expects($this->once())->method('isSalable')->willReturn(true);
         $linkMock->expects($this->once())->method('getSampleType')->willReturn(
             \Magento\Downloadable\Helper\Download::LINK_TYPE_URL
         );
         $linkMock->expects($this->once())->method('getSampleUrl')->willReturn('sample_url');
         $this->objectManager->expects($this->at(1))
             ->method('get')
-            ->with('Magento\Downloadable\Helper\Download')
+            ->with(\Magento\Downloadable\Helper\Download::class)
             ->willReturn($this->downloadHelper);
         $this->response->expects($this->once())->method('setHttpResponseCode')->with(200)->willReturnSelf();
         $this->response->expects($this->any())->method('setHeader')->willReturnSelf();
@@ -194,39 +218,45 @@ public function testExecuteLinkTypeUrl()
         $this->assertEquals($this->response, $this->linkSample->execute());
     }
 
+    /**
+     * Execute Download link's sample action with File link.
+     *
+     * @return void
+     */
     public function testExecuteLinkTypeFile()
     {
-        $linkMock = $this->getMockBuilder('Magento\Downloadable\Model\Link')
+        $linkMock = $this->getMockBuilder(\Magento\Downloadable\Model\Link::class)
             ->disableOriginalConstructor()
             ->setMethods(['getId', 'load', 'getSampleType', 'getSampleUrl', 'getBaseSamplePath'])
             ->getMock();
-        $fileMock = $this->getMockBuilder('Magento\Downloadable\Helper\File')
+        $fileMock = $this->getMockBuilder(\Magento\Downloadable\Helper\File::class)
             ->disableOriginalConstructor()
             ->setMethods(['getFilePath', 'load', 'getSampleType', 'getSampleUrl'])
             ->getMock();
 
         $this->request->expects($this->once())->method('getParam')->with('link_id', 0)->willReturn('some_link_id');
         $this->objectManager->expects($this->at(0))
             ->method('create')
-            ->with('Magento\Downloadable\Model\Link')
+            ->with(\Magento\Downloadable\Model\Link::class)
             ->willReturn($linkMock);
         $linkMock->expects($this->once())->method('load')->with('some_link_id')->willReturnSelf();
         $linkMock->expects($this->once())->method('getId')->willReturn('some_link_id');
+        $this->salabilityCheckerMock->expects($this->once())->method('isSalable')->willReturn(true);
         $linkMock->expects($this->any())->method('getSampleType')->willReturn(
             \Magento\Downloadable\Helper\Download::LINK_TYPE_FILE
         );
         $this->objectManager->expects($this->at(1))
             ->method('get')
-            ->with('Magento\Downloadable\Helper\File')
+            ->with(\Magento\Downloadable\Helper\File::class)
             ->willReturn($fileMock);
         $this->objectManager->expects($this->at(2))
             ->method('get')
-            ->with('Magento\Downloadable\Model\Link')
+            ->with(\Magento\Downloadable\Model\Link::class)
             ->willReturn($linkMock);
         $linkMock->expects($this->once())->method('getBaseSamplePath')->willReturn('downloadable/files/link_samples');
         $this->objectManager->expects($this->at(3))
             ->method('get')
-            ->with('Magento\Downloadable\Helper\Download')
+            ->with(\Magento\Downloadable\Helper\Download::class)
             ->willReturn($this->downloadHelper);
         $this->response->expects($this->once())->method('setHttpResponseCode')->with(200)->willReturnSelf();
         $this->response->expects($this->any())->method('setHeader')->willReturnSelf();
diff --git a/app/code/Magento/Downloadable/Test/Unit/Controller/Download/SampleTest.php b/app/code/Magento/Downloadable/Test/Unit/Controller/Download/SampleTest.php
