FileTest.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Core\Tests\Unit\Resource;

use TYPO3\CMS\Core\Resource\ResourceStorage;

class FileTest extends \TYPO3\CMS\Core\Tests\UnitTestCase {

    protected $singletonInstances = array();

    protected $storageMock;

    public function setUp() {
        $this->singletonInstances = \TYPO3\CMS\Core\Utility\GeneralUtility::getSingletonInstances();
        $this->storageMock = $this->getMock('TYPO3\CMS\Core\Resource\ResourceStorage', array(), array(), '', FALSE);
        $this->storageMock->expects($this->any())->method('getUid')->will($this->returnValue(5));

        $mockedMetaDataRepository = $this->getMock('TYPO3\\CMS\\Core\\Resource\\Index\\MetaDataRepository');
        $mockedMetaDataRepository->expects($this->any())->method('findByFile')->will($this->returnValue(array('file' => 1)));
        \TYPO3\CMS\Core\Utility\GeneralUtility::setSingletonInstance('TYPO3\\CMS\\Core\\Resource\\Index\\MetaDataRepository', $mockedMetaDataRepository);
    }

    public function tearDown() {
        \TYPO3\CMS\Core\Utility\GeneralUtility::resetSingletonInstances($this->singletonInstances);
        parent::tearDown();
    }

    protected function prepareFixture() {
        $fixture = new \TYPO3\CMS\Core\Resource\File(array('testfile'), $this->storageMock);
        return $fixture;
    }

    public function propertiesPassedToConstructorAreAvailableViaGenericGetter() {
        $this->markTestSkipped('TYPO3\\CMS\\Core\\Resource\\File::getAvailableProperties() does not exist');
        $properties = array(
            $this->getUniqueId() => $this->getUniqueId(),
            $this->getUniqueId() => $this->getUniqueId(),
            'uid' => 1
        );
        $fixture = new \TYPO3\CMS\Core\Resource\File($properties, $this->storageMock);
        $availablePropertiesBackup = \TYPO3\CMS\Core\Resource\File::getAvailableProperties();
        \TYPO3\CMS\Core\Resource\File::setAvailableProperties(array_keys($properties));
        foreach ($properties as $key => $value) {
            $this->assertTrue($fixture->hasProperty($key));
            $this->assertEquals($value, $fixture->getProperty($key));
        }
        $this->assertFalse($fixture->hasProperty($this->getUniqueId()));
        \TYPO3\CMS\Core\Resource\File::setAvailableProperties($availablePropertiesBackup);
        $this->setExpectedException('InvalidArgumentException', '', 1314226805);
        $fixture->getProperty($this->getUniqueId());
    }

    public function commonPropertiesAreAvailableWithOwnGetters() {
        $properties = array(
            'name' => $this->getUniqueId(),
            'storage' => $this->storageMock,
            'size' => 1024
        );
        $fixture = new \TYPO3\CMS\Core\Resource\File($properties, $this->storageMock);
        foreach ($properties as $key => $value) {
            $this->assertEquals($value, call_user_func(array($fixture, 'get' . $key)));
        }
    }

    public function fileIndexStatusIsTrueIfUidIsSet() {
        $fixture = new \TYPO3\CMS\Core\Resource\File(array('uid' => 1), $this->storageMock);
        $this->assertTrue($fixture->isIndexed());
    }

    public function updatePropertiesUpdatesFileProperties() {
        $identifier = '/' . $this->getUniqueId();
        $fixture = new \TYPO3\CMS\Core\Resource\File(array('uid' => 1, 'identifier' => '/test'), $this->storageMock);
        $fixture->updateProperties(array('identifier' => $identifier));
        $this->assertEquals($identifier, $fixture->getIdentifier());
    }

    public function updatePropertiesLeavesPropertiesUntouchedIfNotSetInNewProperties() {
        $fixture = new \TYPO3\CMS\Core\Resource\File(array('uid' => 1, 'foo' => 'asdf', 'identifier' => '/test'), $this->storageMock);
        $fixture->updateProperties(array('foo' => 'foobar'));
        $this->assertEquals('/test', $fixture->getIdentifier());
        $this->assertEquals('/test', $fixture->getProperty('identifier'));
    }

    public function updatePropertiesDiscardsUidIfAlreadySet() {
        $fixture = new \TYPO3\CMS\Core\Resource\File(array('uid' => 1, 'identifier' => '/test'), $this->storageMock);
        $fixture->updateProperties(array('uid' => 3));
        $this->assertEquals(1, $fixture->getUid());
    }

    public function updatePropertiesRecordsNamesOfChangedProperties() {
        $fixture = new \TYPO3\CMS\Core\Resource\File(array('uid' => 1, 'foo' => 'asdf', 'baz' => 'fdsw', 'identifier' => '/test'), $this->storageMock);
        $fixture->updateProperties(array('foo' => 'foobar', 'baz' => 'foobaz'));
        $this->assertEquals(array('foo', 'baz'), $fixture->getUpdatedProperties());
    }

    public function updatePropertiesDoesNotRecordPropertyNameIfSameValueIsProvided() {
        $fixture = new \TYPO3\CMS\Core\Resource\File(array('uid' => 1, 'foo' => 'asdf', 'identifier' => '/test'), $this->storageMock);
        $fixture->updateProperties(array('foo' => 'asdf'));
        $this->assertEmpty($fixture->getUpdatedProperties());
    }

    public function updatePropertiesMarksPropertyAsChangedOnlyOnce() {
        $fixture = new \TYPO3\CMS\Core\Resource\File(array('uid' => 1, 'foo' => 'asdf', 'baz' => 'fdsw', 'identifier' => '/test'), $this->storageMock);
        $fixture->updateProperties(array('foo' => 'foobar', 'baz' => 'foobaz'));
        $fixture->updateProperties(array('foo' => 'fdsw', 'baz' => 'asdf'));
        $this->assertEquals(array('foo', 'baz'), $fixture->getUpdatedProperties());
    }

    public function updatePropertiesReloadsStorageObjectIfStorageChanges() {
        $fileProperties = array(
            'uid' => 1,
            'storage' => 'first',
        );
        $subject = $this->getMock(
            'TYPO3\\CMS\\Core\\Resource\\File',
            array('loadStorage'),
            array($fileProperties, $this->storageMock)
        );
        $mockedNewStorage = $this->getMock('TYPO3\\CMS\\Core\\Resource\\ResourceStorage', array(), array(), '', FALSE);
        $mockedResourceFactory = $this->getMock('TYPO3\\CMS\\Core\\Resource\\ResourceFactory');
        $mockedResourceFactory
            ->expects($this->once())
            ->method('getStorageObject')
            ->will($this->returnValue($mockedNewStorage));
        \TYPO3\CMS\Core\Utility\GeneralUtility::setSingletonInstance('TYPO3\\CMS\\Core\\Resource\\ResourceFactory', $mockedResourceFactory);

        $subject->updateProperties(array('storage' => 'different'));
        $this->assertSame($mockedNewStorage, $subject->getStorage());
    }



    public function copyToCallsCopyOperationOnTargetFolderStorage() {
        $targetStorage = $this->getMock('TYPO3\\CMS\\Core\\Resource\\ResourceStorage', array(), array(), '', FALSE);
        $targetFolder = $this->getMock('TYPO3\\CMS\\Core\\Resource\\Folder', array(), array(), '', FALSE);
        $targetFolder->expects($this->any())->method('getStorage')->will($this->returnValue($targetStorage));
        $fixture = new \TYPO3\CMS\Core\Resource\File(array(), $this->storageMock);
        $targetStorage->expects($this->once())->method('copyFile')->with($this->equalTo($fixture), $this->equalTo($targetFolder));
        $fixture->copyTo($targetFolder);
    }

    public function moveToCallsMoveOperationOnTargetFolderStorage() {
        $targetStorage = $this->getMock('TYPO3\\CMS\\Core\\Resource\\ResourceStorage', array(), array(), '', FALSE);
        $targetFolder = $this->getMock('TYPO3\\CMS\\Core\\Resource\\Folder', array(), array(), '', FALSE);
        $targetFolder->expects($this->any())->method('getStorage')->will($this->returnValue($targetStorage));
        $fixture = new \TYPO3\CMS\Core\Resource\File(array(), $this->storageMock);
        $targetStorage->expects($this->once())->method('moveFile')->with($this->equalTo($fixture), $this->equalTo($targetFolder));
        $fixture->moveTo($targetFolder);
    }

    public function openCorrectlyOpensFileInDriver() {
        $this->markTestSkipped();
        $fixture = $this->prepareFixture();
        $fileMode = 'invalidMode';
        $mockDriver = $this->getMockForAbstractClass('t3lib_file_driver_Abstract');
        $mockDriver->expects($this->atLeastOnce())->method('getFileHandle')->with($this->equalTo($fixture), $this->equalTo($fileMode));
        $fixture->setStorageDriver($mockDriver);
        $fixture->open($fileMode);
    }

    public function isOpenReturnsCorrectValuesForClosedAndOpenFile() {
        $this->markTestSkipped();
        $fixture = $this->prepareFixture();
        $fileMode = 'r';
        $mockFileHandle = $this->getMock('TYPO3\\CMS\\Core\\Resource\\FileHandle', array(), array(), '', FALSE);
        $mockFileHandle->expects($this->any())->method('isOpen')->will($this->returnValue(TRUE));
        $mockDriver = $this->getMockForAbstractClass('t3lib_file_driver_Abstract');
        $mockDriver->expects($this->any())->method('getFileHandle')->will($this->returnValue($mockFileHandle));
        $fixture->setStorageDriver($mockDriver);
        $this->assertFalse($fixture->isOpen());
        $fixture->open($fileMode);
        $this->assertTrue($fixture->isOpen());
    }

    public function fileIsCorrectlyClosed() {
        $this->markTestSkipped();
        $fixture = $this->prepareFixture();
        $fileMode = 'r';
        $mockFileHandle = $this->getMock('TYPO3\\CMS\\Core\\Resource\\FileHandle', array(), array(), '', FALSE);
        $mockFileHandle->expects($this->once())->method('close');
        $mockDriver = $this->getMockForAbstractClass('t3lib_file_driver_Abstract');
        $mockDriver->expects($this->any())->method('getFileHandle')->will($this->returnValue($mockFileHandle));
        $fixture->setStorageDriver($mockDriver);
        $fixture->open($fileMode);
        $fixture->close();
        $this->assertFalse($fixture->isOpen());
    }

    public function readReturnsRequestedContentsFromDriver() {
        $this->markTestSkipped();
        $fixture = $this->prepareFixture();
        $fileMode = 'r';
        $fileContents = 'Some random file contents.';
        $bytesToRead = 10;
        $mockFileHandle = $this->getMock('TYPO3\\CMS\\Core\\Resource\\FileHandle', array(), array(), '', FALSE);
        $mockFileHandle->expects($this->any())->method('isOpen')->will($this->returnValue(TRUE));
        $mockDriver = $this->getMockForAbstractClass('t3lib_file_driver_Abstract');
        $mockDriver->expects($this->any())->method('getFileHandle')->will($this->returnValue($mockFileHandle));
        $mockDriver->expects($this->once())->method('readFromFile')->with($this->anything(), $this->equalTo($bytesToRead))->will($this->returnValue(substr($fileContents, 0, $bytesToRead)));
        $fixture->setStorageDriver($mockDriver);
        $fixture->open($fileMode);
        $this->assertEquals(substr($fileContents, 0, $bytesToRead), $fixture->read($bytesToRead));
    }

    public function readFailsIfFileIsClosed() {
        $this->markTestSkipped();
        $this->setExpectedException('\\RuntimeException', '', 1299863431);
        $fixture = $this->prepareFixture();
        $mockFileHandle = $this->getMock('TYPO3\\CMS\\Core\\Resource\\FileHandle', array(), array(), '', FALSE);
        $mockDriver = $this->getMockForAbstractClass('t3lib_file_driver_Abstract');
        $mockDriver->expects($this->any())->method('getFileHandle')->will($this->returnValue($mockFileHandle));
        $fixture->setStorageDriver($mockDriver);
        $fixture->read(1);
    }

    public function writePassesContentsToDriver() {
        $this->markTestSkipped();
        $fixture = $this->prepareFixture();
        $fileMode = 'r+';
        $fileContents = 'Some random file contents.';
        $mockFileHandle = $this->getMock('TYPO3\\CMS\\Core\\Resource\\FileHandle', array(), array(), '', FALSE);
        $mockFileHandle->expects($this->any())->method('isOpen')->will($this->returnValue(TRUE));
        $mockDriver = $this->getMockForAbstractClass('t3lib_file_driver_Abstract');
        $mockDriver->expects($this->any())->method('getFileHandle')->will($this->returnValue($mockFileHandle));
        $mockDriver->expects($this->once())->method('writeToFile')->with($this->anything(), $this->equalTo($fileContents))->will($this->returnValue(TRUE));
        $fixture->setStorageDriver($mockDriver);
        $fixture->open($fileMode);
        $this->assertTrue($fixture->write($fileContents));
    }

    public function writeFailsIfFileIsClosed() {
        $this->markTestSkipped();
        $this->setExpectedException('\\RuntimeException', '', 1299863432);
        $fixture = $this->prepareFixture();
        $mockFileHandle = $this->getMock('TYPO3\\CMS\\Core\\Resource\\FileHandle', array(), array(), '', FALSE);
        $mockDriver = $this->getMockForAbstractClass('t3lib_file_driver_Abstract');
        $mockDriver->expects($this->any())->method('getFileHandle')->will($this->returnValue($mockFileHandle));
        $fixture->setStorageDriver($mockDriver);
        $fixture->write('asdf');
    }

    public function filenameExtensionDataProvider() {
        return array(
            array('somefile.jpg', 'somefile', 'jpg'),
            array('SomeFile.PNG', 'SomeFile', 'png'),
            array('somefile', 'somefile', ''),
            array('somefile.tar.gz', 'somefile.tar', 'gz'),
            array('somefile.tar.bz2', 'somefile.tar', 'bz2'),
        );
    }

    public function getNameWithoutExtensionReturnsCorrectName($originalFilename, $expectedBasename) {
        $fixture = new \TYPO3\CMS\Core\Resource\File(array(
            'name' => $originalFilename,
            'identifier' => '/' . $originalFilename
        ),
        $this->storageMock);
        $this->assertSame($expectedBasename, $fixture->getNameWithoutExtension());
    }

    public function getExtensionReturnsCorrectExtension($originalFilename, $expectedBasename, $expectedExtension) {
        $fixture = new \TYPO3\CMS\Core\Resource\File(array(
            'name' => $originalFilename,
            'identifier' => '/' . $originalFilename
        ), $this->storageMock);
        $this->assertSame($expectedExtension, $fixture->getExtension());
    }

    public function hasPropertyReturnsTrueFilePropertyExists() {
        $fixture = new \TYPO3\CMS\Core\Resource\File(array('testproperty' => 'testvalue'), $this->storageMock);
        $this->assertTrue($fixture->hasProperty('testproperty'));
    }

    public function hasPropertyReturnsTrueIfMetadataPropertyExists() {
        $fixture = $this->getAccessibleMock('TYPO3\\CMS\\Core\\Resource\\File', array('dummy'), array(array(), $this->storageMock));
        $fixture->_set('metaDataLoaded', TRUE);
        $fixture->_set('metaDataProperties', array('testproperty' => 'testvalue'));
        $this->assertTrue($fixture->hasProperty('testproperty'));
    }
}