Merge pull request #1740 from magento-chaika/PR_in_2.1

Alexander Akimov · web-flow · commit 0f56de18c531 · 2017-11-21T13:22:07.000+02:00
[Chaika] bugfixes in 2.1
diff --git a/app/code/Magento/Customer/Controller/Account/Confirm.php b/app/code/Magento/Customer/Controller/Account/Confirm.php
@@ -4,12 +4,16 @@
  * Copyright © 2013-2017 Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+
 namespace Magento\Customer\Controller\Account;
 
+use Magento\Framework\Stdlib\Cookie\CookieMetadataFactory;
+use Magento\Framework\Stdlib\Cookie\PhpCookieManager;
 use Magento\Customer\Model\Url;
 use Magento\Framework\App\Action\Context;
 use Magento\Customer\Model\Session;
 use Magento\Framework\App\Config\ScopeConfigInterface;
+use Magento\Framework\App\ObjectManager;
 use Magento\Store\Model\StoreManagerInterface;
 use Magento\Customer\Api\AccountManagementInterface;
 use Magento\Customer\Api\CustomerRepositoryInterface;
@@ -32,10 +36,10 @@ class Confirm extends \Magento\Customer\Controller\AbstractAccount
     /** @var StoreManagerInterface */
     protected $storeManager;
 
-    /** @var AccountManagementInterface  */
+    /** @var AccountManagementInterface */
     protected $customerAccountManagement;
 
-    /** @var CustomerRepositoryInterface  */
+    /** @var CustomerRepositoryInterface */
     protected $customerRepository;
 
     /** @var Address */
@@ -49,6 +53,16 @@ class Confirm extends \Magento\Customer\Controller\AbstractAccount
      */
     protected $session;
 
+    /**
+     * @var CookieMetadataFactory
+     */
+    private $cookieMetadataFactory;
+
+    /**
+     * @var PhpCookieManager
+     */
+    private $cookieMetadataManager;
+
     /**
      * @param Context $context
      * @param Session $customerSession
@@ -58,6 +72,9 @@ class Confirm extends \Magento\Customer\Controller\AbstractAccount
      * @param CustomerRepositoryInterface $customerRepository
      * @param Address $addressHelper
      * @param UrlFactory $urlFactory
+     * @param CookieMetadataFactory $cookieMetadataFactory
+     * @param PhpCookieManager $cookieMetadataManager
+     * @SuppressWarnings(PHPMD.ExcessiveParameterList)
      */
     public function __construct(
         Context $context,
@@ -67,7 +84,9 @@ public function __construct(
         AccountManagementInterface $customerAccountManagement,
         CustomerRepositoryInterface $customerRepository,
         Address $addressHelper,
-        UrlFactory $urlFactory
+        UrlFactory $urlFactory,
+        CookieMetadataFactory $cookieMetadataFactory = null,
+        PhpCookieManager $cookieMetadataManager = null
     ) {
         $this->session = $customerSession;
         $this->scopeConfig = $scopeConfig;
@@ -76,6 +95,11 @@ public function __construct(
         $this->customerRepository = $customerRepository;
         $this->addressHelper = $addressHelper;
         $this->urlModel = $urlFactory->create();
+        $this->cookieMetadataFactory = $cookieMetadataFactory ?: ObjectManager::getInstance()
+            ->get(CookieMetadataFactory::class);
+        $this->cookieMetadataManager = $cookieMetadataManager ?: ObjectManager::getInstance()
+            ->get(PhpCookieManager::class);
+
         parent::__construct($context);
     }
 
@@ -100,6 +124,8 @@ public function execute()
                 throw new \Exception(__('Bad request.'));
             }
 
+            //clean customer cookies
+            $this->cleanCookie('mage-cache-sessid');
             // log in and send greeting email
             $customerEmail = $this->customerRepository->getById($customerId)->getEmail();
             $customer = $this->customerAccountManagement->activate($customerEmail, $key);
@@ -121,7 +147,7 @@ public function execute()
     /**
      * Retrieve success message
      *
-     * @return string
+     * @return \Magento\Framework\Phrase
      */
     protected function getSuccessMessage()
     {
@@ -166,4 +192,21 @@ protected function getSuccessRedirect()
         }
         return $this->_redirect->success($backUrl ? $backUrl : $successUrl);
     }
+
+    /**
+     * Clean cookie by name.
+     *
+     * @param String $cookieName
+     * @return void
+     */
+    private function cleanCookie($cookieName)
+    {
+        if ($this->cookieMetadataManager->getCookie($cookieName)) {
+            $this->cookieMetadataManager->deleteCookie(
+                $cookieName,
+                $this->cookieMetadataFactory->createCookieMetadata()
+                    ->setPath('/')
+            );
+        }
+    }
 }
diff --git a/app/code/Magento/Customer/Test/Unit/Controller/Account/ConfirmTest.php b/app/code/Magento/Customer/Test/Unit/Controller/Account/ConfirmTest.php
@@ -10,7 +10,27 @@
 
 use Magento\Customer\Helper\Address;
 use Magento\Customer\Model\Url;
+use Magento\Framework\Stdlib\Cookie\CookieMetadataFactory;
+use Magento\Framework\Stdlib\Cookie\PhpCookieManager;
+use Magento\Framework\TestFramework\Unit\Helper\ObjectManager;
 use Magento\Store\Model\ScopeInterface;
+use Magento\Customer\Controller\Account\Confirm;
+use Magento\Customer\Model\Session;
+use Magento\Framework\App\RequestInterface;
+use Magento\Framework\App\Response\Http;
+use Magento\Framework\App\ViewInterface;
+use Magento\Framework\App\Response\RedirectInterface;
+use Magento\Framework\UrlFactory;
+use Magento\Customer\Api\AccountManagementInterface;
+use Magento\Customer\Api\Data\CustomerInterface;
+use Magento\Customer\Api\CustomerRepositoryInterface;
+use Magento\Framework\Message\Manager;
+use Magento\Store\Model\StoreManager;
+use Magento\Store\Model\Store;
+use Magento\Framework\Controller\Result\Redirect;
+use Magento\Framework\Controller\ResultFactory;
+use Magento\Framework\App\Config\ScopeConfigInterface;
+use Magento\Framework\App\Action\Context;
 
 /**
  * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
@@ -98,51 +118,53 @@ class ConfirmTest extends \PHPUnit_Framework_TestCase
      */
     protected $redirectResultMock;
 
+    /** @var PhpCookieManager | \PHPUnit_Framework_MockObject_MockObject */
+    private $cookieMetadataManager;
+
+    /** @var CookieMetadataFactory | \PHPUnit_Framework_MockObject_MockObject */
+    private $cookieMetadataFactory;
+
     protected function setUp()
     {
-        $this->customerSessionMock = $this->getMock('\Magento\Customer\Model\Session', [], [], '', false);
-        $this->requestMock = $this->getMock('Magento\Framework\App\RequestInterface', [], [], '', false);
-        $this->responseMock = $this->getMock(
-            'Magento\Framework\App\Response\Http', ['setRedirect', '__wakeup'], [], '', false
-        );
-        $viewMock = $this->getMock('Magento\Framework\App\ViewInterface');
-        $this->redirectMock = $this->getMock('Magento\Framework\App\Response\RedirectInterface');
-
-        $this->urlMock = $this->getMock('Magento\Framework\Url', [], [], '', false);
-        $urlFactoryMock = $this->getMock('Magento\Framework\UrlFactory', [], [], '', false);
+        $this->customerSessionMock = $this->createDefaultMock(Session::class);
+        $this->requestMock = $this->createDefaultMock(RequestInterface::class);
+        $this->responseMock = $this->getMockBuilder(Http::class)
+            ->disableOriginalConstructor()
+            ->setMethods(['setRedirect', '__wakeup'])
+            ->getMock();
+        $viewMock = $this->createDefaultMock(ViewInterface::class);
+        $this->redirectMock = $this->createDefaultMock(RedirectInterface::class);
+
+        $this->urlMock = $this->createDefaultMock(\Magento\Framework\Url::class);
+        $urlFactoryMock = $this->createDefaultMock(UrlFactory::class);
         $urlFactoryMock->expects($this->any())
             ->method('create')
             ->will($this->returnValue($this->urlMock));
 
-        $this->customerAccountManagementMock =
-            $this->getMockForAbstractClass('Magento\Customer\Api\AccountManagementInterface');
-        $this->customerDataMock = $this->getMock(
-            'Magento\Customer\Api\Data\CustomerInterface', [], [], '', false
-        );
+        $this->customerAccountManagementMock = $this->getMockBuilder(AccountManagementInterface::class)
+            ->getMockForAbstractClass();
+        $this->customerDataMock = $this->createDefaultMock(CustomerInterface::class);
 
-        $this->customerRepositoryMock =
-            $this->getMockForAbstractClass('Magento\Customer\Api\CustomerRepositoryInterface');
-
-        $this->messageManagerMock = $this->getMock('Magento\Framework\Message\Manager', [], [], '', false);
-        $this->addressHelperMock = $this->getMock('Magento\Customer\Helper\Address', [], [], '', false);
-        $this->storeManagerMock = $this->getMock('Magento\Store\Model\StoreManager', [], [], '', false);
-        $this->storeMock = $this->getMock('Magento\Store\Model\Store', [], [], '', false);
-        $this->redirectResultMock = $this->getMock('Magento\Framework\Controller\Result\Redirect', [], [], '', false);
-
-        $resultFactoryMock = $this->getMock(
-            'Magento\Framework\Controller\ResultFactory',
-            ['create'],
-            [],
-            '',
-            false
-        );
+        $this->customerRepositoryMock = $this->getMockBuilder(CustomerRepositoryInterface::class)
+            ->getMockForAbstractClass();
+
+        $this->messageManagerMock = $this->createDefaultMock(Manager::class);
+        $this->addressHelperMock = $this->createDefaultMock(Address::class);
+        $this->storeManagerMock = $this->createDefaultMock(StoreManager::class);
+        $this->storeMock = $this->createDefaultMock(Store::class);
+        $this->redirectResultMock = $this->createDefaultMock(Redirect::class);
+
+        $resultFactoryMock = $this->getMockBuilder(ResultFactory::class)
+            ->disableOriginalConstructor()
+            ->setMethods(['create'])
+            ->getMock();
         $resultFactoryMock->expects($this->once())
             ->method('create')
-            ->with(\Magento\Framework\Controller\ResultFactory::TYPE_REDIRECT)
+            ->with(ResultFactory::TYPE_REDIRECT)
             ->willReturn($this->redirectResultMock);
 
-        $this->scopeConfigMock = $this->getMock('Magento\Framework\App\Config\ScopeConfigInterface');
-        $this->contextMock = $this->getMock('Magento\Framework\App\Action\Context', [], [], '', false);
+        $this->scopeConfigMock = $this->createDefaultMock(ScopeConfigInterface::class);
+        $this->contextMock = $this->createDefaultMock(Context::class);
         $this->contextMock->expects($this->any())
             ->method('getRequest')
             ->willReturn($this->requestMock);
@@ -162,10 +184,31 @@ protected function setUp()
             ->method('getResultFactory')
             ->willReturn($resultFactoryMock);
 
-        $objectManagerHelper = new \Magento\Framework\TestFramework\Unit\Helper\ObjectManager($this);
+        $this->cookieMetadataFactory = $this->getMockBuilder(CookieMetadataFactory::class)
+            ->disableOriginalConstructor()
+            ->setMethods(['setPath', 'createCookieMetadata'])
+            ->getMock();
 
+        $cookieMetaData = $this->getMockBuilder(\Magento\Framework\Stdlib\Cookie\CookieMetadata::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $cookieMetaData->expects($this->any())
+            ->method('setPath')
+            ->will($this->returnSelf());
+
+        $this->cookieMetadataFactory->expects($this->any())
+            ->method('createCookieMetadata')
+            ->will($this->returnValue($cookieMetaData));
+
+        /** @var PhpCookieManager | \PHPUnit_Framework_MockObject_MockObject $cookieMetadataManager */
+        $this->cookieMetadataManager = $this->getMockBuilder(PhpCookieManager::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $objectManagerHelper = new ObjectManager($this);
         $this->model = $objectManagerHelper->getObject(
-            'Magento\Customer\Controller\Account\Confirm',
+            Confirm::class,
             [
                 'context' => $this->contextMock,
                 'customerSession' => $this->customerSessionMock,
@@ -175,6 +218,8 @@ protected function setUp()
                 'customerRepository' => $this->customerRepositoryMock,
                 'addressHelper' => $this->addressHelperMock,
                 'urlFactory' => $urlFactoryMock,
+                'cookieMetadataFactory' => $this->cookieMetadataFactory,
+                'cookieMetadataManager' => $this->cookieMetadataManager,
             ]
         );
     }
@@ -190,7 +235,7 @@ public function testIsLoggedIn()
             ->with('*/*/')
             ->willReturnSelf();
 
-        $this->assertInstanceOf('Magento\Framework\Controller\Result\Redirect', $this->model->execute());
+        $this->assertInstanceOf(Redirect::class, $this->model->execute());
     }
 
     /**
@@ -232,7 +277,7 @@ public function testNoCustomerIdInRequest($customerId, $key)
             ->with($this->equalTo($testUrl))
             ->willReturnSelf();
 
-        $this->assertInstanceOf('Magento\Framework\Controller\Result\Redirect', $this->model->execute());
+        $this->assertInstanceOf(Redirect::class, $this->model->execute());
     }
 
     /**
@@ -442,4 +487,84 @@ public function getSuccessRedirectDataProvider()
             ],
         ];
     }
+
+    /**
+     * @param string $className
+     * @return \PHPUnit_Framework_MockObject_MockObject
+     */
+    protected function createDefaultMock($className)
+    {
+        return $this->getMockBuilder($className)
+            ->disableOriginalConstructor()
+            ->getMock();
+    }
+
+    /**
+     * Tests cookie cleaning
+     *
+     * @dataProvider dataProviderClean
+     * @param mixed $cookieValue
+     * @param \PHPUnit_Framework_MockObject_Matcher_Invocation $deleteMatcher
+     */
+    public function testClean($cookieValue, \PHPUnit_Framework_MockObject_Matcher_Invocation $deleteMatcher)
+    {
+        $this->customerSessionMock->expects($this->once())
+            ->method('isLoggedIn')
+            ->will($this->returnValue(false));
+
+        $this->requestMock->expects($this->any())
+            ->method('getParam')
+            ->willReturnMap([
+                ['id', false, 'id'],
+                ['key', false, 'key'],
+            ]);
+
+        $this->customerDataMock->expects($this->once())
+            ->method('getEmail')
+            ->will($this->returnValue('email@exmple.com'));
+
+        $this->customerRepositoryMock->expects($this->any())
+            ->method('getById')
+            ->will($this->returnValue($this->customerDataMock));
+
+        $this->customerAccountManagementMock->expects($this->once())
+            ->method('activate');
+
+        $this->storeMock->expects($this->any())
+            ->method('getFrontendName')
+            ->will($this->returnValue('frontend'));
+        $this->storeManagerMock->expects($this->any())
+            ->method('getStore')
+            ->will($this->returnValue($this->storeMock));
+
+        $this->cookieMetadataManager->expects($this->once())
+            ->method('getCookie')
+            ->will($this->returnValue($cookieValue));
+
+        $this->cookieMetadataManager->expects($deleteMatcher)
+            ->method('deleteCookie')
+            ->will($this->returnValue(null));
+
+        /** @noinspection PhpUnhandledExceptionInspection */
+        $this->model->execute();
+    }
+
+    /**
+     * Provides data for testing clean method
+     *
+     * @return array
+     */
+    public function dataProviderClean()
+    {
+        return [
+            'clean-cookie' => [
+                'testValue',
+                $this->once()
+            ],
+            'no-clean' => [
+                null,
+                $this->never()
+            ],
+        ];
+    }
 }
