wip: 5.x (2)

Author: alexislefebvre

UPGRADE-5.0.md

@@ -0,0 +1,6 @@
+# Upgrade guide from 3.x to 4.x
+
+## Needed actions
+This is the list of actions that you need to take when upgrading this bundle from the 3.x to the 4.x version:
+
+ * …

doc/basic.md

@@ -4,15 +4,11 @@ Basic usage
 > [!TIP]
 > Some methods provided by this bundle have been [implemented in Symfony](https://symfony.com/doc/current/testing.html#application-tests). Alternative ways will be shown below.
 
-Use `$this->makeClient` to create a Client object. Client is a Symfony class
+Use `$this->createClientWithParams()` to create a Client object. Client is a Symfony class
 that can simulate HTTP requests to your controllers and then inspect the
 results. It is covered by the [functional tests](http://symfony.com/doc/current/book/testing.html#functional-tests)
 section of the Symfony documentation.
 
-After making a request, use `assertStatusCode` to verify the HTTP status code.
-If it fails it will display the last exception message or validation errors
-encountered by the Client object.
-
 If you are expecting validation errors, test them with `assertValidationErrors`.
 
 ```php
@@ -22,120 +18,28 @@ class MyControllerTest extends WebTestCase
 {
     public function testContact()
     {
-        $client = $this->makeClient();
+        $client = $this->createClient();
         $crawler = $client->request('GET', '/contact');
-        $this->assertStatusCode(200, $client);
+        self::assertResponseStatusCodeSame(200);
 
         $form = $crawler->selectButton('Submit')->form();
         $crawler = $client->submit($form);
 
         // We should get a validation error for the empty fields.
-        $this->assertStatusCode(200, $client);
+        self::assertResponseStatusCodeSame(200);
         $this->assertValidationErrors(['data.email', 'data.message'], $client->getContainer());
 
         // Try again with with the fields filled out.
         $form = $crawler->selectButton('Submit')->form();
         $form->setValues(['contact[email]' => '[email protected]', 'contact[message]' => 'Hello']);
         $client->submit($form);
-        $this->assertStatusCode(302, $client);
-    }
-}
-```
-
-> [!TIP]
-> Instead of calling `$this->makeClient`, consider calling `createClient()` from Symfony's `WebTestCase`:
-
-```php
-use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
-
-class MyControllerTest extends WebTestCase
-{
-    public function testContact()
-    {
-        $client = static::createClient();
-        $client->request('GET', '/contact');
-
-        // …
+        self::assertResponseStatusCodeSame(302);
     }
 }
 ```
 
 ### Methods
 
-#### Check HTTP status codes
-
-##### isSuccessful()
-
-Check that the request succeeded:
-
-```php
-$client = $this->makeClient();
-$client->request('GET', '/contact');
-
-// Successful HTTP request
-$this->isSuccessful($client->getResponse());
-```
-
-> [!TIP]
-> Call `assertResponseIsSuccessful()` from Symfony's `WebTestCase` ([documentation](https://symfony.com/doc/current/testing.html#response-assertions)):
-
-```php
-use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
-
-class MyControllerTest extends WebTestCase
-{
-    public function testContact()
-    {
-        $client = static::createClient();
-        $client->request('GET', '/contact');
-
-        self::assertResponseIsSuccessful();
-    }
-}
-```
-
-Add `false` as the second argument in order to check that the request failed:
-
-```php
-$client = $this->makeClient();
-$client->request('GET', '/error');
-
-// Request returned an error
-$this->isSuccessful($client->getResponse(), false);
-```
-
-In order to test more specific status codes, use `assertStatusCode()`:
-
-##### assertStatusCode()
-
-Check the HTTP status code from the request:
-
-```php
-$client = $this->makeClient();
-$client->request('GET', '/contact');
-
-// Standard response for successful HTTP request
-$this->assertStatusCode(302, $client);
-```
-
-> [!TIP]
-> Call `assertResponseStatusCodeSame()` from Symfony's `WebTestCase` ([documentation](https://symfony.com/doc/current/testing.html#response-assertions)):
-
-```php
-use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
-
-class MyControllerTest extends WebTestCase
-{
-    public function testContact()
-    {
-        $client = static::createClient();
-        $client->request('GET', '/contact');
-
-        self::assertResponseStatusCodeSame(302);
-    }
-}
-```
-
 #### Get Crawler or content
 
 ##### fetchCrawler()
@@ -181,44 +85,6 @@ class MyControllerTest extends WebTestCase
 }
 ```
 
-##### fetchContent()
-
-Get the content of a URL:
-
-```php
-$content = $this->fetchContent('/contact');
-
-// `filter()` can't be used since the output is HTML code, check the content directly
-$this->assertStringContainsString(
-    '<h1>LiipFunctionalTestBundle</h1>',
-    $content
-);
-```
-
-> [!TIP]
-> Call `getResponse()->getContent()` or use `assertSelectorText*()` from Symfony's `WebTestCase` ([documentation](https://symfony.com/doc/current/testing.html#crawler-assertions)):
-
-```php
-use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
-
-class MyControllerTest extends WebTestCase
-{
-    public function testContact()
-    {
-        $client = static::createClient();
-        $client->request('GET', '/contact');
-
-        $this->assertStringContainsString(
-            '<h1>LiipFunctionalTestBundle</h1>',
-            $client->getResponse()->getContent()
-        );
-        
-        //or
-        self::assertSelectorTextContains('h1', 'LiipFunctionalTestBundle');
-    }
-}
-```
-
 #### Routing
 
 ##### getURL()

doc/examples.md

@@ -93,7 +93,7 @@ class ExampleFunctionalTest extends WebTestCase
 
     public function testValidationErrors(): void
     {
-        $client = $this->makeClient(true);
+        $client = $this->createClientWithParams();
         $crawler = $client->request('GET', '/users/1/edit');
 
         $client->submit($crawler->selectButton('Save')->form());

doc/installation.md

@@ -1,7 +1,9 @@
 Upgrade from previous version
 ========================
 
-See [Upgrade guide from 1.x to 2.0](../UPGRADE-2.0.md) and [Upgrade guide from 2.x to 3.x](../UPGRADE-3.0.md).
+See [Upgrade guide from 1.x to 2.0](../UPGRADE-2.0.md),
+[Upgrade guide from 2.x to 3.x](../UPGRADE-3.0.md) and 
+[Upgrade guide from 4.x to 5.x](../UPGRADE-5.0.md).
 
 Installation
 ============
@@ -12,7 +14,7 @@ Installation
     following command to download the latest stable version of this bundle:
 
     ```bash
-    $ composer require --dev liip/functional-test-bundle:^4.0.0
+    $ composer require --dev liip/functional-test-bundle:^5.0.0
     ```
 
     This command requires you to have Composer installed globally, as explained

doc/logged.md

@@ -1,20 +1,10 @@
 Create an already logged client
 ===============================
 
-> [!TIP]
-> Some methods provided by this bundle have been implemented in Symfony. Alternative ways will be shown below.
-
-The `WebTestCase` provides a convenience method to create an already logged in client using the first parameter of
-`WebTestCase::makeClient()`.
-
-You have three alternatives to create an already logged in client:
+You have two alternatives to create an already logged in client:
 
 1. Use the `liip_functional_test.authentication` key in the `config_test.yml` file;
 2. Pass an array with login parameters directly when you call the method;
-3. Use the method `WebTestCase::loginClient()`;
-
-> [!TIP]
-> Since Symfony 5.1, [`loginUser()`](https://symfony.com/doc/5.x/testing.html#logging-in-users-authentication) can be used.
 
 ### Logging in a user from the `config_test.yml` file
 

src/Test/WebTestCase.php

@@ -23,11 +23,9 @@
 use Symfony\Component\Console\Tester\CommandTester;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\DependencyInjection\ResettableContainerInterface;
-use Symfony\Component\DomCrawler\Crawler;
 use Symfony\Component\HttpFoundation\Exception\SessionNotFoundException;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\RequestStack;
-use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpFoundation\Session\Session;
 use Symfony\Component\HttpFoundation\Session\SessionInterface;
 use Symfony\Component\HttpKernel\KernelInterface;
@@ -261,22 +259,6 @@ protected static function createKernel(array $options = []): KernelInterface
      * $params can be used to pass headers to the client, note that they have
      * to follow the naming format used in $_SERVER.
      * Example: 'HTTP_X_REQUESTED_WITH' instead of 'X-Requested-With'
-     *
-     * @deprecated
-     */
-    protected function makeClient(array $params = []): Client
-    {
-        return $this->createClientWithParams($params);
-    }
-
-    /**
-     * Creates an instance of a lightweight Http client.
-     *
-     * $params can be used to pass headers to the client, note that they have
-     * to follow the naming format used in $_SERVER.
-     * Example: 'HTTP_X_REQUESTED_WITH' instead of 'X-Requested-With'
-     *
-     * @deprecated
      */
     protected function makeAuthenticatedClient(array $params = []): Client
     {
@@ -288,21 +270,6 @@ protected function makeAuthenticatedClient(array $params = []): Client
         return $this->createClientWithParams($params, $username, $password);
     }
 
-    /**
-     * Creates an instance of a lightweight Http client and log in user with
-     * username and password params.
-     *
-     * $params can be used to pass headers to the client, note that they have
-     * to follow the naming format used in $_SERVER.
-     * Example: 'HTTP_X_REQUESTED_WITH' instead of 'X-Requested-With'
-     *
-     * @deprecated
-     */
-    protected function makeClientWithCredentials(string $username, string $password, array $params = []): Client
-    {
-        return $this->createClientWithParams($params, $username, $password);
-    }
-
     /**
      * Create User Token.
      *
@@ -348,71 +315,6 @@ protected function getUrl(string $route, array $params = [], int $absolute = Url
         return $this->getContainer()->get('router')->generate($route, $params, $absolute);
     }
 
-    /**
-     * Checks the success state of a response.
-     *
-     * @param Response $response Response object
-     * @param bool     $success  to define whether the response is expected to be successful
-     * @param string   $type
-     */
-    public function isSuccessful(Response $response, $success = true, $type = 'text/html'): void
-    {
-        HttpAssertions::isSuccessful($response, $success, $type);
-    }
-
-    /**
-     * Executes a request on the given url and returns the response contents.
-     *
-     * This method also asserts the request was successful.
-     *
-     * @param string $path           path of the requested page
-     * @param string $method         The HTTP method to use, defaults to GET
-     * @param bool   $authentication Whether to use authentication, defaults to false
-     * @param bool   $success        to define whether the response is expected to be successful
-     */
-    public function fetchContent(string $path, string $method = 'GET', bool $authentication = false, bool $success = true): string
-    {
-        $client = ($authentication) ? $this->makeAuthenticatedClient() : $this->makeClient();
-
-        $client->request($method, $path);
-
-        $content = $client->getResponse()->getContent();
-        $this->isSuccessful($client->getResponse(), $success);
-
-        return $content;
-    }
-
-    /**
-     * Executes a request on the given url and returns a Crawler object.
-     *
-     * This method also asserts the request was successful.
-     *
-     * @param string $path           path of the requested page
-     * @param string $method         The HTTP method to use, defaults to GET
-     * @param bool   $authentication Whether to use authentication, defaults to false
-     * @param bool   $success        Whether the response is expected to be successful
-     */
-    public function fetchCrawler(string $path, string $method = 'GET', bool $authentication = false, bool $success = true): Crawler
-    {
-        $client = ($authentication) ? $this->makeAuthenticatedClient() : $this->makeClient();
-
-        $crawler = $client->request($method, $path);
-
-        $this->isSuccessful($client->getResponse(), $success);
-
-        return $crawler;
-    }
-
-    /**
-     * Asserts that the HTTP response code of the last request performed by
-     * $client matches the expected code. If not, raises an error with more
-     * information.
-     */
-    public static function assertStatusCode(int $expectedStatusCode, Client $client): void
-    {
-        HttpAssertions::assertStatusCode($expectedStatusCode, $client);
-    }
-
     /**
      * Assert that the last validation errors within $container match the
      * expected keys.
@@ -439,10 +341,7 @@ protected function tearDown(): void
         parent::tearDown();
     }
 
-    /**
-     * @deprecated
-     */
-    protected function createClientWithParams(array $params, ?string $username = null, ?string $password = null): Client
+    protected function createClientWithParams(array $params = [], ?string $username = null, ?string $password = null): Client
     {
         if ($username && $password) {
             $params = array_merge($params, [