salesagility_SuiteCRM/tests/unit/phpunit/includes/Imap/ImapHandlerFactoryTest.php

<?php
/**
 *
 * SugarCRM Community Edition is a customer relationship management program developed by
 * SugarCRM, Inc. Copyright (C) 2004-2013 SugarCRM Inc.
 *
 * SuiteCRM is an extension to SugarCRM Community Edition developed by SalesAgility Ltd.
 * Copyright (C) 2011 - 2018 SalesAgility Ltd.
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Affero General Public License version 3 as published by the
 * Free Software Foundation with the addition of the following permission added
 * to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED WORK
 * IN WHICH THE COPYRIGHT IS OWNED BY SUGARCRM, SUGARCRM DISCLAIMS THE WARRANTY
 * OF NON INFRINGEMENT OF THIRD PARTY RIGHTS.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more
 * details.
 *
 * You should have received a copy of the GNU Affero General Public License along with
 * this program; if not, see http://www.gnu.org/licenses or write to the Free
 * Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301 USA.
 *
 * You can contact SugarCRM, Inc. headquarters at 10050 North Wolfe Road,
 * SW2-130, Cupertino, CA 95014, USA. or at email address contact@sugarcrm.com.
 *
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU Affero General Public License version 3.
 *
 * In accordance with Section 7(b) of the GNU Affero General Public License version 3,
 * these Appropriate Legal Notices must retain the display of the "Powered by
 * SugarCRM" logo and "Supercharged by SuiteCRM" logo. If the display of the logos is not
 * reasonably feasible for technical reasons, the Appropriate Legal Notices must
 * display the words "Powered by SugarCRM" and "Supercharged by SuiteCRM".
 */

use SuiteCRM\Test\SuitePHPUnitFrameworkTestCase;

if (!defined('sugarEntry') || !sugarEntry) {
    die('Not A Valid Entry Point');
}

require_once __DIR__ . '/../../../../../include/Imap/ImapHandlerFactory.php';

/**
 * ImapHandlerFactoryTest
 *
 * @author gyula
 */
class ImapHandlerFactoryTest extends SuitePHPUnitFrameworkTestCase
{
    /**
     * FAIL: invalid key argument for save test settings key
     */
    public function testSaveTestSettingsKeyInvalidKey(): void
    {
        $factory = new ImapHandlerFactory();

        try {
            $factory->saveTestSettingsKey(null);
            self::assertTrue(false);
        } catch (InvalidArgumentException $e) {
            self::assertTrue(true);
        }

        try {
            $factory->saveTestSettingsKey(123);
            self::assertTrue(false);
        } catch (InvalidArgumentException $e) {
            self::assertTrue(true);
        }

        try {
            $factory->saveTestSettingsKey('');
            self::assertTrue(false);
        } catch (InvalidArgumentException $e) {
            self::assertTrue(true);
        }
    }

    /**
     * FAIL: when key not found in calls settings file
     */
    public function testSaveTestSettingsKeyKeyNotFound(): void
    {
        $factory = new ImapHandlerFactory();
        try {
            $factory->saveTestSettingsKey('foo');
            self::assertTrue(false);
        } catch (ImapHandlerException $e) {
            self::assertEquals(ImapHandlerException::ERR_KEY_NOT_FOUND, $e->getCode());
        }
    }

    /**
     * OK: should successfully saving a key
     */
    public function testSaveTestSettingsKeyOK(): void
    {
        $settingsFile = __DIR__ . '/../../../../../include/Imap' . ImapHandlerFactory::SETTINGS_KEY_FILE;
        $factory = new ImapHandlerFactory();
        $existsBefore = file_exists($settingsFile);
        self::assertFalse($existsBefore);
        $results = $factory->saveTestSettingsKey('testCaseExample');
        $existsAfter = file_exists($settingsFile);
        self::assertTrue($existsAfter);
        self::assertTrue($results);
        $factory->deleteTestSettings();
    }

    /**
     * OK: should retrieves an ImapHandler
     */
    public function testGetImapHandlerOk(): void
    {
        $factory = new ImapHandlerFactory();
        $results = $factory->getImapHandler();
        self::assertInstanceOf(ImapHandlerInterface::class, $results);
        $factory->deleteTestSettings();
    }
}