UseCaseTest.php

<?php


namespace Tests\Unit\Source\UseCases\Users\UpdateUser;

use Carbon\Carbon;
use Source\Entities\User;
use Source\Entities\Doorcode;
use Source\Entities\Password;
use PHPUnit\Framework\TestCase;
use Tests\Doubles\AuthorizerStub;
use Source\Exceptions\EntityNotFoundException;
use Tests\Doubles\InMemoryUsersRepositoryStub;
use Source\UseCases\Users\UpdateUser\UpdateUser;
use Source\Gateways\Users\InMemoryUsersRepository;
use Source\UseCases\Users\UpdateUser\ResponseModel;

class UseCaseTest extends TestCase
{
    protected InMemoryUsersRepository $usersRepository;

    protected UpdateUser $useCase;

    protected ResponseModel $response;

    protected PresenterStub $presenter;

    protected AuthorizerStub $authorizer;

    public function setUp(): void
    {
        parent::setUp();

        $this->authorizer = new AuthorizerStub();
        $this->usersRepository = new InMemoryUsersRepository();
        $this->useCase = new UpdateUser($this->authorizer, $this->usersRepository);
        $this->presenter = new PresenterStub();
    }

    protected function createUserAttributes(User $user, ?string $password = null, ?string $doorcode = null): array
    {
        $expires = $user->getExpiresAt();
        if ($expires) {
            $expires = $expires->toString();
        }

        return [
            'first_name'   => $user->getFirstName(),
            'last_name'    => $user->getLastName(),
            'display_name' => $user->getDisplayName(),
            'emplid'       => $user->getEmplid(),
            'email'        => $user->getEmail(),
            'password'     => $password,
            'doorcode'     => $doorcode,
            'expires_at'   => $expires,
            'salt'         => '',
        ];
    }

    /**
     * @param string $userId
     * @param array  $attributes
     * @throws EntityNotFoundException
     */
    public function handleTest(string $userId, array $attributes): void
    {
        $this->useCase->update($userId, $attributes, $this->presenter);

        $this->response = $this->presenter->response;
    }

    /**
     * @test
     * @throws EntityNotFoundException
     */
    public function presenter_was_called(): void
    {
        $user = new User(69, 'special name', '', '', '');
        $this->usersRepository->create($user);

        $this->handleTest('69', $this->createUserAttributes($user));

        $this->assertTrue($this->presenter->wasPresenterCalled());
    }

    /**
     * @test
     * @throws EntityNotFoundException
     */
    public function it_updates_a_user(): void
    {
        $user = new User(69, 'camdiddle beerbong', '', '', '');
        $updatedUser = new User(69, 'updated name', '', '', '');
        $this->usersRepository->create($user);

        $this->handleTest('69', $this->createUserAttributes($updatedUser));

        $this->assertFalse($this->response->hasError());
        $this->assertEquals('updated name', $this->usersRepository->get('69')->getFirstName());
        $this->assertEquals($updatedUser, $this->response->getUser());
        $this->assertTrue($this->authorizer->adminRightsWereProtected());
    }

    /**
     * @test
     * @throws EntityNotFoundException
     */
    public function it_cannot_update_non_existent_user(): void
    {
        $this->expectException(EntityNotFoundException::class);
        $updatedUser = new User(69, 'updated name', '', '', '');

        $this->handleTest('420', $this->createUserAttributes($updatedUser));
    }

    /**
     * @test
     * @throws EntityNotFoundException
     */
    public function it_sets_error_on_fail(): void
    {
        $updatedUser = new User(420, 'updated name', '', '', '');

        $stub = new InMemoryUsersRepositoryStub();
        $stub->setUserToReturnOnGet($updatedUser);
        $this->useCase = new UpdateUser($this->authorizer, $stub);

        $this->handleTest('420', $this->createUserAttributes($updatedUser));

        $this->assertTrue($this->response->hasError());
        $this->assertEquals('Unable to update user.', $this->response->getError());
    }

    /**
     * @test
     * @throws EntityNotFoundException
     */
    public function it_doesnt_need_doorcode_or_password(): void
    {
        $user = new User(69, '', '', '', '', null, new Password('pass'), new Doorcode('door'));
        $updatedUser = new User(0, '', '', '', '');

        $this->usersRepository->create($user);

        $this->handleTest('69', $this->createUserAttributes($updatedUser, null, null));

        $this->assertEquals('pass', $this->response->getUser()->getPassword()->getHash());
        $this->assertEquals('door', $this->response->getUser()->getDoorcode()->getHash());
    }

    /**
     * @test
     * @throws EntityNotFoundException
     */
    public function it_will_overwrite_pass_and_door_code(): void
    {
        $user = new User(69, '', '', '', '');
        $updatedUser = new User(0, '', '', '', '');

        $this->usersRepository->create($user);

        $this->handleTest('69', $this->createUserAttributes($updatedUser, 'pass', 'door'));

        $this->assertTrue($this->response->getUser()->getPassword()->matches('pass'));
        $this->assertEquals(
            Doorcode::hash('', 'door')->getHash(),
            $this->response->getUser()->getDoorcode()->getHash()
        );
    }

    /**
     * @test
     * @throws \Source\Exceptions\EntityNotFoundException
     */
    public function it_will_set_expires_at(): void
    {
        $user = new User(69, '', '', '', '');
        $updatedUser = new User(0, '', '', '', '', null, null, null, new Carbon('2020-03-07 20:58:50'), null, null);

        $this->usersRepository->create($user);

        $this->handleTest('69', $this->createUserAttributes($updatedUser));

        $this->assertEquals('2020-03-07T20:58:50+00:00', $this->response->getUser()->getExpiresAt()->format('c'));
    }

    /**
     * @test
     * @throws \Source\Exceptions\EntityNotFoundException
     */
    public function it_will_update_nothing_if_no_changes_are_required(): void
    {
        $user = new User(
            69,
            'scat',
            'man',
            'IM THE SCAT MAN',
            'do biddle be bahhhh',
            'hes the scat man',
            new Password('hash'),
            new Doorcode('hash')
        );

        $this->usersRepository->create($user);

        $this->handleTest('69', ['salt' => '']);

        $this->assertFalse($this->response->hasError());
        $this->assertEquals($user, $this->response->getUser());
        $this->assertTrue($this->authorizer->adminRightsWereProtected());
    }
}