AbstractDataHandlerActionTestCase.php

Go to the documentation of this file.

<?php
 
/*
 * 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!
 */
 
namespace ‪TYPO3\CMS\Core\Tests\Functional\DataHandling;
 
use Symfony\Component\Yaml\Yaml;
use ‪TYPO3\CMS\Core\Cache\CacheManager;
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\Database\ReferenceIndex;
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 ‪$assertCleanReferenceIndex = true;
 
    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 ‪$siteLanguageConfiguration = [
        1 => [
            'title' => 'Dansk',
            'enabled' => true,
            'languageId' => 1,
            'base' => '/dk/',
            'typo3Language' => 'dk',
            'locale' => 'da_DK.UTF-8',
            'iso-639-1' => 'da',
            'flag' => 'dk',
            'fallbackType' => 'fallback',
            'fallbacks' => '0'
        ],
        2 => [
            'title' => 'Deutsch',
            'enabled' => true,
            'languageId' => 2,
            'base' => '/de/',
            'typo3Language' => 'de',
            'locale' => 'de_DE.UTF-8',
            'iso-639-1' => 'de',
            'flag' => 'de',
            'fallbackType' => 'fallback',
            'fallbacks' => '1,0'
        ],
    ];
 
    protected function ‪setUp(): void
    {
        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(): void
    {
        $this->‪assertErrorLogEntries();
        if ($this->‪assertCleanReferenceIndex) {
            $this->‪assertCleanReferenceIndex();
        }
        unset($this->actionService);
        unset($this->recordIds);
        parent::tearDown();
    }
 
    protected function ‪setUpFrontendSite(int $pageId, array $additionalLanguages = [])
    {
        $languages = [
            0 => [
                'title' => 'English',
                'enabled' => true,
                'languageId' => 0,
                'base' => '/',
                'typo3Language' => 'default',
                'locale' => 'en_US.UTF-8',
                'iso-639-1' => 'en',
                'navigationTitle' => '',
                'hreflang' => '',
                'direction' => '',
                'flag' => 'us',
            ]
        ];
        $languages = array_merge($languages, $additionalLanguages);
        $configuration = [
            'rootPageId' => $pageId,
            'base' => '/',
            'languages' => $languages,
            'errorHandling' => [],
            'routes' => [],
        ];
        ‪GeneralUtility::mkdir_deep($this->instancePath . '/typo3conf/sites/testing/');
        $yamlFileContents = Yaml::dump($configuration, 99, 2);
        $fileName = $this->instancePath . '/typo3conf/sites/testing/config.yaml';
        ‪GeneralUtility::writeFile($fileName, $yamlFileContents);
        // Ensure that no other site configuration was cached before
        $cache = GeneralUtility::makeInstance(CacheManager::class)->getCache('core');
        if ($cache->has('sites-configuration')) {
            $cache->remove('sites-configuration');
        }
    }
 
    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(array $expectedMessages = null)
    {
        if ($this->expectedErrorLogEntries === null && $expectedMessages === null) {
            return;
        }
 
        if ($expectedMessages !== null) {
            ‪$expectedErrorLogEntries = count($expectedMessages);
        } else {
            ‪$expectedErrorLogEntries = (int)$this->expectedErrorLogEntries;
        }
 
        $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);
 
        $entryMessages = array_map(
            function (array $entry) {
                $entryData = unserialize($entry['log_data'], ['allowed_classes' => false]);
                return vsprintf($entry['details'], $entryData);
            },
            $statement->fetchAll()
        );
 
        if ($expectedMessages !== null) {
            self::assertEqualsCanonicalizing($expectedMessages, $entryMessages);
        } elseif ($actualErrorLogEntries === ‪$expectedErrorLogEntries) {
            self::assertSame(‪$expectedErrorLogEntries, $actualErrorLogEntries);
        } else {
            $failureMessage = sprintf(
                'Expected %d entries in sys_log, but got %d' . LF,
                $expectedMessages,
                $actualErrorLogEntries
            );
            $failureMessage .= '* ' . implode(LF . '* ', $entryMessages) . LF;
            self::fail($failureMessage);
        }
    }
 
    protected function ‪assertCleanReferenceIndex(): void
    {
        $referenceIndex = GeneralUtility::makeInstance(ReferenceIndex::class);
        $referenceIndexFixResult = $referenceIndex->updateIndex(true);
        if (count($referenceIndexFixResult['errors']) > 0) {
            self::fail('Reference index not clean. ' . LF . implode(LF, $referenceIndexFixResult['errors']));
        }
    }
 
    protected function ‪getRequestSectionHasRecordConstraint()
    {
        return new HasRecordConstraint();
    }
 
    protected function ‪getRequestSectionDoesNotHaveRecordConstraint()
    {
        return new DoesNotHaveRecordConstraint();
    }
 
    protected function ‪getRequestSectionStructureHasRecordConstraint()
    {
        return new StructureHasRecordConstraint();
    }
 
    protected function ‪getRequestSectionStructureDoesNotHaveRecordConstraint()
    {
        return new StructureDoesNotHaveRecordConstraint();
    }
}