Merge pull request #13 from eerison/feature/post-put-delete

Added apiClient

Author: eerison

README.md

@@ -65,11 +65,78 @@ it('can be used with snapshot')
     ->toMatchJsonSnapshot();
 ```
 
+##Converting api platform test in pest
+
+Before
+
+```php
+<?php
+// api/tests/BooksTest.php
+
+namespace App\Tests;
+
+use ApiPlatform\Core\Bridge\Symfony\Bundle\Test\ApiTestCase;
+use App\Entity\Book;
+
+class BooksTest extends ApiTestCase
+{
+    public function testGetCollection(): void
+    {
+        // The client implements Symfony HttpClient's `HttpClientInterface`, and the response `ResponseInterface`
+        $response = static::createClient()->request('GET', '/books');
+
+        $this->assertResponseIsSuccessful();
+
+        // Asserts that the returned JSON is a superset of this one
+        $this->assertJsonContains([
+            '@context' => '/contexts/Book',
+            '@id' => '/books',
+            '@type' => 'hydra:Collection',
+            'hydra:totalItems' => 100,
+            'hydra:view' => [
+                '@id' => '/books?page=1',
+                '@type' => 'hydra:PartialCollectionView',
+                'hydra:first' => '/books?page=1',
+                'hydra:last' => '/books?page=4',
+                'hydra:next' => '/books?page=2',
+            ],
+        ]);
+
+        // Asserts that the returned JSON is validated by the JSON Schema generated for this resource by API Platform
+        // This generated JSON Schema is also used in the OpenAPI spec!
+        $this->assertMatchesResourceCollectionJsonSchema(Book::class);
+    }
+```
+
+After
+
+```php
+use App\Entity\Book;
+
+it('can get a collection')
+    ->get('/books')
+    ->assertResponseIsSuccessful()
+    ->expectResponseContent()
+        ->json()
+        ->toHaveKey('@context', '/contexts/Book')
+        ->toHaveKey('@id', '/books')
+        ->toHaveKey('@type', 'hydra:Collection')
+        ->toHaveKey('hydra:totalItems', 100)
+        ->toHaveKey('hydra:view.@id', '/books?page=1')
+        ->toHaveKey('hydra:view.@type', 'hydra:PartialCollectionView')
+        ->toHaveKey('hydra:first', '/books?page=1')
+        ->toHaveKey('hydra:last', '/books?page=4')
+        ->toHaveKey('hydra:next', '/books?page=2')
+        ->toMatchesResourceCollectionJsonSchema(Book::class)
+        ;
+```
+
 Expectations
 - `toMatchesResourceCollectionJsonSchema(Your::class)`
 - `toMatchesResourceItemJsonSchema(Your::class)`
 
 Functions
+- `apiClient()`
 - `get()`
 - `post()`
 - `put()`

src/Autoload.php

@@ -4,12 +4,22 @@
 
 namespace Eerison\PestPluginApiPlatform;
 
+use ApiPlatform\Core\Bridge\Symfony\Bundle\Test\Client;
 use Pest\Plugin;
 use Symfony\Contracts\HttpClient\ResponseInterface;
 
 Plugin::uses(Resource::class);
 Plugin::uses(ResourceShortcuts::class);
 
+/**
+ * @param array<string> $kernelOptions
+ * @param array<string> $defaultOptions
+ */
+function apiClient(array $kernelOptions = [], array $defaultOptions = []): Client
+{
+    return test()->apiClient($kernelOptions, $defaultOptions);
+}
+
 /**
  * @param array<string> $options
  */

src/Resource.php

@@ -4,6 +4,7 @@
 
 namespace Eerison\PestPluginApiPlatform;
 
+use ApiPlatform\Core\Bridge\Symfony\Bundle\Test\Client;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Contracts\HttpClient\ResponseInterface;
@@ -15,6 +16,15 @@ trait Resource
 {
     private ResponseInterface $response;
 
+    /**
+     * @param array<string> $kernelOptions
+     * @param array<string> $defaultOptions
+     */
+    public function apiClient(array $kernelOptions = [], array $defaultOptions = []): Client
+    {
+        return ApiPlatform::createApiClient($kernelOptions, $defaultOptions);
+    }
+
     public function get(string $url, array $options = []): TestCase
     {
         $this->response = ApiPlatform::createApiClient()->request(Request::METHOD_GET, $url, $options);

tests/ResourceResponseTest.php

@@ -1,5 +1,6 @@
 <?php
 
+use function Eerison\PestPluginApiPlatform\apiClient;
 use function Eerison\PestPluginApiPlatform\get;
 
 it('is checking the body structure')
@@ -25,3 +26,15 @@
         ->toHaveKey('company.address')
     ;
 });
+
+it('can use apiClient', function () {
+    $apiClient = apiClient();
+
+    $response = $apiClient->request('GET', '/foo/response/200');
+    $content = $response->getContent();
+
+    expect($content)
+        ->json()
+        ->toHaveKey('company.address')
+    ;
+});