Merge pull request liip#491 from AkenRoberts/bugfix/273-form-with-embed

Fix liip#273: form validation works with sub-requests

Author: alexislefebvre

src/Validator/DataCollectingValidator.php

@@ -14,6 +14,7 @@
 namespace Liip\FunctionalTestBundle\Validator;
 
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+use Symfony\Component\HttpKernel\Event\GetResponseEvent;
 use Symfony\Component\HttpKernel\KernelEvents;
 use Symfony\Component\Validator\ConstraintViolationList;
 use Symfony\Component\Validator\ConstraintViolationListInterface;
@@ -85,10 +86,17 @@ public function inContext(ExecutionContextInterface $context): ContextualValidat
         return $this->wrappedValidator->inContext($context);
     }
 
+    public function onKernelRequest(GetResponseEvent $event): void
+    {
+        if ($event->isMasterRequest()) {
+            $this->clearLastErrors();
+        }
+    }
+
     public static function getSubscribedEvents(): array
     {
         return [
-            KernelEvents::REQUEST => ['clearLastErrors', 99999],
+            KernelEvents::REQUEST => ['onKernelRequest', 99999],
         ];
     }
 }

tests/App/Controller/DefaultController.php

@@ -62,6 +62,30 @@ public function userAction(int $userId): Response
      * @return Response
      */
     public function formAction(Request $request): Response
+    {
+        return $this->form($request, 'form.html.twig');
+    }
+
+    /**
+     * @param Request $request
+     *
+     * @return Response
+     */
+    public function formWithEmbedAction(Request $request): Response
+    {
+        return $this->form($request, 'form_with_embed.html.twig');
+    }
+
+    /**
+     * Common form functionality used to test form submissions both
+     * with and without an embedded request.
+     *
+     * @param Request $request
+     * @param string  $template
+     *
+     * @return Response
+     */
+    private function form(Request $request, string $template): Response
     {
         $object = new \ArrayObject();
         $object->name = null;
@@ -83,7 +107,7 @@ public function formAction(Request $request): Response
         }
 
         return $this->render(
-            'form.html.twig',
+            $template,
             ['form' => $form->createView()]
         );
     }
@@ -100,4 +124,14 @@ public function jsonAction(): Response
 
         return $response;
     }
+
+    /**
+     * Used to embed content as a sub-request.
+     *
+     * @return Response
+     */
+    public function embeddedAction(): Response
+    {
+        return new Response('Embedded Content', Response::HTTP_OK);
+    }
 }

tests/App/Resources/views/form_with_embed.html.twig

@@ -0,0 +1,9 @@
+{% extends 'AcmeBundle::layout.html.twig' %}
+
+{% block body %}
+    <div>
+        {{ render(controller('Liip\\FunctionalTestBundle\\Tests\\App\\Controller\\DefaultController::embeddedAction')) }}
+    </div>
+
+    {{ form(form) }}
+{% endblock %}

tests/App/routing.yml

@@ -12,6 +12,10 @@ liipfunctionaltestbundle_form:
     path:  /form
     defaults: { _controller: 'Liip\FunctionalTestBundle\Tests\App\Controller\DefaultController::formAction' }
 
+liipfunctionaltestbundle_form_with_embed:
+    path:  /form-with-embed
+    defaults: { _controller: 'Liip\FunctionalTestBundle\Tests\App\Controller\DefaultController::formWithEmbedAction' }
+
 liipfunctionaltestbundle_json:
     path:  /json
     defaults: { _controller: 'Liip\FunctionalTestBundle\Tests\App\Controller\DefaultController::jsonAction' }

tests/Test/WebTestCaseTest.php

@@ -726,6 +726,41 @@ public function testForm(): void
         );
     }
 
+    /**
+     * Ensure form validation helpers still work with embedded controllers.
+     *
+     * @see https://github.com/liip/LiipFunctionalTestBundle/issues/273
+     */
+    public function testFormWithEmbed(): void
+    {
+        $this->loadFixtures([]);
+
+        $path = '/form-with-embed';
+
+        $crawler = $this->client->request('GET', $path);
+
+        $this->assertStatusCode(200, $this->client);
+
+        $form = $crawler->selectButton('Submit')->form();
+        $crawler = $this->client->submit($form);
+
+        $this->assertStatusCode(200, $this->client);
+
+        $this->assertValidationErrors(['children[name].data'], $this->client->getContainer());
+
+        // Try again with the fields filled out.
+        $form = $crawler->selectButton('Submit')->form();
+        $form->setValues(['form[name]' => 'foo bar']);
+        $crawler = $this->client->submit($form);
+
+        $this->assertStatusCode(200, $this->client);
+
+        $this->assertContains(
+            'Name submitted.',
+            $crawler->filter('div.flash-notice')->text()
+        );
+    }
+
     /**
      * @depends testForm
      *