AbstractSmrAccountTest

Complexity

Total Complexity

22

Size/Duplication

Total Lines	284
Duplicated Lines	0 %

Importance

Changes	4
Bugs	0	Features	2

21 Methods

Rating	Name	Duplication	Size	Complexity
A	test_get_account_by_account_id()	0	31	1
A	test_get_account_by_email_returns_null_when_no_email_provided()	0	9	1
A	test_get_account_by_name_returns_null_when_no_record_found()	0	8	1
A	test_get_account_by_name_happy_path()	0	9	1
A	test_get_account_by_discord_returns_null_when_no_discord_provided()	0	9	1
A	test_get_account_by_social_returns_null_when_social_invalid()	0	15	1
A	test_get_account_by_irc_returns_null_when_no_record_found()	0	8	1
A	test_get_account_by_account_id_force_update_from_database()	0	15	1
A	test_get_account_by_social_returns_null_when_no_record_found()	0	14	1
A	setupMockMysqlDatabase()	0	17	2
A	test_get_account_by_irc_returns_null_when_no_irc_provided()	0	9	1
A	test_get_account_by_discord_returns_null_when_no_record_found()	0	8	1
A	tearDown()	0	3	1
A	test_get_account_by_id_multiple_times_without_force_refresh_calls_database_once()	0	15	1
A	test_get_account_by_account_id_no_account_found_throws_exception()	0	10	1
A	test_get_account_by_social_happy_path()	0	15	1
A	test_get_account_by_discord_happy_path()	0	9	1
A	test_get_account_by_email_returns_null_when_no_record_found()	0	8	1
A	test_get_account_by_irc_happy_path()	0	9	1
A	test_get_account_by_name_returns_null_when_no_account_name_provided()	0	9	1
A	test_get_account_by_email_happy_path()	0	9	1

<?php declare(strict_types=1);

use Mockery as m;
use Mockery\MockInterface;
use PHPUnit\Framework\TestCase;

class Record
{
    public int $account_id = 1;
    public string $login = "login";
    public string $password = "password";
    public string $email = "email";
    public string $last_login = "last login";
    public string $validation_code = "validation code";
    public string $offset = "offset";
    public string $images = "Yes";
    public string $fontsize = "font size";
    public string $password_reset = "password reset";
    public int $mail_banned = 0;
    public string $friendly_colour = "colour";
    public string $neutral_colour = "colour";
    public string $enemy_colour = "colour";
    public string $css_link = "css link";
    public string $referral_id = 'referral_id';
    public string $max_rank_achieved = 'max_rank_achieved';
    public string $hof_name = 'hof_name';
    public string $discord_id = 'discord_id';
    public string $irc_nick = 'irc_nick';
    public string $date_short = 'date_short';
    public string $time_short = 'time_short';
    public string $template = 'template';
    public string $colour_scheme = 'colour_scheme';
}

/**
 * Class AbstractSmrAccountTest
 * @covers AbstractSmrAccount
 * @covers Globals
 * @runTestsInSeparateProcesses
 */
class AbstractSmrAccountTest extends TestCase
{
    private AbstractSmrAccount $abstractSmrAccount;

    public function test_get_account_by_account_id()
    {
        //# Given the database has been set up with a user
        $record = new Record();
        self::setupMockMysqlDatabase($record);
        //# And there is no force update
        $forceUpdate = false;
        //# When the account is retrieved by its ID
        $this->abstractSmrAccount = AbstractSmrAccount::getAccount($record->account_id, $forceUpdate);
        //# Then the integrity of the user is correct
        $this->assertEquals($record->account_id, $this->abstractSmrAccount->getAccountID());
        $this->assertEquals($record->login, $this->abstractSmrAccount->getLogin());
        $this->assertEquals($record->email, $this->abstractSmrAccount->getEmail());
        $this->assertEquals($record->last_login, $this->abstractSmrAccount->getLastLogin());
        $this->assertEquals($record->validation_code, $this->abstractSmrAccount->getValidationCode());
        $this->assertEquals($record->offset, $this->abstractSmrAccount->getOffset());
        $this->assertEquals(true, $this->abstractSmrAccount->isDisplayShipImages());
        $this->assertEquals($record->fontsize, $this->abstractSmrAccount->getFontSize());
        $this->assertEquals($record->password_reset, $this->abstractSmrAccount->getPasswordReset());
        $this->assertEquals($record->mail_banned, $this->abstractSmrAccount->getMailBanned());
        $this->assertEquals($record->friendly_colour, $this->abstractSmrAccount->getFriendlyColour());
        $this->assertEquals($record->neutral_colour, $this->abstractSmrAccount->getNeutralColour());
        $this->assertEquals($record->enemy_colour, $this->abstractSmrAccount->getEnemyColour());
        $this->assertEquals($record->css_link, $this->abstractSmrAccount->getCssLink());
        $this->assertEquals($record->referral_id, $this->abstractSmrAccount->getReferrerID());
        $this->assertEquals($record->hof_name, $this->abstractSmrAccount->getHofName());
        $this->assertEquals($record->discord_id, $this->abstractSmrAccount->getDiscordId());
        $this->assertEquals($record->irc_nick, $this->abstractSmrAccount->getIrcNick());
        $this->assertEquals($record->date_short, $this->abstractSmrAccount->getShortDateFormat());
        $this->assertEquals($record->time_short, $this->abstractSmrAccount->getShortTimeFormat());
        $this->assertEquals($record->template, $this->abstractSmrAccount->getTemplate());
    }

    public function test_get_account_by_account_id_no_account_found_throws_exception()
    {
        $this->expectException(AccountNotFoundException::class);
        //# Given there is no account record
        $mysqlDatabase = m::mock("overload:" . SmrMySqlDatabase::class)->shouldIgnoreMissing();
        $mysqlDatabase
            ->shouldReceive("nextRecord")
            ->andReturnNull();
        //# When performing an account lookup by id
        AbstractSmrAccount::getAccount("bad account id");
    }

    public function test_get_account_by_account_id_force_update_from_database()
    {
        //# Given the database has been set up with a user
        $record = new Record();
        self::setupMockMysqlDatabase($record);
        //# And the force update flag is true
        $forceUpdate = true;
        //# And the account has been retrieved once
        AbstractSmrAccount::getAccount($record->account_id, $forceUpdate);
        //# When retrieving the account a second time
        AbstractSmrAccount::getAccount($record->account_id, $forceUpdate);
        //# Then verify multiple interactions with the database
        //# There are a total of three mocks in the container:
        //# One constructed here in this test, and one for each time getAccount was called.
        $this->assertCount(3, m::getContainer()->getMocks());
    }

    public function test_get_account_by_id_multiple_times_without_force_refresh_calls_database_once()
    {
        //# Given the database has been set up with a user
        $record = new Record();
        self::setupMockMysqlDatabase($record);
        //# And the force update flag is true
        $forceUpdate = false;
        //# And the account has been retrieved once
        AbstractSmrAccount::getAccount($record->account_id, $forceUpdate);
        //# When retrieving the account a second time
        AbstractSmrAccount::getAccount($record->account_id, $forceUpdate);
        //# Then verify multiple interactions with the database
        //# There are a total of two mocks in the container:
        //# One constructed here in this test, and one for the only time a database connection was spawned.
        $this->assertCount(2, m::getContainer()->getMocks());
    }

    public function test_get_account_by_name_happy_path()
    {
        //# Given a record exists
        $record = new Record();
        self::setupMockMysqlDatabase($record);
        //# When retrieving account by name
        $account = AbstractSmrAccount::getAccountByName($record->login);
        //# Then the record is found
        $this->assertEquals($record->account_id, $account->getAccountID());
    }

    public function test_get_account_by_name_returns_null_when_no_account_name_provided()
    {
        //# Given a record exists
        $record = new Record();
        self::setupMockMysqlDatabase($record);
        //# When retrieving account by null name
        $account = AbstractSmrAccount::getAccountByName(null);
        //# Then the record is null
        $this->assertNull($account);
    }

    public function test_get_account_by_name_returns_null_when_no_record_found()
    {
        //# Given no record exists
        self::setupMockMysqlDatabase(null);
        //# When retrieving account by name
        $account = AbstractSmrAccount::getAccountByName("any");
        //# Then the record is null
        $this->assertNull($account);
    }

    public function test_get_account_by_email_happy_path()
    {
        //# Given a record exists
        $record = new Record();
        self::setupMockMysqlDatabase($record);
        //# When retrieving account by email
        $account = AbstractSmrAccount::getAccountByEmail($record->email);
        //# Then the record is found
        $this->assertEquals($record->account_id, $account->getAccountID());
    }

    public function test_get_account_by_email_returns_null_when_no_email_provided()
    {
        //# Given a record exists
        $record = new Record();
        self::setupMockMysqlDatabase($record);
        //# When retrieving account by null email
        $account = AbstractSmrAccount::getAccountByEmail(null);
        //# Then the record is null
        $this->assertNull($account);
    }

    public function test_get_account_by_email_returns_null_when_no_record_found()
    {
        //# Given no record exists
        self::setupMockMysqlDatabase(null);
        //# When retrieving account by email
        $account = AbstractSmrAccount::getAccountByEmail("any");
        //# Then the record is null
        $this->assertNull($account);
    }

    public function test_get_account_by_discord_happy_path()
    {
        //# Given a record exists
        $record = new Record();
        self::setupMockMysqlDatabase($record);
        //# When retrieving account by discord
        $account = AbstractSmrAccount::getAccountByDiscordId($record->login);
        //# Then the record is found
        $this->assertEquals($record->account_id, $account->getAccountID());
    }

    public function test_get_account_by_discord_returns_null_when_no_discord_provided()
    {
        //# Given a record exists
        $record = new Record();
        self::setupMockMysqlDatabase($record);
        //# When retrieving account by null discord
        $account = AbstractSmrAccount::getAccountByDiscordId(null);
        //# Then the record is null
        $this->assertNull($account);
    }

    public function test_get_account_by_discord_returns_null_when_no_record_found()
    {
        //# Given no record exists
        self::setupMockMysqlDatabase(null);
        //# When retrieving account by discord
        $account = AbstractSmrAccount::getAccountByDiscordId("any");
        //# Then the record is null
        $this->assertNull($account);
    }

    public function test_get_account_by_irc_happy_path()
    {
        //# Given a record exists
        $record = new Record();
        self::setupMockMysqlDatabase($record);
        //# When retrieving account by irc
        $account = AbstractSmrAccount::getAccountByIrcNick($record->login);
        //# Then the record is found
        $this->assertEquals($record->account_id, $account->getAccountID());
    }

    public function test_get_account_by_irc_returns_null_when_no_irc_provided()
    {
        //# Given a record exists
        $record = new Record();
        self::setupMockMysqlDatabase($record);
        //# When retrieving account by null irc
        $account = AbstractSmrAccount::getAccountByIrcNick(null);
        //# Then the record is null
        $this->assertNull($account);
    }

    public function test_get_account_by_irc_returns_null_when_no_record_found()
    {
        //# Given no record exists
        self::setupMockMysqlDatabase(null);
        //# When retrieving account by irc
        $account = AbstractSmrAccount::getAccountByIrcNick("any");
        //# Then the record is null
        $this->assertNull($account);
    }

    /////
    public function test_get_account_by_social_happy_path()
    {
        //# Given a record exists
        $record = new Record();
        self::setupMockMysqlDatabase($record);
        //# And a valid social login
        $socialLogin = m::mock(SocialLogin::class)->shouldIgnoreMissing();
        $socialLogin
            ->expects()
            ->isValid()
            ->andReturns(true);
        //# When retrieving account by social
        $account = AbstractSmrAccount::getAccountBySocialLogin($socialLogin);

$socialLogin of type Mockery\Mock is incompatible with the type SocialLogin expected by parameter $social of AbstractSmrAccount::getAccountBySocialLogin().

        //# Then the record is found
        $this->assertEquals($record->account_id, $account->getAccountID());
    }

    public function test_get_account_by_social_returns_null_when_social_invalid()
    {
        //# Given a record exists
        $record = new Record();
        self::setupMockMysqlDatabase($record);
        //# And an invalid social login
        $socialLogin = m::mock(SocialLogin::class)->shouldIgnoreMissing();
        $socialLogin
            ->expects()
            ->isValid()
            ->andReturns(false);
        //# When retrieving account by null social
        $account = AbstractSmrAccount::getAccountBySocialLogin($socialLogin);

$socialLogin of type Mockery\Mock is incompatible with the type SocialLogin expected by parameter $social of AbstractSmrAccount::getAccountBySocialLogin().

        //# Then the record is null
        $this->assertNull($account);
    }

    public function test_get_account_by_social_returns_null_when_no_record_found()
    {
        //# Given no record exists
        self::setupMockMysqlDatabase(null);
        //# And a valid social login
        $socialLogin = m::mock(SocialLogin::class)->shouldIgnoreMissing();
        $socialLogin
            ->expects()
            ->isValid()
            ->andReturns(true);
        //# When retrieving account by social
        $account = AbstractSmrAccount::getAccountBySocialLogin($socialLogin);

$socialLogin of type Mockery\Mock is incompatible with the type SocialLogin expected by parameter $social of AbstractSmrAccount::getAccountBySocialLogin().

        //# Then the record is null
        $this->assertNull($account);
    }

    public function tearDown(): void
    {
        m::close();
    }

    private static function setupMockMysqlDatabase(?Record $record): MockInterface
    {
        //# Force the mock to be used in the autoloader
        $mysqlDatabase = m::mock("overload:" . SmrMySqlDatabase::class)->shouldIgnoreMissing();
        if (isset($record)) {
            $mysqlDatabase
                ->shouldReceive("escapeNumber")
                ->with($record->account_id)
                ->andReturn($record->account_id);
            $mysqlDatabase
                ->shouldReceive("nextRecord")
                ->andReturn($record);
            $mysqlDatabase
                ->shouldReceive("getRow")
                ->andReturn((array)$record);
        }
        return $mysqlDatabase;
    }
}