ilMailOptionsGUITest.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\HTTP\Wrapper\WrapperFactory;
use Psr\Http\Message\ServerRequestInterface;
use ILIAS\HTTP\GlobalHttpState;
use ILIAS\Refinery\Factory;
use PHPUnit\Framework\Attributes\DoesNotPerformAssertions;

class ilMailOptionsGUITest extends ilMailBaseTestCase
{
    protected function getMailOptionsGUI(
        GlobalHttpState $http_state,
        ilCtrlInterface $ctrl,
        ilMailOptions $mail_options
    ): ilMailOptionsGUI {
        $tpl = $this->getMockBuilder(ilGlobalTemplateInterface::class)->disableOriginalConstructor()->getMock();
        $lng = $this->getMockBuilder(ilLanguage::class)->disableOriginalConstructor()->getMock();
        $user = $this->getMockBuilder(ilObjUser::class)->disableOriginalConstructor()->getMock();

        return new ilMailOptionsGUI(
            $tpl,
            $ctrl,
            $lng,
            $user,
            $http_state,
            new Factory(new \ILIAS\Data\Factory(), $lng),
            $mail_options
        );
    }

    #[DoesNotPerformAssertions]
    public function testMailOptionsAreAccessibleIfGlobalAccessIsNotDenied(): void
    {
        $ctrl = $this->getMockBuilder(ilCtrl::class)->disableOriginalConstructor()->getMock();
        $form = $this->getMockBuilder(ilMailOptionsFormGUI::class)->disableOriginalConstructor()->getMock();

        $ctrl->method('getCmd')->willReturn('showOptions');

        $request = $this->getMockBuilder(ServerRequestInterface::class)->disableOriginalConstructor()->getMock();
        $request->method('getQueryParams')->willReturn([]);
        $wrapper = new WrapperFactory($request);

        $http = $this->getMockBuilder(GlobalHttpState::class)->getMock();
        $http->method('wrapper')->willReturn($wrapper);

        $settings = $this->getMockBuilder(ilSetting::class)->disableOriginalConstructor()->onlyMethods(['get'])->getMock();
        $settings->method('get')->willReturnCallback(static function (string $key, ?string $default = null) {
            if ($key === 'show_mail_settings') {
                return '1';
            }

            return $default;
        });

        $options = new ilMailOptions(
            0,
            null,
            $this->createMock(\ILIAS\Data\Clock\ClockInterface::class),
            $settings,
            $this->createMock(ilDBInterface::class)
        );

        $gui = $this->getMailOptionsGUI($http, $ctrl, $options);
        $gui->setForm($form);
        $gui->executeCommand();
    }

    public function testMailOptionsAreNotAccessibleIfGlobalAccessIsDeniedAndUserWillBeRedirectedToMailSystem(): void
    {
        $ctrl = $this->getMockBuilder(ilCtrl::class)->disableOriginalConstructor()->getMock();
        $form = $this->getMockBuilder(ilMailOptionsFormGUI::class)->disableOriginalConstructor()->getMock();

        $ctrl->method('getCmd')->willReturn('showOptions');

        $request = $this->getMockBuilder(ServerRequestInterface::class)->disableOriginalConstructor()->getMock();
        $request->method('getQueryParams')->willReturn([]);
        $wrapper = new WrapperFactory($request);

        $http = $this->getMockBuilder(GlobalHttpState::class)->getMock();
        $http->method('wrapper')->willReturn($wrapper);

        $ctrl->expects($this->once())->method('redirectByClass')->with(ilMailGUI::class);

        $settings = $this->getMockBuilder(ilSetting::class)->disableOriginalConstructor()->onlyMethods(['get'])->getMock();
        $settings->method('get')->willReturnCallback(static function (string $key, ?string $default = null) {
            if ($key === 'show_mail_settings') {
                return '0';
            }

            return $default;
        });

        $options = new ilMailOptions(
            0,
            null,
            $this->createMock(\ILIAS\Data\Clock\ClockInterface::class),
            $settings,
            $this->createMock(ilDBInterface::class)
        );

        $gui = $this->getMailOptionsGUI($http, $ctrl, $options);
        $gui->setForm($form);
        $gui->executeCommand();
    }

    public function testMailOptionsAreNotAccessibleIfGlobalAccessIsDeniedAndUserWillBeRedirectedToPersonalSettings(): void
    {
        $this->expectException(ilCtrlException::class);

        $request = $this->getMockBuilder(ServerRequestInterface::class)->disableOriginalConstructor()->getMock();
        $ctrl = $this->createMock(ilCtrlInterface::class);
        $form = $this->getMockBuilder(ilMailOptionsFormGUI::class)->disableOriginalConstructor()->getMock();

        $ctrl->method('getCmd')->willReturn('showOptions');

        $ctrl->expects($this->once())->method('redirectByClass')->with(ilPersonalSettingsGUI::class)->willThrowException(
            new ilCtrlException('Script terminated')
        );

        $settings = $this->getMockBuilder(ilSetting::class)->disableOriginalConstructor()->onlyMethods(['get'])->getMock();
        $settings->method('get')->willReturnCallback(static function (string $key, ?string $default = null) {
            if ($key === 'show_mail_settings') {
                return '0';
            }

            return $default;
        });

        $request = $this->getMockBuilder(ServerRequestInterface::class)->disableOriginalConstructor()->getMock();
        $request->method('getQueryParams')->willReturn([
            'referrer' => ilPersonalSettingsGUI::class,
        ]);
        $wrapper = new WrapperFactory($request);

        $http = $this->getMockBuilder(GlobalHttpState::class)->getMock();
        $http->method('wrapper')->willReturn($wrapper);

        $options = new ilMailOptions(
            0,
            null,
            $this->createMock(\ILIAS\Data\Clock\ClockInterface::class),
            $settings,
            $this->createMock(ilDBInterface::class)
        );

        $gui = $this->getMailOptionsGUI($http, $ctrl, $options);
        $gui->setForm($form);
        $gui->executeCommand();
    }
}