engelsystem/tests/Unit/Controllers/Api/ApiBaseControllerTest.php

<?php

declare(strict_types=1);

namespace Engelsystem\Test\Unit\Controllers\Api;

use Engelsystem\Http\UrlGeneratorInterface;
use Engelsystem\Test\Unit\Controllers\ControllerTest as TestCase;
use League\OpenAPIValidation\PSR7\OperationAddress as OpenApiAddress;
use League\OpenAPIValidation\PSR7\ResponseValidator as OpenApiResponseValidator;
use League\OpenAPIValidation\PSR7\ValidatorBuilder as OpenApiValidatorBuilder;
use PHPUnit\Framework\MockObject\MockObject;
use Psr\Http\Message\ResponseInterface;

abstract class ApiBaseControllerTest extends TestCase
{
    protected OpenApiResponseValidator $validator;
    protected UrlGeneratorInterface $url;

    protected function validateApiResponse(string $path, string $method, ResponseInterface $response): void
    {
        $operation = new OpenApiAddress($path, $method);
        $this->validator->validate($operation, $response);
    }

    public function setUp(): void
    {
        parent::setUp();
        $this->initDatabase();

        $openApiDefinition = $this->app->get('path.resources.api') . '/openapi.yml';
        $this->validator = (new OpenApiValidatorBuilder())
            ->fromYamlFile($openApiDefinition)
            ->getResponseValidator();

        /** @var UrlGeneratorInterface|MockObject $url */
        $url = $this->getMockForAbstractClass(UrlGeneratorInterface::class);
        $url->expects($this->any())
            ->method('to')
            ->willReturnCallback(function (string $path, array $params): string {
                $query = http_build_query($params);
                return $path . ($query ? '?' . $query : '');
            });
        $this->url = $url;
    }
}