Ensure Kernel is shutdown - prevent error for Symfony 5 (#41)

* ensure kernel is shutdown - prevent error for Symfony5 * Allow prevention of errors on Symfony 5 in WebTestCase --------- Co-authored-by: Hugo Gonçalves <[email protected]>
kununu · Feb 20, 2023 · a36bd8a · a36bd8a
1 parent 6c7c4ff
commit a36bd8a
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -133,9 +133,11 @@ public function withServerParameter(string $parameterName, string $parameterValu
 This bundle exposes the [WebTestCase](https://github.com/kununu/testing-bundle/blob/master/src/Test/WebTestCase.php) that you can extend which exposes a method that helps you testing your controllers without having to care about create the kernel. This class also allows you load fixtures in your tests.
 
 ```php
-protected function doRequest(RequestBuilder $builder): Symfony\Component\HttpFoundation\Response
+final protected function doRequest(RequestBuilder $builder, bool $shutdown = true): Symfony\Component\HttpFoundation\Response
 ```
 
+The `shutdown` parameter, if set to true (default), will ensure that Symfony kernel is shutdown after the request, which is required to avoid exceptions on Symfony 5 and up.
+
 Internally this method calls the Symfony client with:
 
 ```php
@@ -146,7 +148,7 @@ $client->request($builder->method, $builder->uri, $builder->parameters, $builder
 
 ## Example
 
-Lets imagine that you have a route named *company_create* which is protected (A valid access token needs to be provided) and expects a json to be provided in the body of the request with the data required to create a new company.
+Let's imagine that you have a route named *company_create* which is protected (A valid access token needs to be provided) and expects a json to be provided in the body of the request with the data required to create a new company.
 
 ```yaml
 # routes.yaml

diff --git a/src/Test/WebTestCase.php b/src/Test/WebTestCase.php
@@ -11,7 +11,7 @@ abstract class WebTestCase extends FixturesAwareTestCase
     /** @var KernelBrowser */
     private $client;
 
-    final protected function doRequest(RequestBuilder $builder): Response
+    final protected function doRequest(RequestBuilder $builder, bool $shutdown = true): Response
     {
         $this->initClient();
 
@@ -29,6 +29,10 @@ final protected function doRequest(RequestBuilder $builder): Response
             );
         }
 
+        if ($shutdown) {
+            $this->ensureKernelShutdown();
+        }
+
         return $response;
     }