AbstractNodeTest.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Install\Tests\Unit\FolderStructure;

/*
 * 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!
 */

class AbstractNodeTest extends \TYPO3\CMS\Install\Tests\Unit\FolderStructureTestCase
{
    public function getNameReturnsSetName()
    {
        $node = $this->getAccessibleMock(\TYPO3\CMS\Install\FolderStructure\AbstractNode::class, ['dummy'], [], '', false);
        $name = $this->getUniqueId('name_');
        $node->_set('name', $name);
        $this->assertSame($name, $node->getName());
    }

    public function getTargetPermissionReturnsSetTargetPermission()
    {
        $node = $this->getAccessibleMock(\TYPO3\CMS\Install\FolderStructure\AbstractNode::class, ['dummy'], [], '', false);
        $permission = '1234';
        $node->_set('targetPermission', $permission);
        $this->assertSame($permission, $node->_call('getTargetPermission'));
    }

    public function getChildrenReturnsSetChildren()
    {
        $node = $this->getAccessibleMock(\TYPO3\CMS\Install\FolderStructure\AbstractNode::class, ['dummy'], [], '', false);
        $children = ['1234'];
        $node->_set('children', $children);
        $this->assertSame($children, $node->_call('getChildren'));
    }

    public function getParentReturnsSetParent()
    {
        $node = $this->getAccessibleMock(\TYPO3\CMS\Install\FolderStructure\AbstractNode::class, ['dummy'], [], '', false);
        $parent = $this->getMock(\TYPO3\CMS\Install\FolderStructure\RootNodeInterface::class, [], [], '', false);
        $node->_set('parent', $parent);
        $this->assertSame($parent, $node->_call('getParent'));
    }

    public function getAbsolutePathCallsParentForPathAndAppendsOwnName()
    {
        $node = $this->getAccessibleMock(\TYPO3\CMS\Install\FolderStructure\AbstractNode::class, ['dummy'], [], '', false);
        $parent = $this->getMock(\TYPO3\CMS\Install\FolderStructure\RootNodeInterface::class, [], [], '', false);
        $parentPath = '/foo/bar';
        $parent->expects($this->once())->method('getAbsolutePath')->will($this->returnValue($parentPath));
        $name = $this->getUniqueId('test_');
        $node->_set('parent', $parent);
        $node->_set('name', $name);
        $this->assertSame($parentPath . '/' . $name, $node->getAbsolutePath());
    }

    public function isWritableCallsParentIsWritable()
    {
        $node = $this->getAccessibleMock(\TYPO3\CMS\Install\FolderStructure\AbstractNode::class, ['dummy'], [], '', false);
        $parentMock = $this->getMock(\TYPO3\CMS\Install\FolderStructure\NodeInterface::class, [], [], '', false);
        $parentMock->expects($this->once())->method('isWritable');
        $node->_set('parent', $parentMock);
        $node->isWritable();
    }

    public function isWritableReturnsWritableStatusOfParent()
    {
        $node = $this->getAccessibleMock(\TYPO3\CMS\Install\FolderStructure\AbstractNode::class, ['dummy'], [], '', false);
        $parentMock = $this->getMock(\TYPO3\CMS\Install\FolderStructure\NodeInterface::class, [], [], '', false);
        $parentMock->expects($this->once())->method('isWritable')->will($this->returnValue(true));
        $node->_set('parent', $parentMock);
        $this->assertTrue($node->isWritable());
    }

    public function existsReturnsTrueIfNodeExists()
    {
        $node = $this->getAccessibleMock(\TYPO3\CMS\Install\FolderStructure\AbstractNode::class, ['getAbsolutePath'], [], '', false);
        $path = $this->getVirtualTestDir('dir_');
        $node->expects($this->any())->method('getAbsolutePath')->will($this->returnValue($path));
        $this->assertTrue($node->_call('exists'));
    }

    public function existsReturnsTrueIfIsLinkAndTargetIsDead()
    {
        if (TYPO3_OS === 'WIN') {
            $this->markTestSkipped('Test not available on Windows OS.');
        }
        $node = $this->getAccessibleMock(\TYPO3\CMS\Install\FolderStructure\AbstractNode::class, ['getAbsolutePath'], [], '', false);
        $path = PATH_site . 'typo3temp/' . $this->getUniqueId('link_');
        $target = PATH_site . 'typo3temp/' . $this->getUniqueId('notExists_');
        symlink($target, $path);
        $this->testFilesToDelete[] = $path;
        $node->expects($this->any())->method('getAbsolutePath')->will($this->returnValue($path));
        $this->assertTrue($node->_call('exists'));
    }

    public function existsReturnsFalseIfNodeNotExists()
    {
        $node = $this->getAccessibleMock(\TYPO3\CMS\Install\FolderStructure\AbstractNode::class, ['getAbsolutePath'], [], '', false);
        $path = $this->getVirtualTestFilePath('dir_');
        $node->expects($this->any())->method('getAbsolutePath')->will($this->returnValue($path));
        $this->assertFalse($node->_call('exists'));
    }

    public function fixPermissionThrowsExceptionIfPermissionAreAlreadyCorrect()
    {
        $node = $this->getAccessibleMock(
            \TYPO3\CMS\Install\FolderStructure\AbstractNode::class,
            ['isPermissionCorrect', 'getAbsolutePath'],
            [],
            '',
            false
        );
        $node->expects($this->any())->method('getAbsolutePath')->will($this->returnValue(''));
        $node->expects($this->once())->method('isPermissionCorrect')->will($this->returnValue(true));
        $node->_call('fixPermission');
    }

    public function fixPermissionReturnsNoticeStatusIfPermissionCanNotBeChanged()
    {
        if (TYPO3_OS === 'WIN') {
            $this->markTestSkipped('Test not available on Windows OS.');
        }
        if (function_exists('posix_getegid') && posix_getegid() === 0) {
            $this->markTestSkipped('Test skipped if run on linux as root');
        }
        $node = $this->getAccessibleMock(
            \TYPO3\CMS\Install\FolderStructure\AbstractNode::class,
            ['isPermissionCorrect', 'getRelativePathBelowSiteRoot', 'getAbsolutePath'],
            [],
            '',
            false
        );
        $node->expects($this->any())->method('getRelativePathBelowSiteRoot')->will($this->returnValue(''));
        $node->expects($this->once())->method('isPermissionCorrect')->will($this->returnValue(false));
        $path = $this->getVirtualTestDir('root_');
        $subPath = $path . '/' . $this->getUniqueId('dir_');
        mkdir($subPath);
        chmod($path, 02000);
        $node->expects($this->any())->method('getAbsolutePath')->will($this->returnValue($subPath));
        $node->_set('targetPermission', '2770');
        $this->assertInstanceOf(\TYPO3\CMS\Install\Status\NoticeStatus::class, $node->_call('fixPermission'));
        chmod($path, 02770);
    }

    public function fixPermissionReturnsNoticeStatusIfPermissionsCanNotBeChanged()
    {
        if (TYPO3_OS === 'WIN') {
            $this->markTestSkipped('Test not available on Windows OS.');
        }
        if (function_exists('posix_getegid') && posix_getegid() === 0) {
            $this->markTestSkipped('Test skipped if run on linux as root');
        }
        $node = $this->getAccessibleMock(
            \TYPO3\CMS\Install\FolderStructure\AbstractNode::class,
            ['isPermissionCorrect', 'getRelativePathBelowSiteRoot', 'getAbsolutePath'],
            [],
            '',
            false
        );
        $node->expects($this->any())->method('getRelativePathBelowSiteRoot')->will($this->returnValue(''));
        $node->expects($this->once())->method('isPermissionCorrect')->will($this->returnValue(false));
        $path = $this->getVirtualTestDir('root_');
        $subPath = $path . '/' . $this->getUniqueId('dir_');
        mkdir($subPath);
        chmod($path, 02000);
        $node->expects($this->any())->method('getAbsolutePath')->will($this->returnValue($subPath));
        $node->_set('targetPermission', '2770');
        $this->assertInstanceOf(\TYPO3\CMS\Install\Status\NoticeStatus::class, $node->_call('fixPermission'));
        chmod($path, 02770);
    }

    public function fixPermissionReturnsOkStatusIfPermissionCanBeFixedAndSetsPermissionToCorrectValue()
    {
        if (TYPO3_OS === 'WIN') {
            $this->markTestSkipped('Test not available on Windows OS.');
        }
        $node = $this->getAccessibleMock(
            \TYPO3\CMS\Install\FolderStructure\AbstractNode::class,
            ['isPermissionCorrect', 'getRelativePathBelowSiteRoot', 'getAbsolutePath'],
            [],
            '',
            false
        );
        $node->expects($this->any())->method('getRelativePathBelowSiteRoot')->will($this->returnValue(''));
        $node->expects($this->once())->method('isPermissionCorrect')->will($this->returnValue(false));
        $path = $this->getVirtualTestDir('root_');
        $subPath = $path . '/' . $this->getUniqueId('dir_');
        mkdir($subPath);
        chmod($path, 02770);
        $node->_set('targetPermission', '2770');
        $node->expects($this->any())->method('getAbsolutePath')->will($this->returnValue($subPath));
        $this->assertInstanceOf(\TYPO3\CMS\Install\Status\OkStatus::class, $node->_call('fixPermission'));
        $resultDirectoryPermissions = substr(decoct(fileperms($subPath)), 1);
        $this->assertSame('2770', $resultDirectoryPermissions);
    }

    public function isPermissionCorrectReturnsTrueOnWindowsOs()
    {
        $node = $this->getAccessibleMock(\TYPO3\CMS\Install\FolderStructure\AbstractNode::class, ['isWindowsOs'], [], '', false);
        $node->expects($this->once())->method('isWindowsOs')->will($this->returnValue(true));
        $this->assertTrue($node->_call('isPermissionCorrect'));
    }

    public function isPermissionCorrectReturnsFalseIfTargetPermissionAndCurrentPermissionAreNotIdentical()
    {
        $node = $this->getAccessibleMock(\TYPO3\CMS\Install\FolderStructure\AbstractNode::class, ['isWindowsOs', 'getCurrentPermission'], [], '', false);
        $node->expects($this->any())->method('isWindowsOs')->will($this->returnValue(false));
        $node->expects($this->any())->method('getCurrentPermission')->will($this->returnValue('foo'));
        $node->_set('targetPermission', 'bar');
        $this->assertFalse($node->_call('isPermissionCorrect'));
    }

    public function getCurrentPermissionReturnsCurrentDirectoryPermission()
    {
        if (TYPO3_OS === 'WIN') {
            $this->markTestSkipped('Test not available on Windows OS.');
        }
        $node = $this->getAccessibleMock(\TYPO3\CMS\Install\FolderStructure\AbstractNode::class, ['getAbsolutePath'], [], '', false);
        $path = $this->getVirtualTestDir('dir_');
        chmod($path, 02775);
        clearstatcache();
        $node->expects($this->any())->method('getAbsolutePath')->will($this->returnValue($path));
        $this->assertSame('2775', $node->_call('getCurrentPermission'));
    }

    public function getCurrentPermissionReturnsCurrentFilePermission()
    {
        if (TYPO3_OS === 'WIN') {
            $this->markTestSkipped('Test not available on Windows OS.');
        }
        $node = $this->getAccessibleMock(\TYPO3\CMS\Install\FolderStructure\AbstractNode::class, ['getAbsolutePath'], [], '', false);
        $file = $this->getVirtualTestFilePath('file_');
        touch($file);
        chmod($file, 0770);
        clearstatcache();
        $node->expects($this->any())->method('getAbsolutePath')->will($this->returnValue($file));
        $this->assertSame('0770', $node->_call('getCurrentPermission'));
    }

    public function getRelativePathBelowSiteRootThrowsExceptionIfGivenPathIsNotBelowPathSiteConstant()
    {
        $node = $this->getAccessibleMock(\TYPO3\CMS\Install\FolderStructure\AbstractNode::class, ['dummy'], [], '', false);
        $node->_call('getRelativePathBelowSiteRoot', '/tmp');
    }

    public function getRelativePathCallsGetAbsolutePathIfPathIsNull()
    {
        $node = $this->getAccessibleMock(
            \TYPO3\CMS\Install\FolderStructure\AbstractNode::class,
            ['getAbsolutePath'],
            [],
            '',
            false
        );
        $node->expects($this->once())->method('getAbsolutePath')->will($this->returnValue(PATH_site));
        $node->_call('getRelativePathBelowSiteRoot', null);
    }

    public function getRelativePathBelowSiteRootReturnsSingleForwardSlashIfGivenPathEqualsPathSiteConstant()
    {
        $node = $this->getAccessibleMock(\TYPO3\CMS\Install\FolderStructure\AbstractNode::class, ['dummy'], [], '', false);
        $result = $node->_call('getRelativePathBelowSiteRoot', PATH_site);
        $this->assertSame('/', $result);
    }

    public function getRelativePathBelowSiteRootReturnsSubPath()
    {
        $node = $this->getAccessibleMock(\TYPO3\CMS\Install\FolderStructure\AbstractNode::class, ['dummy'], [], '', false);
        $result = $node->_call('getRelativePathBelowSiteRoot', PATH_site . 'foo/bar');
        $this->assertSame('/foo/bar', $result);
    }
}