ENGCOM-4394: Refactoring the Form class #21474

 - Merge Pull Request #21474 from eduard13/magento2:2.3-develop-guest-form-integration-test
 - Merged commits:
   1. 9dc9829
   2. 37c10bc
   3. a146f50
   4. 96f6a61
   5. e4a1b8a

Author: magento-engcom-team

app/code/Magento/Sales/Controller/Guest/Form.php

@@ -4,40 +4,71 @@
  * Copyright © Magento, Inc. All rights reserved.
  * See COPYING.txt for license details.
  */
+declare(strict_types=1);
+
 namespace Magento\Sales\Controller\Guest;
 
+use Magento\Customer\Model\Session as CustomerSession;
+use Magento\Framework\App\Action\Context;
+use Magento\Framework\App\ObjectManager;
+use Magento\Framework\Controller\Result\Redirect;
+use Magento\Framework\View\Result\Page;
+use Magento\Framework\View\Result\PageFactory;
+use Magento\Sales\Helper\Guest as GuestHelper;
+
+/**
+ * Class Form
+ */
 class Form extends \Magento\Framework\App\Action\Action
 {
     /**
-     * @var \Magento\Framework\View\Result\PageFactory
+     * @var PageFactory
      */
     protected $resultPageFactory;
 
     /**
-     * @param \Magento\Framework\App\Action\Context $context
-     * @param \Magento\Framework\View\Result\PageFactory $resultPageFactory
+     * @var CustomerSession|null
+     */
+    private $customerSession;
+
+    /**
+     * @var GuestHelper|null
+     */
+    private $guestHelper;
+
+    /**
+     * @param Context $context
+     * @param PageFactory $resultPageFactory
+     * @param CustomerSession|null $customerSession
+     * @param GuestHelper|null $guestHelper
      */
     public function __construct(
-        \Magento\Framework\App\Action\Context $context,
-        \Magento\Framework\View\Result\PageFactory $resultPageFactory
+        Context $context,
+        PageFactory $resultPageFactory,
+        CustomerSession $customerSession = null,
+        GuestHelper $guestHelper = null
     ) {
         parent::__construct($context);
         $this->resultPageFactory = $resultPageFactory;
+        $this->customerSession = $customerSession ?: ObjectManager::getInstance()->get(CustomerSession::class);
+        $this->guestHelper = $guestHelper ?: ObjectManager::getInstance()->get(GuestHelper::class);
     }
 
     /**
      * Order view form page
      *
-     * @return \Magento\Framework\Controller\Result\Redirect|\Magento\Framework\View\Result\Page
+     * @return Redirect|Page
      */
     public function execute()
     {
-        if ($this->_objectManager->get(\Magento\Customer\Model\Session::class)->isLoggedIn()) {
+        if ($this->customerSession->isLoggedIn()) {
             return $this->resultRedirectFactory->create()->setPath('customer/account/');
         }
+
         $resultPage = $this->resultPageFactory->create();
         $resultPage->getConfig()->getTitle()->set(__('Orders and Returns'));
-        $this->_objectManager->get(\Magento\Sales\Helper\Guest::class)->getBreadcrumbs($resultPage);
+        $this->guestHelper->getBreadcrumbs($resultPage);
+
         return $resultPage;
     }
-}
+}

dev/tests/integration/testsuite/Magento/Sales/Controller/Guest/FormTest.php

@@ -0,0 +1,109 @@
+<?php
+/**
+ * Copyright © Magento, Inc. All rights reserved.
+ * See COPYING.txt for license details.
+ */
+declare(strict_types=1);
+
+namespace Magento\Sales\Controller\Guest;
+
+use Magento\Customer\Model\Session;
+use Magento\Framework\Data\Form\FormKey;
+use Magento\Framework\Message\MessageInterface;
+use Magento\TestFramework\Request;
+use Magento\TestFramework\TestCase\AbstractController;
+
+/**
+ * @magentoAppIsolation enabled
+ */
+class FormTest extends AbstractController
+{
+    /**
+     * Test view order as guest with correct data
+     *
+     * @magentoDataFixture Magento/Sales/_files/order.php
+     */
+    public function testViewOrderAsGuest()
+    {
+        $this->prepareRequestData();
+        $this->dispatch('sales/guest/view/');
+        $content = $this->getResponse()->getBody();
+        $this->assertContains('Order # 100000001', $content);
+    }
+
+    /**
+     * View order as logged in customer
+     *
+     * @magentoDataFixture Magento/Sales/_files/order.php
+     * @magentoDataFixture Magento/Customer/_files/customer.php
+     */
+    public function testViewOrderAsLoggedIn()
+    {
+        $this->login(1);
+        $this->dispatch('sales/guest/view/');
+        $this->assertRedirect($this->stringContains('sales/order/history/'));
+    }
+
+    /**
+     * Test attempting to open the Returns form as logged in customer
+     *
+     * @magentoDataFixture Magento/Sales/_files/order.php
+     * @magentoDataFixture Magento/Customer/_files/customer.php
+     */
+    public function testAttemptToOpenTheFormAsLoggedIn()
+    {
+        $this->login(1);
+        $this->dispatch('sales/guest/form/');
+        $this->assertRedirect($this->stringContains('customer/account'));
+    }
+
+    /**
+     * Test Return Order for guest with incorrect data
+     */
+    public function testViewOrderAsGuestWithIncorrectData()
+    {
+        $this->prepareRequestData(true);
+        $this->dispatch('sales/guest/view/');
+        $this->assertSessionMessages(
+            $this->equalTo(['You entered incorrect data. Please try again.']),
+            MessageInterface::TYPE_ERROR
+        );
+    }
+
+    /**
+     * Login the user
+     *
+     * @param string $customerId Customer to mark as logged in for the session
+     * @return void
+     */
+    protected function login($customerId)
+    {
+        /** @var Session $session */
+        $session = $this->_objectManager->get(Session::class);
+        $session->loginById($customerId);
+    }
+
+    /**
+     * @param bool $invalidData
+     * @return void
+     */
+    private function prepareRequestData($invalidData = false)
+    {
+        $orderId = 100000001;
+        $email = $invalidData ? '[email protected]' : '[email protected]';
+
+        /** @var FormKey $formKey */
+        $formKey = $this->_objectManager->get(FormKey::class);
+        $post = [
+            'oar_order_id' => $orderId,
+            'oar_billing_lastname' => 'lastname',
+            'oar_type' => 'email',
+            'oar_email' => $email,
+            'oar_zip' => '',
+            'form_key' => $formKey->getFormKey(),
+        ];
+
+        $this->getRequest()->setMethod(Request::METHOD_POST);
+        $this->getRequest()->setPostValue($post);
+    }
+}