ilWebResourceDatabaseRepositoryTest.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

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

class ilWebResourceDatabaseRepositoryTest extends TestCase
{
    protected ?Container $dic = null;
    protected ilObjUser $user;
    protected ilWebLinkRepository&MockObject $web_link_repo;

    protected function setUp(): void
    {
        parent::setUp();
        $this->initDependencies();
    }

    protected function initDependencies(): void
    {
        global $DIC;
        $this->dic = is_object($DIC) ? clone $DIC : $DIC;
        $GLOBALS['DIC'] = new Container();

        $user = $this->getMockBuilder(ilObjUser::class)
                     ->disableOriginalConstructor()
                     ->getMock();
        $user->expects($this->never())
             ->method($this->anything());

        $this->user = $user;
        $this->setGlobal('ilUser', $user);
    }

    protected function setGlobalDBAndRepo(
        ilDBInterface $mock_db,
        int $webr_id,
        bool $update_history,
        int $current_time,
        array $datetimes
    ): void {
        $mock_db->method('quote')
                ->willReturnCallback(function ($arg1, string $arg2) {
                    return (string) $arg1;
                });
        $mock_db->method('quoteIdentifier')
                ->willReturnCallback(function (string $arg1) {
                    return $arg1;
                });

        $this->setGlobal('ilDB', $mock_db);

        $this->web_link_repo = $this->getMockBuilder(ilWebLinkDatabaseRepository::class)
                                    ->setConstructorArgs([$webr_id, $update_history])
                                    ->onlyMethods([
                                        'getCurrentTime',
                                        'getNewDateTimeImmutable',
                                        'createHistoryEntry',
                                        'isInternalLink'
                                    ])
                                    ->getMock();

        $this->web_link_repo->method('getCurrentTime')
                            ->willReturn($current_time);
        $this->web_link_repo->method('getNewDateTimeImmutable')
                            ->willReturnOnConsecutiveCalls(...$datetimes);
    }

    protected function setGlobal(string $name, MockObject $obj): void
    {
        global $DIC;

        $GLOBALS[$name] = $obj;
        unset($DIC[$name]);
        $DIC[$name] = static function (Container $c) use ($obj) {
            return $obj;
        };
    }

    protected function tearDown(): void
    {
        global $DIC;
        $DIC = $this->dic;
        parent::tearDown();
    }

    protected function getNewDateTimeMock(int $timestamp): MockObject
    {
        $datetime = $this->getMockBuilder(DateTimeImmutable::class)
                         ->disableOriginalConstructor()
                         ->onlyMethods(['getTimestamp'])
                         ->getMock();
        $datetime->method('getTimestamp')
                 ->willReturn($timestamp);

        return $datetime;
    }

    public function testCreateExternalItem(): void
    {
        $mock_db = $this->getMockBuilder(ilDBInterface::class)
                        ->disableOriginalConstructor()
                        ->getMock();

        $mock_db->expects($this->exactly(3))
                ->method('nextId')
                ->willReturn(7, 71, 72);

        /*
         * 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.
         */
        $mock_db->expects($this->exactly(3))
                ->method('insert')
                ->willReturnCallback(fn($table, $data) => match([$table, $data]) {
                    [
                        ilWebLinkDatabaseRepository::PARAMS_TABLE,
                        [
                            'webr_id' => ['integer', 0],
                            'link_id' => ['integer', 7],
                            'param_id' => ['integer', 71],
                            'name' => ['text', 'name1'],
                            'value' => ['integer', ilWebLinkBaseParameter::VALUES['user_id']]
                        ]
                    ] => 1,
                    [
                        ilWebLinkDatabaseRepository::PARAMS_TABLE,
                        [
                            'webr_id' => ['integer', 0],
                            'link_id' => ['integer', 7],
                            'param_id' => ['integer', 72],
                            'name' => ['text', 'name2'],
                            'value' => ['integer', ilWebLinkBaseParameter::VALUES['login']]
                        ]
                    ] => 2,
                    [
                        ilWebLinkDatabaseRepository::ITEMS_TABLE,
                        [
                            'internal' => ['integer', 0],
                            'webr_id' => ['integer', 0],
                            'link_id' => ['integer', 7],
                            'title' => ['text', 'title'],
                            'description' => ['text', 'description'],
                            'target' => ['text', 'target'],
                            'active' => ['integer', 1],
                            'create_date' => ['integer', 12345678],
                            'last_update' => ['integer', 12345678]
                        ]
                    ] => 3
                });

        $param1 = new ilWebLinkDraftParameter(
            ilWebLinkBaseParameter::VALUES['user_id'],
            'name1'
        );
        $param2 = new ilWebLinkDraftParameter(
            ilWebLinkBaseParameter::VALUES['login'],
            'name2'
        );
        $item = new ilWebLinkDraftItem(
            false,
            'title',
            'description',
            'target',
            true,
            [$param1, $param2]
        );

        $datetime1 = $this->getNewDateTimeMock(12345678);
        $datetime2 = $this->getNewDateTimeMock(12345678);

        $this->setGlobalDBAndRepo(
            $mock_db,
            0,
            true,
            12345678,
            [$datetime1, $datetime2]
        );

        $this->web_link_repo->expects($this->once())
                            ->method('createHistoryEntry')
                            ->with(0, 'add', ['title']);
        $this->web_link_repo->expects($this->never())
                            ->method('isInternalLink');

        $expected_param1 = new ilWebLinkParameter(
            $this->user,
            0,
            7,
            71,
            ilWebLinkBaseParameter::VALUES['user_id'],
            'name1'
        );

        $expected_param2 = new ilWebLinkParameter(
            $this->user,
            0,
            7,
            72,
            ilWebLinkBaseParameter::VALUES['login'],
            'name2'
        );

        $this->assertEquals(
            new ilWebLinkItemExternal(
                0,
                7,
                'title',
                'description',
                'target',
                true,
                $datetime1,
                $datetime2,
                [$expected_param1, $expected_param2]
            ),
            $this->web_link_repo->createItem($item)
        );
    }

    public function testCreateInternalItemWithBrokenParameter(): void
    {
        $mock_db = $this->getMockBuilder(ilDBInterface::class)
                        ->disableOriginalConstructor()
                        ->getMock();
        $mock_db->expects($this->exactly(3))
                ->method('nextId')
                ->willReturn(7, 71, 72);

        /*
         * 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.
         */
        $mock_db->expects($this->exactly(2))
                ->method('insert')
                ->willReturnCallback(fn($table, $data) => match([$table, $data]) {
                    [
                        ilWebLinkDatabaseRepository::PARAMS_TABLE,
                        [
                            'webr_id' => ['integer', 0],
                            'link_id' => ['integer', 7],
                            'param_id' => ['integer', 72],
                            'name' => ['text', 'name2'],
                            'value' => ['integer', ilWebLinkBaseParameter::VALUES['login']]
                        ]
                    ] => 1,
                    [
                        ilWebLinkDatabaseRepository::ITEMS_TABLE,
                        [
                            'internal' => ['integer', 1],
                            'webr_id' => ['integer', 0],
                            'link_id' => ['integer', 7],
                            'title' => ['text', 'title'],
                            'description' => ['text', 'description'],
                            'target' => ['text', 'trg|123'],
                            'active' => ['integer', 1],
                            'create_date' => ['integer', 12345678],
                            'last_update' => ['integer', 12345678]
                        ]
                    ] => 2
                });

        $param1 = new ilWebLinkDraftParameter(
            23,
            'name1'
        );
        $param2 = new ilWebLinkDraftParameter(
            ilWebLinkBaseParameter::VALUES['login'],
            'name2'
        );
        $item = new ilWebLinkDraftItem(
            true,
            'title',
            'description',
            'trg|123',
            true,
            [$param1, $param2]
        );

        $datetime1 = $this->getNewDateTimeMock(12345678);
        $datetime2 = $this->getNewDateTimeMock(12345678);

        $this->setGlobalDBAndRepo(
            $mock_db,
            0,
            true,
            12345678,
            [$datetime1, $datetime2]
        );

        $this->web_link_repo->expects($this->once())
                            ->method('createHistoryEntry')
                            ->with(0, 'add', ['title']);
        $this->web_link_repo->expects($this->once())
                            ->method('isInternalLink')
                            ->with('trg|123')
                            ->willReturn(true);

        $expected_param2 = new ilWebLinkParameter(
            $this->user,
            0,
            7,
            72,
            ilWebLinkBaseParameter::VALUES['login'],
            'name2'
        );

        $this->assertEquals(
            new ilWebLinkItemInternal(
                0,
                7,
                'title',
                'description',
                'trg|123',
                true,
                $datetime1,
                $datetime2,
                [$expected_param2]
            ),
            $this->web_link_repo->createItem($item)
        );
    }

    public function testCreateItemBrokenInternalLinkException(): void
    {
        $mock_db = $this->getMockBuilder(ilDBInterface::class)
                        ->disableOriginalConstructor()
                        ->getMock();

        $mock_db->expects($this->once())
                ->method('nextId')
                ->with(ilWebLinkDatabaseRepository::ITEMS_TABLE)
                ->willReturn(7);

        $mock_db->expects($this->never())
                ->method('insert');

        $param1 = new ilWebLinkDraftParameter(
            ilWebLinkBaseParameter::VALUES['user_id'],
            'name1'
        );
        $param2 = new ilWebLinkDraftParameter(
            ilWebLinkBaseParameter::VALUES['login'],
            'name2'
        );
        $item = new ilWebLinkDraftItem(
            true,
            'title',
            'description',
            'wrong link',
            true,
            [$param1, $param2]
        );

        $datetime1 = $this->getNewDateTimeMock(12345678);
        $datetime2 = $this->getNewDateTimeMock(12345678);

        $this->setGlobalDBAndRepo(
            $mock_db,
            0,
            true,
            12345678,
            [$datetime1, $datetime2]
        );

        $this->web_link_repo->expects($this->never())
                            ->method('createHistoryEntry');
        $this->web_link_repo->expects($this->once())
                            ->method('isInternalLink')
                            ->with('wrong link')
                            ->willReturn(false);

        $this->expectException(ilWebLinkDatabaseRepositoryException::class);
        $this->web_link_repo->createItem($item);
    }

    public function testCreateList(): void
    {
        $mock_db = $this->getMockBuilder(ilDBInterface::class)
                        ->disableOriginalConstructor()
                        ->getMock();

        $mock_db->expects($this->never())
                ->method('nextId');

        $mock_db->expects($this->once())
                ->method('insert')
                ->with(
                    ilWebLinkDatabaseRepository::LISTS_TABLE,
                    [
                        'webr_id' => ['integer', 0],
                        'title' => ['text', 'title'],
                        'description' => ['text', ''],
                        'create_date' => ['integer', 12345678],
                        'last_update' => ['integer', 12345678]
                    ]
                );

        $list = new ilWebLinkDraftList(
            'title',
            null
        );

        $datetime1 = $this->getNewDateTimeMock(12345678);
        $datetime2 = $this->getNewDateTimeMock(12345678);

        $this->setGlobalDBAndRepo(
            $mock_db,
            0,
            true,
            12345678,
            [$datetime1, $datetime2]
        );

        $this->web_link_repo->expects($this->once())
                            ->method('createHistoryEntry')
                            ->with(0, 'add', ['title']);

        $this->assertEquals(
            new ilWebLinkList(
                0,
                'title',
                '',
                $datetime1,
                $datetime2
            ),
            $this->web_link_repo->createList($list)
        );
    }

    public function testCreateAllItemsInDraftContainer(): void
    {
        $mock_db = $this->getMockBuilder(ilDBInterface::class)
                        ->disableOriginalConstructor()
                        ->getMock();

        $datetime1 = $this->getNewDateTimeMock(12345678);
        $datetime2 = $this->getNewDateTimeMock(12345678);

        $this->setGlobalDBAndRepo(
            $mock_db,
            0,
            false,
            12345678,
            [$datetime1, $datetime2]
        );

        $draft_param1 = new ilWebLinkDraftParameter(
            ilWebLinkBaseParameter::VALUES['user_id'],
            'name1'
        );
        $draft_param2 = new ilWebLinkDraftParameter(
            ilWebLinkBaseParameter::VALUES['login'],
            'name2'
        );
        $draft_item1 = new ilWebLinkDraftItem(
            false,
            'title',
            'description',
            'target',
            true,
            [$draft_param1, $draft_param2]
        );

        $draft_item2 = new ilWebLinkDraftItem(
            true,
            'title',
            null,
            'trg|123',
            false,
            []
        );

        $draft_container = new ilWebLinkDraftItemsContainer([
            $draft_item1,
            $draft_item2
        ]);

        $param1 = new ilWebLinkParameter(
            $this->user,
            0,
            7,
            71,
            ilWebLinkBaseParameter::VALUES['user_id'],
            'name1'
        );
        $param2 = new ilWebLinkParameter(
            $this->user,
            0,
            7,
            72,
            ilWebLinkBaseParameter::VALUES['login'],
            'name2'
        );
        $item1 = new ilWebLinkItemExternal(
            0,
            7,
            'title',
            'description',
            'target',
            true,
            $datetime1,
            $datetime2,
            [$param1, $param2]
        );

        $item2 = new ilWebLinkItemInternal(
            0,
            8,
            'title',
            null,
            'trg|123',
            false,
            $datetime1,
            $datetime2,
            []
        );

        $repo = $this->getMockBuilder(ilWebLinkDatabaseRepository::class)
                     ->setConstructorArgs([0, true])
                     ->onlyMethods(['createItem'])
                     ->getMock();

        $repo->expects($this->exactly(2))
             ->method('createItem')
             ->willReturnCallback(fn($item) => match($item) {
                 $draft_item1 => $item1,
                 $draft_item2 => $item2
             });

        $this->assertEquals(
            new ilWebLinkItemsContainer(
                0,
                [$item1, $item2]
            ),
            $repo->createAllItemsInDraftContainer($draft_container)
        );
    }

}