FieldProviderTest.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Extbase\Tests\Unit\Scheduler;

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

use TYPO3\CMS\Core\Tests\UnitTestCase;
use TYPO3\CMS\Extbase\Mvc\Cli\Command;
use TYPO3\CMS\Extbase\Mvc\Cli\CommandManager;
use TYPO3\CMS\Extbase\Scheduler\FieldProvider;
use TYPO3\CMS\Extbase\Scheduler\Task;
use TYPO3\CMS\Extbase\Tests\Fixture\DummyController;
use TYPO3\CMS\Extbase\Tests\MockACommandController;
use TYPO3\CMS\Scheduler\Controller\SchedulerModuleController;

class FieldProviderTest extends UnitTestCase
{
    public function getCommandControllerActionFieldFetchesCorrectClassNames()
    {

        $command1 = $this->getAccessibleMock(Command::class, [], [], '', false);
        $command1->expects($this->once())->method('isInternal')->will($this->returnValue(false));
        $command1->expects($this->once())->method('isCliOnly')->will($this->returnValue(false));
        $command1->expects($this->once())->method('getControllerClassName')->will($this->returnValue(MockACommandController::class));
        $command1->expects($this->once())->method('getControllerCommandName')->will($this->returnValue('FuncA'));
        $command1->expects($this->once())->method('getCommandIdentifier')->will($this->returnValue('extbase:mocka:funca'));

        $command2 = $this->getAccessibleMock(Command::class, [], [], '', false);
        $command2->expects($this->once())->method('isInternal')->will($this->returnValue(false));
        $command2->expects($this->once())->method('isCliOnly')->will($this->returnValue(false));
        $command2->expects($this->once())->method('getControllerClassName')->will($this->returnValue('Acme\\Mypkg\\Command\\MockBCommandController'));
        $command2->expects($this->once())->method('getControllerCommandName')->will($this->returnValue('FuncB'));
        $command2->expects($this->once())->method('getCommandIdentifier')->will($this->returnValue('mypkg:mockb:funcb'));

        $command3 = $this->getAccessibleMock(Command::class, [], [], '', false);
        $command3->expects($this->once())->method('isInternal')->will($this->returnValue(false));
        $command3->expects($this->once())->method('isCliOnly')->will($this->returnValue(false));
        $command3->expects($this->once())->method('getControllerClassName')->will($this->returnValue('Tx_Extbase_Command_MockCCommandController'));
        $command3->expects($this->once())->method('getControllerCommandName')->will($this->returnValue('FuncC'));
        $command3->expects($this->once())->method('getCommandIdentifier')->will($this->returnValue('extbase:mockc:funcc'));

        $commandManager = $this->getMock(CommandManager::class, ['getAvailableCommands']);
        $commandManager->expects($this->any())->method('getAvailableCommands')->will($this->returnValue([$command1, $command2, $command3]));

        $fieldProvider = $this->getAccessibleMock(
            FieldProvider::class,
            ['getActionLabel'],
            [],
            '',
            false
        );
        $fieldProvider->_set('commandManager', $commandManager);
        $fieldProvider->expects($this->once())->method('getActionLabel')->will($this->returnValue('some label'));
        $actualResult = $fieldProvider->_call('getCommandControllerActionField', []);
        $this->assertContains('<option title="test" value="extbase:mocka:funca">Extbase MockA: FuncA</option>', $actualResult['code']);
        $this->assertContains('<option title="test" value="mypkg:mockb:funcb">Mypkg MockB: FuncB</option>', $actualResult['code']);
        $this->assertContains('<option title="test" value="extbase:mockc:funcc">Extbase MockC: FuncC</option>', $actualResult['code']);
    }

    public function getCommandControllerActionFieldSkipsInternalCommands()
    {
        $command = $this->getAccessibleMock(Command::class, [], [], '', false);
        $command->method('isInternal')->will($this->returnValue(true));
        $command->method('isCliOnly')->will($this->returnValue(false));
        $command->method('getControllerClassName')->will($this->returnValue(MockACommandController::class));
        $command->method('getControllerCommandName')->will($this->returnValue('FuncA'));
        $command->method('getCommandIdentifier')->will($this->returnValue('extbase:mocka:funca'));

        $commandManager = $this->getMock(CommandManager::class, ['getAvailableCommands']);
        $commandManager->expects($this->any())->method('getAvailableCommands')->will($this->returnValue([$command]));

        $fieldProvider = $this->getAccessibleMock(
            FieldProvider::class,
            ['getActionLabel'],
            [],
            '',
            false
        );
        $fieldProvider->_set('commandManager', $commandManager);
        $fieldProvider->expects($this->once())->method('getActionLabel')->will($this->returnValue('some label'));
        $actualResult = $fieldProvider->_call('getCommandControllerActionField', []);
        $this->assertNotContains('<option title="test" value="extbase:mocka:funca">Extbase MockA: FuncA</option>', $actualResult['code']);
    }

    public function getCommandControllerActionFieldSkipsCliOnlyCommands()
    {
        $command = $this->getAccessibleMock(Command::class, [], [], '', false);
        $command->method('isInternal')->will($this->returnValue(false));
        $command->method('isCliOnly')->will($this->returnValue(true));
        $command->method('getControllerClassName')->will($this->returnValue(MockACommandController::class));
        $command->method('getControllerCommandName')->will($this->returnValue('FuncA'));
        $command->method('getCommandIdentifier')->will($this->returnValue('extbase:mocka:funca'));

        $commandManager = $this->getMock(CommandManager::class, ['getAvailableCommands']);
        $commandManager->expects($this->any())->method('getAvailableCommands')->will($this->returnValue([$command]));

        $fieldProvider = $this->getAccessibleMock(
            FieldProvider::class,
            ['getActionLabel'],
            [],
            '',
            false
        );
        $fieldProvider->_set('commandManager', $commandManager);
        $fieldProvider->expects($this->once())->method('getActionLabel')->will($this->returnValue('some label'));
        $actualResult = $fieldProvider->_call('getCommandControllerActionField', []);
        $this->assertNotContains('<option title="test" value="extbase:mocka:funca">Extbase MockA: FuncA</option>', $actualResult['code']);
    }

    public function constructResolvesExtensionNameFromNamespaced()
    {
        $mockController = new DummyController();
        $expectedResult = 'Extbase';
        $actualResult = $mockController->getExtensionName();
        $this->assertSame($expectedResult, $actualResult);
    }

    public function validateAdditionalFieldsReturnsTrue()
    {
        $fieldProvider = $this->getAccessibleMock(
            FieldProvider::class,
            ['dummy'],
            [],
            '',
            false
        );
        $submittedData = [];
        $schedulerModule = $this->getMock(SchedulerModuleController::class, [], [], '', false);
        $this->assertTrue($fieldProvider->validateAdditionalFields($submittedData, $schedulerModule));
    }

    public function getAdditionalFieldsRendersRightHtml()
    {
        $this->markTestSkipped('Incomplete mocking in a complex scenario. This should be a functional test');

        $command1 = $this->getAccessibleMock(Command::class, [], [], '', false);
        $command1->expects($this->once())->method('isInternal')->will($this->returnValue(false));
        $command1->expects($this->once())->method('getControllerClassName')->will($this->returnValue(MockACommandController::class));
        $command1->expects($this->once())->method('getControllerCommandName')->will($this->returnValue('FuncA'));
        $command1->expects($this->any())->method('getCommandIdentifier')->will($this->returnValue('extbase:mocka:funca'));
        $command1->expects($this->once())->method('getArgumentDefinitions')->will($this->returnValue([]));

        $command2 = $this->getAccessibleMock(Command::class, [], [], '', false);
        $command2->expects($this->once())->method('isInternal')->will($this->returnValue(false));
        $command2->expects($this->once())->method('getControllerClassName')->will($this->returnValue('Acme\\Mypkg\\Command\\MockBCommandController'));
        $command2->expects($this->once())->method('getControllerCommandName')->will($this->returnValue('FuncB'));
        $command2->expects($this->any())->method('getCommandIdentifier')->will($this->returnValue('mypkg:mockb:funcb'));

        $command3 = $this->getAccessibleMock(Command::class, [], [], '', false);
        $command3->expects($this->once())->method('isInternal')->will($this->returnValue(false));
        $command3->expects($this->once())->method('getControllerClassName')->will($this->returnValue('Tx_Extbase_Command_MockCCommandController'));
        $command3->expects($this->once())->method('getControllerCommandName')->will($this->returnValue('FuncC'));
        $command3->expects($this->any())->method('getCommandIdentifier')->will($this->returnValue('extbase:mockc:funcc'));

        $commandManager = $this->getMock(CommandManager::class, ['getAvailableCommands']);
        $commandManager->expects($this->any())->method('getAvailableCommands')->will($this->returnValue([$command1, $command2, $command3]));

        $fieldProvider = $this->getAccessibleMock(
            FieldProvider::class,
            ['getActionLabel', 'getArgumentLabel', 'getCommandControllerActionArgumentFields'],
            [],
            '',
            false
        );
        $fieldProvider->_set('commandManager', $commandManager);
        $actionLabel = 'action label string';
        $argumentLabel = 'argument label string';
        $fieldProvider->expects($this->any())->method('getActionLabel')->will($this->returnValue($actionLabel));
        $fieldProvider->expects($this->any())->method('getArgumentLabel')->will($this->returnValue($argumentLabel));
        $argArray['arg'] = [
                'code' => '<input type="text" name="tx_scheduler[task_extbase][arguments][arg]" value="1" /> ',
                'label' => $argumentLabel
        ];
        $fieldProvider->expects($this->any())->method('getCommandControllerActionArgumentFields')->will($this->returnValue($argArray));
        $expectedAdditionalFields = [
            'action' => [
                'code' => '<select name="tx_scheduler[task_extbase][action]">' . LF
                    . '<option title="test" value="extbase:mocka:funca" selected="selected">Extbase MockA: FuncA</option>' . LF
                    . '<option title="test" value="mypkg:mockb:funcb">Mypkg MockB: FuncB</option>' . LF
                    . '<option title="test" value="extbase:mockc:funcc">Extbase MockC: FuncC</option>' . LF
                    . '</select>',
                'label' => $actionLabel
            ],
            'description' => [
                'code' => '',
                'label' => '<strong></strong>'
            ],
            'arg' => [
                'code' => '<input type="text" name="tx_scheduler[task_extbase][arguments][arg]" value="1" /> ',
                'label' => $argumentLabel
            ]
        ];

        $taskInfo = [];
        $task = new Task();
        $task->setCommandIdentifier($command1->getCommandIdentifier());
        $schedulerModule = $this->getMock(SchedulerModuleController::class, [], [], '', false);

        $this->assertEquals($expectedAdditionalFields, $fieldProvider->getAdditionalFields($taskInfo, $task, $schedulerModule));
    }
}