ilTermsOfServiceDocumentGUITest.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Filesystem\Filesystems;
use ILIAS\FileUpload\FileUpload;
use ILIAS\Refinery\Factory as Refinery;
use ILIAS\UI\Component\Button\Standard;
use ILIAS\UI\Component\MessageBox\MessageBox;
use ILIAS\UI\Factory;
use ILIAS\UI\Renderer;
use PHPUnit\Framework\MockObject\MockObject;
use ILIAS\HTTP\GlobalHttpState;

class ilTermsOfServiceDocumentGUITest extends ilTermsOfServiceBaseTest
{
    protected ilTermsOfServiceTableDataProviderFactory $tableDataProviderFactory;
    protected ilObjTermsOfService $tos;
    protected ilGlobalTemplateInterface $tpl;
    protected ilCtrlInterface $ctrl;
    protected ilLanguage $lng;
    protected ilRbacSystem $rbacsystem;
    protected ilErrorHandling $error;
    protected ilObjUser $user;
    protected ilLogger $log;
    protected Factory $uiFactory;
    protected Renderer $uiRenderer;
    protected GlobalHttpState $httpState;
    protected ilToolbarGUI $toolbar;
    protected FileUpload $fileUpload;
    protected Filesystems $fileSystems;
    protected ilTermsOfServiceCriterionTypeFactoryInterface $criterionTypeFactory;
    protected ilHtmlPurifierInterface $documentPurifier;
    protected Refinery $refinery;

    protected function setUp(): void
    {
        parent::setUp();

        $this->tos = $this->getMockBuilder(ilObjTermsOfService::class)->disableOriginalConstructor()->getMock();
        $this->criterionTypeFactory = $this->getMockBuilder(ilTermsOfServiceCriterionTypeFactoryInterface::class)->disableOriginalConstructor()->getMock();
        $this->tpl = $this->getMockBuilder(ilGlobalTemplateInterface::class)->disableOriginalConstructor()->getMock();
        $this->ctrl = $this->getMockBuilder(ilCtrl::class)->disableOriginalConstructor()->getMock();
        $this->lng = $this->getMockBuilder(ilLanguage::class)->disableOriginalConstructor()->getMock();
        $this->rbacsystem = $this->getMockBuilder(ilRbacSystem::class)->disableOriginalConstructor()->getMock();
        $this->error = $this->getMockBuilder(ilErrorHandling::class)->disableOriginalConstructor()->getMock();
        $this->user = $this->getMockBuilder(ilObjUser::class)->disableOriginalConstructor()->getMock();
        $this->log = $this->getMockBuilder(ilLogger::class)->disableOriginalConstructor()->getMock();
        $this->toolbar = $this->getMockBuilder(ilToolbarGUI::class)->disableOriginalConstructor()->getMock();
        $this->httpState = $this->getMockBuilder(GlobalHttpState::class)->getMock();
        $this->uiFactory = $this->getMockBuilder(Factory::class)->disableOriginalConstructor()->getMock();
        $this->uiRenderer = $this->getMockBuilder(Renderer::class)->disableOriginalConstructor()->getMock();
        $this->fileSystems = $this->getMockBuilder(Filesystems::class)->getMock();
        $this->fileUpload = $this->getMockBuilder(FileUpload::class)->getMock();
        $this->tableDataProviderFactory = $this->getMockBuilder(ilTermsOfServiceTableDataProviderFactory::class)->disableOriginalConstructor()->getMock();
        $this->documentPurifier = $this->getMockBuilder(ilHtmlPurifierInterface::class)->getMock();
        $this->refinery = new ILIAS\Refinery\Factory(
            new \ILIAS\Data\Factory(),
            $this->lng
        );
    }

    public function commandProvider(): array
    {
        return [
            ['default_____read', [false]],
            ['confirmReset', [true, false]],
            ['reset', [true, false]],
            ['saveAddDocumentForm', [true, false]],
            ['showAddDocumentForm', [true, false]],
            ['saveEditDocumentForm', [true, false]],
            ['showEditDocumentForm', [true, false]],
            ['deleteDocuments', [true, false]],
            ['saveDocumentSorting', [true, false]],
            ['showAttachCriterionForm', [true, false]],
            ['saveAttachCriterionForm', [true, false]],
            ['showChangeCriterionForm', [true, false]],
            ['saveChangeCriterionForm', [true, false]],
            ['detachCriterionAssignment', [true, false]]
        ];
    }

    public function testAccessDeniedErrorIsRaisedWhenPermissionsAreMissing(string $command, array $accessResults): void
    {
        $this->ctrl
            ->expects($this->once())
            ->method('getCmd')
            ->willReturn($command);

        $accessResultCounter = 0;
        $this->rbacsystem
            ->expects($this->exactly(count($accessResults)))
            ->method('checkAccess')
            ->willReturnCallback(function () use ($accessResults, &$accessResultCounter) {
                $result = $accessResults[$accessResultCounter];

                $accessResultCounter++;

                return $result;
            });

        $this->error
            ->method('raiseError')
            ->willThrowException(new ilException('no_permission'));

        $gui = new ilTermsOfServiceDocumentGUI(
            $this->tos,
            $this->criterionTypeFactory,
            $this->tpl,
            $this->user,
            $this->ctrl,
            $this->lng,
            $this->rbacsystem,
            $this->error,
            $this->log,
            $this->toolbar,
            $this->httpState,
            $this->uiFactory,
            $this->uiRenderer,
            $this->fileSystems,
            $this->fileUpload,
            $this->tableDataProviderFactory,
            $this->documentPurifier,
            $this->refinery
        );

        $this->expectException(ilException::class);

        $gui->executeCommand();
    }

    public function testLastResetDateIsDisplayedInMessageBoxWhenAgreementsHaveBeenResetAtLeastOnce(): void
    {
        $this->setGlobalVariable('lng', clone $this->lng);
        $this->setGlobalVariable('ilUser', clone $this->user);

        $lastResetDate = $this->getMockBuilder(ilDate::class)
                              ->disableOriginalConstructor()
                              ->getMock();

        $date = new DateTime();

        $lastResetDate->setDate($date->getTimestamp(), IL_CAL_UNIX);

        $lastResetDate
            ->method('get')
            ->willReturn([
                'seconds' => (int) $date->format('s'),
                'minutes' => (int) $date->format('i'),
                'hours' => (int) $date->format('G'),
                'mday' => (int) $date->format('j'),
                'wday' => (int) $date->format('w'),
                'mon' => (int) $date->format('n'),
                'year' => (int) $date->format('Y'),
                'yday' => (int) $date->format('z'),
                'weekday' => $date->format('l'),
                'month' => $date->format('F'),
                'isoday' => (int) $date->format('N')
            ]);

        $lastResetDate
            ->method('isNull')
            ->willReturn(true); // Required because of \ilDatePresentation static calls

        $this->tos
            ->method('getLastResetDate')
            ->willReturn($lastResetDate);

        $this->ctrl
            ->expects($this->once())
            ->method('getCmd')
            ->willReturn('getResetMessageBoxHtml');

        $this->ctrl
            ->expects($this->once())
            ->method('getLinkTarget')
            ->with($this->isInstanceOf(ilTermsOfServiceDocumentGUI::class), 'confirmReset')
            ->willReturn('confirmReset');

        $this->rbacsystem
            ->method('checkAccess')
            ->willReturn(true);

        $buttonFactory = $this->getMockBuilder(\ILIAS\UI\Component\Button\Factory::class)->getMock();
        $button = $this->getMockBuilder(Standard::class)->getMock();

        $buttonFactory
            ->expects($this->once())
            ->method('standard')
            ->with($this->isType('string'), $this->equalTo('confirmReset'))
            ->willReturn($button);

        $this->uiFactory
            ->expects($this->once())
            ->method('button')
            ->willReturn($buttonFactory);

        $messageBoxFactory = $this->getMockBuilder(\ILIAS\UI\Component\MessageBox\Factory::class)->getMock();
        $info = $this->getMockBuilder(MessageBox::class)->getMock();

        $messageBoxFactory
            ->expects($this->once())
            ->method('info')
            ->with($this->stringContains('Some date:'))
            ->willReturn($info);

        $info
            ->expects($this->once())
            ->method('withButtons')
            ->with($this->countOf(1));

        $this->uiFactory
            ->expects($this->once())
            ->method('messageBox')
            ->willReturn($messageBoxFactory);

        $this->error
            ->expects($this->never())
            ->method('raiseError');

        $this->uiRenderer
            ->expects($this->atLeast(1))
            ->method('render')
            ->willReturn('');

        $this->lng
            ->expects($this->exactly(2))
            ->method('txt')
            ->willReturnOnConsecutiveCalls(
                'Some date: %s',
                'Some button text'
            );

        $gui = new ilTermsOfServiceDocumentGUI(
            $this->tos,
            $this->criterionTypeFactory,
            $this->tpl,
            $this->user,
            $this->ctrl,
            $this->lng,
            $this->rbacsystem,
            $this->error,
            $this->log,
            $this->toolbar,
            $this->httpState,
            $this->uiFactory,
            $this->uiRenderer,
            $this->fileSystems,
            $this->fileUpload,
            $this->tableDataProviderFactory,
            $this->documentPurifier,
            $this->refinery
        );

        $gui->executeCommand();
    }

    public function testNoLastResetDateIsDisplayedInMessageBoxWhenAgreementsHaveBeenResetAtLeastOnce(): void
    {
        $this->setGlobalVariable('lng', clone $this->lng);
        $this->setGlobalVariable('ilUser', clone $this->user);

        $lastResetDate = $this->getMockBuilder(ilDate::class)
                              ->disableOriginalConstructor()
                              ->getMock();

        $lastResetDate
            ->method('get')
            ->willReturn(0);
        $lastResetDate
            ->method('isNull')
            ->willReturn(true);

        $this->tos
            ->method('getLastResetDate')
            ->willReturn($lastResetDate);

        $this->ctrl
            ->expects($this->once())
            ->method('getCmd')
            ->willReturn('getResetMessageBoxHtml');

        $this->ctrl
            ->expects($this->once())
            ->method('getLinkTarget')
            ->with($this->isInstanceOf(ilTermsOfServiceDocumentGUI::class), 'confirmReset')
            ->willReturn('confirmReset');

        $this->rbacsystem
            ->method('checkAccess')
            ->willReturn(true);

        $buttonFactory = $this->getMockBuilder(\ILIAS\UI\Component\Button\Factory::class)->getMock();
        $button = $this->getMockBuilder(Standard::class)->getMock();

        $buttonFactory
            ->expects($this->once())
            ->method('standard')
            ->with($this->isType('string'), $this->equalTo('confirmReset'))
            ->willReturn($button);

        $this->uiFactory
            ->expects($this->once())
            ->method('button')
            ->willReturn($buttonFactory);

        $messageBoxFactory = $this->getMockBuilder(\ILIAS\UI\Component\MessageBox\Factory::class)->getMock();
        $info = $this->getMockBuilder(MessageBox::class)->getMock();

        $messageBoxFactory
            ->expects($this->once())
            ->method('info')
            ->with($this->stringContains('Agreements never reset'))
            ->willReturn($info);

        $info
            ->expects($this->once())
            ->method('withButtons')
            ->with($this->countOf(1));

        $this->uiFactory
            ->expects($this->once())
            ->method('messageBox')
            ->willReturn($messageBoxFactory);

        $this->error
            ->expects($this->never())
            ->method('raiseError');

        $this->uiRenderer
            ->expects($this->atLeast(1))
            ->method('render')
            ->willReturn('');

        $this->lng
            ->expects($this->exactly(2))
            ->method('txt')
            ->willReturnOnConsecutiveCalls(
                'Agreements never reset',
                'Some button text'
            );

        $gui = new ilTermsOfServiceDocumentGUI(
            $this->tos,
            $this->criterionTypeFactory,
            $this->tpl,
            $this->user,
            $this->ctrl,
            $this->lng,
            $this->rbacsystem,
            $this->error,
            $this->log,
            $this->toolbar,
            $this->httpState,
            $this->uiFactory,
            $this->uiRenderer,
            $this->fileSystems,
            $this->fileUpload,
            $this->tableDataProviderFactory,
            $this->documentPurifier,
            $this->refinery
        );

        $gui->executeCommand();
    }
}