LinkNodeTest.php

Go to the documentation of this file.

<?php
declare(strict_types = 1);
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!
 */
 
use ‪TYPO3\CMS\Core\Core\Environment;
use ‪TYPO3\CMS\Core\Messaging\FlashMessage;
use ‪TYPO3\CMS\Install\FolderStructure\Exception\InvalidArgumentException;
use ‪TYPO3\CMS\Install\FolderStructure\LinkNode;
use ‪TYPO3\CMS\Install\FolderStructure\NodeInterface;
use ‪TYPO3\CMS\Install\FolderStructure\RootNodeInterface;
use TYPO3\TestingFramework\Core\AccessibleObjectInterface;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
class ‪LinkNodeTest extends UnitTestCase
{
    public function ‪constructorThrowsExceptionIfParentIsNull()
    {
        $this->expectException(InvalidArgumentException::class);
        $this->expectExceptionCode(1380485700);
        $node = $this->getAccessibleMock(LinkNode::class, ['dummy'], [], '', false);
        $node->__construct([], null);
    }
 
    public function ‪constructorThrowsExceptionIfNameContainsForwardSlash()
    {
        $this->expectException(InvalidArgumentException::class);
        $this->expectExceptionCode(1380546061);
        $parent = $this->createMock(NodeInterface::class);
        $node = $this->getAccessibleMock(LinkNode::class, ['dummy'], [], '', false);
        $structure = [
            'name' => 'foo/bar',
        ];
        $node->__construct($structure, $parent);
    }
 
    public function ‪constructorSetsParent()
    {
        $parent = $this->createMock(NodeInterface::class);
        $node = $this->getAccessibleMock(LinkNode::class, ['dummy'], [], '', false);
        $structure = [
            'name' => 'foo',
        ];
        $node->__construct($structure, $parent);
        $this->assertSame($parent, $node->_call('getParent'));
    }
 
    public function ‪constructorSetsName()
    {
        $node = $this->getAccessibleMock(LinkNode::class, ['dummy'], [], '', false);
        $parent = $this->createMock(RootNodeInterface::class);
        $name = $this->getUniqueId('test_');
        $node->__construct(['name' => $name], $parent);
        $this->assertSame($name, $node->getName());
    }
 
    public function ‪constructorSetsNameAndTarget()
    {
        $node = $this->getAccessibleMock(LinkNode::class, ['dummy'], [], '', false);
        $parent = $this->createMock(RootNodeInterface::class);
        $name = $this->getUniqueId('test_');
        $target = '../' . $this->getUniqueId('test_');
        $node->__construct(['name' => $name, 'target' => $target], $parent);
        $this->assertSame($target, $node->_call('getTarget'));
    }
 
    public function ‪getStatusReturnsArray()
    {
        $node = $this->getAccessibleMock(
            LinkNode::class,
            ['isWindowsOs', 'getAbsolutePath', 'exists'],
            [],
            '',
            false
        );
        $path = ‪Environment::getVarPath() . '/tests/' . $this->getUniqueId('dir_');
        $node->expects($this->any())->method('getAbsolutePath')->will($this->returnValue($path));
        $this->assertInternalType('array', $node->getStatus());
    }
 
    public function ‪getStatusReturnsArrayWithInformationStatusIfRunningOnWindows()
    {
        $node = $this->getAccessibleMock(
            LinkNode::class,
            ['isWindowsOs', 'getAbsolutePath', 'exists'],
            [],
            '',
            false
        );
        $path = ‪Environment::getVarPath() . '/tests/' . $this->getUniqueId('dir_');
        $node->expects($this->any())->method('getAbsolutePath')->will($this->returnValue($path));
        $node->expects($this->once())->method('isWindowsOs')->will($this->returnValue(true));
        $statusArray = $node->getStatus();
        $this->assertSame(‪FlashMessage::INFO, $statusArray[0]->getSeverity());
    }
 
    public function ‪getStatusReturnsArrayWithErrorStatusIfLinkNotExists()
    {
        $node = $this->getAccessibleMock(
            LinkNode::class,
            ['isWindowsOs', 'getAbsolutePath', 'exists'],
            [],
            '',
            false
        );
        $path = ‪Environment::getVarPath() . '/tests/' . $this->getUniqueId('dir_');
        $node->expects($this->any())->method('getAbsolutePath')->will($this->returnValue($path));
        $node->expects($this->any())->method('isWindowsOs')->will($this->returnValue(false));
        $node->expects($this->once())->method('exists')->will($this->returnValue(false));
        $statusArray = $node->getStatus();
        $this->assertSame(‪FlashMessage::ERROR, $statusArray[0]->getSeverity());
    }
 
    public function ‪getStatusReturnsArrayWithWarningStatusIfNodeIsNotALink()
    {
        $node = $this->getAccessibleMock(
            LinkNode::class,
            ['isWindowsOs', 'getAbsolutePath', 'exists', 'isLink', 'getRelativePathBelowSiteRoot'],
            [],
            '',
            false
        );
        $node->expects($this->any())->method('getAbsolutePath')->will($this->returnValue(''));
        $node->expects($this->any())->method('exists')->will($this->returnValue(true));
        $node->expects($this->once())->method('isLink')->will($this->returnValue(false));
        $statusArray = $node->getStatus();
        $this->assertSame(‪FlashMessage::WARNING, $statusArray[0]->getSeverity());
    }
 
    public function ‪getStatusReturnsErrorStatusIfLinkTargetIsNotCorrect()
    {
        $node = $this->getAccessibleMock(
            LinkNode::class,
            ['isWindowsOs', 'getAbsolutePath', 'exists', 'isLink', 'isTargetCorrect', 'getCurrentTarget', 'getRelativePathBelowSiteRoot'],
            [],
            '',
            false
        );
        $node->expects($this->any())->method('getAbsolutePath')->will($this->returnValue(''));
        $node->expects($this->any())->method('getCurrentTarget')->will($this->returnValue(''));
        $node->expects($this->any())->method('exists')->will($this->returnValue(true));
        $node->expects($this->any())->method('isLink')->will($this->returnValue(true));
        $node->expects($this->once())->method('isLink')->will($this->returnValue(false));
        $statusArray = $node->getStatus();
        $this->assertSame(‪FlashMessage::ERROR, $statusArray[0]->getSeverity());
    }
 
    public function ‪getStatusReturnsOkStatusIfLinkExistsAndTargetIsCorrect()
    {
        $node = $this->getAccessibleMock(
            LinkNode::class,
            ['isWindowsOs', 'getAbsolutePath', 'exists', 'isLink', 'isTargetCorrect', 'getRelativePathBelowSiteRoot'],
            [],
            '',
            false
        );
        $node->expects($this->any())->method('getAbsolutePath')->will($this->returnValue(''));
        $node->expects($this->any())->method('exists')->will($this->returnValue(true));
        $node->expects($this->once())->method('isLink')->will($this->returnValue(true));
        $node->expects($this->once())->method('isTargetCorrect')->will($this->returnValue(true));
        $node->expects($this->once())->method('getRelativePathBelowSiteRoot')->will($this->returnValue(''));
        $statusArray = $node->getStatus();
        $this->assertSame(‪FlashMessage::OK, $statusArray[0]->getSeverity());
    }
 
    public function ‪fixReturnsEmptyArray()
    {
        $node = $this->getAccessibleMock(
            LinkNode::class,
            ['getRelativePathBelowSiteRoot'],
            [],
            '',
            false
        );
        $statusArray = $node->fix();
        $this->assertEmpty($statusArray);
    }
 
    public function ‪isLinkThrowsExceptionIfLinkNotExists()
    {
        $this->expectException(InvalidArgumentException::class);
        $this->expectExceptionCode(1380556246);
        $node = $this->getAccessibleMock(LinkNode::class, ['exists'], [], '', false);
        $node->expects($this->once())->method('exists')->will($this->returnValue(false));
        $this->assertFalse($node->_call('isLink'));
    }
 
    public function ‪isLinkReturnsTrueIfNameIsLink()
    {
        $node = $this->getAccessibleMock(LinkNode::class, ['exists', 'getAbsolutePath'], [], '', false);
        $path = ‪Environment::getVarPath() . '/tests/' . $this->getUniqueId('link_');
        $target = ‪Environment::getVarPath() . '/tests/' . $this->getUniqueId('linkTarget_');
        touch($target);
        symlink($target, $path);
        $this->testFilesToDelete[] = $path;
        $this->testFilesToDelete[] = $target;
        $node->expects($this->any())->method('exists')->will($this->returnValue(true));
        $node->expects($this->any())->method('getAbsolutePath')->will($this->returnValue($path));
        $this->assertTrue($node->_call('isLink'));
    }
 
    public function ‪isFileReturnsFalseIfNameIsAFile()
    {
        $node = $this->getAccessibleMock(LinkNode::class, ['exists', 'getAbsolutePath'], [], '', false);
        $path = ‪Environment::getVarPath() . '/tests/' . $this->getUniqueId('file_');
        touch($path);
        $this->testFilesToDelete[] = $path;
        $node->expects($this->any())->method('exists')->will($this->returnValue(true));
        $node->expects($this->any())->method('getAbsolutePath')->will($this->returnValue($path));
        $this->assertFalse($node->_call('isLink'));
    }
 
    public function ‪isTargetCorrectThrowsExceptionIfLinkNotExists()
    {
        $this->expectException(InvalidArgumentException::class);
        $this->expectExceptionCode(1380556245);
        $node = $this->getAccessibleMock(LinkNode::class, ['exists'], [], '', false);
        $node->expects($this->once())->method('exists')->will($this->returnValue(false));
        $this->assertFalse($node->_call('isTargetCorrect'));
    }
 
    public function ‪isTargetCorrectThrowsExceptionIfNodeIsNotALink()
    {
        $this->expectException(InvalidArgumentException::class);
        $this->expectExceptionCode(1380556247);
        $node = $this->getAccessibleMock(LinkNode::class, ['exists', 'isLink', 'getTarget'], [], '', false);
        $node->expects($this->any())->method('exists')->will($this->returnValue(true));
        $node->expects($this->once())->method('isLink')->will($this->returnValue(false));
        $this->assertTrue($node->_call('isTargetCorrect'));
    }
 
    public function ‪isTargetCorrectReturnsTrueIfNoExpectedLinkTargetIsSpecified()
    {
        $node = $this->getAccessibleMock(LinkNode::class, ['exists', 'isLink', 'getTarget'], [], '', false);
        $node->expects($this->any())->method('exists')->will($this->returnValue(true));
        $node->expects($this->any())->method('isLink')->will($this->returnValue(true));
        $node->expects($this->once())->method('getTarget')->will($this->returnValue(''));
        $this->assertTrue($node->_call('isTargetCorrect'));
    }
 
    public function ‪isTargetCorrectAcceptsATargetWithATrailingSlash()
    {
        $node = $this->getAccessibleMock(LinkNode::class, ['exists', 'isLink', 'getCurrentTarget', 'getTarget'], [], '', false);
        $node->expects($this->any())->method('exists')->will($this->returnValue(true));
        $node->expects($this->any())->method('isLink')->will($this->returnValue(true));
        $node->expects($this->once())->method('getCurrentTarget')->will($this->returnValue('someLinkTarget/'));
        $node->expects($this->once())->method('getTarget')->will($this->returnValue('someLinkTarget'));
        $this->assertTrue($node->_call('isTargetCorrect'));
    }
 
    public function ‪isTargetCorrectReturnsTrueIfActualTargetIsIdenticalToSpecifiedTarget()
    {
        $path = ‪Environment::getVarPath() . '/tests/' . $this->getUniqueId('link_');
        $target = ‪Environment::getVarPath() . '/tests/' . $this->getUniqueId('linkTarget_');
        touch($target);
        symlink($target, $path);
        $this->testFilesToDelete[] = $path;
        $this->testFilesToDelete[] = $target;
        $node = $this->getAccessibleMock(
            LinkNode::class,
            ['exists', 'isLink', 'getTarget', 'getAbsolutePath'],
            [],
            '',
            false
        );
        $node->expects($this->any())->method('exists')->will($this->returnValue(true));
        $node->expects($this->any())->method('isLink')->will($this->returnValue(true));
        $node->expects($this->once())->method('getTarget')->will($this->returnValue(str_replace('/', DIRECTORY_SEPARATOR, $target)));
        $node->expects($this->once())->method('getAbsolutePath')->will($this->returnValue($path));
        $this->assertTrue($node->_call('isTargetCorrect'));
    }
 
    public function ‪isTargetCorrectReturnsFalseIfActualTargetIsNotIdenticalToSpecifiedTarget()
    {
        $path = ‪Environment::getVarPath() . '/tests/' . $this->getUniqueId('link_');
        $target = ‪Environment::getVarPath() . '/tests/' . $this->getUniqueId('linkTarget_');
        touch($target);
        symlink($target, $path);
        $this->testFilesToDelete[] = $path;
        $this->testFilesToDelete[] = $target;
        $node = $this->getAccessibleMock(
            LinkNode::class,
            ['exists', 'isLink', 'getTarget', 'getAbsolutePath'],
            [],
            '',
            false
        );
        $node->expects($this->any())->method('exists')->will($this->returnValue(true));
        $node->expects($this->any())->method('isLink')->will($this->returnValue(true));
        $node->expects($this->once())->method('getTarget')->will($this->returnValue('foo'));
        $node->expects($this->once())->method('getAbsolutePath')->will($this->returnValue($path));
        $this->assertFalse($node->_call('isTargetCorrect'));
    }
}