sunrise-php / http-server-request

tests/UploadedFileTest.php

<?php

declare(strict_types=1);

namespace Sunrise\Http\ServerRequest\Tests;

/**
 * Import classes
 */
use Psr\Http\Message\StreamInterface;
use Psr\Http\Message\UploadedFileInterface;
use Sunrise\Http\ServerRequest\UploadedFile;
use Sunrise\Stream\StreamFactory;

/**
 * Import constants
 */
use const Sunrise\Http\ServerRequest\UPLOAD_ERRORS;

The constant Sunrise\Http\ServerRequest\UPLOAD_ERRORS was not found. Maybe you did not declare it correctly or list all dependencies?

/**
 * UploadedFileTest
 */
class UploadedFileTest extends AbstractTestCase
{

    /**
     * @return void
     */
    public function testConstructor() : void
    {
        $stream = $this->createStream();
        $uploadedFile = new UploadedFile($stream);

        $this->assertInstanceOf(UploadedFileInterface::class, $uploadedFile);
        $this->assertSame($stream, $uploadedFile->getStream());
        $this->assertNull($uploadedFile->getSize());
        $this->assertSame(\UPLOAD_ERR_OK, $uploadedFile->getError());
        $this->assertNull($uploadedFile->getClientFilename());
        $this->assertNull($uploadedFile->getClientMediaType());
    }

    /**
     * @return void
     */
    public function testConstructorWithOptionalParameters() : void
    {
        $stream = $this->createStream();
        $uploadedFile = new UploadedFile($stream, 42, \UPLOAD_ERR_OK, 'foo', 'bar');

        $this->assertInstanceOf(UploadedFileInterface::class, $uploadedFile);
        $this->assertSame($stream, $uploadedFile->getStream());
        $this->assertSame(42, $uploadedFile->getSize());
        $this->assertSame(\UPLOAD_ERR_OK, $uploadedFile->getError());
        $this->assertSame('foo', $uploadedFile->getClientFilename());
        $this->assertSame('bar', $uploadedFile->getClientMediaType());
    }

    /**
     * @return void
     */
    public function testConstructorWithInvalidFile() : void
    {
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionMessage('Invalid uploaded file');

        new UploadedFile(null);
    }

    /**
     * @return void
     */
    public function testMove() : void
    {
        $stream = $this->createStream('foo');
        $uploadedFile = new UploadedFile($stream);
        $targetPath = $this->createStream()->getMetadata('uri');
        $uploadedFile->moveTo($targetPath);

        $this->assertStringEqualsFile($targetPath, 'foo');

It seems like $targetPath can also be of type null; however, parameter $expectedFile of PHPUnit\Framework\Assert::assertStringEqualsFile() does only seem to accept string, maybe add an additional type check?

    }

    /**
     * @return void
     */
    public function testReWrite() : void
    {
        $stream = $this->createStream('foo');
        $uploadedFile = new UploadedFile($stream);
        $targetPath = $this->createStream('bar')->getMetadata('uri');
        $uploadedFile->moveTo($targetPath);

        $this->assertStringEqualsFile($targetPath, 'foo');

It seems like $targetPath can also be of type null; however, parameter $expectedFile of PHPUnit\Framework\Assert::assertStringEqualsFile() does only seem to accept string, maybe add an additional type check?

    }

    /**
     * @dataProvider errorCodeProvider
     *
     * @return void
     */
    public function testMoveWithError($error) : void
    {
        $stream = $this->createStream();
        $uploadedFile = new UploadedFile($stream, null, $error);

        $this->expectException(\RuntimeException::class);
        $this->expectExceptionMessage(\sprintf(
            'The uploaded file cannot be moved due to the error #%d (%s)',
            $error,
            UPLOAD_ERRORS[$error] ?? 'Unknown error'
        ));

        $uploadedFile->moveTo('/');
    }

    /**
     * @return void
     */
    public function testReMove() : void
    {
        $stream = $this->createStream();
        $uploadedFile = new UploadedFile($stream);
        $targetPath = $this->createStream()->getMetadata('uri');
        $uploadedFile->moveTo($targetPath);

        $this->expectException(\RuntimeException::class);
        $this->expectExceptionMessage('The uploaded file already moved');

        $uploadedFile->moveTo('/');
    }

    /**
     * @return void
     */
    public function testMoveToNowhere() : void
    {
        $stream = $this->createStream();
        $uploadedFile = new UploadedFile($stream);

        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionMessage('The uploaded file cannot be moved because the directory "/" is not available');

        $uploadedFile->moveTo('/');
    }

    /**
     * @return void
     */
    public function testGetMovedStream() : void
    {
        $stream = $this->createStream();
        $uploadedFile = new UploadedFile($stream);

        $targetPath = $this->createStream()->getMetadata('uri');
        $uploadedFile->moveTo($targetPath);

        $this->expectException(\RuntimeException::class);
        $this->expectExceptionMessage('The uploaded file already moved');

        $uploadedFile->getStream();
    }

    /**
     * @dataProvider errorCodeProvider
     *
     * @return void
     */
    public function testGetStreamWithError($error) : void
    {
        $stream = $this->createStream();
        $uploadedFile = new UploadedFile($stream, null, $error);

        $this->expectException(\RuntimeException::class);
        $this->expectExceptionMessage(\sprintf(
            'The uploaded file has no a stream due to the error #%d (%s)',
            $error,
            UPLOAD_ERRORS[$error] ?? 'Unknown error'
        ));

        $uploadedFile->getStream();
    }

    /**
     * @return array
     */
    public function errorCodeProvider() : array
    {
        return [
            [\UPLOAD_ERR_INI_SIZE],
            [\UPLOAD_ERR_FORM_SIZE],
            [\UPLOAD_ERR_PARTIAL],
            [\UPLOAD_ERR_NO_FILE],
            [\UPLOAD_ERR_NO_TMP_DIR],
            [\UPLOAD_ERR_CANT_WRITE],
            [\UPLOAD_ERR_EXTENSION],
        ];
    }
}