ilWebResourceParameterTest.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use PHPUnit\Framework\TestCase;
use ILIAS\DI\Container;

class ilWebResourceParameterTest extends TestCase
{
    protected function initDependencies(): void
    {
        $user = $this->getMockBuilder(ilObjUser::class)
                     ->disableOriginalConstructor()
                     ->onlyMethods(['getLogin', 'getId', 'getMatriculation'])
                     ->getMock();
        $user->method('getLogin')->willReturn('login');
        $user->method('getId')->willReturn(37);
        $user->method('getMatriculation')->willReturn('matriculation');
    }

    public function testAppendToLink(): void
    {
        $user = $this->getMockBuilder(ilObjUser::class)
                     ->disableOriginalConstructor()
                     ->onlyMethods(['getLogin', 'getId', 'getMatriculation'])
                     ->getMock();
        $user->method('getLogin')->willReturn('login');
        $user->method('getId')->willReturn(37);
        $user->method('getMatriculation')->willReturn('matriculation');

        $link1 = 'link';
        $link2 = 'li?nk';

        $param = new ilWebLinkParameter(
            $user,
            3,
            7,
            13,
            ilWebLinkBaseParameter::VALUES['user_id'],
            'name'
        );

        $this->assertSame(
            'link?name=37',
            $param->appendToLink($link1)
        );
        $this->assertSame(
            'li?nk&name=37',
            $param->appendToLink($link2)
        );

        $param = new ilWebLinkParameter(
            $user,
            3,
            7,
            13,
            ilWebLinkBaseParameter::VALUES['login'],
            'name'
        );

        $this->assertSame(
            'link?name=login',
            $param->appendToLink($link1)
        );
        $this->assertSame(
            'li?nk&name=login',
            $param->appendToLink($link2)
        );

        $param = new ilWebLinkParameter(
            $user,
            3,
            7,
            13,
            ilWebLinkBaseParameter::VALUES['matriculation'],
            'name'
        );

        $this->assertSame(
            'link?name=matriculation',
            $param->appendToLink($link1)
        );
        $this->assertSame(
            'li?nk&name=matriculation',
            $param->appendToLink($link2)
        );
    }

    public function testAppendToLinkException(): void
    {
        $user = $this->getMockBuilder(ilObjUser::class)
                     ->disableOriginalConstructor()
                     ->getMock();
        $user->expects($this->never())
             ->method($this->anything());

        $link = 'link';
        $param = new ilWebLinkParameter($user, 3, 7, 13, 1241, 'name');
        $this->expectException(ilWebLinkParameterException::class);
        $param->appendToLink($link);
    }

    public function testToXML(): void
    {
        $user = $this->getMockBuilder(ilObjUser::class)
                     ->disableOriginalConstructor()
                     ->getMock();
        $user->expects($this->never())
             ->method($this->anything());

        $writer = $this->getMockBuilder(ilXmlWriter::class)
                       ->disableOriginalConstructor()
                       ->onlyMethods(['xmlElement'])
                       ->getMock();
        /*
         * willReturnCallback is a workaround to replace withConsecutive.
         * The return value is irrelevant here, but if an unexpected parameter
         * is passed, an exception will be thrown (instead of an assumption being
         * broken as before).
         * These tests should be rewritten to rely much less on PHPUnit for mocking.
         */
        $writer->expects($this->exactly(3))
               ->method('xmlElement')
               ->willReturnCallback(fn($tag, $attrs) => match([$tag, $attrs]) {
                   ['DynamicParameter', [
                       'id' => 7,
                       'name' => 'name1',
                       'type' => 'userId'
                   ]] => 1,
                   ['DynamicParameter', [
                       'id' => 8,
                       'name' => 'name2',
                       'type' => 'userName'
                   ]] => 2,
                   ['DynamicParameter', [
                       'id' => 9,
                       'name' => 'name3',
                       'type' => 'matriculation'
                   ]] => 3
               });

        $param = new ilWebLinkParameter(
            $user,
            0,
            13,
            7,
            ilWebLinkBaseParameter::VALUES['user_id'],
            'name1'
        );
        $param->toXML($writer);
        $param = new ilWebLinkParameter(
            $user,
            0,
            13,
            8,
            ilWebLinkBaseParameter::VALUES['login'],
            'name2'
        );
        $param->toXML($writer);
        $param = new ilWebLinkParameter(
            $user,
            0,
            13,
            9,
            ilWebLinkBaseParameter::VALUES['matriculation'],
            'name3'
        );
        $param->toXML($writer);
        $param = new ilWebLinkParameter($user, 0, 13, 9, 987, 'name3');
        $param->toXML($writer);
    }

    public function testGetInfo(): void
    {
        $user = $this->getMockBuilder(ilObjUser::class)
                     ->disableOriginalConstructor()
                     ->getMock();
        $user->expects($this->never())
             ->method($this->anything());

        $param = new ilWebLinkParameter(
            $user,
            0,
            13,
            7,
            ilWebLinkBaseParameter::VALUES['user_id'],
            'name1'
        );
        $this->assertSame('name1=USER_ID', $param->getInfo());
        $param = new ilWebLinkParameter(
            $user,
            0,
            13,
            8,
            ilWebLinkBaseParameter::VALUES['login'],
            'name2'
        );
        $this->assertSame('name2=LOGIN', $param->getInfo());
        $param = new ilWebLinkParameter(
            $user,
            0,
            13,
            9,
            ilWebLinkBaseParameter::VALUES['matriculation'],
            'name3'
        );
        $this->assertSame('name3=MATRICULATION', $param->getInfo());
    }

    public function testGetInfoException(): void
    {
        $user = $this->getMockBuilder(ilObjUser::class)
                     ->disableOriginalConstructor()
                     ->getMock();
        $user->expects($this->never())
             ->method($this->anything());

        $param = new ilWebLinkParameter($user, 0, 13, 7, 374, 'name1');
        $this->expectException(ilWebLinkParameterException::class);
        $param->getInfo();
    }
}