ilMailMimeTest.php

Go to the documentation of this file.

<?php declare(strict_types=1);

/* Copyright (c) 1998-2017 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilMailMimeTest extends ilMailBaseTest
{
    const USER_ID = 6;

    protected function setUp() : void
    {
        if (!defined('ANONYMOUS_USER_ID')) {
            define('ANONYMOUS_USER_ID', 13);
        }

        ilMimeMail::setDefaultTransport(null);
        ilMailMimeSenderUserById::addUserToCache(self::USER_ID, $this->getUserById(self::USER_ID));

        parent::setUp();
    }

    public function testMimMailDelegatesEmailDeliveryToThePassedTransporter() : void
    {
        $defaultTransport = $this->getMockBuilder(ilMailMimeTransport::class)->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->expects($this->any())->method('getTransport')->will($this->returnValue($defaultTransport));
        $this->setGlobalVariable('mail.mime.transport.factory', $transportFactory);

        $settings = $this->getMockBuilder('\ilSetting')->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->expects($this->any())->method('getTransport')->will($this->returnValue($defaultTransport));
        $this->setGlobalVariable('mail.mime.transport.factory', $transportFactory);

        $settings = $this->getMockBuilder('\ilSetting')->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->expects($this->any())->method('get')->will($this->returnCallback(function ($key) {
            if ('mail_allow_external' == $key) {
                return false;
            }

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

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

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

    public function testTransportFactoryWillReturnSmtpTransportIfEnabled() : void
    {
        $settings = $this->getMockBuilder(ilSetting::class)->disableOriginalConstructor()->onlyMethods([
            'set',
            'get'
        ])->getMock();
        $settings->expects($this->any())->method('get')->will($this->returnCallback(function ($key) {
            if ('mail_allow_external' == $key) {
                return true;
            }


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

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

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

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

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

        $settings->expects($this->any())->method('get')->will($this->returnCallback(function ($key) {
            if ('mail_allow_external' == $key) {
                return true;
            }


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

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

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

        $factory = new ilMailMimeTransportFactory($settings, $eventHandler);
        $this->assertInstanceOf('\ilMailMimeTransportSendMail', $factory->getTransport());
    }

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

        $factory = new ilMailMimeSenderFactory($settings);
        $this->assertInstanceOf('\ilMailMimeSenderSystem', $factory->getSenderByUsrId(ANONYMOUS_USER_ID));
    }

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

        $factory = new ilMailMimeSenderFactory($settings);
        $this->assertInstanceOf('\ilMailMimeSenderSystem', $factory->system());
    }

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

        return $user;
    }

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

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

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

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