ilCertificateTemplateRepositoryTest.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilCertificateTemplateRepositoryTest extends ilCertificateBaseTestCase
{
    public function testCertificateWillBeSavedToTheDatabase(): void
    {
        $database = $this->createMock(ilDBInterface::class);

        $logger = $this->getMockBuilder(ilLogger::class)
            ->disableOriginalConstructor()
            ->getMock();

        $objectDataCache = $this->getMockBuilder(ilObjectDataCache::class)
            ->disableOriginalConstructor()
            ->getMock();

        $objectDataCache->method('lookUpType')->willReturn('crs');

        $database->method('nextId')
            ->willReturn(10);

        $database->method('insert')
            ->with(
                'il_cert_template',
                [
                    'id' => ['integer', 10],
                    'obj_id' => ['integer', 100],
                    'obj_type' => ['text', 'crs'],
                    'certificate_content' => ['clob', '<xml>Some Content</xml>'],
                    'certificate_hash' => ['text', md5('<xml>Some Content</xml>')],
                    'template_values' => ['clob', '[]'],
                    'version' => ['integer', 1],
                    'ilias_version' => ['text', 'v5.4.0'],
                    'created_timestamp' => ['integer', 123_456_789],
                    'currently_active' => ['integer', true],
                    'deleted' => ['integer', 0],
                    'background_image_path' => ['text', '/some/where/background.jpg'],
                    'tile_image_path' => ['text', '/some/path/test.svg'],
                    'background_image_ident' => ['text', '-'],
                    'tile_image_ident' => ['text', '-']
                ]
            );

        $database->method('tableColumnExists')->willReturnMap(
            [
                ['il_cert_user_cert', 'background_image_path', true],
                ['il_cert_user_cert', 'tile_image_path', true],
            ]
        );

        $logger->expects($this->atLeastOnce())
            ->method('debug');

        $template = new ilCertificateTemplate(
            100,
            'crs',
            '<xml>Some Content</xml>',
            md5('<xml>Some Content</xml>'),
            '[]',
            1,
            'v5.4.0',
            123_456_789,
            true,
            '/some/where/background.jpg',
            '/some/path/test.svg',
            '-',
            '-'
        );

        $repository = new ilCertificateTemplateDatabaseRepository($database, $logger, $objectDataCache);

        $repository->save($template);
    }

    public function testFetchCertificateTemplatesByObjId(): void
    {
        $logger = $this->getMockBuilder(ilLogger::class)
            ->disableOriginalConstructor()
            ->getMock();

        $database = $this->createMock(ilDBInterface::class);
        $consecutive = [
            [
                'id' => 1,
                'obj_id' => 10,
                'obj_type' => 'crs',
                'certificate_content' => '<xml>Some Content</xml>',
                'certificate_hash' => md5('<xml>Some Content</xml>'),
                'template_values' => '[]',
                'version' => 1,
                'ilias_version' => 'v5.4.0',
                'created_timestamp' => 123_456_789,
                'currently_active' => true,
                'background_image_path' => '/some/where/background.jpg',
                'tile_image_path' => 'some/path/test.svg',
                'background_image_ident' => '-',
                'tile_image_ident' => '-'
            ],
            [
                'id' => 30,
                'obj_id' => 10,
                'obj_type' => 'tst',
                'certificate_content' => '<xml>Some Other Content</xml>',
                'certificate_hash' => md5('<xml>Some Content</xml>'),
                'template_values' => '[]',
                'version' => 55,
                'ilias_version' => 'v5.3.0',
                'created_timestamp' => 123_456_789,
                'currently_active' => false,
                'background_image_path' => '/some/where/else/background.jpg',
                'tile_image_path' => 'some/path/test.svg',
                'background_image_ident' => '-',
                'tile_image_ident' => '-'
            ]
        ];
        $database->method('fetchAssoc')->willReturnCallback(
            function () use (&$consecutive) {
                return array_shift($consecutive);
            }
        );

        $objectDataCache = $this->getMockBuilder(ilObjectDataCache::class)
            ->disableOriginalConstructor()
            ->getMock();

        $objectDataCache->method('lookUpType')->willReturn('crs');

        $repository = new ilCertificateTemplateDatabaseRepository($database, $logger, $objectDataCache);

        $templates = $repository->fetchCertificateTemplatesByObjId(10);

        $this->assertSame(1, $templates[0]->getId());
        $this->assertSame(30, $templates[1]->getId());
    }

    public function testFetchCurrentlyActiveCertificate(): void
    {
        $logger = $this->getMockBuilder(ilLogger::class)
            ->disableOriginalConstructor()
            ->getMock();

        $database = $this->createMock(ilDBInterface::class);
        $consecutive = [
            [
                'id' => 1,
                'obj_id' => 10,
                'obj_type' => 'crs',
                'certificate_content' => '<xml>Some Content</xml>',
                'certificate_hash' => md5('<xml>Some Content</xml>'),
                'template_values' => '[]',
                'version' => 1,
                'ilias_version' => 'v5.4.0',
                'created_timestamp' => 123_456_789,
                'currently_active' => true,
                'background_image_path' => '/some/where/background.jpg',
                'tile_image_path' => 'some/path/test.svg',
                'background_image_ident' => '-',
                'tile_image_ident' => '-'
            ],
            [
                'id' => 30,
                'obj_id' => 10,
                'obj_type' => 'tst',
                'certificate_content' => '<xml>Some Other Content</xml>',
                'certificate_hash' => md5('<xml>Some Content</xml>'),
                'template_values' => '[]',
                'version' => 55,
                'ilias_version' => 'v5.3.0',
                'created_timestamp' => 123_456_789,
                'currently_active' => false,
                'background_image_path' => '/some/where/else/background.jpg',
                'tile_image_path' => 'some/path/test.svg',
                'background_image_ident' => '-',
                'tile_image_ident' => '-'
            ]
        ];
        $database->method('fetchAssoc')->willReturnCallback(
            function () use (&$consecutive) {
                return array_shift($consecutive);
            }
        );

        $objectDataCache = $this->getMockBuilder(ilObjectDataCache::class)
            ->disableOriginalConstructor()
            ->getMock();

        $objectDataCache->method('lookUpType')->willReturn('crs');

        $repository = new ilCertificateTemplateDatabaseRepository($database, $logger, $objectDataCache);

        $template = $repository->fetchCurrentlyActiveCertificate(10);

        $this->assertSame(1, $template->getId());
    }

    public function testFetchPreviousCertificate(): void
    {
        $logger = $this->getMockBuilder(ilLogger::class)
            ->disableOriginalConstructor()
            ->getMock();

        $database = $this->createMock(ilDBInterface::class);
        $consecutive = [
                [
                    'id' => 1,
                    'obj_id' => 10,
                    'obj_type' => 'crs',
                    'certificate_content' => '<xml>Some Content</xml>',
                    'certificate_hash' => md5('<xml>Some Content</xml>'),
                    'template_values' => '[]',
                    'version' => 1,
                    'ilias_version' => 'v5.4.0',
                    'created_timestamp' => 123_456_789,
                    'currently_active' => true,
                    'background_image_path' => '/some/where/background.jpg',
                    'tile_image_path' => 'some/path/test.svg',
                    'background_image_ident' => '-',
                    'tile_image_ident' => '-'
                ],
                [
                    'id' => 30,
                    'obj_id' => 10,
                    'obj_type' => 'tst',
                    'certificate_content' => '<xml>Some Other Content</xml>',
                    'certificate_hash' => md5('<xml>Some Content</xml>'),
                    'template_values' => '[]',
                    'version' => 55,
                    'ilias_version' => 'v5.3.0',
                    'created_timestamp' => 123_456_789,
                    'currently_active' => false,
                    'background_image_path' => '/some/where/else/background.jpg',
                    'tile_image_path' => 'some/path/test.svg',
                    'background_image_ident' => '-',
                    'tile_image_ident' => '-'
                ]
        ];
        $database->method('fetchAssoc')->willReturnCallback(
            function () use (&$consecutive) {
                return array_shift($consecutive);
            }
        );

        $objectDataCache = $this->getMockBuilder(ilObjectDataCache::class)
            ->disableOriginalConstructor()
            ->getMock();

        $objectDataCache->method('lookUpType')->willReturn('crs');

        $repository = new ilCertificateTemplateDatabaseRepository($database, $logger, $objectDataCache);

        $template = $repository->fetchPreviousCertificate(10);

        $this->assertSame(30, $template->getId());
    }

    public function testDeleteTemplateFromDatabase(): void
    {
        $database = $this->createMock(ilDBInterface::class);

        $logger = $this->getMockBuilder(ilLogger::class)
            ->disableOriginalConstructor()
            ->getMock();

        $quote_consecutive = [
            [10, 'integer'],
            [200, 'integer']
        ];
        $database->method('quote')->willReturnCallback(
            function (int $v, string $type) use (&$quote_consecutive) {
                list($expected, $type) = array_shift($quote_consecutive);
                $this->assertEquals('integer', $type);
                $this->assertEquals($expected, $v);
                return (string) ($v);
            }
        );


        $database->method('query')
            ->with('
DELETE FROM il_cert_template
WHERE id = 10
AND obj_id = 200');

        $objectDataCache = $this->getMockBuilder(ilObjectDataCache::class)
            ->disableOriginalConstructor()
            ->getMock();

        $objectDataCache->method('lookUpType')->willReturn('crs');

        $repository = new ilCertificateTemplateDatabaseRepository($database, $logger, $objectDataCache);

        $repository->deleteTemplate(10, 200);
    }

    public function testActivatePreviousCertificate(): void
    {
        $logger = $this->getMockBuilder(ilLogger::class)
            ->disableOriginalConstructor()
            ->getMock();

        $database = $this->createMock(ilDBInterface::class);

        $quote_consecutive = [
            [10, 'integer'],
            [30, 'integer']
        ];
        $database->method('quote')->willReturnCallback(
            function (int $v, string $type) use (&$quote_consecutive) {
                list($expected, $type) = array_shift($quote_consecutive);
                $this->assertEquals('integer', $type);
                $this->assertEquals($expected, $v);
                return (string) ($v);
            }
        );

        $consecutive = [
            [
                'id' => 1,
                'obj_id' => 10,
                'obj_type' => 'crs',
                'certificate_content' => '<xml>Some Content</xml>',
                'certificate_hash' => md5('<xml>Some Content</xml>'),
                'template_values' => '[]',
                'version' => 1,
                'ilias_version' => 'v5.4.0',
                'created_timestamp' => 123_456_789,
                'currently_active' => true,
                'background_image_path' => '/some/where/background.jpg',
                'tile_image_path' => 'some/path/test.svg',
                'background_image_ident' => '-',
                'tile_image_ident' => '-'
            ],
            [
                'id' => 30,
                'obj_id' => 10,
                'obj_type' => 'tst',
                'certificate_content' => '<xml>Some Other Content</xml>',
                'certificate_hash' => md5('<xml>Some Content</xml>'),
                'template_values' => '[]',
                'version' => 55,
                'ilias_version' => 'v5.3.0',
                'created_timestamp' => 123_456_789,
                'currently_active' => false,
                'background_image_path' => '/some/where/else/background.jpg',
                'tile_image_path' => 'some/path/test.svg',
                'background_image_ident' => '-',
                'tile_image_ident' => '-'
            ]
        ];
        $database->method('fetchAssoc')->willReturnCallback(
            function () use (&$consecutive) {
                return array_shift($consecutive);
            }
        );

        $query_consecutive = [
            "SELECT * FROM il_cert_template WHERE obj_id = 10 AND deleted = 0 ORDER BY version ASC",
            'UPDATE il_cert_template SET currently_active = 1 WHERE id = 30'
        ];
        $database->method('query')->willReturnCallback(
            function (string $v) use (&$query_consecutive) {
                $expected = array_shift($query_consecutive);
                $v = trim(str_replace(array("\n", "\r"), ' ', $v))  ;
                $this->assertEquals($expected, $v);
                return $this->createMock(ilDBStatement::class);
            },
        );

        $objectDataCache = $this->getMockBuilder(ilObjectDataCache::class)
            ->disableOriginalConstructor()
            ->getMock();

        $objectDataCache->method('lookUpType')->willReturn('crs');

        $repository = new ilCertificateTemplateDatabaseRepository($database, $logger, $objectDataCache);

        $template = $repository->activatePreviousCertificate(10);

        $this->assertSame(30, $template->getId());
    }

    public function testFetchAllObjectIdsByType(): void
    {
        $logger = $this->getMockBuilder(ilLogger::class)
            ->disableOriginalConstructor()
            ->getMock();

        $objectDataCache = $this->getMockBuilder(ilObjectDataCache::class)
            ->disableOriginalConstructor()
            ->getMock();


        $database = $this->createMock(ilDBInterface::class);
        $consecutive = [
            [
                'id' => 1,
                'obj_id' => 10,
                'obj_type' => 'crs',
                'certificate_content' => '<xml>Some Content</xml>',
                'certificate_hash' => md5('<xml>Some Content</xml>'),
                'template_values' => '[]',
                'version' => 1,
                'ilias_version' => 'v5.4.0',
                'created_timestamp' => 123_456_789,
                'currently_active' => true,
                'background_image_path' => '/some/where/background.jpg',
                'tile_image_path' => '/some/where/tile_image.svg',
                'background_image_ident' => '-',
                'tile_image_ident' => '-'
            ],
            [
                'id' => 30,
                'obj_id' => 30,
                'obj_type' => 'crs',
                'certificate_content' => '<xml>Some Other Content</xml>',
                'certificate_hash' => md5('<xml>Some Content</xml>'),
                'template_values' => '[]',
                'version' => 55,
                'ilias_version' => 'v5.3.0',
                'created_timestamp' => 123_456_789,
                'currently_active' => false,
                'background_image_path' => '/some/where/else/background.jpg',
                'tile_image_path' => '/some/where/tile_image.svg',
                'background_image_ident' => '-',
                'tile_image_ident' => '-'
            ]
        ];
        $database->method('fetchAssoc')->willReturnCallback(
            function () use (&$consecutive) {
                return array_shift($consecutive);
            }
        );

        $repository = new ilCertificateTemplateDatabaseRepository($database, $logger, $objectDataCache);

        $templates = $repository->fetchActiveCertificateTemplatesForCoursesWithDisabledLearningProgress(true);

        $this->assertSame(10, $templates[0]->getObjId());
        $this->assertSame(30, $templates[1]->getObjId());
    }

    public function testFetchFirstCreatedTemplateFailsBecauseNothingWasSaved(): never
    {
        $this->expectException(ilException::class);

        $database = $this->createMock(ilDBInterface::class);

        $logger = $this->getMockBuilder(ilLogger::class)
            ->disableOriginalConstructor()
            ->getMock();

        $database->method('quote')
            ->with(10, 'integer')
            ->willReturn('10');

        $objectDataCache = $this->getMockBuilder(ilObjectDataCache::class)
            ->disableOriginalConstructor()
            ->getMock();

        $database->method('fetchAssoc')
            ->willReturn([]);

        $database->method('fetchAssoc')
            ->willReturn([]);

        $repository = new ilCertificateTemplateDatabaseRepository($database, $logger, $objectDataCache);

        $repository->fetchFirstCreatedTemplate(10);

        $this->fail();
    }

    public function fetchFirstCreateTemplate(): void
    {
        $database = $this->createMock(ilDBInterface::class);

        $logger = $this->getMockBuilder(ilLogger::class)
            ->disableOriginalConstructor()
            ->getMock();

        $database->method('quote')
            ->with(10, 'integer')
            ->willReturn(10);

        $objectDataCache = $this->getMockBuilder(ilObjectDataCache::class)
            ->disableOriginalConstructor()
            ->getMock();

        $database->method('fetchAssoc')
            ->willReturn([]);

        $database->method('fetchAssoc')->willReturn(
            [
                'id' => 1,
                'obj_id' => 10,
                'obj_type' => 'crs',
                'certificate_content' => '<xml>Some Content</xml>',
                'certificate_hash' => md5('<xml>Some Content</xml>'),
                'template_values' => '[]',
                'version' => 1,
                'ilias_version' => 'v5.4.0',
                'created_timestamp' => 123_456_789,
                'currently_active' => true,
                'background_image_ident' => '/some/where/background.jpg'
            ]
        );

        $repository = new ilCertificateTemplateDatabaseRepository($database, $logger, $objectDataCache);

        $firstTemplate = $repository->fetchFirstCreatedTemplate(10);

        $this->assertSame(1, $firstTemplate->getId());
    }
}