ilChatroomUserTest.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\Attributes\DataProvider;

class ilChatroomUserTest extends ilChatroomAbstractTestBase
{
    protected ilObjUser&MockObject $ilUserMock;
    protected ilChatroomUser $user;

    public function testGetUserIdIfNotAnonymous(): void
    {
        $userId = 6;

        $this->ilUserMock->expects($this->once())->method('getId')->willReturn($userId);
        $this->ilUserMock->expects($this->once())->method('isAnonymous')->willReturn(false);

        $this->assertSame($userId, $this->user->getUserId());
    }

    public function testGetUserIdFromSessionIfAnonymous(): void
    {
        $userId = 6;
        $roomId = 99;

        $this->ilUserMock->expects($this->once())->method('getId')->willReturn($userId);
        $this->ilUserMock->expects($this->once())->method('isAnonymous')->willReturn(true);

        $this->ilChatroomMock->method('getRoomId')->willReturn($roomId);

        $session = [
            $roomId => [
                'user_id' => $userId,
            ],
        ];
        ilSession::set('chat', $session);

        $this->assertSame($userId, $this->user->getUserId());
    }

    public function testGetUserIdRandomGeneratedIfAnonymous(): void
    {
        $this->ilUserMock->expects($this->once())->method('getId')->willReturn(0);
        $this->ilUserMock->expects($this->once())->method('isAnonymous')->willReturn(true);

        $this->ilChatroomMock->method('getRoomId')->willReturn(99);

        $this->assertNotNull($this->user->getUserId());
    }

    #[DataProvider('usernameDataProvider')]
    public function testSetUsername(string $username, string $expected): void
    {
        $this->user->setUsername($username);
        $this->assertSame($expected, $this->user->getUsername());
    }

    public function testGetUsernameFromSession(): void
    {
        $username = 'username';
        $roomId = 99;

        ilSession::set('chat', [
            $roomId => [
                'username' => $username,
            ],
        ]);

        $this->ilChatroomMock->method('getRoomId')->willReturn(99);

        $this->assertSame($username, $this->user->getUsername());
    }

    public function testGetUsernameFromIlObjUser(): void
    {
        $username = 'login';
        $roomId = 99;
        ilSession::set('chat', [
            $roomId => [
                'username' => '',
            ],
        ]);

        $this->ilUserMock->expects($this->once())->method('getPublicName')->willReturn($username);
        $this->ilChatroomMock->method('getRoomId')->willReturn($roomId);

        $this->assertSame($username, $this->user->getUsername());
    }

    public function testBuildAnonymousName(): void
    {
        $this->ilChatroomMock->method('getSetting')->willReturn('#_anonymous');

        $firstName = $this->user->buildAnonymousName();
        $secondName = $this->user->buildAnonymousName();

        $this->assertNotEquals($firstName, $secondName);
    }

    public function testBuildLogin(): void
    {
        $username = 'username';
        $this->ilUserMock->expects($this->once())->method('getLogin')->willReturn($username);

        $this->assertSame($username, $this->user->buildLogin());
    }

    public function testBuildFullname(): void
    {
        $fullname = 'John Doe';
        $this->ilUserMock->expects($this->once())->method('getPublicName')->willReturn($fullname);

        $this->assertSame($fullname, $this->user->buildFullname());
    }

    public function testBuildShortname(): void
    {
        $firstname = 'John';
        $lastname = 'Doe';
        $this->ilUserMock->expects($this->once())->method('getFirstname')->willReturn($firstname);
        $this->ilUserMock->expects($this->once())->method('getLastname')->willReturn($lastname);

        $this->assertSame('J. Doe', $this->user->buildShortname());
    }

    public function testGetChatNameSuggestionsIfAnonymous(): void
    {
        $this->ilUserMock->method('isAnonymous')->willReturn(true);
        $this->ilChatroomMock->method('getSetting')->willReturn('#_anonymous');

        $first = $this->user->getChatNameSuggestions();
        $second = $this->user->getChatNameSuggestions();

        $this->assertNotEquals($first, $second);
    }

    public function testGetChatNameSuggestionsIfNotAnonymous(): void
    {
        $this->ilUserMock->method('isAnonymous')->willReturn(false);
        $this->ilUserMock->expects($this->once())->method('getFirstname')->willReturn('John');
        $this->ilUserMock->expects($this->once())->method('getLastname')->willReturn('Doe');
        $this->ilUserMock->expects($this->once())->method('getPublicName')->willReturn('John Doe');
        $this->ilUserMock->expects($this->once())->method('getLogin')->willReturn('jdoe');
        $this->ilChatroomMock->method('getSetting')->willReturn('#_anonymous');

        $suggestions = $this->user->getChatNameSuggestions();

        $this->assertSame('John Doe', $suggestions['fullname']);
        $this->assertSame('J. Doe', $suggestions['shortname']);
        $this->assertSame('jdoe', $suggestions['login']);
    }

    public static function usernameDataProvider(): array
    {
        return [
            ['username', 'username'],
            ['>username<', '&gt;username&lt;'],
        ];
    }

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

        $this->ilUserMock = $this->getMockBuilder(ilObjUser::class)->disableOriginalConstructor()->onlyMethods(
            ['getId', 'isAnonymous', 'getLogin', 'getPublicName', 'getFirstname', 'getLastname']
        )->getMock();
        $this->ilChatroomMock = $this->getMockBuilder(ilChatroom::class)->disableOriginalConstructor()->onlyMethods(
            ['getRoomId', 'getSetting']
        )->getMock();

        $this->user = new ilChatroomUser($this->ilUserMock, $this->ilChatroomMock);
    }
}