AbstractNodeTest.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\Install\Tests\Unit\FolderStructure;
 
use PHPUnit\Framework\Attributes\Test;
use ‪TYPO3\CMS\Core\Core\Environment;
use ‪TYPO3\CMS\Core\Type\ContextualFeedbackSeverity;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Core\Utility\StringUtility;
use ‪TYPO3\CMS\Install\FolderStructure\AbstractNode;
use ‪TYPO3\CMS\Install\FolderStructure\Exception;
use ‪TYPO3\CMS\Install\FolderStructure\Exception\InvalidArgumentException;
use ‪TYPO3\CMS\Install\FolderStructure\NodeInterface;
use ‪TYPO3\CMS\Install\FolderStructure\RootNodeInterface;
 
final class ‪AbstractNodeTest extends ‪AbstractFolderStructureTestCase
{
    #[Test]
    public function ‪getNameReturnsSetName(): void
    {
        $node = $this->getAccessibleMock(AbstractNode::class, null, [], '', false);
        $name = ‪StringUtility::getUniqueId('name_');
        $node->_set('name', $name);
        self::assertSame($name, $node->getName());
    }
 
    #[Test]
    public function ‪getTargetPermissionReturnsSetTargetPermission(): void
    {
        $node = $this->getAccessibleMock(AbstractNode::class, null, [], '', false);
        $permission = '1234';
        $node->_set('targetPermission', $permission);
        self::assertSame($permission, $node->_call('getTargetPermission'));
    }
 
    #[Test]
    public function ‪getChildrenReturnsSetChildren(): void
    {
        $node = $this->getAccessibleMock(AbstractNode::class, null, [], '', false);
        $children = ['1234'];
        $node->_set('children', $children);
        self::assertSame($children, $node->_call('getChildren'));
    }
 
    #[Test]
    public function ‪getParentReturnsSetParent(): void
    {
        $node = $this->getAccessibleMock(AbstractNode::class, null, [], '', false);
        $parent = $this->createMock(RootNodeInterface::class);
        $node->_set('parent', $parent);
        self::assertSame($parent, $node->_call('getParent'));
    }
 
    #[Test]
    public function ‪getAbsolutePathCallsParentForPathAndAppendsOwnName(): void
    {
        $node = $this->getAccessibleMock(AbstractNode::class, null, [], '', false);
        $parent = $this->createMock(RootNodeInterface::class);
        $parentPath = '/foo/bar';
        $parent->expects(self::once())->method('getAbsolutePath')->willReturn($parentPath);
        $name = ‪StringUtility::getUniqueId('test_');
        $node->_set('parent', $parent);
        $node->_set('name', $name);
        self::assertSame($parentPath . '/' . $name, $node->getAbsolutePath());
    }
 
    #[Test]
    public function ‪isWritableCallsParentIsWritable(): void
    {
        $node = $this->getAccessibleMock(AbstractNode::class, null, [], '', false);
        $parentMock = $this->createMock(NodeInterface::class);
        $parentMock->expects(self::once())->method('isWritable');
        $node->_set('parent', $parentMock);
        $node->isWritable();
    }
 
    #[Test]
    public function ‪isWritableReturnsWritableStatusOfParent(): void
    {
        $node = $this->getAccessibleMock(AbstractNode::class, null, [], '', false);
        $parentMock = $this->createMock(NodeInterface::class);
        $parentMock->expects(self::once())->method('isWritable')->willReturn(true);
        $node->_set('parent', $parentMock);
        self::assertTrue($node->isWritable());
    }
 
    #[Test]
    public function ‪existsReturnsTrueIfNodeExists(): void
    {
        $node = $this->getAccessibleMock(AbstractNode::class, ['getAbsolutePath'], [], '', false);
        $path = $this->‪getTestDirectory('dir_');
        $node->method('getAbsolutePath')->willReturn($path);
        self::assertTrue($node->_call('exists'));
    }
 
    #[Test]
    public function ‪existsReturnsTrueIfIsLinkAndTargetIsDead(): void
    {
        $node = $this->getAccessibleMock(AbstractNode::class, ['getAbsolutePath'], [], '', false);
        $testRoot = ‪Environment::getVarPath() . '/tests/';
        $this->testFilesToDelete[] = $testRoot;
        ‪GeneralUtility::mkdir_deep($testRoot);
        $path = $testRoot . ‪StringUtility::getUniqueId('link_');
        $target = $testRoot . ‪StringUtility::getUniqueId('notExists_');
        touch($target);
        symlink($target, $path);
        unlink($target);
        $node->method('getAbsolutePath')->willReturn($path);
        self::assertTrue($node->_call('exists'));
    }
 
    #[Test]
    public function ‪existsReturnsFalseIfNodeNotExists(): void
    {
        $node = $this->getAccessibleMock(AbstractNode::class, ['getAbsolutePath'], [], '', false);
        $path = $this->‪getTestFilePath('dir_');
        $node->method('getAbsolutePath')->willReturn($path);
        self::assertFalse($node->_call('exists'));
    }
 
    #[Test]
    public function ‪fixPermissionThrowsExceptionIfPermissionAreAlreadyCorrect(): void
    {
        $node = $this->getAccessibleMock(
            AbstractNode::class,
            ['isPermissionCorrect', 'getAbsolutePath'],
            [],
            '',
            false
        );
        $this->expectException(Exception::class);
        $this->expectExceptionCode(1366744035);
        $node->method('getAbsolutePath')->willReturn('');
        $node->expects(self::once())->method('isPermissionCorrect')->willReturn(true);
        $node->_call('fixPermission');
    }
 
    #[Test]
    public function ‪fixPermissionReturnsOkStatusIfPermissionCanBeFixedAndSetsPermissionToCorrectValue(): void
    {
        $node = $this->getAccessibleMock(
            AbstractNode::class,
            ['isPermissionCorrect', 'getRelativePathBelowSiteRoot', 'getAbsolutePath'],
            [],
            '',
            false
        );
        $node->method('getRelativePathBelowSiteRoot')->willReturn('');
        $node->expects(self::once())->method('isPermissionCorrect')->willReturn(false);
        $path = $this->‪getTestDirectory();
        $subPath = $path . '/' . ‪StringUtility::getUniqueId('dir_');
        mkdir($subPath);
        chmod($path, 02770);
        $node->_set('targetPermission', '2770');
        $node->method('getAbsolutePath')->willReturn($subPath);
        self::assertEquals(ContextualFeedbackSeverity::OK, $node->_call('fixPermission')->getSeverity());
        $resultDirectoryPermissions = substr(decoct(fileperms($subPath)), 1);
        self::assertSame('2770', $resultDirectoryPermissions);
    }
 
    #[Test]
    public function ‪isPermissionCorrectReturnsTrueOnWindowsOs(): void
    {
        $node = $this->getAccessibleMock(AbstractNode::class, ['isWindowsOs'], [], '', false);
        $node->expects(self::once())->method('isWindowsOs')->willReturn(true);
        self::assertTrue($node->_call('isPermissionCorrect'));
    }
 
    #[Test]
    public function ‪isPermissionCorrectReturnsFalseIfTargetPermissionAndCurrentPermissionAreNotIdentical(): void
    {
        $node = $this->getAccessibleMock(AbstractNode::class, ['isWindowsOs', 'getCurrentPermission'], [], '', false);
        $node->method('isWindowsOs')->willReturn(false);
        $node->method('getCurrentPermission')->willReturn('foo');
        $node->_set('targetPermission', 'bar');
        self::assertFalse($node->_call('isPermissionCorrect'));
    }
 
    #[Test]
    public function ‪getCurrentPermissionReturnsCurrentDirectoryPermission(): void
    {
        $node = $this->getAccessibleMock(AbstractNode::class, ['getAbsolutePath'], [], '', false);
        $path = $this->‪getTestDirectory('dir_');
        chmod($path, 00444);
        clearstatcache();
        $node->method('getAbsolutePath')->willReturn($path);
        self::assertSame('0444', $node->_call('getCurrentPermission'));
    }
 
    #[Test]
    public function ‪getCurrentPermissionReturnsCurrentFilePermission(): void
    {
        $node = $this->getAccessibleMock(AbstractNode::class, ['getAbsolutePath'], [], '', false);
        $file = $this->‪getTestFilePath('file_');
        touch($file);
        chmod($file, 0770);
        clearstatcache();
        $node->method('getAbsolutePath')->willReturn($file);
        self::assertSame('0770', $node->_call('getCurrentPermission'));
    }
 
    #[Test]
    public function ‪getRelativePathBelowSiteRootThrowsExceptionIfGivenPathIsNotBelowPathSiteConstant(): void
    {
        $this->expectException(InvalidArgumentException::class);
        $this->expectExceptionCode(1366398198);
        $node = $this->getAccessibleMock(AbstractNode::class, null, [], '', false);
        $node->_call('getRelativePathBelowSiteRoot', '/tmp');
    }
 
    #[Test]
    public function ‪getRelativePathCallsGetAbsolutePathIfPathIsNull(): void
    {
        $node = $this->getAccessibleMock(
            AbstractNode::class,
            ['getAbsolutePath'],
            [],
            '',
            false
        );
        $node->expects(self::once())->method('getAbsolutePath')->willReturn(‪Environment::getPublicPath());
        $node->_call('getRelativePathBelowSiteRoot', null);
    }
 
    #[Test]
    public function ‪getRelativePathBelowSiteRootReturnsSingleForwardSlashIfGivenPathEqualsPathSiteConstant(): void
    {
        $node = $this->getAccessibleMock(AbstractNode::class, null, [], '', false);
        $result = $node->_call('getRelativePathBelowSiteRoot', ‪Environment::getPublicPath() . '/');
        self::assertSame('/', $result);
    }
 
    #[Test]
    public function ‪getRelativePathBelowSiteRootReturnsSubPath(): void
    {
        $node = $this->getAccessibleMock(AbstractNode::class, null, [], '', false);
        $result = $node->_call('getRelativePathBelowSiteRoot', ‪Environment::getPublicPath() . '/foo/bar');
        self::assertSame('/foo/bar', $result);
    }
}