Unit tests for ilWebLinkDatabaseRepository. More...

Inheritance diagram for ilWebResourceDatabaseRepositoryTest:

Collaboration diagram for ilWebResourceDatabaseRepositoryTest:

Public Member Functions
	testCreateExternalItem ()
	Test creating an item with two intact parameters, and an external link. More...

	testCreateInternalItemWithBrokenParameter ()
	Test creating an item with one intact and one broken parameter, and an internal link. More...

	testCreateItemBrokenInternalLinkException ()

	testCreateList ()

	testCreateAllItemsInDraftContainer ()

Protected Member Functions
	setUp ()

	initDependencies ()

	setGlobalDBAndRepo (ilDBInterface $mock_db, int $webr_id, int $current_time, array $datetimes)

	setGlobal (string $name, MockObject $obj)

	tearDown ()

	getNewDateTimeMock (int $timestamp)

Protected Attributes
Container	$dic = null

ilObjUser	$user

ilWebLinkRepository &MockObject	$web_link_repo

Detailed Description

Unit tests for ilWebLinkDatabaseRepository.

Author: Tim Schmitz schmi.nosp@m.tz@l.nosp@m.eifos.nosp@m..com

Definition at line 29 of file ilWebResourceDatabaseRepositoryTest.php.

Member Function Documentation

◆ getNewDateTimeMock()

ilWebResourceDatabaseRepositoryTest::getNewDateTimeMock ( int $timestamp )

protected

Returns: DateTimeImmutable&MockObject

Definition at line 117 of file ilWebResourceDatabaseRepositoryTest.php.

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

References $datetime, and $timestamp.

◆ initDependencies()

ilWebResourceDatabaseRepositoryTest::initDependencies ( )

protected

Definition at line 41 of file ilWebResourceDatabaseRepositoryTest.php.

                                         : 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);
    }

References $DIC, $GLOBALS, $user, setGlobal(), and ILIAS\Repository\user().

Referenced by setUp().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setGlobal()

ilWebResourceDatabaseRepositoryTest::setGlobal	(	string	$name,
		MockObject	$obj
	)

protected

Definition at line 96 of file ilWebResourceDatabaseRepositoryTest.php.

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

References $c, $DIC, and $GLOBALS.

Referenced by initDependencies().

Here is the caller graph for this function:

◆ setGlobalDBAndRepo()

ilWebResourceDatabaseRepositoryTest::setGlobalDBAndRepo	(	ilDBInterface	$mock_db,
		int	$webr_id,
		int	$current_time,
		array	$datetimes
	)

protected

Parameters

	ilDBInterface&MockObject	$mock_db
int	$webr_id
int	$current_time
	DateTimeImmutable&MockObject[]	$datetimes

Returns: void

Definition at line 64 of file ilWebResourceDatabaseRepositoryTest.php.

     : 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])
                                    ->onlyMethods([
                                        'getCurrentTime',
                                        'getNewDateTimeImmutable',
                                        'isInternalLink'
                                    ])
                                    ->getMock();
 
        $this->web_link_repo->method('getCurrentTime')
                            ->willReturn($current_time);
        $this->web_link_repo->method('getNewDateTimeImmutable')
                            ->willReturnOnConsecutiveCalls(...$datetimes);
    }

◆ setUp()

ilWebResourceDatabaseRepositoryTest::setUp ( )

protected

Definition at line 35 of file ilWebResourceDatabaseRepositoryTest.php.

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

References initDependencies().

Here is the call graph for this function:

◆ tearDown()

ilWebResourceDatabaseRepositoryTest::tearDown ( )

protected

Definition at line 107 of file ilWebResourceDatabaseRepositoryTest.php.

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

References $DIC, and $dic.

◆ testCreateAllItemsInDraftContainer()

ilWebResourceDatabaseRepositoryTest::testCreateAllItemsInDraftContainer ( )

Definition at line 468 of file ilWebResourceDatabaseRepositoryTest.php.

                                                        : void
    {
        $mock_db = $this->getMockBuilder(ilDBInterface::class)
                        ->disableOriginalConstructor()
                        ->getMock();
 
        $datetime1 = $this->getNewDateTimeMock(12345678);
        $datetime2 = $this->getNewDateTimeMock(12345678);
 
        $this->setGlobalDBAndRepo(
            $mock_db,
            0,
            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)
        );
    }

References ILIAS\Repository\user(), and ilWebLinkBaseParameter\VALUES.

Here is the call graph for this function:

◆ testCreateExternalItem()

ilWebResourceDatabaseRepositoryTest::testCreateExternalItem ( )

Test creating an item with two intact parameters, and an external link.

Definition at line 135 of file ilWebResourceDatabaseRepositoryTest.php.

                                            : 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,
            12345678,
            [$datetime1, $datetime2]
        );
 
        $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)
        );
    }

References $data, ilWebLinkDatabaseRepository\ITEMS_TABLE, ilWebLinkDatabaseRepository\PARAMS_TABLE, ILIAS\Repository\user(), and ilWebLinkBaseParameter\VALUES.

Here is the call graph for this function:

◆ testCreateInternalItemWithBrokenParameter()

ilWebResourceDatabaseRepositoryTest::testCreateInternalItemWithBrokenParameter ( )

Test creating an item with one intact and one broken parameter, and an internal link.

Definition at line 261 of file ilWebResourceDatabaseRepositoryTest.php.

                                                               : 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,
            12345678,
            [$datetime1, $datetime2]
        );
 
        $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)
        );
    }

References $data, ilWebLinkDatabaseRepository\ITEMS_TABLE, ilWebLinkDatabaseRepository\PARAMS_TABLE, ILIAS\Repository\user(), and ilWebLinkBaseParameter\VALUES.

Here is the call graph for this function:

◆ testCreateItemBrokenInternalLinkException()

ilWebResourceDatabaseRepositoryTest::testCreateItemBrokenInternalLinkException ( )

Definition at line 365 of file ilWebResourceDatabaseRepositoryTest.php.

                                                               : 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,
            12345678,
            [$datetime1, $datetime2]
        );
 
        $this->web_link_repo->expects($this->once())
                            ->method('isInternalLink')
                            ->with('wrong link')
                            ->willReturn(false);
 
        $this->expectException(ilWebLinkDatabaseRepositoryException::class);
        $this->web_link_repo->createItem($item);
    }

References ilWebLinkDatabaseRepository\ITEMS_TABLE, and ilWebLinkBaseParameter\VALUES.

◆ testCreateList()

ilWebResourceDatabaseRepositoryTest::testCreateList ( )

Definition at line 417 of file ilWebResourceDatabaseRepositoryTest.php.

                                    : 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,
            12345678,
            [$datetime1, $datetime2]
        );
 
        $this->assertEquals(
            new ilWebLinkList(
                0,
                'title',
                '',
                $datetime1,
                $datetime2
            ),
            $this->web_link_repo->createList($list)
        );
    }