myep/tests/Controller/Admin/AccommodationBooking/GenerateAccessLinkControllerTest.php

<?php

declare(strict_types=1);

namespace App\Tests\Controller\Admin\AccommodationBooking;

use App\Controller\Admin\AccommodationBooking\GenerateAccessLinkController;
use App\Entity\Groups\AccommodationBooking;
use App\Enum\Groups\AccommodationBookingStatus;
use App\Service\AccommodationBookingService;
use PHPUnit\Framework\TestCase;
use Psr\Log\LoggerInterface;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Symfony\Component\Security\Core\Exception\AccessDeniedException;

/**
 * Covers the guards around issuing an access link — the issuing itself is tested in
 * AccommodationBookingServiceTest.
 */
class GenerateAccessLinkControllerTest extends TestCase
{
    public function testGetRendersTheConfirmationModal(): void
    {
        $bookingService = $this->createMock(AccommodationBookingService::class);
        $bookingService->expects(self::never())->method('regenerateAccessLink');

        $controller = new TestableGenerateAccessLinkController($bookingService, $this->createMock(LoggerInterface::class));

        $response = $controller->index($this->openBooking(), Request::create('/admin/accommodation-booking/1/generate-access-link'));

        self::assertSame(Response::HTTP_OK, $response->getStatusCode());
        self::assertSame('admin/accommodation_booking/modal_generate_access_link.html.twig', $controller->renderedView);
    }

    public function testPostGeneratesTheLinkAndRedirectsTheBrowser(): void
    {
        $booking = $this->openBooking();

        $bookingService = $this->createMock(AccommodationBookingService::class);
        $bookingService->expects(self::once())->method('regenerateAccessLink')->with($booking);

        $controller = new TestableGenerateAccessLinkController($bookingService, $this->createMock(LoggerInterface::class));

        $response = $controller->index($booking, Request::create('/admin/accommodation-booking/1/generate-access-link', 'POST'));

        self::assertTrue($response->headers->has('HX-Redirect'));
    }

    /**
     * A draft is the office's own workbench: nothing has been offered, so a link would
     * point the customer at a half-prepared record.
     *
     * @dataProvider requestMethods
     */
    public function testADraftGetsNoAccessLinkAtAll(string $method): void
    {
        $booking = $this->openBooking();
        $booking->setStatus(AccommodationBookingStatus::Draft);

        $bookingService = $this->createMock(AccommodationBookingService::class);
        $bookingService->expects(self::never())->method('regenerateAccessLink');

        $controller = new TestableGenerateAccessLinkController($bookingService, $this->createMock(LoggerInterface::class));

        $response = $controller->index($booking, Request::create('/admin/accommodation-booking/1/generate-access-link', $method));

        self::assertSame(Response::HTTP_FOUND, $response->getStatusCode());
        self::assertNull($controller->renderedView, 'not even the modal offering the action');
    }

    /**
     * @return iterable<string, array{string}>
     */
    public static function requestMethods(): iterable
    {
        yield 'GET' => [Request::METHOD_GET];
        yield 'POST' => [Request::METHOD_POST];
    }

    public function testPostWithAnInvalidTokenIsDenied(): void
    {
        $bookingService = $this->createMock(AccommodationBookingService::class);
        $bookingService->expects(self::never())->method('regenerateAccessLink');

        $controller = new TestableGenerateAccessLinkController($bookingService, $this->createMock(LoggerInterface::class), tokenValid: false);

        $this->expectException(AccessDeniedException::class);

        $controller->index($this->openBooking(), Request::create('/admin/accommodation-booking/1/generate-access-link', 'POST'));
    }

    private function openBooking(): AccommodationBooking
    {
        $booking = new AccommodationBooking();
        $booking->setStatus(AccommodationBookingStatus::Open);
        $booking->setGroupName('Schulklasse 7b');
        $booking->setEmail('[email protected]');

        return $booking;
    }
}

final class TestableGenerateAccessLinkController extends GenerateAccessLinkController
{
    public ?string $renderedView = null;

    /** @var list<array{type: string, message: mixed}> */
    public array $flashes = [];

    public function __construct(
        AccommodationBookingService $bookingService,
        LoggerInterface $logger,
        private readonly bool $tokenValid = true,
    ) {
        parent::__construct($bookingService, $logger);
    }

    protected function isCsrfTokenValid(string $id, #[\SensitiveParameter] ?string $token): bool
    {
        return $this->tokenValid;
    }

    /**
     * @param array<string, mixed> $parameters
     */
    protected function render(string $view, array $parameters = [], ?Response $response = null): Response
    {
        $this->renderedView = $view;

        return new Response();
    }

    protected function addFlash(string $type, mixed $message): void
    {
        $this->flashes[] = ['type' => $type, 'message' => $message];
    }

    /**
     * @param array<string, mixed> $parameters
     */
    protected function generateUrl(string $route, array $parameters = [], int $referenceType = 1): string
    {
        return '/'.$route.'?'.http_build_query($parameters);
    }
}