MC-39587: Create automated test for: "Add unexisting product to comparation list"

Author: Serhii Bohomaz

dev/tests/integration/testsuite/Magento/Catalog/Controller/Product/CompareTest.php

@@ -6,44 +6,66 @@
 
 namespace Magento\Catalog\Controller\Product;
 
-use Magento\Framework\Message\MessageInterface;
+use Magento\Catalog\Model\ProductRepository;
 use Magento\Framework\App\Request\Http as HttpRequest;
+use Magento\Framework\Data\Form\FormKey;
+use Magento\Framework\Message\MessageInterface;
+use Magento\TestFramework\TestCase\AbstractController;
+use Magento\Customer\Model\Session;
+use Magento\Customer\Model\Visitor;
+use Laminas\Stdlib\Parameters;
 
 /**
- * @magentoDataFixture Magento/Catalog/controllers/_files/products.php
+ * Test compare product.
  *
+ * @magentoDataFixture Magento/Catalog/controllers/_files/products.php
  * @magentoDbIsolation disabled
- *
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
  */
-class CompareTest extends \Magento\TestFramework\TestCase\AbstractController
+class CompareTest extends AbstractController
 {
-    /**
-     * @var \Magento\Catalog\Model\ProductRepository
-     */
+    /** @var ProductRepository */
     protected $productRepository;
 
-    /**
-     * @var \Magento\Framework\Data\Form\FormKey
-     */
+    /** @var FormKey */
     private $formKey;
 
+    /** @var Session */
+    private $customerSession;
+
+    /** @var Visitor */
+    private $visitor;
+
     /**
      * @inheritDoc
      */
     protected function setUp(): void
     {
         parent::setUp();
-        $this->formKey = $this->_objectManager->get(\Magento\Framework\Data\Form\FormKey::class);
-        $this->productRepository = $this->_objectManager->create(\Magento\Catalog\Model\ProductRepository::class);
+
+        $this->formKey = $this->_objectManager->get(FormKey::class);
+        $this->productRepository = $this->_objectManager->get(ProductRepository::class);
+        $this->customerSession = $this->_objectManager->get(Session::class);
+        $this->visitor = $this->_objectManager->get(Visitor::class);
+    }
+
+    /**
+     * @inheritdoc
+     */
+    protected function tearDown(): void
+    {
+        $this->customerSession->logout();
+        $this->visitor->setId(null);
+
+        parent::tearDown();
     }
 
     /**
      * Test adding product to compare list.
      *
-     * @throws \Magento\Framework\Exception\NoSuchEntityException
+     * @return void
      */
-    public function testAddAction()
+    public function testAddAction(): void
     {
         $this->_requireVisitorWithNoProducts();
         $product = $this->productRepository->get('simple_product_1');
@@ -99,9 +121,9 @@ public function testAddActionForDisabledProduct(): void
     /**
      * Test removing a product from compare list.
      *
-     * @throws \Magento\Framework\Exception\NoSuchEntityException
+     * @return void
      */
-    public function testRemoveAction()
+    public function testRemoveAction(): void
     {
         $this->_requireVisitorWithTwoProducts();
         $product = $this->productRepository->get('simple_product_2');
@@ -139,9 +161,9 @@ public function testRemoveActionForDisabledProduct(): void
     /**
      * Test removing a product from compare list of a registered customer.
      *
-     * @throws \Magento\Framework\Exception\NoSuchEntityException
+     * @return void
      */
-    public function testRemoveActionWithSession()
+    public function testRemoveActionWithSession(): void
     {
         $this->_requireCustomerWithTwoProducts();
         $product = $this->productRepository->get('simple_product_1');
@@ -161,8 +183,10 @@ public function testRemoveActionWithSession()
 
     /**
      * Test getting a list of compared product.
+     *
+     * @return void
      */
-    public function testIndexActionDisplay()
+    public function testIndexActionDisplay(): void
     {
         $this->_requireVisitorWithTwoProducts();
 
@@ -190,8 +214,10 @@ public function testIndexActionDisplay()
 
     /**
      * Test clearing a list of compared products.
+     *
+     * @return void
      */
-    public function testClearAction()
+    public function testClearAction(): void
     {
         $this->_requireVisitorWithTwoProducts();
 
@@ -212,8 +238,9 @@ public function testClearAction()
      * Test escaping a session message.
      *
      * @magentoDataFixture Magento/Catalog/_files/product_simple_xss.php
+     * @return void
      */
-    public function testRemoveActionProductNameXss()
+    public function testRemoveActionProductNameXss(): void
     {
         $this->_prepareCompareListWithProductNameXss();
         $product = $this->productRepository->get('product-with-xss');
@@ -228,6 +255,36 @@ public function testRemoveActionProductNameXss()
         );
     }
 
+    /**
+     * Add not existing product to list of compared.
+     *
+     * @magentoAppIsolation enabled
+     * @magentoDataFixture Magento/Customer/_files/customer.php
+     * @return void
+     */
+    public function testAddNotExistingProductToCompactionList() : void
+    {
+        $this->customerSession->loginById(1);
+        $this->prepareReferer();
+        $this->getRequest()->setMethod(HttpRequest::METHOD_POST);
+        $this->getRequest()->setParams(['product' => 787586534]);
+        $this->dispatch('catalog/product_compare/add/');
+        $this->_assertCompareListEquals([]);
+        $this->assertRedirect($this->stringContains('not_existing'));
+    }
+
+    /**
+     * Prepare referer to test.
+     *
+     * @return void
+     */
+    private function prepareReferer(): void
+    {
+        $parameters = $this->_objectManager->create(Parameters::class);
+        $parameters->set('HTTP_REFERER', 'http://localhost/not_existing');
+        $this->getRequest()->setServer($parameters);
+    }
+
     /**
      * Set product status disabled.
      *
@@ -246,10 +303,9 @@ private function setProductDisabled(string $sku): \Magento\Catalog\Api\Data\Prod
     /**
      * Preparing compare list.
      *
-     * @throws \Magento\Framework\Exception\LocalizedException
-     * @throws \Magento\Framework\Exception\NoSuchEntityException
+     * @return void
      */
-    protected function _prepareCompareListWithProductNameXss()
+    protected function _prepareCompareListWithProductNameXss(): void
     {
         /** @var $visitor \Magento\Customer\Model\Visitor */
         $visitor = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()
@@ -275,9 +331,9 @@ protected function _prepareCompareListWithProductNameXss()
     /**
      * Preparing compare list.
      *
-     * @throws \Magento\Framework\Exception\LocalizedException
+     * @return void
      */
-    protected function _requireVisitorWithNoProducts()
+    protected function _requireVisitorWithNoProducts(): void
     {
         /** @var $visitor \Magento\Customer\Model\Visitor */
         $visitor = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()
@@ -300,10 +356,9 @@ protected function _requireVisitorWithNoProducts()
     /**
      * Preparing compare list.
      *
-     * @throws \Magento\Framework\Exception\LocalizedException
-     * @throws \Magento\Framework\Exception\NoSuchEntityException
+     * @return void
      */
-    protected function _requireVisitorWithTwoProducts()
+    protected function _requireVisitorWithTwoProducts(): void
     {
         /** @var $visitor \Magento\Customer\Model\Visitor */
         $visitor = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()
@@ -339,10 +394,9 @@ protected function _requireVisitorWithTwoProducts()
     /**
      * Preparing a compare list.
      *
-     * @throws \Magento\Framework\Exception\LocalizedException
-     * @throws \Magento\Framework\Exception\NoSuchEntityException
+     * @return void
      */
-    protected function _requireCustomerWithTwoProducts()
+    protected function _requireCustomerWithTwoProducts(): void
     {
         $customer = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()
             ->create(\Magento\Customer\Model\Customer::class);
@@ -405,8 +459,9 @@ protected function _requireCustomerWithTwoProducts()
      * Assert that current visitor has exactly expected products in compare list
      *
      * @param array $expectedProductIds
+     * @return void
      */
-    protected function _assertCompareListEquals(array $expectedProductIds)
+    protected function _assertCompareListEquals(array $expectedProductIds): void
     {
         /** @var $compareItems \Magento\Catalog\Model\ResourceModel\Product\Compare\Item\Collection */
         $compareItems = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()->create(