faker->randomDigitNotNull(), function () { SongResource::factory() ->for(Song::factory()) ->for(ExternalResource::factory(), SongResource::RELATION_RESOURCE) ->create(); }); $songResources = SongResource::all(); $response = $this->get(route('api.songresource.index')); $response->assertJson( json_decode( json_encode( (new SongResourceCollection($songResources, new Query())) ->response() ->getData() ), true ) ); } /** * The Song Resource Index Endpoint shall be paginated. * * @return void */ public function testPaginated(): void { Collection::times($this->faker->randomDigitNotNull(), function () { SongResource::factory() ->for(Song::factory()) ->for(ExternalResource::factory(), SongResource::RELATION_RESOURCE) ->create(); }); $response = $this->get(route('api.songresource.index')); $response->assertJsonStructure([ SongResourceCollection::$wrap, 'links', 'meta', ]); } /** * The Song Resource Index Endpoint shall allow inclusion of related resources. * * @return void */ public function testAllowedIncludePaths(): void { $schema = new SongResourceSchema(); $allowedIncludes = collect($schema->allowedIncludes()); $selectedIncludes = $allowedIncludes->random($this->faker->numberBetween(1, $allowedIncludes->count())); $includedPaths = $selectedIncludes->map(fn (AllowedInclude $include) => $include->path()); $parameters = [ IncludeParser::param() => $includedPaths->join(','), ]; Collection::times($this->faker->randomDigitNotNull(), function () { SongResource::factory() ->for(Song::factory()) ->for(ExternalResource::factory(), SongResource::RELATION_RESOURCE) ->create(); }); $response = $this->get(route('api.songresource.index', $parameters)); $songResources = SongResource::with($includedPaths->all())->get(); $response->assertJson( json_decode( json_encode( (new SongResourceCollection($songResources, new Query($parameters))) ->response() ->getData() ), true ) ); } /** * The Song Resource Index Endpoint shall implement sparse fieldsets. * * @return void */ public function testSparseFieldsets(): void { $schema = new SongResourceSchema(); $fields = collect($schema->fields()); $includedFields = $fields->random($this->faker->numberBetween(1, $fields->count())); $parameters = [ FieldParser::param() => [ SongResourceResource::$wrap => $includedFields->map(fn (Field $field) => $field->getKey())->join(','), ], ]; Collection::times($this->faker->randomDigitNotNull(), function () { SongResource::factory() ->for(Song::factory()) ->for(ExternalResource::factory(), SongResource::RELATION_RESOURCE) ->create(); }); $response = $this->get(route('api.songresource.index', $parameters)); $songResources = SongResource::all(); $response->assertJson( json_decode( json_encode( (new SongResourceCollection($songResources, new Query($parameters))) ->response() ->getData() ), true ) ); } /** * The Song Resource Index Endpoint shall support sorting resources. * * @return void */ public function testSorts(): void { $schema = new SongResourceSchema(); /** @var Sort $sort */ $sort = collect($schema->fields()) ->filter(fn (Field $field) => $field instanceof SortableField) ->map(fn (SortableField $field) => $field->getSort()) ->random(); $parameters = [ SortParser::param() => $sort->format(Arr::random(Direction::cases())), ]; $query = new Query($parameters); Collection::times($this->faker->randomDigitNotNull(), function () { SongResource::factory() ->for(Song::factory()) ->for(ExternalResource::factory(), SongResource::RELATION_RESOURCE) ->create(); }); $response = $this->get(route('api.songresource.index', $parameters)); $songResources = $this->sort(SongResource::query(), $query, $schema)->get(); $response->assertJson( json_decode( json_encode( (new SongResourceCollection($songResources, $query)) ->response() ->getData() ), true ) ); } /** * The Song Resource Index Endpoint shall support filtering by created_at. * * @return void */ public function testCreatedAtFilter(): void { $createdFilter = $this->faker->date(); $excludedDate = $this->faker->date(); $parameters = [ FilterParser::param() => [ BasePivot::ATTRIBUTE_CREATED_AT => $createdFilter, ], PagingParser::param() => [ OffsetCriteria::SIZE_PARAM => Criteria::MAX_RESULTS, ], ]; Carbon::withTestNow($createdFilter, function () { Collection::times($this->faker->randomDigitNotNull(), function () { SongResource::factory() ->for(Song::factory()) ->for(ExternalResource::factory(), SongResource::RELATION_RESOURCE) ->create(); }); }); Carbon::withTestNow($excludedDate, function () { Collection::times($this->faker->randomDigitNotNull(), function () { SongResource::factory() ->for(Song::factory()) ->for(ExternalResource::factory(), SongResource::RELATION_RESOURCE) ->create(); }); }); $songResources = SongResource::query()->where(BasePivot::ATTRIBUTE_CREATED_AT, $createdFilter)->get(); $response = $this->get(route('api.songresource.index', $parameters)); $response->assertJson( json_decode( json_encode( (new SongResourceCollection($songResources, new Query($parameters))) ->response() ->getData() ), true ) ); } /** * The Song Resource Index Endpoint shall support filtering by updated_at. * * @return void */ public function testUpdatedAtFilter(): void { $updatedFilter = $this->faker->date(); $excludedDate = $this->faker->date(); $parameters = [ FilterParser::param() => [ BasePivot::ATTRIBUTE_UPDATED_AT => $updatedFilter, ], PagingParser::param() => [ OffsetCriteria::SIZE_PARAM => Criteria::MAX_RESULTS, ], ]; Carbon::withTestNow($updatedFilter, function () { Collection::times($this->faker->randomDigitNotNull(), function () { SongResource::factory() ->for(Song::factory()) ->for(ExternalResource::factory(), SongResource::RELATION_RESOURCE) ->create(); }); }); Carbon::withTestNow($excludedDate, function () { Collection::times($this->faker->randomDigitNotNull(), function () { SongResource::factory() ->for(Song::factory()) ->for(ExternalResource::factory(), SongResource::RELATION_RESOURCE) ->create(); }); }); $songResources = SongResource::query()->where(BasePivot::ATTRIBUTE_UPDATED_AT, $updatedFilter)->get(); $response = $this->get(route('api.songresource.index', $parameters)); $response->assertJson( json_decode( json_encode( (new SongResourceCollection($songResources, new Query($parameters))) ->response() ->getData() ), true ) ); } /** * The Song Resource Index Endpoint shall support constrained eager loading of resources by site. * * @return void */ public function testResourcesBySite(): void { $siteFilter = Arr::random(ResourceSite::cases()); $parameters = [ FilterParser::param() => [ ExternalResource::ATTRIBUTE_SITE => $siteFilter->localize(), ], IncludeParser::param() => SongResource::RELATION_RESOURCE, ]; Collection::times($this->faker->randomDigitNotNull(), function () { SongResource::factory() ->for(Song::factory()) ->for(ExternalResource::factory(), SongResource::RELATION_RESOURCE) ->create(); }); $response = $this->get(route('api.songresource.index', $parameters)); $songResources = SongResource::with([ SongResource::RELATION_RESOURCE => function (BelongsTo $query) use ($siteFilter) { $query->where(ExternalResource::ATTRIBUTE_SITE, $siteFilter->value); }, ]) ->get(); $response->assertJson( json_decode( json_encode( (new SongResourceCollection($songResources, new Query($parameters))) ->response() ->getData() ), true ) ); } }