VersionControllerTest.php

<?php

declare(strict_types=1);

namespace App\Tests\Application\Tool\Transport\Controller\Api;

use App\General\Domain\Utils\JSON;
use App\Log\Application\Resource\LogRequestResource;
use App\Tests\TestCase\WebTestCase;
use PHPUnit\Framework\Attributes\TestDox;
use Symfony\Component\HttpFoundation\Response;
use Throwable;

use function file_get_contents;

/**
 * @package App\Tests
 */
class VersionControllerTest extends WebTestCase
{
    private string $baseUrl = self::API_URL_PREFIX . '/version';

    /**
     * @throws Throwable
     */
    #[TestDox('Test that version route returns success response.')]
    public function testThatVersionRouteReturns200(): void
    {
        $client = $this->getTestClient();

        $client->request('GET', $this->baseUrl);
        $response = $client->getResponse();
        static::assertSame(Response::HTTP_OK, $response->getStatusCode(), "Response:\n" . $response);
    }

    /**
     * @throws Throwable
     */
    #[TestDox('Test that version route does not make request log.')]
    public function testThatVersionRouteDoesNotMakeRequestLog(): void
    {
        $resource = static::getContainer()->get(LogRequestResource::class);
        $expectedLogCount = $resource->count();
        $client = $this->getTestClient();

        $client->request('GET', $this->baseUrl);
        static::assertSame($expectedLogCount, $resource->count());
    }

    /**
     * @throws Throwable
     */
    #[TestDox('Test that `X-API-VERSION` is added to response headers.')]
    public function testThatApiVersionIsAddedToResponseHeaders(): void
    {
        $client = $this->getTestClient();

        $client->request('GET', $this->baseUrl);
        $response = $client->getResponse();
        $version = $response->headers->get('X-API-VERSION');
        static::assertNotNull($version);
        static::assertSame(
            JSON::decode((string)file_get_contents(__DIR__ . '/../../../../../../composer.json'))->version,
            $version,
        );
    }
}