CleanerFieldProviderTest.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Recycler\Tests\Unit\Task;

/*
 * 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\Messaging\FlashMessage;
use TYPO3\CMS\Lang\LanguageService;
use TYPO3\CMS\Recycler\Task\CleanerFieldProvider;
use TYPO3\CMS\Recycler\Task\CleanerTask;
use TYPO3\CMS\Scheduler\Controller\SchedulerModuleController;

class CleanerFieldProviderTest extends \TYPO3\TestingFramework\Core\Unit\UnitTestCase
{
    protected $subject = null;

    protected function setUp()
    {
        $languageServiceMock = $this->getMockBuilder(LanguageService::class)
            ->setMethods(['sL'])
            ->disableOriginalConstructor()
            ->getMock();
        $languageServiceMock->expects($this->any())->method('sL')->will($this->returnValue('titleTest'));
        $this->subject = $this->getMockBuilder(CleanerFieldProvider::class)
            ->setMethods(['getLanguageService'])
            ->getMock();
        $this->subject->expects($this->any())->method('getLanguageService')->willReturn($languageServiceMock);
    }

    protected function getScheduleModuleControllerMock($mockedMethods = [])
    {
        $languageServiceMock = $this->getMockBuilder(LanguageService::class)
            ->setMethods(['sL'])
            ->disableOriginalConstructor()
            ->getMock();
        $languageServiceMock->expects($this->any())->method('sL')->will($this->returnValue('titleTest'));

        $mockedMethods = array_merge(['getLanguageService'], $mockedMethods);
        $scheduleModuleMock = $this->getMockBuilder(SchedulerModuleController::class)
            ->setMethods($mockedMethods)
            ->disableOriginalConstructor()
            ->getMock();
        $scheduleModuleMock->expects($this->any())->method('getLanguageService')->willReturn($languageServiceMock);

        return $scheduleModuleMock;
    }

    public function validateAdditionalFieldsLogsPeriodErrorDataProvider()
    {
        return [
            ['abc'],
            [$this->getMockBuilder(CleanerTask::class)->disableOriginalConstructor()->getMock()],
            [null],
            [''],
            [0],
            ['1234abc']
        ];
    }

    public function validateAdditionalFieldsLogsPeriodError($period)
    {
        $submittedData = [
            'RecyclerCleanerPeriod' => $period,
            'RecyclerCleanerTCA' => ['pages']
        ];

        $scheduleModuleControllerMock = $this->getScheduleModuleControllerMock(['addMessage']);
        $scheduleModuleControllerMock->expects($this->atLeastOnce())
            ->method('addMessage')
            ->with($this->equalTo('titleTest'), FlashMessage::ERROR);

        $this->subject->validateAdditionalFields($submittedData, $scheduleModuleControllerMock);
    }

    public function validateAdditionalFieldsDataProvider()
    {
        return [
            ['abc'],
            [$this->getMockBuilder(CleanerTask::class)->disableOriginalConstructor()->getMock()],
            [null],
            [123]
        ];
    }

    public function validateAdditionalFieldsLogsTableError($table)
    {
        $submittedData = [
            'RecyclerCleanerPeriod' => 14,
            'RecyclerCleanerTCA' => $table
        ];

        $this->subject->validateAdditionalFields($submittedData, $this->getScheduleModuleControllerMock(['addMessage']));
    }

    public function validateAdditionalFieldsIsTrueIfValid()
    {
        $submittedData = [
            'RecyclerCleanerPeriod' => 14,
            'RecyclerCleanerTCA' => ['pages']
        ];

        $scheduleModuleControllerMock = $this->getScheduleModuleControllerMock();
        $GLOBALS['TCA']['pages'] = ['foo' => 'bar'];
        $this->assertTrue($this->subject->validateAdditionalFields($submittedData, $scheduleModuleControllerMock));
    }

    public function saveAdditionalFieldsSavesFields()
    {
        $submittedData = [
            'RecyclerCleanerPeriod' => 14,
            'RecyclerCleanerTCA' => ['pages']
        ];

        $taskMock = $this->getMockBuilder(CleanerTask::class)->getMock();

        $taskMock->expects($this->once())
            ->method('setTcaTables')
            ->with($this->equalTo(['pages']));

        $taskMock->expects($this->once())
            ->method('setPeriod')
            ->with($this->equalTo(14));

        $this->subject->saveAdditionalFields($submittedData, $taskMock);
    }
}