engelsystem/tests/Unit/Controllers/Admin/UserGoodieControllerTest.php

<?php

declare(strict_types=1);

namespace Engelsystem\Test\Unit\Controllers\Admin;

use Engelsystem\Config\GoodieType;
use Engelsystem\Controllers\Admin\UserGoodieController;
use Engelsystem\Helpers\Authenticator;
use Engelsystem\Http\Exceptions\HttpNotFound;
use Engelsystem\Http\Exceptions\ValidationException;
use Engelsystem\Http\Redirector;
use Engelsystem\Http\Validation\Validator;
use Engelsystem\Models\User\PersonalData;
use Engelsystem\Models\User\State;
use Engelsystem\Models\User\User;
use Engelsystem\Test\Unit\Controllers\ControllerTest;
use Engelsystem\Test\Unit\HasDatabase;
use Illuminate\Database\Eloquent\ModelNotFoundException;
use PHPUnit\Framework\MockObject\MockObject;

class UserGoodieControllerTest extends ControllerTest
{
    use HasDatabase;

    /**
     * @covers \Engelsystem\Controllers\Admin\UserGoodieController::editGoodie
     * @covers \Engelsystem\Controllers\Admin\UserGoodieController::__construct
     */
    public function testIndex(): void
    {
        $this->config->set('goodie_type', GoodieType::Tshirt->value);
        $request = $this->request->withAttribute('user_id', 1);
        /** @var Authenticator|MockObject $auth */
        $auth = $this->createMock(Authenticator::class);
        /** @var Redirector|MockObject $redirector */
        $redirector = $this->createMock(Redirector::class);
        $user = new User();
        User::factory()->create();

        $this->setExpects($this->response, 'withView', ['admin/user/edit-goodie.twig'], $this->response);

        $controller = new UserGoodieController($auth, $this->config, $this->log, $redirector, $this->response, $user);

        $controller->editGoodie($request);
    }

    /**
     * @covers \Engelsystem\Controllers\Admin\UserGoodieController::editGoodie
     */
    public function testIndexUserNotFound(): void
    {
        $this->config->set('goodie_type', GoodieType::Goodie->value);
        /** @var Authenticator|MockObject $auth */
        $auth = $this->createMock(Authenticator::class);
        /** @var Redirector|MockObject $redirector */
        $redirector = $this->createMock(Redirector::class);
        $user = new User();

        $controller = new UserGoodieController($auth, $this->config, $this->log, $redirector, $this->response, $user);

        $this->expectException(ModelNotFoundException::class);
        $controller->editGoodie($this->request);
    }

    /**
     * @covers \Engelsystem\Controllers\Admin\UserGoodieController::editGoodie
     * @covers \Engelsystem\Controllers\Admin\UserGoodieController::checkActive
     */
    public function testEditShirtGoodieNone(): void
    {
        $this->config->set('goodie_type', GoodieType::None->value);
        /** @var Authenticator|MockObject $auth */
        $auth = $this->createMock(Authenticator::class);
        /** @var Redirector|MockObject $redirector */
        $redirector = $this->createMock(Redirector::class);
        $user = new User();

        $controller = new UserGoodieController($auth, $this->config, $this->log, $redirector, $this->response, $user);

        $this->expectException(HttpNotFound::class);
        $controller->editGoodie($this->request);
    }

    /**
     * @covers \Engelsystem\Controllers\Admin\UserGoodieController::saveGoodie
     * @covers \Engelsystem\Controllers\Admin\UserGoodieController::checkActive
     */
    public function testSaveShirtGoodieNone(): void
    {
        $this->config->set('goodie_type', GoodieType::None->value);
        /** @var Authenticator|MockObject $auth */
        $auth = $this->createMock(Authenticator::class);
        /** @var Redirector|MockObject $redirector */
        $redirector = $this->createMock(Redirector::class);
        $user = new User();

        $controller = new UserGoodieController($auth, $this->config, $this->log, $redirector, $this->response, $user);

        $this->expectException(HttpNotFound::class);
        $controller->saveGoodie($this->request);
    }

    /**
     * @todo Factor out separate tests. Isolated User, Config and permissions per test.
     * @covers \Engelsystem\Controllers\Admin\UserGoodieController::saveGoodie
     */
    public function testSaveGoodie(): void
    {
        $this->config->set('goodie_type', GoodieType::Tshirt->value);
        $request = $this->request
            ->withAttribute('user_id', 1)
            ->withParsedBody([
                'shirt_size' => 'S',
            ]);
        /** @var Authenticator|MockObject $auth */
        $auth = $this->createMock(Authenticator::class);
        $this->config->set('tshirt_sizes', ['S' => 'Small', 'XS' => 'Extra Small']);
        /** @var Redirector|MockObject $redirector */
        $redirector = $this->createMock(Redirector::class);
        User::factory()
            ->has(State::factory())
            ->has(PersonalData::factory())
            ->create();

        $auth
            ->expects($this->exactly(5))
            ->method('can')
            ->with('admin_arrive')
            ->willReturnOnConsecutiveCalls(true, true, false, false, true);
        $this->setExpects($redirector, 'back', null, $this->response, $this->exactly(5));

        $controller = new UserGoodieController(
            $auth,
            $this->config,
            $this->log,
            $redirector,
            $this->response,
            new User()
        );
        $controller->setValidator(new Validator());

        // Set shirt size
        $controller->saveGoodie($request);

        $this->assertHasNotification('user.edit.success');
        $this->assertTrue($this->log->hasInfoThatContains('Updated user goodie state'));

        $user = User::find(1);
        $this->assertEquals('S', $user->personalData->shirt_size);
        $this->assertFalse($user->state->arrived);
        $this->assertFalse($user->state->active);
        $this->assertFalse($user->state->got_goodie);

        // Set active, arrived and got_goodie
        $request = $request
            ->withParsedBody([
                'shirt_size' => 'S',
                'arrived'    => '1',
                'active'     => '1',
                'got_goodie'  => '1',
            ]);

        $controller->saveGoodie($request);

        $user = User::find(1);
        $this->assertTrue($user->state->active);
        $this->assertTrue($user->state->arrived);
        $this->assertTrue($user->state->got_goodie);

        // Shirt size not available
        $request = $request
            ->withParsedBody([
                'shirt_size' => 'L',
            ]);

        try {
            $controller->saveGoodie($request);
            self::fail('Expected exception was not raised');
        } catch (ValidationException) {
            // ignore
        }
        $user = User::find(1);
        $this->assertEquals('S', $user->personalData->shirt_size);

        // Not allowed changing arrived
        $request = $request
            ->withParsedBody([
                'shirt_size' => 'S',
                'arrived'    => '1',
            ]);

        $user->state->arrived = false;
        $user->state->save();
        $this->assertFalse($user->state->arrived);
        $controller->saveGoodie($request);
        $user = User::find(1);
        $this->assertFalse($user->state->arrived);

        // Goodie enabled but not a shirt
        $this->config->set('goodie_type', GoodieType::Goodie->value);
        $request = $request
            ->withParsedBody([
                'shirt_size' => 'XS',
            ]);

        $controller->saveGoodie($request);
        $user = User::find(1);
        $this->assertEquals('S', $user->personalData->shirt_size);

        // Shirt enabled
        $this->config->set('goodie_type', GoodieType::Tshirt->value);
        $request = $request
            ->withParsedBody([
                'shirt_size' => 'XS',
            ]);

        $controller->saveGoodie($request);
        $user = User::find(1);
        $this->assertEquals('XS', $user->personalData->shirt_size);
    }

    /**
     * @covers \Engelsystem\Controllers\Admin\UserGoodieController::saveGoodie
     */
    public function testSaveGoodieUserNotFound(): void
    {
        $this->config->set('goodie_type', GoodieType::Goodie->value);
        /** @var Authenticator|MockObject $auth */
        $auth = $this->createMock(Authenticator::class);
        /** @var Redirector|MockObject $redirector */
        $redirector = $this->createMock(Redirector::class);
        $user = new User();

        $controller = new UserGoodieController($auth, $this->config, $this->log, $redirector, $this->response, $user);

        $this->expectException(ModelNotFoundException::class);
        $controller->editGoodie($this->request);
    }
}