Merge pull request #637 from alexislefebvre/doc-add-alternative-ways-…

…to-perform-tests doc: add alternative ways to perform tests
liip · Jan 8, 2024 · f8e0bd2 · f8e0bd2
2 parents a1713e3 + 1891034
commit f8e0bd2
Show file tree

Hide file tree

Showing 2 changed files with 111 additions and 1 deletion.
diff --git a/doc/basic.md b/doc/basic.md
@@ -1,6 +1,9 @@
 Basic usage
 ===========
 
+> [!TIP]
+> Some methods provided by this bundle have been implemented in Symfony. Alternative ways will be shown below.
+
 Use `$this->makeClient` 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)
@@ -39,13 +42,31 @@ class MyControllerTest extends WebTestCase
 }
 ```
 
+> [!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');
+
+        // …
+    }
+}
+```
+
 ### Methods
 
 #### Check HTTP status codes
 
 ##### isSuccessful()
 
-Check that the request succedded:
+Check that the request succeeded:
 
 ```php
 $client = $this->makeClient();
@@ -55,6 +76,24 @@ $client->request('GET', '/contact');
 $this->isSuccessful($client->getResponse());
 ```
 
+> [!TIP]
+> Call `assertResponseIsSuccessful()` 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::assertResponseIsSuccessful();
+    }
+}
+```
+
 Add `false` as the second argument in order to check that the request failed:
 
 ```php
@@ -79,6 +118,24 @@ $client->request('GET', '/contact');
 $this->assertStatusCode(302, $client);
 ```
 
+> [!TIP]
+> Call `assertResponseStatusCodeSame()` 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);
+    }
+}
+```
+
 #### Get Crawler or content
 
 ##### fetchCrawler()
@@ -95,6 +152,28 @@ $this->assertSame(
 );
 ```
 
+> [!TIP]
+> Use the crawler returned by `request()` from Symfony's `WebTestCase`:
+
+```php
+use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;
+
+class MyControllerTest extends WebTestCase
+{
+    public function testContact()
+    {
+        $client = static::createClient();
+        $crawler = $client->request('GET', '/contact');
+
+        // There is one <body> tag
+        $this->assertSame(
+            1,
+            $crawler->filter('html > body')->count()
+        );
+    }
+}
+```
+
 ##### fetchContent()
 
 Get the content of an URL:
@@ -109,6 +188,27 @@ $this->assertStringContainsString(
 );
 ```
 
+> [!TIP]
+> Call `getResponse()->getContent()` 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');
+
+        $this->assertStringContainsString(
+            '<h1>LiipFunctionalTestBundle</h1>',
+            $client->getResponse()->getContent()
+        );
+    }
+}
+```
+
 #### Routing
 
 ##### getURL()
@@ -129,3 +229,7 @@ $client->request('GET', $path);
 
 $this->isSuccessful($client->getResponse());
 ```
+
+> [!TIP]
+> Consider hard-coding the URLs in the test: it will ensure that if a route is changed,
+> the test will fail, so you'll know that there is a Breaking Change.
diff --git a/doc/logged.md b/doc/logged.md
@@ -1,6 +1,9 @@
 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 conveniency method to create an already logged in client using the first parameter of
 `WebTestCase::makeClient()`.
 
@@ -10,6 +13,9 @@ You have three alternatives to create an already logged in client:
 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
 
 You can set the credentials for your test user in your `config_test.yml` file: