firefly-iii/tests/Unit/Handlers/Events/UserEventHandlerTest.php

<?php
/**
 * UserEventHandlerTest.php
 * Copyright (c) 2019 james@firefly-iii.org
 *
 * This file is part of Firefly III (https://github.com/firefly-iii).
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as
 * published by the Free Software Foundation, either version 3 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <https://www.gnu.org/licenses/>.
 */
declare(strict_types=1);

namespace Tests\Unit\Handlers\Events;

use FireflyIII\Events\RegisteredUser;
use FireflyIII\Events\RequestedNewPassword;
use FireflyIII\Events\UserChangedEmail;
use FireflyIII\Handlers\Events\UserEventHandler;
use FireflyIII\Mail\ConfirmEmailChangeMail;
use FireflyIII\Mail\RegisteredUser as RegisteredUserMail;
use FireflyIII\Mail\RequestedNewPassword as RequestedNewPasswordMail;
use FireflyIII\Mail\UndoEmailChangeMail;
use FireflyIII\Models\Preference;
use FireflyIII\Models\Role;
use FireflyIII\Repositories\User\UserRepositoryInterface;
use Illuminate\Auth\Events\Login;
use Illuminate\Support\Facades\Mail;
use Log;
use Mockery;
use Preferences;
use Tests\TestCase;

/**
 * Class UserEventHandlerTest
 *
 * @SuppressWarnings(PHPMD.TooManyPublicMethods)
 * @SuppressWarnings(PHPMD.ExcessiveMethodLength)
 * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
 */
class UserEventHandlerTest extends TestCase
{
    /**
     *
     */
    public function setUp(): void
    {
        parent::setUp();
        Log::info(sprintf('Now in %s.', get_class($this)));
    }

    /**
     * @covers \FireflyIII\Handlers\Events\UserEventHandler
     * @covers \FireflyIII\Events\RegisteredUser
     */
    public function testAttachUserRole(): void
    {
        $repository = $this->mock(UserRepositoryInterface::class);
        $user       = $this->emptyUser();
        $event      = new RegisteredUser($user, '127.0.0.1');

        $repository->shouldReceive('count')->andReturn(1)->once();
        $repository->shouldReceive('attachRole')->withArgs([$user, 'owner'])->andReturn(true)->once();
        $listener = new UserEventHandler();
        $listener->attachUserRole($event);
        $this->assertTrue(true);
    }

    /**
     * @covers \FireflyIII\Handlers\Events\UserEventHandler
     */
    public function testCheckSingleUserIsAdminMulti(): void
    {
        $repository = $this->mock(UserRepositoryInterface::class);
        $user       = $this->user();
        $event      = new Login(null, $user, true);
        $listener   = new UserEventHandler();

        // mock stuff
        $repository->shouldReceive('count')->once()->andReturn(2);


        $listener->checkSingleUserIsAdmin($event);
        $this->assertTrue(true);
    }

    /**
     * @covers \FireflyIII\Handlers\Events\UserEventHandler
     */
    public function testCheckSingleUserIsAdminNoRole(): void
    {
        $repository = $this->mock(UserRepositoryInterface::class);
        $user       = $this->emptyUser();
        $event      = new Login(null, $user, true);
        $listener   = new UserEventHandler();

        // mock stuff

        $repository->shouldReceive('hasRole')->once()->andReturn(false);
        $repository->shouldReceive('count')->once()->andReturn(1);
        $repository->shouldReceive('getRole')->once()->andReturn(null);
        $repository->shouldReceive('attachRole')->once()->withArgs([Mockery::any(), 'owner']);
        $repository->shouldReceive('createRole')->once()->withArgs(['owner', 'Site Owner', 'User runs this instance of FF3'])->andReturn(new Role);
        Log::warning('The following error is part of a test.');
        $listener->checkSingleUserIsAdmin($event);
        $this->assertTrue(true);
    }

    /**
     * @covers \FireflyIII\Handlers\Events\UserEventHandler
     */
    public function testCheckSingleUserIsAdminNotAdmin(): void
    {
        $repository = $this->mock(UserRepositoryInterface::class);
        $user       = $this->emptyUser();
        $event      = new Login(null, $user, true);
        $listener   = new UserEventHandler();

        // mock stuff
        $repository->shouldReceive('hasRole')->once()->andReturn(false);
        $repository->shouldReceive('count')->once()->andReturn(1);
        $repository->shouldReceive('getRole')->once()->andReturn(new Role);
        $repository->shouldReceive('attachRole')->once()->withArgs([Mockery::any(), 'owner']);

        $listener->checkSingleUserIsAdmin($event);
        $this->assertTrue(true);
    }

    /**
     * @covers \FireflyIII\Handlers\Events\UserEventHandler
     */
    public function testCheckSingleUserIsAdminSingle(): void
    {
        $repository = $this->mock(UserRepositoryInterface::class);
        $user       = $this->user();
        $event      = new Login(null, $user, true);
        $listener   = new UserEventHandler();

        // mock stuff
        $repository->shouldReceive('hasRole')->once()->andReturn(true);
        $repository->shouldReceive('count')->once()->andReturn(1);

        $listener->checkSingleUserIsAdmin($event);
        $this->assertTrue(true);
    }

    /**
     * @covers \FireflyIII\Handlers\Events\UserEventHandler
     */
    public function testDemoUserBackToEnglish(): void
    {
        $repository = $this->mock(UserRepositoryInterface::class);
        $user       = $this->emptyUser();
        $event      = new Login(null, $user, true);
        $listener   = new UserEventHandler();

        // mock stuff
        $repository->shouldReceive('hasRole')->withArgs([Mockery::any(), 'demo'])->once()->andReturn(true);

        Preferences::shouldReceive('setForUser')->withArgs([Mockery::any(), 'language', 'en_US'])->once();
        Preferences::shouldReceive('mark')->once();

        $listener->demoUserBackToEnglish($event);
        $this->assertTrue(true);
    }

    /**
     * @covers \FireflyIII\Handlers\Events\UserEventHandler
     * @covers \FireflyIII\Events\UserChangedEmail
     */
    public function testSendEmailChangeConfirmMail(): void
    {
        Log::info(sprintf('Now in test %s.', __METHOD__));
        Mail::fake();

        $tokenPref       = new Preference;
        $tokenPref->data = 'token';
        Preferences::shouldReceive('getForUser')->withArgs([Mockery::any(), 'email_change_confirm_token', 'invalid'])->andReturn($tokenPref);

        $user     = $this->emptyUser();
        $event    = new UserChangedEmail($user, 'new@new', 'old@old', '127.0.0.1');
        $listener = new UserEventHandler;
        $listener->sendEmailChangeConfirmMail($event);

        // must send user an email:

        Mail::assertSent(
            ConfirmEmailChangeMail::class, function ($mail) {
            return $mail->hasTo('new@new') && '127.0.0.1' === $mail->ipAddress;
        }
        );

        $this->assertTrue(true);
    }

    /**
     * @covers \FireflyIII\Handlers\Events\UserEventHandler
     * @covers \FireflyIII\Events\UserChangedEmail
     */
    public function testSendEmailChangeUndoMail(): void
    {
        Log::info(sprintf('Now in test %s.', __METHOD__));
        Mail::fake();

        $tokenPref       = new Preference;
        $tokenPref->data = 'token';
        Preferences::shouldReceive('getForUser')->withArgs([Mockery::any(), 'email_change_undo_token', 'invalid'])->andReturn($tokenPref);

        $user     = $this->emptyUser();
        $event    = new UserChangedEmail($user, 'new@new', 'old@old', '127.0.0.1');
        $listener = new UserEventHandler;
        $listener->sendEmailChangeUndoMail($event);

        Mail::assertSent(
            UndoEmailChangeMail::class, function ($mail) {
            return $mail->hasTo('old@old') && '127.0.0.1' === $mail->ipAddress;
        }
        );

        $this->assertTrue(true);
    }


    /**
     * @covers \FireflyIII\Handlers\Events\UserEventHandler
     * @covers \FireflyIII\Events\RequestedNewPassword
     */
    public function testSendNewPassword(): void
    {
        Log::info(sprintf('Now in test %s.', __METHOD__));
        Mail::fake();
        $user     = $this->emptyUser();
        $event    = new RequestedNewPassword($user, 'token', '127.0.0.1');
        $listener = new UserEventHandler;
        $listener->sendNewPassword($event);

        // must send user an email:

        Mail::assertSent(
            RequestedNewPasswordMail::class, function ($mail) use ($user) {
            return $mail->hasTo($user->email) && '127.0.0.1' === $mail->ipAddress;
        }
        );

        $this->assertTrue(true);
    }

    /**
     * @covers \FireflyIII\Handlers\Events\UserEventHandler
     * @covers \FireflyIII\Events\RegisteredUser
     */
    public function testSendRegistrationMail(): void
    {
        Log::info(sprintf('Now in test %s.', __METHOD__));
        Mail::fake();
        $user  = $this->emptyUser();
        $event = new RegisteredUser($user, '127.0.0.1');
        //config('firefly.send_registration_mail', true);
        \Config::set('firefly.send_registration_mail', true);
        $listener = new UserEventHandler;
        $listener->sendRegistrationMail($event);

        // must send user an email:
        Mail::assertSent(
            RegisteredUserMail::class, function ($mail) use ($user) {
            return $mail->hasTo($user->email) && '127.0.0.1' === $mail->ipAddress;
        }
        );

        $this->assertTrue(true);
    }
}