salesagility_SuiteCRM/tests/unit/phpunit/lib/SuiteCRM/Search/AbstractIndexerTest.php

<?php

/** @noinspection PhpUnhandledExceptionInspection */

/**
 * 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 - 2021 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 Mockery as m;
use SuiteCRM\Search\Index\AbstractIndexer;
use SuiteCRM\Search\Index\Documentify\JsonSerializerDocumentifier;
use SuiteCRM\Search\Index\Documentify\SearchDefsDocumentifier;
use SuiteCRM\Tests\Unit\lib\SuiteCRM\Search\SearchTestAbstract;

/**
 * Class AbstractIndexerTest
 *
 * @see AbstractIndexer
 */
class AbstractIndexerTest extends SearchTestAbstract
{
    public function testConstruct(): void
    {
        $indexer = $this->getIndexerMock();
        self::assertInstanceOf(AbstractIndexer::class, $indexer);
    }

    public function testGettersAndSetters(): void
    {
        $differential = true;
        $doc = new SearchDefsDocumentifier();
        $modules = ['Module1', 'Module2'];

        $indexer = $this->getIndexerMock();

        $indexer->setDifferentialIndexing($differential);
        $indexer->setDocumentifier($doc);
        $indexer->setModulesToIndex($modules);

        self::assertEquals($differential, $indexer->isDifferentialIndexing());
        self::assertEquals($doc, $indexer->getDocumentifier());
        self::assertEquals($modules, $indexer->getModulesToIndex());

        $indexer = $this->getIndexerMock();

        $differential = false;
        $doc = new JsonSerializerDocumentifier();
        $modules = ['Foo', 'Bar'];

        $indexer->setDifferentialIndexing($differential);
        $indexer->setDocumentifier($doc);
        $indexer->setModulesToIndex($modules);

        self::assertEquals($differential, $indexer->isDifferentialIndexing());
        self::assertEquals($doc, $indexer->getDocumentifier());
        self::assertEquals($modules, $indexer->getModulesToIndex());

        try {
            $indexer->setModulesToIndex(null);
            self::fail('Null should not be accepted');
        } catch (Exception $throwable) {
            // All good!
        } catch (Throwable $throwable) {
            // All good!
        }
    }

    public function testAddModulesToIndex(): void
    {
        $indexer = $this->getIndexerMock();
        $indexer->addModulesToIndex('Foo');

        self::assertContains('Foo', $indexer->getModulesToIndex());

        $indexer->addModulesToIndex(['Fu', 'Bar']);

        self::assertContains('Fu', $indexer->getModulesToIndex());
        self::assertContains('Bar', $indexer->getModulesToIndex());

        try {
            $indexer->addModulesToIndex((object)["test"]);
            self::fail("Exception should have been thrown");
        } catch (InvalidArgumentException $ignore) {
            // All good!
        } catch (Exception $exception) {
            throw $exception;
        }
    }

    public function testGetDocumentifierName(): void
    {
        $indexer = $this->getIndexerMock();
        $doc1 = new JsonSerializerDocumentifier();
        $doc2 = new SearchDefsDocumentifier();
        $doc1Exp = 'JsonSerializerDocumentifier';
        $doc2Exp = 'SearchDefsDocumentifier';

        $indexer->setDocumentifier($doc1);
        self::assertEquals($doc1Exp, $indexer->getDocumentifierName());

        $indexer->setDocumentifier($doc2);
        self::assertEquals($doc2Exp, $indexer->getDocumentifierName());
    }

    public function testGetIndexerName(): void
    {
        $indexer = $this->getIndexerMock();

        $expected = $indexer->mockery_getName();
        $actual = $indexer->getIndexerName();

        self::assertEquals($expected, $actual, "Indexer name does not match");
    }

    public function testLogger(): void
    {
        $indexer = $this->getIndexerMock();

        $this->invokeMethod($indexer, 'setupLogger');

        self::assertInstanceOf(\Monolog\Logger::class, $indexer->getLogger());
    }

    /**
     * @return m\Mock|AbstractIndexer
     */
    private function getIndexerMock()
    {
        return m::mock(AbstractIndexer::class)->makePartial();
    }
}