ILIAS\Tests\FileDelivery\Delivery\StreamDeliveryTest Class Reference

Temporary files are removed by a shutdown function as soon as the request exits, header based delivery (X-Sendfile, X-Accel) opens them only afterwards. More...

Inheritance diagram for ILIAS\Tests\FileDelivery\Delivery\StreamDeliveryTest:

Collaboration diagram for ILIAS\Tests\FileDelivery\Delivery\StreamDeliveryTest:

Public Member Functions
	testTemporaryFileIsDeliveredByTheFallback ()
	testRegularFileIsDeliveredByTheConfiguredBuilder ()
	testMemoryStreamIsDeliveredByTheFallback ()

Protected Member Functions
	tearDown ()

Private Member Functions
	assertDeliveredBy (string $expected, FileStream $stream)
	builder (string $name, bool $used, ResponseInterface $response)
	requestTo (string $uri)

Private Attributes
string	$temp_file = null

Detailed Description

Temporary files are removed by a shutdown function as soon as the request exits, header based delivery (X-Sendfile, X-Accel) opens them only afterwards.

They must be streamed by PHP, see https://mantis.ilias.de/view.php?id=48367

Definition at line 41 of file StreamDeliveryTest.php.

Member Function Documentation

assertDeliveredBy()

ILIAS\Tests\FileDelivery\Delivery\StreamDeliveryTest::assertDeliveredBy ( string  $expected, FileStream  $stream  )

private

Definition at line 79 of file StreamDeliveryTest.php.

                                                                            : void
    {
        $response = (new MessageFactoryImpl())->response();
 
        $http = $this->createStub(\ILIAS\HTTP\Services::class);
        $http->method('request')->willReturn($this->requestTo('https://ilias.example.org/'));
        $http->method('response')->willReturn($response);
        // close() is never, the test leaves deliver() by an exception instead
        $http->method('close')->willThrowException(new \RuntimeException('closed'));
 
        $configured = $this->builder('configured', $expected === 'configured', $response);
        $fallback = $this->builder('fallback', $expected === 'fallback', $response);
 
        $delivery = new StreamDelivery(
            new DataSigner(new SecretKeyRotation(new SecretKey(str_repeat('a', 32)))),
            $http,
            $configured,
            $fallback
        );
 
        $this->expectExceptionMessage('closed');
        $delivery->attached($stream, 'file.zip', 'application/zip');
    }

References ILIAS\BookingManager\Common\Table\$http, $response, ILIAS\Tests\FileDelivery\Delivery\StreamDeliveryTest\builder(), ILIAS\Tests\FileDelivery\Delivery\StreamDeliveryTest\requestTo(), and ILIAS\Scripts\PHPStan\str_repeat.

Referenced by ILIAS\Tests\FileDelivery\Delivery\StreamDeliveryTest\testMemoryStreamIsDeliveredByTheFallback(), ILIAS\Tests\FileDelivery\Delivery\StreamDeliveryTest\testRegularFileIsDeliveredByTheConfiguredBuilder(), and ILIAS\Tests\FileDelivery\Delivery\StreamDeliveryTest\testTemporaryFileIsDeliveredByTheFallback().

Here is the call graph for this function:

Here is the caller graph for this function:

builder()

ILIAS\Tests\FileDelivery\Delivery\StreamDeliveryTest::builder ( string  $name, bool  $used, ResponseInterface  $response  )

private

Definition at line 103 of file StreamDeliveryTest.php.

                                                                                   : ResponseBuilder&MockObject
    {
        $builder = $this->createMock(ResponseBuilder::class);
        $builder->method('getName')->willReturn($name);
        $builder->expects($used ? $this->once() : $this->never())
                ->method('buildForStream')
                ->willReturn($response);
 
        return $builder;
    }

References $response.

Referenced by ILIAS\Tests\FileDelivery\Delivery\StreamDeliveryTest\assertDeliveredBy().

Here is the caller graph for this function:

requestTo()

ILIAS\Tests\FileDelivery\Delivery\StreamDeliveryTest::requestTo ( string  $uri )

private

Definition at line 114 of file StreamDeliveryTest.php.

                                           : ServerRequestInterface
    {
        $request = $this->createStub(ServerRequestInterface::class);
        $request->method('getUri')->willReturn((new MessageFactoryImpl())->uri($uri));
 
        return $request;
    }

References $request.

Referenced by ILIAS\Tests\FileDelivery\Delivery\StreamDeliveryTest\assertDeliveredBy().

Here is the caller graph for this function:

tearDown()

ILIAS\Tests\FileDelivery\Delivery\StreamDeliveryTest::tearDown ( )

protected

Definition at line 45 of file StreamDeliveryTest.php.

                                 : void
    {
        if ($this->temp_file !== null && is_file($this->temp_file)) {
            unlink($this->temp_file);
        }
    }

testMemoryStreamIsDeliveredByTheFallback()

ILIAS\Tests\FileDelivery\Delivery\StreamDeliveryTest::testMemoryStreamIsDeliveredByTheFallback

(

)

Definition at line 71 of file StreamDeliveryTest.php.

                                                              : void
    {
        $this->assertDeliveredBy(
            'fallback',
            Streams::ofString('content')
        );
    }

References ILIAS\Tests\FileDelivery\Delivery\StreamDeliveryTest\assertDeliveredBy(), and ILIAS\Filesystem\Stream\Streams\ofString().

Here is the call graph for this function:

testRegularFileIsDeliveredByTheConfiguredBuilder()

ILIAS\Tests\FileDelivery\Delivery\StreamDeliveryTest::testRegularFileIsDeliveredByTheConfiguredBuilder

(

)

Definition at line 63 of file StreamDeliveryTest.php.

                                                                      : void
    {
        $this->assertDeliveredBy(
            'configured',
            Streams::ofResource(fopen(__FILE__, 'rb'))
        );
    }

References ILIAS\Tests\FileDelivery\Delivery\StreamDeliveryTest\assertDeliveredBy(), and ILIAS\Filesystem\Stream\Streams\ofResource().

Here is the call graph for this function:

testTemporaryFileIsDeliveredByTheFallback()

ILIAS\Tests\FileDelivery\Delivery\StreamDeliveryTest::testTemporaryFileIsDeliveredByTheFallback

(

)

Definition at line 52 of file StreamDeliveryTest.php.

                                                               : void
    {
        $this->temp_file = tempnam(sys_get_temp_dir(), 'zip');
        file_put_contents($this->temp_file, 'zip');
 
        $this->assertDeliveredBy(
            'fallback',
            Streams::ofResource(fopen($this->temp_file, 'rb'))
        );
    }

References ILIAS\Tests\FileDelivery\Delivery\StreamDeliveryTest\assertDeliveredBy(), and ILIAS\Filesystem\Stream\Streams\ofResource().

Here is the call graph for this function:

Field Documentation

$temp_file

string ILIAS\Tests\FileDelivery\Delivery\StreamDeliveryTest::$temp_file = null

private

Definition at line 43 of file StreamDeliveryTest.php.

---

The documentation for this class was generated from the following file:

• components/ILIAS/FileDelivery/tests/Delivery/StreamDeliveryTest.php