[Tests] Add test for default include paths

Author: lindyhopchris

tests/lib/Acceptance/DefaultIncludePaths/Test.php

@@ -0,0 +1,81 @@
+<?php
+/*
+ * Copyright 2021 Cloud Creativity Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare(strict_types=1);
+
+namespace LaravelJsonApi\Laravel\Tests\Acceptance\DefaultIncludePaths;
+
+use App\JsonApi\V1\Posts\PostCollectionQuery;
+use App\Models\Post;
+use App\Models\Tag;
+use LaravelJsonApi\Laravel\Facades\JsonApiRoute;
+use LaravelJsonApi\Laravel\Http\Controllers\JsonApiController;
+use LaravelJsonApi\Laravel\Tests\Acceptance\TestCase;
+
+class Test extends TestCase
+{
+
+    /**
+     * @return void
+     */
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->app->bind(PostCollectionQuery::class, TestRequest::class);
+
+        JsonApiRoute::server('v1')->prefix('api/v1')->resources(function ($server) {
+            $server->resource('posts', JsonApiController::class);
+        });
+    }
+
+    public function test(): void
+    {
+        $posts = Post::factory()->count(2)->create();
+        $tag = Tag::factory()->create();
+        $tag->posts()->save($posts[0]);
+
+        $response = $this
+            ->withoutExceptionHandling()
+            ->jsonApi('posts')
+            ->get('/api/v1/posts');
+
+        $response->assertFetchedMany($posts)->assertIncluded([
+            ['type' => 'users', 'id' => $posts[0]->author],
+            ['type' => 'users', 'id' => $posts[1]->author],
+            ['type' => 'tags', 'id' => $tag],
+        ]);
+    }
+
+    /**
+     * When a query request is using default include paths, we expect the client to be able
+     * to ask for nothing to be included by providing an empty include path.
+     */
+    public function testNoneIncluded(): void
+    {
+        $posts = Post::factory()->count(2)->create();
+
+        $response = $this
+            ->withoutExceptionHandling()
+            ->jsonApi('posts')
+            ->get('/api/v1/posts?include=');
+
+        $response->assertFetchedMany($posts);
+        // @TODO assertNoneIncluded should be available on the response.
+        $response->getDocument()->assertNoneIncluded();
+    }
+}

tests/lib/Acceptance/DefaultIncludePaths/TestRequest.php

@@ -0,0 +1,31 @@
+<?php
+/*
+ * Copyright 2021 Cloud Creativity Limited
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+declare(strict_types=1);
+
+namespace LaravelJsonApi\Laravel\Tests\Acceptance\DefaultIncludePaths;
+
+use App\JsonApi\V1\Posts\PostCollectionQuery;
+
+class TestRequest extends PostCollectionQuery
+{
+
+    /**
+     * @var string[]|null
+     */
+    protected ?array $defaultIncludePaths = ['author', 'tags'];
+}