ilLPStatusIconsTest.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use PHPUnit\Framework\TestCase;
use ILIAS\UI\Component\Symbol\Icon\Icon;
use ILIAS\UI\Renderer as UIRenderer;
use ILIAS\UI\Factory as UIFactory;
use ILIAS\UI\Component\Symbol\Factory as SymbolFactory;
use ILIAS\UI\Component\Symbol\Icon\Factory as IconFactory;
use ILIAS\UI\Component\Symbol\Icon\Custom;

class ilLPStatusIconsTest extends TestCase
{
    protected $path = 'sample/path';
    protected $alt = 'alt';
    protected $size = Icon::SMALL;

    protected function getUIFactory(): UIFactory
    {
        $custom_icon = $this->createMock(Custom::class);
        $custom_icon->method('getIconPath')
                    ->willReturn($this->path);
        $custom_icon->method('getSize')
                    ->willReturn($this->size);
        $custom_icon->method('getLabel')
                    ->willReturn($this->alt);

        $icon_factory = $this->createMock(IconFactory::class);
        $icon_factory->method('custom')
                     ->willReturn($custom_icon);

        $symbol_factory = $this->createMock(SymbolFactory::class);
        $symbol_factory->method('icon')
                       ->willReturn($icon_factory);

        $factory = $this->createMock(UIFactory::class);
        $factory->method('symbol')
                ->willReturn($symbol_factory);

        return $factory;
    }

    protected function getUIRenderer(): UIRenderer
    {
        $renderer = $this->createMock(UIRenderer::class);
        $renderer->method('render')
                 ->willReturnCallback(function ($arg) {
                     return 'rendered: path(' . $arg->getIconPath() .
                         '), alt(' . $arg->getLabel() .
                         '), size(' . $arg->getSize() . ')';
                 });

        return $renderer;
    }

    public function testTripleton(): array
    {
        $factory = $this->getUIFactory();
        $renderer = $this->getUIRenderer();

        $long1 = ilLPStatusIconsMock::getInstance(ilLPStatusIcons::ICON_VARIANT_LONG, $renderer, $factory);
        $long2 = ilLPStatusIconsMock::getInstance(ilLPStatusIcons::ICON_VARIANT_LONG, $renderer, $factory);

        $short1 = ilLPStatusIconsMock::getInstance(ilLPStatusIcons::ICON_VARIANT_SHORT, $renderer, $factory);
        $short2 = ilLPStatusIconsMock::getInstance(ilLPStatusIcons::ICON_VARIANT_SHORT, $renderer, $factory);

        $scorm1 = ilLPStatusIconsMock::getInstance(ilLPStatusIcons::ICON_VARIANT_SCORM, $renderer, $factory);
        $scorm2 = ilLPStatusIconsMock::getInstance(ilLPStatusIcons::ICON_VARIANT_SCORM, $renderer, $factory);

        $this->assertSame($short1, $short2);
        $this->assertSame($long1, $long2);
        $this->assertSame($scorm1, $scorm2);

        $this->assertNotSame($long1, $short1);
        $this->assertNotSame($long1, $scorm1);
        $this->assertNotSame($short1, $scorm1);

        return ['long' => $long1, 'short' => $short1, 'scorm' => $scorm1];
    }

    public function testGetInstanceForInvalidVariant(): void
    {
        $renderer = $this->getMockBuilder(UIRenderer::class)
                         ->disableOriginalConstructor()
                         ->getMock();

        $factory = $this->getMockBuilder(UIFactory::class)
                        ->disableOriginalConstructor()
                        ->getMock();

        $this->expectException(ilLPException::class);
        ilLPStatusIcons::getInstance(793, $renderer, $factory);
    }

    public function testSomeExamplesForImagePathsByStatus(array $instances): void
    {
        $path1 = $instances['long']->getImagePathInProgress();
        $path2 = $instances['long']->getImagePathForStatus(ilLPStatus::LP_STATUS_IN_PROGRESS_NUM);
        $this->assertSame($path1, $path2);

        $path1 = $instances['short']->getImagePathCompleted();
        $path2 = $instances['short']->getImagePathForStatus(ilLPStatus::LP_STATUS_COMPLETED_NUM);
        $this->assertSame($path1, $path2);

        $path1 = $instances['scorm']->getImagePathFailed();
        $path2 = $instances['scorm']->getImagePathForStatus(ilLPStatus::LP_STATUS_FAILED_NUM);
        $this->assertSame($path1, $path2);
    }

    public function testImagePathRunningForLongVariant(array $instances): void
    {
        $this->expectException(ilLPException::class);
        $instances['long']->getImagePathRunning();
    }

    public function testImagePathAssetForLongVariant(array $instances): void
    {
        $this->expectException(ilLPException::class);
        $instances['long']->getImagePathAsset();
    }

    public function testSomeExamplesForRenderedIcons(array $instances): void
    {
        //try rendering some icons
        $this->assertSame(
            'rendered: path(' . $this->path .
            '), alt(' . $this->alt .
            '), size(' . $this->size . ')',
            $instances['long']->renderIcon($this->path, $this->alt)
        );

        $this->assertSame(
            'rendered: path(' . $this->path .
            '), alt(' . $this->alt .
            '), size(' . $this->size . ')',
            $instances['short']->renderIcon($this->path, $this->alt)
        );
    }

    public function testRenderScormIcons(array $instances): void
    {
        $this->expectException(ilLPException::class);
        $instances['scorm']->renderIcon('path', 'alt');
    }
}

class ilLPStatusIconsMock extends ilLPStatusIcons
{
    protected function buildImagePath(string $image_name): string
    {
        return 'test/' . $image_name;
    }
}