BaseTestCase.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * 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\Unit\Resource;
 
use org\bovigo\vfs\vfsStream;
use ‪TYPO3\CMS\Core\Resource\File;
use ‪TYPO3\CMS\Core\Resource\Folder;
use ‪TYPO3\CMS\Core\Utility\ArrayUtility;
use ‪TYPO3\CMS\Core\Utility\StringUtility;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
abstract class ‪BaseTestCase extends UnitTestCase
{
    protected string ‪$basedir = 'basedir';
    protected ?string ‪$mountDir;
    protected array ‪$vfsContents = [];
 
    protected function ‪setUp(): void
    {
        parent::setUp();
        $this->mountDir = ‪StringUtility::getUniqueId('mount-');
        $this->basedir = ‪StringUtility::getUniqueId('base-');
        vfsStream::setup($this->basedir);
        // Add an entry for the mount directory to the VFS contents
        $this->vfsContents = [$this->mountDir => []];
    }
 
    protected function ‪getMountRootUrl(): string
    {
        return $this->‪getUrlInMount('');
    }
 
    protected function ‪mergeToVfsContents($contents): void
    {
        ‪ArrayUtility::mergeRecursiveWithOverrule($this->vfsContents, $contents);
    }
 
    protected function ‪initializeVfs(): void
    {
        vfsStream::create($this->vfsContents);
    }
 
    protected function ‪addToMount(array $dirStructure): void
    {
        $this->‪mergeToVfsContents([$this->mountDir => $dirStructure]);
    }
 
    protected function ‪getUrlInMount(string $path): string
    {
        return vfsStream::url($this->basedir . '/' . $this->mountDir . '/' . ltrim($path, '/'));
    }
 
    protected function ‪addToVfs(array $dirStructure): void
    {
        $this->‪mergeToVfsContents($dirStructure);
    }
 
    protected function ‪getUrl(string $path): string
    {
        return vfsStream::url($this->basedir . '/' . ltrim($path, '/'));
    }
 
    protected function ‪_createFileFolderMock(string $type, string $identifier, array $mockedMethods)
    {
        if (!in_array('getIdentifier', $mockedMethods, true)) {
            $mockedMethods[] = 'getIdentifier';
        }
        if (!in_array('getName', $mockedMethods, true)) {
            $mockedMethods[] = 'getName';
        }
 
        $mock = $this->getMockBuilder($type)
            ->onlyMethods($mockedMethods)
            ->disableOriginalConstructor()
            ->getMock();
 
        $mock->method('getIdentifier')->willReturn($identifier);
        $mock->method('getName')->willReturn(basename($identifier));
        return $mock;
    }
 
    protected function ‪getSimpleFileMock(string $identifier, array $mockedMethods = [])
    {
        return $this->‪_createFileFolderMock(File::class, $identifier, $mockedMethods);
    }
 
    protected function ‪getSimpleFolderMock(string $identifier, array $mockedMethods = [])
    {
        return $this->‪_createFileFolderMock(Folder::class, $identifier, $mockedMethods);
    }
 
    protected function ‪getFolderMock(string $identifier, array $mockedMethods = [], array $subfolders = [], array $files = [])
    {
        $folder = $this->‪_createFileFolderMock(Folder::class, $identifier, array_merge($mockedMethods, ['getFiles', 'getSubfolders']));
        $folder->method('getSubfolders')->willReturn($subfolders);
        $folder->method('getFiles')->willReturn($files);
        return $folder;
    }
}