Merge pull request #26437 from jolelievre/refacto-controller-tests

Refactor controller tests

src/PrestaShopBundle/Resources/config/services/bundle/repository.yml

@@ -133,3 +133,9 @@ services:
     factory: [ '@doctrine.orm.default_entity_manager', getRepository ]
     arguments:
       - PrestaShopBundle\Entity\AttributeGroup
+
+  prestashop.core.admin.feature_flag.repository:
+    class: Doctrine\ORM\EntityRepository
+    factory: [ '@doctrine.orm.default_entity_manager', getRepository ]
+    arguments:
+      - PrestaShopBundle\Entity\FeatureFlag

tests/Integration/Core/Form/IdentifiableObject/Handler/FormHandlerChecker.php

@@ -39,7 +39,7 @@ class FormHandlerChecker implements FormHandlerInterface
     private $formHandler;
 
     /**
-     * @var int
+     * @var int|null
      */
     private $lastCreatedId;
 
@@ -53,6 +53,9 @@ public function __construct(FormHandlerInterface $formHandler)
         $this->formHandler = $formHandler;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public function handle(FormInterface $form)
     {
         $result = $this->formHandler->handle($form);
@@ -61,12 +64,18 @@ public function handle(FormInterface $form)
         return $result;
     }
 
+    /**
+     * {@inheritDoc}
+     */
     public function handleFor($id, FormInterface $form)
     {
-        return $this->formHandler->handleFor($form, $id);
+        return $this->formHandler->handleFor($id, $form);
     }
 
-    public function getLastCreatedId(): int
+    /**
+     * @return int|null
+     */
+    public function getLastCreatedId(): ?int
     {
         return $this->lastCreatedId;
     }

tests/Integration/PrestaShopBundle/Controller/FormFiller/FormChecker.php

@@ -0,0 +1,78 @@
+<?php
+/**
+ * Copyright since 2007 PrestaShop SA and Contributors
+ * PrestaShop is an International Registered Trademark & Property of PrestaShop SA
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Open Software License (OSL 3.0)
+ * that is bundled with this package in the file LICENSE.md.
+ * It is also available through the world-wide-web at this URL:
+ * https://opensource.org/licenses/OSL-3.0
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@prestashop.com so we can send you a copy immediately.
+ *
+ * DISCLAIMER
+ *
+ * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
+ * versions in the future. If you wish to customize PrestaShop for your
+ * needs please refer to https://devdocs.prestashop.com/ for more information.
+ *
+ * @author    PrestaShop SA and Contributors <contact@prestashop.com>
+ * @copyright Since 2007 PrestaShop SA and Contributors
+ * @license   https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
+ */
+
+declare(strict_types=1);
+
+namespace Tests\Integration\PrestaShopBundle\Controller\FormFiller;
+
+use InvalidArgumentException;
+use PHPUnit\Framework\Assert;
+use Symfony\Component\DomCrawler\Field\FormField;
+use Symfony\Component\DomCrawler\Form;
+
+class FormChecker
+{
+    /**
+     * @param Form $form
+     * @param array $expectedFormData
+     *
+     * @return Form
+     */
+    public function checkForm(Form $form, array $expectedFormData): Form
+    {
+        foreach ($expectedFormData as $fieldName => $expectedFormDatum) {
+            if (!is_array($expectedFormDatum)) {
+                /** @var FormField $formField */
+                $formField = $form->get($fieldName);
+                $this->assertFormValue($expectedFormDatum, $formField->getValue(), $fieldName);
+            } else {
+                throw new InvalidArgumentException('The check for array values has not been implemented yet, your turn!!');
+            }
+        }
+
+        return $form;
+    }
+
+    /**
+     * @param mixed $expectedValue
+     * @param mixed $formValue
+     * @param string $fieldName
+     */
+    private function assertFormValue($expectedValue, $formValue, string $fieldName): void
+    {
+        // We use assertTrue instead of assertEquals because when it fails it raises an error related to Closure
+        // serialization which makes it very hard to debug (this is because of processIsolation)
+        Assert::assertTrue(
+            $expectedValue == $formValue,
+            sprintf(
+                'Invalid value for field %s, expected %s but got %s instead.',
+                $fieldName,
+                $expectedValue,
+                (string) $formValue
+            )
+        );
+    }
+}

tests/Integration/PrestaShopBundle/Controller/FormFiller/FormFiller.php

@@ -28,8 +28,8 @@
 
 namespace Tests\Integration\PrestaShopBundle\Controller\FormFiller;
 
-use FormField;
 use Symfony\Component\DomCrawler\Field\ChoiceFormField;
+use Symfony\Component\DomCrawler\Field\FormField;
 use Symfony\Component\DomCrawler\Form;
 
 class FormFiller

tests/Integration/PrestaShopBundle/Controller/FormGridControllerTestCase.php

@@ -0,0 +1,188 @@
+<?php
+/**
+ * Copyright since 2007 PrestaShop SA and Contributors
+ * PrestaShop is an International Registered Trademark & Property of PrestaShop SA
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Open Software License (OSL 3.0)
+ * that is bundled with this package in the file LICENSE.md.
+ * It is also available through the world-wide-web at this URL:
+ * https://opensource.org/licenses/OSL-3.0
+ * If you did not receive a copy of the license and are unable to
+ * obtain it through the world-wide-web, please send an email
+ * to license@prestashop.com so we can send you a copy immediately.
+ *
+ * DISCLAIMER
+ *
+ * Do not edit or add to this file if you wish to upgrade PrestaShop to newer
+ * versions in the future. If you wish to customize PrestaShop for your
+ * needs please refer to https://devdocs.prestashop.com/ for more information.
+ *
+ * @author    PrestaShop SA and Contributors <contact@prestashop.com>
+ * @copyright Since 2007 PrestaShop SA and Contributors
+ * @license   https://opensource.org/licenses/OSL-3.0 Open Software License (OSL 3.0)
+ */
+
+declare(strict_types=1);
+
+namespace Tests\Integration\PrestaShopBundle\Controller;
+
+use Symfony\Component\DomCrawler\Form;
+use Tests\Integration\Core\Form\IdentifiableObject\Handler\FormHandlerChecker;
+use Tests\Integration\PrestaShopBundle\Controller\FormFiller\FormChecker;
+
+abstract class FormGridControllerTestCase extends GridControllerTestCase
+{
+    /**
+     * @var FormChecker
+     */
+    protected $formChecker;
+
+    /**
+     * {@inheritDoc}
+     */
+    public function setUp(): void
+    {
+        parent::setUp();
+        $this->formChecker = new FormChecker();
+    }
+
+    /**
+     * Create an entity by filling the form page with the provided data. You will need to implement these methods:
+     *
+     * - generateCreateUrl: returns the creation form url
+     * - getFormHandlerChecker: return the form handler service which has been encapsulated and allows to get the created ID
+     * - getCreateSubmitButtonSelector: returns the selector of the button allowing to select the form
+     *
+     * @param array $formData
+     *
+     * @return int Created entity ID
+     */
+    protected function createEntityFromPage(array $formData): int
+    {
+        $createEntityUrl = $this->generateCreateUrl();
+
+        $this->fillAndSubmitEntityForm($createEntityUrl, $formData, $this->getCreateSubmitButtonSelector());
+        $formHandlerChecker = $this->getFormHandlerChecker();
+
+        $testEntityId = $formHandlerChecker->getLastCreatedId();
+        self::assertNotNull($testEntityId);
+
+        return $testEntityId;
+    }
+
+    /**
+     * Edit an entity by filling the form page with the provided data. You will need to implement these methods:
+     *
+     * - generateEditUrl: returns the edit form url
+     * - getEditSubmitButtonSelector: returns the selector of the button allowing to select the form
+     *
+     * @param array $routeParams
+     * @param array $formData
+     */
+    protected function editEntityFromPage(array $routeParams, array $formData): void
+    {
+        $editEntityUrl = $this->generateEditUrl($routeParams);
+
+        $this->fillAndSubmitEntityForm($editEntityUrl, $formData, $this->getEditSubmitButtonSelector());
+    }
+
+    /**
+     * Parses the entity value from the edit page and assert it matches the expected data. You will need to implement
+     * these methods:
+     *
+     * - generateEditUrl: returns the edit form url
+     * - getEditSubmitButtonSelector: returns the selector of the button allowing to select the form
+     *
+     * @param array $routeParams
+     * @param array $expectedFormData
+     */
+    protected function assertFormValuesFromPage(array $routeParams, array $expectedFormData): void
+    {
+        $editEntityUrl = $this->generateEditUrl($routeParams);
+        $entityForm = $this->getFormFromPage($editEntityUrl, $this->getEditSubmitButtonSelector());
+        $this->formChecker->checkForm($entityForm, $expectedFormData);
+    }
+
+    /**
+     * @param string $formUrl
+     * @param array $formData
+     * @param string $formButtonSelector
+     */
+    protected function fillAndSubmitEntityForm(string $formUrl, array $formData, string $formButtonSelector = 'submit'): void
+    {
+        $filledEntityForm = $this->formFiller->fillForm(
+            $this->getFormFromPage($formUrl, $formButtonSelector),
+            $formData
+        );
+
+        $this->client->submit($filledEntityForm);
+    }
+
+    /**
+     * @param string $formUrl
+     * @param string $formButtonSelector
+     *
+     * @return Form
+     */
+    protected function getFormFromPage(string $formUrl, string $formButtonSelector): Form
+    {
+        $crawler = $this->client->request('GET', $formUrl);
+        $this->assertResponseIsSuccessful();
+
+        return $this->getFormByButton($crawler, $formButtonSelector);
+    }
+
+    /**
+     * @param string $deleteRoute
+     * @param array $routeParams
+     */
+    protected function deleteEntityFromPage(string $deleteRoute, array $routeParams): void
+    {
+        $deleteUrl = $this->router->generate($deleteRoute, $routeParams);
+
+        // Delete url performs the deletion and then redirects to the list
+        $this->client->request('POST', $deleteUrl);
+        $this->assertResponseRedirects();
+    }
+
+    /**
+     * Returns the url of the create page.
+     *
+     * @return string
+     */
+    abstract protected function generateCreateUrl(): string;
+
+    /**
+     * Returns the selector allowing to get the create form's submit button.
+     *
+     * @return string
+     */
+    abstract protected function getCreateSubmitButtonSelector(): string;
+
+    /**
+     * In test environment all form handlers are decorated inside a FormHandlerChecker which allows us to get the
+     * last created ID. This method must be implemented if you want to test your creation form, it returns the form
+     * handler service used in your creation form.
+     *
+     * @return FormHandlerChecker
+     */
+    abstract protected function getFormHandlerChecker(): FormHandlerChecker;
+
+    /**
+     * Returns the url of the edit page.
+     *
+     * @param array $routeParams
+     *
+     * @return string
+     */
+    abstract protected function generateEditUrl(array $routeParams): string;
+
+    /**
+     * Returns the selector allowing to get the edit form's submit button.
+     *
+     * @return string
+     */
+    abstract protected function getEditSubmitButtonSelector(): string;
+}