StreamTest.php

Go to the documentation of this file.

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

/*
 * 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\Http\Stream;

class StreamTest extends \TYPO3\TestingFramework\Core\Unit\UnitTestCase
{
    protected $stream;

    protected function setUp()
    {
        $this->stream = new Stream('php://memory', 'wb+');
    }

    public function canInstantiateWithStreamIdentifier()
    {
        $this->assertInstanceOf(Stream::class, $this->stream);
    }

    public function canInstantiteWithStreamResource()
    {
        $resource = fopen('php://memory', 'wb+');
        $stream = new Stream($resource);
        $this->assertInstanceOf(Stream::class, $stream);
    }

    public function isReadableReturnsFalseIfStreamIsNotReadable()
    {
        $fileName = PATH_site . 'typo3temp/var/tests/' . $this->getUniqueId('test_');
        touch($fileName);
        $this->testFilesToDelete[] = $fileName;
        $stream = new Stream($fileName, 'w');
        $this->assertFalse($stream->isReadable());
    }

    public function isWritableReturnsFalseIfStreamIsNotWritable()
    {
        $stream = new Stream('php://memory', 'r');
        $this->assertFalse($stream->isWritable());
    }

    public function toStringRetrievesFullContentsOfStream()
    {
        $message = 'foo bar';
        $this->stream->write($message);
        $this->assertEquals($message, (string)$this->stream);
    }

    public function detachReturnsResource()
    {
        $resource = fopen('php://memory', 'wb+');
        $stream = new Stream($resource);
        $this->assertSame($resource, $stream->detach());
    }

    public function constructorRaisesExceptionWhenPassingInvalidStreamResource()
    {
        $this->expectException(\InvalidArgumentException::class);
        new Stream(['  THIS WILL NOT WORK  ']);
    }

    public function toStringSerializationReturnsEmptyStringWhenStreamIsNotReadable()
    {
        $fileName = PATH_site . 'typo3temp/var/tests/' . $this->getUniqueId('test_');
        touch($fileName);
        $this->testFilesToDelete[] = $fileName;
        file_put_contents($fileName, 'FOO BAR');
        $stream = new Stream($fileName, 'w');

        $this->assertEquals('', $stream->__toString());
    }

    public function closeClosesResource()
    {
        $fileName = PATH_site . 'typo3temp/var/tests/' . $this->getUniqueId('test_');
        touch($fileName);
        $this->testFilesToDelete[] = $fileName;
        $resource = fopen($fileName, 'wb+');
        $stream = new Stream($resource);
        $stream->close();
        $this->assertFalse(is_resource($resource));
    }

    public function closeUnsetsResource()
    {
        $fileName = PATH_site . 'typo3temp/var/tests/' . $this->getUniqueId('test_');
        touch($fileName);
        $this->testFilesToDelete[] = $fileName;
        $resource = fopen($fileName, 'wb+');
        $stream = new Stream($resource);
        $stream->close();

        $this->assertNull($stream->detach());
    }

    public function closeDoesNothingAfterDetach()
    {
        $fileName = PATH_site . 'typo3temp/var/tests/' . $this->getUniqueId('test_');
        touch($fileName);
        $this->testFilesToDelete[] = $fileName;
        $resource = fopen($fileName, 'wb+');
        $stream = new Stream($resource);
        $detached = $stream->detach();

        $stream->close();
        $this->assertTrue(is_resource($detached));
        $this->assertSame($resource, $detached);
    }

    public function getSizeReportsNullWhenNoResourcePresent()
    {
        $this->stream->detach();
        $this->assertNull($this->stream->getSize());
    }

    public function tellReportsCurrentPositionInResource()
    {
        $fileName = PATH_site . 'typo3temp/var/tests/' . $this->getUniqueId('test_');
        $this->testFilesToDelete[] = $fileName;
        file_put_contents($fileName, 'FOO BAR');
        $resource = fopen($fileName, 'wb+');
        $stream = new Stream($resource);

        fseek($resource, 2);

        $this->assertEquals(2, $stream->tell());
    }

    public function tellRaisesExceptionIfResourceIsDetached()
    {
        $fileName = PATH_site . 'typo3temp/var/tests/' . $this->getUniqueId('test_');
        $this->testFilesToDelete[] = $fileName;
        file_put_contents($fileName, 'FOO BAR');
        $resource = fopen($fileName, 'wb+');
        $stream = new Stream($resource);

        fseek($resource, 2);
        $stream->detach();
        $this->expectException(\RuntimeException::class);
        $this->expectExceptionCode(1436717285);
        $stream->tell();
    }

    public function eofReportsFalseWhenNotAtEndOfStream()
    {
        $fileName = PATH_site . 'typo3temp/var/tests/' . $this->getUniqueId('test_');
        $this->testFilesToDelete[] = $fileName;
        file_put_contents($fileName, 'FOO BAR');
        $resource = fopen($fileName, 'wb+');
        $stream = new Stream($resource);

        fseek($resource, 2);
        $this->assertFalse($stream->eof());
    }

    public function eofReportsTrueWhenAtEndOfStream()
    {
        $fileName = PATH_site . 'typo3temp/var/tests/' . $this->getUniqueId('test_');
        $this->testFilesToDelete[] = $fileName;
        file_put_contents($fileName, 'FOO BAR');
        $resource = fopen($fileName, 'wb+');
        $stream = new Stream($resource);

        while (!feof($resource)) {
            fread($resource, 4096);
        }
        $this->assertTrue($stream->eof());
    }

    public function eofReportsTrueWhenStreamIsDetached()
    {
        $fileName = PATH_site . 'typo3temp/var/tests/' . $this->getUniqueId('test_');
        $this->testFilesToDelete[] = $fileName;
        file_put_contents($fileName, 'FOO BAR');
        $resource = fopen($fileName, 'wb+');
        $stream = new Stream($resource);

        fseek($resource, 2);
        $stream->detach();
        $this->assertTrue($stream->eof());
    }

    public function isSeekableReturnsTrueForReadableStreams()
    {
        $fileName = PATH_site . 'typo3temp/var/tests/' . $this->getUniqueId('test_');
        $this->testFilesToDelete[] = $fileName;
        file_put_contents($fileName, 'FOO BAR');
        $resource = fopen($fileName, 'wb+');
        $stream = new Stream($resource);
        $this->assertTrue($stream->isSeekable());
    }

    public function isSeekableReturnsFalseForDetachedStreams()
    {
        $fileName = PATH_site . 'typo3temp/var/tests/' . $this->getUniqueId('test_');
        $this->testFilesToDelete[] = $fileName;
        file_put_contents($fileName, 'FOO BAR');
        $resource = fopen($fileName, 'wb+');
        $stream = new Stream($resource);
        $stream->detach();
        $this->assertFalse($stream->isSeekable());
    }

    public function seekAdvancesToGivenOffsetOfStream()
    {
        $fileName = PATH_site . 'typo3temp/var/tests/' . $this->getUniqueId('test_');
        $this->testFilesToDelete[] = $fileName;
        file_put_contents($fileName, 'FOO BAR');
        $resource = fopen($fileName, 'wb+');
        $stream = new Stream($resource);
        $stream->seek(2);
        $this->assertEquals(2, $stream->tell());
    }

    public function rewindResetsToStartOfStream()
    {
        $fileName = PATH_site . 'typo3temp/var/tests/' . $this->getUniqueId('test_');
        $this->testFilesToDelete[] = $fileName;
        file_put_contents($fileName, 'FOO BAR');
        $resource = fopen($fileName, 'wb+');
        $stream = new Stream($resource);
        $stream->seek(2);
        $stream->rewind();
        $this->assertEquals(0, $stream->tell());
    }

    public function seekRaisesExceptionWhenStreamIsDetached()
    {
        $fileName = PATH_site . 'typo3temp/var/tests/' . $this->getUniqueId('test_');
        $this->testFilesToDelete[] = $fileName;
        file_put_contents($fileName, 'FOO BAR');
        $resource = fopen($fileName, 'wb+');
        $stream = new Stream($resource);
        $stream->detach();
        $this->expectException(\RuntimeException::class);
        $this->expectExceptionCode(1436717287);
        $stream->seek(2);
    }

    public function isWritableReturnsFalseWhenStreamIsDetached()
    {
        $fileName = PATH_site . 'typo3temp/var/tests/' . $this->getUniqueId('test_');
        $this->testFilesToDelete[] = $fileName;
        file_put_contents($fileName, 'FOO BAR');
        $resource = fopen($fileName, 'wb+');
        $stream = new Stream($resource);
        $stream->detach();
        $this->assertFalse($stream->isWritable());
    }

    public function writeRaisesExceptionWhenStreamIsDetached()
    {
        $fileName = PATH_site . 'typo3temp/var/tests/' . $this->getUniqueId('test_');
        $this->testFilesToDelete[] = $fileName;
        file_put_contents($fileName, 'FOO BAR');
        $resource = fopen($fileName, 'wb+');
        $stream = new Stream($resource);
        $stream->detach();
        $this->expectException(\RuntimeException::class);
        $this->expectExceptionCode(1436717290);
        $stream->write('bar');
    }

    public function isReadableReturnsFalseWhenStreamIsDetached()
    {
        $fileName = PATH_site . 'typo3temp/var/tests/' . $this->getUniqueId('test_');
        $this->testFilesToDelete[] = $fileName;
        file_put_contents($fileName, 'FOO BAR');
        $resource = fopen($fileName, 'wb+');
        $stream = new Stream($resource);
        $stream->detach();
        $this->assertFalse($stream->isReadable());
    }

    public function readRaisesExceptionWhenStreamIsDetached()
    {
        $fileName = PATH_site . 'typo3temp/var/tests/' . $this->getUniqueId('test_');
        $this->testFilesToDelete[] = $fileName;
        file_put_contents($fileName, 'FOO BAR');
        $resource = fopen($fileName, 'r');
        $stream = new Stream($resource);
        $stream->detach();
        $this->expectException(\RuntimeException::class);
        $this->expectExceptionCode(1436717292);
        $stream->read(4096);
    }

    public function readReturnsEmptyStringWhenAtEndOfFile()
    {
        $fileName = PATH_site . 'typo3temp/var/tests/' . $this->getUniqueId('test_');
        $this->testFilesToDelete[] = $fileName;
        file_put_contents($fileName, 'FOO BAR');
        $resource = fopen($fileName, 'r');
        $stream = new Stream($resource);
        while (!feof($resource)) {
            fread($resource, 4096);
        }
        $this->assertEquals('', $stream->read(4096));
    }

    public function getContentsReturnsEmptyStringIfStreamIsNotReadable()
    {
        $fileName = PATH_site . 'typo3temp/var/tests/' . $this->getUniqueId('test_');
        $this->testFilesToDelete[] = $fileName;
        file_put_contents($fileName, 'FOO BAR');
        $resource = fopen($fileName, 'w');
        $stream = new Stream($resource);
        $this->assertEquals('', $stream->getContents());
    }

    public function invalidResourcesDataProvider()
    {
        $fileName = tempnam(sys_get_temp_dir(), 'PHLY');
        $this->testFilesToDelete[] = $fileName;

        return [
            'null'                => [null],
            'false'               => [false],
            'true'                => [true],
            'int'                 => [1],
            'float'               => [1.1],
            'array'               => [[fopen($fileName, 'r+')]],
            'object'              => [(object)['resource' => fopen($fileName, 'r+')]],
        ];
    }

    public function attachWithNonStringNonResourceRaisesExceptionByType($resource)
    {
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode(1436717297);
        $this->stream->attach($resource);
    }

    public function attachWithNonStringNonResourceRaisesExceptionByString()
    {
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode(1436717296);
        $this->stream->attach('foo-bar-baz');
    }

    public function attachWithResourceAttachesResource()
    {
        $fileName = PATH_site . 'typo3temp/var/tests/' . $this->getUniqueId('test_');
        touch($fileName);
        $this->testFilesToDelete[] = $fileName;
        $resource = fopen($fileName, 'r+');
        $this->stream->attach($resource);

        $r = new \ReflectionProperty($this->stream, 'resource');
        $r->setAccessible(true);
        $test = $r->getValue($this->stream);
        $this->assertSame($resource, $test);
    }

    public function attachWithStringRepresentingResourceCreatesAndAttachesResource()
    {
        $fileName = PATH_site . 'typo3temp/var/tests/' . $this->getUniqueId('test_');
        touch($fileName);
        $this->testFilesToDelete[] = $fileName;
        $this->stream->attach($fileName);

        $resource = fopen($fileName, 'r+');
        fwrite($resource, 'FooBar');

        $this->stream->rewind();
        $test = (string)$this->stream;
        $this->assertEquals('FooBar', $test);
    }

    public function getContentsShouldGetFullStreamContents()
    {
        $fileName = PATH_site . 'typo3temp/var/tests/' . $this->getUniqueId('test_');
        touch($fileName);
        $this->testFilesToDelete[] = $fileName;
        $resource = fopen($fileName, 'r+');
        $this->stream->attach($resource);

        fwrite($resource, 'FooBar');

        // rewind, because current pointer is at end of stream!
        $this->stream->rewind();
        $test = $this->stream->getContents();
        $this->assertEquals('FooBar', $test);
    }

    public function getContentsShouldReturnStreamContentsFromCurrentPointer()
    {
        $fileName = PATH_site . 'typo3temp/var/tests/' . $this->getUniqueId('test_');
        touch($fileName);
        $this->testFilesToDelete[] = $fileName;
        $resource = fopen($fileName, 'r+');
        $this->stream->attach($resource);

        fwrite($resource, 'FooBar');

        // seek to position 3
        $this->stream->seek(3);
        $test = $this->stream->getContents();
        $this->assertEquals('Bar', $test);
    }

    public function getMetadataReturnsAllMetadataWhenNoKeyPresent()
    {
        $fileName = PATH_site . 'typo3temp/var/tests/' . $this->getUniqueId('test_');
        touch($fileName);
        $this->testFilesToDelete[] = $fileName;
        $resource = fopen($fileName, 'r+');
        $this->stream->attach($resource);

        $expected = stream_get_meta_data($resource);
        $test = $this->stream->getMetadata();

        $this->assertEquals($expected, $test);
    }

    public function getMetadataReturnsDataForSpecifiedKey()
    {
        $fileName = PATH_site . 'typo3temp/var/tests/' . $this->getUniqueId('test_');
        touch($fileName);
        $this->testFilesToDelete[] = $fileName;
        $resource = fopen($fileName, 'r+');
        $this->stream->attach($resource);

        $metadata = stream_get_meta_data($resource);
        $expected = $metadata['uri'];

        $test = $this->stream->getMetadata('uri');

        $this->assertEquals($expected, $test);
    }

    public function getMetadataReturnsNullIfNoDataExistsForKey()
    {
        $fileName = PATH_site . 'typo3temp/var/tests/' . $this->getUniqueId('test_');
        touch($fileName);
        $this->testFilesToDelete[] = $fileName;
        $resource = fopen($fileName, 'r+');
        $this->stream->attach($resource);

        $this->assertNull($this->stream->getMetadata('TOTALLY_MADE_UP'));
    }

    public function getSizeReturnsStreamSize()
    {
        $resource = fopen(__FILE__, 'r');
        $expected = fstat($resource);
        $stream = new Stream($resource);
        $this->assertEquals($expected['size'], $stream->getSize());
    }
}