IndexerReindexCommandTest.php

Go to the documentation of this file.

<?php
namespace Magento\Indexer\Test\Unit\Console\Command;

use Magento\Framework\Console\Cli;
use Magento\Framework\Exception\LocalizedException;
use Magento\Framework\Indexer\Config\DependencyInfoProvider;
use Magento\Framework\Indexer\IndexerInterface;
use Magento\Framework\Indexer\IndexerRegistry;
use Magento\Framework\Indexer\StateInterface;
use Magento\Framework\Phrase;
use Magento\Framework\TestFramework\Unit\Helper\ObjectManager as ObjectManagerHelper;
use Magento\Indexer\Console\Command\IndexerReindexCommand;
use Symfony\Component\Console\Tester\CommandTester;

class IndexerReindexCommandTest extends AbstractIndexerCommandCommonSetup
{
    private $command;

    protected $configMock;

    private $indexerRegistryMock;

    private $dependencyInfoProviderMock;

    private $objectManagerHelper;

    public function setUp()
    {
        $this->objectManagerHelper = new ObjectManagerHelper($this);
        $this->configMock = $this->createMock(\Magento\Indexer\Model\Config::class);
        $this->indexerRegistryMock = $this->getMockBuilder(IndexerRegistry::class)
            ->disableOriginalConstructor()
            ->getMock();
        $this->dependencyInfoProviderMock = $this->objectManagerHelper->getObject(
            DependencyInfoProvider::class,
            [
                'config' => $this->configMock,
            ]
        );
        parent::setUp();
    }

    protected function getObjectManagerReturnValueMap()
    {
        $result = parent::getObjectManagerReturnValueMap();
        $result[] = [\Magento\Framework\Indexer\ConfigInterface::class, $this->configMock];
        $result[] = [DependencyInfoProvider::class, $this->dependencyInfoProviderMock];
        return $result;
    }

    public function testGetOptions()
    {
        $this->stateMock->expects($this->never())->method('setAreaCode');
        $this->command = new IndexerReindexCommand($this->objectManagerFactory);
        $optionsList = $this->command->getInputList();
        $this->assertSame(1, sizeof($optionsList));
        $this->assertSame('index', $optionsList[0]->getName());
    }

    public function testExecuteAll()
    {
        $this->configMock->expects($this->once())->method('getIndexer')->will($this->returnValue([
            'title' => 'Title_indexerOne',
            'shared_index' => null
        ]));
        $this->configureAdminArea();
        $this->initIndexerCollectionByItems([
            $this->getIndexerMock(
                ['reindexAll', 'getStatus'],
                ['indexer_id' => 'id_indexerOne', 'title' => 'Title_indexerOne']
            )
        ]);
        $this->indexerFactory->expects($this->never())->method('create');
        $this->command = new IndexerReindexCommand($this->objectManagerFactory);
        $commandTester = new CommandTester($this->command);
        $commandTester->execute([]);
        $actualValue = $commandTester->getDisplay();
        $this->assertSame(Cli::RETURN_SUCCESS, $commandTester->getStatusCode());
        $this->assertStringStartsWith('Title_indexerOne index has been rebuilt successfully in', $actualValue);
    }

    public function testExecuteWithIndex(
        array $inputIndexers,
        array $indexers,
        array $states,
        array $reindexAllCallMatchers,
        array $executedIndexers,
        array $executedSharedIndexers
    ) {
        $this->addSeparateIndexersToConfigMock($indexers);
        $this->addAllIndexersToConfigMock($indexers);

        $indexerMocks = [];
        foreach ($indexers as $indexerData) {
            $indexer = $this->getIndexerMock(['getState', 'reindexAll', 'isInvalid'], $indexerData);
            $indexer->method('getState')
                ->willReturn(
                    $this->getStateMock(
                        ['loadByIndexer', 'setStatus', 'save'],
                        $states[$indexer->getId()] ?? []
                    )
                );
            $indexer->method('isInvalid')
                ->willReturn(StateInterface::STATUS_INVALID === ($states[$indexer->getId()]['status'] ?? ''));
            $indexer->expects($reindexAllCallMatchers[$indexer->getId()])
                ->method('reindexAll');
            $indexerMocks[] = $indexer;
        }
        $this->initIndexerCollectionByItems($indexerMocks);

        $emptyIndexer = $this->getIndexerMock(['load', 'getState']);
        $this->indexerRegistryMock
            ->expects($this->exactly(count($executedSharedIndexers)))
            ->method('get')
            ->withConsecutive(...$executedSharedIndexers)
            ->willReturn($emptyIndexer);
        $emptyIndexer->method('getState')
            ->willReturn($this->getStateMock(['setStatus', 'save']));

        $this->configureAdminArea();

        $this->command = new IndexerReindexCommand(
            $this->objectManagerFactory,
            $this->indexerRegistryMock
        );
        $commandTester = new CommandTester($this->command);
        $commandTester->execute(['index' => $inputIndexers]);
        $this->assertSame(Cli::RETURN_SUCCESS, $commandTester->getStatusCode());
        $pattern = '#^';
        $template = '{Title} index has been rebuilt successfully in \d{2}:\d{2}:\d{2}\W*';
        foreach ($executedIndexers as $indexerId) {
            $pattern .= str_replace(
                '{Title}',
                $indexers[$indexerId]['title'],
                $template
            );
        }
        $pattern .= '$#';
        $this->assertRegExp($pattern, $commandTester->getDisplay());
    }

    private function addSeparateIndexersToConfigMock(array $indexers)
    {
        $this->configMock
            ->method('getIndexer')
            ->willReturnMap(
                array_map(
                    function ($elem) {
                        return [$elem['indexer_id'], $elem];
                    },
                    $indexers
                )
            );
    }

    private function addAllIndexersToConfigMock(array $indexers)
    {
        $this->configMock
            ->method('getIndexers')
            ->willReturn($indexers);
    }

    private function getStateMock(array $methods = null, array $data = [])
    {
        $state = $this->getMockBuilder(StateInterface::class)
            ->setMethods($methods)
            ->disableOriginalConstructor()
            ->getMockForAbstractClass();
        $state->method('getStatus')
            ->willReturn($data['status'] ?? StateInterface::STATUS_INVALID);
        return $state;
    }

    public function executeWithIndexDataProvider()
    {
        return [
            'Without dependencies' => [
                'inputIndexers' => [
                    'indexer_1'
                ],
                'indexers' => [
                    'indexer_1' => [
                        'indexer_id' => 'indexer_1',
                        'title' => 'Title_indexer_1',
                        'shared_index' => null,
                        'dependencies' => [],
                    ],
                    'indexer_2' => [
                        'indexer_id' => 'indexer_2',
                        'title' => 'Title_indexer_2',
                        'shared_index' => 'with_indexer_3',
                        'dependencies' => [],
                    ],
                    'indexer_3' => [
                        'indexer_id' => 'indexer_3',
                        'title' => 'Title_indexer_3',
                        'shared_index' => 'with_indexer_3',
                        'dependencies' => [],
                    ],
                ],
                'indexer_states' => [
                    'indexer_2' => [
                        'status' => StateInterface::STATUS_VALID,
                    ],
                    'indexer_3' => [
                        'status' => StateInterface::STATUS_VALID,
                    ],
                ],
                'expected_reindex_all_calls' => [
                    'indexer_1' => $this->once(),
                    'indexer_2' => $this->never(),
                    'indexer_3' => $this->never(),
                ],
                'executed_indexers' => ['indexer_1'],
                'executed_shared_indexers' => [],
            ],
            'With dependencies and some indexers is invalid' => [
                'inputIndexers' => [
                    'indexer_1'
                ],
                'indexers' => [
                    'indexer_2' => [
                        'indexer_id' => 'indexer_2',
                        'title' => 'Title_indexer_2',
                        'shared_index' => 'with_indexer_3',
                        'dependencies' => [],
                    ],
                    'indexer_3' => [
                        'indexer_id' => 'indexer_3',
                        'title' => 'Title_indexer_3',
                        'shared_index' => 'with_indexer_3',
                        'dependencies' => [],
                    ],
                    'indexer_1' => [
                        'indexer_id' => 'indexer_1',
                        'title' => 'Title_indexer_1',
                        'shared_index' => null,
                        'dependencies' => ['indexer_2', 'indexer_3'],
                    ],
                    'indexer_4' => [
                        'indexer_id' => 'indexer_4',
                        'title' => 'Title_indexer_4',
                        'shared_index' => null,
                        'dependencies' => [],
                    ],
                    'indexer_5' => [
                        'indexer_id' => 'indexer_5',
                        'title' => 'Title_indexer_5',
                        'shared_index' => null,
                        'dependencies' => ['indexer_1'],
                    ],
                ],
                'indexer_states' => [
                    'indexer_2' => [
                        'status' => StateInterface::STATUS_VALID,
                    ],
                    'indexer_3' => [
                        'status' => StateInterface::STATUS_INVALID,
                    ],
                    'indexer_4' => [
                        'status' => StateInterface::STATUS_INVALID,
                    ],
                    'indexer_5' => [
                        'status' => StateInterface::STATUS_VALID,
                    ],
                ],
                'expected_reindex_all_calls' => [
                    'indexer_1' => $this->once(),
                    'indexer_2' => $this->never(),
                    'indexer_3' => $this->once(),
                    'indexer_4' => $this->never(),
                    'indexer_5' => $this->once(),
                ],
                'executed_indexers' => ['indexer_3', 'indexer_1', 'indexer_5'],
                'executed_shared_indexers' => [['indexer_2'],['indexer_3']],
            ],
            'With dependencies and multiple indexers in request' => [
                'inputIndexers' => [
                    'indexer_1', 'indexer_3'
                ],
                'indexers' => [
                    'indexer_2' => [
                        'indexer_id' => 'indexer_2',
                        'title' => 'Title_indexer_2',
                        'shared_index' => null,
                        'dependencies' => [],
                    ],
                    'indexer_1' => [
                        'indexer_id' => 'indexer_1',
                        'title' => 'Title_indexer_1',
                        'shared_index' => null,
                        'dependencies' => ['indexer_2'],
                    ],
                    'indexer_4' => [
                        'indexer_id' => 'indexer_4',
                        'title' => 'Title_indexer_4',
                        'shared_index' => null,
                        'dependencies' => [],
                    ],
                    'indexer_3' => [
                        'indexer_id' => 'indexer_3',
                        'title' => 'Title_indexer_3',
                        'shared_index' => null,
                        'dependencies' => ['indexer_4'],
                    ],
                    'indexer_5' => [
                        'indexer_id' => 'indexer_5',
                        'title' => 'Title_indexer_5',
                        'shared_index' => null,
                        'dependencies' => ['indexer_1'],
                    ],
                ],
                'indexer_states' => [
                    'indexer_2' => [
                        'status' => StateInterface::STATUS_VALID,
                    ],
                    'indexer_4' => [
                        'status' => StateInterface::STATUS_INVALID,
                    ],
                    'indexer_5' => [
                        'status' => StateInterface::STATUS_VALID,
                    ],
                ],
                'expected_reindex_all_calls' => [
                    'indexer_1' => $this->once(),
                    'indexer_2' => $this->never(),
                    'indexer_3' => $this->once(),
                    'indexer_4' => $this->once(),
                    'indexer_5' => $this->once(),
                ],
                'executed_indexers' => ['indexer_1', 'indexer_4', 'indexer_3', 'indexer_5'],
                'executed_shared_indexers' => [],
            ],
        ];
    }

    public function testExecuteWithLocalizedException()
    {
        $this->configureAdminArea();
        $indexerOne = $this->getIndexerMock(['reindexAll', 'getStatus'], ['indexer_id' => 'indexer_1']);
        $localizedException = new LocalizedException(new Phrase('Some Exception Message'));
        $indexerOne->expects($this->once())->method('reindexAll')->will($this->throwException($localizedException));
        $this->initIndexerCollectionByItems([$indexerOne]);
        $this->command = new IndexerReindexCommand($this->objectManagerFactory);
        $commandTester = new CommandTester($this->command);
        $commandTester->execute(['index' => ['indexer_1']]);
        $actualValue = $commandTester->getDisplay();
        $this->assertSame(Cli::RETURN_FAILURE, $commandTester->getStatusCode());
        $this->assertStringStartsWith('Some Exception Message', $actualValue);
    }

    public function testExecuteWithException()
    {
        $this->configureAdminArea();
        $indexerOne = $this->getIndexerMock(
            ['reindexAll', 'getStatus'],
            ['indexer_id' => 'indexer_1', 'title' => 'Title_indexer_1']
        );
        $indexerOne->expects($this->once())
            ->method('reindexAll')
            ->willThrowException(new \Exception());
        $this->initIndexerCollectionByItems([$indexerOne]);
        $this->command = new IndexerReindexCommand($this->objectManagerFactory);
        $commandTester = new CommandTester($this->command);
        $commandTester->execute(['index' => ['indexer_1']]);
        $actualValue = $commandTester->getDisplay();
        $this->assertSame(Cli::RETURN_FAILURE, $commandTester->getStatusCode());
        $this->assertStringStartsWith('Title_indexer_1' . ' indexer process unknown error:', $actualValue);
    }

    public function testExecuteWithExceptionInGetIndexers()
    {
        $this->configureAdminArea();
        $inputIndexers = ['indexer_2'];
        $indexerData = [
            'indexer_id' => 'indexer_1',
            'shared_index' => 'new',
        ];
        $indexerOne = $this->getIndexerMock(
            ['reindexAll', 'getStatus', 'load'],
            $indexerData
        );
        $this->initIndexerCollectionByItems([$indexerOne]);

        $indexerOne->expects($this->never())->method('getTitle');
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionMessage(
            "The following requested index types are not supported: '"
            . join("', '", $inputIndexers)
            . "'." . PHP_EOL . 'Supported types: '
            . join(", ", array_map(
                function ($item) {
                    $item->getId();
                },
                $this->indexerCollectionMock->getItems()
            ))
        );
        $this->command = new IndexerReindexCommand($this->objectManagerFactory);
        $commandTester = new CommandTester($this->command);
        $commandTester->execute(['index' => $inputIndexers]);
        $this->assertSame(Cli::RETURN_FAILURE, $commandTester->getStatusCode());
    }
}