ilMailMimeTest.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\Refinery\Factory;

class ilMailMimeTest extends ilMailBaseTestCase
{
    private const USER_ID = 6;

    protected function setUp(): void
    {
        ilMimeMail::setDefaultTransport(null);
        ilMailMimeSenderUserById::addUserToCache(self::USER_ID, $this->getUserById(self::USER_ID));

        parent::setUp();
    }

    public function testMimMailDelegatesEmailDeliveryToThePassedTransporter(): void
    {
        $defaultTransport = $this->getMockBuilder(ilMailMimeTransport::class)->disableOriginalConstructor()->getMock();
        $defaultTransport->expects($this->never())->method('send');

        $transport = $this->getMockBuilder(ilMailMimeTransport::class)->getMock();
        $transport->expects($this->once())->method('send');

        $transportFactory = $this->getMockBuilder(ilMailMimeTransportFactory::class)->disableOriginalConstructor()->getMock();
        $transportFactory->method('getTransport')->willReturn($defaultTransport);
        $this->setGlobalVariable('mail.mime.transport.factory', $transportFactory);

        $refineryMock = $this->getMockBuilder(Factory::class)->disableOriginalConstructor()->getMock();
        $this->setGlobalVariable('refinery', $refineryMock);

        $settings = $this->getMockBuilder(ilSetting::class)->disableOriginalConstructor()->onlyMethods([
            'set',
            'get',
        ])->getMock();
        $this->setGlobalVariable('ilSetting', $settings);

        $mail = new ilMimeMail();
        $mail->Send($transport);
    }

    public function testMimMailDelegatesEmailDeliveryToDefaultTransport(): void
    {
        $defaultTransport = $this->getMockBuilder(ilMailMimeTransport::class)->getMock();
        $defaultTransport->expects($this->once())->method('send');

        $transportFactory = $this->getMockBuilder(ilMailMimeTransportFactory::class)->disableOriginalConstructor()->getMock();
        $transportFactory->method('getTransport')->willReturn($defaultTransport);
        $this->setGlobalVariable('mail.mime.transport.factory', $transportFactory);

        $refineryMock = $this->getMockBuilder(Factory::class)->disableOriginalConstructor()->getMock();
        $this->setGlobalVariable('refinery', $refineryMock);

        $settings = $this->getMockBuilder(ilSetting::class)->disableOriginalConstructor()->onlyMethods([
            'set',
            'get',
        ])->getMock();
        $this->setGlobalVariable('ilSetting', $settings);

        $mail = new ilMimeMail();
        $mail->Send();
    }

    public function testTransportFactoryWillReturnNullTransportIfExternalEmailDeliveryIsDisabled(): void
    {
        $settings = $this->getMockBuilder(ilSetting::class)->disableOriginalConstructor()->onlyMethods([
            'set',
            'get',
        ])->getMock();
        $settings->method('get')->willReturnCallback(static function ($key): ?string {
            return (string) ('mail_allow_external' !== $key);
        });
        $this->setGlobalVariable('ilSetting', $settings);

        $eventHandler = $this->getMockBuilder(ilAppEventHandler::class)->disableOriginalConstructor()->onlyMethods([
            'raise',
        ])->getMock();

        $factory = new ilMailMimeTransportFactory($settings, $eventHandler);
        $this->assertInstanceOf(ilMailMimeTransportNull::class, $factory->getTransport());
    }

    public function testTransportFactoryWillReturnSmtpTransportIfEnabled(): void
    {
        $settings = $this->getMockBuilder(ilSetting::class)->disableOriginalConstructor()->onlyMethods([
            'set',
            'get',
        ])->getMock();
        $settings->method('get')->willReturnCallback(static function ($key): ?string {
            return '1';
        });
        $this->setGlobalVariable('ilSetting', $settings);

        $eventHandler = $this->getMockBuilder(ilAppEventHandler::class)->disableOriginalConstructor()->onlyMethods([
            'raise',
        ])->getMock();

        $factory = new ilMailMimeTransportFactory($settings, $eventHandler);
        $this->assertInstanceOf(ilMailMimeTransportSmtp::class, $factory->getTransport());
    }

    public function testTransportFactoryWillReturnSendmailTransportIfSmtpTransportIsDisabled(): void
    {
        $settings = $this->getMockBuilder(ilSetting::class)->disableOriginalConstructor()->onlyMethods([
            'set',
            'get',
        ])->getMock();

        $settings->method('get')->willReturnCallback(static function ($key): ?string {
            if ('mail_allow_external' === $key) {
                return '1';
            }


            if ('mail_smtp_status' === $key) {
                return '0';
            }

            return '1';
        });
        $this->setGlobalVariable('ilSetting', $settings);

        $eventHandler = $this->getMockBuilder(ilAppEventHandler::class)->disableOriginalConstructor()->onlyMethods([
            'raise',
        ])->getMock();

        $factory = new ilMailMimeTransportFactory($settings, $eventHandler);
        $this->assertInstanceOf(ilMailMimeTransportSendmail::class, $factory->getTransport());
    }

    public function testFactoryWillReturnSystemSenderForAnonymousUserId(): void
    {
        $settings = $this->getMockBuilder(ilSetting::class)->disableOriginalConstructor()->onlyMethods([
            'set',
            'get',
        ])->getMock();
        $mustache_factory = $this->getMockBuilder(ilMustacheFactory::class)->getMock();

        $factory = new ilMailMimeSenderFactory($settings, $mustache_factory);
        $this->assertInstanceOf(ilMailMimeSenderSystem::class, $factory->getSenderByUsrId(ANONYMOUS_USER_ID));
    }

    public function testFactoryWillReturnSystemSenderWhenExplicitlyRequested(): void
    {
        $settings = $this->getMockBuilder(ilSetting::class)->disableOriginalConstructor()->onlyMethods([
            'set',
            'get',
        ])->getMock();
        $mustache_factory = $this->getMockBuilder(ilMustacheFactory::class)->getMock();

        $factory = new ilMailMimeSenderFactory($settings, $mustache_factory);
        $this->assertInstanceOf(ilMailMimeSenderSystem::class, $factory->system());
    }

    protected function getUserById(int $usrId): ilObjUser
    {
        $user = $this->getMockBuilder(ilObjUser::class)
            ->disableOriginalConstructor()
            ->onlyMethods(['getId'])
            ->getMock();
        $user->method('getId')->willReturn($usrId);

        return $user;
    }

    public function testFactoryWillReturnUserSenderForExistingUserId(): void
    {
        $settings = $this->getMockBuilder(ilSetting::class)->disableOriginalConstructor()->onlyMethods([
            'set',
            'get',
        ])->getMock();
        $mustache_factory = $this->getMockBuilder(ilMustacheFactory::class)->getMock();

        $factory = new ilMailMimeSenderFactory($settings, $mustache_factory);
        $this->assertInstanceOf(ilMailMimeSenderUser::class, $factory->getSenderByUsrId(self::USER_ID));
    }

    public function testFactoryWillReturnUserSenderWhenExplicitlyRequested(): void
    {
        $settings = $this->getMockBuilder(ilSetting::class)->disableOriginalConstructor()->onlyMethods([
            'set',
            'get',
        ])->getMock();
        $mustache_factory = $this->getMockBuilder(ilMustacheFactory::class)->getMock();

        $factory = new ilMailMimeSenderFactory($settings, $mustache_factory);
        $this->assertInstanceOf(ilMailMimeSenderUser::class, $factory->user(self::USER_ID));
    }
}