SmrTest\lib\DefaultGame\AbstractSmrAccountIntegrationTest

Complexity

Total Complexity

21

Size/Duplication

Total Lines	241
Duplicated Lines	0 %

Importance

Changes	4
Bugs	0	Features	1

21 Methods

Rating	Name	Duplication	Size	Complexity
A	test_get_account_by_account_id()	0	15	1
A	test_get_account_by_email_returns_null_when_no_email_provided()	0	5	1
A	test_get_account_by_irc_returns_null_when_no_record_found()	0	6	1
A	test_createAccount()	0	11	1
A	test_get_account_by_name_returns_null_when_no_account_name_provided()	0	5	1
A	test_createAccount_throws_if_referrer_does_not_exist()	0	4	1
A	test_get_account_by_irc_happy_path()	0	10	1
A	test_get_account_by_account_id_no_account_found_throws_exception()	0	5	1
A	test_get_account_by_social_happy_path()	0	28	1
A	test_get_account_by_name_returns_null_when_no_record_found()	0	6	1
A	setUp()	0	2	1
A	test_get_account_by_social_returns_null_when_no_record_found()	0	24	1
A	test_get_account_by_discord_returns_null_when_no_discord_provided()	0	5	1
A	test_get_account_by_irc_returns_null_when_no_irc_provided()	0	5	1
A	test_get_account_by_email_returns_null_when_no_record_found()	0	6	1
A	test_get_account_by_social_returns_null_when_social_invalid()	0	11	1
A	test_get_account_by_discord_happy_path()	0	10	1
A	test_get_account_by_email_happy_path()	0	7	1
A	test_get_account_by_discord_returns_null_when_no_record_found()	0	6	1
A	test_get_account_by_name_happy_path()	0	7	1
A	test_date_format_methods()	0	21	1

<?php declare(strict_types=1);

namespace SmrTest\lib\DefaultGame;

use AbstractSmrAccount;
use AccountNotFoundException;
use SmrTest\BaseIntegrationSpec;
use Smr\SocialLogin\Facebook;

/**
 * @covers AbstractSmrAccount
 */
class AbstractSmrAccountIntegrationTest extends BaseIntegrationSpec {

	protected function setUp() : void {
		AbstractSmrAccount::clearCache();
	}

	public function test_createAccount() {
		$login = 'test';
		$password = 'pw';
		$email = 'test@test.com';
		$tz = 9;
		$referral = 0;
		$account = AbstractSmrAccount::createAccount($login, $password, $email, $tz, $referral);
		$this->assertSame($login, $account->getLogin());
		$this->assertSame($email, $account->getEmail());
		$this->assertSame($tz, $account->getOffset());
		$this->assertSame($referral, $account->getReferrerID());
	}

	public function test_createAccount_throws_if_referrer_does_not_exist() {
		$this->expectException(AccountNotFoundException::class);
		$this->expectExceptionMessage('Account ID 123 does not exist');
		AbstractSmrAccount::createAccount('test', 'test', 'test@test.com', 9, 123);
	}

	public function test_get_account_by_account_id() {
		// Given the database has been set up with a user
		$original = AbstractSmrAccount::createAccount('test', 'test', 'test@test.com', 9, 0);
		// And there is no force update
		$forceUpdate = false;
		// When the account is retrieved by its ID
		$account = AbstractSmrAccount::getAccount($original->getAccountID(), $forceUpdate);
		// Without forceUpdate, the two objects should be the same in memory
		$this->assertSame($original, $account);

		// With forceUpdate, the objects should be identical, but not the same
		$forceUpdate = true;
		$account = AbstractSmrAccount::getAccount($original->getAccountID(), $forceUpdate);
		$this->assertNotSame($original, $account);
		$this->assertEquals($original, $account);
	}

	public function test_get_account_by_account_id_no_account_found_throws_exception() {
		$this->expectException(AccountNotFoundException::class);
		// Given there is no account record
		// When performing an account lookup by id
		AbstractSmrAccount::getAccount(123);
	}

	public function test_get_account_by_name_happy_path() {
		// Given the database has been set up with a user
		$original = AbstractSmrAccount::createAccount('test', 'test', 'test@test.com', 9, 0);
		// When retrieving account by name
		$account = AbstractSmrAccount::getAccountByName($original->getLogin());
		// Then the record is found
		$this->assertSame($original, $account);
	}

	public function test_get_account_by_name_returns_null_when_no_account_name_provided() {
		// When retrieving account by empty string name
		$account = AbstractSmrAccount::getAccountByName('');

Are you sure the assignment to $account is correct as AbstractSmrAccount::getAccountByName('') targeting AbstractSmrAccount::getAccountByName() seems to always return 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
		// 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
		$original = AbstractSmrAccount::createAccount('test', 'test', 'test@test.com', 9, 0);
		// When retrieving account by email
		$account = AbstractSmrAccount::getAccountByEmail($original->getEmail());
		// Then the record is found
		$this->assertSame($original, $account);
	}

	public function test_get_account_by_email_returns_null_when_no_email_provided() {
		// 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
		// 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
		// Given the database has been set up with a user
		$original = AbstractSmrAccount::createAccount('test', 'test', 'test@test.com', 9, 0);
		$original->setDiscordId('123');
		$original->update();
		// When retrieving account by discord
		$account = AbstractSmrAccount::getAccountByDiscordId($original->getDiscordId(), true);
		// Then the record is found
		$this->assertSame($original->getAccountID(), $account->getAccountID());
	}

	public function test_get_account_by_discord_returns_null_when_no_discord_provided() {
		// 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
		// 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
		// Given the database has been set up with a user
		$original = AbstractSmrAccount::createAccount('test', 'test', 'test@test.com', 9, 0);
		$original->setIrcNick('nick');
		$original->update();
		// When retrieving account by irc
		$account = AbstractSmrAccount::getAccountByIrcNick($original->getIrcNick(), true);
		// Then the record is found
		$this->assertSame($original->getAccountID(), $account->getAccountID());
	}

	public function test_get_account_by_irc_returns_null_when_no_irc_provided() {
		// 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
		// 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
		$original = AbstractSmrAccount::createAccount('test', 'test', 'test@test.com', 9, 0);
		$authUserID = 'MySocialUserID';
		$original->addAuthMethod(Facebook::getLoginType(), $authUserID);
		// And a valid social login
		/*
		 * Unfortunately we cannot use the simple createMock() method, because the SocialLogin class uses
		 * a static method for getLoginType(). PHPUnit cannot operate on static methods, so it throws a warning.
		 * Instead we create a partial mock, and all other methods will call their default method, and prevent the warning
		 * that causes PHPUnit to fail due to "warnings" or "risky" tests.
		 */
		$isValid = 'isValid';
		$getUserId = 'getUserId';
		$socialLogin = $this->createPartialMock(Facebook::class, array($isValid, $getUserId));
		$socialLogin
			->expects(self::once())
			->method($isValid)
			->willReturn(true);
		$socialLogin
			->expects(self::once())
			->method($getUserId)
			->willReturn($authUserID);
		// When retrieving account by social
		$account = AbstractSmrAccount::getAccountBySocialLogin($socialLogin, true);
		// Then the record is found
		$this->assertSame($original->getAccountID(), $account->getAccountID());
	}

	public function test_get_account_by_social_returns_null_when_social_invalid() {
		// Given an invalid social login
		$socialLogin = $this->createMock(Facebook::class);
		$socialLogin
			->expects(self::once())
			->method('isValid')
			->willReturn(false);
		// When retrieving account by null social
		$account = AbstractSmrAccount::getAccountBySocialLogin($socialLogin);
		// 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
		// And a valid social login
		/*
		 * Unfortunately we cannot use the simple createMock() method, because the SocialLogin class uses
		 * a static method for getLoginType(). PHPUnit cannot operate on static methods, so it throws a warning.
		 * Instead we create a partial mock, and all other methods will call their default method, and prevent the warning
		 * that causes PHPUnit to fail due to "warnings" or "risky" tests.
		 */
		$isValid = 'isValid';
		$getUserId = 'getUserId';
		$socialLogin = $this->createPartialMock(Facebook::class, array($isValid, $getUserId));
		$socialLogin
			->expects(self::once())
			->method($isValid)
			->willReturn(true);
		$socialLogin
			->expects(self::once())
			->method($getUserId)
			->willReturn('123');
		// When retrieving account by social
		$account = AbstractSmrAccount::getAccountBySocialLogin($socialLogin);
		// Then the record is null
		$this->assertNull($account);
	}

	public function test_date_format_methods() {
		$account = AbstractSmrAccount::createAccount('test', 'test', 'test@test.com', 9, 0);

		// Arbitrary epoch for testing (Sat, 24 Apr 2021 01:39:51 GMT)
		$epoch = 1619228391;

		// Test default formats
		self::assertSame('24/4/2021', date($account->getDateFormat(), $epoch));
		self::assertSame('1:39:51 AM', date($account->getTimeFormat(), $epoch));

		// Test combined formats
		self::assertSame('24/4/2021 1:39:51 AM', date($account->getDateTimeFormat(), $epoch));
		self::assertSame('24/4/2021<br />1:39:51 AM', date($account->getDateTimeFormatSplit(), $epoch));

		// Now modify the formats
		$account->setDateFormat('Y M D');
		$account->setTimeFormat('H i s');

		// Test the modified formats
		self::assertSame('2021 Apr Sat', date($account->getDateFormat(), $epoch));
		self::assertSame('01 39 51', date($account->getTimeFormat(), $epoch));
	}

}