9.5/_abstract_data_handler_action_test_case_8php_source.html

<?php

namespace ‪TYPO3\CMS\Core\Tests\Functional\DataHandling;


/*

 * 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\Context\Context;

use ‪TYPO3\CMS\Core\Context\WorkspaceAspect;

use ‪TYPO3\CMS\Core\Core\Bootstrap;

use ‪TYPO3\CMS\Core\Database\Connection;

use ‪TYPO3\CMS\Core\Utility\GeneralUtility;

use TYPO3\TestingFramework\Core\Functional\Framework\Constraint\RequestSection\DoesNotHaveRecordConstraint;

use TYPO3\TestingFramework\Core\Functional\Framework\Constraint\RequestSection\HasRecordConstraint;

use TYPO3\TestingFramework\Core\Functional\Framework\Constraint\RequestSection\StructureDoesNotHaveRecordConstraint;

use TYPO3\TestingFramework\Core\Functional\Framework\Constraint\RequestSection\StructureHasRecordConstraint;

use TYPO3\TestingFramework\Core\Functional\Framework\DataHandling\ActionService;

use TYPO3\TestingFramework\Core\Functional\FunctionalTestCase;


abstract class ‪AbstractDataHandlerActionTestCase extends FunctionalTestCase

{

    const ‪VALUE_BackendUserId = 1;


    protected ‪$scenarioDataSetDirectory;


    protected ‪$assertionDataSetDirectory;


    protected ‪$expectedErrorLogEntries = 0;


    protected ‪$testExtensionsToLoad = [

        'typo3/sysext/core/Tests/Functional/Fixtures/Extensions/irre_tutorial',

    ];


    protected ‪$pathsToLinkInTestInstance = [

        'typo3/sysext/core/Tests/Functional/Fixtures/Frontend/AdditionalConfiguration.php' => 'typo3conf/AdditionalConfiguration.php',

    ];


    protected ‪$recordIds = [];


    protected ‪$actionService;


    protected ‪$backendUser;


    protected function ‪setUp()

    {

        parent::setUp();


        $this->backendUser = $this->setUpBackendUserFromFixture(self::VALUE_BackendUserId);

        // By default make tests on live workspace

        $this->‪setWorkspaceId(0);


        $this->actionService = $this->‪getActionService();

        ‪Bootstrap::initializeLanguageObject();

    }


    protected function ‪tearDown()

    {

        $this->‪assertErrorLogEntries();

        unset($this->actionService);

        unset($this->recordIds);

        parent::tearDown();

    }


    protected function ‪setWorkspaceId(int $workspaceId)

    {

        $this->backendUser->workspace = $workspaceId;

        GeneralUtility::makeInstance(Context::class)->setAspect('workspace', new ‪WorkspaceAspect($workspaceId));

    }


    protected function ‪getActionService()

    {

        return GeneralUtility::makeInstance(

            ActionService::class

        );

    }


    protected function ‪importScenarioDataSet($dataSetName)

    {

        $fileName = rtrim($this->scenarioDataSetDirectory, '/') . '/' . $dataSetName . '.csv';

        $fileName = GeneralUtility::getFileAbsFileName($fileName);

        $this->importCSVDataSet($fileName);

    }


    protected function ‪assertAssertionDataSet($dataSetName)

    {

        $fileName = rtrim($this->assertionDataSetDirectory, '/') . '/' . $dataSetName . '.csv';

        $fileName = GeneralUtility::getFileAbsFileName($fileName);

        $this->assertCSVDataSet($fileName);

    }


    protected function ‪assertErrorLogEntries()

    {

        if ($this->expectedErrorLogEntries === null) {

            return;

        }


        $queryBuilder = $this->getConnectionPool()

            ->getQueryBuilderForTable('sys_log');

        $queryBuilder->getRestrictions()->removeAll();

        $statement = $queryBuilder

            ->select('*')

            ->from('sys_log')

            ->where(

                $queryBuilder->expr()->in(

                    'error',

                    $queryBuilder->createNamedParameter([1, 2], Connection::PARAM_INT_ARRAY)

                )

            )

            ->execute();


        $actualErrorLogEntries = (int)$queryBuilder

            ->count('uid')

            ->execute()

            ->fetchColumn(0);

        if ($actualErrorLogEntries === (int)‪$this->expectedErrorLogEntries) {

            $this->assertSame($this->expectedErrorLogEntries, $actualErrorLogEntries);

        } else {

            $failureMessage = 'Expected ' . $this->expectedErrorLogEntries . ' entries in sys_log, but got ' . $actualErrorLogEntries . LF;

            while ($entry = $statement->fetch()) {

                $entryData = unserialize($entry['log_data']);

                $entryMessage = vsprintf($entry['details'], $entryData);

                $failureMessage .= '* ' . $entryMessage . LF;

            }

            $this->fail($failureMessage);

        }

    }


    protected function ‪getRequestSectionHasRecordConstraint()

    {

        return new HasRecordConstraint();

    }


    protected function ‪getRequestSectionDoesNotHaveRecordConstraint()

    {

        return new DoesNotHaveRecordConstraint();

    }


    protected function ‪getRequestSectionStructureHasRecordConstraint()

    {

        return new StructureHasRecordConstraint();

    }


    protected function ‪getRequestSectionStructureDoesNotHaveRecordConstraint()

    {

        return new StructureDoesNotHaveRecordConstraint();

    }

}