Phing\Io\FileSystemTest

Complexity

Total Complexity

11

Size/Duplication

Total Lines	86
Duplicated Lines	0 %

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
A	testGetFileSystemReturnsCorrect()	0	9	1
A	testWhichFailsDueToUnusualExecutableName()	0	5	1
A	testWhichFailsNonStringExecutable()	0	5	1
A	setUp()	0	3	1
A	tearDown()	0	4	1
A	fileSystemMappingsDataProvider()	0	5	1
A	testGetFileSystemWithUnknownTypeKeyThrowsException()	0	9	1
A	testWhichHinkyExecutableNameWithSeparator()	0	5	1
A	testListContentsWithNumericName()	0	9	2
A	resetFileSystem()	0	6	1

<?php
/**
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * This software consists of voluntary contributions made by many individuals
 * and is licensed under the LGPL. For more information please see
 * <http://phing.info>.
 */

namespace Phing\Io;

use Phing\Phing;
use ReflectionClass;

/**
 * Unit test for FileSystem
 *
 */
class FileSystemTest extends \PHPUnit\Framework\TestCase
{
    private $oldFsType = "";

    public function setUp(): void
    {
        $this->oldFsType = Phing::getProperty('host.fstype');
    }

    public function tearDown(): void
    {
        Phing::setProperty('host.fstype', $this->oldFsType);
        $this->resetFileSystem();
    }

    protected function resetFileSystem()
    {
        $refClass = new ReflectionClass(FileSystem::class);
        $refProperty = $refClass->getProperty('fs');
        $refProperty->setAccessible(true);
        $refProperty->setValue(null);
    }

    public function testGetFileSystemWithUnknownTypeKeyThrowsException()
    {
        $this->resetFileSystem();

        $this->expectException(IOException::class);

        Phing::setProperty('host.fstype', 'UNRECOGNISED');

        FileSystem::getFileSystem();
    }

    /**
     * @dataProvider fileSystemMappingsDataProvider
     */
    public function testGetFileSystemReturnsCorrect($expectedFileSystemClass, $fsTypeKey)
    {
        $this->resetFileSystem();

        Phing::setProperty('host.fstype', $fsTypeKey);

        $system = FileSystem::getFileSystem();

        $this->assertInstanceOf($expectedFileSystemClass, $system);
    }

    public function fileSystemMappingsDataProvider()
    {
        return [
            [UnixFileSystem::class, 'UNIX'],
            [WindowsFileSystem::class, 'WINDOWS'],
        ];
    }

    public function testWhichFailsNonStringExecutable()
    {
        $fs = FileSystem::getFileSystem();
        $path = $fs->which(42);
        $this->assertEquals($path, false);
    }

    public function testWhichFailsDueToUnusualExecutableName()
    {
        $fs = FileSystem::getFileSystem();
        $path = $fs->which('tasword.bin');
        $this->assertEquals($path, false);
    }

    public function testWhichHinkyExecutableNameWithSeparator()
    {
        $fs = FileSystem::getFileSystem();
        $path = $fs->which('zx:\tasword.bin');
        $this->assertEquals($path, false);
    }

    public function testListContentsWithNumericName()
    {
        $fs = FileSystem::getFileSystem();

        $parentDir = new File(__DIR__ . '/../../etc/system/io/testdir');
        $contents = $fs->listContents($parentDir);

        foreach ($contents as $filename) {
            self::assertIsString($filename);
        }
    }
}