animethemes-server/tests/Feature/Http/Api/SearchTest.php

<?php

declare(strict_types=1);

namespace Http\Api;

use App\Http\Api\Parser\FieldParser;
use App\Http\Api\Parser\SearchParser;
use App\Http\Resources\List\Collection\PlaylistCollection;
use App\Http\Resources\SearchResource;
use App\Http\Resources\Wiki\Anime\Collection\ThemeCollection;
use App\Http\Resources\Wiki\Collection\AnimeCollection;
use App\Http\Resources\Wiki\Collection\ArtistCollection;
use App\Http\Resources\Wiki\Collection\SeriesCollection;
use App\Http\Resources\Wiki\Collection\SongCollection;
use App\Http\Resources\Wiki\Collection\StudioCollection;
use App\Http\Resources\Wiki\Collection\VideoCollection;
use Illuminate\Foundation\Testing\WithFaker;
use Illuminate\Support\Arr;
use Illuminate\Support\Facades\Config;
use Tests\TestCase;

/**
 * Class SearchTest.
 */
class SearchTest extends TestCase
{
    use WithFaker;

    /**
     * The Search Endpoint shall require a search term.
     *
     * @return void
     */
    public function testNoSearchTerm(): void
    {
        $response = $this->get(route('api.search.show'));

        $response->assertJsonValidationErrors(SearchParser::param());
    }

    /**
     * The Search Endpoint shall display the Search attributes.
     *
     * @return void
     */
    public function testSearchAttributes(): void
    {
        $driver = Config::get('scout.driver');
        if (empty($driver)) {
            static::markTestSkipped('A driver must be configured for this test');
        }

        $q = $this->faker->word();

        $parameters = [
            SearchParser::param() => $q,
        ];

        $response = $this->get(route('api.search.show', $parameters));

        $response->assertJson([
            SearchResource::$wrap => [
                AnimeCollection::$wrap => [],
                ThemeCollection::$wrap => [],
                ArtistCollection::$wrap => [],
                PlaylistCollection::$wrap => [],
                SeriesCollection::$wrap => [],
                SongCollection::$wrap => [],
                StudioCollection::$wrap => [],
                VideoCollection::$wrap => [],
            ],
        ]);
    }

    /**
     * The Search Endpoint shall allow each resource to be included/excluded in a sparse fieldset.
     *
     * @return void
     */
    public function testSearchSparseFieldsets(): void
    {
        $driver = Config::get('scout.driver');
        if (empty($driver)) {
            static::markTestSkipped('A driver must be configured for this test');
        }

        $fields = [
            AnimeCollection::$wrap,
            ThemeCollection::$wrap,
            ArtistCollection::$wrap,
            PlaylistCollection::$wrap,
            SeriesCollection::$wrap,
            SongCollection::$wrap,
            StudioCollection::$wrap,
            VideoCollection::$wrap,
        ];

        $includedFields = Arr::random($fields, $this->faker->numberBetween(1, count($fields)));

        $q = $this->faker->word();

        $parameters = [
            SearchParser::param() => $q,
            FieldParser::param() => [
                SearchResource::$wrap => implode(',', $includedFields),
            ],
        ];

        $response = $this->get(route('api.search.show', $parameters));

        $response->assertJsonStructure([
            SearchResource::$wrap => $includedFields,
        ]);
    }
}