ApiTestCase and assertions docs

core/testing.md

@@ -0,0 +1,105 @@
+# Testing Utilities
+
+API Platform Core provides a set of useful utilities dedicated to API testing.
+For an overview of how to test an API Platform app, be sure to read [the testing cookbook first](../distribution/testing.md).
+
+## The Test HttpClient
+
+API Platform provides its own implementation of the [Symfony HttpClient](https://symfony.com/doc/current/components/http_client.html)'s interfaces, tailored to be used directly in [PHPUnit](https://phpunit.de/) test classes.
+
+While all the convenient features of Symfony HttpClient are available and usable directly, under the hood the API Platform implementation manipulates [the Symfony HttpKernel](https://symfony.com/doc/current/components/http_kernel.html) directly to simulate HTTP requests and responses.
+This approach results in a huge performance boost compared to triggering real network requests.
+It also allows access to the [Symfony HttpKernel](https://symfony.com/doc/current/components/http_kernel.html and to all your services via the [Dependency Injection Container](https://symfony.com/doc/current/testing.html#accessing-the-container). 
+Reuse them to run, for instance, SQL queries or requests to external APIs directly from your tests.
+
+Install the `symfony/http-client` and `symfony/browser-kit` packages to enabled the API Platform test client:
+
+    $ docker-compose exec php composer require symfony/http-client symfony/browser-kit
+
+To use the testing client, your test class must extend the `ApiTestCase` class:
+
+```php
+<?php
+// api/tests/BooksTest.php
+
+namespace App\Tests;
+
+use ApiPlatform\Core\Bridge\Symfony\Bundle\Test\ApiTestCase;
+
+class BooksTest extends ApiTestCase
+{
+    public function testGetCollection(): void
+    {
+        $response = static::createClient()->request('GET', '/books');
+        // your assertions here...
+    }
+}
+```
+
+Refer to [the Symfony HttpClient documentation](https://symfony.com/doc/current/components/http_client.html) to discover all the features of the client (custom headers, JSON encoding and decoding, HTTP Basic and Bearer authentication and cookies support, among other things).
+
+
+## API Test Assertions
+
+In addition to [the built-in ones](https://phpunit.readthedocs.io/fr/latest/assertions.html), API Platform provides convenient PHPUnit assertions dedicated to API testing:
+
+```php
+<?php
+// api/tests/MyTest.php
+
+namespace App\Tests;
+
+use ApiPlatform\Core\Bridge\Symfony\Bundle\Test\ApiTestCase;
+
+class MyTest extends ApiTestCase
+{
+    public function testSomething(): void
+    {
+        // static::createClient()->request(...);
+
+        // Asserts that the returned JSON is equal to the passed one
+        $this->assertJsonEquals(/* a JSON document as an array or as a string */);
+
+        // Asserts that the returned JSON is a superset of the passed one
+        $this->assertJsonContains(/* a JSON document as an array or as a string */);
+
+        // justinrainbow/json-schema must be installed to use the following assertions
+
+        // Asserts that the returned JSON matches the passed JSON Schema
+        $this->assertMatchesJsonSchema(/* a JSON Schema as an array or as a string */);
+
+        // Asserts that the returned JSON is validated by the JSON Schema generated for this resource by API Platform
+
+        // For collections
+        $this->assertMatchesResourceCollectionJsonSchema(YourApiResource::class);
+        // And for items
+        $this->assertMatchesResourceItemJsonSchema(YourApiResource::class);
+    }
+}
+```
+
+## HTTP Test Assertions
+
+All tests assertions provided by Symfony (assertions for status codes, headers, cookies, XML documents...) can be used out of the box with the API Platform test client:
+
+```php
+<?php
+// api/tests/BooksTest.php
+
+namespace App\Tests;
+
+use ApiPlatform\Core\Bridge\Symfony\Bundle\Test\ApiTestCase;
+
+class BooksTest extends ApiTestCase
+{
+    public function testGetCollection(): void
+    {
+        static::createClient()->request('GET', '/books');
+
+        $this->assertResponseIsSuccessful();
+        $this->assertResponseHeaderSame('content-type', 'application/ld+json; charset=utf-8');
+    }
+}
+```
+
+[Check out the dedicated Symfony documentation entry](https://symfony.com/doc/current/testing/functional_tests_assertions.html).

distribution/index.md

@@ -38,9 +38,9 @@ API Platform uses these model classes to expose a web API having a bunch of buil
 * filtering
 * sorting
 * hypermedia/[HATEOAS](https://en.wikipedia.org/wiki/HATEOAS) and content negotiation support ([JSON-LD](http://json-ld.org),
-  [HAL](http://blog.stateless.co/post/13296666138/json-linking-with-hal), [JSON API](http://jsonapi.org/))
+  [HAL](http://blog.stateless.co/post/13296666138/json-linking-with-hal), [JSON API](http://jsonapi.org/)...)
 * [GraphQL support](http://graphql.org/)
-* Nice UI and machine-readable documentations ([Swagger/OpenAPI](https://swagger.io), [Hydra](http://hydra-cg.com))
+* Nice UI and machine-readable documentations ([Swagger UI/OpenAPI](https://swagger.io), [Hydra](http://hydra-cg.com))
 * authentication ([Basic HTTP](https://en.wikipedia.org/wiki/Basic_access_authentication), cookies as well as [JWT](https://jwt.io/)
   and [OAuth](https://oauth.net/) through extensions)
 * [CORS headers](https://developer.mozilla.org/en-US/docs/Web/HTTP/Access_control_CORS)
@@ -49,7 +49,7 @@ API Platform uses these model classes to expose a web API having a bunch of buil
 * and basically everything needed to build modern APIs.
 
 One more thing, before we start: as the API Platform distribution includes [the Symfony framework](https://symfony.com),
-it is compatible with most [Symfony bundles](https://symfony.com/blog/the-30-most-useful-symfony-bundles-and-making-them-even-better)
+it is compatible with most [Symfony bundles](https://flex.symfony.com)
 (plugins) and benefits from the numerous extensions points provided by this rock-solid foundation (events, DIC...).
 Adding features like custom, service-oriented, API endpoints, JWT or OAuth authentication, HTTP caching, mail sending or
 asynchronous jobs to your APIs is straightforward.